How to get e-invoice API and ip address white listing in e-invoice portal?

 

How to Get E-Invoice API and IP Address Whitelisting in the E-Invoice Portal (India)

With the Government of India implementing e-invoicing under GST (Goods and Services Tax) for B2B transactions, businesses are now required to generate invoices through government-authorized platforms. For medium and large enterprises that use automated systems like ERPs, API integration with the e-invoice system is essential.

This guide walks you through the complete process of obtaining E-Invoice API access and getting your IP address whitelisted on the e-invoice portal.

📌 What is the E-Invoice API?

The e-invoice API is a set of web-based services provided by the Goods and Services Tax Network (GSTN) that allows taxpayers to integrate their ERP or accounting software with the Invoice Registration Portal (IRP). This enables direct submission and generation of IRNs (Invoice Reference Numbers) and QR codes in real-time without manual data entry.

✅ Prerequisites for API Access and IP Whitelisting

Before you apply for API access, ensure the following:

  1. GSTIN is active and under e-invoice mandate (turnover exceeds the current threshold, e.g., ₹5 crores).

  2. You are registered on the e-Invoice portal: https://einvoice.gst.gov.in.

  3. Your ERP or accounting system supports JSON data and HTTPS protocol for API calls.

  4. You have a public IP address for communication with the e-invoice API.

  5. You have a valid Class 2 or Class 3 DSC (Digital Signature Certificate) if needed for registration.

📝 Step-by-Step Process to Get E-Invoice API Access

Step 1: Register on the E-Invoice Portal

  1. Go to https://einvoice.gst.gov.in.

  2. Click on "Registration" and select "Portal Login".

  3. Use your GSTIN and credentials to log in.

Step 2: Register as a GSP or Direct API User

There are two types of API access:

  • Direct API Access: For large taxpayers who want to directly integrate their ERP with the IRP.

  • GSP Route: For businesses that prefer to use a GST Suvidha Provider.

To register for Direct API:

  1. Log in to the e-invoice portal.

  2. Go to API Registration > User Credentials.

  3. Select "Direct API".

  4. Enter details:

    • PAN

    • Registered email ID

    • Mobile number

  5. Set a username and password for API access.

Step 3: IP Address Whitelisting

To prevent unauthorized access and enhance security, NIC requires whitelisting of IPs.

  1. After Direct API registration, go to API Registration > IP Whitelist.

  2. Enter your static public IP address (up to 4 IPs can be added).

  3. Submit the form.

⚠️ Note: You must provide a static IP address. Dynamic IPs from ISPs like mobile networks or broadband routers without fixed IPs are not accepted.

Step 4: Wait for Approval

Once submitted:

  • The NIC (National Informatics Centre) team will review your request.

  • If the details are valid, your IPs will be whitelisted typically within 24-72 hours.

  • You will receive confirmation via email or portal dashboard.

🔐 Using the API Credentials

Once whitelisted, use the API credentials (username and password) along with your static IP to:

  1. Authenticate with the e-invoice system.

  2. Generate IRNs via JSON payload.

  3. Cancel e-invoices.

  4. Fetch details of previously generated invoices.

All API calls must be sent over HTTPS and signed with HMAC SHA-256 using your credentials.

🔧 Testing Environment (Sandbox)

NIC provides a sandbox environment for developers:

  • Register on the E-Invoice Sandbox Portal: https://einv-apisandbox.nic.in

  • Use it to test APIs before going live.

  • Sandbox uses a separate set of credentials and test GSTINs.

🛠️ Troubleshooting & Common Issues

IssueSolution
IP Not WhitelistedEnsure the IP is static and correctly formatted. Check with your ISP.
Invalid CredentialsReset your API password from the portal.
403 Forbidden ErrorsLikely due to an unregistered IP or wrong headers.
IRN Generation FailedCheck the JSON structure; use schema from NIC documentation.

📚 Resources

🔄 Conclusion

Integrating your system with the e-invoice API is essential for businesses that generate high volumes of invoices. Following the steps above for registration, IP whitelisting, and testing will ensure a smooth and secure integration process. Always keep your system updated with the latest APIs and security protocols issued by NIC.

Comments

Post a Comment

Popular posts from this blog

Give comparison of all the charges of top 10 Payment Gateways in India

  Comparison of Charges of Top 10 Payment Gateways in India (2025) As the digital payment landscape continues to grow in India, selecting the right payment gateway is essential for businesses aiming to streamline online transactions. While functionality, integration, and customer support are important, charges and fees often remain the deciding factor. This article offers an in-depth comparison of charges associated with the top 10 payment gateways in India to help merchants make an informed choice. 🧾 Key Payment Gateway Charges Explained Before diving into the comparison, let’s understand the common fee structures: Charge Type Description Setup Fee One-time fee charged during account creation. Annual Maintenance Fee Yearly charge for using the service. Transaction Discount Rate (TDR) Fee deducted per transaction, usually a percentage of the transaction amount. Payout/Withdrawal Fee Charges for transferring money from the gateway to the bank account. 📊 Top 10 Payment Gatew...
Read more

What are the detailed steps to start a Digital Gold Business?

What are the Detailed Steps to Start a Digital Gold Business? In the evolving landscape of fintech and digital assets, digital gold has emerged as a popular investment tool. It allows customers to buy, sell, and store gold digitally without physically owning it. Starting a digital gold business is a lucrative venture, but it requires strategic planning, regulatory compliance, and strong technological infrastructure. Here’s a step-by-step guide to help you understand how to start a digital gold business: Step 1: Understand the Digital Gold Business Model Before diving in, gain a solid understanding of the digital gold ecosystem. In this model: Customers buy and sell gold in small or large quantities online. The gold is backed by physical gold stored securely by trusted vaulting partners. You act as a platform that facilitates these transactions and may earn via spreads, commissions, or service fees. There are typically three key players in this model: Customer – t...
Read more

What factors are affecting Gold Prices?

  What Factors Are Affecting Gold Prices? Gold has long been considered a safe-haven asset, a store of value, and a hedge against economic uncertainties. Its allure spans centuries, playing a central role in global finance, jewelry, and central bank reserves. However, like any commodity or financial asset, the price of gold is influenced by a complex interplay of factors—ranging from macroeconomic indicators to geopolitical tensions and investor behavior. This article delves deeply into the key drivers that affect gold prices in the modern economic landscape. 1. Inflation and Real Interest Rates One of the most influential factors in gold price movements is the real interest rate , which is the nominal interest rate minus inflation. Gold does not yield interest or dividends, so when real interest rates are low or negative, the opportunity cost of holding gold decreases, making it a more attractive investment. Inflation Hedge: Gold is often perceived as a hedge against infla...
Read more