Guias práticos para integrar com confiança.
Referência da API
REST · OpenAPI 3.1 · X-API-Key
OpenAPI / Swagger
Explore o contrato, sem executar chamadas.
API KYC: da identificação ao resultado
Entenda a arquitetura da integração KYC, a jornada hospedada, os eventos e as responsabilidades do seu sistema.
Integre sua primeira jornada de KYC
Crie uma transação no seu servidor, encaminhe a jornada hospedada e consulte o resultado com exemplos da API KYC.
Integre KYC com seu agente de IA
Prepare sua integração KYC com prompts, contexto público, oito linguagens e documentação por MCP.
Autenticação e proteção das chaves de API
Use X-API-Key no backend, mantenha Tenant e ambiente isolados e prepare a rotação de credenciais da integração KYC.
Ambientes e configuração da integração KYC
Separe credenciais, URLs, callbacks e dados por ambiente, sem confundir exemplos locais com serviços operacionais.
Crie uma transação de verificação de identidade
Conheça os campos de criação, os identificadores de correlação e o retorno 201 da API KYC.
Encaminhe a pessoa para a jornada hospedada
Utilize os links retornados pela API KYC, preserve a privacidade e acompanhe a jornada pelo seu backend.
Interprete resultados, decisões e status do KYC
Diferencie etapa operacional de decisão e trate pendências, aprovação, rejeição, expiração e revisão manual.
Idempotência: repita a criação sem duplicar a transação
Use Idempotency-Key para repetir o mesmo POST e trate conflitos de payload sem criar transações duplicadas.
Receba webhooks e acompanhe os eventos de KYC
Configure o callback, valide a assinatura, deduplique pelo event_id e consulte o estado atual da transação.
Valide a assinatura HMAC dos webhooks
Valide timestamp e HMAC SHA-256 sobre os bytes originais, com exemplos em TypeScript e Python e comparação segura.
Reentrega, duplicidades e reconciliação de eventos
Projete um consumidor tolerante a falhas com event_id, persistência durável e consulta do estado atual por GET.
Documentos, assets e evidências com acesso autorizado
Consulte os quatro endpoints de arquivos do KYC e entenda o escopo document_download, a autorização por IP e os cuidados com dados pessoais.
Erros e diagnóstico da integração KYC
Identifique falhas de validação, autenticação, permissão, transação e idempotência sem expor dados pessoais nos logs.
Limites do contrato e boas práticas de integração
Aplique limites documentados de campos, timeouts, concorrência controlada e minimização de dados na integração KYC.
Checklist para colocar sua integração KYC em produção
Revise acesso, segurança de webhook, cenários de decisão, recuperação e proteção de dados antes de liberar a integração.
Histórico e evolução do contrato público KYC
Acompanhe a versão do contrato público e saiba revisar exemplos, consumidores e mudanças antes de atualizar sua integração.
Exemplos de API e downloads para integração KYC
Baixe OpenAPI e Postman e consulte exemplos de criação em Node.js, TypeScript e Python sem credenciais reais.
Explore o simulador local de KYC
Aprenda a interpretar cenários sintéticos de KYC no navegador, sem credenciais, uploads ou chamadas à API real.