Introdução
Seja bem-vindo à documentação da API Know Your Business (KYB) do Instituto Evereste, uma solução completa para verificação, validação e monitoramento de empresas. Nossa API foi desenvolvida para atender aos mais altos padrões de compliance, possibilitando que sua empresa realize due diligence, prevenção à lavagem de dinheiro (AML), onboarding de clientes corporativos e análise de riscos de forma ágil e automatizada.
Esta documentação fornecerá uma visão detalhada sobre os endpoints disponíveis, parâmetros de requisição, estrutura de resposta e melhores práticas de uso da API.
Por que utilizar a API KYB?
A API KYB permite acesso a um conjunto de informações essenciais sobre empresas, fornecedores e parceiros comerciais, garantindo conformidade regulatória, prevenção a fraudes e aumento da eficiência na análise de negócios. Através da integração, sua empresa poderá:
- Automatizar processos de verificação de CNPJ e compliance.
- Reduzir riscos de fraude e irregularidades fiscais.
- Consultar registros públicos e privados em tempo real.
- Acompanhar mudanças cadastrais e monitorar fornecedores.
Indicações de Uso
- Prevenção à Lavagem de Dinheiro e Financiamento ao Terrorismo (AML/CFT)
- Identificação de empresas de fachada e suspeitas.
- Verificação de sócios e beneficiários finais (UBO - Ultimate Beneficial Owner).
- Detecção de transações suspeitas antes da contratação.
- Gestão de Risco e Compliance Regulatório
- Atendimento às normativas de Bancos Centrais e órgãos reguladores.
- Verificação de histórico empresarial em bases públicas e privadas.
- Redução de Fraudes Empresariais
- Identificação de empresas inativas ou fictícias.
- Consulta de regularidade fiscal e tributária.
- Verificação de mudanças cadastrais frequentes, indicativas de fraude.
- Onboarding de Fornecedores e Prestadores de Serviço
- Validação de CNPJ, CNAE, endereço e quadro societário.
- Monitoramento contínuo para mudanças estruturais na governança.
- Consulta a processos judiciais, falências e restrições financeiras.
- Monitoramento de Parceiros e Clientes Corporativos
- Avaliação de parceiros comerciais e empresas investidas.
- Identificação de conflitos de interesse e envolvimento com corrupção.
- Verificação da idoneidade da empresa ao longo do tempo.
- Automação e Eficiência em Processos de Due Diligence
- Redução de tempo na análise manual de documentos.
- Uso de OCR e IA para extração de dados de registros empresariais.
- Integração com APIs para cruzamento de dados em tempo real.
- Melhoria na Experiência do Cliente e Parceiros Comerciais
- Onboarding rápido e sem burocracia.
- Personalização da análise de risco conforme o tipo de cliente ou parceiro.
- Validação automatizada de documentos, reduzindo necessidade de reenvio.
Estrutura da API KYB
Parâmetros da Consulta:
- CNPJ
- Dados de Registro Empresarial - Fornece informações detalhadas sobre empresas, incluindo razão social, situação cadastral, quadro societário e histórico de falências.
- Certidões e Regularidade
- CRF - Consulta Regularidade do Empregador - Consulta a situação de regularidade do FGTS (CRF).
- Certidão Conjunta Empresa Idônea - Verifica antecedentes de corrupção e penalidades administrativas em bases da CGU, CEIS, CNEP e CEPIM.
- CEIS - Cadastro Nacional de Empresas Inidôneas e Suspensas, contendo empresas e pessoas físicas impedidas de participar de licitações ou contratos públicos.
- CNEP - Cadastro Nacional de Empresas Punidas conforme a Lei nº 12.846/2013 (Lei Anticorrupção).
- CEPIM - Cadastro de Entidades Privadas sem Fins Lucrativos Impedidas de firmar novos convênios e contratos com a Administração Pública Federal.
- CND Empresa - Certidão de Débitos Federais - Consulta a Certidão de Débitos Relativos a Créditos Tributários Federais e à Dívida Ativa da União.
- CND Trabalhista - Consulta a Certidão Negativa de Débitos Trabalhistas (CNDT) no Tribunal Superior do Trabalho.
Autenticação
Use a chave de API fornecida para autenticação segura.
Como Usar a API KYB
Para utilizar a API, siga os passos:
- Autenticação: Utilize a chave de API fornecida para acesso seguro.
- Envie Requisições: Faça consultas via REST API utilizando os parâmetros adequados.
- Receba Respostas Estruturadas: Os dados serão retornados em JSON, permitindo integração eficiente.
Fluxo
Figura 1 - Fluxo de entrada e saída no consumo da API.
Endpoints
[POST] /PostSolicitaConsulta
Descrição: Este endpoint recebe um número de CNPJ e realiza a consulta dos dados da razão social correspondente.
Funcionamento:
- Envia o CNPJ para processamento.
- Retorna um JSON contendo:
- Status da solicitação (processando / dados e certificados).
- Protocolo da consulta.
URL: https://sandbox.conformedocs.com.br/PostSolicitaConsulta
Headers:
- x-API-KEY: {Chave da API}
- x-CNPJ: {sem ponto, traço ou barra}
Body 200
{
"erros": false,
"retorno": "Sucesso na solicitação da consulta.",
"Protocolo": "0000XX00X00X000000000XX0X0X "
}
Exemplo de retorno com erro:
Erro caso o CNPJ seja menor que 14 caracteres.
{
"erros": true,
"retorno": "CNPJ inválido."
}
Erro caso o CNPJ seja menor que 14 caracteres:
{
"erros": true,
"retorno": "CNPJ inválido."
}
Erro caso a x-API-KEY esteja errada:
{
"erros": true,
"retorno": "Acesso negado."
}
Erro caso tenha atingido o limite mensal de consultas:
{
"erros": true,
"retorno": "Limite de consultas mensal excedido."
}
Retorno caso já exista um protocolo em aberto para o CNPJ inserido:
{
"erros": false,
"retorno": "Já existe um protocolo para o documento informado.",
"Protocolo": "0000XX00X00X000000000XX0X0X"
}
[GET] /GetStatusSolicitacao
Descrição: Ao enviar o protocolo, o sistema retorna o status da solicitação. Se as consultas já tiverem sido concluídas, os dados correspondentes também serão incluídos na resposta.
URL: https://sandbox.conformedocs.com.br/GetStatusSolicitacao
Headers:
- x-API-KEY: {Chave da API}
- x-Protocolo: {Protocolo}
Body 200 (aguardando resultado)
[
{
"Protocolo": "0000XX00X00X000000000XX0X0X",
"Status": "Processando solicitacao",
"DataHora_Registro": "00/00/0000 00:00:00",
"DataHora_Consulta": "00/00/0000 00:00:00"
}
]
Body 200
{
"ConsultaCNPJ": {
"razaoSocial": "RAZÃO SOCIAL",
"nomeFantasia": "NOME FANTASIA",
"cnpj": "XXXXXXXXXXXXXX",
"dataAbertura": "00/00/0000",
"porte": "ME",
"situacaoCadastral": "ATIVA",
"naturezaJuridica": "XXXX – NATUREZA JURÍDICA",
"capitalSocial": "R$ X0.000,00",
"MEI": false,
"Endereco": {
"CEP": "00.000-000",
"endereco": "ENDEREÇO, NÚMERO",
"bairro": "BAIRRO",
"cidade": "CIDADE",
"estado": "UF"
},
"atividadePrincipal": "Descrição atividade principal",
"atividadeSecundaria": [
{
"atividade": "Descrição atividade(s) secundária(s)"
}
],
"QSA": [
{
"CpfCnpj": "XXXXXXXXXXXXXX",
"PartnerName": "Nome do sócio",
"Participacao": "050,00"
},
{
"CpfCnpj": "XXXXXXXXXXXXXX",
"PartnerName": "Nome do sócio",
"Participacao": "050,00"
}
],
"recuperacoesFalencias": {
"message": "Nada Consta."
}
},
"ConsultaCRF": {
"crf": "000000000000000000000",
"datahora": "00/00/0000, às 00:00:00",
"endereco": "ENDEREÇO / BAIRRO / CIDADE / UF / 00000-000",
"historico_cabecalho": [
"Data de Emissão/Leitura",
"Data de Validade - Início",
"Data de Validade - Fim",
"Número do CRF"
],
"historico_lista": [
[
"00/00/0000",
"00/00/0000",
"00/00/0000",
"000000000000000000000"
]
],
"inscricao": "00.000.000/0000-00",
"razao_social": "RAZÃO SOCIAL",
"situacao": "REGULAR",
"validade_fim_data": "00/00/0000",
"validade_inicio_data": "00/00/0000",
"site_receipt": "https://url.com.br/Arquivo.pdf"
},
"ConsultaConju": [
{
"bases_dados_consultas": [
{
"nome": "CEIS",
"situacao": "Nada Consta",
"url_detalhes": "https://url.com.br/"
},
{
"nome": "CEPIM",
"situacao": "Nada Consta",
"url_detalhes": "https://url.com.br/"
},
{
"nome": "CNEP",
"situacao": "Nada Consta",
"url_detalhes": "https://url.com.br/"
},
{
"nome": "CGU-PJ",
"situacao": "Nada Consta",
"url_detalhes": null
},
{
"nome": "ePAD",
"situacao": "Nada Consta",
"url_detalhes": null
}
],
"codigo_controle": "XXXXXXXXXXXXXXXXXXXX",
"conseguiu_emitir_certidao_negativa": true,
"consultado": "RAZÃO SOCIAL",
"cpf_cnpj": "00000000000000",
"data_validade": "00/00/0000",
"datahora_emissao": "00/00/0000, às 00:00:00",
"mensagem": "Certifica-se que, em consulta aos sistemas ePAD e CGU-PJ e aos cadastros CEIS, CNEP e CEPIM mantidos pela Corregedoria-Geral da União, NÃO CONSTAM registros de penalidades vigentes relativas ao CNPJ/CPF consultado.",
"site_receipt": "https://url.com.br/Arquivo.pdf"
}
],
"ConsultaCNDE": [
{
"certidao": "CERTIDÃO POSITIVA COM EFEITOS DE NEGATIVA DE DÉBITOS RELATIVOS AOS TRIBUTOS FEDERAIS E À DÍVIDA ATIVA DA UNIÃO",
"certidao_codigo": "XXX0.0X00.X0X0.00X0",
"cnpj": "00.000.000/0000-00",
"cnpj_situacao": "Válida",
"comprovante_tipo": "pdf",
"conseguiu_emitir_certidao_negativa": true,
"consulta_comprovante": "XXX0.0X00.X0X0.00X0",
"consulta_datahora": "00/00/0000, às 00:00:00",
"debitos_pgfn": false,
"debitos_rfb": true,
"razao_social": "RAZÃO SOCIAL",
"situacao": "Válida",
"tipo": "Positiva com efeitos de negativa",
"validade": "00/00/0000",
"site_receipt": "https://url.com.br/Arquivo.pdf"
}
],
"ConsultaCNDT": [
{
"certidao": "0000000/0000",
"certidao_codigo": "0000000/0000",
"cnpj": "00.000.000/0000-00",
"conseguiu_emitir_certidao_negativa": true,
"consta": false,
"emissao_data": "00/00/0000",
"expedicao": "00/00/0000, às 00:00:00",
"mensagem": "CERTIDÃO NEGATIVA DE DÉBITOS TRABALHISTAS",
"razao_social": "RAZÃO SOCIAL",
"validade": "00/00/0000",
"site_receipt": "https://url.com.br/Arquivo.pdf"
}
]
}