IdDataResponse

public struct IdDataResponse : Codable

Child structure of CustomerDataValidateIdResponse, CustomerEnrollDataResponse, and CustomerValidateIdFaceMatchDataResponse.

Properties

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

    Declaration

    Swift

    public var idType: String?

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

    Declaration

    Swift

    public var idState: 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.

    Declaration

    Swift

    public var idCountry: String?

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

    Declaration

    Swift

    public var idNumber: String?

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

    Declaration

    Swift

    public var idNumber1: String?

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

    Declaration

    Swift

    public var idNumber2: String?

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

    Declaration

    Swift

    public var idNumber3: String?

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

    Declaration

    Swift

    public var idNumber4: String?

  • 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. (DD/MM/YYYY)

    Declaration

    Swift

    public var idDateOfBirth: String?

  • 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. (DD/MM/YYYY)

    Declaration

    Swift

    public var idDateOfBirthFormatted: String?

  • 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. (DD/MM/YYYY)

    Declaration

    Swift

    public var idExpirationDate: String?

  • 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. (DD/MM/YYYY)

    Declaration

    Swift

    public var idExpirationDateFormatted: String?

  • 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. (DD/MM/YYYY)

    Declaration

    Swift

    public var idIssueDate: 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

    Declaration

    Swift

    public var idIssueCountry: String?

  • Place of issue extracted from the ID.

    Declaration

    Swift

    public var placeOfIssue: String?

  • This is the raw data extracted from the MRZ.

    Declaration

    Swift

    public var mrzData: String?

  • This image is the front image provided by the client. (Base64)

    Declaration

    Swift

    public var idImageFront: String?

  • This image is the back image provided by the client. (Base64)

    Declaration

    Swift

    public var idImageBack: String?

  • Processed images are copies of the image that have been cropped, deskewed, rotated after the server processes them for template matching. (Base64)

    Declaration

    Swift

    public var idProcessImageFront: String?

  • Processed images are copies of the image that have been cropped, deskewed, rotated after the server processes them for template matching. (Base64)

    Declaration

    Swift

    public var idProcessImageBack: String?

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

    Declaration

    Swift

    public var idNumberNonEng: String?

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

    Declaration

    Swift

    public var idNumber2NonEng: String?

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

    Declaration

    Swift

    public var idDateOfBirthNonEng: String?

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

    Declaration

    Swift

    public var idExpirationDateNonEng: String?

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

    Declaration

    Swift

    public var idIssueDateNonEng: String?

  • Flag for barcode data parsed.

    Possible values include:

    • Y: Barcode data was parsed from ID
    • N: Barcode data was not parsed from ID

    Declaration

    Swift

    public var barcodeDataParsed: String?

  • Whether or not a photo was found on the ID.

    Declaration

    Swift

    public var photoOnId: String?

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

    Declaration

    Swift

    public var ageOver18: String?

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

    Declaration

    Swift

    public var nationality: String?

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

    Declaration

    Swift

    public var idNotExpired: String?

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

    Declaration

    Swift

    public var validIdNumber: String?

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

    Declaration

    Swift

    public var negativeDBMatchFound: String?

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

    Declaration

    Swift

    public var mrzErrorMessage: String?

  • ID number extracted from front of the ID.

    Declaration

    Swift

    public var idNumber_doc: String?

  • ID number1 extracted from front of the ID.

    Declaration

    Swift

    public var idNumber1_doc: String?

  • ID number2 extracted from front of the ID.

    Declaration

    Swift

    public var idNumber2_doc: String?

  • ID number3 extracted from front of the ID.

    Declaration

    Swift

    public var idNumber3_doc: String?

  • ID number4 extracted from front of the ID.

    Declaration

    Swift

    public var idNumber4_doc: String?

  • Expiration Date extracted from front of the ID.

    Declaration

    Swift

    public var idExpirationDate_doc: String?

  • Issue Date extracted from front of the ID.

    Declaration

    Swift

    public var idIssueDate_doc: String?

  • Profession extracted from front of the ID.

    Declaration

    Swift

    public var profession: String?

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

    Declaration

    Swift

    public var professionNonEng: String?

  • Employer extracted from the ID.

    Declaration

    Swift

    public var employer: String?

  • vehicleClass extracted from barcode of the ID.

    Declaration

    Swift

    public var vehicleClass: String?

  • endorsement extracted from barcode of the ID.

    Declaration

    Swift

    public var endorsement: String?

  • licenseType extracted from barcode of the ID.

    Declaration

    Swift

    public var licenseType: String?

  • restriction extracted from barcode of the ID.

    Declaration

    Swift

    public var restriction: String?

  • registrationDate extracted from barcode of the ID.

    Declaration

    Swift

    public var registrationDate: String?

  • replacementDate extracted from barcode of the ID.

    Declaration

    Swift

    public var replacementDate: String?

  • Marital Status extracted from the ID.

    Declaration

    Swift

    public var maritalStatus: String?

  • Place of birth extracted from the ID.

    Declaration

    Swift

    public var placeOfBirth: String?

  • Signature extracted from the ID.

    Declaration

    Swift

    public var signatureFromId: String?