You can view PEP and Sanctions screening results in the Investigation Portal. For more information, refer to the View details of a customer session documentation.
Module variants
The PEPs and Sanctions module has variants that determine the scope of compliance checks performed on your customers.- UK Instance: Carries out two checks in the system:
- Checks if an end-user is a PEP.
- Checks if an end-user has sanctions against them.
- UK Instance (with OGM): This variant includes Ongoing Monitoring (OGM), allowing you to track verified customers on an ongoing basis. The system automatically alerts you if an end-user compliance status changes, such as being added to a sanctions list or identified as a PEP after their initial verification.
Ongoing Monitoring requires direct configuration with a PEP and sanctions data supplier. If you have not configured this integration, contact your GBG account manager for assistance.
- UK Instance (with Adverse Media and OGM): This variant screens end-users against negative news coverage, such as reports of fraud, financial crimes, or other risk-related activities. It returns details of any adverse media findings, including article titles, sources, and links. This variant also includes Ongoing Monitoring (OGM) to track end-users for new adverse media after their initial verification.
Capabilities and allowed values
Each PEPs and Sanctions variant supports different capabilities that determine what screening checks are performed. The table below defines the available capabilities and their allowed values.| Capabilities | Allowed values, labels, and descriptions |
|---|---|
PEPs and Sanctions Results: Results from PEPs and Sanctions check.
| View allowed values
|
| Sanctions Hit Type: Shows which customer data fields matched against a sanctions list entry. Values in this capability could indicate whether the match occurred through the customerβs full legal name, a known alias, or other matching criteria. This information helps you assess the accuracy and relevance of the match. | View allowed values (long list)
|
| Peps Hit Type: Shows which customer data fields matched against a PEPs database entry. This includes whether the customer is directly identified as a Politically Exposed Person or flagged as a family member or close associate of a PEP. It may also show if the match occurred through an alias or other matching criteria. | View allowed valuesSame values as Sanctions Hit Type. |
| Sent to OGM: Shows whether the customer has been added to Ongoing Monitoring for continuous tracking. When set to is true, this rule triggers a match if the customer has been enrolled in Ongoing Monitoring. | View allowed values
|
| Adverse Media Hit Type: Shows the nature and type of news coverage found for a customer during screening. This capability shows whether the customer has been linked to fraud, financial crimes, corruption, sanctions violations, or other compliance risks in news articles and media sources. | View allowed values
|
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.- Create a new journey or open an existing one in the Journey builder.
- Click Browse and add modules.
- Search for PEPs and Sanctions or navigate to the Compliance Screening category.
- Select the PEPs and Sanctions module.
- Choose a variant.
The UK Instance (with Adverse Media and OGM) variant is used for testing during these steps.
- Click Add to journey.
- 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.
- Click Close.
Step 2: Publish the journey
After adding and configuring the module:- Click Publish to Preview.
- Go to the GBG GO Dashboard and copy your Resource ID and Version for testing.
Step 3: 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
your_access_token with a valid access token. Replace the resourceId value with your journeyβs Resource ID and Version.
What happens:
- The API creates a journey instance and returns an
instanceIdthat you use in the following steps to drive and inspect the journey.
JSON
Step 4: Fetch interaction
After the journey starts, fetch the next interaction to find out which fields the journey needs from the end-user. This is also where you obtain theinteractionId youβll need when submitting data.
Send a POST request to /journey/interaction/fetch:
Request body:
cURL
- The
interactionIdfor the current interaction. You will pass this back in the next step. - The interactionβs
collectslist, which describes the data the journey can accept. - An
outstandinglist, which highlights the fields that must be supplied before the journey can progress.
JSON
Step 5: Submit the end-userβs details
Submit the customer data the journey is waiting on. Theoutstanding list from the previous step shows that FullName is required. dateOfBirth is optional but recommended, as it improves screening accuracy.
Send a POST request to /journey/interaction/submit:
Request body:
cURL
instanceId from Step 3 and the interactionId from Step 4. The participants array tells the journey which domain element the submitted data belongs to.
Response:
JSON
success status confirms that the submitted data was accepted. The journey continues processing in the background. Move on to the next step to retrieve the screening result.
Step 6: Poll for the screening result
The PEPs and Sanctions screening runs asynchronously. Poll the Fetch journey state endpoint until the journeystatus is Completed.
Send a POST request to /journey/state/fetch:
Request body:
cURL
- The overall journey
status. Continue polling while the status isInProgress. - A
stepsarray, where each step describes a module that ran in the journey. The PEPs and Sanctions step includes theoutcome(for example,MATCH), theadvice(decision, hit types, OGM enrolment, candidate scores) and thenoteblock (PEP and sanctions match details such as aliases, positions, addresses, and sanctioning bodies).
JSON
If the status is Completed, the PEPs and Sanctions screening has finished processing.