Skip to main content
Version: 🚧 Next

Due Diligence Providers

đŸŽ¯ Functional documentation​

Due Diligence Providers can be used to calculate results for Due Diligence Parameters.

The list of available providers (see below) can be divided into 2 main categories:

  • External providers (eg WorldCheck, LexisNexis, â€Ļ)
    • These providers perform an external request to a 3d party integrated system and maps the result onto DD Parameters. The mapping and used parameters are usually fixed.
  • Internal providers
    • These providers use internal Harmoney data points to calculate Due Diligence results.

A provider is independent of the Due Diligence Parameter Definitions defined for the FSP. This means that a provider can return more results than requested for the party/dossier but only the configured ones will be stored & shown in the application.

Provider statuses​

Possible statuses are

  • HIT: If a provider returns results who are flagged as a hit in the Due Diligence Parameter Definition, the status of the provider becomes HIT.
  • NO_HIT: When none of the results are flagged as a hit
  • OPEN: When the provider could not be executed
    • A provider will only be executed when the required input is available (e.g. a Country Risk provider will not be executed when the country is null).
  • FAILED: The provider has no results due to a failure (see below)

â„šī¸ A provider can also return a status instead of a list of results. (e.g. HIT or NO_HIT), but that is less common.

Provider failures​

If an exception occurs during the provider execution, like an HTTP problem (Internal Server Error, Unauthorized, â€Ļ) or a code problem (NullPointerException,â€Ļ), the provider result will have status FAILED and all AML parameters will have result UNDEFINED.

Due Diligence Document Creation​

Some external providers support the possibility to create a document for each Due Diligence Execution. This needs to be configured using the setting DUE_DILIGENCE_DOCUMENT_FETCH.
Depending on the result of the due diligence provider, the behavior for documents of due diligence providers can differ:

  • If the due diligence provider result is different from the last provider result, new documents will always be created. Any existing documents from previous due diligence executions will remain unchanged.
  • If the due diligence provider result is identical to the last provider result, the previous documents associated with the same due diligence provider result will be updated. If no documents associated to the same due diligence provider result exist, then new documents will be created. Any existing documents from previous due diligence executions where the provider result was different will remain unchanged.

âš™ī¸ Configuration​

Due Diligence providers are configured like any other provider in the admin panel. See the list of Due Diligence providers below to find out their implementation class & settings.

Authentication​

  • clientId: defines the username to access the API.
  • userId: defines the user of the API.
  • clientSecret: defines the password to access the API.
  • authorizeUri: defines the web address where the provider sends users to log in and give permission.
  • tokenUri: defines the web address where your app goes to get a token (a digital key) after permission is granted.
  • redirectPath: defines the web address where the user is sent to after log in.
  • resourceUri: defines the web address where the data can be accessed from the API.

Settings​

âš ī¸ Every provider must have a display name, defined in the setting PROVIDER_DISPLAY_NAME

Setting KEYmandatorydefault
PROVIDER_DISPLAY_NAME✅-Name of the provider that is shown in the application. Ex: "ddd"
DUE_DILIGENCE_NUM_RETRIES❌4In case of a provider failure, this setting indicates the number of retries that must be done during automation before we accept the failure as an actual result. This is used to avoid immediate caching of a failed provider result
DUE_DILIGENCE_RESULT_EXPIRATION❌1440 (1 day)The expiration time in minutes for a Due Diligence result. This allows the provider to skip execution and use a previous result (if the DD input is also the same)
DUE_DILIGENCE_DOCUMENT_FETCH❌falseEnables the creation of a due diligence document (only applicable on some external providers)
SUPPORTED_FSP❌all FSP's in the organisationAllows dedicating the provider to specific FSP's based on ID.