Dashboard →
SDK v1.2.0 Last Updated: Feb 2026

Seamless Biometric Onboarding

Integrate a world-class KYC flow in minutes. The LumiID Web SDK handles camera permissions, 3D liveness detection via MediaPipe, and sovereign identity matching without requiring you to build a single UI component.

How the SDK Orchestrates Data

The LumiID web SDK can be included in your app via CDN. The SDK operates as a "Black Box." You provide the API key, and the SDK returns a verified identity. Below is the automated sequence:

1. Initialize the Interface

Place this code within your application's mounting logic (e.g., inside useEffect in React or onMounted in Vue).

Initialization Logic 
               
// Basic configuration object for LumiID SDK

               
<script> src="https://lumiid.com/static/v1/sdk/lumiid-sdk.js">

            const config = {
            containerId: "lumi-verification-mount",
            apiKey: "LUMI_LIVE_SK_xxxx",
            onSuccess: (res) => {
                // Triggered when status: "VERIFIED"
                window.location.href = "/success";
            },
            onError: (msg) => {
                // Handle rejections or camera blocks
                console.error(msg);
            }
        };

        new LumiID(config);

2. Automated Liveness Thresholds

To prevent spoofing, the SDK tracks the user's Yaw Ratio (the side-to-side rotation of the head). Images are only captured when the user hits these exact mathematical points:

Capture 1: Center
0.50 ± 0.05

Subject is looking directly at the camera. Establishes the baseline facial map.

Capture 2: Left
> 0.72

Subject turns head 45° left. Analyzes depth of the ear and nose bridge.

Capture 3: Right
< 0.28

Subject turns head 45° right. Finalizes 3D parallax validation.

Common Error Handling

SDK Error Message Root Cause Resolution
Camera access denied User blocked permission or insecure origin (HTTP). Switch to HTTPS or guide user to settings.
Enter 11-digit NIN Input failed local length validation. The SDK prevents API calls for invalid NIN formats.
Face mismatch detected Live photo does not match the NIN database image. Subject is not the owner of the provided NIN.