SBSDKIDCardRecognizerResult

@interface SBSDKIDCardRecognizerResult : NSObject

The result of an ID card detection or recognition. Summarizes general information from the ID card scan and individual data fields.


                    
                    
                    recognitionSuccessful

YES, if the recognition was successful, No otherwise.

Objective-C

@property (nonatomic) BOOL recognitionSuccessful;

Swift

var recognitionSuccessful: Bool { get set }


                    
                    
                    recognitionStatus

The exact status of the recognition.

Objective-C

@property (nonatomic) SBSDKIDCardRecognitionStatus recognitionStatus;

Swift

var recognitionStatus: SBSDKIDCardRecognitionStatus { get set }


                    
                    
                    type

The type of the recognized ID card.

Objective-C

@property (nonatomic, strong) SBSDKIDCardType *_Nonnull type;

Swift

var type: SBSDKIDCardType { get set }


                    
                    
                    fields

An array containing all recognized data fields of the ID card.

Objective-C

@property (nonatomic, strong) NSArray<SBSDKIDCardRecognizerResultField *> *_Nonnull fields;

Swift

var fields: [SBSDKIDCardRecognizerResultField] { get set }


                    
                    
                    mrzFields

An array containing all recognized machine readable zone fields of the ID card.

Objective-C

@property (nonatomic, strong) NSArray<SBSDKMachineReadableZoneRecognizerField *> *_Nonnull mrzFields;

Swift

var mrzFields: [SBSDKMachineReadableZoneRecognizerField] { get set }


                    
                    
                    mrzCheckDigits

An array containing all recognized machine readable zone check digits of the ID card.

Objective-C

@property (nonatomic, strong) NSArray<SBSDKMachineReadableZoneRecognizerResultCheckDigit *> *_Nonnull mrzCheckDigits;

Swift

var mrzCheckDigits: [SBSDKMachineReadableZoneRecognizerResultCheckDigit] { get set }


                    
                    
                    croppedImage

A perspective-corrected cropped image from the recognized ID card.

Objective-C

@property (nonatomic, strong) UIImage *_Nonnull croppedImage;

Swift

var croppedImage: UIImage { get set }