Debitado do seu saldo a cada chamada cobrada. Autenticação pelo header X-API-Key. Veja como obter a chave.
Consolida em uma única resposta a análise de crédito positiva de pessoa física fornecida pela Boa Vista/Equifax. A partir do CPF, retorna a situação do documento na Receita, dados cadastrais básicos, o score positivo com a probabilidade de inadimplência associada, a renda presumida, a recomendação de decisão de negociação e o levantamento de eventuais restrições — pendências financeiras, protestos, cheques sem fundo (varejo e Bacen), ações cíveis e falências/recuperações. Também lista as empresas em que a pessoa figura como sócia ou administradora e indicadores do cadastro positivo. É indicada para decisões de concessão de crédito, análise de risco e onboarding.
telefones[], enderecos[]: contatos e endereços conhecidos.
Score e renda
scores.ocorrencias[]: score positivo, classificação (numérica e ABC), probabilidade de inadimplência, faixa de risco e texto interpretativo.
rendaPresumida: faixa de renda estimada e descrição.
decisao: recomendação de negociação (código e descrição, ex.: "NEGOCIAÇÃO NÃO RECOMENDADA").
controlePositivo: notas de comportamento de faturas em atraso e de contratos recentes.
Restrições e histórico
restricoes: ocorrências informativas do cadastro (ex.: status do consumidor no cadastro positivo).
pendenciasFinanceiras, protestos, chequeSemFundoVarejo, chequeSemFundoBacen, falenciasAcoesRecuperacoes, acoesCiveis, passagensComerciais: quantidades, valores e ocorrências de cada tipo de restrição.
participacaoEmEmpresas: empresas nas quais o CPF consta como sócio/administrador, com cargo, participação e data de entrada.
a requisição está incorreta ou os parâmetros são inválidos.
401
Não Autenticado
o usuário não forneceu as credenciais corretas para acessar o recurso.
403
Não Autorizado
o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível.
404
Não Encontrado
o servidor não encontrou uma representação atual do recurso solicitado.
408
Tempo Esgotado
o servidor não conseguiu retornar a requisição no prazo estabelecido.
500
Falha ao Realizar Consulta
o servidor não conseguiu processar a requisição com sucesso.
503
Consulta em Manutenção
a consulta requisitada está em manutenção.
Observações
Fonte: Boa Vista SCPC / Equifax (base do cadastro positivo, identificada como "BASE III").
Valores monetários e percentuais vêm como texto, frequentemente com vírgula decimal (ex.: "4,00").
Quantidades de ocorrências são retornadas como string numérica; blocos sem registro trazem quantidade "0" e listas vazias.
A cobrança ocorre pela consulta realizada, independentemente de haver ou não restrições no resultado.
A disponibilidade depende do serviço da Boa Vista; em manutenção, a consulta pode retornar indisponível.
Integrar
OpenAPI (JSON) ↗ — importe a URL
no Postman ou no Insomnia para gerar a coleção com todos os endpoints. Também dá para consultar
pelo chat: conecte via MCP. Esta página em Markdown.