Hosted Common Use Cases

Instead of building your own flow, it’s highly recommended to fork an existing flow from the public sample codes found here

eKYC Forms Flow

The eKYC Forms Flow on the Hosted OneSDK allow customers to embed or send their end-users a link with a fixed set of forms that allow PII data to be captured and used for KYC. Customers will gain access to the following screens in sequence with no ability to make any modifications.

IDV Flow

The IDV flow is a combination of the vendors SDK all-in-one where the customer goes through the process of (1) capturing their document and (2) running the selfie and liveness checks.

IDV + Review Screen Flow

OCR Only Flow

OCR Only Flow on the Hosted OneSDK allow customers to embed or send their end-users a link with an OCR journey provided by Onfido / Incode, getting their data to be captured and used for KYC.

Listening to Window Events with Hosted OneSDK

Hosted OneSDK will emit window events during specific stage of your onboarding experience. You can leverage this mechanism to handle error and success handling

flowIdOn which stage?Event EmittedPayload
ocr_only

failed uploading OCR

ocr_only:failed-
ocr_only

success uploading OCR

ocr_only:success-
manual_kyc

manual kyc is mounted

manual_kyc:mounted-
manual_kyc

success with manual kyc

manual_kyc:success-
manual_kyc

partial success with manual kyc

manual_kyc:partial-
manual_kyc

failed manual kyc

manual_kyc:failed-
idv

idv is getting mounted

idv:mount-
idv

idv process success

idv:success-
idv

idv process failed

idv:failed-
idv

idv getting rendered

idv:render-
idv_review

idv_review is getting mounted

idv_review:mount-
idv_review

idv_review getting rendered

idv_review:render-
idv_review

idv was failed on idv_review flow

idv_review:idv_failed(error message depends on error type)
idv_review

after submitting review screen

idv_review:submit
idv_review

idv_review process is success

idv_review:success

result from calling individual.submit()

sample:

1    {
2      "payload": {
3        "checkDate": "0001-01-01T00:00:00.000Z",
4        "checkTypes": [
5          "id",
6          "namev",
7          "two_plus",
8          "pep",
9          "idvalidate"
10        ],
11        "personalChecks": {
12          "name": null,
13          "dateOfBirth": null,
14          "phoneNumber": null,
15          "email": null,
16          "chineseName": null,
17          "addresses": {
18            "4021e881-e51a-48ab-b8db-82cdc882d1a2": null
19          }
20        },
21        "status": {
22          "type": "unchecked",
23          "label": "Unchecked",
24          "key": "UNCHECKED"
25        },
26        "risk": {
27          "level": null,
28          "class": "HIGH"
29        },
30        "alertList": [],
31        "blocklistPotentialMatches": [],
32        "duplicatePotentialMatches": [],
33        "duplicateBlocklistMatches": [],
34        "checkCounts": {
35          "name": null,
36          "address": {
37            "4021e881-e51a-48ab-b8db-82cdc882d1a2": []
38          },
39          "document": {},
40          "dob": null
41        },
42        "kycMethod": "electronic",
43        "issues": {
44          "creditHeader": false,
45        },
46        "checkResults": [],
47        "rulesetsMatches": []
48      }
49    }
idv_review

during idv_review, there are some issues occurred

idv_review:error
1{
2    error: {} // object of dumped errors
3}
Built with