Características Principais
- Consulta Assíncrona: Processamento eficiente com notificação via webhook ou polling
- 11 Datasets: Acesso a múltiplos datasets de informações empresariais (dados cadastrais, endereços, telefones, certidões, KYC, processos e outros) em uma única requisição
- Flexibilidade: Escolha quais datasets consultar, use um pacote por ID ou utilize todos os disponíveis; opção de forçar atualização dos dados (refresh)
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 endpointPOST /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) — opcional
- Datasets que deseja consultar (opcional; se não informado, consulta todos disponíveis)
- ID do pacote de datasets (opcional)
- Refresh dos dados (opcional) — forçar atualização dos dados
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 orequestIdrecebido na etapa anterior