Global Watchlist

In today's rapidly evolving digital landscape, ensuring security and compliance within various processes has become paramount. The Watchlist module, a sophisticated processing node, stands at the forefront of this initiative. Designed to integrate seamlessly into workflows, this module empowers users with the ability to specify detailed search criteria through comprehensive module configuration options. By collecting user data via forms or ID capture and validation, the system leverages this information to conduct thorough searches. This user guide provides an in-depth look at how to configure and utilize the Watchlist module effectively, outlining the prerequisites for data collection, the nuances of module configuration, and the steps for subscribing to updates. With a focus on optimizing search results through various filters and keeping users informed of any changes, this guide serves as a comprehensive resource for integrating the Watchlist module into your workflow, ensuring enhanced security and compliance with regulatory standards.

Integration

Watchlist belongs to processing nodes. Module configuration gives various options to specify different search criteria. Given that watchlist is a processing module, it needs to be added to the workflow tree after user data is collected. User data can be collected via forms by using predefined questions: What is your name? and What is your date of birth?, where user can type in their name and date of birth that will be used for search, or when user input is not present, that will be extracted from the ID. Forms data has priority over ID data when both are present.

📘

Requisites

Before Watchlist module user data needs to be collected via Forms or ID Capture + ID Validation modules.

Module Configuration

Watchlist module configuration

Conditions

Watchlist results can be used in conditions to impact further user journey or session result:

Single Session Dashboard Results

They are available on Single Session view under Risk tab → Watchlist Result. Clicking on Click here to discover more takes you to detailed view of all matches, hits with information where the user was found.

Subscribe for updates

You can subscribe to updates on the search results and received notification via webhooks.

To configure a webhook for notifying when the global watchlist has updates, you'll need to set up a POST request to a client-defined URL. Configure your webhook url under on Omni Dashboard Configuration → Webhooks: Watchlist update webhook URL. This request will include a body with three mandatory fields:

These fields are used to identify and retrieve the new search result via API - Updated watchlist result.

When performing watchlist search, user should provide “subscribe”:true body parameter and webhook url in Organization’s configuration is set. In the response field ref is of interest, and should be saved by the user. When the search is updated (entities are updated-added-removed) Incode will send the previously saved ref to the user’s webhook to inform the search is updated.

When the user wants to pull the newest data for the updated search, they use /omni/updated-watchlist-result?ref=[referenceId] endpoint.

Steps

Global watchlist request:

You can manually unsubscribe from the Single Session view.

📘

Notes:

Once session is deleted, notifications on the search results will no longer be received.

Direct API Approach

All module configurations and user data can be forwarded directly in the request for performing global watchlist search. This will override existing configuration and data collected about the user.

Note: watchlistTypes parameter should not be included in the API request if they are already specified in the module configuration.

📘

API Authentication

All endpoints require authentication headers to be specified as stated in Incode API Documentation

Process Global Watchlist

POST /omni/process/global-watchlist
Designed for execution where configuration determines behavior and results are persisted for further usage in the processing pipeline (e.g. scoring).

Uses flow configuration (Watchlist module configuration) and requires configuration to be present in the flow, throws an error if it is missing. Merges request data with configuration from the flow and session details.

Response only indicates the success status of the operation ( true or false).

Note: uses subscription flag from configuration

JSX

RESPONSE EXAMPLE
{
  "success": true
}

Watchlist result

POST /omni/watchlist-result
More flexible, lightweight alternative. Uses only the request data and interview data. Returns results without storing.

Note: Uses subscription flag from request

JSX

RESPONSE EXAMPLE
{
  "content": {
    "data": {
      "id": 1697044869,
      "ref": "1712607640-1sEYsOYW",
      "searcher_id": 14876,
      "assignee_id": 14876,
      "filters": {
        "birth_year": 1961,
        "country_codes": ["US"],
        "exact_match": false,
        "fuzziness": 0.5,
        "remove_deceased": 0,
        "types": [
          "pep-class-4",
          "pep-class-1",
          "pep-class-3",
          "pep",
          "sanction",
          "pep-class-2"
        ]
      },
      "match_status": "potential_match",
      "risk_level": "unknown",
      "search_term": "John Doe",
      "total_hits": 2,
      "total_matches": 2,
      "updated_at": "2024-04-08 20:20:40",
      "created_at": "2024-04-08 20:20:40",
      "tags": [],
      "limit": 100,
      "offset": 0,
      "share_url": "https://app.eu.complyadvantage.com/public/search/1712607640-1sEYsOYW/573af167e1a0",
      "hits": [
        {
          "doc": {
            "aka": [
              {"name": "John Doe"}
            ],
            "associates": [
              {"association": "parent", "name": "Nick Doe"},
              {"association": "spouse", "name": "Jane Doe"}
            ],
            "fields": [
              {"name": "Nationality", "source": "complyadvantage", "value": "United States"},
              {"name": "Political Position", "source": "complyadvantage", "value": "44th President of the United States of America"}
            ],
            "id": "1CLBTB5OU7NL55O",
            "last_updated_utc": "2024-04-08T15:04:40Z",
            "name": "John Doe",
            "sources": ["complyadvantage"],
            "types": ["pep", "pep-class-1", "pep-class-2"]
          },
          "is_whitelisted": false,
          "match_types": ["aka_exact", "year_of_birth"],
          "score": 1.0
        }
      ]
    }
  },
  "status": "success"
}

Updated watchlist result

GET /omni/updated-watchlist-result?id={{interviewId}}&ref={{ref}}
InterviewId and ref are values received in the webhook

JSX

Unsubscribe from updates

To unsubscribe from watchlist updates, use the following endpoint:

POST /omni/watchlist/unsubscribe?id=[interviewId]

Provisioning

To obtain comprehensive details on the pricing and provisioning of the Watchlist module, we encourage you to contact our dedicated customer support team. Our experts are on hand to assist you in tailoring a search profile that precisely meets your unique requirements, guiding you through the most effective configuration options for your specific use case. This personalized approach ensures that you leverage the full potential of the Watchlist module, optimizing your workflows for security and compliance. Our team is committed to providing you with the support and insights needed to make informed decisions, ensuring a seamless integration process.