myid 1.0.1

Unique tool for easy and secure biometric facial identification

MyID Android SDK

Table of contents

• Changelog
• Important
• Getting started
  • Before you begin
  • Setup MyID Android SDK
  • Permissions
• Usage
  • Methods
  • Handling callbacks
• SDK error codes
• UI customization

Important

Note: When you update the version of MyID SDK in your application, check the version of the libraries in dependencies and update them too!

Getting started

1.1 Before you begin

Install or update Android Studio to its latest version.

The SDK supports API level 21 and above

Make sure that your app meets the following requirements:

• minSdkVersion = 21
• targetSdkVersion = 33
• android.useAndroidX = true

compileOptions {
  sourceCompatibility JavaVersion.VERSION_1_8
  targetCompatibility JavaVersion.VERSION_1_8
}

• myid-sdk-***.aar, has been provided to you, it contains SDK public interface and implementation. Archive name contains ever increasing release version number.

1.2 Setup MyID Android SDK

Create new project in AndroidStudio. Inside mobile application folder create new folder to store SDK libraries (For example libs) and copy MyID SDK provided libraries.

Add reference to library to module build.gradle:

implementation(files("libs/myid-sdk-2.1.7-release.aar"))

Note: You can get myid-sdk-2.1.7-release.aar file from here

After synchronization, You should be able to access to SDK classes from your source code.

MyID Android SDK also requires following libraries to be added:

dependencies {
    implementation(files("libs/myid-sdk-2.1.7-release.aar"))

    implementation("androidx.appcompat:appcompat:1.5.1")
    implementation("androidx.constraintlayout:constraintlayout:2.1.4")
    implementation("androidx.lifecycle:lifecycle-viewmodel-ktx:2.5.1")
    implementation("androidx.lifecycle:lifecycle-runtime-ktx:2.5.1")

    def cameraVersion = "1.2.2"
    implementation("androidx.camera:camera-camera2:$cameraVersion")
    implementation("androidx.camera:camera-lifecycle:$cameraVersion")
    implementation("androidx.camera:camera-view:$cameraVersion")
    
    // Use these dependencies if your app supports Google Play Services
    implementation("com.google.android.gms:play-services-mlkit-face-detection:17.1.0")
    implementation("com.google.android.gms:play-services-mlkit-text-recognition:18.0.2")
    implementation("com.google.android.gms:play-services-mlkit-barcode-scanning:18.2.0")

    // Use these dependencies if your app doesn't support Google Play Services
    implementation("com.google.mlkit:face-detection:16.1.5")
    implementation("com.google.mlkit:text-recognition:16.0.0-beta6")
    implementation("com.google.mlkit:barcode-scanning:17.1.0")
    
    implementation("io.ktor:ktor-client-android:2.1.2")
}

1.3 Permissions

Add following lines to the AndroidManifest.xml:

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

Usage

With Activity Result API

class ExampleActivity : AppCompatActivity(), MyIdResultListener {

    private val myIdClient = MyIdClient()

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        startMyId()
    }

    private fun startMyId() {
        val organizationDetails = MyIdOrganizationDetails(
            phoneNumber = "1234567",
            logo = R.drawable.image_logo
        )
        
        val myIdConfig = MyIdConfig.builder(clientId = /* Your client id */)
            .withPassportData(passportData)
            .withBirthDate(dateOfBirth)
            .withSdkHash(sdkHash)
            .withExternalId(externalId)
            .withThreshold(threshold)
            .withBuildMode(MyIdBuildMode.PRODUCTION)
            .withEntryType(MyIdEntryType.AUTH)
            .withResidency(MyIdResidentType.RESIDENT)
            .withLocale(Locale("en"))
            .withCameraShape(MyIdCameraShape.CIRCLE)
            .withResolution(MyIdResolution.RESOLUTION_480)
            .withImageFormat(MyIdImageFormat.PNG)
            .withOrganizationDetails(organizationDetails)
            .withPhoto(false)
            .build()

        val intent = client.createIntent(activity = this, myIdConfig = myIdConfig)
        result.launch(intent)
    }

    private val result = takeUserResult(listener = this)
}

With onActivityResult method

class ExampleActivity : AppCompatActivity(), MyIdResultListener {

    private val myIdClient = MyIdClient()

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        startMyId()
    }
    
    override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
        super.onActivityResult(requestCode, resultCode, data)
        myIdClient.handleActivityResult(resultCode, this)
    }

    private fun startMyId() {
        val organizationDetails = MyIdOrganizationDetails(
            phoneNumber = "1234567",
            logo = R.drawable.image_logo
        )
        
        val myIdConfig = MyIdConfig.builder(clientId = /* Your client id */)
            .withPassportData(passportData)
            .withBirthDate(dateOfBirth)
            .withSdkHash(sdkHash)
            .withExternalId(externalId)
            .withThreshold(threshold)
            .withBuildMode(MyIdBuildMode.PRODUCTION)
            .withEntryType(MyIdEntryType.AUTH)
            .withResidency(MyIdResidentType.RESIDENT)
            .withLocale(Locale("en"))
            .withCameraShape(MyIdCameraShape.CIRCLE)
            .withResolution(MyIdResolution.RESOLUTION_480)
            .withImageFormat(MyIdImageFormat.PNG)
            .withOrganizationDetails(organizationDetails)
            .withPhoto(false)
            .build()

        /*
           Start the flow. 1 should be your request code (customize as needed).
           Must be an Activity or Fragment (support library).
           This request code will be important for you on onActivityResult() to identify the MyIdResultListener.
        */
        myIdClient.startActivityForResult(this, 1, myIdConfig)
    }
}

