Version: 19

World-Check

Version 3
Version 2
Version 1

Functional documentation

This provider uses basic party data (name, birthdate, etc.) and country code data fields (nationality, address, etc.) from the party to construct a request to the World-Check One service (LSEG API). The response is mapped to one or more DD parameters, which are set to YES or NO based on the configured RESPONSE_MAPPING.

:::info V2 -> V3 migration note The V3 provider is functionally equivalent to V2. The key difference is authentication: V3 uses OAuth2 (clientId + clientSecret + tokenUri) instead of the V2 API key. The resource URI has also changed from api-worldcheck.refinitiv.com to https://api.risk.lseg.com/screening/v3/. :::

Application high-level architecture and data flow

Input data points

Individual
- First name (required)
- Last name (required)
- Gender
- Date of birth
- Nationality
- Country
Company
- Name (required)
- Country

Applicable DD parameters

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

Configuration

Implementation class: WorldCheckV3DueDiligenceProvider
Resource Uri: https://api.risk.lseg.com/screening/v3/
Token Uri: https://api.risk.lseg.com/auth/oauth2/v1/token

Authentication

V3 uses OAuth2 client credentials flow. The token is fetched from https://api.risk.lseg.com/auth/oauth2/v1/token using the configured clientId, clientSecret and tokenUri.

Settings

Settings Configuration

Examples

🎯 Functional documentation

This provider uses basic party data (name, birthdate, …) & country code data fields (nationality, address, …) from the party to construct a request to the World Check service. The response of the service is then mapped to one or more DD parameters, which will be set to YES or NO (depending on the presence of the corresponding icon_hint)

Input data points

Individual
- First name (required)
- Last name (required)
- Gender
- Date of birth
- Nationality
- Country
Company
- Name (required)
- Country

Applicable DD parameters

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

⚙️ Configuration

Implementation class: WorldCheckV2DueDiligenceProvider
Resource Uri: https://api-worldcheck.refinitiv.com

Settings

Setting KEY	mandatory
`PROVIDER_DISPLAY_NAME`	✅	Name of the provider that is shown in the application. Ex: `"World-Check One"`
`API_KEY`	✅	Security key used for authorization. Ex: `abc12345-1111-1111-1111-aaaaaaaaaaaa`
`WORLD_CHECK_GROUPID`	✅	Identifier for the screening request. Ex: `aaaaaa00000000000`
`DUE_DILIGENCE_DOCUMENT_FETCH`	❌	Defines if document(s) need to be created after a due diligence check is performed. We support generation of a document containing the list of possible matches and a document containing detailed profiles for possible matches. Ex: `true`
`WORLD_CHECK_PDF_DETAILS_MATCH_STRENGTHS`	❌	⚠️ Only applicable when `DUE_DILIGENCE_DOCUMENT_FETCH` = `true` Defines the Match Strength values who are contained in the detailed profiles. When an empty list is provided, there is no filtering on match strength (all matches are taken into account). Ex: `["EXACT","STRONG"]`
`WORLD_CHECK_PDF_DETAILS_MAX`	❌	⚠️ Only applicable when `DUE_DILIGENCE_DOCUMENT_FETCH` = `true` Defines the maximum number of detailed profiles that will be fetched and stored in a document. By default only 1 profile is fetched. Ex: `5`
`WORLD_CHECK_PROVIDER_TYPES`	❌	Defines which provider types should be added when performing the due diligence check. Default: `["WATCHLIST"]`. Ex: `["CLIENT_WATCHLIST", "WATCHLIST", "PASSPORT_CHECK"]`
`RESPONSE_MAPPING`	❌	See below.

Default `RESPONSE_MAPPING`

RESPONSE_MAPPING

Example

