Watchlist Management

The Watchlist Management feature in SmartFace Station empowers you to maintain an accurate and current record of individuals of interest, a crucial aspect of security management. The Watchlist Management enables you to manage watchlists and watchlist members.

The SmartFace Station - The Watchlist Management

Once you’ve registered members into your watchlists, SmartFace continually scans and matches individuals in real-time, comparing their faces to the watchlist members. If a match is detected, you will receive immediate notifications, allowing you to take appropriate actions promptly. This matching capability is a fundamental component of proactive security and ensures that you are alerted to the presence of individuals of interest.

Manage a watchlist

in the SmartFace Station you can create watchlists, edit their name, color, matching threshold or delete them. SmartFace STation also allows you to easily register, edit and delete members from these watchlists.

Create a watchlist

To create a watchlist, you have to name the watchlist, add watchlist members and specify a matching threshold. Please follow these instructions:

  1. Go to Watchlists in the left panel.
  2. Select ADD WATCHLIST.
  3. Type the name of your watchlist and confirm with CREATE WATCHLIST.

  1. Upload one photo per one watchlist member by dropping the photos directly onto the marked area or by choosing the photos on your computer.

⚠️ In this step, it's only possible to add maximum 30 photos of watchlist members. However, you may add other watchlist members, after you completed this step. Please, see below.

  1. After you uploaded photos of watchlist members, click NEXT.
  2. Type the FULL NAME for every uploaded watchlist member. You may also add a note by specifying the NOTE field.
  3. Click NEXT.

  1. If you want to add more watchlist members, click ADD MEMBERS.
  2. Specify the MATCHING THRESHOLD depending on your use case and CONFIRM. For more information what is the matching threshold, see Matching.

⚠️ The matching threshold depends on the specific use case. As a general rule, the higher the score, the more certain SmartFace is that the two images match. However, if the score is set too high, then SmartFace could incorrectly reject matching images (incorrectly deny access to an authorized person).

Edit the watchlist name

  1. Select the specified watchlist
    Begin by selecting the watchlist whose name you wish to change. You can find a list of available watchlists on the main screen of the watchlist management.

  2. Click on the Watchlist Name and edit
    After clicking on the watchlist name, it should become an editable text field. Then click outside the text box or press Enter on your keyboard.

Edit the watchlist color

  1. Select a specified watchlist
    Start by choosing the watchlist you want to modify. You can find a list of available watchlists on the main screen of the watchlist management.
  2. Click on the watchlist Icon
    Next to the name of the selected watchlist, you’ll see a watchlist icon. Click on this icon.
  3. Choose from the color palette
    Once you click on the watchlist icon, a palette of colors will be displayed. You can choose a color from this palette to change the watchlist’s color. By default, the watchlist’s color is green.

Please note that the color of the watchlist can also be customized using the REST API endpoint   PUT   /api/v1/watchlists.by specifying the previewColorattribute. This allows you to have further control over the appearance of the watchlist to suit your preferences and needs.

Edit the watchlist matching threshold

For more information what is the matching threshold, see chapter about matching.

  1. Click on a specific watchlist.
  2. Select the MATCHING THRESHOLD depending on your use case. The default value for the matching threshold is 45.

  1. CONFIRM.

Delete the watchlist

To delete the watchlist:

  1. Go to Watchlists in the left panel.
  2. Then, you may either:
  • hover the mouse over the specific watchlist and select DELETE,

  • or select the watchlist and click DELETE in the right upper corner in watchlist detail.

⚠️ Please note that deletion of a watchlist in SmartFace Station also deletes all watchlist members.

Mark a watchlist as restricted

A restricted watchlist is created by marking a regular watchlist as restricted. In the current version of SmartFace Station it is not possible to mark a watchlist as restricted directly in the web application. This step requires manual changes in the configuration files on the web server.

The change needs to be done in two places:

  • configuration file for SmartFace Station
  • configuration file for Access Controller.

