Outros e utilitários

Endereços (Dados internos)

Verifica se o CNPJ possui endereços cadastrados na base de dados interna da instituição.

Falar com o comercial Ver o catálogo

Quando usar

Descrição

O serviço de Endereços (Dados internos) verifica se a empresa consultada já possui endereços vinculados

na base de dados interna da instituição, retornando todos os endereços encontrados com seus dados cadastrais,

em formato compatível com as demais fontes de endereço utilizadas no Background Check.

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/enderecos-dados-internos

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
`Addresses[].Type`	texto
`Addresses[].AddressMain`	texto
`Addresses[].Number`	texto
`Addresses[].Complement`	texto
`Addresses[].Neighborhood`	texto
`Addresses[].City`	texto
`Addresses[].State`	texto
`Addresses[].ZipCode`	texto
`Addresses[].Country`	texto
`Addresses[].Source`	texto
`Addresses[].IsMainForEntity`	booleano
`Addresses[].CreationDate`	data
`Addresses[].LastUpdateDate`	data
`TotalAddresses`	número

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 (Dados internos)",
  "query_slug": "enderecos-dados-internos",
  "data": {
    "Addresses": [
      {
        "Type": "texto",
        "AddressMain": "texto",
        "Number": "texto",
        "Complement": "texto",
        "Neighborhood": "texto",
        "City": "texto",
        "State": "texto",
        "ZipCode": "texto",
        "Country": "texto",
        "Source": "texto",
        "IsMainForEntity": false,
        "CreationDate": "2026-01-01",
        "LastUpdateDate": "2026-01-01"
      }
    ],
    "TotalAddresses": 0
  },
  "consulted_at": "2026-01-01T12:00:00Z"
}

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