API Reference

setActivation

+(int)setActivation:(NSString*)license;

Name	setActivation
Description	Activate SDK
Input	license (NSString*): The license string
Output	The SDK activation status code. 0: Success Non-zero: Activation failed

initSDK

+(int)initSDK;

Name	initSDK
Description	Initiate SDK
Input	None
Output	The SDK initialization status code. 0: Success -1: License Key Error -2: License AppID Error -3: License Expired -4: Activate Error -5: Initialize SDK Error

idcardRecognition

+(NSMutableDictionary*)idcardRecognition:(UIImage*)image;

Name	idcardRecognition
Description	Extract data from ID Document
Input	image (UIImage*): The input image
Output	A dictionary representing the extracted data.

Output Example for idcardRecognition

{
	"Document Number":"963545627",
	"Nationality":"USA",
	"Date of Issue":"2017-04-14",
	"Document Class Code":"P",
	"Issuing State Code":"USA",
	"Full Name":"JOHN DOE",
	"Date of Birth":"1996-03-15",
	"Sex":"M",
	"Date of Expiry":"2027-04-14",
	"Surname":"JOHN",
	"Given Names":"DOE",
	"Issuing State Name":"United States",
	"Authority":"United States,Department of State",
	"Place of Birth":"CALIFORNIA, U.S.A",
	"Document Name":"Passport",
	"Quality":99,
	"Position": {
		"x1":24,"y1":4294967295,"x2":577,"y2":381
	},
	"MRZ": {
		"Document Number":"963545637",
		"MRZ":"P<USAJOHN<<DOE<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<,9635456374USA9603150M2704140202113962<804330",
		"Document Class Code":"P",
		"Issuing State Code":"USA",
		"Full Name":"JOHN DOE",
		"Nationality Code":"USA",
		"Date of Birth":"1996-03-15",
		"Sex":"M",
		"Date of Expiry":"2027-04-14",
		"Surname":"JOHN",
		"Given Names":"DOE",
		"Issuing State Name":"United States",
		"MRZ Type":"ID-3",
		"Validation":1
	},
	"Images":{
		"Portrait":"/9j/4AAQSkZJRgABAQEAxwDH....KUr2P//Z",
		"Document":"/9j/4AAQSkZJRgABAQEAxwDH....o/Dd8yZC"
	}
}