Sample - Plaid API
POST/watchlist_screening/individual/review/create

Create an individual screening review

Creates a compliance review for an individual watchlist screening. Supply watchlist_screening_id, and classify reviewed hits through confirmed_hits and dismissed_hits; add comment to record the reviewer's explanation.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

6 body fields

A compliance review containing hit classifications, an optional comment, the screening identifier, and authentication credentials.

confirmed_hitsarray<WatchlistScreeningHitID>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_hitsarray<WatchlistScreeningHitID>required
Hits to mark as a false positive after thorough manual review. These hits will never recur or be updated once dismissed.
commentstringoptional
A comment submitted by a team member as part of reviewing a watchlist screening.
client_idstringoptional
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.
secretstringoptional
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_idstringrequired
ID of the associated screening.

1 status code
200Returns the created review, including its identifier, confirmed and dismissed hits, comment, audit trail, and request identifier.
idstringrequired
ID of the associated review.
confirmed_hitsarray<WatchlistScreeningHitID>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_hitsarray<WatchlistScreeningHitID>required
Hits marked as a false positive after thorough manual review. These hits will never recur or be updated once dismissed.
commentstringrequired
A comment submitted by a team member as part of reviewing a watchlist screening.
audit_trailobjectrequired
Information about the last change made to the parent object specifying what caused the change as well as when it occurred.
request_idstringrequired
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Error handling

confirmed_hits, dismissed_hits, and watchlist_screening_id are required, and each hit identifier must refer to a hit associated with the screening. Confirmed hits are treated as true positives and dismissed hits as false positives; review these classifications carefully because they will not recur or be updated.