Skip to main content
For an overview of the PEPs and Sanctions module, its variants, capabilities, and result codes, see the PEPs and Sanctions module reference. When the module detects a match, you can configure the journey to reject a customer, flag them for manual review, or apply additional checks.
You can view PEP and Sanctions screening results in the Investigation Portal. For more information, refer to the View details of a journey session documentation.
In this guide, you’ll learn about the various capabilities of the module and its variants. You’ll also learn how to test the module using GBG GO APIs.

Module variants

The PEPs and Sanctions module has various variants that determine the scope of compliance checks performed on your customers. These include: For a full description of each variant, its capabilities, and default outcomes, refer to PEPs and Sanctions.

Capabilities and allowed values

Each PEPs and Sanctions variant supports different capabilities that determine which screening checks the module performs. The capabilities include PEPs and sanctions results, sanctions hit type, PEPs hit type, sent to OGM, and adverse media hit type. For a full description of each capability and its allowed values, refer to PEPs and Sanctions.

Example: Testing the PEPs and Sanctions module using GO API

This section walks you through testing the PEPs and Sanctions module.

Step 1: Add the module to your journey

To test the PEPs and Sanctions module, you first need to add it to a customer journey.
  1. Create a new journey or open an existing one in the journey builder.
  2. Click Browse and add modules.
  3. Search for PEPs and Sanctions or navigate to the Compliance Screening category.
  4. Select the PEPs and Sanctions module.
  5. Choose a variant.
These steps use the UK Instance (with Adverse Media and OGM) variant for testing.
  1. Click Add to journey.
  2. Click Configure outcomes.
  • Rules:
    • Match: PEPs and Sanctions Results + is any of + PEPs and Sanctions Hit. This rule means that if the PEPs and Sanctions check results in a hit, then there is a match.
    • No Match: PEPs and Sanctions Results + is any of + PEPs and Sanctions No Hit. This rule means that if the PEPs and Sanctions check results in a no hit, then there is no match.
  1. Click Close.
You have successfully added the PEPs and Sanctions module to your journey and configured the evaluation rules. Next, publish the journey to Preview for testing.

(Optional) Step 2: Configure PEPs and Sanctions module settings

Module settings control which records the screening returns and how strictly the module matches an end-user against them. The default settings suit most use cases, so configure these settings only if you need to narrow the screening scope or adjust the match tolerance. To configure the module settings:
  1. Open your journey in the journey builder and click the PEPs and Sanctions module.
  2. Click Settings. The module settings modal appears.
Settings Pep Png
  1. Modify the available settings based on your requirements. For a description of each field, refer to the table below.
  2. Click Save all settings.

Step 3: Publish the journey

After adding and configuring the module:
  1. Click Publish to Preview.
  2. Go to the GBG GO Dashboard and copy your Resource ID and Version for testing.
For more information on publishing journeys, refer to the Publish journey guide.

Step 4: Start journey with test data

Use the Start journey endpoint to trigger the PEPs and Sanctions screening with test customer data. Send a POST request to /journey/start: Request body:
cURL
Replace your_access_token with a valid access token. Replace the resourceId value with your journey’s Resource ID and Version. The request requires the firstName and lastNames values. Include additional data, for example, the dateOfBirth value, to get more accurate screening results. What happens:
  • The API creates a journey instance ID and processes the customer data through the PEPs and Sanctions module.
  • You receive an instanceId in the response, which you will use to retrieve the results.
Response:
JSON
For more details on starting a journey, refer to the Start a journey guide.

Step 5: Retrieve the screening results

Use the Fetch journey state endpoint to check if the PEPs and Sanctions screening has completed. Send a POST request to /journey/state/fetch: Request body:
cURL
What you receive:
  • A list of tasks that the journey executed, including the PEPs and Sanctions screening task.
  • Each task includes details about the screening outcome.
Example response:
JSON
The response indicates that there was a hit and therefore, the outcome is a β€œMATCH”.
If the status is Completed, the PEPs and Sanctions screening has finished processing.