plaid

Create a review for an individual watchlist screening

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

post/watchlist_screening/individual/review/create

Request body

confirmed_hitsWatchlistScreeningHitID[] 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_hitsWatchlistScreeningHitID[] 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.

watchlist_screening_idstring required

ID of the associated screening.

Example request

{
  "confirmed_hits": [
    "scrhit_52xR9LKo77r1Np"
  ],
  "dismissed_hits": [
    "scrhit_52xR9LKo77r1Np"
  ],
  "comment": "These look like legitimate matches, rejecting the customer.",
  "watchlist_screening_id": "scr_52xR9LKo77r1Np"
}

Response

idstring required

ID of the associated review.

confirmed_hitsWatchlistScreeningHitID[] 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_hitsWatchlistScreeningHitID[] 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": "rev_aCLNRxK3UVzn2r",
  "confirmed_hits": [
    "scrhit_52xR9LKo77r1Np"
  ],
  "dismissed_hits": [
    "scrhit_52xR9LKo77r1Np"
  ],
  "comment": "These look like legitimate matches, rejecting the customer.",
  "audit_trail": {
    "dashboard_user_id": "54350110fedcbaf01234ffee",
    "timestamp": "2020-07-24T03:26:02Z"
  }
}

Changes

Changed in 3 of the 52 revisions of this API.211

Jul 22, 2026a1bbca0181601See the full diff
- ●
  added the new retro enum value to the audit_trail/source response property for the response status 200
  response-property-enum-value-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 18, 2024be701ec9316111See the full diff
- ▲
  the comment response property's minLength was decreased from 1 to 0 for the response status 200
  response-property-min-length-decreased
- ○
  the comment request property's minLength was decreased from 1 to 0
  request-property-min-length-decreased
Feb 21, 20245de70cc1e6ca1See the full diff
- ▲
  the comment request property's minLength was increased from 0 to 1
  request-property-min-length-increased
This revision also has 699 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history