SouthAfricaIDCardModel

A class derived from IDCardModel containing details specific to the South African ID card

import com.sybrin.identity.countries.SouthAfrica.IDCard.SouthAfricaIDCardModel

extends IDCardModel

Summary

Public methods		Data source
String	getCardNumber()	PDF417 Barcode
CitizenshipType	getCitizenship()	PDF417 Barcode
String	getCountryOfBirth()	PDF417 Barcode
Date	getDateIssued()	PDF417 Barcode
int	getIdentityNumberADigit()	PDF417 Barcode
int	getIdentityNumberCheckDigit()	PDF417 Barcode
CitizenshipType	getIdentityNumberCitizenship()	PDF417 Barcode
Date	getIdentityNumberDateOfBirth()	PDF417 Barcode
Sex	getIdentityNumberSex()	PDF417 Barcode
String	getNames()	PDF417 Barcode
String	getRsaCode()	PDF417 Barcode
String	getSurname()	PDF417 Barcode

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 document
String	getCroppedDocumentImagePath()	Local storage
Bitmap	getDocumentImage()	Front of document
String	getDocumentImagePath()	Local storage
Bitmap	getPortraitImage()	Front of document
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

IDCardModel		Data source
Bitmap	getCroppedDocumentBackImage()	Back of document
String	getCroppedDocumentBackImagePath()	Local Storage
Date	getDateOfBirth()	PDF417 Barcode
Bitmap	getDocumentBackImage()	Back of document
String	getDocumentBackImagePath()	Local Storage
String	getFullName()	PDF417 Barcode
String	getIdentityNumber()	PDF417 Barcode
String	getNationality()	PDF417 Barcode
Bitmap	getPortraitBackImage()	Back of document
String	getPortraitBackImagePath()	Local Storage
Sex	getSex() Returns the subject's sex as found on the ID card.	PDF417 Barcode

Validation

The following validation and verification applies to this document:

Check digit validation

Value	Validation type
Identity number	Check digit using Luhn algorithm

Component verification

As explained in Validation & Verification the following fields are verified across the front and back components of the document.

Value	Source
Identity number	Front: OCR Back: PDF417 Barcode

Public methods

getCardNumber

public String getCardNumber ()

Returns the ID card number as found on the ID card.

Returns
String	The ID card number. This value cannot be null.

getCitizenship

public CitizenshipType getCitizenship ()

Returns the type of citizen a subject's is as found on the ID card.

Returns
CitizenshipType	The subject's citizenship. This value cannot be null.

getCountryOfBirth

public String getCountryOfBirth ()

Returns the subject's country of birth as found on the ID card.

Returns
String	The subject's country of birth. This value cannot be null.

getDateIssued

public Date getDateIssued ()

Returns the document's issue date as found on the ID card.

Returns
Date	The document's issue date. This value cannot be null.

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 ID card.

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.

getNames

public String getNames ()

Returns the subject's names as found on the ID card.

Returns
String	The subject's names. This value cannot be null.

getRsaCode

public String getRsaCode ()

Returns the ID card's RSA code as found on the ID card.

Returns
String	The ID card's RSA code. This value cannot be null.

getSurname

public String getSurname ()

Returns the subject's surname as found on the ID card.

Returns
String	The subject's surname. This value cannot be null.