Fraud & AML API EndpointsAlerts

Resolve a set of alerts for a specific entity

Request that alerts for an entity are all updated with the same information as provided in the request. You can use this operation to resolve a set of alerts for an entity.

Path parameters

entityIdstringRequired
Unique identifier of a FrankieOne entity

Headers

apiKeystringRequired
X-Frankie-CustomerIDstringRequired
Your Customer ID provided by FrankieOne
X-Frankie-CustomerChildIDstringOptional
Your Customer Child ID provided by FrankieOne
X-Frankie-BackgroundenumOptional
If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if there are no obvious errors in the input. The request will then run in the background and send a notification back to the customer. See our callback API for details on this.
Allowed values:

Request

This endpoint expects an object.
updateobjectOptional
Describes an update to an alert, this can be used to update status, assignment of the alert.
filterobjectOptional

Response

Response from the PATCH /entity/{entityId}/alerts endpoint

totalinteger
Total of number of items that were found to be actioned by bulk update request
successfulobject
Represents the result of a bulk update action
failedobject
Represents the result of a bulk update action

Errors