Debitado do seu saldo a cada chamada cobrada. Autenticação pelo header X-API-Key. Veja como obter a chave.
Entrega a análise de crédito positiva de pessoa jurídica da Boa Vista/Equifax, orientada à recomendação de limite de crédito. A partir do CNPJ, retorna a identificação cadastral da empresa (razão social, nome fantasia, situação, data de fundação, natureza jurídica, CNAEs, capital social, endereço), o score de risco em 12 meses com probabilidade de inadimplência, a decisão de negociação, o limite de crédito sugerido, o faturamento presumido e as restrições (pendências, protestos, cheques sem fundo, ações cíveis, falências/recuperações). Além disso, descreve a governança e o quadro societário, listando cada sócio com o seu percentual de participação no capital, e mapeia as participações desses sócios/administradores em outras empresas (também com o percentual em cada uma). É voltada à definição de limite, política de crédito e avaliação de risco de fornecedores/clientes PJ.
decisoes: recomendação de negociação (código, descrição e layout).
score: score de risco 12 meses, classificação numérica/ABC, probabilidade de inadimplência e texto interpretativo.
restricoes.limiteCredito: limite de crédito recomendado (valor, descricao, texto).
restricoes.faturamentoPresumido: faturamento anual presumido e faixa.
indicadores: crédito obtido, compromissos, pontualidade e histórico de pagamento.
Restrições
restricoes.pendenciasFinanceiras, protestos, chequesSemFundoBacen, chequesSemFundoVarejo, contumacia, acoesCiveis, falenciaRecuperacaoJudicial: quantidades, valores e ocorrências de cada tipo.
alertas[]: alertas informativos (ex.: ramos de atividade adicionais).
governancas.socios[]: cada sócio com nome, documento, tipoDocumento, situacaoDocumento e, principalmente, percentualParticipacao (percentual do sócio no capital da empresa).
participacoes.participacoesSocioAdmOutrasEmpresas[]: para cada sócio/administrador, a lista de outras empresas em que participa, cada uma com razaoSocial, cnpj, situacaoCnpj, indicadores de débito/fraude e o campo participacao (percentual do sócio naquela empresa).
historicoConsulta: consultas anteriores realizadas ao CNPJ.
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").
O limite de crédito só é informado quando a negociação é recomendada; em decisão neutra ou não recomendada, o valor retorna "R$ 0,00" com texto explicativo.
Percentuais de participação vêm como texto, muitas vezes com zeros à esquerda e vírgula decimal (ex.: "080,00"); interprete como valor percentual.
Quantidades vêm como string numérica; blocos sem registro trazem quantidade "0" e listas vazias ou nulas.
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.