South Africa Green Book

Parameters

Headers

CountryCode: 'ZAF' or 'SOUTHAFRICA' DocumentType: 'GREENBOOK'

Required Images

FrontImage: Yes BackImage: No

Return Model

The following properties will be returned for this model:

Name	Data Type	Description
Surname	String	The last name of the subject as extracted from the document.
FirstNames	String	The first names of the subject as extracted from the document.
CountryOfBirth	String	The country of birth of the subject as extracted from the document.
DateOfBirth	DateTime	The date of birth of the subject as extracted from the document.
DateIssued	DateTime	The date of issue of the document as extracted from the document.
BookType	String	The type of book that was detected, either “Bilingual” or “English”.
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.
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.