Export Compliance
Create Watchlist
POST
/v1/monitoring/watchlists$0.05 per callScreens the parties now to set a baseline, then re-screens them whenever the Consolidated Screening List changes. A change in a party's strong matches sends a signed party.status_changed webhook.
Send an Idempotency-Key header to retry safely.
Request body
| Field | Type | Description |
|---|---|---|
| namerequired | string | max length 200 |
| partiesrequired | array of object | min 1 items · max 50 items |
| parties[].namerequired | string | max length 500 |
| parties[].countryoptional | string | max length 3 |
| parties[].externalRefoptional | string | max length 200 |
| webhookoptional | object | |
| webhook.urlrequired | string | HTTPS only; private and reserved addresses are rejected format uri |
| webhook.secretoptional | string | Optional signing secret; generated and returned once when omitted min length 16 |
Response fields
| Field | Type | Description |
|---|---|---|
| success | boolean | |
| data | object | |
| data.id | string | |
| data.name | string | |
| data.isActive | boolean | |
| data.webhookUrl | string | |
| data.createdAt | string | |
| data.parties | array of object | |
| data.parties[].id | string | |
| data.parties[].name | string | |
| data.parties[].country | string | |
| data.parties[].externalRef | string | |
| data.parties[].status | string | |
| data.parties[].lastScreenedAt | string | |
| data.parties[].lastListVersion | string |
Errors
- 400 invalid request
- 401 missing or bad key
- 403 not in your plan
- 429 rate limited, see Retry-After
- 402 payment required
- 5xx retry with backoff
Error bodies and codes are described in Error codes and troubleshooting.