Skip to main content
A API KYB (Know Your Business) permite realizar análises completas de empresas (Pessoas Jurídicas) através da consulta de múltiplos datasets consolidados em um único processo. Esta API foi desenvolvida para apoiar processos de verificação empresarial, análise de crédito, compliance e due diligence, fornecendo informações abrangentes sobre empresas a partir do CNPJ.

​
Características Principais

  • Consulta Assíncrona: Processamento eficiente com notificação via webhook ou polling
  • Múltiplos Datasets: Acesso a diversos datasets de informações empresariais em uma única requisição
  • Flexibilidade: Escolha quais datasets consultar ou utilize todos os disponíveis

​
Como Funciona

O processo de consulta KYB opera em duas etapas principais:

​
1. Iniciação do Processo

A primeira etapa consiste em iniciar o processo de KYB através do endpoint POST /onboarding/api/v1/know/business. Nesta requisição, você especifica:
  • CNPJ da empresa a ser consultada
  • Webhook URL para receber a resposta assíncrona
  • Credenciais de autenticação para o webhook (Basic Auth)
  • Datasets que deseja consultar (opcional - se não informado, consulta todos disponíveis)
A API retorna imediatamente um requestId único que identifica o processo iniciado, juntamente com a data de criação da requisição.

​
2. Recuperação dos Resultados

Como o processamento dos datasets pode levar algum tempo (especialmente para consultas on-demand), a API funciona de forma assíncrona:
  • Via Webhook: Assim que o processamento for concluído, a API enviará automaticamente os resultados para a URL do webhook configurada
  • Via Polling: Alternativamente, você pode consultar o status do processo usando o endpoint GET /onboarding/api/v1/know/business/{requestId} com o requestId recebido na etapa anterior

​
Próximos Passos

Iniciar Consulta KYB

Aprenda como iniciar uma consulta KYB

Consultar Resultados

Veja como recuperar os resultados de uma consulta