Search Taxpayer Details

Search Taxpayer Detail API fetches all public information available with GSTN portal. This information was given during the time of GST Registration of the Taxpayer. All you need to check out the latest version which GSTN has released for the api for an environment (ie production and sandbox).

Route

/basic/gstn/{flynn-version}/commonapi/{gstn-api-version}/search?gstin={gstin}&action={action}

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

URL Parameters

Name	Description	Type
flynn-version	version of the API for example, v2.0	string
gstn-api-version	as per the version of the GST API Documentation for example, v0.3	string

QUERY Parameters

Name	Description	Type
gstin	GSTIN of the taxpayer for example, 33GSPTN0791G1Z5	string
action	Api action for example, TP	string

Headers

All required headers to make an authenticated API call.

Response

200

Successful response will be the same payload as per the ‘GST API Documentation’ for the “Search Taxpayer” API.

Sample Response Body

{
    "data" : "{\"gstin\":\"33GSPTN0791G1Z5\",\"lgnm\":\"Vayana TN TaxPayer 1 Ltd\",\"stj\":\"ADYAR\",\"stjCd\":\"TN001\",\"ctj\":\"ALLAHABAD-I\",\"ctjCd\":\"0101\",\"rgdt\":\"01/07/2017\",\"ctb\":\"Proprietorship\",\"dty\":\"Regular\",\"nba\":null,\"sts\":\"Active\",\"cxdt\":null,\"lstupdt\":\"20/03/2017\",\"tradeNam\":\"Vayana TN TaxPayer 1 Ltd\",\"adadr\":null,\"pradr\":null,\"isFieldVisitConducted\":null}"
}

Errors

Invalid GSTIN Format

{
  "error": {
    "message" : "err-invalid-gstin-format",
    "type": "ClientRequest",
    "args": {
       "parameter-name": "gstin"
     }
  }
}

GSTN Error

{
  "error" : {
    "message" : "err-gstn-returned",
    "type" : "Gstn",
    "args" : {
      "status-code" : "0",
      "gstn-err" : {
        "code" : "AUTH103",
        "message" : "Invalid Auth Token"
      }
    }
  }
}

Response Status	Description
400	Invalid GSTIN format in the request
400	Invalid GSTN API Version
404	Invalid GSTIN
502	Error at GSTN end

Common Errors

check here for other common errors.