Contatos e endereços

E-mails

O serviço de E-mails retorna endereços de e-mail relacionados à consulta, juntamente com informações adicionais e dados agregados.

Quando usar

Descrição

O serviço de E-mails fornece endereços de e-mail associados ao objeto da consulta, acompanhados de informações complementares, como frequência de ocorrência e dados agregados de todos os e-mails encontrados.

Isso facilita análises e modelagens com base em padrões de uso e exposição.

Requisição

Autenticação por chave de API (cabeçalho Authorization: Bearer), criada no painel com esta consulta no escopo.

POST /api/v1/{tenant}/empresas/e-mails

CampoObrigatórioDescrição
document sim CNPJ da empresa, com ou sem máscara.
{
  "document": "00.000.000/0000-00"
}

Campos de retorno

Campos dentro de data. [] indica lista.

CampoTipo
TotalEmails número
TotalActiveEmails número
TotalWorkEmails número
TotalPersonalEmails número
TotalUniqueEmails número
TotalEmailPassages número
TotalBadEmailPassages número
TotalLast3MonthsPassages número
TotalLast6MonthsPassages número
TotalLast12MonthsPassages número
TotalLast18MonthsPassages número
OldestEmailPassageDate data
NewestEmailPassageDate data
Emails[].EmailAddress texto
Emails[].Domain texto
Emails[].UserName texto
Emails[].Type texto
Emails[].EmailEntityAge número
Emails[].EmailAssociationClassification.ClassificationType texto
Emails[].EmailAssociationClassification.ClassificationDescription texto
Emails[].EmailAssociationClassification.ContactAssociationIndex texto
Emails[].EmailCurrentlyInRFSite booleano
Emails[].UserNameTotalPassages número
Emails[].UserNameFirstPassageDate texto
Emails[].UserNameLastPassageDate texto
Emails[].UserNameBadPassages número
Emails[].UserNameCrawlingPassages número
Emails[].UserNameValidationPassages número
Emails[].UserNameQueryPassages número
Emails[].EmailEntityTotalPassages número
Emails[].EmailEntityBadPassages número
Emails[].EmailEntityCrawlingPassages número
Emails[].EmailEntityValidationPassages número
Emails[].EmailEntityQueryPassages número
Emails[].EmailEntityMonthAveragePassages número
Emails[].EmailGlobalAge número
Emails[].EmailGlobalTotalPassages número
Emails[].EmailGlobalBadPassages número
Emails[].EmailGlobalCrawlingPassages número
Emails[].EmailGlobalValidationPassages número
Emails[].EmailGlobalQueryPassages número
Emails[].EmailGlobalMonthAveragePassages número
Emails[].Last3MonthsPassages número
Emails[].Last6MonthsPassages número
Emails[].Last12MonthsPassages número
Emails[].Last18MonthsPassages número
Emails[].EmailNumberOfEntities número
Emails[].EmailNumberOfFamilyRelatedEntities número
Emails[].EmailNumberOfRelatedEntities número
Emails[].Priority número
Emails[].IsMainForEntity booleano
Emails[].IsRecentForEntity booleano
Emails[].IsMainForOtherEntity booleano
Emails[].IsRecentForOtherEntity booleano
Emails[].IsActive booleano
Emails[].IsLikelyFromAccountant booleano
Emails[].ValidationStatus texto
Emails[].LastValidationDate data
Emails[].EntityFirstPassageDate data
Emails[].EntityLastPassageDate data
Emails[].GlobalFirstPassageDate data
Emails[].GlobalLastPassageDate data
Emails[].CreationDate data
Emails[].LastUpdateDate data

Exemplo de resposta

Estrutura real da resposta, com valores fictícios.

{
  "execution_id": "00000000-0000-0000-0000-000000000000",
  "status": "success",
  "message": "Consulta realizada com sucesso",
  "query_name": "E-mails",
  "query_slug": "e-mails",
  "data": {
    "TotalEmails": 0,
    "TotalActiveEmails": 0,
    "TotalWorkEmails": 0,
    "TotalPersonalEmails": 0,
    "TotalUniqueEmails": 0,
    "TotalEmailPassages": 0,
    "TotalBadEmailPassages": 0,
    "TotalLast3MonthsPassages": 0,
    "TotalLast6MonthsPassages": 0,
    "TotalLast12MonthsPassages": 0,
    "TotalLast18MonthsPassages": 0,
    "OldestEmailPassageDate": "2026-01-01",
    "NewestEmailPassageDate": "2026-01-01",
    "Emails": [
      {
        "EmailAddress": "texto",
        "Domain": "texto",
        "UserName": "texto",
        "Type": "texto",
        "EmailEntityAge": 0,
        "EmailAssociationClassification": {
          "ClassificationType": "texto",
          "ClassificationDescription": "texto",
          "ContactAssociationIndex": "texto"
        },
        "EmailCurrentlyInRFSite": false,
        "UserNameTotalPassages": 0,
        "UserNameFirstPassageDate": "texto",
        "UserNameLastPassageDate": "texto",
        "UserNameBadPassages": 0,
        "UserNameCrawlingPassages": 0,
        "UserNameValidationPassages": 0,
        "UserNameQueryPassages": 0,
        "EmailEntityTotalPassages": 0,
        "EmailEntityBadPassages": 0,
        "EmailEntityCrawlingPassages": 0,
        "EmailEntityValidationPassages": 0,
        "EmailEntityQueryPassages": 0,
        "EmailEntityMonthAveragePassages": 0,
        "EmailGlobalAge": 0,
        "EmailGlobalTotalPassages": 0,
        "EmailGlobalBadPassages": 0,
        "EmailGlobalCrawlingPassages": 0,
        "EmailGlobalValidationPassages": 0,
        "EmailGlobalQueryPassages": 0,
        "EmailGlobalMonthAveragePassages": 0,
        "Last3MonthsPassages": 0,
        "Last6MonthsPassages": 0,
        "Last12MonthsPassages": 0,
        "Last18MonthsPassages": 0,
        "EmailNumberOfEntities": 0,
        "EmailNumberOfFamilyRelatedEntities": 0,
        "EmailNumberOfRelatedEntities": 0,
        "Priority": 0,
        "IsMainForEntity": false,
        "IsRecentForEntity": false,
        "IsMainForOtherEntity": false,
        "IsRecentForOtherEntity": false,
        "IsActive": false,
        "IsLikelyFromAccountant": false,
        "ValidationStatus": "texto",
        "LastValidationDate": "2026-01-01",
        "EntityFirstPassageDate": "2026-01-01",
        "EntityLastPassageDate": "2026-01-01",
        "GlobalFirstPassageDate": "2026-01-01",
        "GlobalLastPassageDate": "2026-01-01",
        "CreationDate": "2026-01-01",
        "LastUpdateDate": "2026-01-01"
      }
    ]
  },
  "consulted_at": "2026-01-01T12:00:00Z",
  "query_cost": "0.100"
}

Cobrança e respostas

  • O valor é cobrado por consulta bem-sucedida.
  • 200 — consulta processada (veja status no corpo da resposta)
  • 401 — token ausente, inválido, inativo ou expirado
  • 403 — serviço fora do escopo da chave, IP não autorizado ou limite de consumo excedido
  • 422 — campo obrigatório ausente/inválido ou payload acima do limite do serviço
  • 429 — limite de requisições por minuto da chave excedido
  • 504 — tempo máximo de execução do serviço excedido