Kofax Mobile SDK API Reference
Properties | List of all members
kfxPassportData Class Reference

This object represents passport data. More...

#import <kfxPassportData.h>

Inheritance diagram for kfxPassportData:
kfxCaptureData

Properties

kfxDataFieldfirstName
 First name. More...
 
kfxDataFieldmiddleName
 Middle name. More...
 
kfxDataFieldlastName
 Last name. More...
 
kfxDataFielddateOfBirth
 Birth date. More...
 
kfxDataFieldgender
 Gender. More...
 
kfxDataFieldissueDate
 ID issue date. More...
 
kfxDataFieldexpirationDate
 ID expiration date. More...
 
kfxDataFieldpassportNumber
 Passport number. More...
 
kfxDataFieldcountry
 Country short name. More...
 
kfxDataFieldcountryLong
 Country full name. More...
 
kfxDataFieldnationality
 Nationality. More...
 
kfxDataFieldpersonalNumber
 Personal number. More...
 
kfxDataFieldMRZ1
 Machine readable zone 1. More...
 
kfxDataFieldMRZ2
 Machine readable zone 2. More...
 
NSString * rawData
 Raw data. 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 passport data.

Contains the information extracted from passport image.

Property Documentation

- (kfxDataField*) country
readwritenonatomicstrong

Country short name.

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

See also
kfxDataField
- (kfxDataField*) countryLong
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*) dateOfBirth
readwritenonatomicstrong

Birth date.

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

See also
kfxDataField
- (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*) 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*) 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 last name. 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*) MRZ1
readwritenonatomicstrong

Machine readable zone 1.

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

See also
kfxDataField
- (kfxDataField*) MRZ2
readwritenonatomicstrong

Machine readable zone 2.

This property contains the MRZ2. 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
- (kfxDataField*) passportNumber
readwritenonatomicstrong

Passport number.

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

See also
kfxDataField
- (kfxDataField*) personalNumber
readwritenonatomicstrong

Personal number.

This property contains the personal number. 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.


The documentation for this class was generated from the following file:
Untitled Document © 2018 Kofax, Inc. All rights reserved. Use is subject to license terms.