Generate OTP

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

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-source

string

default:primary

Source. Possible Values: primary (default) or secondary

Example:

"primary"

x-api-version

string

default:1.0.0

API version

Body

application/json

GST Portal identity used to generate and verify a taxpayer OTP.

username

string

required

Username as per GST portal

gstin

string

required

GSTIN of the taxpayer

Response

GSTN success or business-error response. GSTN returns both variants with HTTP 200.

code

integer

HTTP status code returned by Sandbox.

Example:

200

data

object

Generate OTP result. status_cd identifies success or failure. Failed operations also include error.

Show child attributes

timestamp

integer<int64>

Unix timestamp in milliseconds when Sandbox processed the request.

Example:

1712926086000

transaction_id

string

Unique identifier for tracing the request.

Example:

"9a6ce7b9-de63-48a8-b45b-0c5420538b25"

Analytics

Compliance

Annexures

Authorizations

Headers

Body

Response