e-Invoice Authentication

e-Invoice Authentication API takes API credentials set on the e-Invoice portal (NIC) and gives the e-Invoice access token in response. If you have not created API credentials, follow the steps here to create them.

POST /gst/compliance/e-invoice/tax-payer/authenticate

cURL

200 Authenticated

curl --request POST \
  --url https://api.sandbox.co.in/gst/compliance/e-invoice/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"
}
'

200

200 Authenticated

{
  "code": 200,
  "data": {
    "ErrorDetails": null,
    "InfoDtls": null,
    "Status": 1,
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ0YXhwYXllci1zZXNzaW9uIiwiZ3N0aW4iOiIyNEFCS0NTMjAzM0IxWlYiLCJpYXQiOjE3MTI5NDQxMDAsImV4cCI6MTcxMjk0NzcxMX0.sandbox-signature",
    "expiry": 1708693832000
  },
  "timestamp": 1763446641000,
  "transaction_id": "db0435d0-2a7d-42b2-9b44-94eef880bf60"
}

Request body schema

View request body schema

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

password · string · required

username · string · required

gstin · string · required

Required string length: 15

Pattern: ^([0-9]{2}[0-9A-Z]{13})$

Response

200 - application/json

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

Option 1

Option 2

Option 3

Authentication success, NIC business error, or platform error. These variants use HTTP 200.

code · enum<integer> · required

HTTP-compatible Sandbox response code.

Available options: 200

timestamp · integer<int64> · required

Unix timestamp in milliseconds.

transaction_id · string · required

Request transaction identifier.

data · object · required

Show child attributes