Visão geral
Esta seção documenta o contrato API (internamente conhecido como TCA / Check.Integration), utilizado quando a aplicação cliente é responsável pela etapa de captura e envia a imagem diretamente para a plataforma.
Use o contrato API quando:
- Sua aplicação já capturou a selfie ou imagem (via SDK nativo da Unico ou uma stack proprietária — Capture Standard).
- Você deseja resultados síncronos na própria resposta de criação do processo.
- Você não quer redirecionar o usuário para uma jornada hospedada.
- Sua arquitetura prefere chamadas server-to-server tradicionais (requisição → resposta com o resultado).
Se quiser que a Unico hospede a jornada, use Web & SDK.
Crie um processo de verificação enviando a imagem capturada diretamente. Retorna um resultado síncrono.
Recupere um processo existente pelo contrato API a partir do seu identificador.
Verifique se um usuário já possui um documento reutilizável cadastrado antes de iniciar um novo fluxo de captura.
Capture um novo documento ou reutilize um documento capturado anteriormente vinculado a um processo biométrico.
Consulte dados cadastrais, triagem PEP/AML e vínculo esportivo para um determinado CPF.
Bibliotecas nativas para Android, iOS e Flutter para capturar a selfie dentro da sua aplicação mobile.
Requisitos técnicos que sua captura proprietária deve atender quando não utiliza o SDK da Unico — resolução, formato, iluminação e mais.
Diferenças em relação ao Web & SDK
| Aspecto | API | Web & SDK |
|---|---|---|
| Quando o processo é criado | Após a captura | Antes da captura |
| Retorno da imagem | Imediato (após captura no lado do cliente) | Via endpoint dedicado |
| Controle da jornada | Cliente | Unico |
| Controle da captura | Cliente (com ou sem SDK) | Unico |
| Identificação | subject.code | person.duiType + person.duiValue |
| Headers | Authorization + APIKEY | Somente Authorization |
| Schema de resultado | Plano (unicoId.result, liveness, etc.) | Aninhado (process.authenticationInfo.*Result) |
Próximos passos
- Criar Processo — contrato completo de Onboarding.
- Códigos de erro — tratamento de respostas 4xx e 5xx.