Get Started

Integrate the VIDA KYC Mobile SDK into your Android or iOS app. A single integration covers document capture, OCR, document verification, liveness, and face match.

Before you start

You will need the following from VIDA:

Item	Where it is used
API key	Backend, to generate session tokens
License key	SDK setup
Activation key	vida_activation_key in your app config

Contact VIDA to enable the KYC product and define your flows (ID verification or full KYC), regions, and supported documents.

Integration steps

1

Generate an access token

From your backend, generate a secure token for each KYC session and each user. The token binds the SDK call to your organization and the specific applicant.

2

Install the SDK

Android

1. Add the VIDA Maven repository and the id.vida:kyc dependency.

2. Add the vida_activation_key meta-data entry to AndroidManifest.xml.

iOS

1. Add the vidaKYC pod to your Podfile, then run pod install.

2. Add the camera usage description and vida_activation_key to your Info.plist.

3

Initialize the KYC flow

Build the config object for your platform: VidaKycRequest (Android) or VIDAKYCConfig (iOS).

Parameter	Description
token	Session token from step 1
flow	Verification flow (ID verification or full KYC)
sdkRegion	Region the SDK operates in
DocumentType	Default document type
Liveness, UI, error config	Behavior and appearance settings

Then initialize the SDK and wait for the onInitialized callback before starting the flow.

4

Start the verification

Call startFlow() to launch the built-in KYC UI. The SDK guides the user through document capture, liveness, and face match as required.

5

Handle the result and clean up

Callback	When it fires	Returns
onSuccess	Verification completes	VidaKycResponse (Android) / VIDAKYCResponse (iOS), the full result
onError	Something fails	errorCode, errorMessage, and optional diagnostic response

After completion or cancellation, call release() (Android) or releaseSDK() (iOS) to free resources.

You're done. With these five steps you can run a complete KYC journey on mobile through one SDK integration.