API Reference
Home

Manage a Custom Watchlist Record

post
https://riskos.socure.com/api/custom-watchlists//records

Add, update, or soft-delete a record on one of your custom watchlists. The operation is set by the action_type field and keyed by the record ID.

📘

Note:

The custom watchlist must already exist before you call this endpoint. Create it in the RiskOS™ Dashboard (Reason Codes & Lists > Custom Watchlist), then use the list's ID as the listId path parameter. For setup steps, see Custom Watchlist.

Path Params
uuid
required

The unique ID of the custom watchlist to add, update, or remove a record from. The list must already exist (created in the RiskOS™ Dashboard).

Body Params
string
enum
required

The action to take on this record — add, update, or delete.
Note: delete is a soft delete; the record stays on the list, but its status changes from Active to Inactive.

Allowed:
record
object
required

The record details you're adding, updating, or deleting.

Responses

Updated about 1 hour ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated about 1 hour ago

Did this page help you?