Id Class Reference

Inheritance diagram for Id:

Public Member Functions
abstract Field< String >	getFirstName ()
abstract Field< String >	getMiddleName ()
abstract Field< String >	getLastName ()
abstract Field< String >	getIdNumber ()
abstract Field< String >	getDateOfBirth ()
abstract Field< String >	getAddress ()
abstract Field< String >	getGender ()
abstract Field< String >	getZip ()
abstract Field< String >	getState ()
abstract Field< String >	getCity ()
abstract Field< String >	getNameSuffix ()
abstract Field< String >	getAddress2 ()
abstract Field< String >	getAddress3 ()
abstract Field< String >	getAddress4 ()
abstract Field< String >	getAddress5 ()
abstract Field< String >	getAddress6 ()
abstract Field< String >	getIdClass ()
abstract Field< String >	getCountryShort ()
abstract Field< String >	getCountry ()
abstract Field< String >	getExpirationDate ()
abstract Field< String >	getEyes ()
abstract Field< String >	getHair ()
abstract Field< String >	getHeight ()
abstract Field< String >	getIssueDate ()
abstract Field< String >	getNationality ()
abstract Field< String >	getWeight ()
abstract Field< String >	getLicense ()
abstract Field< String >	isBarcodeRead ()
abstract Field< String >	isOcrRead ()
abstract Field< String >	getDocumentVerificationConfidenceRating ()
abstract Bitmap	getSignatureImage ()
abstract Bitmap	getFaceImage ()
Field< String >	getDocumentType ()
Field< String >	getDocumentState ()
abstract String	getRawData ()

Additional Inherited Members
Public Attributes inherited from CaptureData
String	capturedImageId = ""
String	processedImageId = ""

Detailed Description

Each of these fields returns a platform-dependent and jurisdiction-dependent value. For example getEyes() may return BLU or Blue. The fields will return what the card displays, or what is encoded in a barcode string, depending on what was passed to the extractor.

In some cases, depending on the technology being used (e.g. on-device extraction, or server extraction) the field values may be normalized. Fields such as getGender() may return M where the ID may have Male printed. Please refer to the Kofax Mobile ID Capture Administrator’s Guide for more information.

Member Function Documentation

abstract Field<String> getAddress ( )

abstract

Returns

The persons aggregate address (may contain elements from other address fields, such as getAddress2(), etc)

abstract Field<String> getAddress2 ( )

abstract

Returns

An address part, may be aggregated into getAddress()

abstract Field<String> getAddress3 ( )

abstract

Returns

An address part, may be aggregated into getAddress()

abstract Field<String> getAddress4 ( )

abstract

Returns

An address part, may be aggregated into getAddress()

abstract Field<String> getAddress5 ( )

abstract

Returns

An address part, may be aggregated into getAddress()

abstract Field<String> getAddress6 ( )

abstract

Returns

An address part, may be aggregated into getAddress()

abstract Field<String> getCity ( )

abstract

Returns

The address city

abstract Field<String> getCountry ( )

abstract

Returns

The ID country

abstract Field<String> getCountryShort ( )

abstract

Returns

The ID country abbreviation

abstract Field<String> getDateOfBirth ( )

abstract

Returns

The person's date of birth

Field<String> getDocumentState

(

)

Returns

getState()

Field<String> getDocumentType

(

)

The document type, e.g. "ID", "DL".

Returns

"ID" by default

abstract Field<String> getDocumentVerificationConfidenceRating ( )

abstract

Returns

The confidence rating

abstract Field<String> getExpirationDate ( )

abstract

Returns

The ID expiration date

abstract Field<String> getEyes ( )

abstract

Returns

The person's eye color

abstract Bitmap getFaceImage ( )

abstract

Returns

The ID image

abstract Field<String> getFirstName ( )

abstract

Returns

The person's first name

abstract Field<String> getGender ( )

abstract

Returns

The person's gender

abstract Field<String> getHair ( )

abstract

Returns

The person's hair color

abstract Field<String> getHeight ( )

abstract

Returns

The person's height

abstract Field<String> getIdClass ( )

abstract

Returns

The ID class

abstract Field<String> getIdNumber ( )

abstract

Returns

The ID number

abstract Field<String> getIssueDate ( )

abstract

Returns

The ID date of issue

abstract Field<String> getLastName ( )

abstract

Returns

The person's last name

abstract Field<String> getLicense ( )

abstract

Returns

The ID number field

abstract Field<String> getMiddleName ( )

abstract

Returns

The person's middle name

abstract Field<String> getNameSuffix ( )

abstract

Returns

The person's name suffix, e.g. Jr., Sr.

abstract Field<String> getNationality ( )

abstract

Returns

The person's nationality

abstract String getRawData ( )

abstract

Returns

The raw data returned from the extractor

abstract Bitmap getSignatureImage ( )

abstract

Returns

The image of the signature area

abstract Field<String> getState ( )

abstract

Returns

The address state

abstract Field<String> getWeight ( )

abstract

Returns

The person's weight

abstract Field<String> getZip ( )

abstract

Returns

The address zip code

abstract Field<String> isBarcodeRead ( )

abstract

Returns

Whether the ID Barcode was read and parsed

abstract Field<String> isOcrRead ( )

abstract

Returns

Whether Optical Character Recognition was used

---

The documentation for this class was generated from the following file:

• Id.java