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;
          maxAttempts?: number;
          minimumMatchLevel?: number;
          enableOneToNVerification?: boolean;
	};
      	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)
	};
	onTrace?: (trace) => {
	  // trace events
	  console.log(trace)
	};
	onFinally?: () => void;
	assets?: IAssetsArg;
	texts?: ITextsArg;
  });

} catch (error) {
// Error catched from the enrolment process
}

Below the configuration options for enrolment:

PreviousCORS NextFace Session Flow

Last updated 3 months ago