Skip to main content

CustomerDataNgPassport

Extends CustomerDataDto: the object also contains its base fields (country, documentType, firstName, lastName and the optional customerId), which are not repeated below. The fields listed here are specific to this country and document type.

middleNamestring

The middle name(s): the given names that follow the first one. The first space or comma ends the first name ("AMINA, ZAINAB" or "AMINA ZAINAB" -> middle name "ZAINAB"), a hyphen does not ("ADA-OBI, ZAINAB" -> first name "ADA-OBI", middle name "ZAINAB"). Optional: sending all the given names together in firstName is also accepted. Every word is fuzzy-matched individually against the OCR. Never fails the match: a middle name the document does not show is reported as not matching in the breakdown, without rejecting the document. Not verified against the MRZ, which writes spaces and hyphens alike and cannot separate the middle name.

documentNumberstring

The passport number (e.g. "A13456720"). Spaces are stripped.

ninstring

The 11-digit National Identification Number (NIN), printed as "Personal No." on the data page and encoded in the MRZ personal number field. Spaces are stripped, so a grouped form is also accepted. Some genuine passports (e.g. issued abroad) do not carry it — in that case the field is not verified against the document.

sexstring

The sex of the passport holder

Possible values: [F, M]

nationalitystring

Nationality of the document holder (ISO-3, e.g. "NGA").

birthDate object

The birth date of the document holder (bilingual DD MMM/MMM YY on the document)

oneOf
number

Unix timestamp in milliseconds

issueDate object

The issue date of the document (bilingual DD MMM/MMM YY on the document)

oneOf
number

Unix timestamp in milliseconds

expirationDate object

The expiration date of the document (bilingual DD MMM/MMM YY on the document)

oneOf
number

Unix timestamp in milliseconds

birthplacestring

The birthplace

authoritystring

Issuing Authority (e.g. "JOS", "ABUJA HQRS")

CustomerDataNgPassport
{
  "middleName": "string",
  "documentNumber": "string",
  "nin": "string",
  "sex": "F",
  "nationality": "string",
  "birthDate": 0,
  "issueDate": 0,
  "expirationDate": 0,
  "birthplace": "string",
  "authority": "string"
}