South Africa ID Card
Parameters
Headers
CountryCode: 'ZAF'
or 'SOUTHAFRICA'
DocumentType: 'IDCARD'
Required Images
FrontImage: Yes BackImage: Yes
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 card.
Names
String
The first names of the subject as extracted from the card.
Sex
String
The sex of the subject as extracted from the card.
Nationality
String
The nationality country code of the subject as extracted from the card.
IdentityNumber
String
The identity number of the subject as extracted from the card.
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.
DateOfBirth
DateTime
The date of birth of the subject as extracted from the card.
CountryOfBirth
String
The country of birth country code of the subject as extracted from the card.
Status
String
The citizenship status of the subject as extracted from the card.
BackImageSecurityCheckSuccess
Boolean
Indicates whether the back image was verified or not.
FrontImageSecurityCheckSuccess
Boolean
Indicates whether the front image was verified or not.
FaceDetection
An array collection of all the faces that were detected and extracted from the images.
Last updated
Was this helpful?