Sample - Plaid API
POST/watchlist_screening/entity/get

Get an entity watchlist screening

Retrieves an entity watchlist screening by its identifier. Provide entity_watchlist_screening_id to retrieve the screening and its current review state. The response includes the screening profile, status, audit information, and request identifier.

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

3 body fields

Input for fetching an entity watchlist screening.

entity_watchlist_screening_idstringrequired
ID of the associated entity 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 entity screening, including its identifier, search terms, status, assignee, client user identifier, audit trail, and request identifier.
idstringrequired
ID of the associated entity screening.
search_termsobjectrequired
Search terms associated with an entity used for searching against watchlists
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

entity_watchlist_screening_id is required and must identify the entity screening to retrieve.