Telesign Verify Android SDK

The Telesign Verify Android SDK enables you to implement the Telesign Verify API in your Android mobile apps. This API makes it easy for you to set up phone-based, multi-factor authentication (MFA). When conditions apply, your end users' devices can be authenticated seamlessly in the background without the need for any user action. When that option isn't available, you can have the verification process automatically fail over to sending a one-time passcode (OTP) via SMS, WhatsApp, Viber, RCS, or email.

Requirements

• Android Application Gradle Plugin version 8+
• minSdk version 26+
• Java min version 11+
• Kotlin Android Plugin min version 2+
• (Optional) Kotlin The SDK is written in Kotlin. You can use the SDK inside Java projects, but additional configuration might be needed.

NOTE:

These instructions are for MacOS/Unix. You will need to adapt them if you are installing on Windows.

Installation steps

1. Create a new directory in which to download the Telesign SDK.

   mkdir telesign_sdks
   cd telesign_sdks
   

2. Clone this repo. A new directory should appear called android_sdk_verify.

   git clone https://github.com/TeleSign/android_sdk_verify.git      
   

3. Go to the /release folder.

4. Copy the com.telesign.verify-{version number}-ctrl.aar file and paste it into the /libs/ folder of your project root.

5. Add the following lines to repositories in your settings.gradle file: dependencyResolutionManagement { repositories { flatDir { dirs("libs") } } }

6. Add the following lines to the dependencies in your build.gradle file:

   implementation 'com.squareup.okhttp3:okhttp:5.3.2'
   implementation 'org.jetbrains.kotlinx:kotlinx-serialization-json:1.7.3'
   implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.10.2'
   implementation 'androidx.security:security-crypto:1.0.0'
   implementation(platform('com.google.firebase:firebase-bom:34.6.0'))
   implementation 'com.google.firebase:firebase-messaging-ktx:24.1.2'
   implementation(mapOf("name" to "com.telesign.verify-{version number}-ctrl", "ext" to "aar"))
   

7. Run Gradle sync.

   gradle sync   
   

Release history

See RELEASE.md for release history.

Documentation

• Reference documentation for this SDK can be found by opening the local file "docs/reference/html/index.html" in your browser.
• Additional documentation for the Telesign Verify API can be found here.

Support

For assistance using this SDK, contact Telesign Customer Support.