Getting Started

This guide walks through integrating the VIDA Liveness SDK into your Android application — adding the repository and SDK dependency, configuring your activation key, and setting up the liveness request. If your account uses ID Fraud Shield, the additional steps are called out along the way.

Before you begin: Get your keys To access the VIDA SDK you need a Repo API Key and an Activation Key. If you don't have them yet, reach out to the VIDA support team. Using ID Fraud Shield?

The userId is optional from Liveness SDK v1.9.6+ — if you do not provide one, the SDK uses a default value — but we recommend setting your own so fraud rules can be applied per user.

On versions earlier than v1.9.6, the userId is required when ID Fraud Shield is enabled. Not setting it will result in an error.

1. Add the VIDA Repository

In your project's build.gradle file, add the following to include Vida's repository and credentials. Replace REPO-API-KEY with the Repo API Key provided by VIDA.

Response

maven {
   url "https://sdk-repo.dev.vida.id/android"
   credentials(HttpHeaderCredentials) {
       name = "x-api-key"
       value = "REPO-API-KEY"
   }
   authentication {
       header(HttpHeaderAuthentication)
   }
}

2. Add the SDK Dependency

In your app's build.gradle file, add the SDK dependency for your environment. Add the ID Fraud Shield dependency only if ID Fraud Shield is enabled for your account. Replace X.Y.Z with the SDK version you are using.

Production Environment

Response

//Production 
implementation "id.vida:liveness:X.Y.Z"// For Production 

//If ID Fraud Shield is Enabled. 
implementation "id.vida:idFraudShield:1.0.2" 
implementation "id.vida:idFraudShield-sandbox:1.0.2"

//implementation "id.vida:idFraudShield:X.Y.Z" for Production
//implementation "id.vida:idFraudShield-sandbox:X.Y.Z" for Sandbox

Sandbox Environment

Response

//Sandbox 
implementation "id.vida:liveness-sandbox:X.Y.Z" // For sandbox

//ID Fraud Shield is Enabled.
implementation "id.vida:idFraudShield-sandbox:X.Y.Z" // For sandbox  

Permissions

You don't add these permissions manually Liveness and ID Fraud Shield are separate libraries. Bundling ID Fraud Shield alongside Liveness doesn't combine them into a single SDK - it simply pulls in an additional library as part of the execution flow. The permissions each library needs are independent and scoped to that library, so the ID Fraud Shield permissions are not declared under Liveness. You don't need to declare any of these permissions in your manifest yourself - they are merged into your app automatically when it compiles, from the dependencies you added above. To learn more about the additional library, see the ID Fraud Shield SDK documentation.

In your app's AndroidManifest.xml file, add the following permissions

Response

Permissions - Required for All Integrations:
<uses-permission android:name="android.permission.CAMERA"/>
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />

Permissions - Required for ID Fraud Shield:
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.USE_BIOMETRIC" />
<uses-permission android:name="android.permission.USE_FINGERPRINT" />
<uses-permission android:name="com.google.android.providers.gsf.permission.READ_GSERVICES" />

What each permissions is for

The reference below shows the permissions each library declares, so you're aware of what your app will request. Permissions marked All ship with the Liveness SDK, those marked ID Fraud Shield ship with the ID Fraud Shield SDK and only apply when that library is included.

Permission	Purpose	Required For
CAMERA	Capture the user's face for liveness detection	All
INTERNET	Communicate with VIDA servers	All
ACCESS_NETWORK_STATE	Check network connectivity before a request	All
ACCESS_WIFI_STATE	Read Wi-Fi connection details	All
ACCESS_COARSE_LOCATION	Approximate location as a fraud-risk signal	ID Fraud Shield
ACCESS_FINE_LOCATION	Precise location as a fraud-risk signal	ID Fraud Shield
USE_BIOMETRIC	Device biometric verification	ID Fraud Shield
USE_FINGERPRINT	Fingerprint verification on older devices	ID Fraud Shield
READ_GSERVICES	Read Google Services device identifiers for device fingerprinting	ID Fraud Shield

Note on location permissions

Location is used only as a fraud-risk signal during verification. If your app targets the Google Play Store or is subject to a security review, be prepared to declare this purpose, as location access is commonly flagged during review.

3. Add SDK Activation Key

In your application's AndroidManifest.xml file, add the SDK activation key. Replace VIDA-ACTIVATION_KEY with the activation key provided by Vida.

<meta-data android:name="vida_activation_key" android:value="VIDA-ACTIVATION_KEY" />

4. Configure the liveness request

The VIDALivenessRequest object defines the configuration for the liveness flow.

Property	Type	Required	Description
apiKey	String	Required	API key provided by VIDA.
licenseKey	String	Required	License key provided by VIDA.
eKYCID	String	Optional	ID for the user's eKYC for which the liveness is to be done.
userId	String	Optional (if ID Fraud Shield Enabled)	UserId to be tracked in idFraudShield. If you do not provide one, the SDK uses a default value. Recommended when idFraudShield is enabled for the flow, so fraud rules can be applied per user.