Pular para o conteúdo principal
POST
Dispara a busca de processos de um CPF ou CNPJ (assíncrona)

Autorizações

x-api-key
string
header
obrigatório

Corpo

application/json
document
string
obrigatório

CPF ou CNPJ do titular consultado, com ou sem máscara. Separadores (incluindo a barra do CNPJ) são aceitos e ignorados. O dígito verificador é validado antes da consulta.

Exemplo:

"52998224725"

url_retorno
string

URL https que receberá o aviso quando a consulta terminar. Opcional: sem ela, o resultado é obtido apenas pelas rotas de protocolo. O webhook leva os processos quando eles cabem no corpo (teto de 64 KiB, ~16 processos); acima disso leva só o resumo (totalFound, returned, truncated). O campo dataIncluded, no topo do corpo, diz qual dos dois casos ocorreu — e quando é false a chave lawsuits fica ausente, nunca vazia. Em qualquer caso os processos podem ser buscados em GET /api/consultas/buscador-processual/{id}/processos, paginado. Deve apontar para um domínio público na porta 443; endereços IP, hosts internos e http são recusados. A entrega é assinada; o segredo vem no campo signingSecret da resposta e não é exibido novamente.

Exemplo:

"https://cliente.exemplo.com/webhooks/jusfy"

Resposta

Consulta aceita e em processamento. Guarde o id — e o signingSecret, que não é exibido novamente.

The response is of type object.