SouthAfricaPassportModel

A class derived from PassportModel containing details specific to the South African passport

import com.sybrin.identity.countries.SouthAfrica.Passport.SouthAfricaPassportModel

extends PassportModel

Summary

Public methods		Data source
int	getCompositeCheckDigit()	MRZ OCR
int	getDateOfBirthCheckDigit()	MRZ OCR
int	getDateOfExpiryCheckDigit()	MRZ OCR
String	getIdentityNumber()	MRZ OCR
int	getIdentityNumberADigit()	MRZ OCR
int	getIdentityNumberCheckDigit()	MRZ OCR
CitizenshipType	getIdentityNumberCitizenship()	MRZ OCR
Date	getIdentityNumberDateOfBirth()	MRZ OCR
int	getIdentityNumberPassportCheckDigit()	MRZ OCR
Sex	getIdentityNumberSex()	MRZ OCR
String	getMrzLine1()	MRZ OCR
String	getMrzLine2()	MRZ OCR
int	getPassportNumberCheckDigit()	MRZ 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 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

PassportModel		Data source
Date	getDateOfBirth()	MRZ OCR
Date	getDateOfExpiry()	MRZ OCR
String	getIssuingCountryCode()	MRZ OCR
String	getNames()	MRZ OCR
String	getNationality()	MRZ OCR
String	getPassportNumber()	MRZ OCR
String	getPassportType()	MRZ OCR
Sex	getSex() Returns the subject's sex as found on the passport.	MRZ OCR
String	getSurname()	MRZ OCR

Validation

The following validation and verification applies to this document:

Check digit validation

Value	Validation type
Date of birth	Check digit using MRP Checksum calculation algorithm.
Date of expiry	Check digit using MRP Checksum calculation algorithm.
Identity number	Check digit using Luhn algorithm.
MRZ line 2 composite	Check digit using MRP Checksum calculation algorithm.
Passport identity number (Optional data)	Check digit using MRP Checksum calculation algorithm.
Passport number	Check digit using MRP Checksum calculation algorithm.

Public methods

getCompositeCheckDigit

public int getCompositeCheckDigit ()

Returns the check digit used to verify the passport number, date of birth, date of expiry, and optional data as found on the passport.

Returns
int

getDateOfBirthCheckDigit

public int getDateOfBirthCheckDigit ()

Returns the check digit used to verify the subject's date of birth as found on the passport.

Returns
int

getDateOfExpiryCheckDigit

public int getDateOfExpiryCheckDigit ()

Returns the check digit used to verify the passport's date of expiry as found on the passport.

Returns
int

getIdentityNumber

public String getIdentityNumber()

Returns the subject's identity number as found on the passport.

Returns
String	The subject's identity number. 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 passport.

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.

getIdentityNumberPassportCheckDigit

public int getIdentityNumberPassportCheckDigit ()

Returns the check digit used to verify the subject's identity number as found on passport.

Returns
int

getIdentityNumberSex

public String getIdentityNumberSex ()

Returns the subject's sex as found within the subject's identity number.

Returns
Sex	This value cannot be null.

getMrzLine1

public String getMrzLine1 ()

Returns the first MRZ line as found on the passport.

Returns
String	The first MRZ line. This value cannot be null.

getMrzLine2

public String getMrzLine2 ()

Returns the second MRZ line as found on the passport.

Returns
String	The second MRZ line. This value cannot be null.

getPassportNumberCheckDigit

public int getPassportNumberCheckDigit ()

Returns the check digit used to verify the passport number as found on the passport.

Returns
int