IDentity-SDK/com.idmission.sdk2.client.model/AdditionalCustomerFlagData

AdditionalCustomerFlagData

@Serializable()

public final class AdditionalCustomerFlagData

Constructors

public AdditionalCustomerFlagData AdditionalCustomerFlagData(String uniqueRequestId, String clientRequestID, ManualReviewRequired manualReviewRequired, BypassAgeValidation bypassAgeValidation, DeDuplicationRequired deDuplicationRequired, PostDataAPIRequired postDataAPIRequired, String postDataAPIURL, String sendMetaDataInPost, SendInputImagesInPost sendInputImagesInPost, SendProcessedImagesInPost sendProcessedImagesInPost, NeedImmediateResponse needImmediateResponse, DeduplicationSynchronous deduplicationSynchronous, VerifyDataWithHost verifyDataWithHost, IdBackImageRequired idBackImageRequired, StripSpecialCharacter stripSpecialCharacters, IDImageResolutionCheck idImageResolutionCheck, DeDupDataRequiredInResponse deDupDataRequiredInResponse, String deDupManualReviewRequired, PostDataOnReviewRequired postDataOnReviewRequired, String paymentGateway, String gpsCoordinates, String piiExclusion, DetectLiveness detectLiveness, String detectLabel, String detectClosedEyes, String sendSignatureFromIdInResponse, String sendDocumentIdInResponse, String clientTraceId, String metadata, String ocrMetadata, SendProcessedImagesInResponse sendProcessedImagesInResponse, CustomerDataMatchConfig customerDataMatchConfig, SendInputImagesInResponse sendInputImagesInResponse, IsRealId realIdCheckRequired, BypassNameMatching bypassNameMatching)

@JvmOverloads()

public AdditionalCustomerFlagData AdditionalCustomerFlagData(String uniqueRequestId, String clientRequestID, ManualReviewRequired manualReviewRequired, BypassAgeValidation bypassAgeValidation)

@JvmOverloads()

public AdditionalCustomerFlagData AdditionalCustomerFlagData(String uniqueRequestId, String clientRequestID, ManualReviewRequired manualReviewRequired)

@JvmOverloads()

public AdditionalCustomerFlagData AdditionalCustomerFlagData(String uniqueRequestId, String clientRequestID)

@JvmOverloads()

public AdditionalCustomerFlagData AdditionalCustomerFlagData(String uniqueRequestId)

@JvmOverloads()

public AdditionalCustomerFlagData AdditionalCustomerFlagData()

Properties

bypassAgeValidation

private BypassAgeValidation bypassAgeValidation

string example: N Valid values are:

bypassNameMatching

private BypassNameMatching bypassNameMatching

Type: string
example: N
Valid Values are:

clientRequestID

private final String clientRequestID

Type: string
maxLength: 256
example: 56975421474
Client Request ID generated by client applicationIt can be as long as 256 characters.

clientTraceId

private String clientTraceId

Type: string
maxLength: 256 example: 56975421474
Valid values are:
Client Trace ID generated by client applicationIt can be as long as 256 characters.

customerDataMatchConfig

private CustomerDataMatchConfig customerDataMatchConfig

CustomerDataMatchConfig data

deDupDataRequiredInResponse

private DeDupDataRequiredInResponse deDupDataRequiredInResponse

string nullable: true example: Y Valid values are:

deDuplicationRequired

private DeDuplicationRequired deDuplicationRequired

string example: N Valid values are:

deduplicationSynchronous

private DeduplicationSynchronous deduplicationSynchronous

string nullable: true example: N Valid values are:

deDupManualReviewRequired

private String deDupManualReviewRequired

string example: Y Valid values are:

detectClosedEyes

private String detectClosedEyes

string nullable: true example: Y Eye close detection. Valid values are:

detectLabel

private String detectLabel

string nullable: true example: N Valid values are:

detectLiveness

private DetectLiveness detectLiveness

Type: string
example: N
Valid values are:

gpsCoordinates

private String gpsCoordinates

idBackImageRequired

private IdBackImageRequired idBackImageRequired

string nullable: true example: Y Valid values are:

idImageResolutionCheck

