SBSDKCheckRecognizerViewController

@interface SBSDKCheckRecognizerViewController : SBSDKBaseScannerViewController

Classic UI view controller that can be used to detect and recognize bank checks. Can be configured to recognize on video frames or, for better accuracy, on high-res photos that are automatically captured.

  • The current state of the check scanner.

    Declaration

    Objective-C

    @property (nonatomic, readonly) SBSDKCheckRecognizerState state;

    Swift

    var state: SBSDKCheckRecognizerState { get }

  • An array of accepted check types. By default all check types are allowed.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSArray<SBSDKCheckDocumentRootType *> *_Nonnull acceptedCheckTypes;

    Swift

    var acceptedCheckTypes: [SBSDKCheckDocumentRootType] { get set }

  • If set to YES a high-resolution photo of the check is captured to run the recognition on. Upon successful recognition the recognition result also contains a high-resolution image of the check. If set to NO, the video frames will be used for recognition and result image delivery. The default value is YES.

    Declaration

    Objective-C

    @property (nonatomic) BOOL captureHighResolutionImage;

    Swift

    var captureHighResolutionImage: Bool { get set }

  • If set to YES, check recognition results that failed their validation will not be provided to the delegate. Set to NO, if you are interested also in invalid results. The default value is YES.

    Declaration

    Objective-C

    @property (nonatomic) BOOL ignoreInvalidResults;

    Swift

    var ignoreInvalidResults: Bool { get set }

  • The delegate of the receiver.

    Declaration

    Objective-C

    @property (nonatomic, weak, nullable) id<SBSDKCheckRecognizerViewControllerDelegate> delegate;

    Swift

    weak var delegate: SBSDKCheckRecognizerViewControllerDelegate? { get set }

  • Installs the receiver as child view controller onto the parent view controllers view using its entire bounds area.

    Declaration

    Objective-C

    - (nullable instancetype)
    initWithParentViewController:
        (nonnull UIViewController *)parentViewController
                      parentView:(nonnull UIView *)parentView
                        delegate:
                            (nullable
                                 id<SBSDKCheckRecognizerViewControllerDelegate>)
                                delegate;

    Swift

    init?(parentViewController: UIViewController, parentView: UIView, delegate: SBSDKCheckRecognizerViewControllerDelegate?)

    Parameters

    parentViewController

    The view controller the newly created instance is embedded into.
    parentView

    The view the newly created instance is embedded into.
    delegate

    The delegate of the receiver.

    Return Value

    New instance of SBSDKCheckRecognizerViewController.