It is possible to mark multiple watchlists as restricted.

To change the watchlist into restricted - SmartFace Station

  1. Go to the location where you installed the SmartFace Station. For example, C:\Program Files (x86)\SmartFace Station\.
  2. Open the .env configuration file.
  CORE_API_ROOT=http://localhost:8098/api/v1
  ODATA_API_ROOT=http://localhost:8099
  ACCESS_CONTROLLER_ADDRESS=localhost:5050
  HOST=0.0.0.0
  PORT=8000
  BLACKLIST_WATCHLIST_IDS=8cb4a672-25b4-475f-bd94-2f8a31c760e1,0794ff0c-9de6-49fb-877d-24bb46dc806e
  ENABLE_AUTHENTICATION=false
  KEYCLOAK_ADMIN_URL=http://localhost:8080/auth/admin

Add the ID of the watchlist into BLACKLIST_WATCHLIST_IDS variable. You may specify multiple blacklists at once by entering watchlists' IDs separated with a comma (BLACKLIST_WATCHLIST_IDS=ID1, ID2, ID3).

ℹ️ To get the watchlist IDs, use the   GET   /api​/v1​/Watchlists in SmartFace REST API.

To change the watchlist into restricted - Access Controller

  1. Go to the location where you deployed Access Controller.
  2. Open the appsetting.json configuration file, which can be found in the folder where it was extracted.
  3. In the configuration section under the FilterConfiguration.BlacklistsConfiguration key, set the Blacklist attribute to the watchlist IDs, which you want to mark as blacklists. Note that this attribute is a JSON string array.
  "BlacklistsConfiguration": {
	"Enabled": true,
	"Blacklists": [ "8cb4a672-25b4-475f-bd94-2f8a31c760e1", "0794ff0c-9de6-49fb-877d-24bb46dc806e" ]
  },
  1. After you completed the changes, restart the SmartFace Access Controller and SmartFace Station services:
  • Go to the Task Manager and select the Services tab.
  • Right-click on the specific service (SFAccessController or SFStation) and choose Restart.

Restricted Watchlists

When watchlist is marked as restricted it is displayed in overall list of watchlist and also in watchlist details.

Restricted watchlist in list of watchlists

Restricted label in watchlist details

Manage watchlist members

Watchlist members can be accessed by opening a respective watchlist. Members are listed in a plane table which is divided into discrete pages that are limited to display maximum of 100 members. When the limit is reached, members are displayed on the next page and the pages numbers are shown on the bottom of the page. The pagination helps you to navigate among multiple members.

List of watchlist members with 208 items separated into 3 pages.

Register the watchlist member

There are 2 ways to add new member into existing watchlist:

Register new watchlist member in the watchlists section

  1. Open the watchlist.
  2. Then, click on the +ADD MEMBERS button.
  3. Upload one photo per one watchlist member by dropping the photos directly on to the marked area, by choosing the photos on your computer or by taking a photo with the camera on your device. It’s only possible to add maximum 30 photos of watchlist members.

⚠️ To enable taking photos in the SmartFace Station, you need to set configuration parameter DOT_FACE_CAMERA_ENABLED during the SmartFace deployment and setup secure (HTTPS) connection to the SmartFace Station. If “take photo” feature is not available for you, please contact your SmartFace system administrator
  1. After you uploaded photos of watchlist members, click NEXT.
  2. You can enter the FULL NAME for every uploaded watchlist member. You may also add a note by specifying the NOTE field.
  3. Click NEXT to confirm. The members are added.

⚠️ Face not found on the uploaded image

It is possible that SmartFace Platform does not detect a face on the uploaded image due to the bad conditions for facial recognition (insufficient lightning, wrong angle, small size of the face on the image etc.). In such case, the system will inform you that the face is not detected on the image.

SmartFace Platform does not detect a face on the uploaded image.

