Skip to content

Request OTP#

Requests OTP to initiate GST Session creation.

Route

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

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

URL Parameters#

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

Headers#

All headers are mentioned in common GSTN headers

Request#

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

Sample Request Body

{
  "gstin": "33GSPTN0792G1Z4",
  "username": "vayana.tn.2"
}

Response#

200:#

Successful response will have an OTP request ID in “data” attribute as a String. This will be used in the subsequent AUTH Token API call.

Sample response body

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