AdditionalCustomerWFlagCommonData

public struct AdditionalCustomerWFlagCommonData : Encodable

Child structure of CustomerEnrollRequest, CustomerValidateIdFaceMatchRequest, and CustomerValidateIdRequest.

Enumerations

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.
See more
Declaration
Swift

public enum ManualReviewRequired : String, Encodable
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.
See more
Declaration
Swift

public enum BypassAgeValidation : String, Encodable
DeDuplicationRequired
Whether or not deduplication is to be performed against the enrolled customer’s face image. Default is no.
See more
Declaration
Swift

public enum DeDuplicationRequired : String, Encodable
BypassNameMatching
Whether or not the system will validate that the name provided in the reqeust with the Extracted Name. Default is yes.
See more
Declaration
Swift

public enum BypassNameMatching : String, Encodable
PostDataAPIRequired
Whether or not the POST_API call will get triggered. Default is no.
See more
Declaration
Swift

public enum PostDataAPIRequired : String, Encodable
SendInputImagesInPost
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
SendProcessedImagesInPost
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
NeedImmediateResponse
Whether or not the submitting system requires an immediate response back to the request. Default is no.
See more
Declaration
Swift

public enum NeedImmediateResponse : String, Encodable
DeduplicationSynchronous
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
VerifyDataWithHost
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
IdBackImageRequired
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
StripSpecialCharacters
Whether or not to strip special characters. Default is yes.
See more
Declaration
Swift

public enum StripSpecialCharacters : String, Encodable
IdImageResolutionCheck
Whether or not the minimum resolution required for ID Documents is checked. Default is yes.
See more
Declaration
Swift

public enum IdImageResolutionCheck : String, Encodable
DeDupDataRequiredInResponse
Whether or not the deduplication data is required in the response. Default is yes.
See more
Declaration
Swift

public enum DeDupDataRequiredInResponse : String, Encodable
DeDupManualReviewRequired
Whether or not the deduplication Manual Review is required in the response. Default is yes.
See more
Declaration
Swift

public enum DeDupManualReviewRequired : String, Encodable
PostDataOnReviewRequired
Whether or not posting data on review is required. Default is yes.
See more
Declaration
Swift

public enum PostDataOnReviewRequired : String, Encodable
SendProcessedImagesInResponse
Whether or not to send processed images in response. Default is yes.
See more
Declaration
Swift

public enum SendProcessedImagesInResponse : String, Encodable
SendInputImagesInResponse
Whether or not to send input images in response. Default is yes.
See more
Declaration
Swift

public enum SendInputImagesInResponse : String, Encodable


                    
                    
                    DetectLiveness

Declaration

Swift

public enum DetectLiveness : String, Encodable


                    
                    
                    DetectLabel

Declaration

Swift

public enum DetectLabel : String, Encodable

Properties

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

public var uniqueRequestId: String
clientTraceId
Client Trace ID generated by client applicationIt can be as long as 256 characters.
Declaration
Swift

public var clientTraceId: String?
clientRequestID
Client Request ID generated by client applicationIt can be as long as 256 characters.
Declaration
Swift

public var clientRequestID: String?
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.
Declaration
Swift

public var manualReviewRequired: ManualReviewRequired?
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.
Declaration
Swift

public var bypassAgeValidation: BypassAgeValidation?
deDuplicationRequired
Whether or not deduplication is to be performed against the enrolled customer’s face image. Default is no.
Declaration
Swift

public var deDuplicationRequired: DeDuplicationRequired?
bypassNameMatching
Whether or not the system will validate that the name provided in the reqeust with the Extracted Name. Default is yes.
Declaration
Swift

public var bypassNameMatching: BypassNameMatching?
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.

If nil, POST_API will not be triggered and no data will be posted to the host. If this is set to Y, the below fields are applicable. Default is no.
Declaration
Swift

public var postDataAPIRequired: PostDataAPIRequired?
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.
Declaration
Swift

public var postDataAPIURL: String?
sendInputImagesInPost
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?
sendProcessedImagesInPost
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?
needImmediateResponse
Whether or not the submitting system requires an immediate response back to the request. Default is no.
Declaration
Swift

public var needImmediateResponse: NeedImmediateResponse?
deduplicationSynchronous
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?
verifyDataWithHost
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?
idBackImageRequired
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?
stripSpecialCharacters
Whether or not to strip special characters. Default is yes.
Declaration
Swift

public var stripSpecialCharacters: StripSpecialCharacters?
idImageResolutionCheck
Whether or not the minimum resolution required for ID Documents is checked. Default is yes.
Declaration
Swift

public var idImageResolutionCheck: IdImageResolutionCheck?
deDupDataRequiredInResponse
Whether or not the deduplication data is required in the response. Default is yes.
Declaration
Swift

public var deDupDataRequiredInResponse: DeDupDataRequiredInResponse?
deDupManualReviewRequired
Whether or not the deduplication Manual Review is required in the response. Default is no.
Declaration
Swift

public var deDupManualReviewRequired: DeDupManualReviewRequired?
postDataOnReviewRequired
Whether or not posting data on review is required. Default is yes.
Declaration
Swift

public var postDataOnReviewRequired: PostDataOnReviewRequired?
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.
Declaration
Swift

public var postDataOnReviewAPIURL: String?
paymentGateway
Payment gateway details.
Declaration
Swift

