To use the API interface, Tax payers / GSPs / ERPs / E-Comm. operators (ECO) have to meet the following conditions:

  • Should have automated their invoice generation process.
  • Must ensure that traffic originating from their end and destination to e-Invoice system is free from viruses, malwares, intrusions, Bots/C&C threats etc. NIC will reserve the right to block/suspend the services of GSP/Taxpayers if malicious traffic impacting the e-Invoice system is detected.
  • Must adhere to all Government of India IT Security standards and regulatory requirements. GSP/Taxpayers must comply with IT Act 2000 (including 43A) and amendments thereof.
  • Tax payers / ECOs, as notified by the government are allowed to register the e-Invoice on the GST Portal. Please see the laws section on the e-Invoice portal for the category of the tax payers eligible for this purpose.
  • Must have provision for adequate bandwidth at their end for connecting to e-Invoice system.
  • Initially, the tax payers with annual turnover of 500 Crore and above, in their previous financial year, are allowed to get the access to the API credentials.
  • Applications consuming APIs should support SSL with minimum version - TLS 1.2
  • Will be allowed to access the production environment by whitelisting maximum up to 4 Indian Static IP addresses.
  • Need to modify their automated system for data exchange with the e-Invoicing system as per the APIs.
  • It is recommended that Taxpayers / GSTs / ERPs/ ECOs should also consider a backup connectivity to be provided from different service providers at their location.
  • Should have pre-production system for testing.
  • Need to test their modified system on the e-Invoice pre-production site with all types of activities/services.

On-boarding Process

E-Way Bill and E-Invoice API Access Mechanism

Category Tax payers with Turnover > 500 Crores Tax payers with Turnover < 500 Crores
Through GSP
Through ERP
Direct API Access
Through 'Direct API Access Users'
Users already having 'E-Way Bill API Access'
  • GSPs/ERPs/ECOs/Taxpayers should preferably nominate a Project Manager and Technical SPOC, for overseeing all project related matters and issues.
  • GSPs/ERPs/ECOs/Taxpayers should have met the pre-requisite conditions, to get the access to production.
  • Once they have finished the testing of all APIs in pre-production environment with minimum number of successful and failure case considering all possible cases, they have to file their complete test results in the Test Summary Report in the format as given hereExcel Icon.
    • Testing should be carried out by interfacing the APIs with the tax payer's ERP/Accounting application and not through the NIC online testing tool
    • Testing should be done for all possible scenarios and not limited to the scenarios provided in the test summary format
    • Test report should be submitted only by the GSPs/ERPs/ECOs/concerned Taxpayers (not by the third parties)
    • Test report may contain summary for test using a single client ID
    • GSPs / ERPs have to send the report to support[dot]einv[dot]api[at]gov[dot]in email id and Tax payers / ECOs have to upload through the portal along with request for whitelisting IPs
    • It may take 4-5 days for verification of report and whitelisting of the IP addresses. Hence the requests should be sent / submitted well in advance to avoid inconvenience at the time of go live
    • Correct IP addresses should be submitted after due verification. Once whitelisted, it takes more time to change the same
  • Duly filled in report in PDF format has to be uploaded on to the production E Invoice Web Portal and request for whitelisting the IPs can be submitted as well.
  • Access to e-Invoice system shall be provided on evaluation and confirmation of the test report.
  • GSPs/ERPs/ECOs/Taxpayers can reach the e-Invoice system through internet initially. However, subsequently they would access the e-Invoice system through MPLS links provisioned by GSTIN. A cut-off date for the same would be informed in due course of time.
  • The users have to separately create credentials for the production environment by visiting the production e-Invoicing self-help portal.
  • If the taxpayers have multiple tax payer registrations (GSTINs) with same PAN, then they can use same client-id and client-secret of their main business place. However, they have to create separate user name and password credentials for each registration/GSTIN in e-Invoice system.
  • Taxpayers who wish to use the APIs through GSP / ERP have to opt for the GSP / ERP in the portal and create their own user name and password.

Documents Required

  • 4 Indian Public Static IPs (maximum) for whitelisting at NIC end.
  • The summary test report of the successful test on sandbox.
  • Contact details of Project Manager and Technical SPOC.(to be provided in the above report)