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

List hits for an individual watchlist screening

Lists watchlist hits found for a particular individual screening. Supply watchlist_screening_id and use cursor with the returned next_cursor to paginate through the hits.

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

4 body fields

The screening identifier, optional pagination cursor, and authentication credentials for listing watchlist hits.

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

1 status code
200Returns a page of watchlist hits in `watchlist_screening_hits`, along with `next_cursor` and a request identifier.
watchlist_screening_hitsarray<WatchlistScreeningHit>required
List of individual 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

watchlist_screening_id must identify the screening whose hits you want to list. Pass the returned next_cursor value as cursor for the next page, and provide authentication credentials in the body or their corresponding headers.