Adding the SDK to your project

1
allprojects {
2
    repositories {
3
        maven {
4
            name = "IDmeSDK"
5
            url = uri("https://us-maven.pkg.dev/idme-public-artifacts-5581/all")
6
        }
7
    }
8
}

1
dependencies {
2
    implementation 'me.id.sdk:idme-sdk-android:<version>' // latest version is 0.9.0
3
}

configurations.all {
    resolutionStrategy {
        eachDependency {
            if (requested.group == "com.squareup.okhttp3" && requested.name == "okhttp-jvm") {
            useTarget("com.squareup.okhttp3:okhttp:${requested.version}")
            because("choosing okhttp over okhttp-jvm")
            }
        }
    }
}

Required app integration steps

1
android {
2
    defaultConfig {
3
        manifestPlaceholders["appAuthRedirectScheme"] = "<insert package name>"
4
    }
5
}

Initialization

To initialize the SDK, create a subclass of the Application class, and add the following code to your onCreate() method:

1
class SampleApp : Application() {
2
	override fun onCreate() {
3
		super.onCreate()
4
		IDmeSDK.init(this.applicationContext, sdkConfig)
5
	}
6
}

You will need to pass in an instance of IDMeSDKConfig while initializing the SDK. This example demonstrates how to create this config:

1
val sdkConfig = IDmeSDKConfig(
2
	externalUserId = "sample-user-id", // Unique identifier for the user
3
	appName = "SampleApp", // Name of the app
4
	tokenProvider = ::tokenProvider
5
)

The tokenProvider in the example is responsible for generating the client access token. This token enables the SDK to make REST API requests to ID.me’s backend APIs. The application must obtain a client access token from ID.me and provide a function to generate a new token if the current one expires. The SDK will then automatically use this to make REST API requests. This example illustrates the signature of this token provider method:

1
suspend fun tokenProvider(): String = withContext(Dispatchers.IO) {
2
	// Fetch client token from the backend and return it
3
}

Common usage patterns

This section provides examples of common tasks you can perform with our Mobile SDK.

Performing legal document and face liveness verification

This section details the process of legal document and face liveness verification utilizing our Mobile SDK. Initiating a verification is straightforward, as demonstrated by the code snippets below.

1
idmeSDK.verificationsManager.beginVerification(VerificationType.DOCUMENT)
2
3
idmeSDK.verificationsManager.beginVerification(VerificationType.FACE_LIVENESS)

Once the verification is complete, you will receive a result, which contains the following fields:

1
VerificationResult {
2
	verificationId: // The local ID of the verification
3
    serverVerificationId: // The server verification ID of the verification
4
	verificationStatus: // The status of the verification
5
	errorCode: // Error code if the verification failed, null otherwise
6
	errorMessage: // Error message if the verification failed, null otherwise
7
	credentialId: // ID that can be used to fetch the document from ID.me's credentials REST API endpoint, null if the verification failed
8
    nfcData: //NFC data extracted during document verification (null if not available or extraction failed). Contains Base64-encoded DG1 (MRZ data) and DG2 (face image)
9
    nfcExtractionFailed: // Indicates if NFC extraction was attempted but failed
10
}

Checking the status of an ongoing verification

This section describes how to obtain the status of an ongoing verification.

1
// Returns the verificationID and status of all the ongoing verifications
2
idmeSDK.verificationsManager.getAllVerifications()

Customizing the user interface

This section details how to customize the user interface. While default values are based on ID.me’s design system, you have the flexibility to replace any or all of these to align with your application’s aesthetic. We provide customization options for the following elements:

• Colors: Modify the color scheme of various interface elements.
• Button Radius: Control the roundness of buttons within the Mobile SDK.
• Logo: Replace the default ID.me logo with your application’s logo.
• Fonts: Choose the fonts used for all text displayed in the document scanner interface.

1
idmeSDK.verificationsManager.setBaseUIConfig(
2
	IdmeBaseUIConfig(
3
		colors = IDmeBaseColors(
4
			background = Color(<insert hex>).toArgb(),
5
			onBackground = Color(<insert hex>).toArgb(),
6
			onBackgroundSecondary = Color(<insert hex>).toArgb(),
7
			onBackgroundTertiary = Color(<insert hex>).toArgb(),
8
			primary = Color(<insert hex>).toArgb(),
9
			onPrimary = Color(<insert hex>).toArgb(),
10
			secondary = Color(<insert hex>).toArgb(),
11
			onSecondary = Color(<insert hex>).toArgb(),
12
			outline = Color(<insert hex>).toArgb(),
13
			success = Color(<insert hex>).toArgb(),
14
			error = Color(<insert hex>).toArgb()
15
		),
16
		buttonRadius = <insert button radius>,
17
		logo = <insert logo>,
18
		fonts = IDmeFonts(
19
			regular = <insert font>,
20
			medium = <insert font>,
21
			bold = <insert font>
22
		)
23
	)
24
)
25
26
idmeSDK.verificationsManager.setDocScanUIConfig()
27
28
idmeSDK.verificationsManager.setFaceLivenessUIConfig()

Support