Skip to main content

CustomerDataUgPassport

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.

documentNumberA12345678

The passport number. Format should be: A12345678

nationalitystring

Nationality ISO-3 code of the document holder (e.g., UGA). Note: the OCR field shows the long form 'UGANDAN' which cannot be cross-checked against this ISO code without an additional mapping.

birthDatedate-time

The birth date of the document holder.

sexstring

The sex of the passport holder.

Possible values: [F, M]

issueDatedate-time

The date of issue of the passport.

expirationDatedate-time

The expiration date of the passport.

personalNumberstring

The personal identification number printed as 'ID Number' on the document. Format should be: CM950761013H2E

birthplacestring

The place of birth of the passport holder.

authoritystring

The issuing authority.

canstring

The Citizenship Application Number (CAN) printed on the passport.

CustomerDataUgPassport
{
"documentNumber": "string",
"nationality": "string",
"birthDate": "2024-07-29T15:51:28.071Z",
"sex": "F",
"issueDate": "2024-07-29T15:51:28.071Z",
"expirationDate": "2024-07-29T15:51:28.071Z",
"personalNumber": "string",
"birthplace": "string",
"authority": "string",
"can": "string"
}