POST /watchlist_screening/individual/list

List previously created watchlist screenings for individuals

Servers

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
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.

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.

watchlist_program_id String Yes

ID of the associated program.

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"
cursor String No

An identifier that determines which page of results you receive.

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.

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.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.