AriadNext Settings

The AriadNext settings are defined in JSON format as key-value pairs. The following settings are available:

Setting JSON Key Description
UID File FileUIDAttribute The name of the source entity attribute on which the unique ID of the AriadNext file is saved. It holds a unique ID used for retrieving reports.
Workflow entity SourceEntityPrimaryAttributeName The name of the primary key attribute.
ADR Compliant isAdrCompliant The following options are available: 
  • If true, the identity verification process is ADR compliant.
  • If false, the identity verification process is not ADR compliant.
Configuration code ConfigurationCode Configuration code obtained from configuration call which is done initially.
NOTE  
The configuration code is provided by FintechOS at implementation.
Webhook endpoint name WebhookEndpointName Array containing the names of the notification endpoint obtained through the initial configuration call.
NOTE  
The webhook endpoint name is provided by FintechOS at implementation.
Features Features The following options are available:
  • DocumentLiveness: if true the document liveness is enabled in AriadNext SDK.
  • BiometricLiveness: if true the biometric liveness is enabled. This option cannot be set to true if DocumentLiveness is set to false.
Workflow entity SourceEntityName The entity associated with the business workflow (digital journey) that calls the OCR process. Needed only if the OCR process is used on an edit form (to alter an existing record) to update the workflow entity's business status after the scan (see BusinessStatusSuccess and BusinessStatusFail).
If the OCR process is used on an insert form (to create a new record), this key is not needed.
Redirect in case of success MaskNextStepUrlSuccess Location in the user interface where the user is redirected after a successful scan.
  • entity – Entity name.
  • form – Form name of the above entity.
  • section – Optional parameter for the section name of the above form.
Redirect in case of failure MaskNextStepUrlFail Location in the user interface where the user is redirected after the maximum number of failed scan attempts (see AriadNext Settings).
  • entity – Entity name.
  • form – Form name of the above entity.
  • section – Optional parameter for the section name of the above form.
Localization UseLocalization If true, it enables user interface localization.
Widget Configuration WidgetConf Allows you to remove the black box from the AriadNext background using displaymode into the widgetConf.

Example

Copy 
{  
    "FileUIDAttribute": "fileUID",
    "SourceEntityPrimaryAttributeName": "FTOSTestProcessorsId",
    "SourceEntityName":"FTOS_Test_Processors",
    "Language": "EN",
    "isAdrCompliant": false, // True if you need to use through ADR - therwise false,
    "ConfigurationCode": "fintechos_conf_1", // Configuration code obtained from the configuration call that was initially done. 
    "WebhookEndpointName": ["test_webhooks_endpoint"] // Array containing the names of the notification endpoint obtained through the intial configuration call
    "Features": { 
        "DocumentLiveness": true, // True if wyou want to have document liveness enabled in AriadNext SDK.
        "BiometricLiveness": true // True if you want to have biometric liveness enabled. This cannot be set to true if document liveness is set to false.
    },
    "maskNextStepURLSuccess":{  
        "entity":"FTOS_Test_Processors",
        "form":"AriadNext",
        "section":"SuccessStep"
    },
    "maskNextStepURLFail":{  
        "entity":"FTOS_Test_Processors",
        "form":"AriadNext",
        "section":"ErrorStep"
    },
    "UseLocalization": true,
    "WidgetConf": {
        "theme": {
            "displayMode": "SIMPLIFIED", // Remove the black box in the background. 
            "body": {
                "fontFamily": "'Roboto', monospace",
                "fontSize": "12px",
                "backgroundColor": "#f1c40f",
                "secondaryBackgroundColor": "#5ec2ff"
            },
            "button": {
                "backgroundColor": "#ff6b40",
                "textColor": "#fff",
                "hoverColor": "#ff6b40",
                "borderRadius": "0px"
            },
            "pageTitle": {
                "textColor": "#cc0000",
                "hideImagesBackground": true
            },
            "card": {
                "backgroundColor": "#cc0000"
            },
            "typography": {
                "title": {
                    "fontSize": "26px",
                    "textColor": "#cc0000"
                },
                "description": {
                    "fontSize": "18px",
                    "textColor": "#cc0000"
                }
            },
            "stylesheet": "https://fonts.googleapis.com/css?family=Roboto"
        }
    }
}