Identity Android
1.16
Search
⌃K

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
MRZ OCR
int
MRZ OCR
int
MRZ OCR
Date
MRZ OCR
int
MRZ OCR
Date
MRZ OCR
int
MRZ OCR
String
MRZ OCR
String
MRZ OCR
String
MRZ OCR
String
MRZ OCR
String
MRZ OCR
String
MRZ OCR
String
MRZ OCR
String
MRZ OCR

Inherited methods

​
Data source
<T extends DocumentModel>
​castToModel(Class<T> class)
​
Casts the current model to the
type specified by the class parameter.
N/A
Bitmap
Front of document
String
Local storage
Bitmap
Front of document
String
Local storage
Bitmap
Front of document
String
Local storage
void
​saveImages(Context context)
​
Saves all images within the model
to the local device and populates
all path fields.
N/A
​
Data source
Bitmap
Back of document
String
Local Storage
Date
MRZ OCR
Bitmap
Back of document
String
Local Storage
String
MRZ OCR
String
MRZ OCR
String
MRZ OCR
Bitmap
Back of document
String
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
Date of expiry
MRZ line 1 & 2 composite
Card Number

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.
Previous
TanzaniaPassportModel
Next
UgandaPassportModel
Last modified 6mo ago