Skip to content

Sync Gstin#

Given an GSTIN, you can sync its details from the GSTN common portal using this API.

Route

/basic/einv/{flynn-version}/{irp}/eivital/{e-invoice-api-version}/Master/syncgstin/{GSTIN}

  • active ‘flynn-version’: v1.0
  • method: GET

URL Parameters#

Name Description Type
flynn-version version of the API
for example, v1.0		 string
irp IRP Provider as per GST registration for e-invoicing enum (ni1, ni2)
e-invoice-api-version E-invoice API version string
GSTIN GSTIN Number string

Headers#

All headers as mentioned in the Basic E-Invoice API introduction.

Tip

The only valid value for the header key accept is application/json.

Also, since no request body is sent, header key Content-type is optional.

Response#

200:#

Successful response will be the same payload as per the ‘E-Invoice API Documentation’ published by NIC.

Sample Response Body

{
  "data": "{\"Gstin\":\"27GSPMH1881G1ZH\",\"TradeName\":\"GSTN2 MH TaxPayer 1 Ltd\",\"LegalName\":\"GSTN2 MH TaxPayer 1 Ltd\",\"AddrBnm\":\"\",\"AddrBno\":\"\",\"AddrFlno\":\"\",\"AddrSt\":\"\",\"AddrLoc\":\"\",\"StateCode\":\"27\",\"AddrPncd\":0,\"TxpType\":\"REG\",\"Status\":\"ACT\",\"BlkStatus\":null,\"DtReg\":null,\"DtDReg\":null}"
}
404:#

When the Gstin isn’t found.

Sample Response Body

{
  "error": {
    "message": "err-resource-not-found",
    "type": "ResourceNotFound",
    "args": {
      "gstin": "27AAAPI3182M098"
    }
  }
}

Other e-invoice errors are mentioned under common errors.

Notes#

IRP - nic is deprecated. Instead of it please use ni1 or ni2