Alerts
Create alert
Create a new alert by flagging an entity.
POST
Create a new alert programmatically. This lets you trigger, manage, and integrate alerts directly into your application logic.
Request structure
string
required
Unique identifier of the entity to flag. Must be a valid balance, transaction, or identity ID.
string
Optional. A brief title for the alert.
string
required
Required. A detailed description of the alert.
Response structure
string
required
Unique identifier for the alert.
string
The title of the alert, if provided.
string
required
The description of the alert.
string
required
The type or category of the alert (e.g., “Balance”, “Transaction”, “Identity”).
string
The name or identifier of the user assigned to handle the alert.
array
Array of user identifiers to whom the alert has been escalated.
string
required
The current status of the alert (e.g., “FLAGGED”).
timestamp
required
ISO 8601 formatted timestamp of when the alert was created.
timestamp
required
ISO 8601 formatted timestamp of when the alert was last updated.
array
required
Array of balance IDs affected by this alert.
array
required
Array of identity IDs affected by this alert.
array
required
Array of transaction IDs affected by this alert.