private IDImageResolutionCheck idImageResolutionCheck

string example: Y Valid values are:

manualReviewRequired

private ManualReviewRequired manualReviewRequired

string example: N Valid values are:

metadata

private String metadata

needImmediateResponse

private NeedImmediateResponse needImmediateResponse

string nullable: true example: N Valid values are:

ocrMetadata

private String ocrMetadata

paymentGateway

private String paymentGateway

string example: Apriva/FREEDOMPAY Payment Processing Gateway.

piiExclusion

private String piiExclusion

string example: N PII_exclusion.

postDataAPIRequired

private PostDataAPIRequired postDataAPIRequired

string nullable: true example: N The POST Data API is triggered after the form reaches it final state and provides the final decision, extracted / corrected data. When this parameter is set to Y, it requires a URL to be set in Company Settings (if the same URL is to be always used) or a URL to be sent in the postDataAPIURL parameter. Valid values are:

postDataAPIURL

private final String postDataAPIURL

string example: 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.

postDataOnReviewRequired

private PostDataOnReviewRequired postDataOnReviewRequired

string example: N The POST Data API is triggered if a form is sent for manual review, to notify you of the review status and include any auto-extracted data. When this parameter is set to Y, it requires a URL to be set in Company Settings (if the same URL is to be always used) or a URL to be sent in the postDataOnReviewAPIURL parameter.

realIdCheckRequired

private IsRealId realIdCheckRequired

Type: string
example: N
Valid values are:

sendDocumentIdInResponse

private String sendDocumentIdInResponse

string nullable: true example: N Returns urn for documents instead of Base64 data in response. Valid values are:

sendInputImagesInPost

private SendInputImagesInPost sendInputImagesInPost

Type: string
example: N
Used only when the POST_DATA API flag = Y.
Valid values are:

sendInputImagesInResponse

private SendInputImagesInResponse sendInputImagesInResponse

Type: string
example: N
Valid values are:

sendMetaDataInPost

private final String sendMetaDataInPost

string nullable: true example: N If postDataAPIRequired request parameter = Y, this field can be used to send metadata in postDataAPI webhook. Valid values are:

sendProcessedImagesInPost

private SendProcessedImagesInPost sendProcessedImagesInPost

Type: string
example: N
Used only when the POST_DATA API flag = Y.
Valid values are:

sendProcessedImagesInResponse

private SendProcessedImagesInResponse sendProcessedImagesInResponse

Type: string
example: N
Valid values are:

sendSignatureFromIdInResponse

private String sendSignatureFromIdInResponse

string nullable: true example: N Returns signature from ID in response. Valid values are:

stripSpecialCharacters

private StripSpecialCharacter stripSpecialCharacters

Type: string
nullable: true
example: N
Valid values are:
Y:
N:

uniqueRequestId

private final String uniqueRequestId

Type: string
maxLength: 256
example: 56975421474
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.

verifyDataWithHost

private VerifyDataWithHost verifyDataWithHost

string nullable: true example: N Valid values are:

Functions

getBypassAgeValidation

public final BypassAgeValidation getBypassAgeValidation()

string example: N Valid values are:

getBypassNameMatching

public final BypassNameMatching getBypassNameMatching()

Type: string
example: N
Valid Values are:

getClientRequestID

public final String getClientRequestID()

Type: string
maxLength: 256
example: 56975421474
Client Request ID generated by client applicationIt can be as long as 256 characters.

getClientTraceId

public final String getClientTraceId()

Type: string
maxLength: 256 example: 56975421474
Valid values are:
Client Trace ID generated by client applicationIt can be as long as 256 characters.

getCustomerDataMatchConfig

public final CustomerDataMatchConfig getCustomerDataMatchConfig()

CustomerDataMatchConfig data

getDeDupDataRequiredInResponse

public final DeDupDataRequiredInResponse getDeDupDataRequiredInResponse()

string nullable: true example: Y Valid values are:

getDeDuplicationRequired

public final DeDuplicationRequired getDeDuplicationRequired()

string example: N Valid values are:

getDeduplicationSynchronous

public final DeduplicationSynchronous getDeduplicationSynchronous()

