Search Taxpayer GET Call

URL

Refer to API Ecosystem and NIC API document to form the correct URL .

The below example is provided for version: v1.3

The HTTP method required is: GET

The endpoint you shall be accessing is: <base_url>/gus/commonapi/v1.3/search?gstin={gstin}&action={action}

Headers

The headers will look somewhat like follows.

Name	Value
clientid	<your-client-id>
client-secret	<your-client-secret>
Content-Type	application/json
X-Asp-Auth-Token	<your-X-Asp-Auth-Token>
X-Asp-Auth-Signature	<your-X-Asp-Auth-Signature>

Note

To construct the X-Asp-Auth-Token is covered in greater details in building-a-vayana-gsp-auth-token

If cust-id is assigned then it is not required to pass clientid and client-secret in request headers.

Sample Response payload

To Understand how Response payloads should be, refer to GST Developer Portal

{
  "stjCd": "AP003",
  "lgnm": "MS CORPORATION",
  "stj": "BCP KODIKONDA",
  "dty": "Regular",
  "cxdt": "",
  "gstin": "05ABNTY3290P8ZA",
  "einvoiceStatus": "Yes",
  "nba": [
    "Bonded Warehouse",
    "EOU / STP / EHTP",
    "Factory / Manufacturing",
    "Input Service Distributor (ISD)",
    "Leasing Business"
  ],
  "lstupdt": "05/01/2017",
  "rgdt": "05/05/2017",
  "ctb": "Foreign LLP",
  "sts": "Provisional",
  "ctjCd": "AP004",
  "ctj": "BCP THUMMAKUNTA",
  "tradeNam": "ALTON PLASTIC PRIVATE LTD",
  "adadr": [
    {
      "addr": {
        "bnm": "ELPHINSTONE BUILDING",
        "st": "10, VEER NARIMAN ROAD",
        "loc": "FORT",
        "bno": "10",
        "stcd": "Rajasthan",
        "flno": "1ST FLOOR",
        "lt": "74.2179",
        "lg": "27.0238",
        "pncd": "400001"
      },
      "ntr": [
        "Wholesale Business"
      ]
    }
  ],
  "pradr": {
    "addr": {
      "bnm": "KATGARA HOUSE",
      "st": "15, L JAGMOHANDAS MARG",
      "loc": "MALABAR HILL",
      "bno": "5",
      "stcd": "Maharashtra",
      "flno": "4TH FLOOR",
      "lt": "74.2179",
      "lg": "27.0238",
      "pncd": "400006"
    },
    "ntr": [
      "Wholesale Business"
    ]
  }
}

Note

In case of any error, desired response will not be received as above. Here are some few error codes in case of any such error found

FO8001  Malformed Request
FO8007  Invalid GSTIN/UIN