Consultar resultado da pré-análise
GET /pre-profile-analysis
Consulta o resultado de uma pré-análise do próprio parceiro, por CPF de uma das pessoas ou
pelo CRE-ID (protocolo). É a alternativa síncrona ao webhook profile_analysis.finished —
serve para reconciliação e para retomar um fluxo cujo evento você perdeu.
Query params — envie pelo menos um dos dois.
| Param | Tipo | Obrigatório | Regras |
|---|---|---|---|
cpf | string | Um dos dois | Exatamente 11 dígitos, sem pontuação, CPF válido |
creId | string | Um dos dois | Protocolo da análise. Tem precedência sobre cpf quando os dois são enviados |
Parâmetro presente e vazio (?cpf=) é tratado como ausente, não como valor inválido.
Sucesso — 200 OK (análise concluída)
{
"preProfileAnalysisId": "rentals_pa_abc123xyz",
"rentalPotentialInformed": 3000.0,
"rentalPotentialPresumed": 2500.0,
"persons": [
{ "cpf": "52998224725", "result": "APPROVED" }
]
}| Campo | Tipo | Descrição |
|---|---|---|
preProfileAnalysisId | string | Identificador da análise — o mesmo usado em POST /leads |
rentalPotentialInformed | number | Potencial de locação informado na análise |
rentalPotentialPresumed | number | Potencial de locação presumido pela análise |
persons[].cpf | string | CPF da pessoa |
persons[].result | string | Resultado por pessoa. Conjunto aberto — hoje APPROVED, REJECTED ou GREY_ZONE; trate valor desconhecido defensivamente |
Sucesso — 202 Accepted (análise encontrada, ainda processando)
Sem corpo. Não é erro: a análise existe mas não terminou. Tente de novo depois, ou espere o
webhook. Trate 202 explicitamente — desserializar o corpo vazio como se fosse 200 quebra.
Erros mapeados
| HTTP | code | Quando ocorre |
|---|---|---|
| 400 | PRE_PROFILE_ANALYSIS_INVALID_REQUEST | Nem cpf nem creId enviados, ou cpf malformado |
| 403 | PRE_PROFILE_ANALYSIS_PARTNER_NOT_AUTHORIZED | Parceiro não autorizado a consultar esta análise |
| 404 | PRE_PROFILE_ANALYSIS_NOT_FOUND | Nenhuma análise do parceiro corresponde ao cpf/creId — inclui análise de outro parceiro |
| 500 | PRE_PROFILE_ANALYSIS_INTEGRATION_FAILURE | Falha de comunicação interna — repetir com backoff |
Escopo por parceiro. Análise de outro parceiro responde
404, igual a análise inexistente
— o resultado não distingue os dois casos, por desenho.
Updated about 2 hours ago
