Enrolment Flow

In order to use our SDK you need an authorization token. Please check our API "Authorisation" in this regard.

Add the following code at the start-up of your application to initialise the SDK:

import * as UqudoSDK from 'uqudosdk-capacitor';

//On App startup
new UqudoSDK.UqudoPlugin().init();

For setting the locale of the application you can use the below method:

new UqudoSDK.UqudoPlugin().setLocale(<your locale eg. en, ar etc.>);

To check if a document supports enrollment, reading and facial recognition and the enrollment flow you can use the below methods:

let isEnrollmentSupported = await new UqudoSDK.UqudoPlugin().isEnrollmentSupported(DocumentType.UAE_ID)
let isReadingSupported = await new UqudoSDK.UqudoPlugin().isReadingSupported(DocumentType.UAE_ID)
let isFacialRecognitionSupported = await new UqudoSDK.UqudoPlugin().isFacialRecognitionSupported(DocumentType.UAE_ID)

Below, you can find an example on how to initiate the enrolment process for a passport enabling the reading through NFC and facial recognition:

var passport = new UqudoSDK.DocumentBuilder()
			.enableReading(new UqudoSDK.ReadingConfigurationBuilder()
var enrollment = new UqudoSDK.EnrollmentBuilder()
try {
   const plugin = new UqudoSDK.UqudoPlugin();
   const result = await plugin.enroll(enrollment);
} catch (error) {
   //example: {"code":"USER_CANCEL","message":"User canceled the Enrollment process","task":"SCAN"}

In order to evaluate all the possible options please refer to paragraph Enrolment Flow. The TS interface is the porting of the JAVA one. In addition, you can check index.d.ts inside the plugin ./dist folder or directly from your IDE.

If successful, the response is a JSON Web Signature (JWS). Please refer to section "SDK result" for further details.

In case of a failure, the callback returns the following object:

Add the following code in your Javascript/Typescript to enable the tracing mechanism. Please refer to section Analytics for details.

window.addEventListener("TraceEvent", function (msg) {
     console.log("Trace Event: " + JSON.stringify(msg));

Last updated