PeriOne GST API platform logo
HomeDocumentation
GST API Documentation India

GST API Documentation India

Practical implementation guides for teams rolling out GST APIs, e-Invoice workflows, and e-Way Bill APIs across apps, platforms, and ERPs in India.

Auth walkthrough
Copy-ready requests
Core endpoint groups
Error-code references

Quick API Reference

3

API Suites

Bearer

Auth Model

Available

Sandbox

Official

Error References

Getting Started

Quick Start Guide

The quickest path is to validate one sandbox workflow first, confirm authentication, and then layer in the rest of your rollout.

01

Request Sandbox Access

Start with sandbox access so your team can validate one workflow before moving live.

  • No credit card for evaluation
  • Environment-ready onboarding
  • Docs available immediately
02

Receive Credentials

Use the issued credentials to authenticate and confirm the request structure your workflow needs.

  • Sandbox credentials
  • Auth-first workflow
  • Environment-specific access
03

Authenticate

Obtain a bearer token once, then reuse the same access pattern across supported workflows.

  • Shared auth pattern
  • Token-based access
  • Predictable request flow
04

Make API Calls

Call the API suite you need first, then expand into adjacent workflows when your rollout is ready.

  • RESTful endpoints
  • JSON responses
  • Production-ready workflow mapping
Security

API Authentication

All protected requests use a bearer token flow. Authenticate once, then reuse the same access pattern across supported workflows.

Base URLs

Production

https://api.perione.in/v1

Sandbox

https://staging.perione.in/v1

Required Headers

AuthorizationBearer token obtained from /authenticate endpoint
Content-Typeapplication/json
example.js
// Example: Authenticate before calling any workflow
const authResponse = await fetch(
  'https://staging.perione.in/v1/authenticate',
  {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({
      gstin: '29AADCT2727Q1Z2',
      username: 'YOUR_USERNAME',
      password: 'YOUR_PASSWORD'
    })
  }
);

const { token, expires_in } = await authResponse.json();

// Reuse the token across e-Invoice, e-Waybill, and GST calls
console.log(token, expires_in);
API Reference

Explore Our APIs

Start with the API suite you need now, then expand into adjacent workflows without changing the integration style.

e-Invoice API

RESTful API

IRN generation, cancellation, retrieval, and invoice-to-EWB workflow support.

Key Endpoints

POST/authenticate
POST/generate
GET/irn/{irn}
POST/cancel
View full documentation

e-Waybill API

RESTful API

Generation, Part-B updates, transporter workflows, and consolidated e-Waybill operations.

Key Endpoints

POST/generate
POST/update-partb
POST/cancel
GET/ewaybill/{ewbNo}
View full documentation

GST API

RESTful API

GSTIN validation, return history, PAN search, and GST data workflows.

Key Endpoints

GET/gstin/{gstin}
GET/gstin/{gstin}/returns
POST/gstin/verify
GET/gstin/{gstin}/status
View full documentation
Response Handling

HTTP Status Codes

Standard HTTP response codes are used to indicate the success or failure of API requests.

200

Success

Request processed successfully

400

Bad Request

Invalid request parameters

401

Unauthorized

Invalid or expired token

429

Rate Limited

Too many requests

500

Server Error

Internal server error

Official e-Invoice error codes

Reference the GST portal IRN error code list for invoice validation and generation issues.

Official e-Waybill error codes

Use the official e-Waybill API error code list to troubleshoot transport and document flows.

Ready to Get Started?

Validate the flow in sandbox, align the implementation with your team, and then move to production when ready.

Request Sandbox AccessExplore Workflows