Docs/API Reference/Bureau / Serasa
DashboardGitHub

Integração com o bureau de crédito Serasa Experian para consulta de score e enriquecimento de dados cadastrais dos devedores. As consultas ajudam a priorizar a cobrança e ajustar a estratégia de negociação.

Endpoints

#
MétodoEndpointDescrição
GET/api/bureau/query/:cpfConsultar score Serasa por CPF
POST/api/bureau/enrich/:debtIdEnriquecer dívida com dados do bureau
ℹ️

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


Consultar score Serasa

GET/api/bureau/query/:cpf

Consulta o score de crédito de um CPF junto à Serasa Experian. Retorna score (0-1000), faixa de risco e dados cadastrais básicos.

⚠️

Cada consulta consome um crédito do bureau. O uso é tarifado conforme o plano contratado.


Enriquecer dívida

POST/api/bureau/enrich/:debtId

Enriquece os dados de uma dívida com informações do bureau: telefones adicionais, endereço atualizado e score de crédito. Os dados são vinculados automaticamente à dívida.