List IDV Watchlist Events

Retrieve a list of watchlist events for IDV applications.

A watchlist event provides a snapshot of the IDV application at each stage of the evaluation process. Each time the IDV provider evaluates the application, a new snapshot is created. You can use these snapshots to track the evaluation’s progress.

Watchlist events will be retrieved for the Business Account associated with the request access token. You can retrieve all events or use the accountId query parameter to retrieve events for specific Business Accounts, Customer Accounts, and Beneficiary Accounts.

Endpoint

GET /v1/watchlist-events

Authorization Header

Authorization: Bearer <access_token>

Query Parameters

accountId

string

Return watchlist events for IDV applications belonging to specific accounts. Use a comma-separated list to specify the IDs of the Business Accounts, Customer Accounts, and/or Beneficial Owners to include.

page

integer (int32)

Page number to return, based on zero-based page indexing.

size

integer (int32)

Maximum number of results to return per page.

sort

array of strings

Sort the response by any field in ascending or descending order. The default sort order is createdAt,DESC. For more information, see Sorting and Pagination.

Request Body

None

Returns

Returns a paginated response with an array of IDV Watchlist Event objects.

SAMPLE RESPONSE

				
					{
  "totalElements": 3,
  "totalPages": 1,
  "number": 0,
  "numberOfElements": 3,
  "hasNext": false,
  "content": [
    {
      "id": "307bec05-32fd-4f18-ab84-2f5b65f430af",
      "accountId": "ceb718df-eb7e-4cf3-a441-8d0dc66598ce",
      "accountType": "BUSINESS_CUSTOMER",
      "businessAccountId": "a31deb94-5e73-4125-95f4-357276a2118a",
      "status": "COMPLETED",
      "outcome": "APPROVED",
      "outcomeReasons": [
        {
          "name": "Phone match",
          "type": "Fraud check"
        }
      ],
      "tags": [
        "Phone number matched"
      ],
      "servicesRun": [
        "ComplyAdvantage"
      ],
      "createdAt": "2024-08-15T15:14:30.418Z",
      "createdBy": {
        "id": "87c8fd00-4b94-4cb7-a020-8bebb8aff1de",
        "type": "employee"
      }
    },
    {...},
    {...}
  ]
}