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

List entity screening hits

Lists watchlist hits for an entity screening. Provide entity_watchlist_screening_id to identify the screening, and use cursor to paginate through the hits. Each returned hit contains watchlist source information and review-related data.

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

4 body fields

Input for listing hits for an entity watchlist screening.

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_screening_idstringrequired
ID of the associated entity screening.
cursorstringoptional
An identifier that determines which page of results you receive.

1 status code
200Returns a page of entity screening hits, including hit identifiers, review status, list and source identifiers, sub-programs, analysis data, a `next_cursor`, and a request identifier.
entity_watchlist_screening_hitsarray<EntityWatchlistScreeningHit>required
List of entity watchlist screening hits
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_screening_id is required and must identify the entity screening whose hits you want to list. Use the returned next_cursor as cursor to retrieve another page of hits.