plaid

Create a review for an entity watchlist screening

Changed on

Create a review for an entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.

post/watchlist_screening/entity/review/create

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/watchlist_screening/entity/review/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

confirmed_hitsEntityWatchlistScreeningHitID[] required

Hits to mark as a true positive after thorough manual review. These hits will never recur or be updated once confirmed. In most cases, confirmed hits indicate that the customer should be rejected.

dismissed_hitsEntityWatchlistScreeningHitID[] required

Hits to mark as a false positive after thorough manual review. These hits will never recur or be updated once dismissed.

commentstring nullable

A comment submitted by a team member as part of reviewing a watchlist screening.

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.

entity_watchlist_screening_idstring required

ID of the associated entity screening.

Example request

{
  "confirmed_hits": [
    "enthit_52xR9LKo77r1Np"
  ],
  "dismissed_hits": [
    "enthit_52xR9LKo77r1Np"
  ],
  "comment": "These look like legitimate matches, rejecting the customer.",
  "entity_watchlist_screening_id": "entscr_52xR9LKo77r1Np"
}

Response

OK

idstring required

ID of the associated entity review.

confirmed_hitsEntityWatchlistScreeningHitID[] required

Hits marked as a true positive after thorough manual review. These hits will never recur or be updated once confirmed. In most cases, confirmed hits indicate that the customer should be rejected.

dismissed_hitsEntityWatchlistScreeningHitID[] required

Hits marked as a false positive after thorough manual review. These hits will never recur or be updated once dismissed.

commentstring nullable required

A comment submitted by a team member as part of reviewing a watchlist screening.

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": "entrev_aCLNRxK3UVzn2r",
  "confirmed_hits": [
    "enthit_52xR9LKo77r1Np"
  ],
  "dismissed_hits": [
    "enthit_52xR9LKo77r1Np"
  ],
  "comment": "These look like legitimate matches, rejecting the customer.",
  "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

    • info

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