SmartSelfie™ Enrollment and Authentication

Perform a SmartSelfie Enrollment or Authentication job

SmartSelfie™ Authentication is exposed as a flow which performs the following high level steps:

1. Displays instructions to the user

2. Requests camera permissions (if not already granted)

3. Captures and saves Liveness and Selfie images

4. Submits the job to the Smile ID API

5. Delivers the result back to the caller

If you are registering a user for the first time, you should use SmileID.SmartSelfieEnrollment (or SmartSelfieEnrollmentFragment)

If you are authenticating a previously registered user, you should use SmileID.SmartSelfieAuthentication (or SmartSelfieAuthenticationFragment)

Jetpack Compose

import android.util.Log
import androidx.compose.runtime.Composable
import com.smileidentity.SmileID
import com.smileidentity.compose.SmartSelfieRegistration
import com.smileidentity.results.SmartSelfieResult

@Composable
fun SmartSelfieRegistrationExample() {
    SmileID.SmartSelfieEnrollment { result ->
        when (result) {
            is SmileIDResult.Success -> {
                val resultData = result.data
                Log.d("SmartSelfieEnrollment", "Success: $resultData")
                // SmartSelfieResult.Success contains: captured selfie file, captured liveness 
                // files, and latest job status response from the API
                val (selfieFile, livenessFiles, jobStatusResponse) = resultData
            }

            is SmileIDResult.Error -> {
                // There was an error (could be denied camera permissions, network errors, etc)
                val throwable = result.throwable
                Log.w("SmartSelfieEnrollment", "Failure: $it", throwable)
            }
        }
    }
}

Fragment

import android.os.Bundle
import android.util.Log
import androidx.fragment.app.FragmentActivity
import com.smileidentity.fragment.SmartSelfieEnrollmentFragment


class JavaActivity : FragmentActivity() {
    private fun doSmartSelfieEnrollment() {
        val smartSelfieFragment = SmartSelfieEnrollmentFragment.newInstance()
        supportFragmentManager.setFragmentResultListener(
            SmartSelfieEnrollmentFragment.KEY_REQUEST,
            this,
        ) { _: String?, result: Bundle? ->
            val smartSelfieResult = SmartSelfieEnrollmentFragment.resultFromBundle(result!!)
            Log.v("SmartSelfieEnrollment", "Result: $smartSelfieResult")
            when (smartSelfieResult) {
                is SmileIDResult.Success -> {
                    val (selfieFile, livenessFiles, jobStatusResponse) = smartSelfieResult.data
                    // Note: Although the API submission is successful, the job status response
                    // may indicate that the job is still in progress or failed. You should
                    // check the job status response to determine the final status of the job.
                    if (jobStatusResponse.jobSuccess) {
                        Log.v("SmartSelfieEnrollment", "Job Success")
                    } else if (!jobStatusResponse.jobComplete) {
                        Log.v("SmartSelfieEnrollment", "Job Not Complete")
                    } else {
                        Log.v("SmartSelfieEnrollment", "Job Failed")
                    }
                }
                is SmileIDResult.Error -> {
                    val throwable = smartSelfieResult.throwable
                    Log.v("SmartSelfieEnrollment", "Error: " + throwable.message)
                }
            }
            supportFragmentManager
                .beginTransaction()
                .remove(smartSelfieFragment)
                .commit()
        }
        supportFragmentManager
            .beginTransaction()
            .replace(android.R.id.content, smartSelfieFragment)
            .commit()
    }
}

When using the Fragment approach, a convenience resultFromBundle static method is provided to help extract a typed object from the result Bundle.

Arguments

The Javadocs also contain detailed information regarding each parameter.

userId

The user ID to associate with the SmartSelfie™ Registration. Most often, this will correspond to a unique User ID within your own system. (If not provided at time of Registration, a random user ID will be generated. This field is required for Authentication)

jobId

The job ID to associate with the SmartSelfie™ Registration. Most often, this will correspond to a unique Job ID within your own system. If not provided, a random job ID will be generated.

allowAgentMode

Whether to allow Agent Mode or not. If allowed, a switch will be displayed allowing toggling between the back camera and front camera. If not allowed, only the front camera will be used.

showAttribution

Whether to show the Smile ID attribution or not on the Instructions screen

extraPartnerParams

Custom values specific to partners passed as an immutable map

colorScheme

See Theming

typography

See Theming

onResult

Callback to be invoked when the SmartSelfie™ Registration is complete. The result itself is a SmileIDResult which can either be a SmileIDResult.Success or SmileIDResult.Error