E-Way Bill Authentication

API to generate JWT access token required to call E-Way Bill APIs


Users have to authenticate themselves using their E-Way Bill portal credentials to call the E-Way Bill APIs


HTTP MethodResource

API Endpoint  Contact Us  Free Trial


Follow the below guidelines to call the API.


The x-source provided by the user will be utilized for all the other E-Way Bill API requests.

x-source description

The image below demonstrates how Sandbox employs various sources to communicate with the GST E-Way Bill Server. To access the Sandbox E-Way Bill Authentication API, users must specify a particular source via the x-source header attribute. Doing so will create an authorization token that is necessary for accessing other E-Way Bill APIs. This authorization token includes both the selected source and the user's GSTIN. Therefore, any other E-Way Bill APIs accessed using this authorization token will be directed through the chosen source for that authenticated GSTIN.

Note: The name of the souces is not subject to their performance/availability.


x-api-keystringAn API key is a public key to identify users when calling any Sandbox API.key_live_ZUQT5UEf4......
x-sourcestringLook here
Possible Values -
primary, secondary or tertiary
AuthorizationstringJWT Authorization tokeneyJhsebihGyUf......


Currently, only primary source is live meaning secondary and tertiary will not work.

Query Parameters

gstinstring15-character alpha-numeric unique identifier assigned to business entities registering under the GST regime.22AAAAA0000A1Z5


usernamestringUsername of Tax payer as created on E-Way Bill portal for API Integrationtestuser
passwordstringPassword of Tax payer as in E-Way Bill portal for API IntegrationPassword in plain text

Sample CURL Request

curl --request POST \
     --url 'https://api.sandbox.co.in/ewb/authenticate?gstin=gstin' \
     --header 'Authorization: xxxxxxxxxx' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-api-key: xxxxxxxxxx' \
     --header 'x-api-version: 1.0' \
     --header 'x-source: primary' \
     --data '
  "username": "testuser",
  "password": "<Password in plain text >"


Test Environment Not Available


StatusnumStatus of the authentication request.
Possible values -
1 - Success
0 - Failure
access_tokenstringAuthorization token. Users will have to use this token for accessing other E-Way Bill APIs.
Note: This token is only valid for E-Way Bill APIs.
ErrorDetailsstringIf the Staus is 0, user will receive an array of objects containing ErrorCode andErrorMessage"ErrorCode": "1017",
"ErrorMessage": "Incorrect user id/User does not exists"
InfoDtlsstringAny additional message to be conveyed would be passed.null

Response Caching

Response caching is not available for this API. Learn more about our response caching mechanism here

Wallet Charges

Since E-Way Bill Authentication API is a Paid API, a wallet charge will take place.


This API is currently in major version 1.0. Refer to our versioning policies here