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

AdditionalDataFlagRequest

public final class AdditionalDataFlagRequest

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.

manualReviewRequired

Valid values are: - Y IDmission’s ID Verification Team will perform a manual review of the submitted form in the event it is not auto-decisioned. - N The system will auto-decision the submitted form and it will not be manually reviewed. - F Forced Manual Review

bypassAgeValidation

Valid values are: - Y : The system will NOT validate that the age of the individual based on the date of birth and current date is 18 or older. - N : The system will confirm that the age of the individual based on the date of birth and current date is 18 or older.

deDuplicationRequired

Valid values are: - Y : If deduplication is to be performed against the enrolled customer’s face image. - N : If deduplication is not to be executed against the enrolled customer’s face image

bypassNameMatching

Valid Values are: - Y : The system will NOT validate that the name provided in the reqeust with the Extracted Name. - N : The system will validate that the name provided in the reqeust with the Extracted Name.

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. Valid values are: - Y : POST_API call will get triggered. - N : POST_API Data will not be posted to the host. - Blank : 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.

sendInputImagesInPost

Used only when the POST_DATA API flag = Y. Valid values are: - Y: We will send the input images (ID Front/ID Back/Customer Selfie) in the POST_API. - N:No input images will be sent in the POST_API. - Blank: No input images will be sent in the POST_API

sendProcessedImagesInPost

Used only when the POST_DATA API flag = Y. Valid values are: - Y : We will send the processed images (ID front/ID back which have been cropped/marked up with security features, etc.) in POST_API. - N : No processed images will be sent in the POST_API. - Blank : No processed images will be sent in the POST_API.

needImmediateResponse

Valid values are: - Y : If the submitting system requires an immediate response back to the request. - N : The system will execute synchronous calls based on the service IDs used in the request.

deduplicationSynchronous

Valid values are: - Y : If deduplication is to be performed synchronously against the enrolled customer’s face image . - N : If deduplication is not to be executed against the enrolled customer’s face image

verifyDataWithHost

Valid values are: - Y : It will verify the customer data with the data returned back from the host. - N : It will not verify the customer data with host data.

idBackImageRequired

Valid values are: - Y : ID Back is mandatory for all ID types where Back is present and will be processed along with the front of the ID. - N : ID Back is not required and will not be considered in ID validation processing when not provided.

liveFaceDetectionFlag

Expected values are: - true - When the live face is detected - false - When the live face is not detected

Constructors

AdditionalDataFlagRequest

@JvmOverloads()

public AdditionalDataFlagRequest AdditionalDataFlagRequest(ManualReviewRequired manualReviewRequired, BypassAgeValidation bypassAgeValidation, DeDuplicationRequired deDuplicationRequired, BypassNameMatching bypassNameMatching, PostDataAPIRequired postDataAPIRequired, SendInputImagesInPost sendInputImagesInPost, SendProcessedImagesInPost sendProcessedImagesInPost, NeedImmediateResponse needImmediateResponse, DeduplicationSynchronous deduplicationSynchronous, VerifyDataWithHost verifyDataWithHost, IdBackImageRequired idBackImageRequired, StripSpecialCharacter stripSpecialCharacters, String liveFaceDetectionFlag)

@JvmOverloads()

public AdditionalDataFlagRequest AdditionalDataFlagRequest(ManualReviewRequired manualReviewRequired, BypassAgeValidation bypassAgeValidation, DeDuplicationRequired deDuplicationRequired)

@JvmOverloads()

public AdditionalDataFlagRequest AdditionalDataFlagRequest(ManualReviewRequired manualReviewRequired, BypassAgeValidation bypassAgeValidation)

@JvmOverloads()

public AdditionalDataFlagRequest AdditionalDataFlagRequest(ManualReviewRequired manualReviewRequired)

@JvmOverloads()

public AdditionalDataFlagRequest AdditionalDataFlagRequest()

Properties

bypassAgeValidation

private BypassAgeValidation bypassAgeValidation

Type: string
example: N
Valid values are:

bypassNameMatching

private BypassNameMatching bypassNameMatching

Type: string
example: N
Valid Values are:

deDuplicationRequired

private DeDuplicationRequired deDuplicationRequired

Type: string
example: N
Valid values are:

deduplicationSynchronous

private DeduplicationSynchronous deduplicationSynchronous

Type: string
example: N
Valid values are:

idBackImageRequired

private IdBackImageRequired idBackImageRequired

