Skip to main content
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 id, e o resultado deve ser consultado posteriormente no endpoint de resultado assíncrono.

Corpo da requisição

string
required
CPF ou CNPJ que será pesquisado nos módulos processuais selecionados. Pontuação é aceita e removida automaticamente.
string[]
required
Lista de IDs dos datasets processuais que serão consultados.
object
Dados adicionais por dataset, quando algum dataset exigir parâmetros extras.
string
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

O documento acima é fictício e serve apenas para demonstrar a estrutura da requisição. Em chamadas reais ou sandbox, informe um CPF ou CNPJ válido para o ambiente utilizado.

Datasets processuais

Antes de iniciar a consulta, liste os datasets disponíveis em Datasets e preços usando o tipo process. Use apenas datasets com active: true.

Parâmetros adicionais por dataset

Alguns datasets podem exigir campos adicionais. Consulte additional_fields no endpoint de datasets e preços para saber quais campos devem ser enviados. Exemplo de envio de dados adicionais:

Resposta

integer
required
Código da resposta da API.
string
required
Mensagem descritiva da resposta.
object
required
Objeto principal com os dados de acompanhamento da consulta assíncrona.

Estrutura de result

Status possíveis

Consulta do resultado

Após receber o id, consulte o andamento e o resultado final em:
Onde 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:
Campos descritos na estrutura dos datasets podem não aparecer em todas as consultas. A disponibilidade depende da fonte, do documento consultado e do dataset selecionado.

Respostas esperadas

As respostas possíveis estão exemplificadas no painel lateral da página.

Fluxo recomendado

  1. Liste os datasets disponíveis em Datasets e preços usando target: process.
  2. Selecione apenas datasets processuais ativos.
  3. Envie o CPF ou CNPJ, os datasets e os campos adicionais necessários.
  4. Guarde o id retornado.
  5. 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.