Enrolment Flow
The enrolment process supports the following steps:
- Taking of the picture of the document (mobile and tablet only) or upload (enforced for desktop, configurable for mobile and tablet)
- Facial recognition (Optional)
- Background check (Optional)
- Lookup verification (Optional)
See diagram below:

Enrollment flow interface definition:
try {
const result = await uqudoSdk.enrollment({
sessionId?: string;
returnDataForIncompleteSession?: boolean;
// scan can be an array of objects to enroll multiple documents in the same session
scan: {
documentType: DocumentType;
disableExpiryValidation?: boolean;
forceUpload?: boolean;
enableAgeVerification?: number;
};
face?: {
enableFacialRecognition?: boolean;
enrollFace?: boolean;
maxAttempts?: number;
};
lookup?: {
enableLookup: boolean;
documentTypes: DocumentType[];
};
backgroundCheck?: {
enableBackgroundCheck?: boolean;
checkType?: BackgroundCheckType;
disableConsent?: boolean;
skipView?: boolean;
enableMonitoring?: boolean;
};
onSuccess?: (result) => {
// Result returned after a successful enrolment
console.log(result)
};
onError?: (error) => {
// Error returned from the enrolment process failure
console.log(error)
};
onFinally?: () => void;
assets?: IAssetsArg;
texts?: ITextsArg;
});
} catch (error) {
// Error catched from the enrolment process
}
Below the configuration options for enrolment:
Attribute | Description | Required |
---|---|---|
sessionId | UUID v4 that represents the session. Only used for the enrollment process.
Note: make sure to create always a new session id when you trigger the SDK flow | False (Auto generated) |
returnDataForIncompleteSession | When enabled, if the user or the SDK drops the session before completion, the SDK will return the partial data together with the OperationError object 1.8. Operation Error. Please note that you can expect some data only if the user passes at least the scanning step | No. Default false |
scan | Note: can be a single object or an array of objects to on board multiple documents in the same session | |
documentType | Document type to scan. | Yes |
disableExpiryValidation | If true accept expire document | No. Default false |
forceUpload | Force to use the upload process in any device type. By default mobile phones and tablets use the camera to take a picture | No. Default false |
enableAgeVerification | Enable age verification. If the age calculated from the document is not above or equals minAge, the scan fails showing a message to the user accordingly. Min age must be above 0 otherwise is not taken into consideration | No. Default to -1 (disabled) |
face | | |
enableFacialRecognition | Enable facial recognition | No. Default false |
enrollFace | Setting this true, will let you enroll the face so that it can be used for account recovery. More details can be found in | No. Default false |
maxAttempts | Set the max failed facial recognition attempts before dropping the session.
Note: only values between 1 and 3 are taken into consideration. | No. Default to 3 |
lookup | | |
enableLookup | Enable third party lookup (Government database). Note: this feature requires an additional permission and must be explicitly requested | No. Default false |
documentTypes | Enable third party lookup (Government database) filtered by document type. For instance, if your KYC process includes more than one document, you can decide to perform the lookup only for one single document. Note: this feature requires an additional permission and must be explicitly requested | No. Default all the documents part of the KYC |
backgroundCheck | | |
enableBackgroundCheck | Enable background check | No. Default false |
checkType | Background check type | No. Default RDC |
disableConsent | Disable the consent button. Only a continue button is shown | No. Default false |
skipView | Trigger a background check without showing any view to the user. | No. Default false |
enableMonitoring | Enable continuous monitoring. See API documentation for details. | No. Default false |
| | |
onSuccess | Callback function called after the process is done successfully. The result is a string, see "SDK result" for details | false |
onError | false | |
onFinally | Callback function called after the process is done, successfully or unsuccessfully. | false |
assets | List of assets | |
texts | List of text |
Last modified 23d ago