UgandaIDCardModel

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

import com.sybrin.identity.countries.Uganda.IDCard.UgandaIDCardModel

extends IDCardModel

Summary

Public methods		Data source
String	getCardNumber()	MRZ OCR
int	getCardNumberCheckDigit()	MRZ OCR
int	getCompositeCheckDigit()	MRZ OCR
Date	getDateIssued()	MRZ OCR
int	getDateOfBirthCheckDigit()	MRZ OCR
Date	getDateOfExpiry()	MRZ OCR
int	getDateOfExpiryCheckDigit()	MRZ OCR
String	getIssuingCountryCode()	MRZ OCR
String	getMrzLine1()	MRZ OCR
String	getMrzLine2()	MRZ OCR
String	getMrzLine3()	MRZ OCR
String	getNames()	MRZ OCR
String	getOptionalData1()	MRZ OCR
String	getOptionalData2()	MRZ OCR
String	getSurname()	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

IDCardModel		Data source
Bitmap	getCroppedDocumentBackImage()	Back of document
String	getCroppedDocumentBackImagePath()	Local Storage
Date	getDateOfBirth()	MRZ OCR
Bitmap	getDocumentBackImage()	Back of document
String	getDocumentBackImagePath()	Local Storage
String	getFullName()	MRZ OCR
String	getIdentityNumber()	MRZ OCR
String	getNationality()	MRZ OCR
Bitmap	getPortraitBackImage()	Back of document
String	getPortraitBackImagePath()	Local Storage
Sex	getSex() Returns the subject's sex as found on the ID card.	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.
MRZ line 1 & 2 composite	Check digit using MRP Checksum calculation algorithm.
Card Number	Check digit using MRP Checksum calculation algorithm.

Component verification

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

Value	Source
Card number	Front: OCR Back: MRZ OCR

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.

getCardNumberCheckDigit

public int getCardNumberCheckDigit ()

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

Returns
int

getCompositeCheckDigit

public int getCompositeCheckDigit ()

Returns the check digit used to verify the serial number, date of birth, date of expiry, optional data 1, and optional data 2 as found on the ID card.

Returns
int

getDateIssued

public Date getDateIssued ()

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

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

getDateOfBirthCheckDigit

public int getDateOfBirthCheckDigit ()

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

Returns
int

getDateOfExpiry

public Date getDateOfExpiry ()

Returns the ID card's date of expiry as found on the ID card.

Returns
Date	The ID card's date of expiry. This value cannot be null.

getDateOfExpiryCheckDigit

public int getDateOfExpiryCheckDigit ()

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

Returns
int

getIssuingCountryCode

public String getIssuingCountryCode ()

Returns the ISO 3166-1 Alpha 3 country code as found on the ID card.

Returns
String	The ISO 3166-1 Alpha 3 country code. This value cannot be null.

getMrzLine1

public String getMrzLine1 ()

Returns the first MRZ line as found on the back of the ID card.

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

getMrzLine2

public String getMrzLine2 ()

Returns the second MRZ line as found on the back of the ID card.

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

getMrzLine3

public String getMrzLine3 ()

Returns the third MRZ line as found on the back of the ID card.

Returns
String	The third MRZ line. 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.

getOptionalData1

public String getOptionalData1 ()

Returns the first optional data as found on the back of the ID card.

Returns
String	The first optional data.

getOptionalData2

public String getOptionalData2 ()

Returns the second optional data as found on the back of the ID card.

Returns
String	The second optional data.

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.