Get entity watchlist screening program

POST /watchlist_screening/entity/program/get

Get an entity watchlist screening program

Request Body

Required

Request input for fetching an entity watchlist program

Parameters

entity_watchlist_program_id
required, string
ID of the associated entity program.
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.
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.

Response

A program that configures the active lists, search parameters, and other behavior for initial and ongoing screening of entities.

Response Properties

id
required, string
ID of the associated entity program.
created_at
required, string
An ISO8601 formatted timestamp.
is_rescanning_enabled
required, boolean
Indicator specifying whether the program is enabled and will perform daily rescans.
lists_enabled
required, array[string]
Watchlists enabled for the associated program
name
required, string
A name for the entity program to define its purpose. For example, “High Risk Organizations” or “Applicants”.
name_sensitivity
required, string
The valid name matching sensitivity configurations for a screening program. Note that while certain matching techniques may be more prevalent on less strict settings, all matching algorithms are enabled for every sensitivity. coarse - See more potential matches. This sensitivity will see more broad phonetic matches across alphabets that make missing a potential hit very unlikely. This setting is noisier and will require more manual review. balanced - A good default for most companies. This sensitivity is balanced to show high quality hits with reduced noise. strict - Aggressive false positive reduction. This sensitivity will require names to be more similar than coarse and balanced settings, relying less on phonetics, while still accounting for character transpositions, missing tokens, and other common permutations. exact - Matches must be nearly exact. This sensitivity will only show hits with exact or nearly exact name matches with only basic correction such as extraneous symbols and capitalization. This setting is generally not recommended unless you have a very specific use case.
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.
is_archived
required, boolean
Archived programs are read-only and cannot screen new customers nor participate in ongoing monitoring.
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.