Skip to main content
Version: 19

Everial

🎯 Functional documentation​

This provider returns the document assessment performed by Everial to a due diligence parameter. This version is created due to technical changes in v15.

The provider first analyzes the content of a document (serialization) and can then validate the extracted data against known data in the system (consolidation). The process is in two steps:

  1. Serialize: The document is sent to Everial for analysis. The provider checks the response for any errors.
  2. Consolidate: This is an optional second step that is triggered if consolidateConfiguration.enabled is set to true. In this step, the data extracted from the document by Everial is compared with the data already known in the system (via the fieldMapping). If the data does not match, the assessment is marked as failed (NOK).

DD parameters​

This provider supports the parameters defined by the settings (see responseMapping) for entities Individual & Company.

⚙️ Configuration​

  • Implementation class: EverialV3DueDiligenceProvider
  • resource Uri: https://${client}-prod-radial.test.wizidee.com/api/v1

Settings​

  • AUTHENTICATION_PROVIDER (required): The ID of the provider responsible for the authorization
  • everialConfigurations (required): Define a list of configurations. It’s possible to configure a list in order to define different behaviour depending on the document type. Each configuration has following properties:
    • screeningType (required): Defined by Everial.
    • subjectType (required): Defines the party type.
    • parameterInvalidDocument (required): Defines the parameter to which the result should be mapped.
    • parameterDataMismatch (required): Defines the parameter to which the result should be mapped.
    • documentTypes (required): Defines which document types apply to this configuration.
    • validationSchema (optional): Defines the validation schema at Everial side (sent in the serialize & consolidate calls)
    • serializeInput (optional): Defines some of the parameters sent to Everial during the serialize call). Settings:
      • withCrops (optional): Default false
      • withImage (optional): Default false
      • withThumbnail (optional): Default false
      • pageIndexes (optional): Default 1-10
    • consolidateConfiguration (optional): Defines the properties related to the consolidate of the document. When not provided, there is no consolidation performed. Settings:
      • enabled (optional): Toggles the execution of the consolidate. Default false
      • fieldMapping (required): Defines a list of all fields that need to be consolidated and their corresponding data point in Harmoney. Each mapping has following properties:
        • everialFieldName (required): Defines the name of the field on Everial side
        • inputFieldPath (required): Defines the field path of the Harmoney data point (JSON paths are supported)
        • inputFieldType (optional): Define this when the data point is different than a String. E.g. type DATE is necessary to sent dates in the format dd.MM.yyyy. Default STRING
        • alphaNumeric (optional): When true, all non-alphanumeric fields are stripped from the value of the data point. Default false

Example​

{
    "AUTHENTICATION_PROVIDER": "$vault{EVERIAL_<client>_AUTHENTICATION_PROVIDER}",
    "PROVIDER_DISPLAY_NAME": "Everial Due Diligence",
    "everialConfigurations": [
        {
            "consolidateConfiguration": {
                "enabled": true,
                "fieldMapping": [
                    {
                        "everialFieldName": "nom",
                        "inputFieldPath": "individual.lastName"
                    },
                    {
                        "everialFieldName": "prenom",
                        "inputFieldPath": "individual.firstName"
                    },
                    {
                        "alphaNumeric": true,
                        "everialFieldName": "numero",
                        "inputFieldPath": "individual.cardNumber"
                    },
                    {
                        "everialFieldName": "DateExpiration",
                        "inputFieldPath": "individual.cardExpiryDate",
                        "inputFieldType": "DATE"
                    }
                ]
            },
            "documentTypes": [
                "BACK_SCAN",
                "FRONT_BACK_SCAN",
                "FRONT_SCAN"
            ],
            "parameterDataMismatch": "MISMATCH_ID_DOC",
            "parameterInvalidDocument": "INVALID_ID_DOC",
            "screeningType": "IDENTITY",
            "subjectType": "INDIVIDUAL"
        },
        {
            "consolidateConfiguration": {
                "enabled": true,
                "fieldMapping": [
                    {
                        "everialFieldName": "iban",
                        "inputFieldPath": "individual.accounts[?(@.type == 'IBAN')].accountNumber"
                    }
                ]
            },
            "documentTypes": [
                "BANK_VERIFICATION"
            ],
            "parameterDataMismatch": "MISMATCH_PROOF_OF_ACCOUNT_HOLDER",
            "parameterInvalidDocument": "INVALID_PROOF_OF_ACCOUNT_HOLDER",
            "screeningType": "BANK_ACCOUNT",
            "subjectType": "INDIVIDUAL",
            "validationSchema": "Company docs"
        },
        {
            "consolidateConfiguration": {
                "enabled": true,
                "fieldMapping": [
                    {
                        "everialFieldName": "iban",
                        "inputFieldPath": "company.accounts[?(@.type == 'IBAN')].accountNumber"
                    }
                ]
            },
            "documentTypes": [
                "BANK_VERIFICATION"
            ],
            "parameterDataMismatch": "MISMATCH_PROOF_OF_ACCOUNT_HOLDER",
            "parameterInvalidDocument": "INVALID_PROOF_OF_ACCOUNT_HOLDER",
            "screeningType": "BANK_ACCOUNT",
            "subjectType": "COMPANY",
            "validationSchema": "Company docs"
        },
        {
            "consolidateConfiguration": {
                "enabled": true,
                "fieldMapping": [
                    {
                        "everialFieldName": "titre",
                        "inputFieldPath": "company.name"
                    }
                ]
            },
            "documentTypes": [
                "DEED_OF_INCORPORATION"
            ],
            "parameterDataMismatch": "MISMATCH_DEED_OF_INCORPORATION",
            "parameterInvalidDocument": "INVALID_DEED_OF_INCORPORATION",
            "screeningType": "DEED_OF_INCORPORATION",
            "serializeInput": {
                "withCrops": false,
                "withImage": false,
                "withThumbnail": false
            },
            "subjectType": "COMPANY",
            "validationSchema": "Company docs"
        }
    ]
}