AVIEL / Docs / API Reference

API Reference

All endpoints use HTTPS. Authentication via Authorization: Bearer <api_key>. Base URL: https://api.avieI.tech/v1.

Intercepts

POST /intercept/trigger Trigger a honeybot intercept for a customer session
JSON — Request body
{
  "customer_id": "cust_8f3a2d",       // required
  "channel": "sms",                  // sms | in_app | email
  "scam_type_hint": "investment",  // optional hint
  "session_context": {}             // optional metadata
}
GET /intercepts/{intercept_id} Retrieve status and details of a specific intercept
GET /intercepts List all intercepts — paginated, supports date range filters

Fingerprints

GET /fingerprints/{fingerprint_id} Retrieve a scammer fingerprint by ID
JSON — Response
{
  "id": "fp_9b4c1e...",
  "device_hash": "a8f3d2e1...",
  "phone_metadata": {
    "country_code": "GB",
    "carrier_type": "mobile",
    "voip_indicator": false
  },
  "behavior_cadence": "high_frequency_AM",
  "scam_type": "investment_impersonation",
  "first_seen": "2025-09-14T14:32:07Z",
  "intercept_count": 3,
  "confidence": "high"
}
GET /fingerprints List fingerprints — supports filter by scam type, date, confidence

Webhooks

POST /webhooks/register Register a webhook endpoint for event delivery
GET /webhooks List all registered webhook endpoints

Events

GET /events Retrieve event log — paginated, filter by type and date

Error codes

  • 400 — Invalid request body or missing required fields
  • 401 — Invalid or missing API key
  • 404 — Resource not found
  • 429 — Rate limit exceeded — see X-RateLimit-Reset
  • 500 — AVIEL internal error — we log and investigate automatically