Contatos e endereços

Endereços de Pessoas Relacionadas

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

Falar com o comercial Ver o catálogo

Quando usar

Descrição

O dataset de Endereços de Pessoas Relacionadas retorna localizações vinculadas às pessoas relacionadas ao CPF consultado,

independentemente de o endereço estar associado diretamente à pessoa consultada.

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/enderecos-de-pessoas-relacionadas

Campo	Obrigatório	Descriçã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.

Campo	Tipo
`RelatedPeopleAddresses[].RelationshipType`	texto
`RelatedPeopleAddresses[].Typology`	texto
`RelatedPeopleAddresses[].Title`	texto
`RelatedPeopleAddresses[].AddressMain`	texto
`RelatedPeopleAddresses[].Number`	texto
`RelatedPeopleAddresses[].Complement`	texto
`RelatedPeopleAddresses[].Neighborhood`	texto
`RelatedPeopleAddresses[].City`	texto
`RelatedPeopleAddresses[].State`	texto
`RelatedPeopleAddresses[].ZipCode`	texto
`RelatedPeopleAddresses[].Type`	texto
`RelatedPeopleAddresses[].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": "Endereços de Pessoas Relacionadas",
  "query_slug": "enderecos-de-pessoas-relacionadas",
  "data": {
    "RelatedPeopleAddresses": [
      {
        "RelationshipType": "texto",
        "Typology": "texto",
        "Title": "texto",
        "AddressMain": "texto",
        "Number": "texto",
        "Complement": "texto",
        "Neighborhood": "texto",
        "City": "texto",
        "State": "texto",
        "ZipCode": "texto",
        "Type": "texto",
        "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