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

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-accept-cache
boolean

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

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

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"