public var paymentGateway: String?
gpsCoordinates
Get location details in GPS Co-ordinate Format (Latitude & Longitude).
Declaration
Swift

public var gpsCoordinates: String?
piiExclusion
piiExclusion details.
Declaration
Swift

public var piiExclusion: String?
detectLiveness
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?
detectLabel
Valid values are: Y or N
Declaration
Swift

public var detectLabel: DetectLabel?


                    
                    
                    customerDataMatchConfig

CustomerDataMatchConfig

Declaration

Swift

public var customerDataMatchConfig: CustomerDataMatchConfig?

sendProcessedImagesInResponse
Whether or not to send processed images in response. Default is yes.
Declaration
Swift

public var sendProcessedImagesInResponse: SendProcessedImagesInResponse?
sendInputImagesInResponse
Whether or not to send input images in response. Default is yes.
Declaration
Swift

public var sendInputImagesInResponse: SendInputImagesInResponse?
metadata
Additional ID and/or Selfie Capture image metadata.
Declaration
Swift

public var metadata: Metadata?
ocrMetadata
Additional decoded MRZ, Barcode, and/or NFC chip metadata.
Declaration
Swift

public var ocrMetadata: String?

Initialization


                    
                    
                    init(uniqueRequestId:clientTraceId:clientRequestID:manualReviewRequired:bypassAgeValidation:deDuplicationRequired:bypassNameMatching:postDataAPIRequired:postDataAPIURL:sendInputImagesInPost:sendProcessedImagesInPost:needImmediateResponse:deduplicationSynchronous:verifyDataWithHost:idBackImageRequired:stripSpecialCharacters:idImageResolutionCheck:deDupDataRequiredInResponse:deDupManualReviewRequired:postDataOnReviewRequired:postDataOnReviewAPIURL:paymentGateway:gpsCoordinates:piiExclusion:detectLiveness:detectLabel:customerDataMatchConfig:sendProcessedImagesInResponse:sendInputImagesInResponse:)

Designated initializer.

Declaration

Swift

public init(uniqueRequestId: String = IDentitySDK.requestID,
            clientTraceId: String? = nil,
            clientRequestID: String? = nil,
            manualReviewRequired: ManualReviewRequired? = .no,
            bypassAgeValidation: BypassAgeValidation? = .no,
            deDuplicationRequired: DeDuplicationRequired? = .no,
            bypassNameMatching: BypassNameMatching? = .yes,
            postDataAPIRequired: PostDataAPIRequired? = .no,
            postDataAPIURL: String? = nil,
            sendInputImagesInPost: SendInputImagesInPost? = .no,
            sendProcessedImagesInPost: SendProcessedImagesInPost? = .no,
            needImmediateResponse: NeedImmediateResponse? = .no,
            deduplicationSynchronous: DeduplicationSynchronous? = .no,
            verifyDataWithHost: VerifyDataWithHost? = .no,
            idBackImageRequired: IdBackImageRequired? = .yes,
            stripSpecialCharacters: StripSpecialCharacters? = .yes,
            idImageResolutionCheck: IdImageResolutionCheck? = .yes,
            deDupDataRequiredInResponse: DeDupDataRequiredInResponse? = .yes,
            deDupManualReviewRequired: DeDupManualReviewRequired? = .no,
            postDataOnReviewRequired: PostDataOnReviewRequired? = .yes,
            postDataOnReviewAPIURL: String? = nil,
            paymentGateway: String? = nil,
            gpsCoordinates: String? = nil,
            piiExclusion: String? = nil,
            detectLiveness: DetectLiveness? = .yes,
            detectLabel: DetectLabel? = .no,
            customerDataMatchConfig: CustomerDataMatchConfig? = nil,
            sendProcessedImagesInResponse: SendProcessedImagesInResponse? = .yes,
            sendInputImagesInResponse: SendInputImagesInResponse? = .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`.
`clientTraceId`	Client Trace ID generated by client applicationIt can be as long as 256 characters.
`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. Default is `no`.
`bypassNameMatching`	Whether or not the system will validate that the name provided in the reqeust with the Extracted Name. Default is `yes`.
`postDataAPIRequired`	Whether or not the POST_API call will get triggered. Default is `no`.
`postDataAPIURL`
`sendInputImagesInPost`	Whether or not the input images (ID Front/ID Back/Customer Selfie) will be sent in the POST_API. Default is `no`.
`sendProcessedImagesInPost`	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`.
`needImmediateResponse`	Whether or not the submitting system requires an immediate response back to the request. Default is `no`.
`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 the deduplication Manual Review is required in the response. Default is `no`.
`postDataOnReviewRequired`	Whether or not posting data on review is required. Default is `yes`.
`postDataOnReviewAPIURL`
`paymentGateway`	Payment gateway details.
`gpsCoordinates`	Get location details in GPS Co-ordinate Format (Latitude & Longitude).
`piiExclusion`	piiExclusion details.
`detectLiveness`
`detectLabel`
`customerDataMatchConfig`
`sendProcessedImagesInResponse`	Whether or not to send processed images in response. Default is `yes`.
`sendInputImagesInResponse`	Whether or not to send input images in response. Default is `yes`.

Init Method For Backward compatibility


                    
                    
                    init(from:)

Declaration

Swift

public init(from oldObject: AdditionalCustomerWFlagCommonDataV3)