Integrate the Secure ID Verification SDK

Integrate the Secure ID Verification SDK into your application

Prerequisites

1. Complete the Getting Started Guide

2. Integrate the User SDK

Get Started

• Integrate the iOS SDK

• Integrate the Android SDK

• Integrate the JS SDK

Integrate the iOS SDK

To use the Secure ID Verification SDK in an iOS app, you need to install the SudoIdentityVerification package via Swift Package Manager

Open your project settings in XCode, and go to the Package Dependencies tab. Click on the + sign to add a dependency.

Enter the repository URL https://github.com/sudoplatform/sudo-secure-id-verification-ios.git in the top right search box and select the sudo-secure-id-verification-ios repository.

Select the required version and Add Package.

Sudo Platform SDKs conform to semantic versioning so in most cases you will leave the Dependency Rule as Up to Next Major Version to receive regular updates without introducing any breaking changes.

This will resolve the local package dependency and install the latest version of the Secure ID Verification SDK.

In order to instantiate an Secure ID Verification client, make sure you have followed instructions for Getting Started and User SDK (see Prerequisites above)

To instantiate a client in your application, add the following:

Swift

import SudoIdentityVerification

do {
    let identityVerificationClient: SudoIdentityVerificationClient = try DefaultSudoIdentityVerificationClient(
        sudoUserClient: userClient
    )
catch {
    // Handle initialization error. An error might be thrown due to invalid
    // or missing confiugration file.
}

You only need one client instance for a given user and device. Instantiating multiple clients with the same configuration and using them at the same time may cause unexpected runtime errors to occur.

Integrate the Android SDK

To use Secure ID Verification SDK in an Android app you need to add SudoIdentityVerification library as a dependency to your project.

Edit the app module Gradle script (build.gradle) and add SudoIdentityVerification library as a dependency.

gradle

dependencies {
    api 'com.sudoplatform:sudoidentityverification:$latest_version'
}

The latest version of the SDK can be found at SDK Releases.

Edit AndroidManifest.xml to add the following app permissions:

Diff

 <?xml version="1.0" encoding="utf-8"?>
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
+   xmlns:tools="http://schemas.android.com/tools"
    package="com.sudoplatform.sampleapp">

+   <uses-permission android:name="android.permission.INTERNET" />
+   <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
+   <uses-permission android:name="android.permission.WAKE_LOCK" />
+   <uses-permission android:name="android.permission.READ_PHONE_STATE" />
+   <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
+   <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />

    <application
+       tools:replace="android:allowBackup"
+       android:allowBackup="false"

Instantiating and initializing a client:

Kotlin

val client = SudoIdentityVerificationClient.builder(appContext, sudoUserClient).build()

You only need one client instance for a given user per device. Instantiating multiple clients with the same configuration and using them at the same time may cause unexpected runtime errors to occur.

Integrate the JS SDK

To use the Sudo Secure ID Verification SDK in a Web or Node.js project, you must add @sudoplatform/sudo-secure-id-verification as a dependency to your project.

yarn add '@sudoplatform/sudo-secure-id-verification'
# or
npm install --save '@sudoplatform/sudo-secure-id-verification'

SDK Configuration

Before starting to use SudoSecureIdVerificationClient you must configure it using the configuration information provided to you for your instance of the Sudo Platform. Download and install your project's SDK configuration file before proceeding.

Instantiating and initializing a client:

TypeScript

import { DefaultConfigurationManager } from '@sudoplatform/sudo-common'
import { DefaultSudoUserClient } from '@sudoplatform/sudo-user'
import { DefaultApiClientManager } from '@sudoplatform/sudo-api-client'
import { DefaultSudoSecureIdVerificationClient } from '@sudoplatform/sudo-secure-id-verification'

// Set configuration (content of file downloaded in previous step) in the configuration manager
DefaultConfigurationManager.getInstance().setConfig(configJson)

// Set up Sudo User client
const sudoUserClient = new DefaultSudoUserClient()
DefaultApiClientManager.getInstance().setAuthClient(sudoUserClient)

// Instantiate and initialize the client
const client = new DefaultSudoSecureIdVerificationClient({ sudoUserClient })

You only need one client instance for a given user per device. Instantiating multiple clients with the same configuration and using them at the same time may cause unexpected runtime errors to occur.