Sample - Plaid API
POST/watchlist_screening/individual/create

Create an individual watchlist screening

Creates a watchlist screening for an individual customer. Supply search_terms.watchlist_program_id and search_terms.legal_name, and include optional identity details such as date_of_birth, document_number, and country when available.

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

4 body fields

Individual watchlist screening details, including the associated program and the person's identifying information.

search_termsobjectrequired
Search inputs for creating a 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 individual screening with its identifier, 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

search_terms must include 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. date_of_birth must use YYYY-MM-DD format, and document_number must contain 4 to 32 characters without leading or trailing spaces.