South Africa Passport

Parameters

Headers

CountryCode: 'ZAF' or 'SOUTHAFRICA' DocumentType: 'PASSPORT'

Required Images

FrontImage: Yes BackImage: No

Return Model

The following properties will be returned for this model:

Name	Data Type	Description
MRZLine1	String	The first line of the MRZ.
MRZLine2	String	The second line of the MRZ.
PassportType	String	The passport type as extracted from the MRZ.
IssuingCountryCode	String	The country code that issued the passport.
Surname	String	The surname of the subject as extracted from the MRZ.
Names	String	The names of the subject as extracted from the MRZ.
PassportNumber	String	The passport number as extracted from the MRZ.
PassportNumberCheckDigit	Integer	A check digit, used to verify the OCR integrity of the passport number.
Nationality	String	The nationality country code of the subject as extracted from the MRZ.
DateOfBirth	DateTime	The date of birth of the subject as extracted from the MRZ.
DateOfBirthCheckDigit	Integer	A check digit, used to verify the OCR integrity of the date of birth.
Sex	String	The sex of the subject as extracted from the MRZ.
DateOfExpiry	DateTime	The date of expiry of the document as extracted from the MRZ.
DateOfExpiryCheckDigit	Integer	A check digit, used to verify the OCR integrity of the date of expiry.
IdentityNumber	String	The identity number of the subject as extracted from the document.
IdentityNumberDateOfBirth	DateTime	The date of birth of the subject as extracted from the identity number.
IdentityNumberSex	String	The sex of the subject as extracted from the identity number.
IdentityNumberCitizenship	String	The citizenship of the subject as extracted from the identity number.
IdentityNumberADigit	Integer	The a digit of the identity number as extracted from the identity number.
IdentityNumberCheckDigit	Integer	The check digit of the identity number as extracted from the identity number. Used to verify the OCR integrity of the identity number.
IdentityNumberPassportCheckDigit	Integer	A check digit, used to verify the OCR integrity of the entire identity number.
CompositeCheckDigit	Integer	A check digit, used to verify the OCR integrity of the entire MRZ.
FrontImageSecurityCheckSuccess	Boolean	Indicates whether the front image was verified or not.
FaceDetection	FaceDetectionResponse[]	An array collection of all the faces that were detected and extracted from the images.