Search docsIDmission.com ↗
Mobile SDKs18 pages
Mobile SDKs / AdditionalCustomerEnrollBiometricRequestDataV3 Structure Reference

AdditionalCustomerEnrollBiometricRequestDataV3 Structure Reference

← Browse native SDK reference

Imported 2026-10-25View original source ↗How updates workRead Markdown
On this page · 19 sections

AdditionalCustomerEnrollBiometricRequestDataV3

public struct AdditionalCustomerEnrollBiometricRequestDataV3 : Encodable

Child structure of CustomerEnrollBiometricsRequest.

Properties

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

    Declaration

    Swift

    public var uniqueRequestId: String

  • Verification Approval Code

    Declaration

    Swift

    public var verificationApprovalCode: String?

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

    Declaration

    Swift

    public var clientRequestID: String?

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

    Declaration

    Swift

    public var stripSpecialCharacters: AdditionalCustomerEnrollBiometricRequestData.StripSpecialCharacters?

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

    Declaration

    Swift

    public var postDataAPIRequired: AdditionalCustomerEnrollBiometricRequestData.PostDataAPIRequired?

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

    Declaration

    Swift

    public var gpsCoordinates: String?

  • piiExclusion

    Declaration

    Swift

    public var piiExclusion: String?

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

    Declaration

    Swift

    public var needImmediateResponse: AdditionalCustomerEnrollBiometricRequestData.NeedImmediateResponse?

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

    Declaration

    Swift

    public var deDuplicationRequired: AdditionalCustomerEnrollBiometricRequestData.DeDuplicationRequired?

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

    Declaration

    Swift

    public var deDupDataRequiredInResponse: AdditionalCustomerEnrollBiometricRequestData.DeDupDataRequiredInResponse?

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

    Declaration

    Swift

    public var deDupManualReviewRequired: AdditionalCustomerEnrollBiometricRequestData.DeDupManualReviewRequired?

  • Whether or not to detect liveness.

    Declaration

    Swift

    public var detectLiveness: AdditionalCustomerEnrollBiometricRequestData.DetectLiveness?

  • Additional ID and/or Selfie Capture image metadata.

    Declaration

    Swift

    public var metadata: Metadata?

  • Additional decoded MRZ and/or Barcode metadata.

    Declaration

    Swift

    public var ocrMetadata: String?

Initialization

  • Designated initializer.

    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)

    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.
Report a docs issue

Copy this context into your team’s issue tracker or an email to support@idmission.com.