{
    "authentication": {
      "clientSecret": "$vault{WORLD_CHECK_ONE_<client>_clientSecret}"
    },
    "API_KEY": "$vault{WORLD_CHECK_ONE_<client>_API_KEY}",
    "DUE_DILIGENCE_DOCUMENT_FETCH": "true",
    "DUE_DILIGENCE_RESULT_EXPIRATION": 1380,
    "PROVIDER_DISPLAY_NAME": "World-Check One V2",
    "RESPONSE_MAPPING": {
        "rules": [
            {
                "comparisons": [
                    {
                        "field": "CATEGORY",
                        "value": "BANK"
                    },
                    {
                        "field": "CATEGORY",
                        "value": "CRIME - FINANCIAL"
                    },
                    {
                        "field": "CATEGORY",
                        "value": "CRIME - NARCOTICS"
                    },
                    {
                        "field": "CATEGORY",
                        "value": "CRIME - ORGANIZED"
                    },
                    {
                        "field": "CATEGORY",
                        "value": "CRIME - TERROR"
                    },
                    {
                        "field": "CATEGORY",
                        "value": "CRIME - WAR"
                    },
                    {
                        "field": "CATEGORY",
                        "value": "CRIME - OTHER"
                    },
                    {
                        "field": "CATEGORY",
                        "value": "NONCONVICTION TERROR"
                    },
                    {
                        "field": "CATEGORY",
                        "value": "ORGANISATION"
                    },
                    {
                        "field": "CATEGORY",
                        "value": "RELIGION"
                    },
                    {
                        "field": "CATEGORY",
                        "value": "TRADE UNION"
                    },
                    {
                        "field": "CATEGORIES",
                        "value": "Law Enforcement"
                    }
                ],
                "dueDiligenceParameter": "REPUTATIONAL_RISK"
            },
            {
                "comparisons": [
                    {
                        "field": "CATEGORY",
                        "value": "EMBARGO"
                    },
                    {
                        "field": "CATEGORY",
                        "value": "EMBARGO VESSEL"
                    },
                    {
                        "field": "CATEGORY",
                        "value": "PORT"
                    },
                    {
                        "field": "CATEGORY",
                        "value": "VESSEL"
                    }
                ],
                "dueDiligenceParameter": "NATION_UNDER_EMBARGO"
            },
            {
                "comparisons": [
                    {
                        "field": "CATEGORIES",
                        "value": "Sanctions"
                    }
                ],
                "dueDiligenceParameter": "SANCTION_LIST"
            },
            {
                "comparisons": [
                    {
                        "field": "CATEGORIES",
                        "value": "PEP"
                    }
                ],
                "dueDiligenceParameter": "PEP"
            },
            {
                "comparisons": [
                    {
                        "field": "CATEGORIES",
                        "value": "Special Interest Categories"
                    }
                ],
                "dueDiligenceParameter": "SPECIAL_INTEREST"
            },
            {
                "comparisons": [
                    {
                        "field": "SOURCES",
                        "method": "ENDS_WITH",
                        "value": "FATF"
                    },
                    {
                        "field": "SOURCES",
                        "method": "ENDS_WITH",
                        "value": "FATF-SD"
                    }
                ],
                "dueDiligenceParameter": "FATF_SENSITIVE_COUNTRY"
            },
            {
                "comparisons": [
                    {
                        "field": "PROVIDER_TYPE",
                        "value": "CLIENT_WATCHLIST"
                    }
                ],
                "dueDiligenceParameter": "WATCH_LIST"
            }
        ]
    },
    "SUPPORTED_FSP": "$vault{WORLD_CHECK_ONE_<client>_SUPPORTED_FSP}",
    "WORLD_CHECK_GROUPID": "$vault{WORLD_CHECK_ONE_<client>_GROUP_ID}",
    "WORLD_CHECK_PDF_DETAILS_MATCH_STRENGTHS": [
        "EXACT",
        "STRONG"
    ],
    "WORLD_CHECK_PDF_DETAILS_MAX": 5,
    "WORLD_CHECK_PROVIDER_TYPES": [
        "WATCHLIST",
        "CLIENT_WATCHLIST"
    ],
    "nameTransposition": true
}

🎯 Functional documentation

Input data points

Individual
- First name (required)
- Last name (required)
- Gender
- Date of birth
- Nationality
- Country
Company
- Name (required)
- Country

Applicable DD parameters

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

⚙️ Configuration

Implementation class: WorldCheckDueDiligenceProvider
Resource Uri: https://api-worldcheck.refinitiv.com

Settings

