Configuration Parameters

The LivenessDetectionBuilder class lets you customize the liveness detection process. You build a VidaLivenessDetector by passing the calling activity and a configured VidaLivenessRequest , which carries the required and optional parameters described below.

Building the detector

Initializing a LivenessDetectionBuilder instance requires two arguments:

Argument	Description
activity	An instance of the calling Android activity, so the SDK can access the application context.
vidaRequest	A VidaLivenessRequest configuration object containing the information for the liveness detection request.

VidaLivenessDetector detector = VidaLivenessDetector.LivenessDetectionBuilder
.getInstance(activity, vidaRequest)
.build();

Required Parameters

The VidaLivenessRequest object must be initialized with the following mandatory fields:

Parameter	Method	Required	Description
API Key	setApiKey()	Mandatory	Your API key used for authenticating SDK requests.
License Key	setLicenseKey()	Mandatory	Your license key to authorize the SDK.
User ID	setUserID()	Optional	A unique identifier representing the client/user.

setUserID() is Optional starting from SDK version 1.9.6. Ensure this is set before initializing the detector.

Example

Create a configured VidaLivenessRequest with the required keys and user ID:

Response

/**
 * Creates a liveness request with the necessary API and License keys.
 *
 * @return A configured VidaLivenessRequest object.
 */
private VidaLivenessRequest createLivenessRequest() {
    VidaLivenessRequest request = new VidaLivenessRequest();
    request.setApiKey(KeyConstant.API_KEY_NORMAL);         // Mandatory
    request.setLicenseKey(KeyConstant.LICENSE_KEY_NORMAL); // Mandatory
    request.setUserID("USER-ID");                          // Optional (v1.96+)
    return request;
}

Optional Parameters

The LivenessDetectionBuilder also provides optional configurations for the detection process. If any of these are not set, the SDK's default values are used.

Parameter	Method	Description
Detection Timeout	setDetectionTimeout()	The overall timeout for face detection on the front end (FE) - the maximum time the detector waits to detect a face in the frame.
Minimum Frame	setMinimumFrame()	The minimum number of continuous frames that satisfy the quality parameters. These frames are used for stable image capture and liveness analysis.
Eye Open Probability	setEyeOpenProbability()	The probability of eye openness required for successful detection (for example, 20% or 30%).

Defaults: If any optional parameter is not defined, the SDK applies its built-in default value for that parameter.

Behavioral Biometrics Configuration

Behavioral biometrics is part of ID Fraud Shield. It collects clipboard, copy-paste and typing signals during the flow.

These settings are not passed through LivenessDetectionBuilder or any other code on your side. They are configured per client by the VIDA team in the OSS Configuration Console. The SDK reads the configuration when it initializes and behaves accordingly.

Available from: Android Liveness SDK 1.9.8 · iOS Liveness SDK 1.9.6

Available Settings

Setting	Description
behavior_biometrics_enabled	Parent switch for all behavioral signals. When this is disabled, the two settings below have no effect.
clipboard_tracking	Clipboard and copy-paste events.
field_tracking	Typing, hesitation and field input events.

Default Behaviour

All three settings are disabled by default on the SDK side. If nothing is configured for your client, no behavioral signals are collected and the end user sees no clipboard permission prompt.

When to enable it

Enable these settings only for flows that contain input fields, such as name or date of birth. The liveness screen has no input fields, so these signals add no value there.

When a change takes effect

A configuration change is applied at the next SDK initialization. It never changes behaviour in the middle of an active session. An end user who is already in a session continues with the configuration that was read when that session started.

How to request a change

Contact your VIDA team. The settings are visible in the OSS Configuration Console only for clients who have ID Fraud Shield enabled.