Introduction
The GST Taxpayer APIs are provided by the GSTN for public usage. These APIs, together, mirror the GST Portal. Therefore, you can use these Sandbox APIs to integrate GST compliance into your workflow itself.
Accessing GST Portal
Use the following workflow to access the GST Portal:
-
First, the GST taxpayer is authenticated.
-
Second, after successful authentication, the GST taxpayer can access their GST Portal. Sandbox provides the following APIs which enable the corresponding functionality of the GST Portal.
i. Ledger APIs - Fetch the taxpayer's ledger like a) cash ITC Ledger, b) cash ledger, c) ITC Ledger, d) Tax Liability Ledger, e) other Ledger, and f) return related liability balance.
ii. Returns APIs - Fetch and file GSTR -1, Fetch GSTR-2A, Fetch and file GSTR -3B, File GSTR-4
GST Taxpayer API workflow


How are the Taxpayer APIs charged?
API | Quota | Upstream |
---|---|---|
Taxpayer Authentication / Generate OTP | Yes | Yes |
Taxpayer Authentication / Verify OTP | Yes | Yes |
Taxpayer Authentication / Get Session Expiry | Yes | No |
Taxpayer Authentication / Refresh Taxpayer Access | Yes | Yes |
Taxpayer Authentication / Taxpayer logout | Yes | Yes |
Ledgers | Yes | Yes |
Returns | Yes | Yes |
GST Pattern Validation
Type | Regular Expression |
---|---|
GSTIN | ^[0-9]{2}[a-zA-Z]{5}[0-9]{4}[a-zA-Z]{1}[1-9A-Za-z]{1}[CZ]{1}[0-9a-zA-Z]{1}$|^[0-9]{4}[a-zA-Z]{3}[0-9]{5}[uUnN]{2}[0-9a-zA-Z]{1}$ |
Updated 5 days ago