Options

struct Options

ID capture options.

  • Minimum ID front capture realness threshold percentage, represented as a value between 0.0 and 1.0. Default is 0.5.

    Declaration

    Swift

    public var frontRealnessThreshold: Float

  • Minimum ID back capture realness threshold percentage, represented as a value between 0.0 and 1.0. Default is 0.3.

    Declaration

    Swift

    public var backRealnessThreshold: Float

  • Minimum ID front classification confidence percentage, represented as a value between 0.0 and 1.0. Default is 0.7.

    Declaration

    Swift

    public var frontDocumentConfidence: Float

  • Minimum ID back classification confidence percentage, represented as a value between 0.0 and 1.0. Default is 0.7.

    Declaration

    Swift

    public var backDocumentConfidence: Float

  • Lower ID capture rectangle width threshold tolerance percentage, represented as a value between 0.0 and 1.0. Default is 0.2.

    A lower width threshold tolerance of 0.2 (20%) means that a scanned ID must fall within (100 - 20) = 80% of the capture overlay rectangle width.

    Declaration

    Swift

    public var lowerWidthThresholdTolerance: Float

  • Upper ID capture rectangle width threshold tolerance percentage, represented as a value between 0.0 and 1.0. Default is 0.05.

    An upper width threshold tolerance of 0.05 (5%) means that a scanned ID must fall within (100 + 5) = 105% of the capture overlay rectangle width.

    Declaration

    Swift

    public var upperWidthThresholdTolerance: Float

  • Minimum document component confidence percentage, represented as a value between 0.0 and 1.0. Default is 0.5.

    Declaration

    Swift

    public var documentComponentConfidence: Float

  • Minimum glareDetection confidence percentage, represented as a value between 0.0 and 1.0. Default is 0.3.

    Declaration

    Swift

    public var glareThreshold: Float

  • Minimum fingerDetection confidence percentage, represented as a value between 0.0 and 1.0. Default is 0.3.

    Declaration

    Swift

    public var fingerThreshold: Float

  • Minimum focus threshold percentage, represented as a value between 0.0 and 1.0. Default is 0.2.

    Declaration

    Swift

    public var focusThreshold: Float

  • Whether or not to display debug information during capture. Default is false.

    Declaration

    Swift

    public var isDebugMode: Bool

  • Whether or not to always try to capture in 4K. Default is false.

    Declaration

    Swift

    public var capture4K: Bool

  • Whether or not to upload ID data to the Ground Truth Engine (GTE) service. Default is true.

    Declaration

    Swift

    public var uploadIdData: Bool

  • Whether or not to perform Real ID processing. Default is true.

    Declaration

    Swift

    public var enableRealId: Bool

  • Whether or not to display an instruction screen to the user before initiating capture. Default is true.

    Declaration

    Swift

    public var enableInstructionScreen: Bool

  • Whether or not to prompt the user to scan their passport’s NFC chip data during ID capture. Default is false.

    Declaration

    Swift

    public var enablePassportNFC: Bool

  • Minimum passport NFC photo match threshold. Default is 0.97.

    Declaration

    Swift

    public var passportNFCPhotoMatchThreshold: Float