Verify OTP

Verify OTP to authenticate tax payer. This API will start a session and provide access valid for 6 hrs. Returns date timestamp of expiry of session.

POST /gst/compliance/tax-payer/otp/verify

cURL

200 Success

curl --request POST \
  --url https://api.sandbox.co.in/gst/compliance/tax-payer/otp/verify \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "username": "TN_NT2.2477",
  "gstin": "33ABKCS2033B1ZW"
}
'

200

200 Success

{
  "code": 200,
  "data": {
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ0YXhwYXllci1zZXNzaW9uIiwiZ3N0aW4iOiIyNEFCS0NTMjAzM0IxWlYiLCJpYXQiOjE3MTI5NDQxMDAsImV4cCI6MTcxMjk0NzcxMX0.sandbox-signature",
    "session_expiry": 1712947711000,
    "status_cd": "1",
    "token_expiry": 1712947711000
  },
  "timestamp": 1712926110000,
  "transaction_id": "f6a85bd7-6d53-4e60-b4a7-480d3738ff0c"
}

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

Headers

authorization · string · required

JWT access token

x-source · string · default: primary

Source. Possible Values: primary (default) or secondary

Example:

"primary"

x-api-key · string · required

API key for identification

x-api-version · string · default: 1.0.0

API version

Query Parameters

otp · integer<int32> · required

One time password

Example:

"575757"

Body

application/json

username · string · required

Username as per GST portal

gstin · string · required

GSTIN of the taxpayer

Response

200

application/json

AUTH4033 Invalid session / 200 Success

code · number

Example:

200

data · object

Show child attributes

timestamp · number

Example:

1763446641000

transaction_id · string

Example:

"1ad1d698-499e-4b10-a44a-fecba43babbb"