Changes 2026.01.12

What's New

A number of new APIs have been introduced to manage watchlists and watchlist entries. The new watchlist capabilties relate VistorID, Document Number, IP Address and Face. Older APIs to manage Face watchlist are deprecated but will remain in place for a period of time.

  • GET /api/watchlist-manager/watchlists/{watchlistId}
  • POST /api/watchlist-manager/watchlists/{watchlistId}
  • DELETE /api/watchlist-manager/watchlists/{watchlistId}
  • GET /api/watchlist-manager/watchlists/usage/largest
  • GET /api/watchlist-manager/watchlists/{watchlistId}/usage
  • GET /api/watchlist-manager/watchlists
  • POST /api/watchlist-manager/watchlists
  • GET /api/watchlist-manager/watchlists/{watchlistId}/entries/{entryId}
  • DELETE /api/watchlist-manager/watchlists/{watchlistId}/entries/{entryId}
  • GET /api/watchlist-manager/watchlists/usage
  • POST /api/watchlist-manager/watchlists/{watchlistId}/queries
  • GET /api/watchlist-manager/watchlists/{watchlistId}/entries
  • POST /api/watchlist-manager/watchlists/{watchlistId}/entries
  • GET /api/identity-store/stores/{storeName}/users/{userExtId}/totps/{id}/ext

What's Deprecated

Older APIs to manage Face watchlist are deprecated but will remain in place for a period of time.

  • GET /api/watchlist-manager/facewatchlists/{watchlistId}/watchlist-members/{watchlistMemberId}/image
  • GET /api/watchlist-manager/facewatchlists/{watchlistId}
  • POST /api/watchlist-manager/facewatchlists/{watchlistId}
  • DELETE /api/watchlist-manager/facewatchlists/{watchlistId}
  • GET /api/watchlist-manager/facewatchlists/{watchlistId}/watchlist-members/{watchlistMemberId}
  • DELETE /api/watchlist-manager/facewatchlists/{watchlistId}/watchlist-members/{watchlistMemberId}
  • POST /api/watchlist-manager/facewatchlists/{watchlistId}/watchlist-members
  • GET /api/watchlist-manager/facewatchlists/{watchlistId}/watchlist-members
  • POST /api/watchlist-manager/facewatchlists
  • GET /api/watchlist-manager/facewatchlists

What's Changed

GET /api/watchlist-manager/facewatchlists/{watchlistId}

Return Type:

Changed response : 200 OK

Added support in the API for additional watchlist types. However, these types do not apply to the old Face Watchlists API - only the types FACEV6 /facev6 apply.
  • Changed content type : */*
  • Changed property type (string)

Added enum values:

  • facev6
  • documentNumber
  • ipv4Address
  • visitorID Removed enum value:
  • FACEV6

Return Type:

Changed response : 200 OK

Added support in the API for additional watchlist types. However, these types do not apply to the old Face Watchlists API - only the types FACEV6 /facev6 apply.
  • Changed content type : */*
  • Changed property type (string)

Added enum values:

  • facev6
  • documentNumber
  • ipv4Address
  • visitorID Removed enum value:
  • FACEV6

POST /api/theme-server/customPages/{id}/status/{status}

Return Type:

Changed response : 200 OK

Added new property previewGatewayUrl - this property is only used by the Backoffice.
  • Changed content type : */*
  • Added property previewGatewayUrl (string)

GET /api/theme-server/customPages/{id}

Parameters:

Added: includeGatewayUrl in query

Return Type:

Changed response : 200 OK

Added new property previewGatewayUrl - this property is only used by the Backoffice.
  • Changed content type : */*
  • Added property previewGatewayUrl (string)

POST /api/theme-server/customPages/{id}

Return Type:

Changed response : 200 OK

Added new property previewGatewayUrl - this property is only used by the Backoffice.
  • Changed content type : */*
  • Added property previewGatewayUrl (string)

POST /api/watchlist-manager/facewatchlists

Added support in the API for additional watchlist types. However, these types do not apply to the old Face Watchlists API - only the types FACEV6 /facev6 apply.

Request:

Changed content type : application/json

  • Changed property type (string)

Added enum values:

  • facev6
  • documentNumber
  • ipv4Address
  • visitorID Removed enum value:
  • FACEV6

Return Type:

Changed response : 201 Created

  • Changed content type : */*
  • Changed property type (string)

Added enum values:

  • facev6
  • documentNumber
  • ipv4Address
  • visitorID Removed enum value:
  • FACEV6

GET /api/watchlist-manager/facewatchlists

Added support in the API for additional watchlist types. However, these types do not apply to the old Face Watchlists API - only the types FACEV6 /facev6 apply.

Return Type:

Changed response : 200 OK

  • Changed content type : */*
  • Changed property content (array)

Changed items (object):

  • Changed property type (string)

Added enum values:

  • facev6
  • documentNumber
  • ipv4Address
  • visitorID Removed enum value:
  • FACEV6
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard
Next to read:
Advance Notices
Edit on GitHub
On This Page
Changes 2026.01.12What's NewWhat's DeprecatedWhat's ChangedGET /api/watchlist-manager/facewatchlists/{watchlistId}Return Type:Return Type:POST /api/theme-server/customPages/{id}/status/{status}Return Type:GET /api/theme-server/customPages/{id}Parameters:Return Type:POST /api/theme-server/customPages/{id}Return Type:POST /api/watchlist-manager/facewatchlistsRequest:Return Type:GET /api/watchlist-manager/facewatchlistsReturn Type: