Parent API: GST API Quickstart guide Authentication guide

Extend GST Session Token Validity

Q: What parameters and payload format are required for Request for extension of authorization token?

Requests are submitted via HTTP GET to '/authentication/refreshtoken'. Required parameters: 'email' (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 extension of authorization token return?

For Request for extension of authorization token (GET '/authentication/refreshtoken'), 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/refreshtoken

Refresh token can be used by GSP to extend access through Authorization code and allow for access to data on behalf of tax payer / tax consultant without user intervention.

Parameters

query parameters

emailstringrequired

User Email

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/refreshtoken. Required parameters: email (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 extension of authorization token (GET /authentication/refreshtoken), 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).

Refresh token can be used by GSP to extend access through Authorization code and allow for access to data on behalf of tax payer / tax consultant without user intervention.

Request for Authorization Token

Request for logout

GET/authentication/refreshtoken

1const response = await fetch('https://apisandbox.whitebooks.in/authentication/refreshtoken?email=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.