Documentation

Liveness Type List

Default livenessType

We provide four livenessType for all clients, including DISTANT_NEAR_ACTION, DISTANT_NEAR, ACTION, SILENT. Among these, ACTION livenessType and DISTANT_CLOSE_ACTION livenessType support multiple liveness action, such as single-action, dual-action, and more.

livenessType livenessMethod supportAction defaultConfiguration flowCategory imagesCaptured
DISTANT_NEAR_ACTION Distant Near Action Liveness Detection 1.open mouth
2.blink eye
The default set performs a mouth-opening or eye-blinking action after the Distant Near Liveness Detection process. DISTANT_CLOSE_ACTION an farImage and an closeImage
DISTANT_NEAR Distant Near Liveness Detection same with LD SDK v3.6.0 or LD H5 v6.2.5. DISTANT_CLOSE an farImage and an closeImage
ACTION Action Liveness Detection 1.open mouth
2.blink eye
3.yaw head
The default set is to perform an eye-blinking and head-yawing or a head-yawing and an eye-blinking action. ACTION an silentImage
SILENT Silent Liveness Detection same with LIVENESS_DETECTION_MOTION_FREE_IN. SILENT an silentImage

If the default livenessType does not align with your business scenarios, please reach out to AAI for tailored configuration support. Below are examples of customizable scenarios:

  • For the DISTANT_NEAR_ACTION livenessType, you can display mouth-opening and eye-blinking two actions after the distant-near liveness detection;
  • For the ACTION livenessType, you can request random prompts for actions such as eye-blinking, mouth-opening, and head-yawing;
  • For the ACTION livenessType, you can specify display ratios for actions—e.g., 30% for mouth-opening and 70% for eye-blinking;
  • You can set up random alternation between the ACTION livenessType and DISTANT_CLOSE livenessType;

Customized livenessType

For customized livenessType, we offer the following capabilities:

  • customizable livenessType name, such as login;
  • customizable display probabilities, for example, setting a 30% probability for mouth opening and 70% for eye blinking within the ACTION livenessType;
  • Flexible combination of liveness types, such as random alternation between the ACTION livenessType and DISTANT_CLOSE livenessType;
  • Online switching of liveness types – for instance, if you're using a custom livenessType named "login" that initially only displays the DISTANT_CLOSE livenessType, you can later switch to randomly showing both DISTANT_CLOSE livenessType and ACTION livenessType without releasing a new SDK. Simply contact AAI for this modification.

livenessFlowCategory

When a livenessType in Generate URL API , a group of livenessFlowCategory is determined.

Then one livenessFlowCategory in the group will be finally used in the liveness process.

And different flowCategory may capture different face images. (Refer to column imagesCaptured in the table under Default livenessType.)