CustomerDataDto

Also accepts any additional custom field (camelCase key, string value) to be verified against the document. The optional properties marked 'MRZ-verifiable' (plus firstName/lastName) are verified against the machine readable zone whenever it validates; any other key is verified against the OCR text only.

documentNumberstring

Customer's document serial number - MRZ-verifiable

birthDatestring

Customer's birth date, any common format - MRZ-verifiable

dateOfBirthstring

Alias of birthDate - MRZ-verifiable

expirationDatestring

Document expiry date, any common format - MRZ-verifiable

expiryDatestring

Alias of expirationDate - MRZ-verifiable

nationalitystring

Nationality as a country name, ISO alpha-2 or alpha-3 code - MRZ-verifiable

sexstring

Customer's sex - MRZ-verifiable

genderstring

Alias of sex - MRZ-verifiable

personalNumberstring

Personal number (TD3 passports) - MRZ-verifiable

issuingStatestring

Issuing state as a country name or ISO code - MRZ-verifiable

issueDatestring

Issue date (French/Swiss driving-licence MRZs) - MRZ-verifiable

languageCodestring

Language code (Swiss driving-licence MRZs) - MRZ-verifiable

countrystringrequired

Customer's country ISO Code

documentTypestringrequired

Customer's document type

Possible values: [other, alien-id, health-card, id-card, electronic-id-card, foreigner-certificate, id-book, passport, driving-license, refugee-id, resident-id, seaman-id, social-id, travel-docs, voting-card, ke-kra-pin, ke-army-id, zm-tpin, nin-card, nin-slip, nin-digital-slip, digital-id-card]

firstNamestringrequired

Customer's first name

lastNamestringrequired

Customer's last name

customerIdstring

Customer's optional identifying key

property name*any

Also accepts any additional custom field (camelCase key, string value) to be verified against the document. The optional properties marked 'MRZ-verifiable' (plus firstName/lastName) are verified against the machine readable zone whenever it validates; any other key is verified against the OCR text only.

CustomerDataDto

{
  "documentNumber": "string",
  "birthDate": "string",
  "dateOfBirth": "string",
  "expirationDate": "string",
  "expiryDate": "string",
  "nationality": "string",
  "sex": "string",
  "gender": "string",
  "personalNumber": "string",
  "issuingState": "string",
  "issueDate": "string",
  "languageCode": "string",
  "country": "string",
  "documentType": "other",
  "firstName": "string",
  "lastName": "string",
  "customerId": "string"
}