Crédito, renda e birô

Risco Financeiro

O serviço de Risco Financeiro retorna a pontuação de risco financeiro de um indivíduo com base em seus dados econômicos, profissionais e histórico de cobranças.

Falar com o comercial Ver o catálogo

Quando usar

Descrição

O serviço de Risco Financeiro fornece uma pontuação de risco financeiro a partir da análise de dados econômicos, profissionais e da presença em cobranças ao longo do tempo.

Requisição

Autenticação por chave de API (cabeçalho Authorization: Bearer), criada no painel com esta consulta no escopo.

POST /api/v1/{tenant}/pessoas/risco-financeiro

Campo	Obrigatório	Descrição
`document`	sim	CPF da pessoa, com ou sem máscara.

{
  "document": "000.000.000-00"
}

Campos de retorno

Campos dentro de data. [] indica lista.

Campo	Tipo
`TotalAssets`	texto
`EstimatedIncomeRange`	texto
`IsCurrentlyEmployed`	booleano
`IsCurrentlyOwner`	booleano
`LastOccupationStartDate`	data
`IsCurrentlyOnCollection`	booleano
`Last365DaysCollectionOccurrences`	número
`CurrentConsecutiveCollectionMonths`	número
`IsCurrentlyReceivingAssistance`	booleano
`FinancialRiskScore`	número
`FinancialRiskLevel`	texto

Exemplo de resposta

Estrutura real da resposta, com valores fictícios.

{
  "execution_id": "00000000-0000-0000-0000-000000000000",
  "status": "success",
  "message": "Consulta realizada com sucesso",
  "query_name": "Risco Financeiro",
  "query_slug": "risco-financeiro",
  "data": {
    "TotalAssets": "texto",
    "EstimatedIncomeRange": "texto",
    "IsCurrentlyEmployed": false,
    "IsCurrentlyOwner": false,
    "LastOccupationStartDate": "2026-01-01",
    "IsCurrentlyOnCollection": false,
    "Last365DaysCollectionOccurrences": 0,
    "CurrentConsecutiveCollectionMonths": 0,
    "IsCurrentlyReceivingAssistance": false,
    "FinancialRiskScore": 0,
    "FinancialRiskLevel": "texto"
  },
  "consulted_at": "2026-01-01T12:00:00Z",
  "query_cost": "0.500"
}

Cobrança e respostas

O valor é cobrado por consulta bem-sucedida.
200 — consulta processada (veja status no corpo da resposta)
401 — token ausente, inválido, inativo ou expirado
403 — serviço fora do escopo da chave, IP não autorizado ou limite de consumo excedido
422 — campo obrigatório ausente/inválido ou payload acima do limite do serviço
429 — limite de requisições por minuto da chave excedido
504 — tempo máximo de execução do serviço excedido