Documentation Index
Fetch the complete documentation index at: https://docs.compliance.legaltalent.ai/llms.txt
Use this file to discover all available pages before exploring further.
Endpoint
PATCH /kyc/watchlists/{watchlist_id}
Authentication
Requires watchlist:update permission.
Path Parameters
The unique identifier of the watchlist
Request Body
All parameters are optional. Only include fields you want to update.
Request Example
curl -X PATCH https://stg.kyc.legaltalent.ai/kyc/watchlists/550e8400-e29b-41d4-a716-446655440000 \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"check_frequency": "weekly"
}'
Additional Request Examples
Pause Watchlist
curl -X PATCH https://stg.kyc.legaltalent.ai/kyc/watchlists/550e8400-e29b-41d4-a716-446655440000 \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"status": "paused"
}'
Update Multiple Settings
curl -X PATCH https://stg.kyc.legaltalent.ai/kyc/watchlists/550e8400-e29b-41d4-a716-446655440000 \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Updated Watchlist Name",
"check_frequency": "weekly",
"status": "active",
"lists_to_monitor": ["ofac", "un", "eu"],
"tags": ["updated", "priority"]
}'
curl -X PATCH https://stg.kyc.legaltalent.ai/kyc/watchlists/550e8400-e29b-41d4-a716-446655440000 \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"tags": ["reviewed", "compliance", "q1-2025"]
}'
Response
{
"status": "success",
"data": {
"watchlist_id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Updated Watchlist Name",
"check_frequency": "weekly",
"status": "active",
"lists_to_monitor": ["ofac", "un", "eu"],
"tags": ["updated", "priority"],
"updated_at": "2024-11-22T11:00:00Z"
}
}
Error Responses
404 Not Found
{
"status": "error",
"error": {
"type": "NotFoundError",
"message": "Watchlist not found",
"code": "WATCHLIST_NOT_FOUND"
}
}
Status Codes
| Code | Description |
|---|
| 200 | Success |
| 400 | Bad Request - Invalid parameters |
| 401 | Unauthorized |
| 403 | Forbidden - Missing watchlist:update permission |
| 404 | Not Found |
| 500 | Internal Server Error |
