Liveness Detection Report

Our Liveness Detection process provides comprehensive insights into the verification process, helping you understand the security assessment and potential risks associated with each verification attempt.

Report Structure

The liveness detection report is returned as a JSON object containing a liveness object with the following key sections:

• Liveness Status: Overall verification status and confidence score
• Media References: URLs to captured images and videos
• Method Details: Information about the liveness detection method used
• Risk Assessment: Warnings and potential security issues detected
• Verification Metadata: Additional verification details and timestamps

Core Response Fields

interface LivenessVerificationResponse {
  liveness: {
    status: 'Approved' | 'Declined' | 'In Review' | 'Not Finished';
    method: 'ACTIVE_3D' | 'FLASHING' | 'PASSIVE';
    score: number;
    reference_image: string;       // Temporary URL
    video_url: string;            // Temporary URL
    age_estimation: number | null;       // Age estimation in years for the target image
    warnings: {
      risk: string;
      additional_data: string | null;
      log_type: 'information' | 'warning' | 'error';
      short_description: string;
      long_description: string;
    }[];
  }
}

Response Fields

Liveness Status

• status: The overall status of the liveness verification (Options: "Approved", "Declined", "In Review", "Not Finished")
• score: A numerical value (0-100) representing the liveness confidence score

Media References

• reference_image: URL to the reference facial image captured during verification
• video_url: URL to the video recording of the liveness check (when applicable)

Method Details

• method: The liveness detection method employed (Options: "ACTIVE_3D", "FLASHING", "PASSIVE")

Risk Assessment

• warnings: Array of detected risks and warnings:
  • risk: The specific risk identified (e.g., "LOW_LIVENESS_SCORE")
  • additional_data: Any supplementary information related to the warning (when available)
  • log_type: Classification of the warning (Options: "information", "warning", "error")
  • short_description: Brief explanation of the detected issue
  • long_description: Detailed explanation of the risk and its implications

Biometric Estimations

• age_estimation: Estimated age in years of the person in the verification image (may be null if estimation fails)

Sample JSON Response

{
  "liveness": {
    "status": "Approved",
    "method": "ACTIVE_3D",
    "score": 89.92,
    "reference_image": "https://example.com/reference.jpg",
    "video_url": "https://example.com/video.mp4",
    "age_estimation": 24.3,
    "warnings": [
      {
        "risk": "LOW_LIVENESS_SCORE",
        "additional_data": null,
        "log_type": "information",
        "short_description": "Low liveness score",
        "long_description": "The liveness check resulted in a low score, indicating potential use of non-live facial representations or poor-quality biometric data."
      }
    ]
  }
}

Security Note

The URLs provided for liveness verification images and videos are temporary and expire after 60 minutes for enhanced security. Ensure these media resources are handled with appropriate security measures and are not shared publicly. As a best practice, your application should only store the verification status and confidence score, minimizing the amount of biometric data retained on your servers.