Android SDK

Latest Version: 1.1.1

Integrate seamless ID verification and Know Your Customer (KYC) compliance into your Android applications with our streamlined VoveSDK. This guide outlines the steps to incorporate VoveSDK effectively into your Android projects.

Installation

Incorporate VoveSDK into your project by adding it as a dependency in your app's build.gradle file, ensuring you have access to the required repository:

Kotlin DSL (build.gradle.kts)

repositories {
    maven { url 'https://jitpack.io' }
}

dependencies {
    implementation("com.github.VOVE-ID:vove-id-android:1.1.1")
}

Groovy DSL (build.gradle)

repositories {
    maven { url 'https://jitpack.io' }
}

dependencies {
    implementation "com.github.VOVE-ID:vove-id-android:1.1.1"
}

Permissions

Add the necessary camera permission to your AndroidManifest.xml:

<uses-permission android:name="android.permission.CAMERA"/>

Usage

Initialize Vove SDK

To initialize the Vove SDK, use your public API key. This setup should ideally be done in your Application class as early as possible

Vove.initialize(context, "ENVIRONMENT", "PUBLIC_KEY") { isInitialized ->
    if (isInitialized) {
        println("success")
    } else {
        println("failure")
    }
}

Starting a Verification Session

Invoke the SDK to start an ID verification session directly, providing a session token generated by your backend.

Kotlin:

Vove.start(context, VoveEnvironment.SANDBOX, "YOUR_SESSION_TOKEN") { verificationResult ->
    runOnUiThread {
        when (verificationResult) {
            VerificationResult.SUCCESS -> Toast.makeText(context, "Verification success", Toast.LENGTH_LONG).show()
            VerificationResult.FAILURE -> Toast.makeText(context, "Verification failed", Toast.LENGTH_LONG).show()
            VerificationResult.PENDING -> Toast.makeText(context, "Verification pending", Toast.LENGTH_LONG).show()
            VerificationResult.CANCELLED -> Toast.makeText(context, "Verification canceled", Toast.LENGTH_LONG).show()
        }
    }
}

Java:

Vove.INSTANCE.start(context, VoveEnvironment.SANDBOX, "YOUR_SESSION_TOKEN", (result) -> {
    switch (verificationResult) {
        case SUCCESS:
        Toast.makeText(getApplicationContext(), "Verification success", Toast.LENGTH_LONG).show();
        break;
        case FAILURE:
        Toast.makeText(getApplicationContext(), "Verification failed", Toast.LENGTH_LONG).show();
        break;
        case PENDING:
        Toast.makeText(getApplicationContext(), "Verification pending", Toast.LENGTH_LONG).show();
        break;
        case CANCELLED:
        Toast.makeText(getApplicationContext(), "Verification canceled", Toast.LENGTH_LONG).show();
        break;
    }
});

Setting the Application Locale

VoveSDK supports various locales to accommodate a diverse user base. You can programmatically set the locale to match the user's language and regional preferences, which enhances the user experience in multilingual applications or regions with specific language requirements.

To change the locale in VoveSDK, use the following method with the desired value from the VoveLocale enumeration:

 Vove.setLocale(context, VoveLocale.EN)

Here is the list of supported locales defined in the VoveLocale enumeration, which you can select to ensure the SDK’s text and user interface elements are presented in the chosen language:

• VoveLocale.EN: English

• VoveLocale.FR: French

• VoveLocale.AR: Arabic

• VoveLocale.AR_MA: Moroccan Arabic

Enabling Vocal Guidance for 3D Liveness Verification

To enhance the user experience and accuracy during the 3D liveness verification process, VoveSDK on Android offers an optional vocal guidance feature. This feature provides audio instructions to guide users through the verification process, helping them position themselves correctly in front of the camera.

Vove.setEnableVocalGuidance(true)

When enabled, the SDK provides voice instructions during the 3D liveness verification step, aiding users in performing the necessary actions correctly and efficiently.

Support

By following the steps outlined in this guide, you can effectively integrate the VoveSDK into your Android applications, ensuring efficient and secure ID verification and KYC compliance. For further assistance or questions, please contact our support team.