AdditionalCustomerEnrollBiometricRequestData

public struct AdditionalCustomerEnrollBiometricRequestData : Encodable

Child structure of CustomerEnrollBiometricsRequest.

Enumerations

  • Whether or not IDmission’s ID Verification Team will perform a manual review of the submitted form in the event it is not auto-decisioned. Default is no.

    See more

    Declaration

    Swift

    public enum ManualReviewRequired : String, Encodable

  • Whether or not the system will confirm that the age of the individual is 18 or older based on the date of birth and current date. Default is no.

    See more

    Declaration

    Swift

    public enum BypassAgeValidation : String, Encodable

  • Whether or not the input images (ID Front/ID Back/Customer Selfie) will be sent in the POST_API. Default is no.

    See more

    Declaration

    Swift

    public enum SendInputImagesInPost : String, Encodable

  • Whether or not the processed images (ID front/ID back which have been cropped/marked up with security features, etc.) will be sent in the POST_API. Default is no.

    See more

    Declaration

    Swift

    public enum SendProcessedImagesInPost : String, Encodable

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

    See more

    Declaration

    Swift

    public enum DeduplicationSynchronous : String, Encodable

  • Whether or not customer data will be verified with the data returned back from the host. Default is no.

    See more

    Declaration

    Swift

    public enum VerifyDataWithHost : String, Encodable

  • Whether or not the ID Back is mandatory for all ID types where Back is present. Default is yes.

    See more

    Declaration

    Swift

    public enum IdBackImageRequired : String, Encodable

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

    See more

    Declaration

    Swift

    public enum StripSpecialCharacters : String, Encodable

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

    See more

    Declaration

    Swift

    public enum PostDataAPIRequired : String, Encodable

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

    See more

    Declaration

    Swift

    public enum NeedImmediateResponse : String, Encodable

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

    See more

    Declaration

    Swift

    public enum DeDuplicationRequired : String, Encodable

  • Whether or not the minimum resolution required for ID Documents is checked. Default is yes.

    See more

    Declaration

    Swift

    public enum IdImageResolutionCheck : String, Encodable

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

    See more

    Declaration

    Swift

    public enum DeDupDataRequiredInResponse : String, Encodable

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

    See more

    Declaration

    Swift

    public enum DeDupManualReviewRequired : String, Encodable

  • Whether or not posting data on review is required. Default is yes.

    See more

    Declaration

    Swift

    public enum PostDataOnReviewRequired : String, Encodable

  • Whether or not to detect liveness. Default is yes.

    See more

    Declaration

    Swift

    public enum DetectLiveness : String, Encodable
  • See more

    Declaration

    Swift

    public enum DetectLabel : String, Encodable

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

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

    Declaration

    Swift

    public var clientRequestID: String?

  • Whether or not IDmission’s ID Verification Team will perform a manual review of the submitted form in the event it is not auto-decisioned. Default is no.

    Declaration

    Swift

    public var manualReviewRequired: ManualReviewRequired?

  • Whether or not the system will confirm that the age of the individual is 18 or older based on the date of birth and current date. Default is no.

    Declaration

    Swift

    public var bypassAgeValidation: BypassAgeValidation?

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

    Declaration

    Swift

    public var deDuplicationRequired: DeDuplicationRequired?

  • 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: PostDataAPIRequired?

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

    Declaration

    Swift

    public var postDataAPIURL: String?

  • Used only when the POST_DATA API flag = Y

    If nil, no input images will be sent in the POST_API. Default is no.

    Declaration

    Swift

    public var sendInputImagesInPost: SendInputImagesInPost?

  • Used only when the POST_DATA API flag = Y

    If nil, no processed images will be sent in the POST_API. Default is no.

    Declaration

    Swift

    public var sendProcessedImagesInPost: SendProcessedImagesInPost?

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

    Declaration

    Swift

    public var needImmediateResponse: NeedImmediateResponse?

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

    Declaration

    Swift

    public var deduplicationSynchronous: DeduplicationSynchronous?

  • Whether or not customer data will be verified with the data returned back from the host. Default is no.

    Declaration

    Swift

    public var verifyDataWithHost: VerifyDataWithHost?

  • Whether or not the ID Back is mandatory for all ID types where Back is present. Default is yes.

    Declaration

    Swift

    public var idBackImageRequired: IdBackImageRequired?

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

    Declaration

    Swift

    public var stripSpecialCharacters: StripSpecialCharacters?

  • Whether or not the minimum resolution required for ID Documents is checked. Default is yes.

    Declaration

    Swift

    public var idImageResolutionCheck: IdImageResolutionCheck?

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

    Declaration

    Swift

    public var deDupDataRequiredInResponse: DeDupDataRequiredInResponse?

  • Whether or not the deduplication Manual Review is required in the response. Default is no.

    Declaration

    Swift

    public var deDupManualReviewRequired: DeDupManualReviewRequired?

  • Whether or not posting data on review is required. Default is yes.

    Declaration

    Swift

    public var postDataOnReviewRequired: PostDataOnReviewRequired?

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

    Declaration

    Swift

    public var postDataOnReviewAPIURL: String?

  • Payment gateway details.

    Declaration

    Swift

    public var paymentGateway: String?

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

    Declaration

    Swift

    public var gpsCoordinates: String?

  • piiExclusion details.

    Declaration

    Swift

    public var piiExclusion: String?

  • Y - Check liveness of the Face Image. * N - Do not check liveness of the Face Image. This field will be deprecated in future versions.

    Declaration

    Swift

    public var detectLiveness: DetectLiveness?

  • Valid values are: Y or N

    Declaration

    Swift

    public var detectLabel: DetectLabel?

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

  • Verification Approval Code

    Declaration

    Swift

    public var verificationApprovalCode: String?

