Busca por CPF/CNPJ
Processos
Busca por CPF/CNPJ
Inicie uma consulta processual por CPF ou CNPJ nos datasets selecionados.
POST
Busca por CPF/CNPJ
Inicia uma consulta processual usando um CPF ou CNPJ e os datasets processuais informados no corpo da requisição.
Consultas processuais são sempre assíncronas. A resposta inicial retorna um
Estrutura de
Onde
id, e o resultado deve ser consultado posteriormente no endpoint de resultado assíncrono.
Corpo da requisição
CPF ou CNPJ que será pesquisado nos módulos processuais selecionados. Pontuação é aceita e removida automaticamente.
Lista de IDs dos datasets processuais que serão consultados.
Dados adicionais por dataset, quando algum dataset exigir parâmetros extras.
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
Datasets processuais
Antes de iniciar a consulta, liste os datasets disponíveis em Datasets e preços usando o tipoprocess.
Use apenas datasets com active: true.
Parâmetros adicionais por dataset
Alguns datasets podem exigir campos adicionais. Consulteadditional_fields no endpoint de 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 com os dados de acompanhamento da consulta assíncrona.
Estrutura de result
| Campo | Tipo | Descrição |
|---|---|---|
id | string | Identificador da consulta assíncrona. Use este valor para consultar o resultado depois. |
status | string | Status atual da consulta. Na resposta inicial, normalmente retorna queued. |
status_values | array<string> | Lista de status possíveis da consulta assíncrona. |
datasets | array<string> | Datasets processuais solicitados na consulta. |
Status possíveis
| Status | Descrição |
|---|---|
queued | Consulta criada e aguardando processamento. |
processing | Consulta em processamento. |
completed | Consulta finalizada. Verifique o resultado, erros e status por dataset no endpoint de resultado. |
failed | Consulta finalizada com falha geral. |
Consulta do resultado
Após receber oid, consulte o andamento e o resultado final em:
history_id é o id retornado na criação da consulta.
Consulte a página de resultado assíncrono para ver a estrutura completa do retorno final.
Retorno final
Quando a consulta for finalizada, o resultado assíncrono retorna a estrutura completa da busca, incluindo:| Campo | Descrição |
|---|---|
query | Documento, datasets e campos adicionais usados na consulta. |
cost | Valores debitados e estornados por dataset. |
timing | Tempo total e tempo individual por dataset, quando disponível. |
errors | Erros por dataset, quando ocorrerem. |
datasets_status | Status individual de cada dataset consultado. |
result | Dados retornados por cada dataset processual. |
Respostas esperadas
As respostas possíveis estão exemplificadas no painel lateral da página.| Status | Quando ocorre |
|---|---|
202 | Consulta processual iniciada com sucesso. |
400 | Requisição inválida, documento inválido, dataset ausente ou parâmetro incompatível. |
401 | A chave da API está ausente, inválida ou não pôde ser autenticada. |
403 | A credencial não possui escopo de consulta, o plano não permite acesso ou há bloqueio financeiro. |
Fluxo recomendado
- Liste os datasets disponíveis em Datasets e preços usando
target: process. - Selecione apenas datasets processuais ativos.
- Envie o CPF ou CNPJ, os datasets e os campos adicionais necessários.
- Guarde o
idretornado. - Consulte o resultado em Resultado assíncrono usando
target: process.
Evite polling agressivo. Consultas processuais podem levar mais tempo por dependerem de múltiplas fontes e tribunais.

