API Reference
Home

Enable Watchlist Monitoring for an Evaluation

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

Enables or disables watchlist monitoring for data in an existing evaluation. When monitoring is enabled, each entity in the evaluation is automatically checked daily against the specified lists for any additions, modifications, or removals that may affect their watchlist risk.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Headers
string

Specifies the API version used for the request.

Body Params
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.

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:
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:
boolean
required

Indicates whether the consumer has provided consent for monitoring enrollment.

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.

Updated 3 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 3 months ago