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

---

<a id="additionalcustomercommondata"></a>

# AdditionalCustomerCommonData

```
public struct AdditionalCustomerCommonData : Encodable
```

Child structure of `CustomerIdentifyRequest` and `CustomerVerifyRequest`.

<a id="/Enumerations"></a>

[]()

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

[]()

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

<a id="enumerations"></a>

### Enumerations

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

  <a id="//apple_ref/swift/Enum/PostDataAPIRequired"></a>

  `PostDataAPIRequired`

  Whether or not the POST_API call will get triggered. Default is `no`.

  [See more](https://docs.idmission.com/markdown/mobile/reference/ios/Structs/AdditionalCustomerCommonData/PostDataAPIRequired.md)

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

  #### Declaration

  Swift

  ```
  public enum PostDataAPIRequired : String, Encodable
  ```

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

  <a id="//apple_ref/swift/Enum/StripSpecialCharacters"></a>

  `StripSpecialCharacters`

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

  [See more](https://docs.idmission.com/markdown/mobile/reference/ios/Structs/AdditionalCustomerCommonData/StripSpecialCharacters.md)

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

  #### Declaration

  Swift

  ```
  public enum StripSpecialCharacters : String, Encodable
  ```

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

  <a id="//apple_ref/swift/Enum/SendMetaDataInPost"></a>

  `SendMetaDataInPost`

  If postDataAPIRequired request parameter = Y, this field can be used to send metadata in postDataAPI webhook. Valid values are: Y : N

  [See more](https://docs.idmission.com/markdown/mobile/reference/ios/Structs/AdditionalCustomerCommonData/SendMetaDataInPost.md)

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

  #### Declaration

  Swift

  ```
  public enum SendMetaDataInPost : String, Encodable
  ```

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

  <a id="//apple_ref/swift/Enum/DetectLabel"></a>

  `DetectLabel`

  [See more](https://docs.idmission.com/markdown/mobile/reference/ios/Structs/AdditionalCustomerCommonData/DetectLabel.md)

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

  #### Declaration

  Swift

  ```
  public enum DetectLabel : String, Encodable
  ```

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

  <a id="//apple_ref/swift/Enum/DetectClosedEyes"></a>

  `DetectClosedEyes`

  [See more](https://docs.idmission.com/markdown/mobile/reference/ios/Structs/AdditionalCustomerCommonData/DetectClosedEyes.md)

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

  #### Declaration

  Swift

  ```
  public enum DetectClosedEyes : String, Encodable
  ```

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

  <a id="//apple_ref/swift/Enum/SendDocumentIdInResponse"></a>

  `SendDocumentIdInResponse`

  [See more](https://docs.idmission.com/markdown/mobile/reference/ios/Structs/AdditionalCustomerCommonData/SendDocumentIdInResponse.md)

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

  #### Declaration

  Swift

  ```
  public enum SendDocumentIdInResponse : String, Encodable
  ```

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

[]()

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

[]()

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

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

### Properties

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

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

  `idToken`

  idToken which has SHA256 data of request.

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

  #### Declaration

  Swift

  ```
  public var idToken: String?
  ```

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

  #### Declaration

  Swift

  ```
  public var uniqueRequestId: String
  ```

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

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

  `verificationApprovalCode`

  Verification Approval Code

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

  #### Declaration

  Swift

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

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

  #### Declaration

  Swift

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

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

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

  `stripSpecialCharacters`

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

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

  #### Declaration

  Swift

  ```
  public var stripSpecialCharacters: StripSpecialCharacters?
  ```

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

  #### Declaration

  Swift

  ```
  public var postDataAPIRequired: PostDataAPIRequired?
  ```

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

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

  `postDataAPIURL`

  If the postDataAPIRequired request parameter = Y, this field can be used to provide the URL that the postDataAPI webhook will be posted to. This will override any settings that are stored for the particular company the request is being submitted to.

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

  #### Declaration

  Swift

  ```
  public var postDataAPIURL: String?
  ```

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

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

  `sendMetaDataInPost`

  If postDataAPIRequired request parameter = Y, this field can be used to send metadata in postDataAPI webhook. Default is `yes`

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

  #### Declaration

  Swift

  ```
  public var sendMetaDataInPost: SendMetaDataInPost?
  ```

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

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

  `gpsCoordinates`

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

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

  #### Declaration

  Swift

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

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

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

  `piiExclusion`

  piiExclusion

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

  #### Declaration

  Swift

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

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

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

  `detectLabel`

  Valid values are: Y or N

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

  #### Declaration

  Swift

  ```
  public var detectLabel: DetectLabel?
  ```

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

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

  `detectClosedEyes`

  Eye close detection. Valid values are: Y or N

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

  #### Declaration

  Swift

  ```
  public var detectClosedEyes: DetectClosedEyes?
  ```

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

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

  `sendDocumentIdInResponse`

  Returns urn for documents instead of Base64 data in response. Valid values are: Y or N

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

  #### Declaration

  Swift

  ```
  public var sendDocumentIdInResponse: SendDocumentIdInResponse?
  ```

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

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

  `metadata`

  Additional ID and/or Selfie Capture image metadata.

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

  #### Declaration

  Swift

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

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

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

  `ocrMetadata`

  Additional decoded MRZ and/or Barcode metadata.

  <a id="declaration-21"></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/AdditionalCustomerCommonData.md#/Initialization)

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

### Initialization

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

  <a id="//apple_ref/swift/Method/init(idToken:uniqueRequestId:verificationApprovalCode:clientRequestID:stripSpecialCharacters:postDataAPIRequired:postDataAPIURL:sendMetaDataInPost:gpsCoordinates:piiExclusion:detectLabel:detectClosedEyes:sendDocumentIdInResponse:)"></a>

  `init(idToken:uniqueRequestId:verificationApprovalCode:clientRequestID:stripSpecialCharacters:postDataAPIRequired:postDataAPIURL:sendMetaDataInPost:gpsCoordinates:piiExclusion:detectLabel:detectClosedEyes:sendDocumentIdInResponse:)`

  Designated initializer.

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

  #### Declaration

  Swift

  ```
  public init(idToken: String? = "",
              uniqueRequestId: String = IDentitySDK.requestID,
              verificationApprovalCode: String? = nil,
              clientRequestID: String? = nil,
              stripSpecialCharacters: StripSpecialCharacters? = .yes,
              postDataAPIRequired: PostDataAPIRequired? = .no,
              postDataAPIURL: String? = nil,
              sendMetaDataInPost: SendMetaDataInPost? = .yes,
              gpsCoordinates: String? = nil,
              piiExclusion: String? = nil,
              detectLabel: DetectLabel? = .no,
              detectClosedEyes: DetectClosedEyes? = .no,
              sendDocumentIdInResponse: SendDocumentIdInResponse? = .yes)
  ```

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

  #### Parameters

  |                            |                                                                                                                                                                                                                                                                                                                                                                   |
  | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `idToken`                  | idToken which has SHA256 data of request.                                                                                                                                                                                                                                                                                                                         |
  | `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`.                                                                                                                                                                                             |
  | `postDataAPIURL`           | If the postDataAPIRequired request parameter = Y, this field can be used to provide the URL that the postDataAPI webhook will be posted to. This will override any settings that are stored for the particular company the request is being submitted to.                                                                                                         |
  | `sendMetaDataInPost`       | If postDataAPIRequired request parameter = Y, this field can be used to send metadata in postDataAPI webhook. Valid values are: Y : N                                                                                                                                                                                                                             |
  | `gpsCoordinates`           | Get location details in GPS Co-ordinate Format (Latitude & Longitude).                                                                                                                                                                                                                                                                                            |
  | `piiExclusion`             | piiExclusion                                                                                                                                                                                                                                                                                                                                                      |
  | `detectLabel`              | Valid values are: Y or N                                                                                                                                                                                                                                                                                                                                          |
  | `detectClosedEyes`         | Eye close detection. Valid values are: Y : N                                                                                                                                                                                                                                                                                                                      |
  | `sendDocumentIdInResponse` | Returns urn for documents instead of Base64 data in response. Valid values are: Y : N.                                                                                                                                                                                                                                                                            |

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