Initialization

  • Designated initializer.

    Declaration

    Swift

    public init(uniqueRequestId: String = IDentitySDK.requestID,
            clientRequestID: String? = nil,
            manualReviewRequired: ManualReviewRequired? = .no,
            bypassAgeValidation: BypassAgeValidation? = .no,
            deDuplicationRequired: DeDuplicationRequired? = nil,
            postDataAPIRequired: PostDataAPIRequired? = .no,
            postDataAPIURL: String? = nil,
            sendInputImagesInPost: SendInputImagesInPost? = .no,
            sendProcessedImagesInPost: SendProcessedImagesInPost? = .no,
            needImmediateResponse: NeedImmediateResponse? = nil,
            deduplicationSynchronous: DeduplicationSynchronous? = .no,
            verifyDataWithHost: VerifyDataWithHost? = .no,
            idBackImageRequired: IdBackImageRequired? = .yes,
            stripSpecialCharacters: StripSpecialCharacters? = .yes,
            idImageResolutionCheck: IdImageResolutionCheck? = .yes,
            deDupDataRequiredInResponse: DeDupDataRequiredInResponse? = .yes,
            deDupManualReviewRequired: DeDupManualReviewRequired? = .yes,
            postDataOnReviewRequired: PostDataOnReviewRequired? = .yes,
            postDataOnReviewAPIURL: String? = nil,
            paymentGateway: String? = nil,
            gpsCoordinates: String? = nil,
            piiExclusion: String? = nil,
            detectLiveness: DetectLiveness? = .yes,
            detectLabel: DetectLabel? = .no,
            verificationApprovalCode: String? = nil)

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

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

    Whether or not IDmission’s ID Verification Team will perform a manual review of the submitted form in the event it is not auto-decisioned. Default is no.
    bypassAgeValidation

    Whether or not the system will confirm that the age of the individual is 18 or older based on the date of birth and current date. Default is no.
    deDuplicationRequired

    Whether or not deduplication is to be performed against the enrolled customer’s face image.
    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.
    sendInputImagesInPost

    Input images to be sent in the POST_API.
    sendProcessedImagesInPost

    Processed images will be sent in the POST_API
    needImmediateResponse

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

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

    Whether or not customer data will be verified with the data returned back from the host. Default is no.
    idBackImageRequired

    Whether or not the ID Back is mandatory for all ID types where Back is present. Default is yes.
    stripSpecialCharacters

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

    Whether or not the minimum resolution required for ID Documents is checked. Default is yes.
    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.
    postDataOnReviewRequired

    Whether or not posting data on review is required. Default is yes.
    postDataOnReviewAPIURL

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

    Payment gateway details.
    gpsCoordinates

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

    piiExclusion details.
    detectLiveness

    Whether or not to detect liveness.
    detectLabel

    Valid values are: Y or N
    verificationApprovalCode

    Verification Approval Code

Init Method For Backward compatibility