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

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") { 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)

DocumentVerificationFragment documentVerificationFragment = DocumentVerificationFragment
    .newInstance("GH");
getSupportFragmentManager().setFragmentResultListener(
    DocumentVerificationFragment.KEY_REQUEST,
    this,
    (requestKey, result) -> {
        SmileIDResult<DocumentVerificationResult> documentVerificationResult =
            DocumentVerificationFragment.resultFromBundle(result);
        Timber.v("DocumentVerification Result: %s", documentVerificationResult);
        getSupportFragmentManager()
            .beginTransaction()
            .remove(documentVerificationFragment)
            .commit();
        hideProductFragment();
    }
);

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, DocumentVerificationResultDelegate {
    @State presentDocumentVerification = false
    var body: some View {
        HStack(spacing: 15) {
            Button(action: {self.presentDocumentVerification.toggle()}) {
                Text("Document Verification")
            }
            .sheet(isPresented: presentDocumentVerification, content: {
                SmileID.documentVerificationScreen(countryCode: "GH", delegate: self)
            })
        }
    }

    func didSucceed(selfie: URL, documentFrontImage: URL, documentBackImage: URL?, didSubmitDocumentVerificationJob: Bool) {
        print("Successfully submitted Document Verification job")
    }

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

UIKit (iOS)

let documentVerificationScreen = SmileID.documentVerificationScreen(...)
let controller = UIHostingController(rootView: documentVerificationScreen)
controller.modalPresentationStyle = .fullScreen
navigationController?.present(controller, animated: true)

Flutter

SmileIDDocumentVerification(
    countryCode: "GH",
    // 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
    }
)

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

{
  "selfieFile":  "<path to selfie file>",
  "documentFrontFile": "<path to document front file>",
  "documentBackFile":  null | "<path to document back file>",
  "jobStatusResponse": {
    "timestamp": "...",
    "jobComplete": true | false,
    "jobSuccess":  true | false,
    "code": "",
    "result": null | {
      "actions": {},
      "resultCode": "...",
      "resultText": "...",
      "smileJobId": "...",
      "partnerParams": {},
      "country": null | "...",
      "idType": null | "...",
      "idNumber": null | "...",
      "fullName":null | "...",
      "dob": null | "...",
      "gender": null | "...",
      "expirationDate": null | "...",
      "documentImageBase64":null | "...",
      "phoneNumber": null | "...",
      "phoneNumber2": null | "...",
      "address": null | "..."
    },
    "history": null | [],
    "imageLinks":  null | {
      "selfieImageUrl": "...",
      "error": "..."
    }
  }
}

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,

 <SmileIDDocumentVerificationView
  allowAgentMode: false, // true if you need to use the secondary camera
  showInstructions: true, // show instructions before capture
  countryCode: '<country code>',
  documentType: '<document type>',
  captureBothSides: true, // true if capturing back and front of document
  allowGalleryUpload: false, //true if document can be uploaded from gallery
  onResult={(event) => {
    setResult(event.nativeEvent.result);
  }}
  />

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

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

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

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).