Sample - Plaid API
POST/watchlist_screening/individual/get

Retrieve an individual watchlist screening

Retrieves a previously created individual watchlist screening. Supply watchlist_screening_id to identify the screening, and provide authentication credentials in the body or their corresponding headers.

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

3 body fields

Identifiers and authentication credentials for retrieving an individual watchlist screening.

watchlist_screening_idstringrequired
ID of the associated 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.

1 status code
200Returns the individual screening, including its search terms, status, assignment, audit trail, client user identifier, and request identifier.
idstringrequired
ID of the associated screening.
search_termsobjectrequired
Search terms for creating an individual watchlist screening
assigneestringrequired
ID of the associated user. To retrieve the email address or other details of the person corresponding to this ID, use `/dashboard_user/get`.
statusstringrequired
A status enum indicating whether a screening is still pending review, has been rejected, or has been cleared.
Allowed:rejectedpending_reviewcleared
client_user_idstringrequired
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`.
audit_trailobjectrequired
Information about the last change made to the parent object specifying what caused the change as well as when it occurred.
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 to retrieve. Provide client_id and secret in the request body or through the PLAID-CLIENT-ID and PLAID-SECRET headers.