Enable Watchlist Monitoring for an Evaluation

Watchlist Monitoring API

Overview

Note: This endpoint is currently unavailable in the Sandbox environment. Use the Production environment for testing and integration.

Request Parameters

X-API-Version

Type: string
Specifies the API version used for the request. If omitted, the default version is used. Socure recommends pinning a version to avoid unexpected behavioral changes when new versions are released.

reference_id

Type: uuid
Required: Yes
Unique identifier assigned to a Watchlist enrichment after a RiskOS™ workflow is finalized. You can retrieve this value from the response of a successful call to the Evaluation endpoint.

list_type

Type: string
Required: Yes
Enum:
Specifies the type of monitoring list to which the entity (identified by its enrichment referenceId) will be subscribed.
Passing watchlist enables monitoring for changes across all watchlist types defined in your Monitoring policy.

Allowed: watchlist

operation

Type: string
Required: Yes
Enum:
Specifies the action to be taken for monitoring enrollment.
- enable: Activates Watchlist Monitoring for the specified evaluation.
- disable: Deactivates Watchlist Monitoring for the specified evaluation.

Allowed: enable, disable

Sample Request

curl --request POST \
     --url https://riskos.socure.com/api/evaluation/monitoring \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
  "reference_id": "ae94dd2e-46fe-4e58-bf0b-45ef1d4588a2",
  "list_type": "watchlist",
  "operation": "enable"
}'

Sample Response

{
  "success": true,
  "monitoring_status": "enabled"
}