# 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/SelfieCapture/Options.html
- Imported at: 2026-10-21T17:27:02.187Z
- Canonical page: https://docs.idmission.com/mobile/reference/ios/Classes/SelfieCapture/Options
- Agent index: https://docs.idmission.com/llms.txt

---

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

# Options

```
struct Options
```

Selfie capture options.

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

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

  `minFaceWidth`

  Minimum face capture overlay width threshold percentage, represented as a value between `0.0` and `1.0`. Default is `0.6`.

  A minimum face width of `0.6` (60%) means that a scanned face must be greater than 60% of the face capture overlay width.

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

  #### Declaration

  Swift

  ```
  public var minFaceWidth: Float
  ```

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

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

  `eyeOpenProbability`

  Minimum eye open probability percentage, represented as a value between `0.0` and `1.0`. Default is `0.4`.

  If a user is detected as closing one or both of their eyes, they will be prompted to open them.

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

  #### Declaration

  Swift

  ```
  public var eyeOpenProbability: Float
  ```

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

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

  `minHeadEulerAngle`

  Minimum captured face angle from vertical, in degrees. Default is `-10`.

  When a user attempts to capture their face while tilting their head an angle beyond this threshold, they will be prompted to straighten their head.

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

  #### Declaration

  Swift

  ```
  public var minHeadEulerAngle: Float
  ```

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

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

  `maxHeadEulerAngle`

  Maximum captured face angle from vertical, in degrees. Default is `-10`.

  When a user attempts to capture their face while tilting their head an angle beyond this threshold, they will be prompted to straighten their head.

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

  #### Declaration

  Swift

  ```
  public var maxHeadEulerAngle: Float
  ```

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

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

  `minRelativeNoseHeight`

  Minimum nose height percentage, relative to the height of the face, represented as a value between `0.0` and `1.0`. Default is `0.48`.

  With a minimum nose height percentage of 48%, the end of a user’s nose can be detected within 2% of the total face height above the center point.

  If a user’s nose is too height, they will be prompted to move their face down.

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

  #### Declaration

  Swift

  ```
  public var minRelativeNoseHeight: Float
  ```

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

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

  `maxRelativeNoseHeight`

  Maximum nose height percentage, relative to the height of the face, represented as a value between `0.0` and `1.0`. Default is `0.67`.

  With a maximum nose height percentage of 67%, the end of a user’s nose can be detected within 17% of the total face height below the center point.

  If a user’s nose is too low, they will be prompted to move their face up.

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

  #### Declaration

  Swift

  ```
  public var maxRelativeNoseHeight: Float
  ```

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

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

  `labelsConfidenceThreshold`

  Hat and glasses detection confidence threshold, represented as a value between `0.0` and `1.0`. Default is `0.79`.

  If a user is detected as wearing a hat or glasses, they will be prompted to remove them.

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

  #### Declaration

  Swift

  ```
  public var labelsConfidenceThreshold: Float
  ```

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

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

  `faceMaskProbabilityThreshold`

  Face mask detection probability threshold percentage, represented as a value between `0.0` and `1.0`. Default is `0.98`.

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

  #### Declaration

  Swift

  ```
  public var faceMaskProbabilityThreshold: Float
  ```

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

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

  `liveFaceProbabilityThreshold`

  Live face detection probability threshold percentage, represented as a value between `0.0` and `1.0`. Default is `0.9`.

  If a user is detected as not having a “live face” the face capture will fail, and the user will be prompted to retry or cancel.

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

  #### Declaration

  Swift

  ```
  public var liveFaceProbabilityThreshold: Float
  ```

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

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

  `consecutiveFakeFaceLimit`

  Consecutive fake face limit count. Default is `3`.

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

  #### Declaration

  Swift

  ```
  public var consecutiveFakeFaceLimit: Int
  ```

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

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

  `lightIntensityThreshold`

  Maximum percentage of pixels with a light intensity over the threshold, represented as a value between `0.0` and `1.0`. Default is `0.05`.

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

  #### Declaration

  Swift

  ```
  public var lightIntensityThreshold: Float
  ```

- <a id="/s:17IDentitySDK_Swift13SelfieCaptureC7OptionsV14focusThresholdSfvp"></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-12"></a>

  #### Declaration

  Swift

  ```
  public var focusThreshold: Float
  ```

- <a id="/s:17IDentitySDK_Swift13SelfieCaptureC7OptionsV11isDebugModeSbvp"></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-13"></a>

  #### Declaration

  Swift

  ```
  public var isDebugMode: Bool
  ```

- <a id="/s:17IDentitySDK_Swift13SelfieCaptureC7OptionsV9capture4KSbvp"></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-14"></a>

  #### Declaration

  Swift

  ```
  public var capture4K: Bool
  ```

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

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

  `uploadFaceData`

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

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

  #### Declaration

  Swift

  ```
  public var uploadFaceData: Bool
  ```

- <a id="/s:17IDentitySDK_Swift13SelfieCaptureC7OptionsV23enableInstructionScreenSbvp"></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-16"></a>

  #### Declaration

  Swift

  ```
  public var enableInstructionScreen: Bool
  ```

- <a id="/s:17IDentitySDK_Swift13SelfieCaptureC7OptionsV35instructionScreenBackButtonIsHiddenSbvp"></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-17"></a>

  #### Declaration

  Swift

  ```
  public var instructionScreenBackButtonIsHidden: Bool
  ```

- <a id="/s:17IDentitySDK_Swift13SelfieCaptureC7OptionsV30cameraScreenBackButtonIsHiddenSbvp"></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-18"></a>

  #### Declaration

  Swift

  ```
  public var cameraScreenBackButtonIsHidden: Bool
  ```

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

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

  `ovalScaleMultiplier`

  Selife capture oval scale multiplier represented as a value between `0.5` and `1.0`. Default is `0.7`.

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

  #### Declaration

  Swift

  ```
  public var ovalScaleMultiplier: Float { get set }
  ```

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

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

  `cameraPosition`

  Selfie Capture camera position. Default is `front`.

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

  #### Declaration

  Swift

  ```
  public var cameraPosition: AVCaptureDevice.Position
  ```

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

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

  `showToggleCamera`

  Whether or not to show the toggle camera button. Default is `false`.

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

  #### Declaration

  Swift

  ```
  public var showToggleCamera: Bool
  ```

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

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

  `isSelfieCapturePreviewEnabled`

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

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

  #### Declaration

  Swift

  ```
  public var isSelfieCapturePreviewEnabled: Bool
  ```

<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.