Edit the watchlist member

  1. Open the watchlist.
  2. Then, click on the watchlist member you want to modify.
  3. Details of watchlist members are displayed on the right side of your screen.
  4. You may edit the watchlist member’s NAME and NOTE. There is also an option to configure additional user information below.
  5. Changes are saved automatically once you hit the enter or click anywhere on the screen or close the watchlist member detail.

Manage watchlist member labels

In the current version of SmartFace Station is possible to add more information about watchlist members in watchlist member´s detail. Labels are set of unique key value pairs - each label consists of a key-label and a key-value. This step requires manual changes in the configuration files on the web server or via REST API.

Manage watchlist member labels via configuration file .env

To add or change the watchlist member´s labels:

  1. Go to the location where you installed the SmartFace Station. For example, C:\Program Files (x86)\SmartFace Station\.
  2. Open the .env configuration file.
  3. Add new labels (e.g. Date of birth and Tax number).
ℹ️ Note that a key-label can be managed through the configuration file. WATCHLIST_MEMBER_LABEL is displayed on the SmartFace Station. A key-value can be managed only through the SmartFace Station or REST API.
WATCHLIST_MEMBER_KEY_0=date
WATCHLIST_MEMBER_LABEL_0=Date of birth
 
WATCHLIST_MEMBER_KEY_1=tax_number
WATCHLIST_MEMBER_LABEL_1=Tax number
  1. After you completed the changes, restart the SmartFace Station services:

    • Go to the Task Manager and select the Services tab.

    • Right-click on the specific service (SFStation) and choose Restart.

  2. After restarting the SmartFace Station service, you will be able to add values to the created or changed watchlist member labels directly in the web application in watchlist member´s detail

Watchlist member detail with labels (Date of birth and Tax number)

Manage watchlist member labels via REST API

The WachlistMember entity allows you to set watchlist member labels (key-label and key- value) via REST API. For example: labels Date of birth and Tax number

"labels": [
    {
      "key": "date",
      "value": "12/09/1994"
    }
    {
      "key": "tax_number",
      "value": "123456"
    }
 ]
⚠️ There is a possibility to manage labels via [REST API](https://developers.innovatrics.com/smartface/docs/integration/api-references/rest-api/) in WachlistMember entity. To display the same labels in SmartFace Station, it is necessary to maintain consistency with the .env configuration file.

Manage watchlist member images

There are 2 ways to manage images to watchlist members:

  1. in the watchlist section: add/remove image to/from watchlist member´s gallery
  2. from notification detail:
Manage images in the watchlist section

It is possible to upload multiple images for one watchlist member. Multiple images stored for one member can increase the accuracy of the identification of the respective member. Images are displayed in member gallery in member detail.

⚠️ Be careful, when uploading multiple images to one watchlist member. Uploading mismatched photos to the watchlist member will cause the template poisoning and malfunction of the matching.
  1. Open the watchlist.
  2. Then, click on the watchlist member you want to add an image to.
  3. Then, click on the +ADD PHOTOS.
  4. Then, select the image you want to add for the watchlist member.

To remove the image:

  1. Open the watchlist.
  2. Then, click on the watchlist member you want to remove an image from.
  3. Then, hover over the image and click on the icon of the bin to delete the image.
  4. You can also mark multiple images and remove them at once.

Watchlist member image badges

Watchlist member image can be marked with badges located in the right bottom corner of the image.

Watchlist member images marked with a badge “A” are added automatically by Watchlist Autolearn feature. Images without this badge were added manually by the user. For more information, see Watchlist Autolearn chapter.

Watchlist member images marked with a badge “face mask” are added to the cluster of images where face mask was recognized by SmartFace Platform. For more information about autolearn clusters, see Watchlist Autolearn chapter.

Delete watchlist members

Select a specific watchlist and click DELETE next to watchlist member you want to delete.

You may also delete several watchlist members at once, by marking the checkbox next to the members and clicking REMOVE.

Multiple images selected for removal.