Localização
O serviço de Localização retorna informações completas sobre o local da empresa, incluindo endereço, telefone, site, avaliações, fotos, mapa e visualização via Street View.
Quando usar
Descrição
O serviço de Localização fornece informações completas sobre o local da empresa consultada.
As informações incluem endereço, telefone, site, avaliações de usuários, status de funcionamento (horários de abertura e fechamento), além de elementos visuais como fotos do ambiente, mapa e visualização via Street View.
Com esses dados, é possível verificar a posição geográfica da empresa e o contexto físico ao redor, facilitando análises de presença física e estrutura operacional.
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/localizacao
| Campo | Obrigatório | Descriçã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.
| Campo | Tipo |
|---|---|
empresa |
texto |
nome_oficial |
texto |
endereco |
texto |
tipo |
texto |
rating |
número |
user_rating_count |
número |
status_funcionamento |
texto |
mensagem |
texto |
site |
texto |
telefone |
texto |
plus_code |
texto |
fotos[].photoUri |
texto |
place_id |
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": {
"empresa": "texto",
"nome_oficial": "texto",
"endereco": "texto",
"tipo": "texto",
"rating": 0,
"user_rating_count": 0,
"status_funcionamento": "texto",
"mensagem": "texto",
"site": "texto",
"telefone": "texto",
"plus_code": "texto",
"fotos": [
{
"photoUri": "texto"
}
],
"place_id": "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