patch https://api.sumsub.com/resources/amlCases//hits
Overview
Use this method to update the review status of specific AML hits from Watchlist checks. For example, you can mark a hit as a false positive, whitelist specific hits, attach notes to individual hits, and more.
You can obtain necessary data for the request from the Get AML case data.
Request example
curl -X PATCH \
'https://api.sumsub.com/resources/amlCases/67fcc2f55669f5f05c4e0eab/hits' \
-H 'accept: application/json' \
-H 'content-type: application/json' \
-d '{
"hitReviews": [
{
"hitId": "QT06...",
"matchStatus": "potential_match",
"whitelisted": true,
"note": "Actual personal information does not match exactly"
},
{
"hitId": "XW42...",
"matchStatus": "true_positive",
"whitelisted": false
}
]
}'
Response explained
If the request is successfully sent and processed, you will get a response like the one of those below. It contains the number of updated hit reviews.
Note
The
updatedcounter returns the number of hits actually updated. If no changes, the value will be0.
// In this example, two hits have been updated.
{
"updated": 2
}
// No changes occurred.
{
"updated": 0
}
If the request fails, you will receive an HTTP response containing an error code along with a message explaining the error. For example:
{
"code": 400,
"correlationId": "07f789881eaf8c0bd05ce30903845f07",
"errorCode": 0,
"description": "Invalid id 'XXXXXXXXXX'"
}