string nullable: true example: N Valid values are:

getDeDupManualReviewRequired

public final String getDeDupManualReviewRequired()

string example: Y Valid values are:

getDetectClosedEyes

public final String getDetectClosedEyes()

string nullable: true example: Y Eye close detection. Valid values are:

getDetectLabel

public final String getDetectLabel()

string nullable: true example: N Valid values are:

getDetectLiveness

public final DetectLiveness getDetectLiveness()

Type: string
example: N
Valid values are:

getGpsCoordinates

public final String getGpsCoordinates()

getIdBackImageRequired

public final IdBackImageRequired getIdBackImageRequired()

string nullable: true example: Y Valid values are:

getIdImageResolutionCheck

public final IDImageResolutionCheck getIdImageResolutionCheck()

string example: Y Valid values are:

getManualReviewRequired

public final ManualReviewRequired getManualReviewRequired()

string example: N Valid values are:

getMetadata

public final String getMetadata()

getNeedImmediateResponse

public final NeedImmediateResponse getNeedImmediateResponse()

string nullable: true example: N Valid values are:

getOcrMetadata

public final String getOcrMetadata()

getPaymentGateway

public final String getPaymentGateway()

string example: Apriva/FREEDOMPAY Payment Processing Gateway.

getPiiExclusion

public final String getPiiExclusion()

string example: N PII_exclusion.

getPostDataAPIRequired

public final PostDataAPIRequired getPostDataAPIRequired()

getPostDataAPIURL

public final String getPostDataAPIURL()

getPostDataOnReviewRequired

public final PostDataOnReviewRequired getPostDataOnReviewRequired()

getRealIdCheckRequired

public final IsRealId getRealIdCheckRequired()

Type: string
example: N
Valid values are:

getSendDocumentIdInResponse

public final String getSendDocumentIdInResponse()

string nullable: true example: N Returns urn for documents instead of Base64 data in response. Valid values are:

getSendInputImagesInPost

public final SendInputImagesInPost getSendInputImagesInPost()

Type: string
example: N
Used only when the POST_DATA API flag = Y.
Valid values are:

getSendInputImagesInResponse

public final SendInputImagesInResponse getSendInputImagesInResponse()

Type: string
example: N
Valid values are:

getSendMetaDataInPost

public final String getSendMetaDataInPost()

string nullable: true example: N If postDataAPIRequired request parameter = Y, this field can be used to send metadata in postDataAPI webhook. Valid values are:

getSendProcessedImagesInPost

public final SendProcessedImagesInPost getSendProcessedImagesInPost()

Type: string
example: N
Used only when the POST_DATA API flag = Y.
Valid values are:

getSendProcessedImagesInResponse

public final SendProcessedImagesInResponse getSendProcessedImagesInResponse()

Type: string
example: N
Valid values are:

getSendSignatureFromIdInResponse

public final String getSendSignatureFromIdInResponse()

string nullable: true example: N Returns signature from ID in response. Valid values are:

getStripSpecialCharacters

public final StripSpecialCharacter getStripSpecialCharacters()

Type: string
nullable: true
example: N
Valid values are:
Y:
N:

getUniqueRequestId

public final String getUniqueRequestId()

getVerifyDataWithHost

public final VerifyDataWithHost getVerifyDataWithHost()

string nullable: true example: N Valid values are:

setBypassAgeValidation

public final Unit setBypassAgeValidation(BypassAgeValidation bypassAgeValidation)

string example: N Valid values are:

setBypassNameMatching

public final Unit setBypassNameMatching(BypassNameMatching bypassNameMatching)

Type: string
example: N
Valid Values are:

setClientTraceId

public final Unit setClientTraceId(String clientTraceId)

Type: string
maxLength: 256 example: 56975421474
Valid values are:
Client Trace ID generated by client applicationIt can be as long as 256 characters.

setCustomerDataMatchConfig

public final Unit setCustomerDataMatchConfig(CustomerDataMatchConfig customerDataMatchConfig)

CustomerDataMatchConfig data

setDeDupDataRequiredInResponse

public final Unit setDeDupDataRequiredInResponse(DeDupDataRequiredInResponse deDupDataRequiredInResponse)

