Update individual watchlist screening

POST /watchlist_screening/individual/update

Update a specific individual watchlist screening. This endpoint can be used to add additional customer information, correct outdated information, add a reference id, assign the individual to a reviewer, and update which program it is associated with. Please note that you may not update search_terms and status at the same time since editing search_terms may trigger an automatic status change.

Request Body

Required

Request input for editing an individual watchlist screening

Parameters

watchlist_screening_id
required, string
ID of the associated screening.
search_terms
object
Search terms for editing an individual watchlist screening
watchlist_program_id
string
ID of the associated program.
legal_name
string
The legal name of the individual being screened. Must have at least one alphabetical character, have a maximum length of 100 characters, and not include leading or trailing spaces.
date_of_birth
string
A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).
document_number
string
The numeric or alphanumeric identifier associated with this document. Must be between 4 and 32 characters long, and cannot have leading or trailing spaces.
country
string
Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.
assignee
string
ID of the associated user. To retrieve the email address or other details of the person corresponding to this id, use /dashboard_user/get.
status
string
A status enum indicating whether a screening is still pending review, has been rejected, or has been cleared.
client_user_id
string
A unique ID that identifies the end user in your system. 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_id
string
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.
secret
string
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_fields
array[string]
A list of fields to reset back to null

Response

The screening object allows you to represent a customer in your system, update their profile, and search for them on various watchlists. Note: Rejected customers will not receive new hits, regardless of program configuration.

Response Properties

id
required, string
ID of the associated screening.
search_terms
required, object
Search terms for creating an individual watchlist screening
watchlist_program_id
required, string
ID of the associated program.
legal_name
required, string
The legal name of the individual being screened. Must have at least one alphabetical character, have a maximum length of 100 characters, and not include leading or trailing spaces.
date_of_birth
required, string
A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).
document_number
required, string
The numeric or alphanumeric identifier associated with this document. Must be between 4 and 32 characters long, and cannot have leading or trailing spaces.
country
required, string
Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.
version
required, integer
The current version of the search terms. Starts at 1 and increments with each edit to search_terms.
assignee
required, string
ID of the associated user. To retrieve the email address or other details of the person corresponding to this id, use /dashboard_user/get.
status
required, string
A status enum indicating whether a screening is still pending review, has been rejected, or has been cleared.
client_user_id
required, string
A unique ID that identifies the end user in your system. 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_trail
required, object
Information about the last change made to the parent object specifying what caused the change as well as when it occurred.
source
required, string
A type indicating whether a dashboard user, an API-based user, or Plaid last touched this object.
dashboard_user_id
required, string
ID of the associated user. To retrieve the email address or other details of the person corresponding to this id, use /dashboard_user/get.
timestamp
required, string
An ISO8601 formatted timestamp.
request_id
required, string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.