Gig Platform & Aggregator Integration

Partner REST API Specification

This documentation is exclusively for platform aggregators (Zomato, Swiggy, Uber, Zepto, Blinkit, Porter, Urban Company) and fleet operators integrating rider earnings telemetry, automated Save-As-You-Earn (SAYE) deductions, and statutory welfare compliance.

Sandbox Environment

https://sandbox-api.gignivesh.com/partner/v1

Production Gateway

https://api.gignivesh.com/partner/v1

1. Partner Gateway Architecture

The GigNivesh Partner API operates as a secure bridge between your delivery dispatch system and SEBI-regulated custodian trusts. It allows platforms to:

Transmit trip completion events without modifying core payroll schedules.
Automatically deduct agreed micro-savings (e.g. ₹15/trip) and credit the rider's emergency corpus.
Comply with Karnataka Gig Workers Bill 2024 and Rajasthan Platform-Based Gig Workers Welfare Board without administrative overhead.

2. Authentication & Authorization

Partner integration requests require mutually authenticated credentials issued during platform onboarding:

POST /partner/v1/auth/token HTTP/1.1
Host: api.gignivesh.com
X-Partner-Id: ptr_swiggy_ind_0912
X-Partner-Secret: sec_live_99fa821bc08412e8...
Content-Type: application/json
        

Partner Endpoints Reference

POST /auth/token Client Credentials

Generates a short-lived Bearer JWT token (24-hour validity) for server-to-server API calls.

Request Payload:

{
  "partnerId": "ptr_zomato_fleet_001",
  "apiKey": "ak_live_8291048210491823",
  "scopes": ["telemetry.stream", "deductions.settle", "workers.verify"]
}
        

Response (HTTP 200 OK):

{
  "success": true,
  "data": {
    "accessToken": "gn_ptr_jwt_99182ab91283...",
    "tokenType": "Bearer",
    "expiresIn": 86400,
    "partnerName": "Zomato Logistics Fleet"
  }
}
        

POST /workers/verify Bearer Scoped

Verifies if an onboarded rider is registered with GigNivesh, active on Save-As-You-Earn (SAYE), and has active e-Shram UAN coverage.

Request:

{
  "partnerWorkerId": "SWIGGY_RIDER_99214",
  "mobileNumber": "+91 98765 43210",
  "operatingState": "Maharashtra",
  "city": "Mumbai"
}
        

Response:

{
  "success": true,
  "data": {
    "workerId": "usr_99214",
    "isEnrolledInSAYE": true,
    "activeRule": "fixed_per_trip",
    "microSaveAmount": 15.00,
    "eShramVerified": true,
    "eShramUAN": "••••••••4412",
    "welfareCoverActive": true
  }
}
        

POST /telemetry/trip-stream Bearer Scoped • Low Latency

Real-time delivery trip telemetry. Ingests completed order events and computes micro-deductions into the rider's emergency corpus.

Request:

{
  "partnerWorkerId": "SWIGGY_RIDER_99214",
  "orderId": "ORD_SW_20260915_9918",
  "tripFareEarned": 65.00,
  "surgeBonus": 15.00,
  "timestamp": "2026-09-15T15:30:00Z"
}
        

Response:

{
  "success": true,
  "data": {
    "acknowledgementId": "ACK_TEL_883192",
    "deductionApplied": 15.00,
    "riderNetPayout": 65.00,
    "creditedTo": {
      "emergencyLiquidFund": 4.50,
      "niftyIndexFund": 7.50,
      "digitalGold": 3.00
    },
    "currentEmergencyBalance": 18450.00
  }
}
        

POST /settlement/batch-reconcile Daily Settlement Escrow

Submits end-of-day batch settlement for all micro-deductions and platform welfare levies collected across the fleet.

Request:

{
  "batchDate": "2026-09-15",
  "totalTripsProcessed": 184250,
  "totalMicroSavingsDeducted": 2763750.00,
  "stateWelfareLevyFee": 184250.00,
  "settlementUTR": "HDFCN260915998124"
}
        

Response:

{
  "success": true,
  "data": {
    "settlementBatchId": "BAT_SET_20260915_01",
    "status": "RECONCILED",
    "escrowAuditHash": "sha256:7f83b1657ff1fc53b92dc18148a1d65dfc2d4b1fa3d677284addd200126d9069"
  }
}
        

POST /payouts/instant-advance Emergency Distress Buffer

Enables gig platforms to disburse instant emergency withdrawals from the rider's accumulated liquid corpus directly to their UPI ID.

Request:

{
  "partnerWorkerId": "SWIGGY_RIDER_99214",
  "requestedAmount": 2500.00,
  "disbursementReason": "BIKE_REPAIR_BREAKDOWN",
  "payoutUpiId": "raju.rider@okhdfcbank"
}
        

Response:

{
  "success": true,
  "data": {
    "payoutReference": "IMPS_ADV_99182310",
    "amountDisbursed": 2500.00,
    "feeCharged": 0.00,
    "transferStatus": "CREDITED_INSTANTLY",
    "remainingLiquidBuffer": 15950.00
  }
}
        

GET /compliance/welfare-report Statutory Audit Export

Returns official audit telemetry for Labour Commissioners and State Gig Workers Welfare Boards.

curl -X GET "https://api.gignivesh.com/partner/v1/compliance/welfare-report?state=Maharashtra&month=2026-09" \
  -H "Authorization: Bearer <partner_token>"
        

Response:

{
  "success": true,
  "data": {
    "state": "Maharashtra",
    "reportingPeriod": "September 2026",
    "activePartnerRiders": 48200,
    "welfareLevyCollected": "₹9,64,000",
    "remittedToBoard": true,
    "auditCertificateUrl": "https://api.gignivesh.com/compliance/certs/MH-2026-09-8821.pdf"
  }
}
        

3. Partner Webhook Subscriptions

Subscribe your backend services to real-time events emitted by the GigNivesh engine:

Event Identifier	Trigger Condition	Action Recommended
`worker.saye_enrolled`	Rider turns on Save-As-You-Earn in their app	Begin streaming trip-level telemetry for this partner ID
`saye.sweep_executed`	Daily or trip micro-deduction completed	Log deduction on rider's daily earnings slip
`payout.disbursed`	Emergency distress cash advance credited via IMPS	Update rider's available cashout buffer
`welfare.board_certified`	Monthly statutory audit sign-off generated	Archive compliance certificate for labour inspections