Document Verification

Perform a Document Verification Job

Document Verification 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. Performs Document Capture

4. Performs Selfie Capture

   1. useStrictMode defaults to false and will use Smile Smartselfie™ capture screens for selfie

   2. If useStrictMode is set to true the selfie capture use Enhanced SmartSelfie™ capture

5. Submits the job to the Smile ID API

6. Delivers the result back to the caller

Jetpack Compose (Android)

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 DocumentVerificationExample() {
    // It will need to be provided as input depending on your use case
    SmileID.DocumentVerification(
    country = "GH"
    useStrictMode = true, // true if you want to capture using enhanced SmartSelfie™ capture 
    ) { result ->
        when (result) {
            is SmileIDResult.Success -> {
                val resultData = result.data
                Log.d("DocumentVerification", "Success: $resultData")
                // DocumentVerificationResult contains: captured documents, captured selfie,
                // and job status response from the API
                val (selfieFile, documentFrontFile, documentBackFile, jobStatusResponse) = resultData
            }

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

Fragment (Android)

Swift UI (iOS)

UIKit (iOS)

Flutter

React Native

React Native Expo

Arguments

country

A 2-letter country code (ISO 3166-1 alpha-2 compliant)

documentType

The type of document/ID that is to be captured. If omitted, the document type will be automatically determined

captureBothSides

Boolean indicating whether both sides of the ID card should be captured. When set to true, the user will still be presented with the option to skip capturing the back of the ID card. This value can be fetched by calling SmileID.api.getValidDocuments() and checking the hasBack property of a document

bypassSelfieCaptureWithFile

If this value is provided, then the user will not be asked to capture a selfie as part of this flow

userId

The user ID to associate with the job. 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 job. Most often, this will correspond to a unique Job ID within your own system. If not provided, a random job ID will be generated.

idAspectRatio

The aspect ratio of the ID to be captured. If not specified, the aspect ratio will attempt to be inferred from the device's camera.

showAttribution

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

autoCapture

This is an enum that determines whether how autocapture is used. It takes the values: autoCapture, autoCaptureOnly, manualCaptureOnly. The default is autoCapture

autoCapture

This is an enum that determines how autocapture is used. It takes the values: autoCapture, autoCaptureOnly, manualCaptureOnly. The default is autoCapture

⚠️ Do not change the default as this might affect your passrates. Learn more on the reason for using this flag here: document autocapture details.

Enum Options

1. autoCapture (default)

Uses automatic document capture, with a fallback to a manual capture button after 10 seconds if auto-capture is unsuccessful.

Recommended: Best for maintaining high pass rates and optimal user experience.

1. autoCaptureOnly ⚠️

Only automatic document capture is allowed. There is no manual fallback.

Warning: Enabling this may reduce your pass rates if auto-capture fails, since users will not be able to capture documents manually.

1. manualCaptureOnly ⚠️

Only manual capture is permitted. No automatic capture is used.

Warning: Disabling auto-capture may negatively impact your pass rates and user experience, as manual capture relies entirely on user input.

allowGalleryUpload

Whether the user should be allowed to upload their document photos from the Gallery instead of performing a live capture

showInstructions

Whether to deactivate capture screen's instructions

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 job 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 notified when there is a result from the DocumentVerification flow. This class has to conform to DocumentCaptureResultDelegate and implement the delegate methods func didSucceed(selfie: URL, documentFrontImage: URL, documentBackImage: URL?, jobStatusResponse: DocumentVerificationJobStatusResponse) and func didError(error: Error).