# Custom Watchlist
The Custom Watchlist module screens the user's collected data, including biometric face data when available, against your organization's private watchlist of blocked or trusted users, and influences the Session outcome accordingly. It runs as a background process and isn't visible to the end user.
For an overview of this module and how it works, see [Custom Watchlist](https://developer.incode.com/docs/custom-watchlist).
## Supported with:
:white_check_mark: Workflows | :white_check_mark: Flows
## Add Custom Watchlist to Workflows
1. In the left menu, click **Flow Builder** > **Workflows**.
2. Click **New** or select an existing Workflow.
3. Ensure that the modules that collect user data, such as ID Capture and Face Capture, are in your Workflow.
4. From the **Processes** list, drag and drop the **Custom Watchlist** module into the builder after the data-collection modules.
5. You can click the three dots > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.
## Add Custom Watchlist to Flows
1. In the left menu, click **Flow Builder** > **Flows**.
2. Click **New** or select an existing Flow.
3. Ensure that the modules that collect user data, such as ID Capture and Face Capture, are in your Flow
4. On the **Select Modules** tab, find the **Custom Watchlist** module and click **Add**.
5. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.
## Configuration Options
This section details all the configuration options available for this module. After changing anything, click **Save configurations** before closing the configuration panel.
The options you see in your configuration may differ from those documented below. Contact your Incode representative for more information.
| Setting | Description |
| ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **_Fail in face match_**
_Flows only_ | When enabled, a biometric face match against a Blocklist entry directly fails the Session, regardless of other scoring. |
| **Automatically add suspected fraud** | When enabled, the system automatically adds a user to the Blocklist when fraud signals are detected: for example, if a face match fails or if there is a name or date of birth mismatch against a record already linked to the same biometric face template. Score updates apply to the current session and all future sessions. Historical sessions are not affected. |
| **_Auto execute_**
_Flows only_ | When enabled, the module runs automatically after ID and face data have been collected, without requiring a manual trigger. |
| **_Shared device mode_** | When enabled, device-specific identifiers such as device hash are excluded from watchlist matching. Use this when users access the service on shared devices, such as a branch kiosk. |
| **_Use fallback search_**
_Workflows only_ | When enabled, the module performs a fallback search if the primary matching pass does not return a result. {/* TODO: Confirm with PM — exact behavior of fallback search, including which fields or methods it falls back to */} |
| **_Exclude ID photo from matching_** | When enabled, the ID photo is not used when matching the user against watchlist entries. |
## Add Conditions
[Conditions](https://developer.incode.com/docs/configure-workflow-conditions) let you branch the Workflow based on a result. Conditions are optional for Custom Watchlist, but you can add one or more Conditions after the module to route the session based on whether the user was found on a Blocklist or Allowlist.
To add a Condition for Custom Watchlist:
1. Drag a Condition into the builder from the left panel. Place it after the Custom Watchlist module.
2. In the first drop-down, find the Custom Watchlist section and select one of the conditions listed below:
| Condition | Description |
| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Watchlist birth date match | If the user's date of birth matches a date of birth on a watchlist entry. |
| Watchlist device hash match | If the user's device fingerprint matches a device hash on a watchlist entry. This is a high-impact signal. When **_Shared device mode_** is enabled, device identifiers are excluded from matching. |
| Watchlist phone match | If the user's phone number matches a phone number on a watchlist entry. |
| Watchlist name match | If the user's name matches a name on a watchlist entry. Name matching is scored and fuzzy. |
| Watchlist type | The list classification of the matched entry: _BLOCKLIST_ or _ALLOWLIST_. Include this condition to determine whether a match should restrict or trust the user. Blocklist matches reduce the session score; Allowlist matches increase it. |
| Watchlist email match | If the user's email address matches an email on a watchlist entry. |
| Watchlist personal id number match | If the user's personal ID number matches a personal ID number on a watchlist entry. |
| Watchlist face match | If the user's face matches a face template enrolled in the watchlist. If **_Fail in face match_** is enabled, a match against a Blocklist entry directly fails the session. |
| Watchlist id number match | If the user's document number matches an ID number on a watchlist entry. |
3. In the second drop-down, select an operator.
4. In the value field, enter or select the value to compare against.
5. Select the **Yes path** or **No path** radio button to route the Workflow when the Condition is met.
6. Click **Save condition**.