provider plaid POST /watchlist_screening/entity/list
@utdk/plaid /watchlist_screening/entity/list
List entity watchlist screenings
List all entity screenings.

Try it

Authentication
Configure credentials for The Plaid API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

watchlistscreeningentitylist
POST/watchlist_screening/entity/list
List all entity screenings.

Input

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.

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.

required

ID of the associated entity program.

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

A status enum indicating whether a screening is still pending review, has been rejected, or has been cleared.

ID of the associated user. To retrieve the email address or other details of the person corresponding to this id, use `/dashboard_user/get`.

An identifier that determines which page of results you receive.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import plaid from '@utdk/plaid';

await plaid.watchlistscreeningentitylist()