PixFace SDK

The PixFace SDK is a JavaScript library that allows you to easily integrate the KYC (Know Your Customer) verification flow with PixtoPay facial validation into your web application.

Overview

The PixFace SDK provides a complete identity verification solution that includes:

• Document validation - Identity document OCR
• Facial verification - Face matching with liveness detection
• Data enrichment - Registration data validation and enrichment
• SOW Flow - Source of Wealth
• Customizable interface - Responsive and customizable modal

Key Features

Complete Identity Validation

The SDK manages the entire identity validation flow, including:

• CPF capture and validation
• Automatic session creation
• Modal interface for document and selfie capture
• Liveness detection
• Biometric validation

Multiple Verification Flows

• verify - Full KYC flow (OCR + Face Match)
• faceindex - Liveness and facial indexing only
• verify-sow-flow - KYC flow with source of wealth verification

Simple Integration

Declarative interface that allows you to configure the SDK using existing HTML or programmatic JavaScript calls.

Installation

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

Quick Start

Include the script and initialize:

<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. Done!

The SDK is now ready to use. When the user enters a CPF and clicks the "Verify Identity" button, the modal will automatically open for document and selfie capture.

Next Steps

• SDK Methods - Complete reference of all available methods
• Configuration Options - All SDK configuration options
• Features - Detailed documentation of each feature
• Fields and Actions - Reference for fields and customizable actions

Support

For technical support or questions, contact the PixtoPay team.