Skip to main content
GET
/
kyc
/
watchlists
/
{watchlist_id}
Get Watchlist Details
curl --request GET \
  --url https://api.example.com/kyc/watchlists/{watchlist_id}

Endpoint

GET /kyc/watchlists/{watchlist_id}

Authentication

Requires watchlist:read permission.

Path Parameters

watchlist_id
string
required
The unique identifier of the watchlist

Request Example

curl -X GET https://stg.kyc.legaltalent.ai/kyc/watchlists/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "status": "success",
  "data": {
    "watchlist_id": "550e8400-e29b-41d4-a716-446655440000",
    "tenant_id": "tenant123",
    "name": "High Risk Customers",
    "subjects": [
      {
        "subject_id": "660e8400-e29b-41d4-a716-446655440001",
        "full_name": "John Doe",
        "identifier": "12345678",
        "identifier_type": "document",
        "added_at": "2024-11-22T10:30:00Z",
        "expires_at": 1763789400
      }
    ],
    "lists_to_monitor": ["ofac", "un"],
    "check_frequency": "daily",
    "last_checked_at": "2024-11-22T09:00:00Z",
    "next_check_due": 1732278600000,
    "last_results": {
      "checked_at": "2024-11-22T09:00:00Z",
      "subjects_checked": 5,
      "matches_found": 0,
      "new_matches": 0,
      "s3_snapshot_key": "snapshots/tenant123/550e8400/2024-11-22T09:00:00Z.json"
    },
    "alert_config": {
      "on_new_match": true,
      "on_status_change": true,
      "webhook_url": "https://your-server.com/webhooks/kyc",
      "notification_email": "compliance@example.com"
    },
    "status": "active",
    "created_at": "2024-11-22T10:30:00Z",
    "updated_at": "2024-11-22T10:30:00Z"
  }
}

Response Fields

FieldTypeDescription
watchlist_idstringUnique identifier
tenant_idstringYour tenant ID
namestringWatchlist name
subjectsarrayFull list of monitored subjects
lists_to_monitorarrayLists being checked
check_frequencystringScreening frequency
last_checked_atstring/nullLast check timestamp
next_check_duenumber/nullNext check timestamp (Unix ms)
last_resultsobject/nullMost recent screening results
alert_configobjectAlert configuration
statusstringactive or paused
created_atstringCreation timestamp
updated_atstringLast update timestamp

Subject Fields

FieldTypeDescription
subject_idstringUnique identifier
full_namestringSubject’s full name
identifierstring/nullDocument ID, wallet, etc.
identifier_typestring/nullType of identifier
added_atstringWhen added to watchlist
expires_atintegerUnix timestamp for TTL expiration

Error Responses

404 Not Found

{
  "status": "error",
  "error": {
    "type": "NotFoundError",
    "message": "Watchlist not found",
    "code": "WATCHLIST_NOT_FOUND"
  }
}

Status Codes

CodeDescription
200Success
401Unauthorized
403Forbidden - Missing watchlist:read permission
404Not Found
500Internal Server Error

Next Steps