Skip to main content

CustomerDataNgDigitalIdCard

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 Digital ID number: the letter M followed by digits (e.g. "M0067910"). Spaces are stripped, so the grouped print ("M0 067 910") is also accepted. OCR often confuses the 0 after M with the letter O, so it is fuzzy-matched (one-character tolerance). Included so Document Analysis extracts it in parsed form.

ninstring

The 11-digit National Identification Number (NIN), e.g. "12345678901". Spaces are stripped, so the grouped print is also accepted. Printed in red on the BACK of the card; NOT encoded in the MRZ.

sexstring

The sex of the document holder — printed short on the front

Possible values: [F, M]

nationalitystring

Nationality of the document holder (ISO-3 "NGA" as printed).

birthDate object

Verified STRICTLY against the MRZ (YYMMDD). Genuine cards with a face/MRZ mismatch exist; they fail automated verification by design and are resolved at manual review.

oneOf
number

Unix timestamp in milliseconds

expirationDate object

Not printed on the card; exists only in the MRZ.

oneOf
number

Unix timestamp in milliseconds

CustomerDataNgDigitalIdCard
{
  "middleName": "string",
  "documentNumber": "string",
  "nin": "string",
  "sex": "F",
  "nationality": "string",
  "birthDate": 0,
  "expirationDate": 0
}