Kofax Mobile SDK API Reference: kfxIDData Class Reference

Kofax Mobile SDK API Reference

This object represents id document data. More...

#import <kfxIDData.h>

Inheritance diagram for kfxIDData:

Properties
kfxDataField *	firstName
	First name. More...

kfxDataField *	middleName
	Middle name. More...

kfxDataField *	lastName
	Last name. More...

kfxDataField *	idNumber
	ID number. More...

kfxDataField *	dateOfBirth
	Birth date. More...

kfxDataField *	address
	Address line. More...

kfxDataField *	gender
	Gender. More...

kfxDataField *	zip
	Address ZIP code. More...

kfxDataField *	state
	Address state name. More...

kfxDataField *	city
	Address city name. More...

kfxDataField *	nameSuffix
	Name suffix. More...

kfxDataField *	address2
	Additional address line 2. More...

kfxDataField *	address3
	Additional address line 3. More...

kfxDataField *	address4
	Additional address line 4. More...

kfxDataField *	address5
	Additional address line 5. More...

kfxDataField *	address6
	Additional address line 6. More...

kfxDataField *	idClass
	Class. More...

kfxDataField *	countryShort
	Country short name. More...

kfxDataField *	country
	Country full name. More...

kfxDataField *	expirationDate
	ID expiration date. More...

kfxDataField *	eyes
	Eyes color. More...

kfxDataField *	hair
	Hair color. More...

kfxDataField *	height
	Height. More...

kfxDataField *	issueDate
	ID issue date. More...

kfxDataField *	nationality
	Nationality. More...

kfxDataField *	weight
	Weight. More...

kfxDataField *	license
	License number. More...

kfxDataField *	documentState
	Document state. More...

kfxDataField *	documentType
	Document type. More...

BOOL	isBarcodeRead
	isBarcodeRead value. More...

BOOL	isOcrRead
	isOcrRead value. More...

BOOL	isIDVerified
	isIDVerified value. More...

CGFloat	documentVerificationConfidenceRating
	Document verification confidence rating. More...

NSString *	faceImageId
	Identifier for the ID face image. More...

NSString *	signatureImageId
	Identifier for the ID signature image. More...

NSString *	rawData
	Raw data. More...

NSString *	barcode
	Barcode. More...

Properties inherited from kfxCaptureData
NSString *	originalImage
	Identifier for the image captured by capture view controller classes. More...

NSString *	processedImage
	Identifier for the image processed by image processor. More...

Detailed Description

This object represents id document data.

Contains the information extracted from id image.

Property Documentation

- (kfxDataField*) address

readwritenonatomicstrong

Address line.

This property contains the person's address. The value string is empty if the extraction of this field is unsuccessfull.

See also: kfxDataField

- (kfxDataField*) address2

readwritenonatomicstrong

Additional address line 2.

This property contains the additional address line. The value string is empty if the extraction of this field is unsuccessfull.

See also: kfxDataField

- (kfxDataField*) address3

readwritenonatomicstrong

Additional address line 3.

This property contains the additional address line. The value string is empty if the extraction of this field is unsuccessfull.

See also: kfxDataField

- (kfxDataField*) address4

readwritenonatomicstrong

Additional address line 4.

This property contains the additional address line. The value string is empty if the extraction of this field is unsuccessfull.

See also: kfxDataField

- (kfxDataField*) address5

readwritenonatomicstrong

Additional address line 5.

This property contains the additional address line. The value string is empty if the extraction of this field is unsuccessfull.

See also: kfxDataField

- (kfxDataField*) address6

readwritenonatomicstrong

Additional address line 6.

This property contains the additional address line. The value string is empty if the extraction of this field is unsuccessfull.

See also: kfxDataField

- (NSString*) barcode

readwritenonatomicstrong

Barcode.

This property contains barcode string. Default value is nil.

- (kfxDataField*) city

readwritenonatomicstrong

Address city name.

This property contains the city name. The value string is empty if the extraction of this field is unsuccessfull.

See also: kfxDataField

- (kfxDataField*) country

readwritenonatomicstrong

Country full name.

This property contains the full country name. The value string is empty if the extraction of this field is unsuccessfull.

See also: kfxDataField

- (kfxDataField*) countryShort

readwritenonatomicstrong

Country short name.

This property contains the country short identifier. The value string is empty if the extraction of this field is unsuccessfull.

See also: kfxDataField

- (kfxDataField*) dateOfBirth

readwritenonatomicstrong

Birth date.

This property contains the person's birth date. When automatically populated, the value string has yyyy-mm-dd format. The value string is empty if the extraction of this field is unsuccessfull.

See also: kfxDataField

- (kfxDataField*) documentState

readwritenonatomicstrong

Document state.

This property contains the document state. The value string is empty if the extraction of this field is unsuccessfull.

See also: kfxDataField

