Overriding Server Settings

The fields in the object below all correspond to a setting that can be found in the DIVE Web Portal. By including an override setting in the request submitted to the DIVE Web API the configuration for that request can be modified from the default configuration that has been set through the DIVE Web Portal.

  "overriddenSettings": {
    "isOCREnabled": true,
    "isBackOrSecondImageProcessingEnabled": true,
    "isFaceMatchEnabled": true,
    "isFaceMatchOptional": true,
    "isAgeCheckEnabled": true,
    "isGenderCheckEnabled": true,
    "isExternalAddressVerificationEnabled": true,
    "isExternalOFACWatchlistEnabled": true,
    "isExternalShuftiEnabled": true,
    "isDocTypeChangeEnabled": true,
    "isCrossMatchRequired": true,
    "ageYearsDifference": 10
    "bothSidedScreeningStrategy": 1,
    "oneSidedScreeningStrategy": 1,

  }

isOCREnabled (boolean) - this setting will enable OCR processing to be run on the front image

isBackOrSecondImageProcessingEnabled (boolean) - this setting will enable the back image to be processed

isFaceMatchEnabled (boolean) - this setting will enable face matching to be run

isFaceMatchOptional (boolean) - this setting will make face matching optional if isFaceMatchEnabled is also enabled

isAgeCheckEnabled (boolean) - this setting will enable the age verificaiton check to be run

isGenderCheckEnabled (boolean) - this setting will enable the gender verificaiton check to be run

isExternalAddressVerificationEnabled (boolean) - this setting will enable an address verificiation check to be run that requires an HTTP request to be made over the network

isExternalOFACWatchlistEnabled (boolean) - this setting will enable an OFAV check to be run on the data from the submitted document

isExternalShuftiEnabled (boolean) - this setting will enable enhanced international document support to be available that requires an HTTP request to be made over the network

isDocTypeChangeEnabled (boolean) - this setting allows the server to correct the document type of a submission if it is determined that the submitted document type does not match the submitted document

isCrossMatchRequired (boolean) - this setting will require both sides of a document to be read in order for the submission to be treated as a successfully

ageYearsDifference (integer) - this value is used when performing the age verification check and it the greatest allowed difference in the number of years between the age found on the document and the age of the person in the submitted selfie

bothSidedScreeningStrategy	Meaning
0	No Third Party Checks Enabled
1	DMV Enabled
2	Identifraud Enabled
3	DMV Then Identifraud
4	DMV And Identifraud

oneSidedScreeningStrategy	Meaning
1	DMV Enabled
2	Identifraud Enabled
3	DMV Then Identifraud
4	DMV And Identifraud

Note

When cross matching the document is not a requirement (which means it is not required that both the front and back of the document can be read) a 3rd party check must be configured to run when only one side of the document can be read successfully. That is why it is not possible to configure no 3rd party checks to be run for the oneSidedScreeningStrategy setting