Documentação da API
API REST para verificação de identidade: crie candidatos, colete documentos, receba a decisão da IA e monitore tudo.
Verificar uma pessoa (PF)
profileType pf_br ou pf_intl. Identidade, selfie e o checklist da pessoa: residência, renda e ocupação.
Verificar uma empresa (PJ)
profileType pj_simples, pj_presumido, pj_real ou pj_intl. Dados da empresa, atos societários, fiscais e o responsável legal.
PF e PJ na mesma API
As duas verificações usam o mesmo endpoint de criação. O campo profileType define o restante: os campos aceitos, os documentos exigidos e as etapas que o candidato vê no fluxo hospedado.
| Pessoa física (KYC) | Empresa (KYB) | |
|---|---|---|
| profileType | pf_br, pf_intl | pj_simples, pj_presumido, pj_real, pj_intl |
| Quem é verificado | A própria pessoa | A empresa e o responsável legal |
| Campos extras | — | companyName, companyTaxId, declaredRevenue |
| Documentos | Identidade, selfie, residência, renda | Identidade e selfie do responsável + atos societários e fiscais |
| Consulta oficial | CPF na Receita Federal | CPF do responsável + dados declarados da empresa |
Guia rápido
Da chave de API ao primeiro resultado em 5 minutos.
Referência
Todos os endpoints, parâmetros e exemplos.
Checklist de KYC
Documentos exigidos por regime tributário, de PF a empresa estrangeira.
Base URL
Todos os endpoints partem deste prefixo. Autentique com a sua chave no header X-API-Key.
https://SEU-DOMINIO/api/public/kyc/v1
Ambientes
isTest: trueVerificações de teste: fluxo completo, sem cobrança.
isTest: falseVerificações reais: entram no faturamento mensal.
Como funciona
- Crie o applicant com os dados que você já conhece do usuário.
- Crie uma sessão e abra a URL retornada em um iframe (token de uso único, 30 min).
- O usuário escolhe o documento, captura frente/verso e selfie no fluxo hospedado.
- A IA extrai os dados, valida o CPF e compara o rosto com o documento.
- Você recebe o webhook com o resultado; casos duvidosos ficam em revisão manual.