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
​getCompositeCheckDigit()
MRZ OCR
int
​getDateOfBirthCheckDigit()
MRZ OCR
Date
​getDateOfExpiry()
MRZ OCR
int
​getDateOfExpiryCheckDigit()
MRZ OCR
String
​getMrzLine1()
MRZ OCR
String
​getMrzLine2()
MRZ OCR
String
​getMrzLine3()
MRZ OCR
String
​getOptionalData1()
MRZ OCR
String
​getOptionalData2()
MRZ OCR
String
​getSerialNumber()
MRZ OCR
int
​getSerialNumberCheckDigit()
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.
PDF417 Barcode
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.
Serial 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
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
​

IdentityScanner.OnSuccessListener

KenyaPassportModel

Last modified 6mo ago

Public methods		Data source
int	getCompositeCheckDigit()	MRZ OCR
int	getDateOfBirthCheckDigit()	MRZ OCR
Date	getDateOfExpiry()	MRZ OCR
int	getDateOfExpiryCheckDigit()	MRZ OCR
String	getMrzLine1()	MRZ OCR
String	getMrzLine2()	MRZ OCR
String	getMrzLine3()	MRZ OCR
String	getOptionalData1()	MRZ OCR
String	getOptionalData2()	MRZ OCR
String	getSerialNumber()	MRZ OCR
int	getSerialNumberCheckDigit()	MRZ OCR

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.	PDF417 Barcode

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.
Serial Number	Check digit using MRP Checksum calculation algorithm.

Value	Source
Serial number	Front: OCR Back: MRZ OCR

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

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

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

Returns
String	The third MRZ line. This value cannot be `null`.

Returns
String	The subject's serial number. This value cannot be `null`.