DocumentationAPI Reference
Dashboard platform administration, Add Modules

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.

Supported with:

✅ Workflows | ✅ Flows

Add Custom Watchlist to Workflows

  1. In the left menu in Dashboard, 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. Add the Custom Watchlist module. Do one of the following, depending on whether you have the New or Classic view enabled in the toggle in the top right:
    • New: After the modules that collect user data, click Add node Icon of a plus sign > Processes, then search for and select Custom Watchlist.
    • Classic: From the Processes list, drag and drop the Custom Watchlist module into the builder after the modules that collect user data.
  5. You can click Options Icon of three dots stacked on top of each other > Edit on the module node to open the Configuration Options panel and adjust settings as needed.
  6. Add conditions to route sessions based on whether the user was found on a Blocklist or Allowlist.

Add Custom Watchlist to Flows

  1. In the left menu in Dashboard, 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 panel and adjust settings as needed.

Configuration Options

This section details all the configuration options available for this module. The options that appear depend on whether you have the New or Classic view enabled in the toggle in the top right in your Flow or Workflow. After changing anything, click Save configuration 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.

Configuration Options: New

View image of Workflow configuration panel

Image of Custom Watchlist module configuration in Workflows. Availability listed for Web, iOS, and Android. Has four configuration options

View image of Flow configuration panel

Image of Custom Watchlist module configuration in Flows. Availability listed for Web, iOS, and Android. Has five configuration options

Setting Description
Fail session on Blocklist face match
Flows only		 When enabled, a biometric face match against a Blocklist entry directly fails the Session, regardless of other scoring.
Add suspected fraud to Blocklist When enabled, the system automatically adds a user to the Blocklist when fraud signals, such as face match failing, are detected. Score updates apply to the current session and all future sessions. Historical sessions are not affected.
Exclude ID photo from matching When enabled, the ID photo is not used when matching the user against watchlist entries.
Run automatically
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.

Configuration Options: Classic

View image of Workflow configuration panel

Image of the Custom Watchlist module's configuration panel in Workflows. Has four configuration options.

View image of Flow configuration panel

Image of the Custom Watchlist module's configuration panel in Flows. Has five configuration options.

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.
Exclude ID photo from matching When enabled, the ID photo is not used when matching the user against watchlist entries.

Add Conditions

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.

The way you set conditions depends on whether you have the New or Classic view enabled in the toggle in the top right in your Workflow.

Add Conditions: New

  1. Right after Custom Watchlist, click Add node Icon of a plus sign > Conditions.
  2. In the first drop-down under If, expand the Custom Watchlist section and select one of its values:
    Value 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 External ID Match If the user's external ID matches an external ID 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. Configure the second and third drop-downs under If to fit the condition you want:
    • In the second drop-down under If, select is or is not.
    • In the third drop-down under If, select Matched or Not Matched. For Watchlist type, select Blocklist or Allowlist.

      Note

For example, configuring the condition Watchlist name match is Matched will route the session based on if the user's name matches a name on a watchlist entry.

4. Configure the **_Then_** and **_Otherwise_** drop-downs to fit the condition you want.

Note

For example, with Watchlist name match is Matched, you might select Manual Review under Then to send the session to manual review if the user's name matches a name on a watchlist entry. Then, you might select Continue to next step under Otherwise to continue the session if the user's name does not match a watchlist entry.

5. Click **Save condition**.

Add Conditions: Classic

  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.

Was this page helpful?