Overview

This method provides the tax payer to Sync GSTIN details from Common Portal.

The format and details of Sync GSTIN Details from CP API request is depicted in following table.

URL

<URL>/eivital/v1.04/Master/syncgstin/<GSTIN>

Content-Type

application/json

Method

GET

URL Parameters

GSTIN

URL Parameter Description

GSTIN – GSTIN number for which tax payer to Sync GSTIN details from Common Portal are required

Request Payload

Request Header

Attributes Description

client_id

client id to be provided by E-Invoice System

client_secret

client secret to be provided by E-Invoice System

Gstin

GSTIN of the authenticated user

user_name

User name of the authenticated user

AuthToken

Authorization Token

Response Payload

Attributes Description
Status Status of the Sync GSTIN Details from CP API request(values 1-Success and 0- Failure)
Data If Status is 1
ErrorDetails If Status is ‘0’
InfoDtls Any additional message to be conveyed would be passed.

If Status is "1"

Data Base 64 encoded string of decrypted invoice JSON using Sek.
After decrypting Data the following attributes are obtained as below.
Attributes Description
Gstin GSTIN for which the details are provided
TradeName Trade Name of the GSTIN
LegalName Legal Name of the GSTIN
AddrBnm Address
AddrBno Address
AddrFlno Floor number
AddrSt Street
AddrLoc Location
StateCode State Code
AddrPncd PIN code
TxpType Taxpayer Type
BlkStatus Block Status
DtReg Date of Registration
DtDReg Date of De-registration

If Status is "0"

ErrorDetails Base 64 encoded string.
On decoding ErrorDetals the following attributes from JSON array are obtained as follows.
ErrorCode Unique error code
ErrorMessage Error Description

Sample Json for GetGSTIN (GSTIN details)

Get GSTIN Response

  {
    "Status":1,
    "ErrorDetails":null,
    "Data":"mY8nqjCrxs4/xvqc6lmDhAaGOPF1nFLnG4wmg0sG0/X652r9ARMlO2+F9WKdVpJNrtIO/hpG9/rFId4M8+mstMGvxcBVobhrc5uvcydkHOcdfXm+n9kaZ9zN3ieXh5hRztAOr5RnI/mp0keHglrO+ibOQ+pMso8CueabsDiOa0sT/KqIfDIWrbCojFdEy9sBUSjQMTsoe9Z+76vDXxgzquY+TyAGwrfmVTH++tDSGH/h/5KAqYqzTM/0L1MdtADjFOsHEkVhQ7tRSn97+N2OUElAjV4I51lhI3aaTKh6tTenFIjvQaxSnJDpLFuFeU1qLZG8VnlThKTowYHLrSVtoQ==",
    "InfoDtls":null
 }
            

"data" JSON (corresponds to the data element of GetGSTIN Response(Success))

    {
      "Gstin":"29AWGPV7107B1Z1",
      "TradeName":"VIKAS EXPORTS",
      "LegalName":"VIKASEXPORTS ",
      "AddrBnm":"RAMANAGARA",
      "AddrBno":"562160",
      "AddrFlno":"1st floor",
      "AddrSt":"6th main",
      "AddrLoc":"CHANNAPATNA",
      "StateCode":29,
      "AddrPncd":562160,
      "TxpType":"REG",
      "Status":"ACT",
      "BlkStatus":null,
      "DtReg":"05/03/2021",
      "DtDReg":"05/04/2021"
    }
   

JSON(in case of error)


"status": "0",
"Data": null,
"ErrorDetails":"<Errors JSON >",
"InfoDtls": "<alert message >"
}

Faq's

  1. "Status" will have values as 'ACT' (Active) or 'CNL' (Cancelled) or 'INA' (Inactive) or 'PRO' (Provision). Considered active only if status='ACT'
  2. The "blkStatus" indicates the status of blocking of generation of E Way Bill and will have following values
    i) 'U' or '' for Unblocked
    ii) 'B' for blocked - E Way Bill generation is not allowed for tax payers who have not filed the returns for last two months