Skip to main content
POST
/
gst
/
compliance
/
e-invoice
/
tax-payer
/
authenticate
E-Invoice Authentication
curl --request POST \
  --url https://api.sandbox.co.in/gst/compliance/e-invoice/tax-payer/authenticate \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{
  "username": "ACME_IND_API_QCK",
  "password": "QnVzaW5lc3NfQVBJX1FDSw",
  "gstin": "29AAACQ3770E000"
}'
{
  "code": 200,
  "data": {
    "Data": null,
    "ErrorDetails": [
      {
        "ErrorCode": "1015",
        "ErrorMessage": "Invalid GSTIN for this user"
      }
    ],
    "InfoDtls": null,
    "Status": 0
  },
  "timestamp": 1763446641000,
  "transaction_id": "474bfffc-7f59-4f01-b658-454f36028cd3"
}
Prerequisites: You must have API credentials to hit E-Invoice APIs. If not, create API credentials.

Headers

ā€‹
Authorization
string
required

JWT access token

ā€‹
x-source
enum<string>
default:primary

Specifies the source to access, either primary (NIC 1) or secondary (NIC 2)

Available options:
primary,
secondary
Example:

"primary"

ā€‹
x-api-key
string
required

API key for identification

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

API version

Query Parameters

ā€‹
force
string
required

The value of this attribute is to be set true if the client needs to refresh the token 10 minutes before expiry. Possible Values - true or false

Example:

"true"

Body

application/json
ā€‹
username
string
required

API username of taxpayer as set on E-Invoice portal

ā€‹
password
string
required

API password of taxpayer as set on E-Invoice portal

ā€‹
gstin
string
required

GSTIN of the taxpayer

Response

200 - application/json

1015 Invalid GSTIN for user / 200 Authenticated / 1019 Incorrect password / 1017 Incorrect user id / GEN5008 GSTN Server Error

ā€‹
code
number
Example:

200

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

1763446641000

ā€‹
transaction_id
string
Example:

"474bfffc-7f59-4f01-b658-454f36028cd3"