Extracted
Parameters
This is extracted id type that is returned in the response.
This is 2 or 3 digit ISO state code. Either extracted from the barcode or as defined in the template.
This is the 3-digit ISO country code in which the identity document was issued. Either extracted from the barcode / MRZ or as defined in the template.
ID number extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present.
ID number1 extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present.
ID number2 extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present.
ID number3 extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present.
ID number4 extracted from either barcode, MRZ, or front of the ID when MRZ /barcode are not present.
Date of Birth extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present. Date will be formatted as dd/mm/yyyy format if parsed correctly after extraction.
Date of Birth extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present. Date will be formatted as dd/mm/yyyy format if parsed correctly after extraction.
Expiration Date extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present. Date will be formatted as dd/mm/yyyy format if parsed correctly after extraction.
Expiration Date extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present. Date will be formatted as dd/mm/yyyy format if parsed correctly after extraction.
Issue Date extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present. Date will be formatted as dd/mm/yyyy format if parsed correctly after extraction.
This is the 3-digit ISO country code in which the identity document was issued. Either extracted from the barcode / MRZ or as defined in the template
Place of issue extracted from the ID.
This is the raw data extracted from the MRZ.
This is the Document Type.
This image is the front image provided by the client.
This image is the back image provided by the client.
Processed images are copies of the image that have been cropped, desckewed, rotated after the server processes them for template matching.
Processed images are copies of the image that have been cropped, desckewed, rotated after the server processes them for template matching.
ID number extracted from front of the ID.
Issue Date extracted from front of the ID.
Expiration Date extracted from front of the ID.
Non English idNumber, extracted from the front or back of the ID.
Non English idNumber2, extracted from the front or back of the ID.
Non English date of birth, extracted from the front or back of the ID.
Non English expiration date, extracted from the front or back of the ID.
Non English issue date, extracted from the front or back of the ID.
Flag for barcode data parsed.
Customer Photo on specific Id.
Flag which indicates if the individual's age is over 18 as calculated from the extracted Date of Birth. (Y/N).
Nationality of individual based on the MRZ data from the submitted ID, if available.
Flag which indicates if the submitted ID is expired. (Y/N).
Flag which indicates if the ID number extracted from the ID is in a valid format. (Y/N).
Flag which indicates if there is a biometric match against the negative database which will automatically decline the transaction. (Y/N).
Will display any error if the MRZ extraction fails, this will be blank if there are no errors.
ID number extracted from front of the ID.
ID number1 extracted from front of the ID.
ID number2 extracted from front of the ID.
ID number3 extracted from front of the ID.
ID number4 extracted from front of the ID.
Expiration Date extracted from front of the ID.
Issue Date extracted from front of the ID.
Profession extracted from front of the ID.
Non English profession, extracted from the front or back of the ID.
Employer extracted from the ID.
vehicleClass extracted from the ID.
endorsement extracted from the ID.
licenseType extracted from the ID.
restriction extracted from the ID.
Registration Date extracted from the ID.
Replacement Date extracted from the ID.
Marital Status extracted from the ID.
Place of birth extracted from the ID.
Signature extracted from the ID.
Constructors
Properties
Type:String
Flag for barcode data parsed. Possible values include:
Y: Barcode data was parsed from ID
N: Barcode data was not parsed from ID
Type:String
This is the Document Type.
Type:String
endorsement extracted from the ID./b>
Type:String
Expiration Date extracted from front of the ID.
Type:String($DD/MM/YYYY)
Example:31/12/2019
Date of Birth extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present. Date will be formatted as dd/mm/yyyy format if parsed correctly after extraction.
Type:String($DD/MM/YYYY)
Example:31/12/2019
Date of Birth extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present. Date will be formatted as dd/mm/yyyy format if parsed correctly after extraction.
Type:String
Non English date of birth, extracted from the front or back of the ID.
Type:String($DD/MM/YYYY)
Example:31/12/2019
Expiration Date extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present. Date will be formatted as dd/mm/yyyy format if parsed correctly after extraction.
Type:String
Expiration Date extracted from front of the ID.
Type:String($DD/MM/YYYY)
Example:31/12/2019
Expiration Date extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present. Date will be formatted as dd/mm/yyyy format if parsed correctly after extraction.
Type:String
Non English expiration date, extracted from the front or back of the ID.
Type:String($base64)
This image is the back image provided by the client.
Type:String($base64)
This image is the front image provided by the client.
Type:String
This is the 3-digit ISO country code in which the identity document was issued. Either extracted from the barcode / MRZ or as defined in the template
Type:String($DD/MM/YYYY)
Example:31/12/2019
Issue Date extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present. Date will be formatted as dd/mm/yyyy format if parsed correctly after extraction.
Type:String
Issue Date extracted from front of the ID.
Type:String
Non English issue date, extracted from the front or back of the ID.
Type:String
Flag which indicates if the submitted ID is expired. (Y/N).
Type:String
ID number1 extracted from front of the ID.
Type:String
ID number2 extracted from front of the ID.
Type:String
Non English idNumber2, extracted from the front or back of the ID.
Type:String
ID number3 extracted from front of the ID.
Type:String
ID number4 extracted from front of the ID.
Type:String
ID number extracted from front of the ID.
Type:String
ID number extracted from front of the ID.
Type:String
Non English idNumber, extracted from the front or back of the ID.
Type:String($base64)
Processed images are copies of the image that have been cropped, desckewed, rotated after the server processes them for template matching.
Type:String($base64)
Processed images are copies of the image that have been cropped, desckewed, rotated after the server processes them for template matching.
Type:String
Issue Date extracted from front of the ID.
Type:String
licenseType extracted from the ID./b>
Type:String
Marital Status extracted from the ID./b>
Type:String
Will display any error if the MRZ extraction fails, this will be blank if there are no errors.
Type:String
Nationality of individual based on the MRZ data from the submitted ID, if available.
Type:String
Flag which indicates if there is a biometric match against the negative database which will automatically decline the transaction. (Y/N).
Type:String
Place of birth extracted from the ID./b>
Type:String
Place of issue extracted from the ID.
Type:String
profession, extracted from the front or back of the ID.
Type:String
Non English profession, extracted from the front or back of the ID./b>
Type:String
Registration Date extracted from the ID./b>
Type:String
Replacement Date extracted from the ID./b>
Type:String
restriction extracted from the ID./b>
Type:String
Signature extracted from the ID./b>
Type:String
Flag which indicates if the ID number extracted from the ID is in a valid format. (Y/N)..
Type:String
vehicleClass extracted from the ID./b>
Functions
Type:String
Flag for ageOver18 data parsed. Possible values include:
Y: age Over 18 parsed from ID
N: age Over 18 was not parsed from ID
Type:String
Flag for barcode data parsed. Possible values include:
Y: Barcode data was parsed from ID
N: Barcode data was not parsed from ID
Type:String
This is the Document Type.
Type:String
Employer extracted from the ID./b>
Type:String
endorsement extracted from the ID./b>
Type:String
Expiration Date extracted from front of the ID.
Type:String
This is the 3-digit ISO country code in which the identity document was issued. Either extracted from the barcode / MRZ or as defined in the template.
Type:String($DD/MM/YYYY)
Example:31/12/2019
Date of Birth extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present. Date will be formatted as dd/mm/yyyy format if parsed correctly after extraction.
Type:String($DD/MM/YYYY)
Example:31/12/2019
Date of Birth extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present. Date will be formatted as dd/mm/yyyy format if parsed correctly after extraction.
Type:String
Non English date of birth, extracted from the front or back of the ID.
Type:String($DD/MM/YYYY)
Example:31/12/2019
Expiration Date extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present. Date will be formatted as dd/mm/yyyy format if parsed correctly after extraction.
Type:String
Expiration Date extracted from front of the ID.
Type:String($DD/MM/YYYY)
Example:31/12/2019
Expiration Date extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present. Date will be formatted as dd/mm/yyyy format if parsed correctly after extraction.
Type:String
Non English expiration date, extracted from the front or back of the ID.
Type:String($base64)
This image is the back image provided by the client.
Type:String($base64)
This image is the front image provided by the client.
Type:String
This is the 3-digit ISO country code in which the identity document was issued. Either extracted from the barcode / MRZ or as defined in the template
Type:String($DD/MM/YYYY)
Example:31/12/2019
Issue Date extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present. Date will be formatted as dd/mm/yyyy format if parsed correctly after extraction.
Type:String
Issue Date extracted from front of the ID.
Type:String
Non English issue date, extracted from the front or back of the ID.
Type:String
Flag which indicates if the submitted ID is expired. (Y/N).
Type:String
Example:123456
ID number extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present.
Type:String
Example:123456
ID number1 extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present.
Type:String
ID number1 extracted from front of the ID.
Type:String
Example:123456
ID number2 extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present.
Type:String
ID number2 extracted from front of the ID.
Type:String
Non English idNumber2, extracted from the front or back of the ID.
Type:String
Example:123456
ID number3 extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present.
Type:String
ID number3 extracted from front of the ID.
Type:String
Example:123456
ID number4 extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present.
Type:String
ID number4 extracted from front of the ID.
Type:String
ID number extracted from front of the ID.
Type:String
ID number extracted from front of the ID.
Type:String
Non English idNumber, extracted from the front or back of the ID.
Type:String($base64)
Processed images are copies of the image that have been cropped, desckewed, rotated after the server processes them for template matching.
Type:String($base64)
Processed images are copies of the image that have been cropped, desckewed, rotated after the server processes them for template matching.
Type:String
This is 2 or 3 digit ISO state code. Either extracted from the barcode or as defined in the template.
Type:String
Issue Date extracted from front of the ID.
Type:String
licenseType extracted from the ID./b>
Type:String
Marital Status extracted from the ID./b>
Type:String
This is the raw data extracted from the MRZ.
Type:String
Will display any error if the MRZ extraction fails, this will be blank if there are no errors.
Type:String
Nationality of individual based on the MRZ data from the submitted ID, if available.
Type:String
Flag which indicates if there is a biometric match against the negative database which will automatically decline the transaction. (Y/N).
Type:String($base64)
Copy of the image of Face on the ID that have been cropped.
Type:String
Place of birth extracted from the ID./b>
Type:String
Place of issue extracted from the ID.
Type:String
profession, extracted from the front or back of the ID.
Type:String
Non English profession, extracted from the front or back of the ID./b>
Type:String
Registration Date extracted from the ID./b>
Type:String
Replacement Date extracted from the ID./b>
Type:String
restriction extracted from the ID./b>
Type:String
Signature extracted from the ID./b>
Type:String
Flag which indicates if the ID number extracted from the ID is in a valid format. (Y/N)..
Type:String
vehicleClass extracted from the ID./b>
Type:String
Expiration Date extracted from front of the ID.
Type:String($base64)
This image is the back image provided by the client.
Type:String($base64)
This image is the front image provided by the client.
Type:String
ID number extracted from front of the ID.
Type:String($base64)
Processed images are copies of the image that have been cropped, desckewed, rotated after the server processes them for template matching.
Type:String($base64)
Processed images are copies of the image that have been cropped, desckewed, rotated after the server processes them for template matching.
Type:String
Issue Date extracted from front of the ID.
Type:String($base64)
Copy of the image of Face on the ID that have been cropped.