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

Jetpack Compose (Android)

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

If you are authenticating a previously registered user, you should use SmileID.SmartSelfieAuthentication

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 (Android)

If you are registering a user for the first time, you should use SmartSelfieEnrollmentFragment

If you are authenticating a previously registered user, you should use SmartSelfieAuthenticationFragment

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.

Swift UI (iOS)

import SwiftUI
import SmileID

struct HomeView: View, SmartSelfieResultDelegate {
@State presentAuth = false
@State presentEnroll = false

    var body: some View {
        HStack(spacing: 15) {
            Button(action: {self.presentEnroll.toggle()}) {
                Text("SmartSelfie™ Enrollment")
            }
            .sheet(isPresented: $presentEnroll, content: {
                SmileID.smartSelfieEnrollmentScreen(userId: "userID", delegate: self)
            })

            Button(action: {self.presentAuth.toggle()}) {
                Text("SmartSelfie™ Authentication")
            }
            .sheet(isPresented: $presentEnroll, content: {
                SmileID.smartSelfieAuthenticationScreen(userId: "userID", delegate: self)
            })
        }
    }

    func didSucceed(selfieImage: Data, livenessImages: [Data], jobStatusResponse: SmartSelfieJobStatusResponse) {
        print("Successfully submitted SmartSelfie job")
    }

    func didError(error: Error) {
        print("An error occured - \(error.localizedDescription)")
    }
}

UIKit (iOS)

let smartSelfieEnrollmentScreen = SmileID.smartSelfieEnrollmentScreen(...)
let uiKitController = UIHostingController(rootView: smartSelfieEnrollmentScreen)
smartSelfieScreen.modalPresentationStyle = .fullScreen
navigationController?.present(uiKitController, animated: true)

Flutter

SmileIDSmartSelfieEnrollment(
    userId: "random-user-id/generated-user-id",
    // There are more parameters -- they correspond 1:1 with the native SDK parameters
    onSuccess: (String? result) {
        // Your success handling logic
    },
    onError: (String errorMessage) {
        // Your error handling logic
    }
)

If you are authenticating a previously registered user, you should use SmileIDSmartSelfieAuthentication Flutter widget

SmileIDSmartSelfieAuthentication(
    userId: "random-user-id/generated-user-id",
    // There are more parameters -- they correspond 1:1 with the native SDK parameters
    onSuccess: (String? result) {
        // Your success handling logic
    },
    onError: (String errorMessage) {
        // Your error handling logic
    }
)

React Native

⚠️ Note: Recommend wrapping this in a component that can be navigated to and out of view due to a known issue with views displaying dialogs particularly on failure and the dialog keeps showing,

 <SmileIDSmartSelfieEnrollmentView
  userId: "random-user-id/generated-user-id",
  onResult={(event) => {
    setResult(event.nativeEvent.result);
  }}
  />

If you are authenticating an existing user you should use SmileIDSmartSelfieAuthenticationView

 <SmileIDSmartSelfieAuthenticationView
  userId: "random-user-id/generated-user-id",
  onResult={(event) => {
    setResult(event.nativeEvent.result);
  }}
  />

React Native component

On onResult, you will receive a JSON string following the structure:

{
  "selfieFile":  "<path to selfie file>",
  "livenessFiles": "<path to liveness files>",
  "apiResponse": {
    "code": "...",
    "created_at": true | false,
    "job_id":  true | false,
    "job_type": "",
    "message": "",
    "partner_id": "",
    "partner_params": "",
    "status": "",
    "updated_at": "",
    "user_id": "",
  }
}

Arguments

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

skipApiSubmission

Whether to capture images and not Submit to the SmileID api, this will return file paths which can be retrieved for later use.

extraPartnerParams

Custom values specific to partners passed as an immutable map

colorScheme

See Theming

typography

See Theming

onResult (Android)

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

delegate (iOS)

This is the delegate object that is notifed when there is a result from the SmartSelfie™ flow. This class has to conform to SmartSelfieResultDelegate and implement the delegate methods func didSucceed(selfieImage: Data, livenessImages: [Data], jobStatusResponse: JobStatusReponse) and func didError(error: Error)