List entity watchlist screenings
POST /watchlist_screening/entity/list
List all entity screenings.
Request Body
Required
Request input for listing entity watchlist screenings
Parameters
secret
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_id
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.
entity_watchlist_program_id
ID of the associated entity program.
client_user_id
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.
status
A status enum indicating whether a screening is still pending review, has been rejected, or has been cleared.
assignee
ID of the associated user. To retrieve the email address or other details of the person corresponding to this id, use
/dashboard_user/get.
cursor
An identifier that determines which page of results you receive.
Response
Paginated list of entity watchlist screenings
Response Properties
entity_watchlist_screenings
List of entity watchlist screening
id
ID of the associated entity screening.
search_terms
Search terms associated with an entity used for searching against watchlists
entity_watchlist_program_id
ID of the associated entity program.
legal_name
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.
document_number
The numeric or alphanumeric identifier associated with this document. Must be between 4 and 32 characters long, and cannot have leading or trailing spaces.
email_address
A valid email address. Must not have leading or trailing spaces and address must be RFC compliant. For more information, see RFC 3696.
country
Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.
phone_number
A phone number in E.164 format.
url
An ‘http’ or ‘https’ URL (must begin with either of those).
version
The current version of the search terms. Starts at
1 and increments with each edit to search_terms.
assignee
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
A status enum indicating whether a screening is still pending review, has been rejected, or has been cleared.
client_user_id
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
Information about the last change made to the parent object specifying what caused the change as well as when it occurred.
source
A type indicating whether a dashboard user, an API-based user, or Plaid last touched this object.
dashboard_user_id
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
An ISO8601 formatted timestamp.
next_cursor
An identifier that determines which page of results you receive.
request_id
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.