API Reference

Frontend Liveness Integration

The Face Liveness Component is a pre-built React component:

  • Uses the camera to capture a liveness challenge.
  • Sends the video for Face Liveness check.
  • Confirms that a live person is in front of the camera, not a spoof.

How it Works?

Liveness Session: You must create a liveness session on the backend (using an API). This session gives you a sessionId.

Liveness Check Flow:

  • The Face Liveness component initiates the liveness detection. It presents an oval-shaped camera view and guides the user through a sequence of facial movements to verify real-time presence.
  • the user is prompted to perform specific actions (e.g., move closer, move back) to ensure the face is being captured live and not spoofed.
  • The component records the short video session for liveness analysis.

Detection:

  • After the challenge is completed, the recorded video is uploaded for liveness evaluation.
  • The liveness detection service analyzes the video to determine whether the face belongs to a live person and not a spoof (e.g., photo, video, or mask).

Result:

  • You can retrieve the result (liveness confidence score) by calling another API using the session ID.
  • You can then proceed to facial matching.