Setting KEY	mandatory
`PROVIDER_DISPLAY_NAME`	✅	Name of the provider that is shown in the application. Ex: `"World-Check One"`
`API_KEY`	✅	Security key used for authorization. Ex: `abc12345-1111-1111-1111-aaaaaaaaaaaa`
`WORLD_CHECK_GROUPID`	✅	Identifier for the screening request. Ex: `aaaaaa00000000000`
`DUE_DILIGENCE_DOCUMENT_FETCH`	❌	Defines if document(s) need to be created after a due diligence check is performed. We support generation of a document containing the list of possible matches and a document containing detailed profiles for possible matches. Ex: `true`
`WORLD_CHECK_PDF_DETAILS_MATCH_STRENGTHS`	❌	⚠️ Only applicable when `DUE_DILIGENCE_DOCUMENT_FETCH` = `true` Defines the Match Strength values who are contained in the detailed profiles. When an empty list is provided, there is no filtering on match strength (all matches are taken into account). Ex: `["EXACT","STRONG"]`
`WORLD_CHECK_PDF_DETAILS_MAX`	❌	⚠️ Only applicable when `DUE_DILIGENCE_DOCUMENT_FETCH` = `true` Defines the maximum number of detailed profiles that will be fetched and stored in a document. By default only 1 profile is fetched. Ex: `5`
`WORLD_CHECK_PROVIDER_TYPES`	❌	Defines which provider types should be added when performing the due diligence check. Default: `["WATCHLIST"]`. Ex: `["CLIENT_WATCHLIST", "WATCHLIST", "PASSPORT_CHECK"]`
`RESPONSE_MAPPING`	❌	See below.

Default `RESPONSE_MAPPING`

RESPONSE_MAPPING

{
  "authentication": {
    "clientSecret": "$vault{WORLD_CHECK_ONE_<client>_clientSecret}"
  },
  "RESPONSE_MAPPING": {
    "rules": [
      {
        "comparisons": [
          {
            "field": "CATEGORY",
            "value": "BANK"
          },
          {
            "field": "CATEGORY",
            "value": "CRIME - FINANCIAL"
          },
          {
            "field": "CATEGORY",
            "value": "CRIME - NARCOTICS"
          },
          {
            "field": "CATEGORY",
            "value": "CRIME - ORGANIZED"
          },
          {
            "field": "CATEGORY",
            "value": "CRIME - TERROR"
          },
          {
            "field": "CATEGORY",
            "value": "CRIME - WAR"
          },
          {
            "field": "CATEGORY",
            "value": "CRIME - OTHER"
          },
          {
            "field": "CATEGORY",
            "value": "NONCONVICTION TERROR"
          },
          {
            "field": "CATEGORY",
            "value": "ORGANISATION"
          },
          {
            "field": "CATEGORY",
            "value": "RELIGION"
          },
          {
            "field": "CATEGORY",
            "value": "TRADE UNION"
          },
          {
            "field": "CATEGORIES",
            "value": "Law Enforcement"
          },
          {
            "field": "CATEGORIES",
            "value": "Special Interest Categories"
          },
          {
            "field": "CATEGORIES",
            "value": "Regulatory Enforcement"
          }
        ],
        "dueDiligenceParameter": "REPUTATIONAL_RISK"
      },
      {
        "comparisons": [
          {
            "field": "CATEGORY",
            "value": "EMBARGO"
          },
          {
            "field": "CATEGORY",
            "value": "EMBARGO VESSEL"
          }
        ],
        "dueDiligenceParameter": "NATION_UNDER_EMBARGO"
      },
      {
        "comparisons": [
          {
            "field": "CATEGORIES",
            "value": "Sanctions"
          }
        ],
        "dueDiligenceParameter": "SANCTION_LIST"
      },
      {
        "comparisons": [
          {
            "field": "CATEGORIES",
            "value": "PEP"
          }
        ],
        "dueDiligenceParameter": "PEP"
      },
      {
        "comparisons": [
          {
            "field": "SOURCES",
            "method": "ENDS_WITH",
            "value": "FATF"
          },
          {
            "field": "SOURCES",
            "method": "ENDS_WITH",
            "value": "FATF-SD"
          }
        ],
        "dueDiligenceParameter": "FATF_SENSITIVE_COUNTRY"
      }
    ]
  }
}

Functional documentation​

Application high-level architecture and data flow​

Input data points​

Applicable DD parameters​

Configuration​

Authentication​

Settings​

Settings Configuration

Examples

🎯 Functional documentation​

Input data points​

Applicable DD parameters​

⚙️ Configuration​

Settings​

Default RESPONSE_MAPPING​

Example​

🎯 Functional documentation​

Input data points​

Applicable DD parameters​

⚙️ Configuration​

Settings​

Default RESPONSE_MAPPING​

Functional documentation

Application high-level architecture and data flow

Input data points

Applicable DD parameters

Configuration

Authentication

Settings

🎯 Functional documentation

Input data points

Applicable DD parameters

⚙️ Configuration

Settings

Default `RESPONSE_MAPPING`

Example

🎯 Functional documentation

Input data points

Applicable DD parameters

⚙️ Configuration

Settings

Default `RESPONSE_MAPPING`