Biometric KYC

Perform a Biometric KYC Job

Biometric KYC 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

   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

4. Submits the job to the Smile ID API

5. Delivers the result back to the caller

Consent Information

Some ID Types may require consent to be granted. In such cases the consent information would expect the below so this is completely optional and the SDK will default to false and consent time will be the time of execution

consentGrantedDate. // The date consent was granted defaults to the time of screen initialisation
personalDetailsConsentGranted // If the user has granted personal details consent defaults to false
contactInfoConsentGranted // If the user has granted contact information consent defaults to false
documentInfoConsentGranted // If the user has granted document information consent defaults to false

If the user has granted consent personalDetailsConsentGranted, contactInfoConsentGranted, documentInfoConsentGranted can all be set to true

Java has no named parameters so when using fragments instantiate the consent with the consent grant date in iSO format and all other values set to false.

Jetpack Compose (Android)

@Composable
fun BiometricKYCExample(idInfo: IdInfo) {
    SmileID.BiometricKYC(
        idInfo = idInfo,
        consentInformation =
        ConsentInformation(
            consentGrantedDate = getCurrentIsoTimestamp(), // date in iso string format for when user granted consent
            personalDetailsConsentGranted = false, // set true if user has agreed to personal details, will default to false
            contactInfoConsentGranted = false, // set true if user has agreed to contact information, will default to false
            documentInfoConsentGranted = false, // set true if user has agreed to document information, will default to false
        ),
        useStrictMode = true, // true if you want to capture using enhanced SmartSelfie™ capture) { result ->
        onResult = { result ->
            when (result) {
                is Success -> {
                    // val resultData = result.data
                    // Log.d("BiometricKYC", "Success: $resultData")
                    // ...
                }

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

Fragment (Android)

IdInfo idInfo = new IdInfo(...);
BiometricKYCFragment biometricKycFragment = BiometricKYCFragment
    .newInstance(idInfo);
getSupportFragmentManager().setFragmentResultListener(
    BiometricKYCFragment.KEY_REQUEST,
    this,
    (requestKey, result) -> {
        SmileIDResult<BiometricKYCResult> biometricKycResult =
            BiometricKYCResult.resultFromBundle(result);
        Timber.v("BiometricKYC Result: %s", biometricKycResult);
        getSupportFragmentManager()
            .beginTransaction()
            .remove(biometricKycFragment)
            .commit();
        hideProductFragment();
    }
);

Swift UI (iOS)

import SwiftUI
import SmileID

struct MyView: View, BiometricKycResultDelegate {
    @State private var idInfo: IdInfo
    var body: some View {
        ZStack {
            SmileID.biometricKycScreen(
                idInfo: idInfo,
                consentInformation: ConsentInformation(
                    consentGrantedDate: "date consent granted", // date in iso string format for when user granted consent
                    personalDetailsConsentGranted: false, // set true if user has agreed to personal details, will default to false
                    contactInformationConsentGranted:  false,// set true if user has agreed to contact information, will default to false
                    documentInformationConsentGranted: false // set true if user has agreed to document information, will default to false
                ),
                useStrictMode : true, // true if you want to capture using enhanced SmartSelfie™ capture
                delegate: self
            )
        }
    }
    
    func didSucceed(selfieImage: URL, livenessImages: [URL], didSubmitBiometricJob: Bool) {
        print("Successfully submitted Biometric KYC job")
    }
    
    func didError(error: Error) {
        print("An error occurred - \(error.localizedDescription)")
    }
}

UIKit (iOS)

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

Flutter

Navigator.of(context).push( //Requires Navigator.of(context).push in order to load
    MaterialPageRoute<void>(
        builder: (BuildContext context) => Scaffold(
            appBar: AppBar(title: const Text("SmileID Biometric KYC")),
            body: SmileIDBiometricKYC(
                country: "KE",
                idType: "NATIONAL_ID",
                idNumber: "12345678",
                showInstructions: true, //Show the instruction screen
                useStrictMode: true, // true if you want to capture using enhanced SmartSelfie™ capture (will invalidate the above)
                consentGrantedDate : DateTime.now().toIso8601String(), // date in iso string format for when user granted consent
                personalDetailsConsentGranted = false, // set true if user has agreed to personal details, will default to false
                contactInformationConsentGranted = false, // set true if user has agreed to contact information, will default to false
                documentInformationConsentGranted = false, // set true if user has agreed to document information, will default to false
                onSuccess: (String? result) {
                    // Your success handling logic
                    final snackBar = SnackBar(content: Text("Success: $result"));
                    ScaffoldMessenger.of(context).showSnackBar(snackBar);
                    Navigator.of(context).pop(); //Return flow to your app
                },
                onError: (String errorMessage) {
                    // Your error handling logic
                    final snackBar = SnackBar(content: Text("Error: $errorMessage"));
                    ScaffoldMessenger.of(context).showSnackBar(snackBar);
                    Navigator.of(context).pop(); //Return flow to your app
                },
            ),
        ),
    ),
);

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,

<SmileIDBiometricKYCView
  allowAgentMode={false} // true if you need to use the secondary camera
  allowGalleryUpload={false} //true if document can be uploaded from gallery
  captureBothSides={true} // true if capturing back and front of document
  showInstructions={true} // show instructions before capture
  useStrictMode={true} // true if you want to capture using enhanced SmartSelfie™ capture (will invalidate the above)
  idInfo={{
    country: "<country code>",
    idType: "<id type>",
    idNumber: "<id number>",
    entered: true,
  }}
  consentInformation ={
      {
          consentGrantedDate: new Date().toISOString(),  // date in iso string format for when user granted consent
          personalDetailsConsentGranted: true,  // set true if user has agreed to personal details, will default to false
          contactInfoConsentGranted: true, // set true if user has agreed to contact information, will default to false
          documentInfoConsentGranted: true, // set true if user has agreed to document information, will default to false
      }
  }
  style={{ width: '100%', height: '100%' }} //fill the entire view
  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>",
    "<path to liveness file>",
    ...
    "<path to liveness file>",
  ],
  "didSubmitBiometricKycJob": true
}