AdditionalCustomerWFlagCommonDataV3
public struct AdditionalCustomerWFlagCommonDataV3 : Encodable
Child structure of CustomerEnrollRequest
, CustomerValidateIdFaceMatchRequest
, and CustomerValidateIdRequest
.
-
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 Trace ID generated by client applicationIt can be as long as 256 characters.
Declaration
Swift
public var clientTraceId: 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: AdditionalCustomerWFlagCommonData.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: AdditionalCustomerWFlagCommonData.BypassAgeValidation?
-
Whether or not deduplication is to be performed against the enrolled customer’s face image. Default is
no
.Declaration
Swift
public var deDuplicationRequired: AdditionalCustomerWFlagCommonData.DeDuplicationRequired?
-
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: AdditionalCustomerWFlagCommonData.BypassNameMatching?
-
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: AdditionalCustomerWFlagCommonData.PostDataAPIRequired?
-
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: AdditionalCustomerWFlagCommonData.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: AdditionalCustomerWFlagCommonData.SendProcessedImagesInPost?
-
Whether or not the submitting system requires an immediate response back to the request. Default is
no
.Declaration
Swift
public var needImmediateResponse: AdditionalCustomerWFlagCommonData.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: AdditionalCustomerWFlagCommonData.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: AdditionalCustomerWFlagCommonData.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: AdditionalCustomerWFlagCommonData.IdBackImageRequired?
-
Whether or not to strip special characters. Default is
yes
.Declaration
Swift
public var stripSpecialCharacters: AdditionalCustomerWFlagCommonData.StripSpecialCharacters?
-
Whether or not the minimum resolution required for ID Documents is checked. Default is
yes
.Declaration
Swift
public var idImageResolutionCheck: AdditionalCustomerWFlagCommonData.IdImageResolutionCheck?
-
Whether or not the deduplication data is required in the response. Default is
yes
.Declaration
Swift
public var deDupDataRequiredInResponse: AdditionalCustomerWFlagCommonData.DeDupDataRequiredInResponse?
-
Whether or not the deduplication Manual Review is required in the response. Default is
no
.Declaration
Swift
public var deDupManualReviewRequired: AdditionalCustomerWFlagCommonData.DeDupManualReviewRequired?
-
Whether or not posting data on review is required. Default is
yes
.Declaration
Swift
public var postDataOnReviewRequired: AdditionalCustomerWFlagCommonData.PostDataOnReviewRequired?
-
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?
-
Whether or not to send processed images in response. Default is
yes
.Declaration
Swift
public var sendProcessedImagesInResponse: AdditionalCustomerWFlagCommonData.SendProcessedImagesInResponse?
-
Whether or not to send input images in response. Default is
yes
.Declaration
Swift
public var sendInputImagesInResponse: AdditionalCustomerWFlagCommonData.SendInputImagesInResponse?
-
Additional ID and/or Selfie Capture image metadata.
Declaration
Swift
public var metadata: Metadata?
-
Additional decoded MRZ, Barcode, and/or NFC chip metadata.
Declaration
Swift
public var ocrMetadata: String?
-
init(uniqueRequestId:
clientTraceId: clientRequestID: manualReviewRequired: bypassAgeValidation: deDuplicationRequired: bypassNameMatching: postDataAPIRequired: sendInputImagesInPost: sendProcessedImagesInPost: needImmediateResponse: deduplicationSynchronous: verifyDataWithHost: idBackImageRequired: stripSpecialCharacters: idImageResolutionCheck: deDupDataRequiredInResponse: deDupManualReviewRequired: postDataOnReviewRequired: paymentGateway: gpsCoordinates: piiExclusion: sendProcessedImagesInResponse: sendInputImagesInResponse: ) Designated initializer.
Declaration
Swift
public init(uniqueRequestId: String = IDentitySDK.requestID, clientTraceId: String? = nil, clientRequestID: String? = nil, manualReviewRequired: AdditionalCustomerWFlagCommonData.ManualReviewRequired? = .no, bypassAgeValidation: AdditionalCustomerWFlagCommonData.BypassAgeValidation? = .no, deDuplicationRequired: AdditionalCustomerWFlagCommonData.DeDuplicationRequired? = .no, bypassNameMatching: AdditionalCustomerWFlagCommonData.BypassNameMatching? = .yes, postDataAPIRequired: AdditionalCustomerWFlagCommonData.PostDataAPIRequired? = .no, sendInputImagesInPost: AdditionalCustomerWFlagCommonData.SendInputImagesInPost? = .no, sendProcessedImagesInPost: AdditionalCustomerWFlagCommonData.SendProcessedImagesInPost? = .no, needImmediateResponse: AdditionalCustomerWFlagCommonData.NeedImmediateResponse? = .no, deduplicationSynchronous: AdditionalCustomerWFlagCommonData.DeduplicationSynchronous? = .no, verifyDataWithHost: AdditionalCustomerWFlagCommonData.VerifyDataWithHost? = .no, idBackImageRequired: AdditionalCustomerWFlagCommonData.IdBackImageRequired? = .yes, stripSpecialCharacters: AdditionalCustomerWFlagCommonData.StripSpecialCharacters? = .yes, idImageResolutionCheck: AdditionalCustomerWFlagCommonData.IdImageResolutionCheck? = .yes, deDupDataRequiredInResponse: AdditionalCustomerWFlagCommonData.DeDupDataRequiredInResponse? = .yes, deDupManualReviewRequired: AdditionalCustomerWFlagCommonData.DeDupManualReviewRequired? = .no, postDataOnReviewRequired: AdditionalCustomerWFlagCommonData.PostDataOnReviewRequired? = .yes, paymentGateway: String? = nil, gpsCoordinates: String? = nil, piiExclusion: String? = nil, sendProcessedImagesInResponse: AdditionalCustomerWFlagCommonData.SendProcessedImagesInResponse? = .yes, sendInputImagesInResponse: AdditionalCustomerWFlagCommonData.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
.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
.paymentGateway
Payment gateway details.
gpsCoordinates
Get location details in GPS Co-ordinate Format (Latitude & Longitude).
piiExclusion
piiExclusion details.
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
.