plaid

Create a watchlist screening for an entity

Changed on

Create a new entity watchlist screening to check your customer against watchlists defined in the associated entity watchlist program. If your associated program has ongoing screening enabled, this is the profile information that will be used to monitor your customer over time.

post/watchlist_screening/entity/create

Request

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

Request body

client_user_idstring

A unique ID that identifies the end user in your system. Either a user_id or the client_user_id must be provided. 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.

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.

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.

Example request

{
  "search_terms": {
    "entity_watchlist_program_id": "entprg_2eRPsDnL66rZ7H",
    "legal_name": "Al-Qaida",
    "document_number": "C31195855",
    "email_address": "user@example.com",
    "country": "US",
    "phone_number": "+14025671234",
    "url": "https://example.com"
  },
  "client_user_id": "your-db-id-3b24110"
}

Response

OK

idstring required

ID of the associated entity screening.

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

status'rejected' | 'pending_review' | 'cleared' required

A status enum indicating whether a screening is still pending review, has been rejected, or has been cleared.

client_user_idstring nullable required

A unique ID that identifies the end user in your system. Either a user_id or the client_user_id must be provided. 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.

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": "entscr_52xR9LKo77r1Np",
  "search_terms": {
    "entity_watchlist_program_id": "entprg_2eRPsDnL66rZ7H",
    "legal_name": "Al-Qaida",
    "document_number": "C31195855",
    "email_address": "user@example.com",
    "country": "US",
    "phone_number": "+14025671234",
    "url": "https://example.com",
    "version": 1
  },
  "assignee": "54350110fedcbaf01234ffee",
  "status": "cleared",
  "client_user_id": "your-db-id-3b24110",
  "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

  • be701ec93161Revision changes
    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the / response property's minLength was decreased from 2 to 0 for the response status

    • breaking

      the / response property's minLength was decreased from 4 to 0 for the response status

    • breaking

      the / response property's minLength was decreased from 1 to 0 for the response status

    • info

      the request property's minLength was decreased from 1 to 0

    • info

      the / request property's minLength was decreased from 2 to 0

    • info

      the / request property's minLength was decreased from 4 to 0

    • info

      the / request property's minLength was decreased from 1 to 0