Sample - Plaid API
POST/watchlist_screening/entity/list

List entity watchlist screenings

Lists entity watchlist screenings associated with a watchlist program. Supply entity_watchlist_program_id and optionally filter by client_user_id, status, or assignee. Use cursor to paginate through the matching screenings.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

7 body fields

Input for listing entity watchlist screenings.

secretstringoptional
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_idstringoptional
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_idstringrequired
ID of the associated entity program.
client_user_idstringoptional
A unique ID that identifies the end user in your system. Either a `user_id` or the `client_user_id` must be provided. 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`.
statusstringoptional
A status enum indicating whether a screening is still pending review, has been rejected, or has been cleared.
Allowed:rejectedpending_reviewcleared
assigneestringoptional
ID of the associated user. To retrieve the email address or other details of the person corresponding to this ID, use `/dashboard_user/get`.
cursorstringoptional
An identifier that determines which page of results you receive.

1 status code
200Returns a page of entity screenings, a `next_cursor` for pagination, and a request identifier.
entity_watchlist_screeningsarray<EntityWatchlistScreening>required
List of entity watchlist screening
next_cursorstringrequired
An identifier that determines which page of results you receive.
request_idstringrequired
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Error handling

entity_watchlist_program_id is required and must identify the associated entity program. If supplied, status must be one of rejected, pending_review, or cleared; use the returned next_cursor as cursor to retrieve another page.