- (kfxDataField*) documentType

readwritenonatomicstrong

Document type.

This property contains the document type. The value string is empty if the extraction of this field is unsuccessfull.

See also: kfxDataField

- (CGFloat) documentVerificationConfidenceRating

readwritenonatomicassign

Document verification confidence rating.

This property contains the id verification confidence rating. May take values from 0 to 100.

Default value is 0.

- (kfxDataField*) expirationDate

readwritenonatomicstrong

ID expiration date.

This property contains the ID expiration date. When automatically populated, the value string has yyyy-mm-dd format. The value string is empty if the extraction of this field is unsuccessfull.

See also: kfxDataField

- (kfxDataField*) eyes

readwritenonatomicstrong

Eyes color.

This property contains the person's eyes color. The value string is empty if the extraction of this field is unsuccessfull.

See also: kfxDataField

- (NSString*) faceImageId

readwritenonatomicstrong

Identifier for the ID face image.

This property contains the identifier for ID face image. Nil if the extraction of this field is unsuccessfull.

- (kfxDataField*) firstName

readwritenonatomicstrong

First name.

This property contains the person's first name. The value string is empty if the extraction of this field is unsuccessfull.

See also: kfxDataField

- (kfxDataField*) gender

readwritenonatomicstrong

Gender.

This property contains the person's gender. When automatically populated, the value string is "M" or "F". The value string is empty if the extraction of this field is unsuccessfull.

See also: kfxDataField

- (kfxDataField*) hair

readwritenonatomicstrong

Hair color.

This property contains the person's hair color. The value string is empty if the extraction of this field is unsuccessfull.

See also: kfxDataField

- (kfxDataField*) height

readwritenonatomicstrong

Height.

This property contains the person's height. The value string is empty if the extraction of this field is unsuccessfull.

See also: kfxDataField

- (kfxDataField*) idClass

readwritenonatomicstrong

Class.

This property contains the driver license class. The value string is empty if the extraction of this field is unsuccessfull.

See also: kfxDataField

- (kfxDataField*) idNumber

readwritenonatomicstrong

ID number.

This property contains the id number for this this IDData object. The value string is empty if the extraction of this field is unsuccessfull.

See also: kfxDataField

- (BOOL) isBarcodeRead

readwritenonatomicassign

isBarcodeRead value.

This property defines if the barcode has been read.

Default value is false.

- (BOOL) isIDVerified

readwritenonatomicassign

isIDVerified value.

This property defines if the ID has been verified.

Default value is false.

- (BOOL) isOcrRead

readwritenonatomicassign

isOcrRead value.

This property defines if the OCR has been read.

Default value is false.

- (kfxDataField*) issueDate

readwritenonatomicstrong

ID issue date.

This property contains the ID issue date. When automatically populated, the value string has yyyy-mm-dd format. The value string is empty if the extraction of this field is unsuccessfull.

See also: kfxDataField

- (kfxDataField*) lastName

readwritenonatomicstrong

Last name.

This property contains the person's first name. The value string is empty if the extraction of this field is unsuccessfull.

See also: kfxDataField

- (kfxDataField*) license

readwritenonatomicstrong

License number.

This property contains the driver license number. The value string is empty if the extraction of this field is unsuccessfull.

See also: kfxDataField

- (kfxDataField*) middleName

readwritenonatomicstrong

Middle name.

This property contains the person's middle name. The value string is empty if the extraction of this field is unsuccessfull.

See also: kfxDataField

- (kfxDataField*) nameSuffix

readwritenonatomicstrong

Name suffix.

This property contains the person's name suffix. The value string is empty if the extraction of this field is unsuccessfull.

See also: kfxDataField

- (kfxDataField*) nationality

readwritenonatomicstrong

Nationality.

This property contains the person's nationality. The value string is empty if the extraction of this field is unsuccessfull.

See also: kfxDataField

- (NSString*) rawData

readwritenonatomicstrong

Raw data.

This property contains raw JSON string with response from extraction server.

- (NSString*) signatureImageId

readwritenonatomicstrong

Identifier for the ID signature image.

This property contains the identifier for ID signature image. Nil if the extraction of this field is unsuccessfull.

- (kfxDataField*) state

readwritenonatomicstrong

Address state name.

This property contains the state name. The value string is empty if the extraction of this field is unsuccessfull.

See also: kfxDataField

- (kfxDataField*) weight

readwritenonatomicstrong

Weight.

This property contains the person's weight. The value string is empty if the extraction of this field is unsuccessfull.

See also: kfxDataField

- (kfxDataField*) zip

readwritenonatomicstrong

Address ZIP code.

This property contains the zip code. The value string is empty if the extraction of this field is unsuccessfull.

See also: kfxDataField

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

kfxIDData.h

Untitled Document © 2018 Kofax, Inc. All rights reserved. Use is subject to license terms.