DEVELOPER REST API & SDK

VaaniX API Documentation

Integrate real-time acoustic voice biometrics, community threat radar, and forensic complaint packaging into banking, telecom, or custom mobile applications.

Authentication

All API requests must supply an API key in the standard Authorization header:

Authorization: Bearer vx_live_your_32_byte_secret_key

Keys can be created and managed in the logged-in app console under /app/api.

POST/api/v1/analyze

Rate: 120 req / min

Submit an 8–12 second audio sample with optional family member metadata. Returns acoustic model probability, transcript, extracted claims, and combined risk score.

Example Request (curl)

curl -X POST "https://vaanix.in/api/v1/analyze" \
  -H "Authorization: Bearer vx_live_7a8f9c0e2b1d4e" \
  -F "audio=@suspicious_call_10s.wav" \
  -F 'members=[{"id":"fam_01","name":"Rahul","relationship":"son"}]'

Example Response (200 OK)

{
  "voice": {
    "spoof_prob": 92.4,
    "real_prob": 7.6,
    "stub": false
  },
  "transcript": {
    "text": "Mummy accident ho gaya hai jaldi paise bhejo",
    "language": "hi",
    "segments": [
      { "start": 0.0, "end": 4.2, "text": "Mummy accident ho gaya hai jaldi paise bhejo" }
    ]
  },
  "text_analysis": {
    "groups": ["money", "accident", "urgency"],
    "matched_words": ["accident", "paise", "jaldi"],
    "text_score": 70,
    "claim": {
      "type": "family",
      "member_id": "fam_01",
      "label": "Rahul (Son)",
      "source": "transcript_relation"
    }
  },
  "risk_score": 86,
  "verdict": "AI_CLONE"
}

GET/api/v1/radar/lookup

Latency: < 300ms

Fast number reputation check designed for call screening and ringing pop-ups.

Example Request

curl -X GET "https://vaanix.in/api/v1/radar/lookup?number=%2B919876543210" \
  -H "Authorization: Bearer vx_live_7a8f9c0e2b1d4e"

Example Response

{
  "number_e164": "+919876543210",
  "level": "potential_scam",
  "reporters_24h": 4,
  "reporters_7d": 11,
  "primary_scam_type": "police_arrest_impersonation",
  "threshold_exceeded": true
}

Android Mobile SDK

Planned

The embeddable satyavoice-sdk library module allows banking, telecom, and fintech applications to implement Payment Guard UPI overlays and on-device audio sampling with zero background latency.