Integration Overview

This page explains how VIDA KYC Mobile SDK fits into your system and what needs to happen for it to works on both Android and iOS.

Android SDKiOS SDK

Configuring VidaKycRequest

The VidaKycRequest object is used to configure and initialize the KYC SDK. Below are all the parameters available when building the request.

JAVA Response

VidaKycRequest request = new VidaKycRequest();

request.setVidaFlow(VidaFlow.ID_VERIFICATION);
request.setApiKey(KeyConstant.api_key);
request.setLicenseKey(KeyConstant.license_key);
request.setVidaSdkRegion(region);
request.setUserID("USER-ID");                                    // Mandatory if ID Fraud Shield is enabled
request.setVidaIdFraudShieldClientId("shield-client-id");       // Required if ID Fraud Shield is enabled
request.setToken(token);
vidaKycRequest.setPartnerTransactionID("PARTNER_TRANSACTION_ID");

Parameters

Parameter	Method	Required	Description
Vida Flow	setVidaFlow()	Yes	Specifies the KYC workflow. Use VidaFlow.ID_VERIFICATION for identity verification.
API Key	setApiKey()	Yes	Your API key used for authenticating SDK requests.
License Key	setLicenseKey()	Yes	Your license key to authorize the SDK.
SDK Region	setVidaSdkRegion()	Yes	The region for the SDK. Pass the appropriate region value based on your deployment.
User ID	setUserID()	No	A unique identifier representing the user.
ID Fraud Shield Client ID	setVidaIdFraudShieldClientId()	Yes, if ID Fraud Shield is enabled.	The client ID for ID Fraud Shield. Required when ID Fraud Shield is part of the KYC workflow.
Token	setToken()	Yes	The bearer token used for authenticating the session.
Partner Transaction ID	setPartnerTransactionID()	No	Your own reference for this KYC flow. If you do not set it, the SDK creates a UUID for you. The SDK adds the operation name and attempt number to your value, so the partnerTrxId in the SDK response will not be the same as the value you sent. See the SDK Response page.