Enable Watchlist Monitoring for an Evaluation

post

https://riskos.socure.com/api/evaluation/monitoring

Enable or disable daily watchlist monitoring for an existing evaluation. Monitored entities are checked automatically for list additions, modifications, or removals.

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

Headers

X-API-Version

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.

Body Params

reference_id

uuid

required

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

string

enum

required

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:

operation

string

enum

required

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:

Responses

400

Bad Request - The request was unacceptable.

401

Unauthorized - An invalid API key was provided.

403

Forbidden - The client does not have permission to access this resource.

404

Not Found - The requested resource does not exist.

500

Internal Server Error – Unexpected server issue.

Language

Credentials

Bearer

URL

Loading…

Response

Choose an example:

application/json

200The request was processed successfully.