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

4. Submits the job to the Smile ID API

5. Delivers the result back to the caller

The screen is exposed as a React Native view which you can incorporate into your app as follows:

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

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": "..."
    }
  }
}