Liveness SDK API Category
Overview#
The Liveness SDK category provides APIs for integrating facial liveness detection capabilities into your applications. These APIs enable you to verify that a real person is present during identity verification processes, helping to prevent spoofing attempts using photos, videos, or masks. The Liveness SDK offers a robust solution for enhancing security in digital onboarding, authentication, and verification workflows.Parent Category: Root
Child Categories:
APIs in this category: Init, Get Report
Key Capabilities#
Main Functionality
The Liveness SDK enables applications to detect and verify human presence through facial analysis, distinguishing between live users and presentation attacks using advanced biometric technology.
Session Initialization
Create and configure liveness detection sessions with customizable parameters to meet specific security requirements and user experience needs.
Liveness Verification
Analyze facial movements, texture, and other biometric signals to determine if the subject is a live person rather than a spoofing attempt.
Comprehensive Reporting
Generate detailed verification reports containing liveness scores, confidence levels, and supporting evidence to document the verification process.
Common Use Cases#
Secure customer onboarding for banking and financial applications
Fraud prevention during high-value transactions
Passwordless authentication for mobile banking apps
Integration Considerations#
Best Practices
Implement proper error handling to manage network issues and user interaction failures
Store session tokens securely and handle them according to data protection regulations
Provide clear user instructions to guide them through the liveness check process
Test the integration across different devices and lighting conditions
Requires adequate lighting conditions for optimal performance
Network connectivity is essential for real-time verification
May have varying performance across different device capabilities
Subject to regulatory requirements regarding biometric data processing and storage
How APIs in this Category Work Together#
The Liveness SDK APIs work in a sequential workflow, starting with initialization and culminating in a comprehensive verification report. This process creates a seamless verification experience while maintaining security standards.Key Integration Patterns:Init + Get Report: Initialize a liveness detection session and then retrieve the detailed verification results after the user completes the liveness check
Init with custom parameters + Get Report: Configure specific security thresholds during initialization and obtain detailed analysis in the subsequent report
Init with callback URL + Get Report: Set up automated workflows by configuring webhook notifications upon completion and then retrieving the full report data
Identity Verification: Works alongside Liveness SDK to provide complete identity assurance by combining liveness detection with document verification
Authentication Services: Enhances authentication workflows by adding an additional biometric factor through liveness verification
Fraud Prevention: Contributes vital biometric signals to broader fraud detection systems to identify and prevent sophisticated identity fraud attempts
