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 document back component confidence percentage, represented as a value between 0.0 and 1.0. Default is 0.7.

    Declaration

    Swift

    public var documentBackComponentConfidence: Float

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

    Declaration

    Swift

    public var glareThreshold: Float

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

    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

  • Barcode crop padding percentage, represented as a value between 0.0 and 1.0. Default is 0.1 (10%).

    Declaration

    Swift

    public var barcodeCropPadding: Float

  • Whether or not barcode recovery is enabled. Default is true.

    Declaration

    Swift

    public var isBarcodeRecoveryEnabled: Bool

  • Number of seconds to attempt to decode a barcode before optionally entering barcode recovery. Default is 5.

    Declaration

    Swift

    public var missingBarcodeTimeInterval: Int

  • Barcode Recovery Move-Closer Time Interval (sec). Default is 10.

    Declaration

    Swift

    public var barcodeRecoveryMoveCloserTimeInterval: Int

  • Barcode Recovery Capture Time Interval (sec). Default is 5.

    Declaration

    Swift

    public var barcodeRecoveryCaptureTimeInterval: Int

  • 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 animate the ID capture instruction image. Default is true.

    Declaration

    Swift

    public var isIdInstructionAnimationEnabled: Bool

  • Optional images to animate on the ID capture instruction screen. Default is nil, which uses SDK default animation images.

    Declaration

    Swift

    public var idCaptureInstructionAnimationImages: [UIImage]?

  • Duration of the ID capture instruction image animation. Default is 3.

    Declaration

    Swift

    public var idInstructionAnimationDuration: TimeInterval

  • 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

  • Whether or not to append a read-progress percentage to the NFC system sheet while the chip is being read. A full passport read takes ~20 seconds, most of it on the photo data group, so without this the sheet shows one unchanging line and the user may lift the phone early. Default is false, which shows strings.nfcScreenLoadingText unchanged.

    Declaration

    Swift

    public var showPassportNFCReadProgress: Bool

  • How many bytes the SDK asks the NFC chip for in a single read. Default is 0xFF (255).

    The photo data group is ~19.7 KB, so at the previous 160 bytes it took 124 round trips; at 255 it takes 78, which is roughly a third off the total read. Chips that cannot serve a read this large answer 0x6C xx or 0x67 0x00, and the reader recovers automatically by dropping back to 160 and re-running BAC — at the cost of restarting that data group. Set this to 0xA0 (160) to force the old, slower-but-most-compatible behaviour.

    Declaration

    Swift

    public var passportNFCReadChunkSize: Int

  • It changes the sequence of IDCapture & SelfieCapture for SID-10 & SID-50

    Declaration

    Swift

    public var performIdCaptureBeforeSelfie: Bool

  • Whether or not to display an instruction screen close button to the user. Default is false.

    Declaration

    Swift

    public var instructionScreenBackButtonIsHidden: Bool

  • Whether or not to display an camera screen close button to the user. Default is false.

    Declaration

    Swift

    public var cameraScreenBackButtonIsHidden: Bool

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

    Declaration

    Swift

    public var passportNFCPhotoMatchThreshold: Float

  • Whether or not to show Progress Bar. Default is false

    Declaration

    Swift

    public var isIdCaptureProgressBarEnabled: Bool

  • Optional ProgressBar line width override. Default is nil.

    Declaration

    Swift

    public var idCaptureProgressBarLineWidth: CGFloat

  • Declaration

    Swift

    public var wrongDocumentTypeHandlingMode: WrongDocumentTypeHandlingMode

  • Allow Override Wrong Document Type After Seconds. Default is 8 sec.

    Declaration

    Swift

    public var allowOverrideWrongDocumentTypeAfterSec: TimeInterval

  • When to show warning

    Declaration

    Swift

    public var wrongDocumentTypeWarningDelayInSec: TimeInterval

  • Whether or not to show IDCapture Preview Screen for Front & Back. Default is false

    Declaration

    Swift

    public var separateIdCardCaptureSequence: Bool

  • Whether or not to show IDCapture Preview Screen. Default is false

    Declaration

    Swift

    public var isIDCapturePreviewEnabled: Bool

  • Consecutive spoof id limit count. Default is 3.

    Declaration

    Swift

    public var consecutiveFakeIdCaptureLimit: Int

  • ID capture orientation. Default is horizontal.

    Declaration

    Swift

    public var idCaptureOrientationMode: IdCaptureOrientationMode

  • Dynamic side-order capture flow for two-sided IDs.

    Declaration

    Swift

    public var enableDynamicBothSideCapture: Bool