Skip to content

Auth Token#

Given a request-id and corresponding OTP, Saves the Auth Token received from GSTN.

Route

/basic/gstn/{flynn-version}/taxpayerapi/{gstn-api-version}/authenticate

  • active ‘flynn-version’: v3.0
  • method: POST

URL Parameters#

Name Description Type
flynn-version version of the API
for example, v3.0		 string
gstn-api-version GSTN API version
for example, v0.2		 string

Headers#

All headers are mentioned in common GSTN headers

Apart from the common GSTN headers for Version-3 need to pass action in header

header value
action AUTHTOKEN

Request#

Body consists of the following payload and has GSTIN and username of the authenticating user

Sample Request Body

{
    "otp-request-id": "c7d5da63-c532-43ff-9c32-e6e43dd58072",
    "otp": "123456"
}

Response#

200:#

Successful response will have the session ID for the authenticated Session with GSTN in “data” attribute as a String. This will be used in the subsequent GSTN API call.

Sample response body

{
  "status": "1",
  "data": {
    "gst-session-id": "8d7a5abc-e7ba-4ab8-8f0a-ef80456e9194"
  },
  "error": null,
  "info": null,
  "additionalInfo": null,
  "alert": null
}