Skip to main content
POST
/
gst
/
compliance
/
e-way-bill
/
tax-payer
/
authenticate
curl --request POST \
  --url https://api.sandbox.co.in/gst/compliance/e-way-bill/tax-payer/authenticate \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "username": "ACME_IND_API_QCK",
  "password": "QnVzaW5lc3NfQVBJX1FDSw",
  "gstin": "29AAACQ3770E000"
}
'
{
  "code": 200,
  "data": {
    "Status": 1,
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ0YXhwYXllci1zZXNzaW9uIiwiZ3N0aW4iOiIyNEFCS0NTMjAzM0IxWlYiLCJpYXQiOjE3MTI5NDQxMDAsImV4cCI6MTcxMjk0NzcxMX0.sandbox-signature",
    "expiry": 1714157100000
  },
  "timestamp": 1763446641000,
  "transaction_id": "2ab9923e-f844-4b6c-8fc7-0bcc767bafc7"
}

ā€‹
Request body schema

View request body schema

Prerequisites: You must have API credentials to hit E-Way Bill APIs. If not, create API credentials.

Headers

ā€‹
authorization
string
required

JWT access token

ā€‹
x-source
string
default:primary

Source. Possible Values: primary, secondary or tertiary

Example:

"primary"

ā€‹
x-api-key
string
required

API key for identification

ā€‹
x-api-version
string
default:1.0.0

API version

Body

application/json
ā€‹
username
string
required

API username of taxpayer as set on E-Way Bill portal

ā€‹
password
string
required

API password of taxpayer as set on E-Way Bill portal

ā€‹
gstin
string
required

GSTIN of the taxpayer

Response

200 - application/json

200 Authenticated / 108 Invalid login credentials

ā€‹
code
number
Example:

200

ā€‹
data
object
ā€‹
timestamp
number
Example:

1763446641000

ā€‹
transaction_id
string
Example:

"2ab9923e-f844-4b6c-8fc7-0bcc767bafc7"