string nullable: true example: Y Valid values are:

setDeDuplicationRequired

public final Unit setDeDuplicationRequired(DeDuplicationRequired deDuplicationRequired)

string example: N Valid values are:

setDeduplicationSynchronous

public final Unit setDeduplicationSynchronous(DeduplicationSynchronous deduplicationSynchronous)

string nullable: true example: N Valid values are:

setDeDupManualReviewRequired

public final Unit setDeDupManualReviewRequired(String deDupManualReviewRequired)

string example: Y Valid values are:

setDetectClosedEyes

public final Unit setDetectClosedEyes(String detectClosedEyes)

string nullable: true example: Y Eye close detection. Valid values are:

setDetectLabel

public final Unit setDetectLabel(String detectLabel)

string nullable: true example: N Valid values are:

setDetectLiveness

public final Unit setDetectLiveness(DetectLiveness detectLiveness)

Type: string
example: N
Valid values are:

setGpsCoordinates

public final Unit setGpsCoordinates(String gpsCoordinates)

setIdBackImageRequired

public final Unit setIdBackImageRequired(IdBackImageRequired idBackImageRequired)

string nullable: true example: Y Valid values are:

setIdImageResolutionCheck

public final Unit setIdImageResolutionCheck(IDImageResolutionCheck idImageResolutionCheck)

string example: Y Valid values are:

setManualReviewRequired

public final Unit setManualReviewRequired(ManualReviewRequired manualReviewRequired)

string example: N Valid values are:

setMetadata

public final Unit setMetadata(String metadata)

setNeedImmediateResponse

public final Unit setNeedImmediateResponse(NeedImmediateResponse needImmediateResponse)

string nullable: true example: N Valid values are:

setOcrMetadata

public final Unit setOcrMetadata(String ocrMetadata)

setPaymentGateway

public final Unit setPaymentGateway(String paymentGateway)

string example: Apriva/FREEDOMPAY Payment Processing Gateway.

setPiiExclusion

public final Unit setPiiExclusion(String piiExclusion)

string example: N PII_exclusion.

setPostDataAPIRequired

public final Unit setPostDataAPIRequired(PostDataAPIRequired postDataAPIRequired)

setPostDataOnReviewRequired

public final Unit setPostDataOnReviewRequired(PostDataOnReviewRequired postDataOnReviewRequired)

setRealIdCheckRequired

public final Unit setRealIdCheckRequired(IsRealId realIdCheckRequired)

Type: string
example: N
Valid values are:

setSendDocumentIdInResponse

public final Unit setSendDocumentIdInResponse(String sendDocumentIdInResponse)

string nullable: true example: N Returns urn for documents instead of Base64 data in response. Valid values are:

setSendInputImagesInPost

public final Unit setSendInputImagesInPost(SendInputImagesInPost sendInputImagesInPost)

Type: string
example: N
Used only when the POST_DATA API flag = Y.
Valid values are:

setSendInputImagesInResponse

public final Unit setSendInputImagesInResponse(SendInputImagesInResponse sendInputImagesInResponse)

Type: string
example: N
Valid values are:

setSendProcessedImagesInPost

public final Unit setSendProcessedImagesInPost(SendProcessedImagesInPost sendProcessedImagesInPost)

Type: string
example: N
Used only when the POST_DATA API flag = Y.
Valid values are:

setSendProcessedImagesInResponse

public final Unit setSendProcessedImagesInResponse(SendProcessedImagesInResponse sendProcessedImagesInResponse)

Type: string
example: N
Valid values are:

setSendSignatureFromIdInResponse

public final Unit setSendSignatureFromIdInResponse(String sendSignatureFromIdInResponse)

string nullable: true example: N Returns signature from ID in response. Valid values are:

setStripSpecialCharacters

public final Unit setStripSpecialCharacters(StripSpecialCharacter stripSpecialCharacters)

Type: string
nullable: true
example: N
Valid values are:
Y:
N:

setVerifyDataWithHost

public final Unit setVerifyDataWithHost(VerifyDataWithHost verifyDataWithHost)

string nullable: true example: N Valid values are: