Developer API

Gst API

The GST API exposes a session-based workflow through the active controller catalogue. Published routes include starting the flow, submitting GSTIN plus captcha data and refreshing captcha state when needed. This lets an application orchestrate the existing GST workflow through a controlled API subscription.

api-gst
Published endpoints4
Active plans1
Base daily limit1,000
Base monthly limit30,000
Capabilities

What this API is designed to do

GST data workflow API with session, captcha, data and captcha-refresh stages.

Start a GST workflow session
Receive or refresh captcha state
Submit GSTIN and captcha data through the published POST route
Apply API-key, quota and whitelist controls around requests
Use cases

Where it can fit

These are common integration scenarios; the exact use depends on your application, data handling requirements and subscription tier.

Business onboarding workflows that need GST-related data
Internal vendor or customer verification processes
Applications that need to orchestrate the existing GST session and captcha flow
Endpoint catalogue

Published routes and methods

The endpoint list is read from the existing API controller catalogue. It changes automatically when the catalogue is refreshed.

MethodRoutePurpose
ANY/gstIndex
POST/gst/dataBody JSON: { sessionId, GSTIN, captcha }
GET/gst/refresh_captcha(Optional) GET /api/v1/gst/refresh-captcha?sessionId=...
GET/gst/startWS: send {type:"start"} -> receive {type:"captcha", sessionId, captcha(base64)}
Integration flow

From subscription to first request

Keep access and usage manageable by using the customer dashboard as the control point for keys, whitelist rules and plan limits.

01

Choose a GST API tier

02

Generate or assign an API key

03

Call the start route and retain the returned session context

04

Submit GSTIN and captcha data to the published data route

05

Refresh captcha when required and handle errors explicitly

Plans

Choose the request capacity you need

Pricing and limits below are read from the active subscription tiers in the API system.

Star

INR 499.00/month

  • 100,000 requests/day
  • 3,000,000 requests/month
Integration notes

Before you go live

GST data can be business-sensitive. Validate your lawful basis and downstream use, and do not log sensitive payloads unnecessarily.