Kofax Mobile SDK API Reference
kfxIDData.h
Go to the documentation of this file.
1 //
2 // API Reference
3 // kfxIDData.h
4 // Framework: MobileSDK
5 //
6 // Copyright (c) 2012 - 2017 Kofax. Use of this code is with permission pursuant to Kofax license terms.
7 
8 #import <MobileSDK/kfxCaptureData.h>
9 
10 @class kfxDataField;
11 
13 
19 
21 
26 @property (nonatomic, strong) kfxDataField* firstName;
27 
29 
34 @property (nonatomic, strong) kfxDataField* middleName;
35 
37 
42 @property (nonatomic, strong) kfxDataField* lastName;
43 
45 
50 @property (nonatomic, strong) kfxDataField* idNumber;
51 
53 
58 @property (nonatomic, strong) kfxDataField* dateOfBirth;
59 
61 
66 @property (nonatomic, strong) kfxDataField* address;
67 
69 
74 @property (nonatomic, strong) kfxDataField* gender;
75 
77 
82 @property (nonatomic, strong) kfxDataField* zip;
83 
85 
90 @property (nonatomic, strong) kfxDataField* state;
91 
93 
98 @property (nonatomic, strong) kfxDataField* city;
99 
101 
106 @property (nonatomic, strong) kfxDataField* nameSuffix;
107 
109 
114 @property (nonatomic, strong) kfxDataField* address2;
115 
117 
122 @property (nonatomic, strong) kfxDataField* address3;
123 
125 
130 @property (nonatomic, strong) kfxDataField* address4;
131 
133 
138 @property (nonatomic, strong) kfxDataField* address5;
139 
141 
146 @property (nonatomic, strong) kfxDataField* address6;
147 
149 
154 @property (nonatomic, strong) kfxDataField* idClass;
155 
157 
162 @property (nonatomic, strong) kfxDataField* countryShort;
163 
165 
170 @property (nonatomic, strong) kfxDataField* country;
171 
173 
178 @property (nonatomic, strong) kfxDataField* expirationDate;
179 
181 
186 @property (nonatomic, strong) kfxDataField* eyes;
187 
189 
194 @property (nonatomic, strong) kfxDataField* hair;
195 
197 
202 @property (nonatomic, strong) kfxDataField* height;
203 
205 
210 @property (nonatomic, strong) kfxDataField* issueDate;
211 
213 
218 @property (nonatomic, strong) kfxDataField* nationality;
219 
221 
226 @property (nonatomic, strong) kfxDataField* weight;
227 
229 
234 @property (nonatomic, strong) kfxDataField* license;
235 
237 
242 @property (nonatomic, strong) kfxDataField* documentState;
243 
245 
250 @property (nonatomic, strong) kfxDataField* documentType;
251 
253 
258 @property (nonatomic, assign) BOOL isBarcodeRead;
259 
261 
266 @property (nonatomic, assign) BOOL isOcrRead;
267 
269 
274 @property (nonatomic, assign) BOOL isIDVerified;
275 
277 
282 @property (nonatomic, assign) CGFloat documentVerificationConfidenceRating;
283 
285 
288 @property (nonatomic, strong) NSString* faceImageId;
289 
291 
294 @property (nonatomic, strong) NSString* signatureImageId;
295 
297 
300 @property (nonatomic, strong) NSString* rawData;
301 
303 
306 @property (nonatomic, strong) NSString* barcode;
307 
308 @end
kfxIDData::documentType
kfxDataField * documentType
Document type.
Definition: kfxIDData.h:250
kfxIDData::countryShort
kfxDataField * countryShort
Country short name.
Definition: kfxIDData.h:162
kfxIDData::lastName
kfxDataField * lastName
Last name.
Definition: kfxIDData.h:42
kfxIDData::nationality
kfxDataField * nationality
Nationality.
Definition: kfxIDData.h:218
kfxIDData::height
kfxDataField * height
Height.
Definition: kfxIDData.h:202
kfxIDData::state
kfxDataField * state
Address state name.
Definition: kfxIDData.h:90
kfxIDData::isOcrRead
BOOL isOcrRead
isOcrRead value.
Definition: kfxIDData.h:266
kfxIDData::isIDVerified
BOOL isIDVerified
isIDVerified value.
Definition: kfxIDData.h:274
barcode
barcode
Barcode enum to define barcode types to find, or those found.
Definition: kfxKEDBarcodeResult.h:14
kfxIDData::signatureImageId
NSString * signatureImageId
Identifier for the ID signature image.
Definition: kfxIDData.h:294
kfxIDData::hair
kfxDataField * hair
Hair color.
Definition: kfxIDData.h:194
kfxDataField
Data field object.
Definition: kfxDataField.h:21
kfxIDData::documentState
kfxDataField * documentState
Document state.
Definition: kfxIDData.h:242
kfxIDData::eyes
kfxDataField * eyes
Eyes color.
Definition: kfxIDData.h:186
kfxIDData::address2
kfxDataField * address2
Additional address line 2.
Definition: kfxIDData.h:114
kfxIDData::address6
kfxDataField * address6
Additional address line 6.
Definition: kfxIDData.h:146
kfxIDData::isBarcodeRead
BOOL isBarcodeRead
isBarcodeRead value.
Definition: kfxIDData.h:258
kfxIDData::idNumber
kfxDataField * idNumber
ID number.
Definition: kfxIDData.h:50
kfxIDData::faceImageId
NSString * faceImageId
Identifier for the ID face image.
Definition: kfxIDData.h:288
kfxIDData::documentVerificationConfidenceRating
CGFloat documentVerificationConfidenceRating
Document verification confidence rating.
Definition: kfxIDData.h:282
kfxIDData::country
kfxDataField * country
Country full name.
Definition: kfxIDData.h:170
kfxIDData
This object represents id document data.
Definition: kfxIDData.h:18
kfxCaptureData
Base class for document data objects.
Definition: kfxCaptureData.h:16
kfxIDData::nameSuffix
kfxDataField * nameSuffix
Name suffix.
Definition: kfxIDData.h:106
kfxIDData::address
kfxDataField * address
Address line.
Definition: kfxIDData.h:66
kfxIDData::license
kfxDataField * license
License number.
Definition: kfxIDData.h:234
kfxIDData::expirationDate
kfxDataField * expirationDate
ID expiration date.
Definition: kfxIDData.h:178
kfxIDData::zip
kfxDataField * zip
Address ZIP code.
Definition: kfxIDData.h:82
kfxIDData::rawData
NSString * rawData
Raw data.
Definition: kfxIDData.h:300
kfxIDData::gender
kfxDataField * gender
Gender.
Definition: kfxIDData.h:74
kfxIDData::city
kfxDataField * city
Address city name.
Definition: kfxIDData.h:98
kfxIDData::address5
kfxDataField * address5
Additional address line 5.
Definition: kfxIDData.h:138
kfxIDData::dateOfBirth
kfxDataField * dateOfBirth
Birth date.
Definition: kfxIDData.h:58
kfxIDData::weight
kfxDataField * weight
Weight.
Definition: kfxIDData.h:226
kfxIDData::address3
kfxDataField * address3
Additional address line 3.
Definition: kfxIDData.h:122
kfxIDData::idClass
kfxDataField * idClass
Class.
Definition: kfxIDData.h:154
kfxIDData::firstName
kfxDataField * firstName
First name.
Definition: kfxIDData.h:26
kfxIDData::address4
kfxDataField * address4
Additional address line 4.
Definition: kfxIDData.h:130
kfxIDData::issueDate
kfxDataField * issueDate
ID issue date.
Definition: kfxIDData.h:210
kfxIDData::middleName
kfxDataField * middleName
Middle name.
Definition: kfxIDData.h:34
Untitled Document © 2021 Kofax, Inc. All rights reserved. Use is subject to license terms.