Skip to main content
POST
Prerequisites: You must enable API access to get access to GST APIs. If not done already, enable API access.

Authorizations

authorization
string
header
required

Sandbox access token returned by /authenticate.

x-api-key
string
header
required

Sandbox API key from your Sandbox account.

Headers

x-source
string
default:primary

Source. Possible Values: primary (default) or secondary

Example:

"primary"

x-api-version
string
default:1.0.0

API version

Query Parameters

otp
string
required

One time password

Example:

"575757"

Body

application/json

GST Portal identity used to generate and verify a taxpayer OTP.

username
string
required

Username as per GST portal

gstin
string
required

GSTIN of the taxpayer

Response

GSTN success or business-error response. GSTN returns both variants with HTTP 200.

A taxpayer session success or GSTN business-error response. Both variants use HTTP 200.

code
enum<integer>
required

The HTTP status code reported in the response body.

Available options:
200
Example:

200

timestamp
integer<int64>
required

The response timestamp in Unix epoch milliseconds.

Example:

1763446641000

transaction_id
string
required

The transaction identifier used to trace the request.

Example:

"41bb8041-fb83-4654-8d75-85a19f329158"

data
object
required

A successful GST taxpayer session.