BizAgent API Documentation

Structured user session data tracking for enhanced security and analytics

Example API Request

BizAgent API receives structured user session data from your frontend or backend. Here's how a sample request looks:

POST /api/session/create
Headers:
  X-API-KEY: YOUR_API_KEY
  X-Session-Id: SESSION_ID_HERE
{
  "user_Id": "465456465",
  "name": "username",
  "email": "example@gmail.com",
  "ip_Address": "202.125.30.60",
  "device": {
    "fingerprint": "fhiuhu7346385641646retertre5rvhroiv64156417rfuhi1564851ehuihvn",
    "browser": "chrome",
    "device_Type": "desktop",
    "os": "windows",
    "language": "en",
    "screen_Resolution": "1920*1280"
  },
  "localTime": "2025-07-29T11:57:57.484Z"
}

Data Captured

Comprehensive session data fields and their descriptions

FieldDescription
user_Id
Unique user identifier from your system
username
User's name
email
User's email address
ip_Address
User's public IP address
device.fingerprint
Unique device/browser fingerprint
device.browser
Browser name (e.g., Chrome)
device.os
Operating system (e.g., Windows)
device_Type
Device type (desktop, mobile)
screen_Resolution
User's screen resolution
language
Browser language
localTime
Client's local timestamp (ISO 8601)

This data helps you:

  • Detect suspicious logins
  • Track session behavior
  • Build secure analytics
  • Improve user experience with device-specific insights

Built for developers who care about security, clarity, and control.

Want full documentation or SDK?