Overview

This method provides the tax payer details for a given GSTIN number.

The format and details of GetGSTIN API request is depicted in following table.

URL

<URL>/gstvital/v1.01/Master/gstin/29ABCDE1234B1Z1

Content-Type

application/json

Method

GET

URL Parameters

GSTIN

URL Parameter Description

GSTIN – GSTIN number for which the details 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 Get GSTIN Details API request(values 1-Success and 0- Failure)
Data If Status is 1
Gstin GSTIN for which the details are provided
TradeName Trade Name of the GSTIN .
LegalName Legal Name of the GSTIN
Address1 Address
Address2 Address
StateCode State Code
PinCode PIN code
ErrorDetails If Status is ‘0’
ErrorCode Unique error code
ErrorMessage Error Description
InfoDtls Any additional message to be conveyed would be passed.

Sample Json for GetGSTIN (GSTIN details)

Get GSTIN Response

{
"status":"1",
"data":"pqO4DZbmV374giihBU2i8IyAIwstG5K0jajoEwb5H9Cy33aEji2MAnSauFeTduDqin/WASDoWoT9rx04Z4fNZ40NqFMq4QqqtqOXXpd7aqsl13wX0lW3EwuMpncLAm6cu5J9aylFY1ULRmQpy/aL9js/xnWcVzDdjEYXW3+OsYwB+jk4XX7jynDbtaSlHXc4","rek":"ieJ8YYyua7HW9tpJc7HtNirzoQAS5kMPIi+KEUOyvEgWGDsjNkiwEB76t4u5rai7","hmac":"mFJ+1oFDKg233BLYP9QZjHN+mLJd9YCGz7JJWqwN6no=",
"ErrorDetails": null,
"InfoDtls":"<alert message >"
}

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

    {
      "Gstin":"29AWGPV7107B1Z1",
      "TradeName":"VIKAS EXPORTS",
      "LegalName":"VIKASEXPORTS ",
      "AddrBnm":"RAMANAGARA",
      "AddrBno":"562160",
      "AddrFlno":"",
      "AddrSt":"",
      "AddrLoc":"CHANNAPATNA",
      "StateCode":29,
      "AddrPncd":562160,
      "TxpType":"REG",
      "Status":"ACT",
      "BlkStatus":null
    }

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