Skip to main content

Method Signature

FAD_SDK.startBiometrics(idValidation: string): Promise<BiometricsResponse>
Initiates a step-by-step biometric validation workflow that guides users through multiple verification stages with granular control over each step.

Parameters

idValidation
string
required
The validation identifier that determines which biometric validation workflow to execute. This ID is configured in your FAD SDK dashboard and defines the sequence of validation steps.

Return Value

Returns a Promise that resolves to a BiometricsResponse object containing the validation results from all steps.
data
object
The biometric validation results
event
string
Event type indicating validation completion or user action
  • FadSDK.Constants.EventModule.PROCESS_COMPLETED - Validation completed
  • FadSDK.Constants.EventModule.MODULE_CLOSED - User closed the validation

Usage Example

import FadSDK from '@fad-producto/fad-sdk';

async function runBiometricValidation() {
  const options = {
    environment: FadSDK.getFadEnvironments().UATHA
  };

  const FAD_SDK = new FadSDK(null, options);
  
  try {
    // Validation ID configured in your dashboard
    const idValidation = 'kyc-validation-001';
    
    const result = await FAD_SDK.startBiometrics(idValidation);
    
    if (result.event === FadSDK.Constants.EventModule.MODULE_CLOSED) {
      console.log('User cancelled validation');
      return;
    }
    
    // Process validation results
    console.log('Validation status:', result.data.status);
    console.log('Step results:', result.data.steps);
    
  } catch (error) {
    console.error('Validation error:', error);
  } finally {
    FAD_SDK.end();
  }
}

How It Works

The Biometrics by Steps workflow provides granular control over multi-step validation:
1

Configure Validation Workflow

Define the sequence of biometric validation steps in your FAD SDK dashboard (e.g., document capture → face liveness → fingerprint)
2

Initialize with Validation ID

Call startBiometrics() with the validation ID that identifies your configured workflow
3

Execute Steps Sequentially

Users are guided through each validation step with clear instructions and feedback
4

Collect Results

Results from each step are aggregated and returned with pass/fail status for each stage

Validation Workflow Steps

Common steps that can be included in a validation workflow:
Step TypeDescriptionTypical Use
Document CaptureCapture and verify ID documentsIdentity verification
Face LivenessVerify the user is present and not spoofedAnti-spoofing
Face MatchCompare document photo with live selfieIdentity matching
Fingerprint CaptureCapture biometric fingerprintsHigh-security verification
Signature CaptureCapture digital signatureLegal consent
Video AgreementRecord video consentRegulatory compliance

Use Cases

Progressive KYC

Break complex KYC into manageable steps with clear progress tracking

Conditional Validation

Execute different validation steps based on risk assessment or user type

Audit Trail

Maintain detailed records of each validation step for compliance

User-Friendly Flows

Guide users through complex processes with step-by-step instructions

Configuration

Validation workflows are configured in your FAD SDK dashboard:
  1. Create Validation ID: Define a unique identifier for your workflow
  2. Add Steps: Select which biometric modules to include
  3. Set Sequence: Define the order of execution
  4. Configure Thresholds: Set pass/fail criteria for each step
  5. Customize UI: Tailor instructions and branding for each step

Notes

The startBiometrics() method requires null as the token parameter in the FadSDK constructor, as authentication is managed through the validation ID system.
Use meaningful validation IDs that reflect the workflow purpose (e.g., basic-kyc, high-risk-verification, employee-onboarding) to make your code more maintainable.
Each validation step must complete successfully before proceeding to the next step. If a step fails, the workflow may terminate depending on your configuration.

Build docs developers (and LLMs) love