Contatos e endereços
Localização
O serviço de Localização retorna informações sobre um dos endereços principais da pessoa consultada, incluindo tipo, endereço completo, mapa e visualização via Street View.
Quando usar
Descrição
O serviço de Localização fornece informações sobre o endereço residencial ou comercial associado a uma pessoa.
As informações incluem o endereço completo, além de elementos visuais, como o mapa e a visualização via Street View, permitindo identificar com precisão sua localização e o ambiente ao redor.
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/localizacao
| 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 |
|---|---|
endereco |
texto |
tipo |
texto |
latitude |
número |
longitude |
número |
status |
texto |
message |
texto |
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": "Localização",
"query_slug": "localizacao",
"data": {
"endereco": "texto",
"tipo": "texto",
"latitude": 0,
"longitude": 0,
"status": "texto",
"message": "texto"
},
"consulted_at": "2026-01-01T12:00:00Z",
"query_cost": "0.160"
}
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