Skip to main content
A API KYC (Know Your Customer) permite realizar análises completas de pessoas físicas através da consulta de múltiplos datasets consolidados em um único processo. Esta API foi desenvolvida para apoiar processos de verificação de identidade, análise de crédito, compliance e onboarding digital, fornecendo informações abrangentes sobre pessoas a partir do CPF.

​
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 pessoais em uma única requisição
  • Flexibilidade: Escolha quais datasets consultar ou utilize todos os disponíveis

​
Como Funciona

O processo de consulta KYC opera em duas etapas principais:

​
1. Iniciação do Processo

A primeira etapa consiste em iniciar o processo de KYC através do endpoint POST /onboarding/api/v1/know/customer. Nesta requisição, você especifica:
  • CPF da pessoa 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/customer/{requestId} com o requestId recebido na etapa anterior

​
Próximos Passos

Iniciar Consulta KYC

Aprenda como iniciar uma consulta KYC

Consultar Resultados

Veja como recuperar os resultados de uma consulta