e-Invoice Authentication

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": "<string>",
  "password": "<string>",
  "gstin": "<string>"
}
'

{
  "code": 200,
  "data": {
    "Data": null,
    "ErrorDetails": [
      {
        "ErrorCode": "1015",
        "ErrorMessage": "Invalid GSTIN for this user"
      }
    ],
    "InfoDtls": null,
    "Status": 0,
    "access_token": "{{$headers 'authorization'}}",
    "error": {
      "error_cd": "GEN5008",
      "message": "GSTN Server Error"
    },
    "expiry": 1708693832000,
    "status_cd": "0"
  },
  "timestamp": 1763446641000,
  "transaction_id": "474bfffc-7f59-4f01-b658-454f36028cd3"
}

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": "<string>",
  "password": "<string>",
  "gstin": "<string>"
}
'

{
  "code": 200,
  "data": {
    "Data": null,
    "ErrorDetails": [
      {
        "ErrorCode": "1015",
        "ErrorMessage": "Invalid GSTIN for this user"
      }
    ],
    "InfoDtls": null,
    "Status": 0,
    "access_token": "{{$headers 'authorization'}}",
    "error": {
      "error_cd": "GEN5008",
      "message": "GSTN Server Error"
    },
    "expiry": 1708693832000,
    "status_cd": "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

Show child attributes

data.Data

unknown

data.ErrorDetails

object[] | null

Show child attributes

data.ErrorDetails.ErrorCode

string

Example:

"1015"

data.ErrorDetails.ErrorMessage

string

Example:

"Invalid GSTIN for this user"

Example:

[
  {
    "ErrorCode": "1015",
    "ErrorMessage": "Invalid GSTIN for this user"
  }
]

data.InfoDtls

unknown

data.Status

number

Example:

0

data.access_token

string

Example:

"{{$headers 'authorization'}}"

data.error

object

Show child attributes

data.error.error_cd

string

Example:

"GEN5008"

data.error.message

string

Example:

"GSTN Server Error"

data.expiry

number

Example:

1708693832000

data.status_cd

string

Example:

"0"

timestamp

number

Example:

1763446641000

transaction_id

string

Example:

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

Create API credentials

Generate e-Invoice

⌘I

Analytics

Compliance

Headers

Query Parameters

Body

Response