Skip to main content
A API de dados tem duas rotas. Em POST /dados/consultar você envia um CPF ou CNPJ e a lista de datasets que quer, e recebe um bloco resumido para cada dataset pedido. Em GET /dados/processos/{numero} você recebe o detalhe de um processo pelo número CNJ, com os movimentos paginados (veja Detalhe de processo). Cada dataset tem uma página própria com a rota já preenchida: veja o catálogo de datasets.
A chave de API vai no cabeçalho X-API-Key: <chave>: veja Autenticação. A rota valida a chave e o escopo por dataset: POST /dados/consultar exige dados:consultar e dados:<dataset> para cada dataset pedido (dados:pep, dados:processos, …). Faltando um, responde 403 (escopo_insuficiente). GET /dados/processos/{numero} exige dados:processos. Todos os exemplos desta aba usam documentos e números sintéticos.

Requisição

O cabeçalho opcional Idempotency-Key faz a mesma chave, em 24 horas a partir da primeira chamada, devolver a mesma resposta, sem repetir a leitura.

Resposta

Só aparecem os datasets pedidos. Cada bloco traz encontrado e itens resumidos. O bloco de processos traz ainda total e proximo_cursor: repita a chamada com processos.cursor até proximo_cursor vir null.

Mascaramento de documentos de terceiros

Quando um item cita uma pessoa ou empresa que não é a consultada (por exemplo, uma parte de um processo), o documento dela vem mascarado e o nome vem inteiro. O documento da entidade consultada não é mascarado. Continue em Datasets e Erros.