Inicia uma consulta do JusScore

Recebe um CPF ou CNPJ e inicia a busca de processos judiciais. A consulta é assíncrona: a resposta normal traz situacao: "PROCESSANDO" e o id_consulta, que deve ser consultado em GET /api/jus-score/{id_consulta} até concluir.

Quando o mesmo documento já foi consultado nos últimos 30 dias, o resultado completo vem já nesta resposta, com situacao: "CONCLUIDA".

Acompanhando a consulta (polling)

• Intervalo: repita o GET a cada ~15 segundos enquanto a situacao for "PROCESSANDO".
• Custo: a consulta é cobrada uma única vez, no POST. Os GETs de acompanhamento não são cobrados, em nenhuma situação.
• Estados: situacao só tem "PROCESSANDO" e "CONCLUIDA"; não existe estado de falha. Erros de comunicação com a base de processos voltam como 502/504 no GET e a consulta segue válida: repita em instantes.
• Quando desistir: tempo esperado de conclusão e limite de espera pendente: produto.
• Passado o limite: o que fazer (novo POST ou suporte) pendente: produto.

Webhook (opcional)

Informe url_retorno (https) e nós entregamos o resultado por POST nela assim que a consulta concluir — sem necessidade de polling. A entrega leva a sua API key no header x-api-key: é assim que você confirma que a chamada veio da Jusfy. Compare com a sua key antes de aceitar o payload.

Responda 2xx para confirmar o recebimento. Qualquer outra resposta (ou timeout de 15s) é retentada 5 vezes, com espera crescente de 1min, 5min, 15min, 1h e 6h. Esgotadas as tentativas, a entrega é registrada como falha e o resultado continua disponível pelo GET.

Headers da entrega: x-api-key (sua key), x-jusfy-event (jus_score.concluida) e x-jusfy-delivery (o id_consulta, útil para deduplicar).

POST /api/jus-score

Inicia uma consulta do JusScore

cURL

curl --request POST \
  --url https://api.jusfy.dev/calculators/api/jus-score \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "documento": "14065221803",
  "url_retorno": "https://seu-sistema.com.br/webhooks/jus-score"
}
'

200

Autorizações

x-api-key · string · header · obrigatório

Corpo

application/json

documento · string · obrigatório

CPF (11 dígitos) ou CNPJ (14 dígitos) do consultado, com ou sem máscara. Separadores são aceitos e ignorados.

Exemplo:

"14065221803"

url_retorno · string

URL https que receberá o resultado por POST quando a consulta concluir. Opcional — sem ela, consulte o resultado pelo GET. A entrega inclui sua API key no header x-api-key.

Exemplo:

"https://seu-sistema.com.br/webhooks/jus-score"

Resposta

200

application/json

Consulta iniciada (PROCESSANDO) ou resultado completo, quando o documento já estava em cache.