Documentation

DocDetail

DocDetail

Field

Description

ocrResult

string, PASS or FAIL

docFrontImage

string, The front image of the document.

When returnImageType is URL, this value is a link that will be expired in 1 day; if the link is expired ,you need to re query this endpoint to get a new link.

When returnImageType is Base64, this value is a Base64 encoded string of image bytes.

Always return null when solutionCode in ["05"]. (no need to return because the images are originally provided by caller")

docBackImage

string,
The back image of the document ( only if the document has two sides).

When returnImageType is URL, this value is a link that will be expired in 1 day; if the link is expired ,you need to re query this endpoint to get a new link.

When returnImageType is Base64, this value is a Base64 encoded string of image bytes.

Always return null when solutionCode in ["05"]. (no need to return because the images are originally provided by caller")

docType

object,The document type of the user provided (recognized from the document picture ,not the docType provide when generateUrl).

subDocType

object,The sub document type of the user provided(recognized from the document picture ,not the docType provide when generateUrl).It is the same as docType,except PH-ID-NATIONAL_ID,PH-ID-E_NATIONAL_ID-V1,PH-ID-E_NATIONAL_ID-V2.

ocrInfo

object, the ocr result of the document images.

qualityLabels

object, the image quality assessment result of the document images.

forgeryLabels

list, the reasons why the front image of the document is considered forgery.

eventDetails

array, Event details.

docTypeDetails

object,The document type details recognized from the document pictures.

ocrResult

ValueDescription
PASSocr succeeded for all images.
FAILocr failed ( ocr failed for at least one image)

docType

ValueDescription
frontThe front doc type.
backThe back doc type.

examples:

{
  "front": "PH-ID-UMID",
  "back": null
}

refer toSupported Regions & DocTypes

subDocType

ValueDescription
frontThe front sub doc type.
backThe back sub doc type.

examples:

{
  "front": "PH-ID-E_NATIONAL_ID-V1",
  "back": "PH-ID-E_NATIONAL_ID-V1"
}

ocrInfo

Field

Description

front

object, OCR result of the document front image. empty if the document front image quality is good.

back

object, OCR result of the document back image. null if the document is not two-side. empty if the document front image quality is good.

mrz

object, OCR result of the Passport MRZ (machine-readable zone) when the docType is passport. need to enable document.ocr.passportMRZ first. Refer to mrz

mrzCheck

object, the comparision result between OCR results of front and mrz when the docType is passport. need to enable document.ocr.passportMRZ first. Refer to mrzCheck

mrz

FieldDescription
issueCountryString, Issuing country or organization. Refer to ISO ALPHA-3 Country Code
passportTypeString, Passport type (for countries that distinguish between different types of passports)
firstNameString, First name of the person
lastNameString, Last name of the person
fullNameString, Full name of the person
idNumberString,Personal number (may be used by the issuing country as it desires)
birthdayString,Birthday of the person(YYYY/MM/DD)
nationalityString,Nationality of the person. Refer to ISO ALPHA-3 Country Code
genderString, Gender of the person. F: female; M: male.
expiryDateString, Expiration date of passport(YYYY/MM/DD)
documentNumberString,Passport number

mrzCheck

FieldDescription
issueCountryString, pass when the issueCountry in front and mrz are equals else fail.
passportTypeString, pass when the passportType in front and mrz are equals else fail.
firstNameString, pass when the firstName in front and mrz are equals else fail.
lastNameString, pass when the lastName in front and mrz are equals else fail.
fullNameString, pass when the fullName in front and mrz are equals else fail.
idNumberString,pass when the idNumber in front and mrz are equals else fail.
birthdayString,pass when the birthday in front and mrz are equals else fail.
nationalityString,pass when the nationality in front and mrz are equals elsefail.
genderString, pass when the gender in frontandmrz are equals elsefail.
expiryDateString, passwhen the expiryDate infrontandmrz are equals elsefail.

Examples

General

{
  "front": {
    "idNumber": "871125523500",
    "documentNumber": null,
    "fullName": "LEE SHI YIN",
    "fullNameLocal": null,
    "lastName": null,
    "lastNameLocal": null,
    "firstName": null,
    "firstNameLocal": null,
    "middleName": null,
    "middleNameLocal": null,
    "birthday": "1987/11/25",
    "dobDay": null,
    "dobMonth": null,
    "dobYear": null,
    "expiryDate": null,
    "expiryDay": null,
    "expiryMonth": null,
    "expiryYear": null,
    "daysToExpiry": null,
    "issueDate": null,
    "issueDay": null,
    "issueMonth": null,
    "issueYear": null,
    "daysFromIssue": null,
    "state": null,
    "city": null,
    "district": null,
    "subdistrict": null,
    "fullAddress": "NO 26 JALAN DUTA 3/5 TAMAN",
    "postcode": null,
    "placeOfBirth": null,
    "issuerAuthority": null,
    "issuerPlace": null,
    "gender": "FEMALE",
    "height": null,
    "weight": null,
    "eyeColor": null,
    "bloodType": null,
    "religion": "",
    "nationality": null,
    "issuerCountry": null,
    "countryCode": null,
    "passportType": null,
    "vehicleClass": null,
    "restrictions": null,
    "endorsement": null,
    "others": {},
    "side": "front",
    "genderLocal": "PEREMPUAN",
    "nationalityLocal": null
  },
  "back": {
    "idNumber": null,
    "documentNumber": "8711567840000301",
    "fullName": null,
    "fullNameLocal": null,
    "lastName": null,
    "lastNameLocal": null,
    "firstName": null,
    "firstNameLocal": null,
    "middleName": null,
    "middleNameLocal": null,
    "birthday": null,
    "dobDay": null,
    "dobMonth": null,
    "dobYear": null,
    "expiryDate": null,
    "expiryDay": null,
    "expiryMonth": null,
    "expiryYear": null,
    "daysToExpiry": null,
    "issueDate": null,
    "issueDay": null,
    "issueMonth": null,
    "issueYear": null,
    "daysFromIssue": null,
    "state": null,
    "city": null,
    "district": null,
    "subdistrict": null,
    "fullAddress": null,
    "postcode": null,
    "placeOfBirth": null,
    "issuerAuthority": null,
    "issuerPlace": null,
    "gender": null,
    "height": null,
    "weight": null,
    "eyeColor": null,
    "bloodType": null,
    "religion": null,
    "nationality": null,
    "issuerCountry": null,
    "countryCode": null,
    "passportType": null,
    "vehicleClass": null,
    "restrictions": null,
    "endorsement": null,
    "side": "back",
    "others": {},
    "genderLocal": "PEREMPUAN",
    "nationalityLocal": null
  },
  "mrz": null,
  "mrzCheck": null
}
{
  "front": {
    "idNumber": "E********0",
    "documentNumber": null,
    "fullName": "P******************O",
    "fullNameLocal": null,
    "lastName": "L******O",
    "lastNameLocal": null,
    "firstName": "P**********E",
    "firstNameLocal": null,
    "middleName": "M********O",
    "middleNameLocal": null,
    "birthday": "1990/12/15",
    "dobDay": null,
    "dobMonth": null,
    "dobYear": null,
    "expiryDate": "2019/02/26",
    "expiryDay": null,
    "expiryMonth": null,
    "expiryYear": null,
    "daysToExpiry": null,
    "issueDate": "2014/02/27",
    "issueDay": null,
    "issueMonth": null,
    "issueYear": null,
    "daysFromIssue": null,
    "state": null,
    "city": null,
    "district": null,
    "subdistrict": null,
    "fullAddress": null,
    "postcode": null,
    "placeOfBirth": "MAKATI MM",
    "issuerAuthority": "DFA MANILA",
    "issuerPlace": null,
    "gender": "FEMALE",
    "height": null,
    "weight": null,
    "eyeColor": null,
    "bloodType": null,
    "religion": null,
    "nationality": "PHL",
    "issuerCountry": null,
    "countryCode": "PHL",
    "passportType": "P",
    "vehicleClass": null,
    "restrictions": null,
    "endorsement": null,
    "others": {
      "cardType": "PASSPORT"
    },
    "side": "front",
    "nationalityLocal": "FILIPINO",
    "genderLocal": "F"
  },
  "back": null,
  "mrz": {
    "issuerCountry": "PHL",
    "passportType": "P",
    "firstName": "****** ******",
    "lastName": "******",
    "fullName": "******",
    "idNumber": "******",
    "birthday": "1990/12/15",
    "nationality": "PHL",
    "gender": "F",
    "expiryDate": "2019/02/26",
    "documentNumber": ""
  },
  "mrzCheck": {
    "idNumber": "pass",
    "passportType": "pass",
    "firstName": "fail",
    "lastName": "pass",
    "fullName": "pass",
    "birthday": "pass",
    "nationality": "pass",
    "gender": "pass",
    "expiryDate": "pass"
  }
}

Malaysia

{
	"front": {
		"idNumber": "87********00",
		"documentNumber": null,
		"fullName": "L*********N",
		"fullNameLocal": null,
		"lastName": null,
		"lastNameLocal": null,
		"firstName": null,
		"firstNameLocal": null,
		"middleName": null,
		"middleNameLocal": null,
		"birthday": "1987/11/25",
		"dobDay": null,
		"dobMonth": null,
		"dobYear": null,
		"expiryDate": null,
		"expiryDay": null,
		"expiryMonth": null,
		"expiryYear": null,
		"daysToExpiry": null,
		"issueDate": null,
		"issueDay": null,
		"issueMonth": null,
		"issueYear": null,
		"daysFromIssue": null,
		"state": null,
		"city": null,
		"district": null,
		"subdistrict": null,
		"fullAddress": "NO 26*******************************JOHOR",
		"postcode": null,
		"placeOfBirth": null,
		"issuerAuthority": null,
		"issuerPlace": null,
		"gender": "FEMALE",
		"height": null,
		"weight": null,
		"eyeColor": null,
		"bloodType": null,
		"religion": "ISLAM",
		"nationality": "MYS",
		"issuerCountry": null,
		"countryCode": null,
		"passportType": null,
		"vehicleClass": null,
		"restrictions": null,
		"endorsement": null,
		"others": {
			"cardType":"MY-ID-MYKAD"
		},
		"side": "front",
		"nationalityLocal": null,
		"genderLocal": "PEREMPUAN"
	},
	"back": {
		"idNumber": null,
		"documentNumber": "8**************1",
		"fullName": null,
		"fullNameLocal": null,
		"lastName": null,
		"lastNameLocal": null,
		"firstName": null,
		"firstNameLocal": null,
		"middleName": null,
		"middleNameLocal": null,
		"birthday": null,
		"dobDay": null,
		"dobMonth": null,
		"dobYear": null,
		"expiryDate": null,
		"expiryDay": null,
		"expiryMonth": null,
		"expiryYear": null,
		"daysToExpiry": null,
		"issueDate": null,
		"issueDay": null,
		"issueMonth": null,
		"issueYear": null,
		"daysFromIssue": null,
		"state": null,
		"city": null,
		"district": null,
		"subdistrict": null,
		"fullAddress": null,
		"postcode": null,
		"placeOfBirth": null,
		"issuerAuthority": null,
		"issuerPlace": null,
		"gender": null,
		"height": null,
		"weight": null,
		"eyeColor": null,
		"bloodType": null,
		"religion": null,
		"nationality": null,
		"issuerCountry": null,
		"countryCode": null,
		"passportType": null,
		"vehicleClass": null,
		"restrictions": null,
		"endorsement": null,
		"others": {
			"cardType":"MY-ID-MYKAD"
		},
		"side": "back",
		"nationalityLocal": null,
		"genderLocal": null
	}
}
{
  "front": {
    "side": "front",
    "idNumber": "8812**-**-5288",
    "documentNumber": null,
    "fullName": "NAI** BIN** NAH***",
    "fullNameLocal": null,
    "lastName": "NAH***",
    "lastNameLocal": null,
    "firstName": "NAI** BIN**",
    "firstNameLocal": null,
    "middleName": null,
    "middleNameLocal": null,
    "birthday": "1988/12/**",
    "dobDay": "**",
    "dobMonth": "12",
    "dobYear": "1988",
    "expiryDate": null,
    "expiryDay": null,
    "expiryMonth": null,
    "expiryYear": null,
    "daysToExpiry": null,
    "issueDate": null,
    "issueDay": null,
    "issueMonth": null,
    "issueYear": null,
    "daysFromIssue": null,
    "state": null,
    "city": null,
    "district": null,
    "subdistrict": null,
    "postcode": "891**",
    "placeOfBirth": "12",
    "issuerAuthority": null,
    "issuerPlace": null,
    "gender": "FEMALE",
    "height": null,
    "weight": null,
    "eyeColor": null,
    "bloodType": null,
    "religion": null,
    "nationality": "PHL",
    "issuerCountry": "Malaysia",
    "countryCode": "MY",
    "passportType": null,
    "vehicleClass": null,
    "restrictions": null,
    "endorsement": null,
    "others": {
      "optionalData1": null,
      "optionalData2": null
    },
    "internalId": "7**",
    "fullAddress": "891**",
    "nationalityLocal": "PHL",
    "genderLocal": "F"
  },
  "back": {
    "side": "back",
    "idNumber": "8812**-**-5288-01",
    "documentNumber": null,
    "fullName": null,
    "fullNameLocal": null,
    "lastName": null,
    "lastNameLocal": null,
    "firstName": null,
    "firstNameLocal": null,
    "middleName": null,
    "middleNameLocal": null,
    "birthday": "1988/12/**",
    "dobDay": "**",
    "dobMonth": "12",
    "dobYear": "1988",
    "expiryDate": null,
    "expiryDay": null,
    "expiryMonth": null,
    "expiryYear": null,
    "daysToExpiry": null,
    "issueDate": null,
    "issueDay": null,
    "issueMonth": null,
    "issueYear": null,
    "daysFromIssue": null,
    "state": null,
    "city": null,
    "district": null,
    "subdistrict": null,
    "postcode": null,
    "placeOfBirth": "12",
    "issuerAuthority": null,
    "issuerPlace": null,
    "gender": null,
    "height": null,
    "weight": null,
    "eyeColor": null,
    "bloodType": null,
    "religion": null,
    "nationality": "MYS",
    "issuerCountry": "Malaysia",
    "countryCode": "MY",
    "passportType": null,
    "vehicleClass": null,
    "restrictions": null,
    "endorsement": null,
    "others": {
      "optionalData1": "A000**25583",
      "optionalData2": "INDONESIA"
    },
    "internalId": "7**",
    "fullAddress": null,
    "nationalityLocal": "MYS",
    "genderLocal": null
  }
}
{
  "front": {
    "side": "front",
    "idNumber": null,
    "documentNumber": null,
    "fullName": "******* **** ****",
    "fullNameLocal": null,
    "lastName": "****",
    "lastNameLocal": null,
    "firstName": "*******",
    "firstNameLocal": null,
    "middleName": "****",
    "middleNameLocal": null,
    "birthday": null,
    "dobDay": null,
    "dobMonth": null,
    "dobYear": null,
    "expiryDate": "2024/**/**",
    "expiryDay": "**",
    "expiryMonth": "*",
    "expiryYear": "2024",
    "daysToExpiry": "-213",
    "issueDate": "2023/**/**",
    "issueDay": "**",
    "issueMonth": "*",
    "issueYear": "2023",
    "daysFromIssue": "658",
    "state": null,
    "city": null,
    "district": null,
    "subdistrict": null,
    "postcode": "*****",
    "placeOfBirth": null,
    "issuerAuthority": null,
    "issuerPlace": null,
    "gender": null,
    "height": null,
    "weight": null,
    "eyeColor": null,
    "bloodType": null,
    "religion": null,
    "nationality": null,
    "issuerCountry": "Malaysia",
    "countryCode": "MY",
    "passportType": null,
    "vehicleClass": null,
    "restrictions": null,
    "endorsement": null,
    "others": {
      "optionalData1": null,
      "optionalData2": null
    },
    "internalId": "***",
    "fullAddress": "*****",
    "nationalityLocal": "MYS",
    "genderLocal": null
  },
  "back": null
}
{
  "front": {
    "side": "biodata",
    "idNumber": "*********",
    "documentNumber": "************",
    "fullName": "**** *** *****",
    "fullNameLocal": null,
    "lastName": "*****",
    "lastNameLocal": null,
    "firstName": "****",
    "firstNameLocal": null,
    "middleName": "***",
    "middleNameLocal": null,
    "birthday": "1995/**/**",
    "dobDay": "**",
    "dobMonth": "*",
    "dobYear": "1995",
    "expiryDate": "2026/**/**",
    "expiryDay": "**",
    "expiryMonth": "**",
    "expiryYear": "2026",
    "daysToExpiry": "638",
    "issueDate": "2021/**/**",
    "issueDay": "**",
    "issueMonth": "**",
    "issueYear": "2021",
    "daysFromIssue": "1188",
    "state": null,
    "city": null,
    "district": null,
    "subdistrict": null,
    "postcode": null,
    "placeOfBirth": "** ***** ******",
    "issuerAuthority": "****** ****",
    "issuerPlace": null,
    "gender": "MALE",
    "height": "*** cm",
    "weight": null,
    "eyeColor": null,
    "bloodType": null,
    "religion": null,
    "nationality": "MYS",
    "issuerCountry": "Malaysia",
    "countryCode": "MY",
    "passportType": null,
    "vehicleClass": null,
    "restrictions": null,
    "endorsement": null,
    "others": {
      "optionalData1": null,
      "optionalData2": null
    },
    "fullAddress": null,
    "nationalityLocal": "Malaysia",
    "genderLocal": "M"
  },
  "back": null
}

Philippines

{
	"front": {
		"idNumber": "477-***-***-***",
		"documentNumber": "",
		"fullName": "PUYAT,******* *******",
		"fullNameLocal": null,
		"lastName": null,
		"lastNameLocal": null,
		"firstName": null,
		"firstNameLocal": null,
		"middleName": null,
		"middleNameLocal": null,
		"birthday": "1994/04/27",
		"dobDay": null,
		"dobMonth": null,
		"dobYear": null,
		"expiryDate": null,
		"expiryDay": null,
		"expiryMonth": null,
		"expiryYear": null,
		"daysToExpiry": null,
		"issueDate": "2020/06/02",
		"issueDay": null,
		"issueMonth": null,
		"issueYear": null,
		"daysFromIssue": null,
		"state": null,
		"city": null,
		"district": null,
		"subdistrict": null,
		"fullAddress": "BLOCK 3 LOT ********************** BACOOR ******",
		"postcode": null,
		"placeOfBirth": null,
		"issuerAuthority": "",
		"issuerPlace": null,
		"gender": null,
		"height": null,
		"weight": null,
		"eyeColor": null,
		"bloodType": null,
		"religion": null,
		"nationality": null,
		"issuerCountry": null,
		"countryCode": null,
		"passportType": null,
		"vehicleClass": null,
		"restrictions": null,
		"endorsement": null,
		"others": {
			"cardType": "TIN"
		},
		"side": "front",
		"nationalityLocal": null,
		"genderLocal": null
	},
	"back": null
}
{
	"front": {
		"idNumber": "C02-18-******",
		"documentNumber": null,
		"fullName": "MORALES, CECILIA CERVANTES",
		"fullNameLocal": null,
		"lastName": null,
		"lastNameLocal": null,
		"firstName": null,
		"firstNameLocal": null,
		"middleName": null,
		"middleNameLocal": null,
		"birthday": "1978/11/29",
		"dobDay": null,
		"dobMonth": null,
		"dobYear": null,
		"expiryDate": "2022/11/29",
		"expiryDay": null,
		"expiryMonth": null,
		"expiryYear": null,
		"daysToExpiry": null,
		"issueDate": null,
		"issueDay": null,
		"issueMonth": null,
		"issueYear": null,
		"daysFromIssue": null,
		"state": null,
		"city": null,
		"district": null,
		"subdistrict": null,
		"fullAddress": "128 ****** ST. *****, ******, ****",
		"postcode": null,
		"placeOfBirth": null,
		"issuerAuthority": null,
		"issuerPlace": null,
		"gender": "FEMALE",
		"height": "1.55",
		"weight": "49",
		"eyeColor": "BLACK",
		"bloodType": "A+",
		"religion": null,
		"nationality": "PHL",
		"issuerCountry": null,
		"countryCode": null,
		"passportType": null,
		"vehicleClass": null,
		"restrictions": "1,2",
		"endorsement": null,
		"others": {
			"agencyCode": "BLC",
			"conditions": "NONE",
			"assistantSecretary": "EDGAR C. GALVANTE",
			"cardType": "DRIVING_LICENSE"
		},
		"side": "front",
		"nationalityLocal": "PHL",
		"genderLocal": "F"
	},
	"back": null
}
{
	"front": {
		"idNumber": "4376-****-****-****",
		"documentNumber": null,
		"fullName": "MONINA ****** ******",
		"fullNameLocal": null,
		"lastName": "******",
		"lastNameLocal": null,
		"firstName": "MON***",
		"firstNameLocal": null,
		"middleName": "******",
		"middleNameLocal": null,
		"birthday": "1969/02/02",
		"dobDay": null,
		"dobMonth": null,
		"dobYear": null,
		"expiryDate": null,
		"expiryDay": null,
		"expiryMonth": null,
		"expiryYear": null,
		"daysToExpiry": null,
		"issueDate": null,
		"issueDay": null,
		"issueMonth": null,
		"issueYear": null,
		"daysFromIssue": null,
		"state": null,
		"city": null,
		"district": null,
		"subdistrict": null,
		"fullAddress": "1411 *********************CITY OF TACLOBAN,LEYTE",
		"postcode": null,
		"placeOfBirth": null,
		"issuerAuthority": null,
		"issuerPlace": null,
		"gender": null,
		"height": null,
		"weight": null,
		"eyeColor": null,
		"bloodType": null,
		"religion": null,
		"nationality": null,
		"issuerCountry": null,
		"countryCode": null,
		"passportType": null,
		"vehicleClass": null,
		"restrictions": null,
		"endorsement": null,
		"others": {
			"cardType": "NATIONALID"
		},
		"side": "front",
		"nationalityLocal": null,
		"genderLocal": null
	},
	"back": {
		"side": "back",
		"idNumber": null,
		"documentNumber": null,
		"fullName": null,
		"fullNameLocal": null,
		"lastName": null,
		"lastNameLocal": null,
		"firstName": null,
		"firstNameLocal": null,
		"middleName": null,
		"middleNameLocal": null,
		"birthday": null,
		"dobDay": null,
		"dobMonth": null,
		"dobYear": null,
		"expiryDate": null,
		"expiryDay": null,
		"expiryMonth": null,
		"expiryYear": null,
		"daysToExpiry": null,
		"issueDate": "2019/06/14",
		"issueDay": "14",
		"issueMonth": "6",
		"issueYear": "2019",
		"daysFromIssue": "1915",
		"state": null,
		"city": null,
		"district": null,
		"subdistrict": null,
		"postcode": null,
		"placeOfBirth": "QUEZON CITY, METRO MANILA",
		"issuerAuthority": null,
		"issuerPlace": null,
		"gender": "MALE",
		"height": null,
		"weight": null,
		"eyeColor": null,
		"bloodType": "0",
		"religion": null,
		"nationality": "PHL",
		"issuerCountry": "Philippines",
		"countryCode": "PH",
		"passportType": null,
		"vehicleClass": null,
		"restrictions": null,
		"endorsement": null,
		"others": {
			"optionalData1": null,
			"optionalData2": null,
			"cardType": "ID_CARD"
		},
		"fullAddress": null,
		"nationalityLocal": "Philippines",
		"genderLocal": "M"
	}
}
{
	"front": {
		"idNumber": "0*****3",
		"documentNumber": null,
		"fullName": null,
		"fullNameLocal": null,
		"lastName": "A******N",
		"lastNameLocal": null,
		"firstName": "A******E",
		"firstNameLocal": null,
		"middleName": "R*****A",
		"middleNameLocal": null,
		"birthday": null,
		"dobDay": null,
		"dobMonth": null,
		"dobYear": null,
		"expiryDate": "2022/11/03",
		"expiryDay": null,
		"expiryMonth": null,
		"expiryYear": null,
		"daysToExpiry": null,
		"issueDate": "2016/04/04",
		"issueDay": null,
		"issueMonth": null,
		"issueYear": null,
		"daysFromIssue": null,
		"state": null,
		"city": null,
		"district": null,
		"subdistrict": null,
		"fullAddress": null,
		"postcode": null,
		"placeOfBirth": null,
		"issuerAuthority": null,
		"issuerPlace": null,
		"gender": null,
		"height": null,
		"weight": null,
		"eyeColor": null,
		"bloodType": null,
		"religion": null,
		"nationality": null,
		"issuerCountry": null,
		"countryCode": null,
		"passportType": null,
		"vehicleClass": null,
		"restrictions": null,
		"endorsement": null,
		"others": {
			"occupation": "MEDICAL TECHNOLOGIST",
			"cardType": "PRC"
		},
		"side": "front",
		"nationalityLocal": null,
		"genderLocal": null
	},
	"back": null
}
{
	"front": {
		"idNumber": "E********0",
		"documentNumber": null,
		"fullName": "P******************O",
		"fullNameLocal": null,
		"lastName": "L******O",
		"lastNameLocal": null,
		"firstName": "P**********E",
		"firstNameLocal": null,
		"middleName": "M********O",
		"middleNameLocal": null,
		"birthday": "1990/12/15",
		"dobDay": null,
		"dobMonth": null,
		"dobYear": null,
		"expiryDate": "2019/02/26",
		"expiryDay": null,
		"expiryMonth": null,
		"expiryYear": null,
		"daysToExpiry": null,
		"issueDate": "2014/02/27",
		"issueDay": null,
		"issueMonth": null,
		"issueYear": null,
		"daysFromIssue": null,
		"state": null,
		"city": null,
		"district": null,
		"subdistrict": null,
		"fullAddress": null,
		"postcode": null,
		"placeOfBirth": "MAKATI MM",
		"issuerAuthority": "DFA MANILA",
		"issuerPlace": null,
		"gender": "FEMALE",
		"height": null,
		"weight": null,
		"eyeColor": null,
		"bloodType": null,
		"religion": null,
		"nationality": "PHL",
		"issuerCountry": null,
		"countryCode": "PHL",
		"passportType": "P",
		"vehicleClass": null,
		"restrictions": null,
		"endorsement": null,
		"others": {
			"cardType": "PASSPORT"
		},
		"side": "front",
		"nationalityLocal": "FILIPINO",
		"genderLocal": "F"
	},
	"back": null
}
{
	"front": {
		"idNumber": "N**********8",
		"documentNumber": null,
		"fullName": "R*******A",
		"fullNameLocal": null,
		"lastName": null,
		"lastNameLocal": null,
		"firstName": null,
		"firstNameLocal": null,
		"middleName": null,
		"middleNameLocal": null,
		"birthday": "1999/02/08",
		"dobDay": null,
		"dobMonth": null,
		"dobYear": null,
		"expiryDate": "2020/06/30",
		"expiryDay": null,
		"expiryMonth": null,
		"expiryYear": null,
		"daysToExpiry": null,
		"issueDate": null,
		"issueDay": null,
		"issueMonth": null,
		"issueYear": null,
		"daysFromIssue": null,
		"state": null,
		"city": null,
		"district": null,
		"subdistrict": null,
		"fullAddress": "B***************************R",
		"postcode": null,
		"placeOfBirth": null,
		"issuerAuthority": "RLP.LP",
		"issuerPlace": null,
		"gender": null,
		"height": null,
		"weight": null,
		"eyeColor": null,
		"bloodType": null,
		"religion": null,
		"nationality": "PHL",
		"issuerCountry": null,
		"countryCode": null,
		"passportType": null,
		"vehicleClass": null,
		"restrictions": null,
		"endorsement": null,
		"others": {
			"cardType": "POSTALID"
		},
		"side": "front",
		"nationalityLocal": "PHL",
		"genderLocal": null
	},
	"back": null
}
{
	"front": {
		"idNumber": "09-*******-1",
		"documentNumber": null,
		"fullName": "R***************O",
		"fullNameLocal": null,
		"lastName": null,
		"lastNameLocal": null,
		"firstName": null,
		"firstNameLocal": null,
		"middleName": null,
		"middleNameLocal": null,
		"birthday": "1977/10/28",
		"dobDay": null,
		"dobMonth": null,
		"dobYear": null,
		"expiryDate": null,
		"expiryDay": null,
		"expiryMonth": null,
		"expiryYear": null,
		"daysToExpiry": null,
		"issueDate": null,
		"issueDay": null,
		"issueMonth": null,
		"issueYear": null,
		"daysFromIssue": null,
		"state": null,
		"city": null,
		"district": null,
		"subdistrict": null,
		"fullAddress": null,
		"postcode": null,
		"placeOfBirth": null,
		"issuerAuthority": null,
		"issuerPlace": null,
		"gender": null,
		"height": null,
		"weight": null,
		"eyeColor": null,
		"bloodType": null,
		"religion": null,
		"nationality": null,
		"issuerCountry": null,
		"countryCode": null,
		"passportType": null,
		"vehicleClass": null,
		"restrictions": null,
		"endorsement": null,
		"others": {
			"cardType": "SSS"
		},
		"side": "front",
		"nationalityLocal": null,
		"genderLocal": null
	},
	"back": null
}
{
	"front": {
		"idNumber": "0111-*******-2",
		"documentNumber": null,
		"fullName": null,
		"fullNameLocal": null,
		"lastName": "MACASERO",
		"lastNameLocal": null,
		"firstName": "*******",
		"firstNameLocal": null,
		"middleName": "E********A",
		"middleNameLocal": null,
		"birthday": "1987/11/08",
		"dobDay": null,
		"dobMonth": null,
		"dobYear": null,
		"expiryDate": null,
		"expiryDay": null,
		"expiryMonth": null,
		"expiryYear": null,
		"daysToExpiry": null,
		"issueDate": null,
		"issueDay": null,
		"issueMonth": null,
		"issueYear": null,
		"daysFromIssue": null,
		"state": "LAGUNA",
		"city": "SANTA ROSA",
		"district": null,
		"subdistrict": null,
		"fullAddress": "BL*************************************************************6",
		"postcode": "4026",
		"placeOfBirth": null,
		"issuerAuthority": null,
		"issuerPlace": null,
		"gender": "FEMALE",
		"height": null,
		"weight": null,
		"eyeColor": null,
		"bloodType": null,
		"religion": null,
		"nationality": null,
		"issuerCountry": null,
		"countryCode": null,
		"passportType": null,
		"vehicleClass": null,
		"restrictions": null,
		"endorsement": null,
		"others": {
			"homeAddress": "B*********************************************A",
			"ph": "PHL",
			"cardType": "UMID"
		},
		"side": "front",
		"nationalityLocal": null,
		"genderLocal": "F"
	},
	"back": null
}

Thailand

{
  "front": {
    "idNumber": "1********6884",
    "documentNumber": "1035-**-******26",
    "fullName": "Mr. **** Ratt*****iput",
    "fullNameLocal": "นาย **********งวิพุธ",
    "lastName": "Ratt*******put",
    "lastNameLocal": null,
    "firstName": "Mr. P******t",
    "firstNameLocal": null,
    "middleName": null,
    "middleNameLocal": null,
    "birthday": "2003/11/04",
    "dobDay": null,
    "dobMonth": null,
    "dobYear": null,
    "expiryDate": "2027/11/03",
    "expiryDay": null,
    "expiryMonth": null,
    "expiryYear": null,
    "daysToExpiry": null,
    "issueDate": "2018/11/05",
    "issueDay": null,
    "issueMonth": null,
    "issueYear": null,
    "daysFromIssue": null,
    "state": "กรุงเทพมหานคร",
    "city": null,
    "district": "เขตจอมทอง",
    "subdistrict": "แขวงบางค้อ",
    "fullAddress": "ที่อยู่ *************************ทพมหานคร",
    "postcode": null,
    "placeOfBirth": null,
    "issuerAuthority": null,
    "issuerPlace": null,
    "gender": null,
    "height": null,
    "weight": null,
    "eyeColor": null,
    "bloodType": null,
    "religion": "พุทธ",
    "nationality": null,
    "issuerCountry": null,
    "countryCode": null,
    "passportType": null,
    "vehicleClass": null,
    "restrictions": null,
    "endorsement": null,
    "mrz": null,
    "others": {
      "typeEN": "Thai National ID Card",
      "typeTH": "บัตรประจำตัวประชาชน",
      "birthdayTH": "4 พ.ย. 2546",
      "issueDateTH": "5 พ.ย. 2561",
      "expiryDateTH": "3 พ.ย. 2570",
      "issuingOfficerTH": "อาทิตย์ บุญญะโสภัต",
      "homeAddressTH": "ที่อยู่*************",
      "addressOthersTH": ""
    },
    "side": "front",
    "nationalityLocal": null,
    "genderLocal": null
  },
  "back": {
    "idNumber": null,
    "documentNumber": "AA0-*******-00",
    "fullName": null,
    "fullNameLocal": null,
    "lastName": null,
    "lastNameLocal": null,
    "firstName": null,
    "firstNameLocal": null,
    "middleName": null,
    "middleNameLocal": null,
    "birthday": null,
    "dobDay": null,
    "dobMonth": null,
    "dobYear": null,
    "expiryDate": null,
    "expiryDay": null,
    "expiryMonth": null,
    "expiryYear": null,
    "daysToExpiry": null,
    "issueDate": null,
    "issueDay": null,
    "issueMonth": null,
    "issueYear": null,
    "daysFromIssue": null,
    "state": null,
    "city": null,
    "district": null,
    "subdistrict": null,
    "fullAddress": null,
    "postcode": null,
    "placeOfBirth": null,
    "issuerAuthority": null,
    "issuerPlace": null,
    "gender": null,
    "height": null,
    "weight": null,
    "eyeColor": null,
    "bloodType": null,
    "religion": null,
    "nationality": null,
    "issuerCountry": null,
    "countryCode": null,
    "passportType": null,
    "vehicleClass": null,
    "restrictions": null,
    "endorsement": null,
    "others": {},
    "side": "back",
    "nationalityLocal": null,
    "genderLocal": null
  }
}
{
  "front":
  {
	"idNumber": "13********40",
	"expiryDate": "2032/07/13",
	"issueDate": "2022/07/14",
	"mrz": "P<THALEELAD<<WIPHAWADEE<<<<<<<<<<<<<<<<<<<<<A*********************0<14",
	"fullName": "WIPHAWADEE LEELAD",
	"fullNameLocal": "วิ*********ด",
	"firstName": "W********E",
	"lastName": "L********D",
	"gender": "F",
	"birthday": "2002/05/12",
	"placeOfBirth": "SI SA KET",
	"nationality": "THAI"
},
  "back":null
}
{
  "front": {
    "side": "front",
    "idNumber": "6******3",
    "documentNumber": "3 **** *** ** ** 2",
    "fullName": "K**************E",
    "fullNameLocal": "กิ*********ณี",
    "lastName": "S*********E",
    "lastNameLocal": null,
    "firstName": "K*********N",
    "firstNameLocal": null,
    "middleName": null,
    "middleNameLocal": null,
    "birthday": "1980/09/01",
    "dobDay": "1",
    "dobMonth": "9",
    "dobYear": "1980",
    "expiryDate": "2027/09/01",
    "expiryDay": "1",
    "expiryMonth": "9",
    "expiryYear": "2027",
    "daysToExpiry": "1043",
    "issueDate": "2010/06/04",
    "issueDay": "4",
    "issueMonth": "6",
    "issueYear": "2010",
    "daysFromIssue": "5255",
    "state": null,
    "city": null,
    "district": null,
    "subdistrict": null,
    "postcode": null,
    "placeOfBirth": null,
    "issuerAuthority": null,
    "issuerPlace": null,
    "gender": null,
    "height": null,
    "weight": null,
    "eyeColor": null,
    "bloodType": null,
    "religion": null,
    "nationality": "THA",
    "issuerCountry": "Thailand",
    "countryCode": "TH",
    "passportType": null,
    "vehicleClass": null,
    "restrictions": null,
    "endorsement": null,
    "others": {
      "optionalData1": null,
      "optionalData2": null
    },
    "fullAddress": null,
    "nationalityLocal": "Thailand",
    "genderLocal": null
  },
  "back": null
}

Indonesia

{
  "front": {
    "idNumber": "3************007",
    "documentNumber": null,
    "fullName": null,
    "fullNameLocal": null,
    "lastName": null,
    "lastNameLocal": null,
    "firstName": null,
    "firstNameLocal": null,
    "middleName": null,
    "middleNameLocal": null,
    "birthday": null,
    "dobDay": null,
    "dobMonth": null,
    "dobYear": null,
    "expiryDate": "SEUMUR HIDUP",
    "expiryDay": null,
    "expiryMonth": null,
    "expiryYear": null,
    "daysToExpiry": null,
    "issueDate": null,
    "issueDay": null,
    "issueMonth": null,
    "issueYear": null,
    "daysFromIssue": null,
    "state": "JAWA BARAT",
    "city": "KABUPATEN BEKASI",
    "district": "TAMBUN SELATAN",
    "subdistrict": "SETIAMEKAR",
    "fullAddress": "BE*********************15",
    "postcode": null,
    "placeOfBirth": null,
    "issuerAuthority": null,
    "issuerPlace": null,
    "gender": "FEMALE",
    "height": null,
    "weight": null,
    "eyeColor": null,
    "bloodType": null,
    "religion": "ISLAM",
    "nationality": "IDN",
    "issuerCountry": null,
    "countryCode": null,
    "passportType": null,
    "vehicleClass": null,
    "restrictions": null,
    "endorsement": null,
    "mrz": null,
    "others": {
      "occupation": "PELAJAR/MAHASISWA",
      "maritalStatus": "BELUM KAWIN",
      "rtrw": "014/012",
      "birthPlaceBirthday": "JAKARTA, 28-03-1995",
      "": null
    },
    "side": "front",
    "nationalityLocal": "WNI",
    "genderLocal": "PEREMPUAN"
  }
}
{
  "front": {
    "side": "front",
    "idNumber": "3**************7",
    "documentNumber": null,
    "fullName": "A**********I",
    "fullNameLocal": null,
    "lastName": "D*****I",
    "lastNameLocal": null,
    "firstName": "A***********A",
    "firstNameLocal": null,
    "middleName": null,
    "middleNameLocal": null,
    "birthday": "1995/03/28",
    "dobDay": "28",
    "dobMonth": "3",
    "dobYear": "1995",
    "expiryDate": null,
    "expiryDay": null,
    "expiryMonth": null,
    "expiryYear": null,
    "daysToExpiry": null,
    "issueDate": "2019/04/13",
    "issueDay": "13",
    "issueMonth": "4",
    "issueYear": "2019",
    "daysFromIssue": "2025",
    "state": null,
    "city": null,
    "district": null,
    "subdistrict": null,
    "postcode": "014/012",
    "placeOfBirth": null,
    "issuerAuthority": "JAWA BARAT\nKABUPATEN BEKASI",
    "issuerPlace": null,
    "gender": "FEMALE",
    "height": null,
    "weight": null,
    "eyeColor": null,
    "bloodType": null,
    "religion": null,
    "nationality": "IDN",
    "issuerCountry": "Indonesia",
    "countryCode": "ID",
    "passportType": null,
    "vehicleClass": null,
    "restrictions": null,
    "endorsement": null,
    "others": {
      "optionalData1": null,
      "optionalData2": "ISLAM"
    },
    "fullAddress": "B*************************2",
    "nationalityLocal": "Indonesia",
    "genderLocal": "F"
  },
  "back": null
}

Vietnam

{
  "front": {
    "side": "front",
    "idNumber": "0770********7",
    "documentNumber": null,
    "fullName": "QUANG ***** **",
    "fullNameLocal": null,
    "lastName": "**",
    "lastNameLocal": null,
    "firstName": "QUANG *****",
    "firstNameLocal": null,
    "middleName": null,
    "middleNameLocal": null,
    "birthday": "1994/**/**",
    "dobDay": "**",
    "dobMonth": "*",
    "dobYear": "1994",
    "expiryDate": "2034/**/**",
    "expiryDay": "**",
    "expiryMonth": "*",
    "expiryYear": "2034",
    "daysToExpiry": "3431",
    "issueDate": null,
    "issueDay": null,
    "issueMonth": null,
    "issueYear": null,
    "daysFromIssue": null,
    "state": null,
    "city": null,
    "district": null,
    "subdistrict": null,
    "postcode": null,
    "placeOfBirth": "***",
    "issuerAuthority": null,
    "issuerPlace": null,
    "gender": null,
    "height": null,
    "weight": null,
    "eyeColor": null,
    "bloodType": null,
    "religion": null,
    "nationality": "VNM",
    "issuerCountry": "Vietnam",
    "countryCode": "VN",
    "passportType": null,
    "vehicleClass": null,
    "restrictions": null,
    "endorsement": null,
    "others": {
      "optionalData1": null,
      "optionalData2": null
    },
    "fullAddress": "******* *** ** ****** ****",
    "nationalityLocal": "Vietnam",
    "genderLocal": null
  },
  "back": {
    "side": "back",
    "idNumber": null,
    "documentNumber": null,
    "fullName": null,
    "fullNameLocal": null,
    "lastName": null,
    "lastNameLocal": null,
    "firstName": null,
    "firstNameLocal": null,
    "middleName": null,
    "middleNameLocal": null,
    "birthday": null,
    "dobDay": null,
    "dobMonth": null,
    "dobYear": null,
    "expiryDate": null,
    "expiryDay": null,
    "expiryMonth": null,
    "expiryYear": null,
    "daysToExpiry": null,
    "issueDate": null,
    "issueDay": null,
    "issueMonth": null,
    "issueYear": null,
    "daysFromIssue": null,
    "state": null,
    "city": null,
    "district": null,
    "subdistrict": null,
    "postcode": null,
    "placeOfBirth": null,
    "issuerAuthority": "**** **** ****",
    "issuerPlace": null,
    "gender": null,
    "height": null,
    "weight": null,
    "eyeColor": null,
    "bloodType": null,
    "religion": null,
    "nationality": "VNM",
    "issuerCountry": "Vietnam",
    "countryCode": "VN",
    "passportType": null,
    "vehicleClass": null,
    "restrictions": null,
    "endorsement": null,
    "others": {
      "optionalData1": null,
      "optionalData2": null
    },
    "fullAddress": null,
    "nationalityLocal": "Vietnam",
    "genderLocal": null
  }
}
{
  "front": {
    "side": "biodata",
    "idNumber": "C*******",
    "documentNumber": "*********",
    "fullName": "*** **** ** ******",
    "fullNameLocal": null,
    "lastName": "******",
    "lastNameLocal": null,
    "firstName": "*** **** **",
    "firstNameLocal": null,
    "middleName": null,
    "middleNameLocal": null,
    "birthday": "1986/**/**",
    "dobDay": "**",
    "dobMonth": "*",
    "dobYear": "1986",
    "expiryDate": "2026/**/**",
    "expiryDay": "**",
    "expiryMonth": "*",
    "expiryYear": "2026",
    "daysToExpiry": "575",
    "issueDate": "2016/**/**",
    "issueDay": "**",
    "issueMonth": "*",
    "issueYear": "2016",
    "daysFromIssue": "3077",
    "state": null,
    "city": null,
    "district": null,
    "subdistrict": null,
    "postcode": null,
    "placeOfBirth": "*** ****",
    "issuerAuthority": "*** **** ** **** **** ****",
    "issuerPlace": null,
    "gender": "FEMALE",
    "height": null,
    "weight": null,
    "eyeColor": null,
    "bloodType": null,
    "religion": null,
    "nationality": "VNM",
    "issuerCountry": "Vietnam",
    "countryCode": "VN",
    "passportType": null,
    "vehicleClass": null,
    "restrictions": null,
    "endorsement": null,
    "others": {
      "optionalData1": null,
      "optionalData2": null
    },
    "fullAddress": null,
    "nationalityLocal": "Vietnam",
    "genderLocal": "F"
  },
  "back": null
}
{
  "front": {
    "side": "front",
    "idNumber": "************",
    "documentNumber": null,
    "fullName": "*** ** **",
    "fullNameLocal": null,
    "lastName": "**",
    "lastNameLocal": null,
    "firstName": "*** **",
    "firstNameLocal": null,
    "middleName": null,
    "middleNameLocal": null,
    "birthday": "1992/**/**",
    "dobDay": "**",
    "dobMonth": "**",
    "dobYear": "1992",
    "expiryDate": null,
    "expiryDay": null,
    "expiryMonth": null,
    "expiryYear": null,
    "daysToExpiry": null,
    "issueDate": "2012/**/**",
    "issueDay": "* * ",
    "issueMonth": " ** ",
    "issueYear": " 2012",
    "daysFromIssue": "4568",
    "state": null,
    "city": null,
    "district": null,
    "subdistrict": null,
    "postcode": null,
    "placeOfBirth": null,
    "issuerAuthority": "**,**** ***\n*** **** ***",
    "issuerPlace": null,
    "gender": null,
    "height": null,
    "weight": null,
    "eyeColor": null,
    "bloodType": null,
    "religion": null,
    "nationality": null,
    "issuerCountry": "Vietnam",
    "countryCode": "VN",
    "passportType": null,
    "vehicleClass": "A1",
    "restrictions": null,
    "endorsement": null,
    "others": {
      "optionalData1": null,
      "optionalData2": null
    },
    "internalId": "****",
    "fullAddress": null,
    "nationalityLocal": null,
    "genderLocal": null
  },
  "back": null
}

eventDetails

ValueDescription
eventstring,Event name.
resultstring,Event result.
createTimestmaplong,Millisecond timestamp.

qualityLabels

FieldDescription
frontmap, The quality label (IQA failed reasons) of document front image. empty if the document front image quality is good.
backmap, The quality label (IQA failed reasons) of document back image. null if the document is not two-side. empty if the document front image quality is good.

examples:

{
  "front": null,
  "back": null
}
{
  "front": {
    "isBlur": false,
    "isDim": false,
    "isExposure": true
  },
  "back": null
}

qualityKey

ValueDescription
isBlurThe image is blurry.
isDimThe image is dim.
isExposureThe image is exposure。
occludeThe image is occlude by something.
poor_qualityThe image is in poor quality.

forgeryLabels

ValueDescription
screenshotThe image is a screenshot.
retakeThe image is taken from another screen.
photocopyThe image is a black and white, or color photocopy.
bw_photocopyThe image is a black and white photocopy.
color_photocopyThe image is a color photocopy.
editedThe image of the card, or the information on the card has been edited or altered.
othersDocument’s authenticity is not verified for various reasons.

docTypeDetails

ValueDescription
frontdocTypeDetail of the front side.
backdocTypeDetail of the back side.

Example

{
  "front": {
    "side": "FRONT",
    "category": "ID",
    "subCategory": null,
    "docType": "UA-ID-N",
    "version": null,
    "countryIso3": "UKR"
  },
  "back": {
    "side": "BACK",
    "category": "ID",
    "subCategory": null,
    "docType": "UA-ID-N",
    "version": null,
    "countryIso3": "UKR"
  }
}

docTypeDetail

Value

Description

side

enum FRONT or BACK.

countryIso3

the region of the doc. Refer to ISO ALPHA-3 Country Code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)

category

enum, category of the cardType. Refer to docTypeCategory equals the second part of docType.front/back

subCategory

string, subCategory of cardType. equals the third part of docType.front/back splitted by -

version

string, version of cardType. equals the last part of docType.front/back splitted by -

docType

equals docType.front/back

docTypeCategory


ValueDescription
IDNationalId
PPPassport
DLDriver's License