Creditsafe Connect API Documentation

Update A Single Business Hit

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

SecuritybearerToken

Request

path Parameters

searchId required	string Id of the search
hitId required	string

Request Body schema: application/json

decision	string The Decision of the Hit to be updated. The Decision can only be made once. Allowed values are undecided,trueMatch and falsePositive
note	string Note associated with the Hit

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

put/compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}

Request samples

application/json

{"decision": "string",
"note": "string"
}

Response samples

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"hitScore": 0,
"name": "string",
"match": "string",
"countries": ["string"
],
"datasets": ["string"
],
"decision": "string",
"note": "string",
"modifiedById": 0,
"modifiedBy": "string",
"modifiedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"supersededHit": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"hitScore": 0,
"name": { },
"match": { },
"countries": ["string"
],
"datasets": ["string"
],
"decision": "string",
"note": { },
"modifiedById": 0,
"modifiedBy": { },
"modifiedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}
}

➔ Next to Download AML Details for a Hit