Request OTP

Requests OTP to initiate GST Session creation.

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	OTPREQUEST

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

{
  "status": "1",
  "data": {
    "otp-request-id": "bda3b490-fd37-4a6a-9d62-05cdb4b5ccbb"
  },
  "error": null,
  "info": null,
  "additionalInfo": null,
  "alert": null
}