Sample - Plaid API
POST/watchlist_screening/entity/update

Update an entity watchlist screening

Updates an entity watchlist screening and its associated search terms. Supply entity_watchlist_screening_id and the required search_terms.entity_watchlist_program_id; use reset_fields to clear supported fields such as assignee.

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

8 body fields

Entity screening fields to update, including search terms, assignment, status, and reset instructions.

entity_watchlist_screening_idstringrequired
ID of the associated entity screening.
search_termsobjectoptional
Search terms for editing an entity watchlist screening
assigneestringoptional
ID of the associated user. To retrieve the email address or other details of the person corresponding to this ID, use `/dashboard_user/get`.
statusstringoptional
A status enum indicating whether a screening is still pending review, has been rejected, or has been cleared.
Allowed:rejectedpending_reviewcleared
client_user_idstringoptional
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`.
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.
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.
reset_fieldsarray<string>optional
A list of fields to reset back to null

1 status code
200Returns the updated entity screening, including its search terms, status, assignment, audit trail, client user identifier, 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 and search_terms.entity_watchlist_program_id are required. status must be rejected, pending_review, or cleared when provided, and values such as email_address, url, country, and phone_number must use their specified formats. reset_fields accepts only assignee.