plaid

Get entity watchlist screening program

Changed on

Get an entity watchlist screening program

post/watchlist_screening/entity/program/get

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/watchlist_screening/entity/program/get
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

Request body

entity_watchlist_program_idstring required

ID of the associated entity program.

secretstring

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_idstring

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.

Example request

{
  "entity_watchlist_program_id": "entprg_2eRPsDnL66rZ7H"
}

Response

OK

idstring required

ID of the associated entity program.

created_atstring date-time required

An ISO8601 formatted timestamp.

is_rescanning_enabledboolean required

Indicator specifying whether the program is enabled and will perform daily rescans.

lists_enabledEntityWatchlistCode[] required

Watchlists enabled for the associated program

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

is_archivedboolean required

Archived programs are read-only and cannot screen new customers nor participate in ongoing monitoring.

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Example response

{
  "id": "entprg_2eRPsDnL66rZ7H",
  "created_at": "2020-07-24T03:26:02Z",
  "is_rescanning_enabled": true,
  "lists_enabled": [
    "EU_CON"
  ],
  "name": "Sample Program",
  "name_sensitivity": "balanced",
  "audit_trail": {
    "dashboard_user_id": "54350110fedcbaf01234ffee",
    "timestamp": "2020-07-24T03:26:02Z"
  }
}

Changes

  • a1bbca018160Revision changes
    • warning

      added the new retro enum value to the / response property for the response status

  • 09cbc8444913Revision changes
    • warning

      added the new US_SAM enum value to the / response property for the response status

    • warning

      added the new US_TEL enum value to the / response property for the response status