1.1 Methods

Method	Notes	Default
withPassportData(value: String)	Passport serial number or PINFL data	Optional
withBirthDate(value: String)	Date of birth in. Format: dd.MM.yyyy	Optional
withSdkHash(value: String)	32 characters long string	Optional
withExternalId(value: String)	36 characters long. Should match with UUID4 regex	Optional
withThreshold(value: Float)	The value can be in the range of 0.50 - 0.99	0.50
withBuildMode(value: MyIdBuildMode)	Build mode	MyIdBuildMode.PRODUCTION
withEntryType(value: MyIdEntryType)	Customizing the SDK Entry types	MyIdEntryType.AUTH
withResidency(value: MyIdResidentType)	To set a specific resident type	MyIdResidentType.RESIDENT
withLocale(value: Locale)	To set a specific locale	Locale("uz")
withCameraShape(value: MyIdCameraShape)	To set a specific camera shape	MyIdCameraShape.CIRCLE
withResolution(value: MyIdResolution)	To set a specific camera resolution	MyIdResolution.480
withImageFormat(value: MyIdImageFormat)	To set a specific image format	MyIdImageFormat.PNG
withOrganizationDetails(value: MyIdOrganizationDetails)	Custom Organization Details	Optional
withPhoto(value: Boolean)	Return SDK face bitmap	false

Note 1.1. You can customize the screen for entering passport data and date of birth in your application, in which case you can pass these parameters during initialization to the SDK, otherwise the SDK requires the input of passport data and date of birth for user identification.

Note 1.2. If the sdk_hash is empty, blank or string with length other than 32 has been provided, we will continue showing the credentials screen.

Note 1.3. If the externalId is not empty, has a length of 36 characters and corresponds to the regular expression UUID4, we will display a recommendation screen in case the sdk detects a blurry photo.

Note 1.4. MyIdBuildMode contains DEBUG and PRODUCTION modes.

• DEBUG is used to sandbox.
• PRODUCTION is used to production.

Note 1.5. MyIdEntryType contains AUTH and FACE types.

• AUTH is used to identify the user through the MyID services.
• FACE is used to detect a face and returns a picture (bitmap).

Note 1.6. MyIdCameraShape contains CIRCLE and ELLIPSE types.

1.2 Handling callbacks

val myIdResultListener: MyIdResultListener = object : MyIdResultListener {
    override fun onSuccess(result: MyIdResult) {
        // Get face bitmap and result code

        val bitmap = result.bitmap
        val code = result.code
        val comparison = result.comparison
    }

    override fun onUserExited() {
        // User left the SDK
    }

    override fun onError(e: MyIdException) {
        // Get error message and code:

        val message = e.message
        val code = e.code
    }
}

Attribute	Notes
onSuccess	MyIdResult contains information about the face captures made during the flow, result code and comparison value.
onUserExited	User left the SDK flow without completing it.
onError	Some error happened. MyIdException contains information about the error message and code

SDK error codes

The error code in the following list may appear during the call of SDK. The list below is for your reference.

Code	Error message
2	Паспортные данные введены неправильно
3	Не удалось подтвердить жизненность
4	Не удалось распознать
5	Внешний сервис недоступен или работает некорректно
6	Запрашиваемый пользовател скончался
7	Фото с ресурсов не получено
8	Внутренняя ошибка MyID
9	Срок выполнения задачи истек
10	Срок ожидания задачи в очереди истек
11	Сервис MyID не может обработать запрос. Попробуйте повторить позже
12	Сервис MyID не может обработать запрос. Попробуйте повторить позже
13	Сервис MyID не может обработать запрос. Попробуйте повторить позже
14	Не удалось подтвердить жизненность. Некорректная фотография
15	Сервис MyID не может обработать запрос. Попробуйте повторить позже
16	Сервис MyID не может обработать запрос. Попробуйте повторить позже
17	Не удалось распознать. Некорректная фотография
18	Сервис проверки жизненности не может обработать запрос
19	Сервис распознования не может обработать запрос
20	Размытая фотография
21	Лицо не полностью изображено
22	Обнаружено несколько лиц
23	Представленное изображение в градациях серого, требуется цветное изображение
24	Обнаружены затемненные очки
25	Тип фотографии не поддерживается
26	Глаза закрыты либо не видны
27	Обнаружено вращение головы
28	Не удалось обнаружить все ориентиры
101	Непредвиденная ошибка
102	Доступ к камере запрещен
103	Ошибка при получении данных с сервера
120	Размытое фото обнаружено в SDK