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

---

<a id="identitysdk"></a>

# IDentitySDK

```
public class IDentitySDK
```

Documentation for the `IDentitySDK.framework` methods and parameter overrides.

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

  <a id="//apple_ref/swift/Variable/allowedSecurityFrameworks"></a>

  `allowedSecurityFrameworks`

  List of known client-side framework names that should be allowed to load Add the names (e.g., “FridaDetector”) before calling initializeSDK.

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

  #### Declaration

  Swift

  ```
  public static var allowedSecurityFrameworks: [String]
  ```

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

  <a id="//apple_ref/swift/Method/setDevelopmentRelaxationSecret(_:)"></a>

  `setDevelopmentRelaxationSecret(_:)`

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

  #### Declaration

  Swift

  ```
  public class func setDevelopmentRelaxationSecret(_ secret: Int)
  ```

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

  <a id="//apple_ref/swift/Method/setScreenSecurityEnabled(_:)"></a>

  `setScreenSecurityEnabled(_:)`

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

  #### Declaration

  Swift

  ```
  public class func setScreenSecurityEnabled(_ enabled: Bool)
  ```

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

  <a id="//apple_ref/swift/Method/isScreenRecordingEnabled(_:)"></a>

  `isScreenRecordingEnabled(_:)`

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

  #### Declaration

  Swift

  ```
  public class func isScreenRecordingEnabled(_ enabled: Bool)
  ```

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

  <a id="//apple_ref/swift/Variable/isInitialized"></a>

  `isInitialized`

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

  #### Declaration

  Swift

  ```
  public static var isInitialized: Bool { get }
  ```

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

  <a id="//apple_ref/swift/Method/initializeSDK(language:isGPSEnabled:geolocationRequired:isUpdateModelsData:accessToken:completion:)"></a>

  `initializeSDK(language:isGPSEnabled:geolocationRequired:isUpdateModelsData:accessToken:completion:)`

  Initializes the IDentitySDK framework.

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

  #### Declaration

  Swift

  ```
  public class func initializeSDK(language: Language = .en,
                                  isGPSEnabled: Bool = true,
                                  geolocationRequired: Bool = false,
                                  isUpdateModelsData: Bool = true,
                                  accessToken: String,
                                  completion: @escaping ErrorCompletion)
  ```

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

  #### Parameters

  |                       |                                                                                                     |
  | --------------------- | --------------------------------------------------------------------------------------------------- |
  | `language`            | User Interface Language. Default is `en` (English).                                                 |
  | `isGPSEnabled`        | set true / false to enable disbale location                                                         |
  | `geolocationRequired` | Whether or not geolocation permission is required. Default is `false`.                              |
  | `isUpdateModelsData`  | Whether or not to download the latest SDK models after credential verification. Default is `true`.  |
  | `accessToken`         | accessToken generated at user                                                                       |
  | `completion`          | If `Error?` is `nil`, the SDK was initialized successfully.                                         |

<a id="/Document Capture"></a>

[]()

<a id="//apple_ref/swift/Section/Document Capture"></a>

[]()

