PixFace SDK

O PixFace SDK é uma biblioteca JavaScript que permite integrar facilmente o fluxo de verificação KYC (Know Your Customer) com validação facial da PixtoPay em sua aplicação web.

Visão Geral

O PixFace SDK oferece uma solução completa para verificação de identidade que inclui:

• Validação de documentos - OCR de documentos de identidade
• Verificação facial - Face matching com liveness detection
• Enriquecimento de dados - Validação e enriquecimento de dados cadastrais
• Fluxo SOW - Source of Wealth (Origem dos Recursos)
• Interface customizável - Modal responsivo e personalizável

Recursos Principais

Validação de Identidade Completa

O SDK gerencia todo o fluxo de validação de identidade, incluindo:

• Captura e validação de CPF
• Criação automática de sessão
• Interface em modal para captura de documentos e selfie
• Detecção de vida (liveness detection)
• Validação biométrica

Múltiplos Fluxos de Verificação

• verify - Fluxo completo de KYC (OCR + Face Match)
• faceindex - Apenas liveness e indexação facial
• verify-sow-flow - Fluxo KYC com verificação de origem de recursos

Integração Simples

Interface declarativa que permite configurar o SDK usando HTML existente ou chamadas programáticas via JavaScript.

Instalação

<script src="https://kyc-demo.pixtopay.com.br/pixface-sdk.min.js"></script>

Início Rápido

Inclua o script e inicialize:

<script>
  const sdk = PixFace({
    apiURL: "https://kyc-api.pixtopay.com.br",
    api_key: "<API_KEY>",
    kycFrontOrigin: "https://face.pixtopay.com.br",
    lang: "pt",
    onSuccess: (name, data) => console.log("success", name, data),
    onError: (name, data) => console.log("error", name, data),
    eventHandler: (evt) => console.log("event", evt),
  });
  sdk.mount();
</script>

3. Pronto!

O SDK agora está pronto para uso. Quando o usuário digitar um CPF e clicar no botão "Verificar Identidade", o modal será aberto automaticamente para captura de documentos e selfie.

Próximos Passos

• Métodos do SDK - Referência completa de todos os métodos disponíveis
• Opções de Configuração - Todas as opções de configuração do SDK
• Funcionalidades - Documentação detalhada de cada funcionalidade
• Campos e Ações - Referência de campos e ações customizáveis

Suporte

Para suporte técnico ou dúvidas, entre em contato com o time da PixtoPay.