Skip to main content
POST

ā€‹
Response schema

For successful responses, these resources describe the Goods and Services Tax Network (GSTN) payload at data.data.

View response JSON schema

View Excel field reference

Headers

ā€‹
authorization
string
required

JWT access token used to authorize the request.

ā€‹
x-accept-cache
boolean

Pass true to accept a cached response. Requests without this header, or with false, are sent to the origin.

ā€‹
x-api-key
string
required

API key used to identify your Sandbox account.

ā€‹
x-api-version
string
default:1.0.0

Sandbox API version to use.

Body

application/json

Contact details to validate for an unregistered applicant.

ā€‹
enrolment_number
string
required

GST enrolment number of the unregistered applicant.

Maximum string length: 15
Example:

"372300000015ES1"

ā€‹
email
string<email>
required

Email address registered for the applicant.

Maximum string length: 254
Example:

"abcd@gmail.com"

ā€‹
mobile
string

Mobile number registered for the applicant.

Maximum string length: 10
Example:

"9898989898"

Response

200 - application/json

Unregistered applicant contact details validated successfully.

ā€‹
code
integer
required

HTTP status code.

Example:

200

ā€‹
data
object
required
ā€‹
timestamp
integer<int64>
required

Unix timestamp in milliseconds indicating when the server generated the response.

Example:

1785424627417

ā€‹
transaction_id
string<uuid>
required

Unique identifier for tracking the request across systems.

Example:

"eb03920d-5dae-447b-aa2a-8e4931ccbe58"