Documentation · API

REST API Reference.

Base URL: https://api.caraaye.com/v1

Enterprise plan required · Bearer token authentication
Endpoints

Available Endpoints.

GET/v1/employees

List all provisioned employees and their circle assignments, verification status, and Trust Score.

POST/v1/employees

Provision a new employee. Triggers SMS/email onboarding flow automatically.

GET/v1/circles

List all active circles with current membership, route corridor, and shift window.

GET/v1/completions

Retrieve GPS-verified route completion records, filterable by date range, circle, and employee.

GET/v1/esg/summary

Retrieve aggregate ESG metrics: total CO₂ saved, modal shift percentage, and vehicle reduction count.

GET/v1/esg/report

Generate a dated ESG report export in JSON or PDF. Used for board submissions and CSR reporting.

POST/v1/subsidies/load

Pre-load employer transport subsidies into employee wallets. Consumed per verified ride.

GET/v1/trust-scores/{employeeId}

Retrieve a specific employee's Trust Score breakdown: verification components, attendance, and peer endorsements.

Example Request
curl -X GET https://api.caraaye.com/v1/completions \
  -H "Authorization: Bearer {API_KEY}" \
  -H "Content-Type: application/json" \
  -G \
  --data-urlencode "from=2025-06-01" \
  --data-urlencode "to=2025-06-30" \
  --data-urlencode "circle_id=crc_abc123"
Response 200
{
  "data": [
    {
      "id": "cmp_x9g2f",
      "employee_id": "emp_1234",
      "circle_id": "crc_abc123",
      "date": "2025-06-14",
      "direction": "morning",
      "verified": true,
      "distance_km": 12.4,
      "cost_share_pkr": 48.50
    }
  ],
  "meta": { "total": 1, "page": 1 }
}
Request API Access