ExtractedIdData

public ExtractedIdData ExtractedIdData(String idType, String idState, String idCountry, String idNumber, String idNumber1, String idNumber2, String idNumber3, String idNumber4, String idDateOfBirth, String idDateOfBirthFormatted, String idExpirationDate, String idExpirationDateFormatted, String idIssueDate, String idIssueCountry, String placeOfIssue, String mrzData, String documentType, String idImageFront, String idImageBack, String idProcessImageFront, String idProcessImageBack, String idNumberDoc, String issueDateDoc, String expiryDateDoc, String idNumberNonEng, String idNumber2NonEng, String idDateOfBirthNonEng, String idExpirationDateNonEng, String idIssueDateNonEng, String barcodeDataParsed, String photoOnId, String ageOver18, String nationality, String idNotExpired, String validIdNumber, String negativeDBMatchFound, String mrzErrorMessage, String idNumber_doc, String idNumber1_doc, String idNumber2_doc, String idNumber3_doc, String idNumber4_doc, String idExpirationDate_doc, String idIssueDate_doc, String profession, String professionNonEng, String employer, String vehicleClass, String endorsement, String licenseType, String restriction, String registrationDate, String replacementDate, String maritalStatus, String placeOfBirth, String signatureFromId)

Parameters

idType

This is extracted id type that is returned in the response.

idState

This is 2 or 3 digit ISO state code. Either extracted from the barcode or as defined in the template.

idCountry

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.

idNumber

ID number extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present.

idNumber1

ID number1 extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present.

idNumber2

ID number2 extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present.

idNumber3

ID number3 extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present.

idNumber4

ID number4 extracted from either barcode, MRZ, or front of the ID when MRZ /barcode are not present.

idDateOfBirth

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.

idDateOfBirthFormatted

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.

idExpirationDate

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.

idExpirationDateFormatted

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.

idIssueDate

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.

idIssueCountry

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

placeOfIssue

Place of issue extracted from the ID.

mrzData

This is the raw data extracted from the MRZ.

documentType

This is the Document Type.

idImageFront

This image is the front image provided by the client.

idImageBack

This image is the back image provided by the client.

idProcessImageFront

Processed images are copies of the image that have been cropped, desckewed, rotated after the server processes them for template matching.

idProcessImageBack

Processed images are copies of the image that have been cropped, desckewed, rotated after the server processes them for template matching.

idNumberDoc

ID number extracted from front of the ID.

issueDateDoc

Issue Date extracted from front of the ID.

expiryDateDoc

Expiration Date extracted from front of the ID.

idNumberNonEng

Non English idNumber, extracted from the front or back of the ID.

idNumber2NonEng

Non English idNumber2, extracted from the front or back of the ID.

idDateOfBirthNonEng

Non English date of birth, extracted from the front or back of the ID.

idExpirationDateNonEng

Non English expiration date, extracted from the front or back of the ID.

idIssueDateNonEng

Non English issue date, extracted from the front or back of the ID.

barcodeDataParsed

Flag for barcode data parsed.

photoOnId

Customer Photo on specific Id.

ageOver18

Flag which indicates if the individual's age is over 18 as calculated from the extracted Date of Birth. (Y/N).

nationality

Nationality of individual based on the MRZ data from the submitted ID, if available.

idNotExpired

Flag which indicates if the submitted ID is expired. (Y/N).

validIdNumber

Flag which indicates if the ID number extracted from the ID is in a valid format. (Y/N).

negativeDBMatchFound

Flag which indicates if there is a biometric match against the negative database which will automatically decline the transaction. (Y/N).

mrzErrorMessage

Will display any error if the MRZ extraction fails, this will be blank if there are no errors.

idNumber_doc

ID number extracted from front of the ID.

idNumber1_doc

ID number1 extracted from front of the ID.

idNumber2_doc

ID number2 extracted from front of the ID.

idNumber3_doc

ID number3 extracted from front of the ID.

idNumber4_doc

ID number4 extracted from front of the ID.

idExpirationDate_doc

Expiration Date extracted from front of the ID.

idIssueDate_doc

Issue Date extracted from front of the ID.

profession

Profession extracted from front of the ID.

professionNonEng

Non English profession, extracted from the front or back of the ID.

employer

Employer extracted from the ID.

vehicleClass

vehicleClass extracted from the ID.

endorsement

endorsement extracted from the ID.

licenseType

licenseType extracted from the ID.

restriction

restriction extracted from the ID.

registrationDate

Registration Date extracted from the ID.

replacementDate

Replacement Date extracted from the ID.

maritalStatus

Marital Status extracted from the ID.

placeOfBirth

Place of birth extracted from the ID.

signatureFromId

Signature extracted from the ID.