SouthAfricaGreenBookModel

A class derived from GreenBookModel containing details specific to the South African green book

import com.sybrin.identity.countries.SouthAfrica.GreenBook.SouthAfricaGreenBookModel
extends GreenBookModel​
Summary
Public methods
​
Data source
int
​getIdentityNumberADigit()
OCR
int
​getIdentityNumberCheckDigit()
OCR
​CitizenshipType​
​getIdentityNumberCitizenship()
OCR
Date
​getIdentityNumberDateOfBirth()
OCR
​Sex​
​getIdentityNumberSex()
OCR
Inherited methods
​DocumentModel​
​
Data source
<T extends DocumentModel>
​castToModel(Class<T> class)
​
Casts the current model to the
type specified by the class parameter.
N/A
Bitmap
​getCroppedDocumentImage()
Front of card
String
​getCroppedDocumentImagePath()
Local storage
Bitmap
​getDocumentImage()
Front of card
String
​getDocumentImagePath()
Local storage
Bitmap
​getPortraitImage()
Front of card
String
​getPortraitImagePath()
Local storage
void
​saveImages(Context context)
​
Saves all images within the model
to the local device and populates
all path fields.
N/A
​GreenBookModel​
​
Data source
​GreenBookType​
​getBookType()
​
Returns the language type of the 
green book document.
OCR
String
​getCountryOfBirth()
OCR
Date
​getDateIssued()
OCR
Date
​getDateOfBirth()
OCR
String
​getFirstNames()
OCR
String
​getIdentityNumber()
OCR
String
​getSurname()
OCR
Validation
The following validation and verification applies to this document:
Check digit validation
Value
Validation type
Identity number
Check digit using Luhn algorithm​
Public methods
getIdentityNumberADigit
public int getIdentityNumberADigit ()
Returns the A digits as found within the subject's identity number.
Returns
​
int
​
​
getIdentityNumberCheckDigit
public int getIdentityNumberCheckDigit ()
Returns the check digit used to verify the subject's identity number as found on the green book document.
Returns
​
int
​
​
getIdentityNumberCitizenship
public CitizenshipType getIdentityNumberCitizenship ()
Returns the type of citizen a subject's is as found within the subject's identity number.
Returns
​
​CitizenshipType​
The subject's citizenship according to their identity number. This value cannot be null.
​
getIdentityNumberDateOfBirth
public Date getIdentityNumberDateOfBirth ()
Returns the subject's date of birth as found within the subject's identity number.
Returns
​
Date
The subject's date of birth according to their identity number. This value cannot be null.
​
getIdentityNumberSex
public String getIdentityNumberSex ()
Returns the subject's sex as found within the subject's identity number.
Returns
​
​Sex​
This value cannot be null.

SouthAfricaGeneralWorkVisaModel

SouthAfricaIDCardModel

Last modified 6mo ago

Public methods		Data source
int	getIdentityNumberADigit()	OCR
int	getIdentityNumberCheckDigit()	OCR
CitizenshipType	getIdentityNumberCitizenship()	OCR
Date	getIdentityNumberDateOfBirth()	OCR
Sex	getIdentityNumberSex()	OCR

DocumentModel		Data source
<T extends DocumentModel>	castToModel(Class<T> class) Casts the current model to the type specified by the class parameter.	N/A
Bitmap	getCroppedDocumentImage()	Front of card
String	getCroppedDocumentImagePath()	Local storage
Bitmap	getDocumentImage()	Front of card
String	getDocumentImagePath()	Local storage
Bitmap	getPortraitImage()	Front of card
String	getPortraitImagePath()	Local storage
void	saveImages(Context context) Saves all images within the model to the local device and populates all path fields.	N/A

GreenBookModel		Data source
GreenBookType	getBookType() Returns the language type of the green book document.	OCR
String	getCountryOfBirth()	OCR
Date	getDateIssued()	OCR
Date	getDateOfBirth()	OCR
String	getFirstNames()	OCR
String	getIdentityNumber()	OCR
String	getSurname()	OCR

Value	Validation type
Identity number	Check digit using Luhn algorithm

Returns
CitizenshipType	The subject's citizenship according to their identity number. This value cannot be `null`.

Returns
Date	The subject's date of birth according to their identity number. This value cannot be `null`.