Looking for a business loan


Thank you for your interest, our team will get back to you shortly

Please Fill the Details to download

Thank you for your response

Get Expert Assistance

Thank you for your response

Our representative will get in touch with you shortly.

India's #1 GST software

1 click autofill GSTR-3B with G1 and 2B data

Download 2B data for multiple months in < 2mins

GSTR-2B vs purchase matching in under 1 min

India's No 1 GST software

Save upto 7% in taxes

Claim 100% ITC and save ~4% GST

3x faster experience

Save 2 man days every GSTIN month

Easy to connect

Connect with 100s of ERP's, import data error-free

All you need to know about GST API access

Updated on :  

08 min read.

GST API is an application programming interface under GST. An API acts as an intermediary between two applications so that they can interact with each other. API is an essential aspect of easing GST compliance. This article covers the below topics on GST API.

Ways to access the GST portal

GST is a progressive tax reform implemented in India. It has changed how you interact with your vendors and customers and place control over all the activities. There are two ways to access the GST portal:

  1. G2B: It means the government to business interaction. All businesses can directly access the GST portal for performing various GST compliance-related work.
  2. Using third party applications: A taxpayer can choose to carry out these GST related compliances through third-party applications. These third-party applications can connect with the GST system via secure GST system APIs. These applications may also be developed by third parties known as GST Suvidha Providers (GSPs). These applications can pull the required data from the GST portal and provide beneficial results using GST APIs.

Introduction to GST system APIs

Using a GST API, a taxpayer can connect with the GSTN’s server and perform different functionalities such as filing returns, viewing ledger, pulling payment information, etc. Restful API is used by the Goods and Services Tax Network in India.

Avail third-party services- A taxpayer can use the services of ASP-GSP for GST return filing and other compliance-related work. For availing these services, a taxpayer needs to give access to his GST portal’s APIs. This is a security feature and helps to avoid any unauthorised access to the taxpayers’ information. It allows the taxpayers to control API access on the GST portal. A taxpayer can also disable or limit this access.

Benefits of using APIs

  1. GST API provides integration with the ERP or accounting system of taxpayers.
  2. They have a smart system and deliver 80% results even if the GST servers are down.
  3. Signing up, generating API keys and running requests takes less time. APIs provide faster response time.
  4. GST API can help to view/save different GST returns, check GST returns’ status, and make payments.

List of GST APIs

The various GST return filing functions available as APIs are as follows:

A. Registration Module API

  1. New registration
  2. Amendment/cancellation of registration
  3. Opting in/out from composition scheme
  4. Revocation of GST registration
  5. Surrender of GST registration

B. View ledger details API

  1. Cash ITC Balance
  2. Cash Ledger Details
  3. ITC Ledger Details
  4. Liability Ledger Details
  5. For Return Liability
  6. Other than Return Ledger
  7. RetLiab Balance

C. Payment details API

  1. Challan History
  2. Challan Summary

D. File and submit returns APIs

  1. GSTR 1
  2. GSTR 2A
  3. GSTR 3B
  4. GSTR 4
  5. GSTR 5
  6. GSTR 6
  7. GSTR 6A
  8. GSTR 7
  9. GSTR 8
  10. GSTR 9
  11. ITC 03
  12. ITC 04

E. Miscellaneous activities 

  1. HSN/SAC code search
  2. Notification for notices and alerts
  3. Grievance creation

How to enable GST API Access on GST Portal?

Step 1: Log in to the GST portal and navigate to the ‘My profile’ section.


Step 2: Under the quick-links panel, select ‘Manage API access’.


Step 3: Click ‘Yes’.


Step 4: Duration dropdown will be displayed. Select the desired duration and click confirm.


Duration for keeping GST API Access active

A taxpayer can keep the API session active for a minimum of six hours and a maximum of up to 30 days. A taxpayer is not required to enter the OTP during this time frame. A taxpayer can choose a longer session if he wants to allow the GSP/ASP to maintain an active session with the GST portal without entering OTP. A taxpayer can also terminate the session for a longer API session and enable the API access and choose a shorter duration.

Issues while accessing GST API

Unable to access the portal- The API access on GST Portal is a permission-controlled feature. A taxpayer needs to activate the GST Portal’s API session, as illustrated in the above topic. He is also required to define the period for which his/her session should remain active. After the period lapses, the GSP cannot access the GST portal. Again permission is required to be given.

Technical challenges- An error message may be received, stating, ‘Your connection is terminated. Kindly reconnect to proceed’. This error message is received due to a technical glitch in the API from the GSTN. For this type of error, one needs to enter the OTP again and then continue with GST filing.

inline CTA
India’s Fastest and Most Advanced 2B Matching
Maximise ITC claims, use smart validations to correct your data and complete 2B matching in <1 minute