Country list check

🎯 Functional documentation

This provider can check data fields of type COUNTRY or MULTI_COUNTRY against a country list to define if the country is a high risk country or not.

DD parameters

This provider supports the parameters defined in the settings. The result values are defined by the list (or fallback through configuration). Depending on the enabled data points (see configuration below), the subjects can be one or more of the following:

• Individual
• Company
• Partnership
• Indivision
• Dossier

⚙️ Configuration

Implementation class: eu.myharmoney.app.providers.duediligence.list.CountryDueDiligenceProvider

Settings:

• includeAddress: if true, checks the country of the address of the party
• includePostalAddress: if true, checks the country of the postal address of the party
• includeTransaction: if true, checks the country of the transaction of the dossier. Requires module TRANSACTION
• includeCountryOfBirth: if true, checks the country of birth of the individual
• includeNationality: if true, checks the country of the nationality of the individual
• includeAdditionalNationalities: if true, checks the countries of additional nationalities of the individual
• includePrimaryTaxInformation: if true, checks the country of the primary tax information (can be the same as residential address) of the party. Requires module FISCALITY
• includeAdditionalTaxInformation: if true, checks the countries of the additional tax information of the party. Requires module FISCALITY

More settings related to the list check itself

• LIST_IDENTIFIERS: (required) Defines the Due Diligence parameter and its corresponding list: "LIST_IDENTIFIERS": {"DD_PARAM": "country_list"}
• SUBJECT_TYPES: (optional) Can be used to limit the subject types (e.g. you want to check the address country of individuals but not companies): "SUBJECT_TYPES": ["INDIVIDUAL"]
• fallbackResultWhenFound (default YES): When the country is found in the list, but the list doesn’t specify a value (only identifiers), this is the result that will return
• resultWhenNotFound (default NO): When the country is not found in the list, this is the result that will return

Example:

{
  "identifier": "DueDiligence - Country - <client>",
  "state": "ACTIVE",
  "implementationClass": "eu.myharmoney.app.providers.duediligence.list.CountryDueDiligenceProvider",
  "settings": {
    "LIST_IDENTIFIERS": {
      "HIGH_RISK_COUNTRY": "<client>_country_risk"
    },
    "includeTransaction": true,
    "includeAddress": true,
    "includePostalAddress": true,
    "includeCountryOfBirth": true,
    "includeNationality": true,
    "includeAdditionalNationalities": true,
    "includePrimaryTaxInformation": true,
    "PROVIDER_DISPLAY_NAME": "Countries",
    "fallbackResultWhenFound": "HIGH",
    "resultWhenNotFound": "LOW"
  }
}