O endpoint /api/BoaVistaRiscoPositivoPJ permite consultar um CNPJ e retornar o Risco Positivo da empresa, incluindo score, indicadores, restrições financeiras, governança e dados cadastrais completos.
Boa Vista - Risco Positivo Pessoa Jurídica
Consulta responsável por verificar um CNPJ e retornar o Risco Positivo, oferecendo indicadores confiáveis para análises mais seguras, redução de incertezas e tomadas de decisão mais assertivas.
Casos de Uso
- Onboarding de clientes e fornecedores.
- Análise de risco e crédito para concessão mais segura.
- Avaliação de probabilidade de inadimplência.
- Apoio a decisões comerciais com base em score e indicadores positivos.
- Monitoramento da saúde financeira e comportamental de empresas.
Aplicações
- Onboarding de Clientes e Fornecedores
- Análise de Risco/Crédito
Benefícios
- Acesso automatizado ao Risco Positivo da Boa Vista.
- Indicadores confiáveis para reduzir incertezas na tomada de decisão.
- Visão ampla do comportamento financeiro, restrições, score e governança.
- Integração simples com sistemas internos de crédito, risco e compliance.
URL Base
A API está hospedada no seguinte endereço:
https://apiv3.directd.com.br/api/BoaVistaRiscoPositivoPJEndpoint
GET https://apiv3.directd.com.br/api/BoaVistaRiscoPositivoPJ?CNPJ={0}&Token=Seu_TokenDescrição: Endpoint para realizar consultas Boa Vista - Risco Positivo Pessoa Jurídica.
Nota: Esta consulta gera comprovantes em PDF.
Esta API suporta geração de comprovantes em PDF
Campos Retornados
- Ação: Informa sobre a ação.
- Ações Cíveis: Detalha sobre ações cíveis.
- Alertas: Detalhes sobre alertas.
- Anuência: Informa a anuência do registro.
- Autor: Informa o autor do registro.
- Bairro: Bairro do endereço
- Capital Social: Capital social do quadro societário
- Cargo: Cargo ou função do indivíduo
- Cartório: Informa o cartório do registro.
- CEP: Número CEP do endereço
- Cheques Sem Fundo BACEN: Detalhes sobre ocorrências de cheque sem fundo no BACEN.
- Cheques Sem Fundo Varejo: Detalhes sobre cheque sem fundo do varejo
- Cidade: Cidade do registro em questão
- Cidades Filiais: Informa as cidades das filiais da empresa.
- Classificação ABC: Informa a classificação ABC da empresa.
- Classificação em Número: Informa a classificação da empresa.
- CNAE Primário: Código do CNAE principal da empresa.
- CNAE Secundário: Informa o CNAE secundários da empresa.
- CNPJ: CNPJ da empresa
- Código da Situação: Informa o código da situação.
- Comarca: Comarco de origem do processo
- Complemento: Complemento do endereço do registro em questão
- Compromissos: Detalha os indicadores de compromissos.
- Contrato: Informa qual o contrato do registro.
- Contumácia: Informa restrições de contumácia.
- Correntista: Informa o correntista do registro.
- Crédito Obtido: Detalhes sobre o crédito obtido.
- Credor: Informa o credor do registro.
- Dados de Cadastro Positivo: Informa dados de cadastro positivo.
- Data: Data do registro
- Data da Consulta: Data da consulta
- Data da Primeira Ocorrência: Informa a data da primeira ocorrência.
- Data da Situação: Informa a data em que a empresa ficou com a devida situação.
- Data da Última Ocorrência: Data da última ocorrência
- Data de Consulta no Sintegra: Informa a data que a consulta do Sintegra foi realizada.
- Data de Distribuição: Data em que o processo foi distribuído.
- Data de Encerramento: Informa a data de encerramento da parcela anterior
- Data de Entrada: Data da entrada do sócio na empresa
- Data de Fundação: Data de fundação da empresa
- Data de Inclusão: Data de inclusão do registro
- Data de Referência: Data de referência do crédito rotativo
- Data de Situação do Sintegra: Informa a data em que a empresa ficou com a devida situação no Sintegra.
- Data de Vencimento: Data de vencimento do registro
- Data do Primeiro: Informa a data do primeiro registro.
- Data do Último: Informa a data do último registro.
- Data Final: Informa a data final do registro.
- Data Inicial: Informa a data inicial do registro.
- Data Maior: Informa a data do maior registro encontrado.
- Data Menor: Informa a data com a menor ocorrência.
- Data Primeira: Informa a data da primeira ocorrência.
- DDD: Retorna apenas o DDD do número de telefone.
- Descrição: Descrição do registro
- Descrição Plano: Descrição do plano.
- Descrição Score: Informa a descrição do score.
- Detalhes: Informa mais detalhes a respeito do indivíduo.
- Documento: Documento referente ao CPF/CNPJ
- E-mail: Endereço de e-mail da entidade
- Entidade: Nome da entidade
- Eventos de Pessoa Jurídica: Detalhes sobre eventos da pessoa jurídica.
- Execução: Informa a execução do registro.
- Faixa: Faixa do indicador de negócio
- Faixa de Funcionários: Número de funcionários estimado da empresa
- Falência e Recuperação Judicial: Detalhes sobre recuperação judicial.
- Faturamento Anual: Informa o faturamento anual da empresa.
- Faturamento Presumido: Faturamento estimado da empresa
- Foro: Nome do foro responsável
- Governanças: Detalhes sobre a governança.
- Histórico de consulta: Detalhes sobre o histórico de consultas.
- Indicador: Descreve o título do indicador
- Indicadores: Informações a respeito dos indicadores da entidade
- Informante: Informa de onde veio a informação.
- Inscrição Estadual: Inscrição estadual da entidade consultada
- Inscrição Estadual UF: Informa a UF na qual a inscrição estadual pertence.
- Layout: Informa o layout do registro.
- Limite de Crédito: Informa o limite de crédito.
- Lista de Administradores: Lista os administradores da empresa.
- Lista de Decisões: Lista as decisões do processo.
- Lista de Endereço: Lista os endereços do indivíduo
- Lista de Itens: Lista os itens disponíveis.
- Lista de Ocorrências: Lista as ocorrências que o indivíduo possui
- Lista de Protestos: Retorna a lista de protestos que o indivíduo possui
- Lista de Provedores: Lista os provedores da informação.
- Lista de Sócios: Lista de sócios da empresa
- Lista de Telefones: Telefones vinculados ao indivíduo
- Logradouro: Nome da rua, avenida, travessa, alameda ou outros onde está localizado o endereço.
- Mensagem: Informa uma mensagem a respeito do registro.
- Modalidade: Informa a modalidade do registro.
- Modelo do Score: Informa o modelo do score.
- Moeda: Informa a moeda do registro.
- Natureza Jurídica: Detalhes da natureza jurídica da entidade
- NIRE: Número de Identificação do Registro de Empresas
- NIRE UF: Informa o estado de cadastro do Número de Identificação do Registro de Empresas.
- Nome: Nome do indivíduo/registro
- Nome Fantasia: Nome fantasia da empresa
- Número: Número do registro em questão
- Observação: Observação relacionada ao registro retornado
- Opção Tributária: Informa a opção tributária da empresa.
- Origem: Origem do processo
- Pagamento Atrasado.: Detalhes sobre os indicadores de pagamentos atrasados.
- Pagamento Pontual: Dealha sobre o indicador de pagamento pontual.
- Pendências Financeiras: Retorna os dados relacionados à pendência financeira.
- Percentual de Participação: Percentual de participação do sócio na empresa
- Período: Informa o período do registro.
- Período de Relacionamento de Fornecedores: Detalha sobre o indicador de período de relacionamento com fornecedores.
- Período Final: Informa o período final do registro.
- Período Inicial: Período de início do registro.
- Pontuação: Pontuação do registro.
- Pontuação Mensal: Informa a pontuação mensal.
- Porte: Porte da empresa, referindo-se ao tamanho da mesma
- Probabilidade de Inadimplência: Informa a probabilidade de inadimplência da entidade.
- Processo: Detalhe sobre o processo
- Quantidade: Quantidade de registros
- Quantidade de Administradores: Informa a quantidade de administradores da empresa.
- Quantidade de Filiais: Informa a quantidade de filiais que a empresa possui
- Quantidade de Ocorrências: Informa a quantidade de ocorrências.
- Quantidade de Sócios: Informa a quantidade de sócios da empresa.
- Ramo de Atividade Primário: Informa o ramo de atividade primário da empresa.
- Ramo de Atividade Secundário: Informa o ramo de atividade secundário da empresa.
- Razão Social: Razão social da empresa
- Razão Social Anterior: Informa a razão social anterior da empresa.
- Requerido: Informa o requerido do registro.
- Restrições: Detalhes sobre as restrições as quais a empresa possui.
- Resultado: Informa o resultado.
- Risco: Descreve o risco que a entidade possui com relação ao indicador analisado
- Score: Pontuação da entidade consultada
- Situação: Situação do registro em questão
- Situação do Documento: Informa a situação do documento da entidade.
- Situação Sintegra: Informa a situação da empresa perante o Sintegra.
- Sub Judice: Informa sobre o sub judice do registro.
- Telefone: Número de telefone do indivíduo ou entidade
- Texto da Publicação: Texto de publicação da sanção
- Tipo: Tipo do registro em questão
- Tipo de Anotação: Informa o tipo de anotação.
- Tipo de Documento: Informa o tipo de documento da entidade.
- Tipo de Pessoa: Tipo de pessoa do indivíduo consultado
- Tipo de Sociedade: Informa o tipo de sociedade da empresa.
- Tipo do Devedor: Informa que tipo de devedor é o indivíduo consultado
- Tipo do Score: Informa o tipo de score.
- Título: Título da certidão
- Total de Credores: Informa o total de credores.
- UF: Unidade Federativa (estado) referente ao registro
- Último Protesto: Informa o último protestos.
- Último Vencimento: Informa o último vencimento que a entidade possui.
- Valor: Valor da parcela
- Valor das Custas: Informa o valor das custas do registro.
- Valor do Último: Informa o valor do último registro.
- Valor Maior: Informa o maior valor.
- Valor Menor: Informa o menor valor do registro.
- Valor Presumido: Informa a renda presumida da empresa.
- Valor Primeiro: Informa o valor do primeiro registro.
- Valor Total: Valor total do registro
- Vara: Vara que o processo pertence
- Vencimento: Data de vencimento do registro
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
CNPJ | string | Sim | O parâmetro CNPJ pode ser enviado com ou sem formatação. |
TOKEN | string | Sim | O parâmetro TOKEN é essencial para efetuar esta consulta. Em caso de dúvidas, por favor, entre em contato com: suporte@directd.com.br |
Exemplo de Resposta
{
"metaDados": {
"consultaNome": "string",
"consultaUid": "string",
"chave": "string",
"usuario": "string",
"mensagem": "string",
"ip": "string",
"resultadoId": 0,
"resultado": "string",
"apiVersao": "v3",
"enviarCallback": false,
"gerarComprovante": false,
"urlComprovante": "string",
"assincrono": true,
"data": "dd/MM/yyyy HH:mm:ss",
"tempoExecucaoMs": 0
},
"retorno": {
"empresa": {
"cnpj": "string",
"razaoSocial": "string",
"razaoSocialAnterior": "string",
"nomeFantasia": "string",
"situacao": "string",
"situacaoSintegra": "string",
"dataSituacao": "string",
"dataConsulta": "string",
"dataFundacao": "string",
"dataEncerramento": "string",
"dataSituacaoSintegra": "string",
"dataConsultaSintegra": "string",
"inscricaoEstadual": "string",
"inscricaoEstadualUf": "string",
"naturezaJuridica": "string",
"faixaFuncionarios": "string",
"quantidadeFiliais": "string",
"cidadesFiliais": "string",
"nire": "string",
"nireUf": "string",
"ramoAtividadePrimario": "string",
"ramoAtividadeSecundario": "string",
"cnaePrimario": "string",
"cnaeSecundario": "string",
"capitalSocial": "string",
"telefone": "string",
"email": "string",
"tipoSociedade": "string",
"opcaoTributaria": "string",
"porte": "string",
"endereco": {
"rua": "string",
"bairro": "string",
"cidade": "string",
"uf": "string",
"cep": "string"
}
},
"decisoes": {
"codigoSituacao": "string",
"descricao": "string",
"observacoes": "string",
"layout": "string"
},
"score": {
"layout": "string",
"tipoScore": "string",
"score": "string",
"execucao": "string",
"descrPlano": "string",
"descrScore": "string",
"classificacaoABC": "string",
"classificacaoNumero": "string",
"probabilidadeInadimplencia": "string",
"texto": "string",
"risco": "string",
"modeloScore": "string",
"informante": "string"
},
"indicadores": {
"creditoObtido": {
"pontuacao": "string",
"ocorrencias": [
{
"periodo": "string",
"pontuacao_Mensal": "string"
}
]
},
"compromissos": {
"pontuacao": "string",
"ocorrencias": [
{
"periodo": "string",
"pontuacao_Mensal": "string"
}
]
},
"pagamentoPontual": {
"pontuacao": "string",
"ocorrencias": [
{
"periodo": "string",
"pontuacao_Mensal": "string"
}
]
},
"pagamentoAtrasado": {
"ocorrencias": [
{
"descricao": "string",
"pontuacao": "string",
"itens": [
{
"periodo": "string",
"pontuacao_Mensal": "string"
}
]
}
]
},
"eventosPessoaJuridica": {
"pontuacao": "string",
"ocorrencias": [
{
"indicador": "string",
"periodo": "string",
"pontuacao": "string"
}
]
},
"periodoRelacionamentoFornecedores": {
"pontuacao": "string",
"ocorrencias": [
{
"periodo": "string",
"valor": "string"
}
]
}
},
"restricoes": {
"pendenciasFinanceiras": {
"quantidade": "string",
"valorTotal": "string",
"periodoInicial": "string",
"periodoFinal": "string",
"ultimoVencimento": "string",
"dataPrimeiro": "string",
"dataMaior": "string",
"totalCredores": "string",
"valorMaior": "string",
"valorPrimeiro": "string",
"provedores": [
"string"
],
"ocorrencias": [
{
"dataVencimento": "string",
"dataInclusao": "string",
"informante": "string",
"tipoDevedor": "string",
"credor": "string",
"moeda": "string",
"valor": "string",
"contrato": "string",
"origem": "string",
"subjudice": "string",
"modalidade": "string",
"entidade": "string"
}
]
},
"protestos": {
"quantidade": "string",
"valorTotal": "string",
"ultimoProtesto": "string",
"dataPrimeiro": "string",
"dataUltimo": "string",
"dataMaior": "string",
"valorPrimeiro": "string",
"valorUltimo": "string",
"valorMaior": "string",
"ocorrencias": [
{
"data": "string",
"moeda": "string",
"valor": "string",
"valorCustas": "string",
"quantidade": "string",
"cartorio": "string",
"origem": "string",
"credor": "string",
"anuencia": "string",
"tipoAnotacao": "string",
"subjudice": "string",
"vencimento": "string"
}
]
},
"chequesSemFundoBacen": {
"quantidade": "string",
"correntista": "string",
"tipoPessoa": "string",
"documento": "string"
},
"chequesSemFundoVarejo": {
"quantidade": "string",
"correntista": "string",
"tipoPessoa": "string",
"documento": "string"
},
"contumacia": {
"quantidade": "string",
"dataPrimeiraOcorrencia": "string",
"dataUltimaOcorrencia": "string"
},
"acoesCiveis": {
"quantidade": "string",
"valorTotal": "string",
"valorPrimeiro": "string",
"valorUltimo": "string",
"valorMaior": "string",
"valorMenor": "string",
"dataPrimeira": "string",
"dataUltimo": "string",
"dataMaior": "string",
"dataMenor": "string",
"ocorrencias": [
{
"requerido": "string",
"valor": "string",
"acao": "string",
"documento": "string",
"foro": "string",
"origem": "string",
"vara": "string",
"comarca": "string",
"autor": "string",
"processo": "string",
"dataDistribuicao": "string"
}
]
},
"falenciaRecuperacaoJudicial": {
"quantidade": "string",
"periodoInicial": "string",
"periodoFinal": "string",
"ocorrencias": [
{
"tipo": "string",
"data": "string",
"origem": "string",
"vara": "string"
}
]
},
"limiteCredito": {
"descricao": "string",
"valor": "string",
"texto": "string"
},
"faturamentoPresumido": {
"faixa": "string",
"faturamentoAnual": "string",
"mensagem": "string",
"dataReferencia": "string",
"valorPresumido": "string",
"dadosCadastroPositivo": "string"
}
},
"governancas": {
"quantidadeAdministradores": "string",
"administradores": [
{
"nome": "string",
"documento": "string",
"cargo": "string",
"dataEntrada": "string",
"situacaoDocumento": "string"
}
],
"quantidadeSocios": "string",
"socios": [
{
"nome": "string",
"documento": "string",
"percentualParticipacao": "string",
"tipoDocumento": "string",
"situacaoDocumento": "string"
}
]
},
"alertas": [
{
"titulo": "string",
"observacoes": "string",
"tipo": "string"
}
],
"historicoConsulta": {
"quantidadeOcorrencias": "string",
"dataInicial": "string",
"dataFinal": "string",
"detalhes": [
{
"data": "string",
"razaoSocial": "string",
"cnpj": "string"
}
]
}
}
}Erros Comuns
| Código | Descrição |
|---|---|
400 | Requisição Inválida: 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. Por favor, entre em contato com o nosso suporte. |
503 | Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte. |
Notas Importantes
- Para obter o comprovante desta consulta, utiliza-se: '&GerarComprovante=habilitar' na URL
- Para utilizar a consulta de forma assíncrona, utiliza-se: '&async=habilitar' na URL
- Em caso de dúvidas/suporte, entre em contato pelo e-mail: suporte@directd.com.br ou pelo nosso WhatsApp: (11) 93906-9228