# Options Structure Reference



## Scope and provenance

- Product: mobile
- Status: Imported reference snapshot. Import date is not a verification date or guarantee of current release support.
- SDK version: Not declared for this page. Versions in examples must not be assumed current.
- Environment: Page-specific. Confirm the environment host, credentials, and service configuration; do not infer them from another product.
- Source: https://documentation.idmission.com/identity/iOS-SDK-2/Classes/IDCapture/Options.html
- Imported at: 2026-10-21T17:27:02.187Z
- Canonical page: https://docs.idmission.com/mobile/reference/ios/Classes/IDCapture/Options
- Agent index: https://docs.idmission.com/llms.txt

---

<a id="options"></a>

# Options

```
struct Options
```

ID capture options.

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV22frontRealnessThresholdSfvp"></a>

  <a id="//apple_ref/swift/Property/frontRealnessThreshold"></a>

  `frontRealnessThreshold`

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

  <a id="declaration"></a>

  #### Declaration

  Swift

  ```
  public var frontRealnessThreshold: Float
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV21backRealnessThresholdSfvp"></a>

  <a id="//apple_ref/swift/Property/backRealnessThreshold"></a>

  `backRealnessThreshold`

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

  <a id="declaration-2"></a>

  #### Declaration

  Swift

  ```
  public var backRealnessThreshold: Float
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV23frontDocumentConfidenceSfvp"></a>

  <a id="//apple_ref/swift/Property/frontDocumentConfidence"></a>

  `frontDocumentConfidence`

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

  <a id="declaration-3"></a>

  #### Declaration

  Swift

  ```
  public var frontDocumentConfidence: Float
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV22backDocumentConfidenceSfvp"></a>

  <a id="//apple_ref/swift/Property/backDocumentConfidence"></a>

  `backDocumentConfidence`

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

  <a id="declaration-4"></a>

  #### Declaration

  Swift

  ```
  public var backDocumentConfidence: Float
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV28lowerWidthThresholdToleranceSfvp"></a>

  <a id="//apple_ref/swift/Property/lowerWidthThresholdTolerance"></a>

  `lowerWidthThresholdTolerance`

  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.

  <a id="declaration-5"></a>

  #### Declaration

  Swift

  ```
  public var lowerWidthThresholdTolerance: Float
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV28upperWidthThresholdToleranceSfvp"></a>

  <a id="//apple_ref/swift/Property/upperWidthThresholdTolerance"></a>

  `upperWidthThresholdTolerance`

  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.

  <a id="declaration-6"></a>

  #### Declaration

  Swift

  ```
  public var upperWidthThresholdTolerance: Float
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV27documentComponentConfidenceSfvp"></a>

  <a id="//apple_ref/swift/Property/documentComponentConfidence"></a>

  `documentComponentConfidence`

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

  <a id="declaration-7"></a>

  #### Declaration

  Swift

  ```
  public var documentComponentConfidence: Float
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV31documentBackComponentConfidenceSfvp"></a>

  <a id="//apple_ref/swift/Property/documentBackComponentConfidence"></a>

  `documentBackComponentConfidence`

  Minimum document back component confidence percentage, represented as a value between `0.0` and `1.0`. Default is `0.7`.

  <a id="declaration-8"></a>

  #### Declaration

  Swift

  ```
  public var documentBackComponentConfidence: Float
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV14glareThresholdSfvp"></a>

  <a id="//apple_ref/swift/Property/glareThreshold"></a>

  `glareThreshold`

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

  <a id="declaration-9"></a>

  #### Declaration

  Swift

  ```
  public var glareThreshold: Float
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV15fingerThresholdSfvp"></a>

  <a id="//apple_ref/swift/Property/fingerThreshold"></a>

  `fingerThreshold`

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

  <a id="declaration-10"></a>

  #### Declaration

  Swift

  ```
  public var fingerThreshold: Float
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV14focusThresholdSfvp"></a>

  <a id="//apple_ref/swift/Property/focusThreshold"></a>

  `focusThreshold`

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

  <a id="declaration-11"></a>

  #### Declaration

  Swift

  ```
  public var focusThreshold: Float
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV18barcodeCropPaddingSfvp"></a>

  <a id="//apple_ref/swift/Property/barcodeCropPadding"></a>

  `barcodeCropPadding`

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

  <a id="declaration-12"></a>

  #### Declaration

  Swift

  ```
  public var barcodeCropPadding: Float
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV24isBarcodeRecoveryEnabledSbvp"></a>

  <a id="//apple_ref/swift/Property/isBarcodeRecoveryEnabled"></a>

  `isBarcodeRecoveryEnabled`

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

  <a id="declaration-13"></a>

  #### Declaration

  Swift

  ```
  public var isBarcodeRecoveryEnabled: Bool
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV26missingBarcodeTimeIntervalSivp"></a>

  <a id="//apple_ref/swift/Property/missingBarcodeTimeInterval"></a>

  `missingBarcodeTimeInterval`

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

  <a id="declaration-14"></a>

  #### Declaration

  Swift

  ```
  public var missingBarcodeTimeInterval: Int
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV37barcodeRecoveryMoveCloserTimeIntervalSivp"></a>

  <a id="//apple_ref/swift/Property/barcodeRecoveryMoveCloserTimeInterval"></a>

  `barcodeRecoveryMoveCloserTimeInterval`

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

  <a id="declaration-15"></a>

  #### Declaration

  Swift

  ```
  public var barcodeRecoveryMoveCloserTimeInterval: Int
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV34barcodeRecoveryCaptureTimeIntervalSivp"></a>

  <a id="//apple_ref/swift/Property/barcodeRecoveryCaptureTimeInterval"></a>

  `barcodeRecoveryCaptureTimeInterval`

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

  <a id="declaration-16"></a>

  #### Declaration

  Swift

  ```
  public var barcodeRecoveryCaptureTimeInterval: Int
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV11isDebugModeSbvp"></a>

  <a id="//apple_ref/swift/Property/isDebugMode"></a>

  `isDebugMode`

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

  <a id="declaration-17"></a>

  #### Declaration

  Swift

  ```
  public var isDebugMode: Bool
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV9capture4KSbvp"></a>

  <a id="//apple_ref/swift/Property/capture4K"></a>

  `capture4K`

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

  <a id="declaration-18"></a>

  #### Declaration

  Swift

  ```
  public var capture4K: Bool
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV12uploadIdDataSbvp"></a>

  <a id="//apple_ref/swift/Property/uploadIdData"></a>

  `uploadIdData`

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

  <a id="declaration-19"></a>

  #### Declaration

  Swift

  ```
  public var uploadIdData: Bool
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV12enableRealIdSbvp"></a>

  <a id="//apple_ref/swift/Property/enableRealId"></a>

  `enableRealId`

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

  <a id="declaration-20"></a>

  #### Declaration

  Swift

  ```
  public var enableRealId: Bool
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV23enableInstructionScreenSbvp"></a>

  <a id="//apple_ref/swift/Property/enableInstructionScreen"></a>

  `enableInstructionScreen`

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

  <a id="declaration-21"></a>

  #### Declaration

  Swift

  ```
  public var enableInstructionScreen: Bool
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV31isIdInstructionAnimationEnabledSbvp"></a>

  <a id="//apple_ref/swift/Property/isIdInstructionAnimationEnabled"></a>

  `isIdInstructionAnimationEnabled`

  Whether or not to animate the ID capture instruction image. Default is `true`.

  <a id="declaration-22"></a>

  #### Declaration

  Swift

  ```
  public var isIdInstructionAnimationEnabled: Bool
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV35idCaptureInstructionAnimationImagesSaySo7UIImageCGSgvp"></a>

  <a id="//apple_ref/swift/Property/idCaptureInstructionAnimationImages"></a>

  `idCaptureInstructionAnimationImages`

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

  <a id="declaration-23"></a>

  #### Declaration

  Swift

  ```
  public var idCaptureInstructionAnimationImages: [UIImage]?
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV30idInstructionAnimationDurationSdvp"></a>

  <a id="//apple_ref/swift/Property/idInstructionAnimationDuration"></a>

  `idInstructionAnimationDuration`

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

  <a id="declaration-24"></a>

  #### Declaration

  Swift

  ```
  public var idInstructionAnimationDuration: TimeInterval
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV17enablePassportNFCSbvp"></a>

  <a id="//apple_ref/swift/Property/enablePassportNFC"></a>

  `enablePassportNFC`

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

  <a id="declaration-25"></a>

  #### Declaration

  Swift

  ```
  public var enablePassportNFC: Bool
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV28performIdCaptureBeforeSelfieSbvp"></a>

  <a id="//apple_ref/swift/Property/performIdCaptureBeforeSelfie"></a>

  `performIdCaptureBeforeSelfie`

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

  <a id="declaration-26"></a>

  #### Declaration

  Swift

  ```
  public var performIdCaptureBeforeSelfie: Bool
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV35instructionScreenBackButtonIsHiddenSbvp"></a>

  <a id="//apple_ref/swift/Property/instructionScreenBackButtonIsHidden"></a>

  `instructionScreenBackButtonIsHidden`

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

  <a id="declaration-27"></a>

  #### Declaration

  Swift

  ```
  public var instructionScreenBackButtonIsHidden: Bool
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV30cameraScreenBackButtonIsHiddenSbvp"></a>

  <a id="//apple_ref/swift/Property/cameraScreenBackButtonIsHidden"></a>

  `cameraScreenBackButtonIsHidden`

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

  <a id="declaration-28"></a>

  #### Declaration

  Swift

  ```
  public var cameraScreenBackButtonIsHidden: Bool
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV30passportNFCPhotoMatchThresholdSfvp"></a>

  <a id="//apple_ref/swift/Property/passportNFCPhotoMatchThreshold"></a>

  `passportNFCPhotoMatchThreshold`

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

  <a id="declaration-29"></a>

  #### Declaration

  Swift

  ```
  public var passportNFCPhotoMatchThreshold: Float
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV29isIdCaptureProgressBarEnabledSbvp"></a>

  <a id="//apple_ref/swift/Property/isIdCaptureProgressBarEnabled"></a>

  `isIdCaptureProgressBarEnabled`

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

  <a id="declaration-30"></a>

  #### Declaration

  Swift

  ```
  public var isIdCaptureProgressBarEnabled: Bool
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV29idCaptureProgressBarLineWidth14CoreFoundation7CGFloatVvp"></a>

  <a id="//apple_ref/swift/Property/idCaptureProgressBarLineWidth"></a>

  `idCaptureProgressBarLineWidth`

  Optional ProgressBar line width override. Default is `nil`.

  <a id="declaration-31"></a>

  #### Declaration

  Swift

  ```
  public var idCaptureProgressBarLineWidth: CGFloat
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV29wrongDocumentTypeHandlingModeAA05WrongghiJ0Ovp"></a>

  <a id="//apple_ref/swift/Property/wrongDocumentTypeHandlingMode"></a>

  `wrongDocumentTypeHandlingMode`

  <a id="declaration-32"></a>

  #### Declaration

  Swift

  ```
  public var wrongDocumentTypeHandlingMode: WrongDocumentTypeHandlingMode
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV38allowOverrideWrongDocumentTypeAfterSecSdvp"></a>

  <a id="//apple_ref/swift/Property/allowOverrideWrongDocumentTypeAfterSec"></a>

  `allowOverrideWrongDocumentTypeAfterSec`

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

  <a id="declaration-33"></a>

  #### Declaration

  Swift

  ```
  public var allowOverrideWrongDocumentTypeAfterSec: TimeInterval
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV34wrongDocumentTypeWarningDelayInSecSdvp"></a>

  <a id="//apple_ref/swift/Property/wrongDocumentTypeWarningDelayInSec"></a>

  `wrongDocumentTypeWarningDelayInSec`

  When to show warning

  <a id="declaration-34"></a>

  #### Declaration

  Swift

  ```
  public var wrongDocumentTypeWarningDelayInSec: TimeInterval
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV29separateIdCardCaptureSequenceSbvp"></a>

  <a id="//apple_ref/swift/Property/separateIdCardCaptureSequence"></a>

  `separateIdCardCaptureSequence`

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

  <a id="declaration-35"></a>

  #### Declaration

  Swift

  ```
  public var separateIdCardCaptureSequence: Bool
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV02isD14PreviewEnabledSbvp"></a>

  <a id="//apple_ref/swift/Property/isIDCapturePreviewEnabled"></a>

  `isIDCapturePreviewEnabled`

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

  <a id="declaration-36"></a>

  #### Declaration

  Swift

  ```
  public var isIDCapturePreviewEnabled: Bool
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV29consecutiveFakeIdCaptureLimitSivp"></a>

  <a id="//apple_ref/swift/Property/consecutiveFakeIdCaptureLimit"></a>

  `consecutiveFakeIdCaptureLimit`

  Consecutive spoof id limit count. Default is `3`.

  <a id="declaration-37"></a>

  #### Declaration

  Swift

  ```
  public var consecutiveFakeIdCaptureLimit: Int
  ```

- <a id="/s:17IDentitySDK_Swift9IDCaptureC7OptionsV24idCaptureOrientationModeAA02IdghI0Ovp"></a>

  <a id="//apple_ref/swift/Property/idCaptureOrientationMode"></a>

  `idCaptureOrientationMode`

  ID capture orientation. Default is `horizontal`.

  <a id="declaration-38"></a>

  #### Declaration

  Swift

  ```
  public var idCaptureOrientationMode: IdCaptureOrientationMode
  ```

<a id="footer"></a>

© 2026 [IDmission](https://www.idmission.com/). All rights reserved. (Last updated: 2026-07-20)

Generated by [jazzy ♪♫ v0.15.3](https://github.com/realm/jazzy), a [Realm](https://realm.io/) project.