Skip to main content
PATCH
/
entities
/
{entityId}
/
alerts
Resolve a set of alerts for a specific entity
curl --request PATCH \
  --url https://api.frankiefinancial.io/transaction/v2/entities/{entityId}/alerts \
  --header 'Content-Type: application/json' \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'apiKey: <api-key>' \
  --data '
{
  "update": {
    "createdBy": "[email protected]",
    "comment": "Alert has been manually reviewed to be a false positive",
    "newStatus": "PENDING",
    "assignedTo": "[email protected]"
  },
  "filter": {
    "alertIds": [
      "db30f17e-5e79-4185-b7d5-6dfc06478055"
    ],
    "resultTypes": [
      "AML",
      "FRAUD"
    ],
    "isActive": true
  }
}
'
{
  "total": 123,
  "successful": {
    "count": 123
  },
  "failed": {
    "count": 123
  }
}

Authorizations

apiKey
string
header
required

API key issued by FrankieOne. This will rotate regularly.

Headers

X-Frankie-CustomerID
string
required

Your Customer ID provided by FrankieOne

Example:

"12345678-1234-1234-1234-123456789012"

X-Frankie-CustomerChildID
string

Your Customer Child ID provided by FrankieOne

Example:

"87654321-4321-4321-4321-210987654321"

X-Frankie-Background
enum<integer>

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.

Available options:
0,
1

Path Parameters

entityId
string
required

Unique identifier of a FrankieOne entity The unique identifier for a FrankieOne entity construct

Example:

"98ded7ac-2457-4bde-b27c-fcee05301262"

Body

application/json
update
object

Describes an update to an alert, this can be used to update status, assignment of the alert.

filter
object

Response

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

total
integer
required

Total of number of items that were found to be actioned by bulk update request

successful
object
required

Represents the result of a bulk update action

failed
object
required

Represents the result of a bulk update action