API Documentation

Integrate VerifyX's AI-powered identity verification into your application in minutes.

Installation

Install the VerifyX SDK using your preferred package manager. It exposes the React components and TypeScript definitions needed for integration.

npm install @verifyx/sdk

Basic Usage

Embed the VerificationFlow component in your application. This component handles the entire lifecycle of the user verification process.

Using your keys

Frontend: Use your public key (pk_live_... or pk_test_...) in the SDK. Safe to expose in client code (e.g. NEXT_PUBLIC_VERIFYX_API_KEY).

Backend: Use your secret key only when your server calls the VerifyX API (e.g. to fetch verification results). Store it in server env (e.g. VERIFYX_SECRET_KEY). Never use it in the browser or SDK. See API Client tab.

import { VerificationFlow } from "@verifyx/sdk";

// Use your public key in the frontend (safe to expose)
function App() {
  return (
    <VerificationFlow
      apiKey={process.env.NEXT_PUBLIC_VERIFYX_API_KEY}
      onComplete={(result) => {
        console.log("Verification completed:", result);
      }}
      onError={(error) => {
        console.error("Verification error:", error);
      }}
    />
  );
}

Why VerifyX?

Multi-Country OCR

Extracts data from local ID cards and passports with 99% accuracy across India and Singapore.

3D Liveness

Advanced active and passive liveness detection to prevent spoofing checks.

Govt Integration

Real-time validation against government databases (UIDAI, etc) for authoritative results.

Privacy First

GDPR compliant, auto-purging of biometric data, and AES-256 encryption.