PeriOne GST API platform logo
HomeDocumentation
PeriOne API Documentation India

PeriOne API Documentation India

References for GST, e-Invoice, e-Way Bill, e-KYC and VAHAN APIs. Find each service's endpoints, authentication requirements and supporting resources.

Auth walkthrough
Copy-ready requests
Core endpoint groups
Error-code 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

Free Sandbox Access

Confirm the environment for your chosen service. e-KYC and VAHAN consoles currently provide production access; ask about testing arrangements.

  • No Credit Card Required 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

Follow each service reference for credentials, token generation and request headers. e-Invoice uses the auth-token header.

  • Service-specific authentication
  • 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

Sandbox

https://staging.perione.in

e-Invoice Request Headers

auth-tokene-Invoice token from GET /einvoice/authenticate; other services have their own documented headers.
Content-Typeapplication/json
example.js
// Server-side e-Invoice authentication example.
// Supply credentials from your server environment; never embed them in a browser app.
const url = new URL('https://staging.perione.in/einvoice/authenticate');
url.searchParams.set('email', process.env.PERIONE_EMAIL);
const response = await fetch(url, {
  method: 'GET',
  headers: {
    username: process.env.PERIONE_USERNAME,
    password: process.env.PERIONE_PASSWORD,
    ip_address: process.env.PERIONE_IP_ADDRESS,
    client_id: process.env.PERIONE_CLIENT_ID,
    client_secret: process.env.PERIONE_CLIENT_SECRET,
    gstin: process.env.PERIONE_GSTIN
  }
});
if (!response.ok) throw new Error('Authentication failed');
// Handle the documented response server-side.
// Subsequent e-Invoice requests use the auth-token header.
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-e-Way Bill workflow support.

Key Endpoints

GET/einvoice/authenticate
POST/einvoice/type/GENERATE/version/V1_03
GET/einvoice/type/GETIRN/version/V1_03
POST/einvoice/type/CANCEL/version/V1_03

e-Way Bill API

RESTful API

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

Key Endpoints

POST/ewaybillapi/v1.03/ewayapi/genewaybill
POST/ewaybillapi/v1.03/ewayapi/vehewb
POST/ewaybillapi/v1.03/ewayapi/canewb
GET/ewaybillapi/v1.03/ewayapi/getewaybill

GST API

RESTful API

GST search, filing, amendments, purchase reconciliation, IMS, notices, ledgers and annual returns.

Key Endpoints

GET/public/search
GET/public/rettrack
POST/gstr1/retfile
GET/gstr2b/all

e-KYC API

RESTful API

Seven APIs for PAN/GST, MCA company and director checks, and Udyam registration.

Key Endpoints

POST/ekyc/pansearch
GET/ekyc/pantogst
POST/ekyc/cinverify
POST/ekyc/udyam

VAHAN and SARATHI API

RESTful API

Nine APIs for GST, vehicle, driving licence, e-Challan, FASTag and toll lookups.

Key Endpoints

POST/vahan/dl
POST/vahan/vehicleno
POST/vahan/echallan
POST/vahan/tag
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

Ready to Get Started?

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