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

Create an entity screening review

Creates a compliance review for an entity watchlist screening. Provide entity_watchlist_screening_id and classify manually reviewed hits through confirmed_hits and dismissed_hits; optionally add a comment. Confirmed or dismissed hits do not recur or receive further updates.

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

6 body fields

Input for creating a review of an entity watchlist screening.

confirmed_hitsarray<EntityWatchlistScreeningHitID>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<EntityWatchlistScreeningHitID>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.
entity_watchlist_screening_idstringrequired
ID of the associated entity screening.

1 status code
200Returns the created review, including its identifier, confirmed and dismissed hit identifiers, comment, audit trail, and request identifier.
idstringrequired
ID of the associated entity review.
confirmed_hitsarray<EntityWatchlistScreeningHitID>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<EntityWatchlistScreeningHitID>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 entity_watchlist_screening_id are required. Each hit identifier in confirmed_hits or dismissed_hits must identify an associated entity screening hit; confirmed hits represent true positives and dismissed hits represent false positives.