Skip to main content

CustomerDataGhIdCard

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.

documentNumberstring

The Document Number printed on the front (e.g. "AB1234567"). Not the Ghana Card PIN.

personalNumberstring

The Ghana Card PIN, printed as "Personal ID Number" on both sides, hyphens included (e.g. "GHA-123456789-0"). Not encoded in the MRZ.

nationalitystring

Nationality of the document holder (ISO-3, e.g. "GHA", as encoded in the MRZ; the card face prints the word, e.g. "GHANAIAN").

sexstring

The sex of the document holder

Possible values: [F, M]

birthDate object

The birth date of the document holder, printed DD/MM/YYYY.

oneOf
number

Unix timestamp in milliseconds

issueDate object

The issue date of the document, printed DD/MM/YYYY; not present in the MRZ, so it is verified against the OCR.

oneOf
number

Unix timestamp in milliseconds

expirationDate object

The expiration date of the document, printed DD/MM/YYYY.

oneOf
number

Unix timestamp in milliseconds

placeOfIssuestring

The place of issuance (e.g. "ACCRA").

authoritystring

The issuing authority, printed on the back (e.g. "NATIONAL IDENTIFICATION AUTHORITY").

heightstring

The height in metres, exactly as printed (e.g. "1.5"); another notation ("150cm", "1.50") does not match.

CustomerDataGhIdCard
{
  "documentNumber": "string",
  "personalNumber": "string",
  "nationality": "string",
  "sex": "F",
  "birthDate": 0,
  "issueDate": 0,
  "expirationDate": 0,
  "placeOfIssue": "string",
  "authority": "string",
  "height": "string"
}