Sample - Plaid API
POST/watchlist_screening/entity/program/list

List entity watchlist screening programs

Lists entity watchlist screening programs. Use cursor to paginate through the available programs. Each program includes its enabled watchlists, matching sensitivity, rescanning setting, and archival state.

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

3 body fields

Input for listing entity watchlist screening programs.

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.
cursorstringoptional
An identifier that determines which page of results you receive.

1 status code
200Returns a page of entity watchlist programs, a `next_cursor` for pagination, and a request identifier.
entity_watchlist_programsarray<EntityWatchlistProgram>required
List of entity watchlist screening programs
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

Use the returned next_cursor as cursor to retrieve the next page when more programs are available. The request body contains no required filter fields.