Skip to main content
POST
Get unregistered applicant details

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

Identifier for the unregistered applicant.

uid
string
required

GST enrolment UID of the unregistered applicant.

Example:

"292200000001ES9"

Response

200 - application/json

Unregistered applicant details retrieved 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:

"f8be2d24-ed85-4a65-9763-0a3bef00870a"