Verify API - Get started with QR Verify

📘

NOTE:

LIMITED RELEASE: For customers who opt in to our early access program, QR Verify is now available for use with Verify API. Contact a Telesign expert or your Customer Success Manager for more details.


To add Verify API to your account, contact a Telesign expert. This product is available for full-service accounts only.

QR Verify provides a secure mechanism for device registration and identity verification using QR codes to securely authenticate your users. This page explains the basic usage of the QR Verify verification method of the Telesign Verify API and directs you to two key sets of instructions you will need to code your integration. These instructions assume the use of a verification policy with:

• QR Verify set as the primary verification method.
• SMS one-time passcode (OTP) set as the fallback verification method.

These instructions assume a log in use case, but the same verification workflow also applies to other use cases.

Before you begin

• Review Verify API - Get started and its key terms for Verify API.
• Install the Telesign Verify Android SDK or Telesign Verify iOS SDK, depending on your specific needs. Contact Telesign Customer Support or your Telesign contact to get access.
• Implement Verify API and Verify Mobile SDK to your website as well as to your mobile app. This is required in order for QR Verify to work successfully.

Basic usage

This workflow assumes that each step in the flow is successful and that the app has not already registered for QR Verify.

1. The user downloads and installs your mobile app on their device for the first time. This app includes the Telesign SDK.
2. The user registers this new device as a trusted device with QR Verify.
3. The user later attempts to log in on your website.
4. You begin to authenticate that user by displaying a QR on your website that must be read with their previously registered device.
5. Your backend communicates with Verify API to trigger a new user verification.
6. Your website allows the user to log in.

Setup

Telesign Verify Android SDK

• Add the Telesign Verify Android SDK as a dependency in the Gradle project for your Android app. For access, please contact our Customer Support Team.
• Add the following statements to the "proguard-rules.pro" file for the project:
  Kotlin

  -keep class com.telesign.verify.data.dto.** { *; }
  -keep class com.telesign.verify.api.models.** { *; }
  

  These statements exempt those two classes from being obfuscated by ProGuard, which is necessary for the Telesign SDK to function.

Telesign Verify iOS SDK

Verify iOS SDK is distributed as a Swift Package. You just need to add a dependency in your project in XCode.

1. Select your project from the Project navigator.
2. Go to the section Package Dependencies.
3. Select the plus sign to add a new package:
4. Enter the repository URL in the search box.
5. Select Add Package.

To get the repository URL or for further assistance, contact our Customer Support Team.

Further instructions

For further details on how to implement the different components of this architecture, see:

• Verify API - Register a new device with QR Verify
• Verify API - Authenticate a user with QR Verify