Parent API: GST API Quickstart guide Authentication guide

GST Authorization Token API

Q: What parameters and payload format are required for Request for Authorization Token?

Requests are submitted via HTTP GET to '/authentication/authtoken'. Required parameters: 'email' (query parameter), 'otp' (query parameter), 'gst_username' (header parameter), 'state_cd' (header parameter), 'ip_address' (header parameter), 'txn' (header parameter), 'client_id' (header parameter), 'client_secret' (header parameter). No request body payload is required for this call.

Q: What response status codes and format does Request for Authorization Token return?

For Request for Authorization Token (GET '/authentication/authtoken'), responses are returned in JSON format ('application/json'). Documented response codes in the specification include: HTTP 404 (Not Found. If requested entity is not found or if requested API is not found.), HTTP 500 (Internal server error).

GEThttps://apisandbox.whitebooks.in/authentication/authtoken

Tax payer and tax consultant using GSP application will be authenticated asynchronously using OTP. OTP Request API is used by the GSP to initiate the issue of OTP to tax payer.After the successful verification of request parameters, GST system sends the OTP to the taxpayer's primary business credentials through Email and SMS

Parameters

query parameters

emailstringrequired

User Email

otpstringrequired

GST User Recived OTP,Default OTP for SandBox is 575757

header parameters

gst_usernamestringrequired

GST UserName

state_cdstringrequired

State Code

ip_addressstringrequired

IP Address

txnstringrequired

Transaction

client_idstringrequired

Client ID

client_secretstringrequired

Client Secret

Response

Not Found. If requested entity is not found or if requested API is not found.

Frequently Asked Questions

Requests are submitted via HTTP GET to /authentication/authtoken. Required parameters: email (query parameter), otp (query parameter), gst_username (header parameter), state_cd (header parameter), ip_address (header parameter), txn (header parameter), client_id (header parameter), client_secret (header parameter). No request body payload is required for this call.

For Request for Authorization Token (GET /authentication/authtoken), responses are returned in JSON format (application/json). Documented response codes in the specification include: HTTP 404 (Not Found. If requested entity is not found or if requested API is not found.), HTTP 500 (Internal server error).

Request for OTP

Request for extension of authorization token

GET/authentication/authtoken

1const response = await fetch('https://apisandbox.whitebooks.in/authentication/authtoken?email=value&otp=value', {

2 method: 'GET',

3 headers: {

4 gst_username: "value",

5 state_cd: "value",

6 ip_address: "value",

7 txn: "value",

8 client_id: "value",

9 client_secret: "value"

10},

11});

13const data = await response.json();

14console.log(data);

No example available.