POST /watchlist_screening/entity/review/create
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.
Servers
- https://production.plaid.com
- https://sandbox.plaid.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
entity_watchlist_screening_id |
String | Yes |
ID of the associated entity screening. |
comment |
String | No |
A comment submitted by a team member as part of reviewing a watchlist screening. |
confirmed_hits[] |
Array | Yes |
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. |
client_id |
String | No |
Your Plaid API |
dismissed_hits[] |
Array | Yes |
Hits to mark as a false positive after thorough manual review. These hits will never recur or be updated once dismissed. |
secret |
String | No |
Your Plaid API |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.