Contatos e endereços

E-mails de Pessoas Relacionadas

Retorna e-mails associados a pessoas relacionadas ao indivíduo consultado (parentes, colegas, household e outros vínculos).

Quando usar

Descrição

O dataset de E-mails de Pessoas Relacionadas retorna endereços de e-mail vinculados às pessoas relacionadas ao CPF consultado,

com atributos de relacionamento, validação, recência e prioridade.

Requisição

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

POST /api/v1/{tenant}/pessoas/e-mails-de-pessoas-relacionadas

CampoObrigatórioDescrição
document sim CPF da pessoa, com ou sem máscara.
{
  "document": "000.000.000-00"
}

Campos de retorno

Campos dentro de data. [] indica lista.

CampoTipo
RelatedPeopleEmails[].RelationshipType texto
RelatedPeopleEmails[].EmailAddress texto
RelatedPeopleEmails[].Domain texto
RelatedPeopleEmails[].Type texto
RelatedPeopleEmails[].IsActive booleano
RelatedPeopleEmails[].IsMain booleano
RelatedPeopleEmails[].ValidationStatus texto
RelatedPeopleEmails[].CreationDate data
RelatedPeopleEmails[].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 de Pessoas Relacionadas",
  "query_slug": "e-mails-de-pessoas-relacionadas",
  "data": {
    "RelatedPeopleEmails": [
      {
        "RelationshipType": "texto",
        "EmailAddress": "texto",
        "Domain": "texto",
        "Type": "texto",
        "IsActive": false,
        "IsMain": false,
        "ValidationStatus": "texto",
        "CreationDate": "2026-01-01",
        "LastUpdateDate": "2026-01-01"
      }
    ]
  },
  "consulted_at": "2026-01-01T12:00:00Z",
  "query_cost": "0.120"
}

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