Skip to main content
POST
https://api.cloud.blnkfinance.com
/
alerts
/
flag
/
{id}
curl -X POST 'https://api.cloud.blnkfinance.com/alerts/flag/bal_1234567890abcdef' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "An identity has been flagged in a sanction list.",
    "description": "this is a test"
  }'

{
  "anomaly_id": "ano_8a380fd1-0289-46d1-bc76-aa17a510a64e",
  "title": "An identity has been flagged in a sanction list.",
  "description": "this is a test",
  "type": "Balance",
  "assigned_to": "jerrys enebeli",
  "escalated_to": [
    "user_01K4EX0BRXHNNGCRVT2TPNK07W"
  ],
  "status": "FLAGGED",
  "created_at": "2026-01-15T09:22:37.55763+01:00",
  "updated_at": "2026-01-15T09:26:03.094425+01:00",
  "affected_balances": [
    "bln_20f02af6-3728-4d37-9b5a-c7ed080f09df"
  ],
  "affected_identities": [],
  "affected_transactions": []
}
This feature is only available on the Pro plan.
Create a new alert programmatically. This lets you trigger, manage, and integrate alerts directly into your application logic. Common use cases include:
  • Error tracking: Trigger alerts when system or transaction errors occur.
  • Third-party monitoring: Alert on status changes from external services, payment processors, or APIs.
  • KYC workflows: Flag records that need additional verification or compliance review.
  • Balance thresholds: Alert when an account balance goes below or above a defined limit.
  • Anomaly detection: Flag unusual transaction patterns or unexpected spikes in activity.
  • Settlement delays: Alert when settlements or reconciliations do not complete on time.
  • Workflow exceptions: Flag records stuck in a pending, queued, or failed state.
  • Operational reviews: Mark transactions or accounts for manual review by ops teams.
  • Lifecycle events: Trigger alerts on key state changes like account activation, suspension, or closure.

​
Request structure

curl -X POST 'https://api.cloud.blnkfinance.com/alerts/flag/bal_1234567890abcdef' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "An identity has been flagged in a sanction list.",
    "description": "this is a test"
  }'
​
id
string
required
Unique identifier of the entity to flag. Must be a valid balance, transaction, or identity ID.
​
title
string
Optional. A brief title for the alert.
​
description
string
required
Required. A detailed description of the alert.

​
Response structure

{
  "anomaly_id": "ano_8a380fd1-0289-46d1-bc76-aa17a510a64e",
  "title": "An identity has been flagged in a sanction list.",
  "description": "this is a test",
  "type": "Balance",
  "assigned_to": "jerrys enebeli",
  "escalated_to": [
    "user_01K4EX0BRXHNNGCRVT2TPNK07W"
  ],
  "status": "FLAGGED",
  "created_at": "2026-01-15T09:22:37.55763+01:00",
  "updated_at": "2026-01-15T09:26:03.094425+01:00",
  "affected_balances": [
    "bln_20f02af6-3728-4d37-9b5a-c7ed080f09df"
  ],
  "affected_identities": [],
  "affected_transactions": []
}
​
anomaly_id
string
required
Unique identifier for the alert.
​
title
string
The title of the alert, if provided.
​
description
string
required
The description of the alert.
​
type
string
required
The type or category of the alert (e.g., “Balance”, “Transaction”, “Identity”).
​
assigned_to
string
The name or identifier of the user assigned to handle the alert.
​
escalated_to
array
Array of user identifiers to whom the alert has been escalated.
​
status
string
required
The current status of the alert (e.g., “FLAGGED”).
​
created_at
timestamp
required
ISO 8601 formatted timestamp of when the alert was created.
​
updated_at
timestamp
required
ISO 8601 formatted timestamp of when the alert was last updated.
​
affected_balances
array
required
Array of balance IDs affected by this alert.
​
affected_identities
array
required
Array of identity IDs affected by this alert.
​
affected_transactions
array
required
Array of transaction IDs affected by this alert.

​
Need help?

If you’re having trouble with Blnk Cloud, don’t hesitate to send us a message via email at [email protected] or send us a message here.