Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Watchlist (deprecated)

Update watchlist monitoring subscription

put/customers/{customer_id}/watchlists/subscriptions/{subscription_id}

Path parameters

subscription_idstring uuid required
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

Watchlist monitoring subscription ID

customer_idstring uuid required
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

The customer's unique identifier

Request body

auto_renewboolean

Whether this subscription should automatically renew when the subscription period is over (default: vendor-dependent).

createdstring date-time

When this subscription was created

customer_consentboolean required

Whether this customer has consented to being enrolled for watchlist monitoring

idstring uuid

Unique identifier for this subscription

period_endstring date

The date when monitoring of this individual should end.

period_startstring date

The date when monitoring of this individual should begin (default: today).

provider_subscription_idstring

External provider subscription id

status'ACTIVE' | 'INACTIVE'

Response

Updated watchlist subscription

auto_renewboolean

Whether this subscription should automatically renew when the subscription period is over (default: vendor-dependent).

createdstring date-time

When this subscription was created

customer_consentboolean required

Whether this customer has consented to being enrolled for watchlist monitoring

idstring uuid

Unique identifier for this subscription

period_endstring date

The date when monitoring of this individual should end.

period_startstring date

The date when monitoring of this individual should begin (default: today).

provider_subscription_idstring

External provider subscription id

status'ACTIVE' | 'INACTIVE'