# AdditionalCustomerEnrollBiometricRequestDataV3 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/Structs/AdditionalCustomerEnrollBiometricRequestDataV3.html
- Imported at: 2026-10-25T05:00:44.899Z
- Canonical page: https://docs.idmission.com/mobile/reference/ios/Structs/AdditionalCustomerEnrollBiometricRequestDataV3
- Agent index: https://docs.idmission.com/llms.txt

---

<a id="additionalcustomerenrollbiometricrequestdatav3"></a>

# AdditionalCustomerEnrollBiometricRequestDataV3

```
public struct AdditionalCustomerEnrollBiometricRequestDataV3 : Encodable
```

Child structure of `CustomerEnrollBiometricsRequest`.

<a id="/Properties"></a>

[]()

<a id="//apple_ref/swift/Section/Properties"></a>

[]()

[](https://docs.idmission.com/markdown/mobile/reference/ios/Structs/AdditionalCustomerEnrollBiometricRequestDataV3.md#/Properties)

<a id="properties"></a>

### Properties

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

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

  `uniqueRequestId`

  Mandatory Unique Identifier generated by the client application that will be stored with the form and can be subsequently used to search form. This is required to be unique for each form and should have logic to ensure that. Recommendation is to include items such as the timestamp and Login ID. It can be as long as 256 characters. Default is a `UUID`.

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

  #### Declaration

  Swift

  ```
  public var uniqueRequestId: String
  ```

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

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

  `verificationApprovalCode`

  Verification Approval Code

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

  #### Declaration

  Swift

  ```
  public var verificationApprovalCode: String?
  ```

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

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

  `clientRequestID`

  Client Request ID generated by client applicationIt can be as long as 256 characters.

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

  #### Declaration

  Swift

  ```
  public var clientRequestID: String?
  ```

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

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

  `stripSpecialCharacters`

  Whether or not to strip special characters. Default is `yes`.

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

  #### Declaration

  Swift

  ```
  public var stripSpecialCharacters: AdditionalCustomerEnrollBiometricRequestData.StripSpecialCharacters?
  ```

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

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

  `postDataAPIRequired`

  The POST Data API is used to accept the results and extracted data from the service. This requires a URL to be specified for the POST to be sent to. Default is `no`.

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

  #### Declaration

  Swift

  ```
  public var postDataAPIRequired: AdditionalCustomerEnrollBiometricRequestData.PostDataAPIRequired?
  ```

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

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

  `gpsCoordinates`

  Get location details in GPS Co-ordinate Format (Latitude & Longitude).

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

  #### Declaration

  Swift

  ```
  public var gpsCoordinates: String?
  ```

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

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

  `piiExclusion`

  piiExclusion

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

  #### Declaration

  Swift

  ```
  public var piiExclusion: String?
  ```

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

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

  `needImmediateResponse`

  Whether or not the submitting system requires an immediate response back to the request.

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

  #### Declaration

  Swift

  ```
  public var needImmediateResponse: AdditionalCustomerEnrollBiometricRequestData.NeedImmediateResponse?
  ```

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

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

  `deDuplicationRequired`

  Whether or not deduplication is to be performed against the enrolled customer’s face image.

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

  #### Declaration

  Swift

  ```
  public var deDuplicationRequired: AdditionalCustomerEnrollBiometricRequestData.DeDuplicationRequired?
  ```

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

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

  `deDupDataRequiredInResponse`

  Whether or not the deduplication data is required in the response. Default is `yes`.

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

  #### Declaration

  Swift

  ```
  public var deDupDataRequiredInResponse: AdditionalCustomerEnrollBiometricRequestData.DeDupDataRequiredInResponse?
  ```

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

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

  `deDupManualReviewRequired`

  Whether or not manual review is required for the deduplication result.. Default is `yes`.

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

  #### Declaration

  Swift

  ```
  public var deDupManualReviewRequired: AdditionalCustomerEnrollBiometricRequestData.DeDupManualReviewRequired?
  ```

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

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

  `detectLiveness`

  Whether or not to detect liveness.

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

  #### Declaration

  Swift

  ```
  public var detectLiveness: AdditionalCustomerEnrollBiometricRequestData.DetectLiveness?
  ```

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

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

  `metadata`

  Additional ID and/or Selfie Capture image metadata.

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

  #### Declaration

  Swift

  ```
  public var metadata: Metadata?
  ```

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

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

  `ocrMetadata`

  Additional decoded MRZ and/or Barcode metadata.

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

  #### Declaration

  Swift

  ```
  public var ocrMetadata: String?
  ```

<a id="/Initialization"></a>

[]()

<a id="//apple_ref/swift/Section/Initialization"></a>

[]()

[](https://docs.idmission.com/markdown/mobile/reference/ios/Structs/AdditionalCustomerEnrollBiometricRequestDataV3.md#/Initialization)

<a id="initialization"></a>

### Initialization

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

  <a id="//apple_ref/swift/Method/init(uniqueRequestId:verificationApprovalCode:clientRequestID:stripSpecialCharacters:postDataAPIRequired:gpsCoordinates:piiExclusion:needImmediateResponse:deDuplicationRequired:deDupDataRequiredInResponse:deDupManualReviewRequired:detectLiveness:)"></a>

  `init(uniqueRequestId:verificationApprovalCode:clientRequestID:stripSpecialCharacters:postDataAPIRequired:gpsCoordinates:piiExclusion:needImmediateResponse:deDuplicationRequired:deDupDataRequiredInResponse:deDupManualReviewRequired:detectLiveness:)`

  Designated initializer.

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

  #### Declaration

  Swift

  ```
  public init(uniqueRequestId: String = IDentitySDK.requestID,
              verificationApprovalCode: String? = nil,
              clientRequestID: String? = nil,
              stripSpecialCharacters: AdditionalCustomerEnrollBiometricRequestData.StripSpecialCharacters? = .yes,
              postDataAPIRequired: AdditionalCustomerEnrollBiometricRequestData.PostDataAPIRequired? = .no,
              gpsCoordinates: String? = nil,
              piiExclusion: String? = nil,
              needImmediateResponse: AdditionalCustomerEnrollBiometricRequestData.NeedImmediateResponse? = nil,
              deDuplicationRequired: AdditionalCustomerEnrollBiometricRequestData.DeDuplicationRequired? = nil,
              deDupDataRequiredInResponse: AdditionalCustomerEnrollBiometricRequestData.DeDupDataRequiredInResponse? = .yes,
              deDupManualReviewRequired: AdditionalCustomerEnrollBiometricRequestData.DeDupManualReviewRequired? = .yes,
              detectLiveness: AdditionalCustomerEnrollBiometricRequestData.DetectLiveness? = .yes)
  ```

  <a id="parameters"></a>

  #### Parameters

  |                               |                                                                                                                                                                                                                                                                                                                                                                    |
  | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
  | `uniqueRequestId`             | Mandatory Unique Identifier generated by the client application that will be stored with the form and can be subsequently used to search form. This is required to be unique for each form and should have logic to ensure that. Recommendation is to include items such as the timestamp and Login ID. It can be as long as 256 characters. Default is a `UUID`.  |
  | `verificationApprovalCode`    | Verification Approval Code                                                                                                                                                                                                                                                                                                                                         |
  | `clientRequestID`             | Client Request ID generated by client applicationIt can be as long as 256 characters.                                                                                                                                                                                                                                                                              |
  | `stripSpecialCharacters`      | Whether or not to strip special characters. Default is `yes`.                                                                                                                                                                                                                                                                                                      |
  | `postDataAPIRequired`         | The POST Data API is used to accept the results and extracted data from the service. This requires a URL to be specified for the POST to be sent to. Default is `no`.                                                                                                                                                                                              |
  | `gpsCoordinates`              | Get location details in GPS Co-ordinate Format (Latitude & Longitude).                                                                                                                                                                                                                                                                                             |
  | `piiExclusion`                | piiExclusion                                                                                                                                                                                                                                                                                                                                                       |
  | `needImmediateResponse`       | Whether or not the submitting system requires an immediate response back to the request.                                                                                                                                                                                                                                                                           |
  | `deDuplicationRequired`       | Whether or not deduplication is to be performed against the enrolled customer’s face image.                                                                                                                                                                                                                                                                        |
  | `deDupDataRequiredInResponse` | Whether or not the deduplication data is required in the response. Default is `yes`.                                                                                                                                                                                                                                                                               |
  | `deDupManualReviewRequired`   | Whether or not manual review is required for the deduplication result.. Default is `yes`.                                                                                                                                                                                                                                                                          |
  | `detectLiveness`              | Whether or not to detect liveness.                                                                                                                                                                                                                                                                                                                                 |

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

© 2025 [IDmission](https://www.idmission.com/). All rights reserved. (Last updated: 2025-11-11)

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