IDCardModel

A class derived from DocumentModel containing details pertaining to all ID card documents

import com.sybrin.identity.models.IDCardModel

extends DocumentModel

Summary

Public methods

Data source

Bitmap

Back of document

String

Local Storage

Date

PDF417 Barcode / OCR

Bitmap

Back of document

String

Local Storage

String

PDF417 Barcode / OCR

String

PDF417 Barcode / OCR

String

PDF417 Barcode / OCR

Bitmap

Back of document

String

Local Storage

getSex()

Returns the subject's sex as

found on the ID card.

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

Public methods

getCroppedDocumentBackImage

public Bitmap getCroppedDocumentBackImage ()

Returns a cropped image of the back of the scanned document.

Returns

Bitmap

This value cannot be null.

getCroppedDocumentBackImagePath

public String getCroppedDocumentBackImagePath ()

Returns the file path of the saved cropped back of the document image.

Returns

String

Value is null if image was not saved.

getDateOfBirth

public Date getDateOfBirth ()

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

Returns

Date

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

getDocumentBackImage

public Bitmap getCroppedDocumentBackImage ()

Returns an image of the back of the scanned document.

Returns

Bitmap

This value cannot be null.

getDocumentBackImagePath

public String getCroppedDocumentBackImagePath ()

Returns the file path of the saved back of the document image.

Returns

String

Value is null if image was not saved.

getFullName

public String getFullName ()

Returns the subject's full name as found on the ID card.

Returns

String

The subject's full name. This value cannot be null.

getIdentityNumber

public String getIdentityNumber ()

Returns the subject's identity number as found on the ID card.

Returns

String

The subject's identity number. This value cannot be null.

getNationality

public String getNationality ()

Returns the subject's nationality as found on the ID card.

Returns

String

The subject's country of birth. This value cannot be null.

getPortraitBackImage

public Bitmap getPortraitBackImage ()

Returns an image of the portrait on the back of the scanned document.

Returns

Bitmap

This value can be null.

getPortraitBackImagePath

public String getPortraitBackImagePath ()

Returns the file path of the saved portrait on the back of the document image.

Returns

String

Value is null if image was not saved.

getSex

public String getSex ()

Returns the subject's sex as found on the ID card.

Returns

This value cannot be null.