POST /watchlist_screening/entity/update

Update an entity watchlist screening.

Servers

https://production.plaid.com
https://sandbox.plaid.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`entity_watchlist_screening_id`	String	Yes	ID of the associated entity screening.
`assignee`	String	No	ID of the associated user. To retrieve the email address or other details of the person corresponding to this id, use `/dashboard_user/get`.
`search_terms`	Object	No	Search terms for editing an entity watchlist screening
`search_terms.email_address`	String	No	A valid email address. Must not have leading or trailing spaces and address must be RFC compliant. For more information, see RFC 3696.
`search_terms.url`	String	No	An 'http' or 'https' URL (must begin with either of those).
`search_terms.entity_watchlist_program_id`	String	Yes	ID of the associated entity program.
`search_terms.legal_name`	String	No	The name of the organization being screened. Must have at least one alphabetical character, have a maximum length of 100 characters, and not include leading or trailing spaces.
`search_terms.document_number`	String	No	The numeric or alphanumeric identifier associated with this document. Must be between 4 and 32 characters long, and cannot have leading or trailing spaces.
`search_terms.country`	String	No	Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.
`search_terms.phone_number`	String	No	A phone number in E.164 format.
`client_id`	String	No	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.
`status`	String	No	A status enum indicating whether a screening is still pending review, has been rejected, or has been cleared. Possible values: `"pending_review"` `"cleared"` `"rejected"`
`client_user_id`	String	No	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`.
`secret`	String	No	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	No	A list of fields to reset back to null

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.