---
title: "Get entity watchlist screening program"
method: POST
path: "/watchlist_screening/entity/program/get"
tags: ["plaid"]
---

# Get entity watchlist screening program

`POST /watchlist_screening/entity/program/get`

Get an entity watchlist screening program

## Request body

- WatchlistScreeningEntityProgramGetRequest — Request input for fetching an entity watchlist program
  - `entity_watchlist_program_id` string, required — 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 `200`

OK

- WatchlistScreeningEntityProgramGetResponse — A program that configures the active lists, search parameters, and other behavior for initial and ongoing screening of entities.
  - `id` string, required — ID of the associated entity program.
  - `created_at` string, date-time, required — An ISO8601 formatted timestamp.
  - `is_rescanning_enabled` boolean, required — Indicator specifying whether the program is enabled and will perform daily rescans.
  - `lists_enabled` EntityWatchlistCode[], required — Watchlists enabled for the associated program
  - `name` string, required — A name for the entity program to define its purpose. For example, "High Risk Organizations" or "Applicants".
  - `name_sensitivity` 'coarse' | 'balanced' | 'strict' | 'exact', required — 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` WatchlistScreeningAuditTrail, required — Information about the last change made to the parent object specifying what caused the change as well as when it occurred.
    - `source` 'dashboard' | 'link' | 'api' | 'system' | 'retro', required — A type indicating who or what last touched this object. `dashboard`, `link`, and `api` indicate the originating surface; `system` indicates Plaid. `retro` indicates a screening created retroactively via a bulk screening creation.
    - `dashboard_user_id` string, nullable, required — 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` string, date-time, required — An ISO8601 formatted timestamp.
  - `is_archived` boolean, required — Archived programs are read-only and cannot screen new customers nor participate in ongoing monitoring.
  - `request_id` string, required — A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

---

[API](https://skmtc.net/plaid/apis/the-plaid-api.md) · [All operations](https://skmtc.net/plaid/apis/the-plaid-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/plaid/the-plaid-api/versions/64c4514ea59b/schema)