Skip to content
Connect API Catalog/
/
/
Update A Single Individua...

Update A Single Individual Hit

Request

This endpoint will update a single individual AML search hit by searchId and hitId.

Security
bearerToken
Path
searchIdstring, (uuid)required

Id of the search

hitIdstring, (uuid)required

Id of the hit

Bodyapplication/json
decisionstring

The Decision of the Hit to be updated. The Decision can only be made once.
Allowed values are undecided,trueMatch and falsePositive

notestring

Note associated with the Hit

curl -i -X PUT \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "decision": "string",
    "note": "string"
  }'

Responses

Success

Bodyapplication/json
itemsobject
Response
{
  "items": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "hitScore": 0,
    "name": "string",
    "match": "string",
    "countries": [ … ],
    "datasets": [ … ],
    "decision": "string",
    "note": "string",
    "modifiedById": 0,
    "modifiedBy": "string",
    "modifiedAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "gender": "string",
    "datesOfBirth": [ … ],
    "pepTier": "string",
    "profileImages": "string",
    "supersededHit": { … }
  }
}