Skip to content

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’: v3.0
  • method: GET

URL Parameters#

Name Description Type
flynn-version version of the API
for example, v3.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

{
  "status": "1",
  "data": {
    "gstin": "27ASJPC0786C3C7",
    "lgnm": "Vay Network Services Pvt Ltd",
    "stj": "State - Maharashtra,Zone - Nagpur,Division - AMRAVATI (Jurisdictional Office)",
    "stjCd": "MH001",
    "ctj": "Commissionerate - AGARTALA,Range - AGARTALA II RANGE",
    "ctjCd": "UX0102",
    "rgdt": "01/07/2017",
    "ctb": "Proprietorship",
    "dty": "Tax Collector (Electronic Commerce Operator)",
    "nba": null,
    "sts": "Active",
    "cxdt": "",
    "lstupdt": null,
    "tradeNam": "GSTN",
    "adadr": null,
    "pradr": {
      "addr": {
        "bnm": "Gold Hill Supreme",
        "st": "Shantipura Cross Roads",
        "loc": "Electronic City Phase 2",
        "bno": "252",
        "stcd": "Maharashtra",
        "dst": "",
        "city": null,
        "flno": "",
        "lt": "",
        "lg": "",
        "pncd": "400123"
      },
      "ntr": null
    }
  },
  "error": null,
  "info": null,
  "additionalInfo": null,
  "alert": null
}
Errors#

Invalid GSTIN Format

{
  "status": "0",
  "data": null,
  "error": {
    "message": "err-invalid-gstin-format",
    "type": "ClientRequest",
    "args": {
      "parameter-name": "gstin"
    }
  },
  "info": null,
  "additionalInfo": null,
  "alert": null
}

GSTN Error

 {
  "status": "0",
  "data": null,
  "error": {
    "message": "err-gstn-returned-error",
    "type": "Gstn",
    "args": {
      "gstn-err": {
        "status-code": "0",
        "error-code": "RET11402",
        "message": "Unauthorized User"
      }
    }
  },
  "info": null,
  "additionalInfo": null,
  "alert": null
}
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.