PassportModel

A class derived from DocumentModel containing details pertaining to all passport documents

import com.sybrin.identity.models.PassportModel
extends DocumentModel​
Summary
Public methods
​
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
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
Public methods
getDateOfBirth
public Date getDateOfBirth ()
Returns the subject's date of birth as found on the passport.
Returns
​
Date
The subject's date of birth. This value cannot be null.
​
getDateOfExpiry
public Date getDateOfExpiry ()
Returns the passport's date of expiry as found on the passport.
Returns
​
Date
The passport's date of expiry. This value cannot be null.
​
getIssuingCountryCode
public String getIssuingCountryCode ()
Returns the country code of the country the passport was issued in as found on the passport.
Returns
​
String
The passport's issuing country code. This value cannot be null.
​
getNames
public String getNames ()
Returns the subject's names as found on the green book document.
Returns
​
String
The subject's names. This value cannot be null.
​
getNationality
public String getNationality ()
Returns the subject's nationality as found on the passport.
Returns
​
String
The subject's nationality. This value cannot be null.
​
getPassportNumber
public String getPassportNumber ()
Returns the passport number as found on the passport.
Returns
​
String
The passport number. This value cannot be null.
​
getPassportType
public String getPassportType ()
Returns the passport's type as found on the passport.
Returns
​
String
The passport type. This value cannot be null.
​
getSex
public String getSex ()
Returns the subject's sex as found on the passport.
Returns
​
​Sex​
This value cannot be null.
​
getSurname
public String getSurname ()
Returns the subject's surname as found on the passport.
Returns
​
String
The subject's surname. This value cannot be null.

NigeriaPassportModel

PakistanPassportModel

Last modified 6mo ago

Public methods		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

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

Returns
Date	The subject's date of birth. This value cannot be `null`.

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

Returns
String	The passport's issuing country code. This value cannot be `null`.

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

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

Returns
String	The passport number. This value cannot be `null`.

Returns
String	The passport type. This value cannot be `null`.

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