---
title: "List entity watchlist screenings"
method: POST
path: "/watchlist_screening/entity/list"
tags: ["plaid"]
---

# List entity watchlist screenings

`POST /watchlist_screening/entity/list`

List all entity screenings.

## Request body

- WatchlistScreeningEntityListRequest — Request input for listing entity watchlist screenings
  - `secret` string — Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
  - `client_id` string — Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
  - `entity_watchlist_program_id` string, required — ID of the associated entity program.
  - `client_user_id` string — A unique ID that identifies the end user in your system. This ID can also be used to associate user-specific data from other Plaid products. Financial Account Matching requires this field and the `/link/token/create` `client_user_id` to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the `client_user_id`.
  - `status` 'rejected' | 'pending_review' | 'cleared' — A status enum indicating whether a screening is still pending review, has been rejected, or has been cleared.
  - `assignee` string — ID of the associated user.
  - `cursor` string, nullable — An identifier that determines which page of results you receive.

## Response `200`

OK

- WatchlistScreeningEntityListResponse — Paginated list of entity watchlist screenings
  - `entity_watchlist_screenings` EntityWatchlistScreening[], required — List of entity watchlist screening
    - `id` string, required — ID of the associated entity screening.
    - `search_terms` EntityWatchlistScreeningSearchTerms, required — Search terms associated with an entity used for searching against watchlists
      - `entity_watchlist_program_id` string, required — ID of the associated entity program.
      - `legal_name` string, required — The name of the organization being screened.
      - `document_number` string, nullable, required — The numeric or alphanumeric identifier associated with this document.
      - `email_address` string, email, nullable, required — A valid email address.
      - `country` string, nullable, required — Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.
      - `phone_number` string, nullable, required — A phone number in E.164 format.
      - `url` string, uri, nullable, required — An 'http' or 'https' URL (must begin with either of those).
      - `version` integer, required — The current version of the search terms. Starts at `1` and increments with each edit to `search_terms`.
    - `assignee` string, nullable, required — ID of the associated user.
    - `status` 'rejected' | 'pending_review' | 'cleared', required — A status enum indicating whether a screening is still pending review, has been rejected, or has been cleared.
    - `client_user_id` string, nullable, required — A unique ID that identifies the end user in your system. This ID can also be used to associate user-specific data from other Plaid products. Financial Account Matching requires this field and the `/link/token/create` `client_user_id` to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the `client_user_id`.
    - `audit_trail` WatchlistScreeningAuditTrail, required — Information about the last change made to the parent object specifying what caused the change as well as when it occurred.
      - `source` 'dashboard' | 'link' | 'api' | 'system', required — A type indicating whether a dashboard user, an API-based user, or Plaid last touched this object.
      - `dashboard_user_id` string, nullable, required — ID of the associated user.
      - `timestamp` string, date-time, required — An ISO8601 formatted timestamp.
  - `next_cursor` string, nullable, required — An identifier that determines which page of results you receive.
  - `request_id` string, required — A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

## Changes

- **2024-02-21** `5de70cc1e6ca` — 1 breaking
  - the `client_user_id` request property's minLength was increased from `0` to `1`

[Change history](https://skmtc.dev/plaid/apis/the-plaid-api/changes/watchlist_screening/entity/list/post.md)

---

[API](https://skmtc.dev/plaid/apis/the-plaid-api.md) · [All operations](https://skmtc.dev/plaid/apis/the-plaid-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/plaid/the-plaid-api/revisions/a5b45bccb4e8/schema)