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:

function traceCallback(result) {
	console.log('----Trace=' + result);
};
function success(result) {
	console.log('----Result=' + result);
};
function failure(error) {
	console.log('----Result=' + JSON.parse(error));
};

...
// On App startup
cordova.plugins.UqudoIdPlugin.init(traceCallback);
...

Use the below method for setting the locale of the application:

...
cordova.plugins.UqudoIdPlugin.setLocale("<your locale eg. en, ar etc.>");
...

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

...
cordova.plugins.UqudoIdPlugin.isEnrollmentSupported(cordova.plugins.UqudoIdPlugin.DocumentType.UAE_ID, success, failure);
cordova.plugins.UqudoIdPlugin.isReadingSupported(cordova.plugins.UqudoIdPlugin.DocumentType.UAE_ID, success, failure);
cordova.plugins.UqudoIdPlugin.isFacialRecognitionSupported(cordova.plugins.UqudoIdPlugin.DocumentType.UAE_ID, success, failure);
...

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 doc = new cordova.plugins.UqudoIdPlugin.DocumentBuilder()
	.setDocumentType(cordova.plugins.UqudoIdPlugin.DocumentType.PASSPORT)
	.enableReading(new cordova.plugins.UqudoIdPlugin.ReadingConfigurationBuilder()
		.forceReadingIfSupported(true)
		.build()
	)
	.build();
var enrollObject =  new cordova.plugins.UqudoIdPlugin.EnrollmentBuilder()
	.setToken(token)
	.enableFacialRecognition(new cordova.plugins.UqudoIdPlugin.FacialRecognitionConfigurationBuilder().build())
	.setAppearanceMode(cordova.plugins.UqudoIdPlugin.AppearanceMode.SYSTEM)
	.add(doc)
	.build();
cordova.plugins.UqudoIdPlugin.enroll(enrollObject, success, failure);

In order to evaluate all the possible options please refer to paragraph Enrolment Flow. The JS interface is the porting of the JAVA one. In addition you can check UqudoIdPlugin.js inside the plugin 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:

Property	Type	Optional	Default	Description
code	String	No	None	See Handling the Result
message	String	Yes	null	Description of the error if any
task	String	Yes	null	See Handling the Result

Please refer to section Analytics for details.