Docs/API Reference/Predições
DashboardGitHub

O módulo de predições identifica dívidas com alta probabilidade de inadimplência antes que se tornem irrecuperáveis. Usa modelos estatísticos baseados em histórico de pagamento, comportamento conversacional e dados do bureau.

Endpoints

#
MétodoEndpointDescrição
GET/api/predictions/at-riskDívidas com alta probabilidade de inadimplência
GET/api/predictions/statsEstatísticas de predições
POST/api/predictions/scoreDisparar scoring preditivo
ℹ️

Todos os endpoints requerem autenticação via JWT (Authorization: Bearer TOKEN).


Dívidas em risco

GET/api/predictions/at-risk

Retorna as dívidas classificadas com maior risco de inadimplência, ordenadas por probabilidade. Inclui os fatores de risco e ação recomendada (contato urgente, desconto preventivo, etc.).


Estatísticas de predições

GET/api/predictions/stats

Retorna indicadores do modelo preditivo: total de dívidas analisadas, acurácia histórica, distribuição por faixa de risco e valor total em risco.


Disparar scoring preditivo

POST/api/predictions/score

Dispara o cálculo preditivo para todas as dívidas ativas. O processo roda em background via fila (BullMQ) e atualiza os scores conforme completa.

⚠️

O scoring preditivo é um processo intensivo. Recomendamos executar no máximo uma vez por dia.