Busca por CNPJ
Pessoa jurídica
Busca por CNPJ
Execute consultas de pessoa jurídica por CNPJ nos datasets selecionados.
POST
Busca por CNPJ
Executa uma consulta de pessoa jurídica por CNPJ usando os datasets informados no corpo da requisição.
Essa consulta pode ser executada em modo síncrono ou assíncrono. No modo assíncrono, a API retorna um
Valores aceitos para
Estrutura de
Para consultar o resultado final, use o
id para acompanhamento posterior do resultado.
Corpo da requisição
CNPJ da empresa consultada. Pontuação é aceita e removida automaticamente.
Lista de IDs dos datasets que serão consultados.
Dados adicionais por dataset, quando algum dataset exigir parâmetros extras.
Modo da consulta.
mode:
| Valor | Descrição |
|---|---|
async | Inicia a consulta e retorna um id para acompanhar o resultado depois. |
sync | Aguarda a conclusão da consulta e retorna os dados diretamente na resposta. |
Use
sandbox para executar uma chamada de teste sem consumo de saldo.Para detalhes sobre chamadas de teste, consulte Ambiente de teste.
Exemplo de corpo
Parâmetros adicionais por dataset
Alguns datasets podem exigir campos adicionais. Consulteadditional_fields em Datasets e preços para saber quais campos devem ser enviados.
Exemplo de envio de dados adicionais:
Resposta
Código da resposta da API.
Mensagem descritiva da resposta.
Objeto principal da consulta. A estrutura varia de acordo com o modo de execução.
Retorno síncrono
Quandomode é sync, a resposta pode retornar code: 200 com os dados completos da consulta.
Estrutura de result
| Campo | Tipo | Descrição |
|---|---|---|
id | string | Identificador único da consulta. |
status | string | Status final da consulta. Normalmente completed. |
target | string | Tipo da consulta. Para esta rota, retorna company. |
query | object | Dados usados na consulta. |
cost | object | Valores cobrados e estornados. |
timing | object | Tempo total e tempo individual por dataset. |
errors | object | Erros por dataset, quando ocorrerem. |
datasets_status | object | Status individual de cada dataset. |
result | object | Resultado agrupado por dataset. |
created_at | string | Data de criação da consulta em ISO 8601. |
last_updated_at | string | Data da última atualização da consulta em ISO 8601. |
Retorno assíncrono
Quandomode é async, a resposta inicial retorna code: 202 e o processamento continua em segundo plano.
Status possíveis:
| Status | Descrição |
|---|---|
queued | Consulta criada e aguardando processamento. |
processing | Consulta em processamento. |
completed | Consulta finalizada com sucesso. |
failed | Consulta finalizada com falha. |
id retornado no endpoint de resultado assíncrono.
Fluxo recomendado
- Liste os datasets disponíveis em Datasets e preços.
- Selecione apenas datasets com
active: true. - Envie o CNPJ, os datasets e os campos adicionais necessários.
- Use
mode: "async"para consultas com múltiplos datasets ou fontes online. - Consulte o resultado pelo
idretornado quando a chamada for assíncrona.

