Parent API: GST API Quickstart guide Authentication guide

Upload Supporting Documents to GST Portal

Q: What parameters and payload format are required for Document Upload?

Requests are submitted via HTTP POST to '/all/docupld'. Required parameters: 'email' (query parameter), 'gstin' (header parameter), 'ret_period' (header parameter), 'gst_username' (header parameter), 'state_cd' (header parameter), 'ip_address' (header parameter), 'txn' (header parameter), 'client_id' (header parameter), 'client_secret' (header parameter). A JSON request body ('Content-Type: application/json') is accepted per the schema specifications shown in the request documentation.

Q: What response status codes and format does Document Upload return?

For Document Upload (POST '/all/docupld'), 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).

POSThttps://apisandbox.whitebooks.in/all/docupld

Used to upload Document

Parameters

query parameters

emailstringrequired

API Developer User Email

header parameters

gstinstringrequired

GST Number

ret_periodstringrequired

Return Period (MMYYYY)

gst_usernamestringrequired

GST UserName

state_cdstringrequired

State Code

ip_addressstringrequired

IP Address

txnstringrequired

Transaction

client_idstringrequired

Client ID

client_secretstringrequired

Client Secret

Request Body

application/jsonrequired

ctstringoptional

Example: "application/pdf"

datastringoptional

Example: "Base64 encoded document"

doc_namstringoptional

Example: "Document.pdf"

Response

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

Frequently Asked Questions

Requests are submitted via HTTP POST to /all/docupld. Required parameters: email (query parameter), gstin (header parameter), ret_period (header parameter), gst_username (header parameter), state_cd (header parameter), ip_address (header parameter), txn (header parameter), client_id (header parameter), client_secret (header parameter). A JSON request body (Content-Type: application/json) is accepted per the schema specifications shown in the request documentation.

For Document Upload (POST /all/docupld), 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).

Used to upload Document

New Proceed To File(GSTR1,GSTR5,GSTR6)

Get Return Status

POST/all/docupld

1const response = await fetch('https://apisandbox.whitebooks.in/all/docupld?email=value', {

2 method: 'POST',

3 headers: {

4 gstin: "value",

5 ret_period: "value",

6 gst_username: "value",

7 state_cd: "value",

8 ip_address: "value",

9 txn: "value",

10 client_id: "value",

11 client_secret: "value",

12 Content-Type: "application/json"

13},

14 body: JSON.stringify({

15 "ct": "application/pdf",

16 "data": "Base64 encoded document",

17 "doc_nam": "Document.pdf"

18}),

19});

21const data = await response.json();

22console.log(data);

No example available.