Sample API

Base URL

{{HOST}}/ewb-gsp/v1.03

Authentication

All requests require the user authentication token in the request header.

X-CT-Auth-Token: <YOUR-AUTH-TOKEN-HERE>

To generate authentication token, please contact ClearTax GST Sales.

For all new users, you DO NOT have to add client-id and client-secret to the request headers.

For customers migrating from Karvy, please contact [e-mail] for your updated karvyclientid and karvyclient_secret.

Sample Request

curl --location --request POST 'https://api-sandbox.clear.in/ewb-gsp/v1.03/auth' \
--header 'Gstin: 07AAFCD5862R1ZX' \
--header 'X-CT-Auth-Token: 3c469428-5708-479e-a116-294fd57fe052' \
--header 'Content-Type: application/json' \
--data-raw '{
"Data":"Hy/UBN8CqAG1kJhunyVFTpd80IYyB+e2fQmnxC8ZaUaCpPN1Kcv9kCbi+u4Ste9OodeQjepBsjhfpkgZ4fevuaSBo2sFVKZgNXWxzRZsVbjny2fRH3bxFguqlcP1nDpwCdtoL1fMLHr6bHMxRysz+FaXEJWybNulaRdhsQIlxvYgdlfHPmZ9qQvGPjvOjlDZxgMYzvzJKoPvu2ETmzcrQeza2UtED6CQs2AV8Z4VYFjiOqovB3s8W1KegCiLpggmDCabzj7ethsdugJHXecTHJ5MH13UY1jWtcmI4WUamJn/aEu+cdnnxMh8c03uwpU+xLcOXpG8GijEUqhETqoaQ=="
}'

For further information on different endpoints like generate, cancel, extend, etc, please refer to the NIC documentation at https://docs.ewaybillgst.gov.in/apidocs/index.html

Error Codes

In case you have received an error code from NIC, you can check the description of the code here: https://docs.ewaybillgst.gov.in/apidocs/api-error-codes-list.html