Skip to main content
POST

Response schema

For successful responses, these resources describe the GSTN payload at data.data.

View response JSON schema

View Excel field reference

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-accept-cache
boolean

Pass true to accept the cached response. If the header is not passed, or if false is sent as the value, the request will hit the origin.

x-api-version
string
default:1.0.0

API version

Body

application/json
gstin
string
required

GSTIN of the taxpayer

Response

200 Success / 200 Success / 200 SEZ / 200 ISD / 200 Multiple additional addresses of business / 200 Cancelled GSTIN / 200 Public Limited Company / 200 Public Sector Bank / FO8000 No records found / 200 NRI GSTIN

code
integer
required
Example:

200

data
object
required
timestamp
integer<int64>
required
Example:

1763446641000

transaction_id
string
required
Example:

"b14e175f-a03a-4e61-8cf1-1853a12bbc21"