Fluxo assíncrono
Como funcionam as consultas com requestId: criar, acompanhar e ler o resultado.
A maior parte das consultas é assíncrona: a busca nos tribunais e nas bases oficiais pode levar alguns segundos, então a API responde na hora com um requestId e processa em segundo plano.
1. Crie a consulta
cURL
curl -X POST "https://consultadeprocessos.com.br/api/partner/v2/people/pep" \
-H "Authorization: Bearer SUA_CHAVE_DE_API" \
-H "Content-Type: application/json" \
-d '{"document":"12345678901"}'JSON
{
"requestId": "cm8p1q2r30004ab12cdef5678",
"message": "Solicitação realizada com sucesso"
}A cobrança acontece nesse momento. Guarde o requestId.
2. Acompanhe o status
Chame o GET da consulta com o requestId a cada 2 ou 3 segundos:
JSON
{ "status": "pending", "message": "Solicitação em andamento" }| Status | O que significa | O que fazer |
|---|---|---|
pending, running, processing | Ainda processando | Espere e repita o GET |
done | Pronto, o resultado está em data | Leia o resultado |
error | A consulta falhou | Leia message; o valor já voltou para o saldo |
3. Leia o resultado
JSON
{
"status": "done",
"data": { "document": "12345678901", "isCurrentlyPEP": false }
}O resultado fica disponível pelo mesmo requestId. Ler de novo, paginar ou filtrar não gera nova cobrança.
Consultas síncronas
O Processo por CNJ responde na hora: o POST já devolve o processo completo. O requestId dele serve para paginar as movimentações.