Descrição
Essa consulta retorna dados de um birô de crédito de mercado. Retorna a pontuação de score de um indivíduo, avaliando a probabilidade de inadimplência.
Atenção: As consultas de crédito são desabilitadas por segurança. Assim que habilitadas, o usuário conta com um limite de 500 consultas por mês. Caso deseje habilitar ou aumentar o limite de consultas, por favor, entre em contato por email com a equipe de atendimento.
Origem da Informação
Todas as informações desse dataset tem origem no birô de crédito que é consultado.
Tabela de preços para esse dataset
| Consultas Realizadas no Mês | Valor por consulta |
|---|---|
| 1 - 10000 | R$ 13,010 |
| 10001 - 50000 | R$ 12,359 |
| 50001 - 100000 | R$ 11,741 |
| 100001 - 500000 | R$ 11,154 |
| 500001 e acima | R$ 10,596 |
Parâmetros de consulta
A tabela abaixo detalha os campos aceitos na consulta a este dataset.
| Campo | Descrição | Valores Possíveis | Tipo de Campo |
|---|---|---|---|
| doc | Documento de identificação | CPF | 🛑 Obrigatório |
| type | Tipo de modelo de score a ser consultado. Caso nenhum modelo seja passado, será retornado o score geral. | vehicles, card, mix, overall, fpd, real_estate, loan, retail | ℹ️ Opcional |
Clique aqui para saber mais sobre os parâmetros de consulta da Plataforma de Dados.
Abaixo está um exemplo de como realizar a chamada apenas com os parâmetros obrigatórios:
{
"Datasets": "partner_boavista_one_score_person",
"q": "doc{CPF},type{vehicles}"
}
Modelos de Score disponíveis
A API oferece diferentes modelos de score de crédito, cada um adaptado para uma modalidade de crédito específica. O parâmetro 'type' define qual modelo será consultado. Segue a lista e descrição de cada um:
| Parâmetro | Descrição do Modelo |
|---|---|
| vehicles | Avalia a probabilidade de inadimplência na concessão de financiamento de veículos (atraso superior a 60 dias em 6 meses). |
| card | Avalia a probabilidade de inadimplência na concessão de cartão de crédito (atraso superior a 60 dias em 6 meses). |
| mix | Combina histórico positivo e negativo para avaliar o cliente. |
| overall | Avalia a probabilidade de inadimplência em qualquer modalidade de crédito (atraso de pelo menos 60 dias em 6 meses). |
| fpd | Avalia a probabilidade de inadimplência no pagamento da primeira fatura/parcela (atraso de pelo menos 30 dias). |
| real_estate | Avalia a probabilidade de inadimplência na concessão de crédito imobiliário (atraso superior a 60 dias em 6 meses). |
| loan | Avalia a probabilidade de inadimplência na concessão de crédito pessoal. |
| general | Modelo geral de score de crédito (atraso de pelo menos 60 dias em 6 meses). |
| retail | Avalia a probabilidade de inadimplência na concessão de crédito do segmento Varejo (atraso superior a 60 dias em 6 meses). |