Type: string
example: N
Valid values are:

liveFaceDetectionFlag

private final String liveFaceDetectionFlag

Type:String
Expected values are:
true - When the live face is detected
false - When the live face is not detected

manualReviewRequired

private ManualReviewRequired manualReviewRequired

Type: string
example: N
Valid values are:

needImmediateResponse

private NeedImmediateResponse needImmediateResponse

Type: string
example: N
Valid values are

postDataAPIRequired

private PostDataAPIRequired postDataAPIRequired

Type: string
example: N
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.
Valid values are:

sendInputImagesInPost

private SendInputImagesInPost sendInputImagesInPost

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

sendProcessedImagesInPost

private SendProcessedImagesInPost sendProcessedImagesInPost

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

stripSpecialCharacters

private StripSpecialCharacter stripSpecialCharacters

Type: string
example: N
Valid values are:

verifyDataWithHost

private VerifyDataWithHost verifyDataWithHost

Type: string
example: N
Valid values are:

Functions

getBypassAgeValidation

public final BypassAgeValidation getBypassAgeValidation()

Type: string
example: N
Valid values are:

getBypassNameMatching

public final BypassNameMatching getBypassNameMatching()

Type: string
example: N
Valid Values are:

getDeDuplicationRequired

public final DeDuplicationRequired getDeDuplicationRequired()

Type: string
example: N
Valid values are:

getDeduplicationSynchronous

public final DeduplicationSynchronous getDeduplicationSynchronous()

Type: string
example: N
Valid values are:

getIdBackImageRequired

public final IdBackImageRequired getIdBackImageRequired()

Type: string
example: N
Valid values are:

getLiveFaceDetectionFlag

public final String getLiveFaceDetectionFlag()

Type:String
Expected values are:
true - When the live face is detected
false - When the live face is not detected

getManualReviewRequired

public final ManualReviewRequired getManualReviewRequired()

Type: string
example: N
Valid values are:

getNeedImmediateResponse

public final NeedImmediateResponse getNeedImmediateResponse()

Type: string
example: N
Valid values are

getPostDataAPIRequired

public final PostDataAPIRequired getPostDataAPIRequired()

Type: string
example: N
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.
Valid values are:

getSendInputImagesInPost

public final SendInputImagesInPost getSendInputImagesInPost()

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

getSendProcessedImagesInPost

public final SendProcessedImagesInPost getSendProcessedImagesInPost()

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

getStripSpecialCharacters

public final StripSpecialCharacter getStripSpecialCharacters()

Type: string
example: N
Valid values are:

getVerifyDataWithHost

public final VerifyDataWithHost getVerifyDataWithHost()

Type: string
example: N
Valid values are:

setBypassAgeValidation

public final Unit setBypassAgeValidation(BypassAgeValidation bypassAgeValidation)

Type: string
example: N
Valid values are:

setBypassNameMatching

public final Unit setBypassNameMatching(BypassNameMatching bypassNameMatching)

Type: string
example: N
Valid Values are:

setDeDuplicationRequired

public final Unit setDeDuplicationRequired(DeDuplicationRequired deDuplicationRequired)

Type: string
example: N
Valid values are:

setDeduplicationSynchronous

public final Unit setDeduplicationSynchronous(DeduplicationSynchronous deduplicationSynchronous)

Type: string
example: N
Valid values are:

setIdBackImageRequired

public final Unit setIdBackImageRequired(IdBackImageRequired idBackImageRequired)

Type: string
example: N
Valid values are:

setManualReviewRequired

public final Unit setManualReviewRequired(ManualReviewRequired manualReviewRequired)

Type: string
example: N
Valid values are:

setNeedImmediateResponse

public final Unit setNeedImmediateResponse(NeedImmediateResponse needImmediateResponse)

Type: string
example: N
Valid values are

setPostDataAPIRequired

public final Unit setPostDataAPIRequired(PostDataAPIRequired postDataAPIRequired)

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

setSendProcessedImagesInPost

public final Unit setSendProcessedImagesInPost(SendProcessedImagesInPost sendProcessedImagesInPost)

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

setStripSpecialCharacters

public final Unit setStripSpecialCharacters(StripSpecialCharacter stripSpecialCharacters)

Type: string
example: N
Valid values are:

setVerifyDataWithHost

public final Unit setVerifyDataWithHost(VerifyDataWithHost verifyDataWithHost)

Type: string
example: N
Valid values are: