Introdução à API Verifiky

Entenda o fluxo unificado de processamento de identidade.

Bem-vindo à documentação oficial da Verifiky. Nossa API foi projetada para simplificar a validação de identidade (KYC), condensando processos complexos de Visão Computacional em uma única chamada.

Arquitetura de Envio Único

⚠️ Importante: Não envie dados separadamente

A API Verifiky não funciona com uploads fracionados. Não tente enviar o documento em um endpoint e a selfie em outro. O motor de IA precisa receber ambos os arquivos simultaneamente para garantir a integridade da comparação biométrica.

Diferente de APIs antigas que exigem múltiplos passos (Upload Frente > Upload Verso > Upload Selfie > Comparar), a Verifiky utiliza um modelo de Processamento Atômico.

Fluxo Tradicional (Não Usar)

1. POST /upload-doc
↓
2. POST /upload-selfie
↓
3. POST /compare (ID1, ID2)

Fluxo Verifiky (Correto)

POST /api/verifiky/processar
Payload: { documento + selfie + tipo }

Tudo processado em uma única transação.

Ciclo de Vida da Requisição

  1. Coleta: Seu frontend captura a foto do documento e a selfie do usuário.
  2. Envio Único: Seu backend envia um único POST multipart contendo as duas imagens e o user_reference.
  3. Processamento Síncrono (Hold): Nossa API recebe os arquivos e inicia o OCR e a Biometria. Nota: Como a IA analisa imagens pesadas em tempo real, defina o timeout do seu cliente HTTP para pelo menos 60 segundos.
  4. Resposta Imediata: Assim que a análise preliminar termina, retornamos 200 OK.
  5. Confirmação Assíncrona (Webhook): Para garantir redundância, enviamos um Webhook com o resultado final (Aprovado/Rejeitado) para sua URL configurada.

Ambientes

Ambiente URL Base
Produção https://app.verifiky.com/

Autenticação

Todas as chamadas devem incluir o cabeçalho Authorization com sua chave de API.

Authorization: Bearer sua_api_key_secreta