Sample - Plaid API
POST/watchlist_screening/entity/program/get

Get an entity watchlist screening program

Retrieves an entity watchlist screening program. Provide entity_watchlist_program_id to retrieve the program's configuration for active lists, name matching, rescanning, and archival state. The response describes whether the program can perform ongoing screening.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

3 body fields

Input for fetching an entity watchlist program.

entity_watchlist_program_idstringrequired
ID of the associated entity program.
secretstringoptional
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_idstringoptional
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.

1 status code
200Returns the program configuration, including its identifier, creation time, enabled watchlists, name sensitivity, rescanning and archival flags, audit trail, and request identifier.
idstringrequired
ID of the associated entity program.
created_atstringrequired
An ISO8601 formatted timestamp.
is_rescanning_enabledbooleanrequired
Indicator specifying whether the program is enabled and will perform daily rescans.
lists_enabledarray<EntityWatchlistCode>required
Watchlists enabled for the associated program
namestringrequired
A name for the entity program to define its purpose. For example, "High Risk Organizations" or "Applicants".
name_sensitivitystringrequired
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.
Allowed:coarsebalancedstrictexact
audit_trailobjectrequired
Information about the last change made to the parent object specifying what caused the change as well as when it occurred.
is_archivedbooleanrequired
Archived programs are read-only and cannot screen new customers nor participate in ongoing monitoring.
request_idstringrequired
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Error handling

entity_watchlist_program_id is required and must identify the entity watchlist program to retrieve.