Endpoint
Entrada
A consulta utiliza CPF ou CNPJ como identificador principal.| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tax_id | string | Sim | CPF ou CNPJ consultado. Pode ser enviado com ou sem pontuação. |
datasets | array<string> | Sim | Lista de bases processuais que serão executadas. |
additional_data | object | Não | Dados adicionais exigidos por bases específicas, quando houver. |
Execução assíncrona
A consulta processual é sempre executada de forma assíncrona. Ao iniciar a consulta, a API registra o processamento e retorna um identificador para acompanhamento posterior.Consultas processuais podem envolver múltiplas bases, provedores externos e tempos de resposta maiores. Por isso, o processamento é sempre assíncrono.
Status da consulta
Consultas processuais 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 uma ou mais bases retornaram erro. |
expired | O resultado da consulta não está mais disponível. |
Dados adicionais
Algumas bases processuais podem exigir parâmetros complementares. Esses dados devem ser enviados emadditional_data, usando o identificador da base como chave.
O exemplo acima usa uma base fictícia apenas para demonstrar a estrutura de envio de dados adicionais.
Ambiente de teste
A consulta processual 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.
Bases processuais
As bases disponíveis podem variar conforme plano, permissões e configuração comercial da conta. Cada base processual representa um tribunal, sistema ou fonte específica.A lista real de bases processuais deve ser consultada na configuração da conta ou no endpoint de datasets disponíveis.
Alguns campos do processo podem não ser retornados em determinadas bases. Isso pode ocorrer por limitação da fonte, ausência da informação, indisponibilidade temporária ou diferença entre os sistemas processuais.
Retorno inicial
Ao iniciar uma consulta processual, a API retorna o identificador para acompanhamento.Retorno do resultado
Após a conclusão, o resultado pode ser consultado usando o identificador retornado na criação.| Campo | Tipo | Descrição |
|---|---|---|
result | object | Processos retornados por cada base executada. |
query.id | string | Identificador da consulta. |
query.timing.datasets | object | Tempo de execução de cada base, em segundos. |
query.timing.total | number | Tempo total da consulta, em segundos. |
query.error | object | Erros individuais por base, quando houver. |
query.datasets_status | object | Status individual de cada base executada. |
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
Regras importantes
- O documento informado deve ser um CPF ou CNPJ válido.
- Bases indisponíveis, inativas ou não permitidas para a conta podem retornar erro.
- Consultas com múltiplas bases podem retornar resultados parciais caso alguma base falhe.
- A cobrança é calculada com base nas bases efetivamente executadas, conforme as regras comerciais da conta.
- Uma mesma pessoa ou empresa pode possuir processos em múltiplas bases.
- A ausência de processos em uma base não significa ausência em todas as demais fontes.
Próximos passos
Pessoa física
Veja como consultar dados vinculados a CPF.
Pessoa jurídica
Veja como consultar dados vinculados a CNPJ.
Códigos de erro
Consulte os erros relacionados a consultas.

