Identity Android
1.16
Search
⌃K
Comment on page

KenyaIDCardModel

A class derived from IDCardModel containing details specific to the Kenya ID card
import com.sybrin.identity.countries.Kenya.IDCard.KenyaIDCardModel
extends IDCardModel​

Summary

Public methods
​
Data source
int
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
int
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.
PDF417 Barcode

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
Serial Number

Component verification

As explained in Validation & Verification the following fields are verified across the front and back components of the document.
Value
Source
Serial number
Front: OCR
Back: MRZ OCR

Public methods

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
​
​

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
​
​

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.
​

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.
​

getSerialNumber

public String getSerialNumber ()
Returns the subject's serial number as found on the back of the ID card.
Returns
​
String
The subject's serial number. This value cannot be null.
​

getSerialNumberCheckDigit

public int getSerialNumberCheckDigit ()
Returns the check digit used to verify the subject's serial number as found on the ID card.
Returns
​
int
​
Previous
IdentityScanner.OnSuccessListener
Next
KenyaPassportModel
Last modified 1yr ago