[](https://docs.idmission.com/markdown/mobile/reference/ios/Classes/IDentitySDK.md#/Document%20Capture)

<a id="document-capture"></a>

### Document Capture

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

  <a id="//apple_ref/swift/Method/documentCapture(from:documentName:processAsPOA:uploadDocument:completion:)"></a>

  `documentCapture(from:documentName:processAsPOA:uploadDocument:completion:)`

  Captures an additional document.

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

  #### Declaration

  Swift

  ```
  public class func documentCapture(from presenter: UIViewController, documentName name: String, processAsPOA: ProcessAsPOA?, uploadDocument: Bool = false, completion: @escaping DocumentCaptureCompletion)
  ```

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

  #### Parameters

  |                  |                                                                |
  | ---------------- | -------------------------------------------------------------- |
  | `presenter`      | `UIViewController` to present the flow from.                   |
  | `name`           | Additional document name.                                      |
  | `uploadDocument` | Additional document.                                           |
  | `processAsPOA`   | processAsPOA description                                       |
  | `completion`     | Returns a `AdditionalDocumentsRequest` to send to the server.  |

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

  <a id="//apple_ref/swift/Variable/apiBaseUrl"></a>

  `apiBaseUrl`

  RESTful API base URL. Default is: `https://api.idmission.com/`

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

  #### Declaration

  Swift

  ```
  static var apiBaseUrl: String { get set }
  ```

<a id="/XML Request"></a>

[]()

<a id="//apple_ref/swift/Section/XML Request"></a>

[]()

[](https://docs.idmission.com/markdown/mobile/reference/ios/Classes/IDentitySDK.md#/XML%20Request)

<a id="xml-request"></a>

### XML Request

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

  <a id="//apple_ref/swift/Method/getXMLString(request:genericDataDictionary:)"></a>

  `getXMLString(request:genericDataDictionary:)`

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

  #### Declaration

  Swift

  ```
  class func getXMLString(request: GenericDataRequest, genericDataDictionary: [String : Any]) -> String
  ```

<a id="/Helper Method"></a>

[]()

<a id="//apple_ref/swift/Section/Helper Method"></a>

[]()

[](https://docs.idmission.com/markdown/mobile/reference/ios/Classes/IDentitySDK.md#/Helper%20Method)

<a id="helper-method"></a>

### Helper Method

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

  <a id="//apple_ref/swift/Method/getJSONString(dictionary:)"></a>

  `getJSONString(dictionary:)`

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

  #### Declaration

  Swift

  ```
  class func getJSONString(dictionary: [String : Any]) -> String?
  ```

<a id="/Get JSON String"></a>

[]()

<a id="//apple_ref/swift/Section/Get JSON String"></a>

[]()

[](https://docs.idmission.com/markdown/mobile/reference/ios/Classes/IDentitySDK.md#/Get%20JSON%20String)

<a id="get-json-string"></a>

### Get JSON String

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

  <a id="//apple_ref/swift/Method/getImageJSONString(for:formKey:ifForFace:pdfDocumentName:extensionType:)"></a>

  `getImageJSONString(for:formKey:ifForFace:pdfDocumentName:extensionType:)`

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

  #### Declaration

  Swift

  ```
  class func getImageJSONString(for fileBase64: String, formKey: String, ifForFace: Bool? = nil, pdfDocumentName: String? = nil, extensionType: ExtensionType? = nil) -> String?
  ```

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

  <a id="//apple_ref/swift/Method/getFingerprintJSONString(fingerPrintData:)"></a>

  `getFingerprintJSONString(fingerPrintData:)`

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

  #### Declaration

  Swift

  ```
  class func getFingerprintJSONString(fingerPrintData: FingerPrintData?) -> String?
  ```

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

  <a id="//apple_ref/swift/Method/getVoiceJSONString(fileContent:formKey:)"></a>

  `getVoiceJSONString(fileContent:formKey:)`

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

  #### Declaration

  Swift

  ```
  class func getVoiceJSONString(fileContent: String, formKey: String) -> String?
  ```

<a id="/Get XML Tags"></a>

[]()

<a id="//apple_ref/swift/Section/Get XML Tags"></a>

[]()

[](https://docs.idmission.com/markdown/mobile/reference/ios/Classes/IDentitySDK.md#/Get%20XML%20Tags)

<a id="get-xml-tags"></a>

### Get XML Tags

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

  <a id="//apple_ref/swift/Method/getLiveFaceImageDataNode(formKey:formID:request:additionalData:)"></a>

  `getLiveFaceImageDataNode(formKey:formID:request:additionalData:)`

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

  #### Declaration

  Swift

  ```
  class func getLiveFaceImageDataNode(formKey: String, formID: String, request: GenericDataRequest, additionalData: [String : Any]?) -> String?
  ```

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

  <a id="//apple_ref/swift/Method/getPrimaryIdImageDataNode(formKey:serviceId:request:idType:countryCode:stateCode:)"></a>

  `getPrimaryIdImageDataNode(formKey:serviceId:request:idType:countryCode:stateCode:)`

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

  #### Declaration

  Swift

  ```
  class func getPrimaryIdImageDataNode(formKey: String, serviceId: String?, request: GenericDataRequest, idType: String?, countryCode: String?, stateCode: String?) -> String?
  ```

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

  <a id="//apple_ref/swift/Method/getSecodaryIdImageDataNode(formKey:request:idType_sec:countryCode_sec:stateCode_sec:)"></a>

  `getSecodaryIdImageDataNode(formKey:request:idType_sec:countryCode_sec:stateCode_sec:)`

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

  #### Declaration

  Swift

  ```
  class func getSecodaryIdImageDataNode(formKey: String, request: GenericDataRequest, idType_sec: String?, countryCode_sec: String?, stateCode_sec: String?) -> String?
  ```

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

  <a id="//apple_ref/swift/Method/getEmployeeInformationDataNode(request:employeeInfoXMLString:employeeCode:serviceID:)"></a>

  `getEmployeeInformationDataNode(request:employeeInfoXMLString:employeeCode:serviceID:)`

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

  #### Declaration

  Swift

  ```
  class func getEmployeeInformationDataNode(request: GenericDataRequest, employeeInfoXMLString: String?, employeeCode: String?, serviceID: String?) -> String?
  ```

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

  <a id="//apple_ref/swift/Method/getSignatureCaptureNode(request:)"></a>

  `getSignatureCaptureNode(request:)`

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

  #### Declaration

  Swift

  ```
  class func getSignatureCaptureNode(request: GenericDataRequest) -> String?
  ```

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

  <a id="//apple_ref/swift/Method/getFingerPrintXMLNode(request:for:)"></a>

  `getFingerPrintXMLNode(request:for:)`

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

  #### Declaration

  Swift

  ```
  class func getFingerPrintXMLNode(request: GenericDataRequest, for process: String) -> String?
  ```

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

  <a id="//apple_ref/swift/Method/getAdditionalDataXMLNode(loginId:merchantId:CompanyId:companyName:formKey:request:additionalDictionary:)"></a>

  `getAdditionalDataXMLNode(loginId:merchantId:CompanyId:companyName:formKey:request:additionalDictionary:)`

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

  #### Declaration

  Swift

  ```
  class func getAdditionalDataXMLNode(loginId: String, merchantId: String, CompanyId: String, companyName: String, formKey: String, request: GenericDataRequest, additionalDictionary: [String : Any]?) -> String?
  ```

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

  <a id="//apple_ref/swift/Variable/fingerprintDetectionModelName"></a>

  `fingerprintDetectionModelName`

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

  #### Declaration

  Swift

  ```
  public static var fingerprintDetectionModelName: String { get }
  ```

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

  <a id="//apple_ref/swift/Variable/focusModelName"></a>

  `focusModelName`

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

  #### Declaration

  Swift

  ```
  public static var focusModelName: String { get }
  ```

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

  <a id="//apple_ref/swift/Variable/version"></a>

  `version`

  Version of the SDK.

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

  #### Declaration

  Swift

  ```
  public static var version: String { get }
  ```

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

  <a id="//apple_ref/swift/Variable/pluginName"></a>

  `pluginName`

  Plugin or platform name of the application.

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

  #### Declaration

  Swift

  ```
  public static var pluginName: String
  ```

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

  <a id="//apple_ref/swift/Variable/requestID"></a>

  `requestID`

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

  #### Declaration

  Swift

  ```
  public static var requestID: String { get }
  ```

<a id="/ID Validation (20)"></a>

[]()

<a id="//apple_ref/swift/Section/ID Validation (20)"></a>

[]()

[](https://docs.idmission.com/markdown/mobile/reference/ios/Classes/IDentitySDK.md#/ID%20Validation%20%2820%29)

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

### ID Validation (20)

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

  <a id="//apple_ref/swift/Method/idValidation(from:customerDataOptions:options:captureBack:isSecondaryID:completion:)"></a>

  `idValidation(from:customerDataOptions:options:captureBack:isSecondaryID:completion:)`

  Capturing ID document(s), validate the ID and extract data from it.

- <a id="//apple_ref/swift/Method/idValidation(from:customerDataOptions:options:idType:idCountry:idState:isSecondaryID:completion:)"></a>

  `idValidation(from:customerDataOptions:options:idType:idCountry:idState:isSecondaryID:completion:)`

  Capturing ID document(s), validate the ID and extract data from it.

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

  <a id="//apple_ref/swift/Method/idValidation(from:customerDataOptions:options:isSecondaryID:completion:)"></a>

  `idValidation(from:customerDataOptions:options:isSecondaryID:completion:)`

  Capturing ID document(s), validate the ID and extract data from it.

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

  #### Declaration

  Swift

  ```
  public class func idValidation(from presenter: UIViewController,
                                 customerDataOptions: CommonCustomerDataRequest? = nil,
                                 options: AdditionalCustomerWFlagCommonData,
                                 isSecondaryID: Bool = false,
                                 completion: @escaping ValidateIdCompletion)
  ```

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

  #### Parameters

  |                       |                                                               |
  | --------------------- | ------------------------------------------------------------- |
  | `presenter`           | `UIViewController` to present the flow from.                  |
  | `customerDataOptions` | Its instance of CustomerValidateIdDataRequest                 |
  | `options`             | Service options.                                              |
  | `completion`          | Returns a `CustomerValidateIdRequest` to send to the server.  |

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

  <a id="//apple_ref/swift/Method/idValidation(from:customerDataOptions:options:captureBack:idType:idCountry:idState:isSecondaryID:completion:)"></a>

  `idValidation(from:customerDataOptions:options:captureBack:idType:idCountry:idState:isSecondaryID:completion:)`

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

  #### Declaration

  Swift

  ```
  public class func idValidation(from presenter: UIViewController,
                                  customerDataOptions: CommonCustomerDataRequest?,
                                  options: AdditionalCustomerWFlagCommonData,
                                  captureBack: Int?,  // enum CaptureBack rawValue
                                  idType: String?,
                                  idCountry: String?,
                                  idState: String?,
                                  isSecondaryID: Bool = false,
                                  completion: @escaping ValidateIdCompletion)
  ```

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

  <a id="//apple_ref/swift/Method/autofill(from:captureIdSide:completion:)"></a>

  `autofill(from:captureIdSide:completion:)`

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

  #### Declaration

  Swift

  ```
  public class func autofill(from presenter: UIViewController, captureIdSide: AutofillCaptureIdSide, completion: @escaping AutofillAPICompletion)
  ```

<a id="/Live Face Check (660)"></a>

[]()

<a id="//apple_ref/swift/Section/Live Face Check (660)"></a>

[]()

[](https://docs.idmission.com/markdown/mobile/reference/ios/Classes/IDentitySDK.md#/Live%20Face%20Check%20%28660%29)

<a id="live-face-check-660"></a>

### Live Face Check (660)

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

  <a id="//apple_ref/swift/Method/liveFaceCheck(from:customerDataOptions:options:completion:)"></a>

  `liveFaceCheck(from:customerDataOptions:options:completion:)`

  Live Face Detection features the ability to perform of a liveness check of the photo image that is sent via API.

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

  #### Declaration

  Swift

  ```
  public class func liveFaceCheck(from presenter: UIViewController,
                                  customerDataOptions: CommonCustomerDataRequest? = nil,
                                  options: AdditionalCustomerLiveCheckData? = nil,
                                  completion: @escaping LiveFaceCheckCompletion)
  ```

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

  #### Parameters

  |                       |                                                                 |
  | --------------------- | --------------------------------------------------------------- |
  | `presenter`           | `UIViewController` to present the flow from.                    |
  | `customerDataOptions` | Its instance of CustomerValidateIdDataRequest                   |
  | `options`             | `AdditionalCustomerLiveCheckData` Used to set Service options.  |
  | `completion`          | Returns a `CustomerLiveCheckRequest` to send to the server.     |

<a id="/Enroll Biometric (175)"></a>

[]()

<a id="//apple_ref/swift/Section/Enroll Biometric (175)"></a>

[]()

[](https://docs.idmission.com/markdown/mobile/reference/ios/Classes/IDentitySDK.md#/Enroll%20Biometric%20%28175%29)

<a id="enroll-biometric-175"></a>

### Enroll Biometric (175)

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

  <a id="//apple_ref/swift/Method/customerEnrollBiometrics(from:customerDataOptions:personalData:options:completion:)"></a>

  `customerEnrollBiometrics(from:customerDataOptions:personalData:options:completion:)`

  Customer Data sent is enrolled with customer record and not processed.

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

  #### Declaration

  Swift

  ```
  public class func customerEnrollBiometrics(from presenter: UIViewController,
                                             customerDataOptions: CommonCustomerDataRequest? = nil,
                                             personalData: PersonalCustomerEnrollBiometricsRequestData,
                                             options: AdditionalCustomerEnrollBiometricRequestData,
                                             completion: @escaping CustomerEnrollBiometricsCompletion)
  ```

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

  #### Parameters

  |                       |                                                                               |
  | --------------------- | ----------------------------------------------------------------------------- |
  | `presenter`           | `UIViewController` to present the flow from.                                  |
  | `customerDataOptions` | Its instance of CustomerValidateIdDataRequest                                 |
  | `personalData`        | `PersonalCustomerEnrollBiometricsRequestData` used to identify the customer.  |
  | `options`             | `AdditionalCustomerEnrollBiometricRequestData` Used to set Service options.   |
  | `completion`          | Returns a `CustomerEnrollBiometricsRequest` to send to the server.            |

<a id="/Customer Verification (105)"></a>

[]()

<a id="//apple_ref/swift/Section/Customer Verification (105)"></a>

[]()

[](https://docs.idmission.com/markdown/mobile/reference/ios/Classes/IDentitySDK.md#/Customer%20Verification%20%28105%29)

<a id="customer-verification-105"></a>

### Customer Verification (105)

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

  <a id="//apple_ref/swift/Method/customerVerification(from:customerDataOptions:personalData:options:completion:)"></a>

  `customerVerification(from:customerDataOptions:personalData:options:completion:)`

  Capture of biometric data to verify against a previously enrolled customer.

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

  #### Declaration

  Swift

  ```
  public class func customerVerification(from presenter: UIViewController,
                                         customerDataOptions: CommonCustomerDataRequest? = nil,
                                         personalData: PersonalCustomerVerifyData,
                                         options: AdditionalCustomerCommonData,
                                         completion: @escaping CustomerVerificationCompletion)
  ```

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

  #### Parameters

  |                       |                                                              |
  | --------------------- | ------------------------------------------------------------ |
  | `presenter`           | `UIViewController` to present the flow from.                 |
  | `customerDataOptions` | Its instance of CustomerValidateIdDataRequest                |
  | `personalData`        | `PersonalCustomerVerifyData` used to identify the customer.  |
  | `options`             | `AdditionalCustomerCommonData` Used to set Service options.  |
  | `completion`          | Returns a `CustomerVerifyRequest` to send to the server.     |

<a id="/Customer Biometric Verification (185)"></a>

[]()

<a id="//apple_ref/swift/Section/Customer Biometric Verification (185)"></a>

[]()

[](https://docs.idmission.com/markdown/mobile/reference/ios/Classes/IDentitySDK.md#/Customer%20Biometric%20Verification%20%28185%29)

<a id="customer-biometric-verification-185"></a>

### Customer Biometric Verification (185)

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

  <a id="//apple_ref/swift/Method/identifyCustomer(from:customerDataOptions:options:completion:)"></a>

  `identifyCustomer(from:customerDataOptions:options:completion:)`

  Capture biometric data for a Customer (face, fingerprint, voice or iris) and search the customer DB to see if its already enrolled.

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

  #### Declaration

  Swift

  ```
  public class func identifyCustomer(from presenter: UIViewController,
                                     customerDataOptions: CommonCustomerDataRequest? = nil,
                                     options: AdditionalCustomerCommonData,
                                     completion: @escaping CustomerIdentifyCompletion)
  ```

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

  #### Parameters

  |                       |                                                              |
  | --------------------- | ------------------------------------------------------------ |
  | `presenter`           | `UIViewController` to present the flow from.                 |
  | `customerDataOptions` | Its instance of CustomerValidateIdDataRequest                |
  | `options`             | `AdditionalCustomerCommonData` Used to set Service options.  |
  | `completion`          | Returns a `CustomerIdentifyRequest` to send to the server.   |

<a id="/ID Validation and Face Match (10)"></a>

[]()

<a id="//apple_ref/swift/Section/ID Validation and Face Match (10)"></a>

[]()

[](https://docs.idmission.com/markdown/mobile/reference/ios/Classes/IDentitySDK.md#/ID%20Validation%20and%20Face%20Match%20%2810%29)

<a id="id-validation-and-face-match-10"></a>

### ID Validation and Face Match (10)

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

  <a id="//apple_ref/swift/Variable/customerValidateSecondaryIdFaceMatchRequest"></a>

  `customerValidateSecondaryIdFaceMatchRequest`

  For secondaryId

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

  #### Declaration

  Swift

  ```
  public static var customerValidateSecondaryIdFaceMatchRequest: CustomerValidateIdFaceMatchRequest?
  ```

- <a id="//apple_ref/swift/Method/idValidationAndMatchFace(from:customerDataOptions:options:captureBack:isSecondaryID:completion:)"></a>

  `idValidationAndMatchFace(from:customerDataOptions:options:captureBack:isSecondaryID:completion:)`

  Capturing ID document(s), validate the ID and extract data from it. Additionally capture a selfie and match it against the photo on the ID.

- <a id="//apple_ref/swift/Method/idValidationAndMatchFace(from:customerDataOptions:options:idType:idCountry:idState:isSecondaryID:completion:)"></a>

  `idValidationAndMatchFace(from:customerDataOptions:options:idType:idCountry:idState:isSecondaryID:completion:)`

  Capturing ID document(s), validate the ID and extract data from it. Additionally capture a selfie and match it against the photo on the ID.

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

  <a id="//apple_ref/swift/Method/idValidationAndMatchFace(from:customerDataOptions:options:isSecondaryID:completion:)"></a>

  `idValidationAndMatchFace(from:customerDataOptions:options:isSecondaryID:completion:)`

  Capturing ID document(s), validate the ID and extract data from it. Additionally capture a selfie and match it against the photo on the ID.

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

  #### Declaration

  Swift

  ```
  public class func idValidationAndMatchFace(from presenter: UIViewController,
                                             customerDataOptions: CommonCustomerDataRequest? = nil,
                                             options: AdditionalCustomerWFlagCommonData,
                                             isSecondaryID: Bool = false,
                                             completion: @escaping ValidateIdMatchFaceCompletion)
  ```

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

  #### Parameters

  |                       |                                                              |
  | --------------------- | ------------------------------------------------------------ |
  | `presenter`           | `UIViewController` to present the flow from.                 |
  | `customerDataOptions` | Its instance of CustomerValidateIdDataRequest                |
  | `options`             | Service options.                                             |
  | `completion`          | Returns a `CustomerLiveCheckRequest` to send to the server.  |

<a id="/Enroll Customer with ID Validation (50)"></a>

[]()

<a id="//apple_ref/swift/Section/Enroll Customer with ID Validation (50)"></a>

[]()

[](https://docs.idmission.com/markdown/mobile/reference/ios/Classes/IDentitySDK.md#/Enroll%20Customer%20with%20ID%20Validation%20%2850%29)

<a id="enroll-customer-with-id-validation-50"></a>

### Enroll Customer with ID Validation (50)

- <a id="//apple_ref/swift/Method/idValidationAndCustomerEnroll(from:customerDataOptions:personalData:options:captureBack:completion:)"></a>

  `idValidationAndCustomerEnroll(from:customerDataOptions:personalData:options:captureBack:completion:)`

  Capturing ID document(s), validate that ID and extract data from it. Additionally capture a selfie of the customer and match it against the photo on the ID, then enroll all captured biometrics with the customer if the match is positive.

- <a id="//apple_ref/swift/Method/idValidationAndCustomerEnroll(from:customerDataOptions:personalData:options:idType:idCountry:idState:completion:)"></a>

  `idValidationAndCustomerEnroll(from:customerDataOptions:personalData:options:idType:idCountry:idState:completion:)`

  Capturing ID document(s), validate that ID and extract data from it. Additionally capture a selfie of the customer and match it against the photo on the ID, then enroll all captured biometrics with the customer if the match is positive.

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

  <a id="//apple_ref/swift/Method/idValidationAndCustomerEnroll(from:customerDataOptions:personalData:options:completion:)"></a>

  `idValidationAndCustomerEnroll(from:customerDataOptions:personalData:options:completion:)`

  Capturing ID document(s), validate that ID and extract data from it. Additionally capture a selfie of the customer and match it against the photo on the ID, then enroll all captured biometrics with the customer if the match is positive.

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

  #### Declaration

  Swift

  ```
  public class func idValidationAndCustomerEnroll(from presenter: UIViewController,
                                                  customerDataOptions: CommonCustomerDataRequest? = nil,
                                                  personalData: PersonalCustomerCommonRequestEnrollData,
                                                  options: AdditionalCustomerWFlagCommonData,
                                                  completion: @escaping ValidateIdCustomerEnrollCompletion)
  ```

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

  #### Parameters

  |              |                                                           |
  | ------------ | --------------------------------------------------------- |
  | `presenter`  | `UIViewController` to present the flow from.              |
  | `options`    | Service options.                                          |
  | `completion` | Returns a `CustomerEnrollRequest` to send to the server.  |

<a id="/SelfieCapture + IDCapture Methods"></a>

[]()

<a id="//apple_ref/swift/Section/SelfieCapture + IDCapture Methods"></a>

[]()

[](https://docs.idmission.com/markdown/mobile/reference/ios/Classes/IDentitySDK.md#/SelfieCapture%20%2B%20IDCapture%20Methods)

<a id="selfiecapture-idcapture-methods"></a>

### SelfieCapture + IDCapture Methods

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

  <a id="//apple_ref/swift/Variable/genericCustomerData"></a>

  `genericCustomerData`

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

  #### Declaration

  Swift

  ```
  public static var genericCustomerData: GenericCustomerData
  ```

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

  <a id="//apple_ref/swift/Variable/genericSignatureDataRequest"></a>

  `genericSignatureDataRequest`

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

  #### Declaration

  Swift

  ```
  public static var genericSignatureDataRequest: SignatureDataRequest?
  ```

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

  <a id="//apple_ref/swift/Method/genericApiCall(genericDataDictionary:completion:)"></a>

  `genericApiCall(genericDataDictionary:completion:)`

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

  #### Declaration

  Swift

  ```
  public class func genericApiCall(genericDataDictionary: [String : Any], completion: @escaping GenericAPICompletion)
  ```

<a id="/Document Capture2"></a>

[]()[]()

[](https://docs.idmission.com/markdown/mobile/reference/ios/Classes/IDentitySDK.md#/Document%20Capture2)

<a id="document-capture-2"></a>

### Document Capture

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

  <a id="//apple_ref/swift/Method/signatureCapture(from:completion:)"></a>

  `signatureCapture(from:completion:)`

  Captures an Signature.

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

  #### Declaration

  Swift

  ```
  public class func signatureCapture(from presenter: UIViewController, completion: @escaping SignatureCaptureCompletion)
  ```

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

  #### Parameters

  |              |                                                          |
  | ------------ | -------------------------------------------------------- |
  | `presenter`  | `UIViewController` to present the flow from.             |
  | `completion` | Returns a `SignatureDataRequest` to send to the server.  |

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

  <a id="//apple_ref/swift/Method/fingerPrintCapture(from:completion:)"></a>

  `fingerPrintCapture(from:completion:)`

  Captures an FingerPrint.

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

  #### Declaration

  Swift

  ```
  public class func fingerPrintCapture(from presenter: UIViewController, completion: @escaping FingerPrintCaptureCompletion)
  ```

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

  #### Parameters

  |              |                                                          |
  | ------------ | -------------------------------------------------------- |
  | `presenter`  | `UIViewController` to present the flow from.             |
  | `completion` | Returns a `SignatureDataRequest` to send to the server.  |

<a id="/Voice Capture"></a>

[]()

<a id="//apple_ref/swift/Section/Voice Capture"></a>

[]()

[](https://docs.idmission.com/markdown/mobile/reference/ios/Classes/IDentitySDK.md#/Voice%20Capture)

<a id="voice-capture"></a>

### Voice Capture

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

  <a id="//apple_ref/swift/Method/voiceCapture(from:completion:)"></a>

  `voiceCapture(from:completion:)`

  Captures voice audio data.

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

  #### Declaration

  Swift

  ```
  public class func voiceCapture(from presenter: UIViewController, completion: @escaping VoiceCaptureCompletion)
  ```

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

  #### Parameters

  |              |                                               |
  | ------------ | --------------------------------------------- |
  | `presenter`  | `UIViewController` to present the flow from.  |
  | `completion` | Returns an audio file `URL`.                  |

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