Endpoint
Entrada
A consulta utiliza o CNPJ como identificador principal.| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tax_id | string | Sim | CNPJ consultado. Pode ser enviado com ou sem pontuação. |
mode | string | Não | Define o modo da consulta. Aceita sync ou async. |
datasets | array<string> | Sim | Lista de datasets que serão executados. |
additional_data | object | Não | Dados adicionais exigidos por datasets específicos. |
Modo de execução
A consulta pode ser executada em dois modos.| Modo | Descrição |
|---|---|
sync | A API aguarda o processamento e retorna o resultado na própria resposta. |
async | A API registra a consulta para processamento assíncrono e retorna um identificador para acompanhamento posterior. |
Status assíncronos
Consultas assíncronas podem passar pelos seguintes status:| Status | Descrição |
|---|---|
processing | A consulta foi recebida e está em processamento. |
completed | A consulta foi concluída com sucesso. |
failed | A consulta falhou e não pôde ser concluída. |
partial | A consulta foi concluída, mas um ou mais datasets retornaram erro. |
expired | O resultado da consulta não está mais disponível. |
Dados adicionais
Alguns datasets podem exigir parâmetros complementares. Esses dados devem ser enviados emadditional_data, usando o identificador do dataset como chave.
O exemplo acima usa um dataset fictício apenas para demonstrar a estrutura de envio de dados adicionais.
Ambiente de teste
A consulta de pessoa jurídica tem suporte ao ambiente de teste. Para saber como habilitar chamadas de teste, consulte:Ambiente de teste
Veja como usar o header de sandbox e validar integrações sem consumir saldo.
Datasets
Os datasets disponíveis podem variar conforme plano, permissões e configuração comercial da conta.A lista real de datasets deve ser consultada na configuração da conta ou no endpoint de datasets disponíveis.
Alguns campos de um dataset podem não ser retornados em determinadas consultas. Isso pode ocorrer por ausência da informação na base, regra de disponibilidade do provedor, restrição legal ou característica do próprio registro consultado.
Retorno síncrono
Quandomode for sync, a resposta retorna os dados processados em result e os metadados da consulta em query.
| Campo | Tipo | Descrição |
|---|---|---|
result | object | Dados retornados pelos datasets executados. |
query.id | string | Identificador da consulta. |
query.timing.datasets | object | Tempo de execução de cada dataset, em segundos. |
query.timing.total | number | Tempo total da consulta, em segundos. |
query.error | object | Erros individuais por dataset, quando houver. |
query.datasets_status | object | Status individual de cada dataset executado. |
query.datetime | string | Data e hora da consulta em formato ISO. |
O campo
query.error permite identificar falhas parciais sem invalidar necessariamente toda a consulta.Exemplo com erro parcial
Retorno assíncrono
Quandomode for async, a resposta retorna os dados necessários para acompanhar a consulta.
Regras importantes
- O CNPJ deve ser válido.
- Datasets indisponíveis, inativos ou não permitidos para a conta podem retornar erro.
- Consultas com múltiplos datasets podem retornar resultados parciais caso algum dataset falhe.
- A cobrança é calculada com base nos datasets efetivamente executados, conforme as regras comerciais da conta.
- Alguns dados podem estar indisponíveis por regra legal, restrição de privacidade ou ausência de informação na base.
Próximos passos
Pessoa física
Veja como consultar dados vinculados a CPF.
Códigos de erro
Consulte os erros relacionados a consultas.

