Sample - Plaid API
POST/watchlist_screening/entity/create

Create an entity watchlist screening

Creates a watchlist screening for an entity. Supply search_terms with the associated program and the organization's legal_name, and include any additional identifiers that improve matching. If ongoing screening is enabled for the program, the submitted profile is used for future monitoring.

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

4 body fields

Input for creating an entity watchlist screening.

search_termsobjectrequired
Search inputs for creating an entity watchlist screening
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.

1 status code
200Returns the created entity screening, including its identifier, search terms, status, assignee, 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

search_terms is required and must include entity_watchlist_program_id and legal_name. legal_name must contain at least one alphabetical character, be no longer than 100 characters, and have no leading or trailing spaces. When supplied, email_address must be a valid RFC-compliant email, country must be an ISO 3166-1 alpha-2 code, phone_number must use E.164 format, and url must begin with http or https.