curl -X POST "https://demo.api.vultlocal.com/api/v1/compliance/alerts" \
-H "Authorization: Bearer olive_live_xxx" \
-H "Content-Type: application/json" \
-d '{
"subscriber_id": "sub_abc123",
"alert_type": "SUSPICIOUS_BEHAVIOR",
"details": "User attempted multiple PIN guesses at agent location"
}'
{
"success": true,
"message": "Alert created",
"alert_id": 101
}
Compliance
Create Alert
Manually raise a compliance alert
POST
/
compliance
/
alerts
curl -X POST "https://demo.api.vultlocal.com/api/v1/compliance/alerts" \
-H "Authorization: Bearer olive_live_xxx" \
-H "Content-Type: application/json" \
-d '{
"subscriber_id": "sub_abc123",
"alert_type": "SUSPICIOUS_BEHAVIOR",
"details": "User attempted multiple PIN guesses at agent location"
}'
{
"success": true,
"message": "Alert created",
"alert_id": 101
}
Manual alert creation for suspicious activity observed by agents or support staff.
Request
string
required
Bearer olive_live_xxxBody Parameters
string
required
Subscriber UUID involved
string
required
e.g.,
SUSPICIOUS_BEHAVIOR, AGENT_REPORTstring
required
Description of the incident
integer
Optional ID of rule violated
Response
boolean
Creation status
integer
ID of created alert
Examples
curl -X POST "https://demo.api.vultlocal.com/api/v1/compliance/alerts" \
-H "Authorization: Bearer olive_live_xxx" \
-H "Content-Type: application/json" \
-d '{
"subscriber_id": "sub_abc123",
"alert_type": "SUSPICIOUS_BEHAVIOR",
"details": "User attempted multiple PIN guesses at agent location"
}'
{
"success": true,
"message": "Alert created",
"alert_id": 101
}
Authorizations
API Key for third-party integrations (WhatsApp, Smart PAY, VULT). Format: 'Bearer olive_live_xxxxxxxxxxxxx'
Body
application/json
Alert details
Response
Created
The response is of type object.
⌘I