Create a review for an individual watchlist screening

POST /watchlist_screening/individual/review/create

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.

Request Body

Required

Request input for creating a screening review

Parameters

confirmed_hits
required, array[string]
Hits to mark as a true positive after thorough manual review. These hits will never recur or be updated once dismissed. In most cases, confirmed hits indicate that the customer should be rejected.
dismissed_hits
required, array[string]
Hits to mark as a false positive after thorough manual review. These hits will never recur or be updated once dismissed.
comment
string
A comment submitted by a team member as part of reviewing a watchlist screening.
client_id
string
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.
secret
string
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_id
required, string
ID of the associated screening.

Response

A review submitted by a team member for an individual watchlist screening. A review can be either a comment on the current screening state, actions taken against hits attached to the watchlist screening, or both.

Response Properties

id
required, string
ID of the associated review.
confirmed_hits
required, array[string]
Hits marked as a true positive after thorough manual review. These hits will never recur or be updated once dismissed. In most cases, confirmed hits indicate that the customer should be rejected.
dismissed_hits
required, array[string]
Hits marked as a false positive after thorough manual review. These hits will never recur or be updated once dismissed.
comment
required, string
A comment submitted by a team member as part of reviewing a watchlist screening.
audit_trail
required, object
Information about the last change made to the parent object specifying what caused the change as well as when it occurred.
source
required, string
A type indicating whether a dashboard user, an API-based user, or Plaid last touched this object.
dashboard_user_id
required, string
ID of the associated user. To retrieve the email address or other details of the person corresponding to this id, use /dashboard_user/get.
timestamp
required, string
An ISO8601 formatted timestamp.
request_id
required, string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.