Introducing VIDA Identity Stack: All of VIDA, in one place 🎉
For the complete documentation index, see llms.txt. This page is also available as Markdown.

SDK User Journey

User initiates the liveness verification process from the host application.

Tutorial Screen

The tutorial provides clear instructions on how the user can complete the liveness verification process.

It includes dos and don'ts, emphasising the importance of proper lighting and positioning for a successful verification.

The Tutorial screen can be disabled/enabled in the host application using the setShowTutorialScreen method.

Camera Permission Screen

If camera permission is not enabled, a pop-up screen appears, requesting permission to access the device's camera.The user can choose to grant or deny camera permission through the host application settings.


Overview

VIDA provides 4 types of selfie capture flows for liveness verification:


Passive Liveness - Selfie Capture Flow

Upon completing the tutorial, the user is taken to the camera preview screen. The screen includes an oval frame where the user is instructed to frame their face.

Users will be shown various prompts to guide them through the selfie capture process

  • "Frame Your Face in the Oval" (Encouraging proper alignment)

  • "Face Too Far" (Alerting if the face is too distant)

  • "Face Too Close" (Alerting if the face is too close to the camera)

  • "Face Detected" (Confirming successful face detection)

  • "Dark Image" ( Alerting if the image is Dark. Only in Android SDK)

  • "No Face Detected" (Alerting if the camera cannot detect a face)

  • "Multiple Face Detected" ( Alerting if multiple faces are visible in the frame)

  • "Eyes Closed" ( Alerting if the eyes of the person capturing selfie is closed

  • "Left Eye Closed" ( Alerting if the left eye of the person capturing selfie is closed

  • "Right Eye Closed" ( Alerting if the right eye of the person capturing selfie is closed

  • "Face Not Straight" ( Alerting if the face of the person is not straight)

  • "Eyes Occluded" (Alerting if the eyes of the person is occluded)

Once the user properly frames their face, the liveness capture process gets initiated. After capturing the user's selfie, they are directed to a review screen.


Active Liveness - Selfie Capture Flow

Active liveness supports ZOOM_FACE and gestures such as BLINK, SMILE, SHAKE_HEAD.

If no gesture is specified when active liveness is enabled, the ZOOM_FACE gesture will be used by default.

ZOOM gestures

In the ZOOM_FACE flow, the user will be prompted to adjust their face within three consecutive, randomly-sized concentric frames. The SDK performs gesture validation before initiating the liveness verification process.

The user will be prompted to do one or more of the required gestures. Once the user properly frames their face and performs the required gestures, SDK verifies the gestures and the liveness check gets initiated.

Guided Prompts for Gestures

Users will be shown various prompts to guide them through the gesture-based liveness capture process:

  • "Blink Your Eyes" (Prompting the user to blink)

  • "Smile" (Prompting the user to smile)

  • "Shake Your Head" (Prompting the user to shake their head)

Review Screen

Here, the user can preview the captured photo to ensure it meets the required criteria (proper lighting, visibility, etc.).

  • Options are provided to either submit the selfie or retake it.

  • Choosing to retake the selfie will return the user to the initial tutorial screen for further guidance.

  • Submitting the selfie triggers the transmission of the photo to the Vida backend for liveness verification using algorithms.

setShowReviewScreen()method can be used to update if the review screen needs to be shown. The method returns boolean value which denotes if the review screen can be shown or not.


Liveness Check

The VIDA backend processes the submitted selfie using its algorithms to verify liveness.It checks for facial movements, ensuring the user is not presenting a static image. The result of the verification is returned from the backend with the status and the relevant success and error codes.

Host Application Success Screen

If the liveness verification is successful, the host application displays a customised success screen. The user is informed that their liveness check has been successfully completed and directed to the next steps within the host application, which could include account creation, access to a specific service, or any other relevant actions.

Liveness Detection Error

If the liveness check gets failed, the VIDA backend will respond with the error message and the corresponding error code.


Color Flash - Selfie Capture Flow

To verify user liveness through dynamic color flash sequences. This ensures the selfie is captured under varying light conditions to detect presentation attacks (e.g., printed photo, screen replay).

User aligns their face in the frame and the system automatically captures 6 selfies with sequential color flashes to verify liveness.

Color Flash - Selfie Prompt

  • Position your face within the frame – Align your face inside the oval guide.

  • Face area is too dark, move to a well-lit place – Ensure your face is clearly visible with enough light.

  • Great! Stay still for clear photos – Remain still while the system captures your selfie.

These prompts guide users step-by-step to ensure proper alignment, lighting, and stability, resulting in a successful selfie capture and liveness verification.

Last updated