ID Extraction Result. More...
#import <kfxKOEIDExtractor.h>
Properties | |
| BOOL | isBarcodeRead |
| Barcode read success indicator. More... | |
| BOOL | isOcrRead |
| OCR success indicator. More... | |
| float | documentVerificationConfidenceRating |
| ID verification confidence rating. More... | |
| NSArray * | fields |
| An array of extracted fields. More... | |
| kfxKEDClassificationResult * | frontClassification |
| Front side classification result. More... | |
| kfxKEDClassificationResult * | backClassification |
| Back side classification result. More... | |
| kfxKOEImageField * | faceImageField |
| The face image field. More... | |
| kfxKOEImageField * | signatureImageField |
| The signature image field. More... | |
Detailed Description
Property Documentation
|
readwritenonatomicstrong |
Back side classification result.
Contains back side image classification result. Nil if back image was not provided for extraction or if back image classification failed.
Classification is considered as failed if classification confidence value returned by classifier is negative. Any non-negative confidence is considered as a successful classification. There is no determined range confidence value can take; higher values mean higher credibility.
Default value is nil.
- See also
- kfxKEDClassificationResult
|
readwritenonatomicassign |
ID verification confidence rating.
Provides the confidence rating that specified ID was verified. Can take the following values:
- 0 if front side was not provided or failed to be extracted.
- 50 if front data was extracted successfully and back side wasn't (or wasn't provided).
- from 50 to 100 if both sides were extracted successfully. Actual value will depend on difference between front and back values. Higher value means a better match.
Default value is 0.0.
|
readwritenonatomicstrong |
The face image field.
The optional identification photo field extracted from the front or back image.
Will return nil if face extraction was disabled, or an identification photo was not found.
Default value is nil.
|
readwritenonatomicstrong |
An array of extracted fields.
Array of kfxKOEDataField objects.
Default value is nil.
- See also
- kfxKOEDataField
|
readwritenonatomicstrong |
Front side classification result.
Contains front side image classification result. Nil if front image was not provided for extraction or if front image classification failed.
Classification is considered as failed if classification confidence value returned by classifier is negative. Any non-negative confidence is considered as a successful classification. There is no determined range confidence value can take; higher values mean higher credibility.
Default value is nil.
- See also
- kfxKEDClassificationResult
|
readwritenonatomicassign |
Barcode read success indicator.
YES if barcode data was provided and extracted successfully (either from image or barcode string), NO otherwise.
Default value is NO.
|
readwritenonatomicassign |
OCR success indicator.
YES if data was provided and extracted successfully, NO otherwise.
Default value is NO.
|
readwritenonatomicstrong |
The signature image field.
The optional signature image field extracted from the front or back image.
Will return nil if signature extraction was disabled, or a signature image was not found.
Default value is nil.
The documentation for this class was generated from the following file: