Get GSTIN details

Looks up a GSTIN on the GST portal and returns the registered business’s details. Useful for validating a party’s GSTIN and prefilling their name and address.

GET /v2/utils/gstin/{gstin}

Get GSTIN details

cURL

curl --request GET \
  --url https://app.getswipe.in/api/partner/v2/utils/gstin/{gstin} \
  --header 'Authorization: Bearer <token>'

200

{
  "success": false,
  "message": "",
  "error_code": "",
  "errors": {},
  "data": {
    "company_name": "XYZ Company",
    "trade_name": "XYZ Company",
    "legal_name": "XYZ Company",
    "status": "<string>",
    "is_sez": true,
    "is_ecom": true,
    "billing": {
      "address_1": "123 Street",
      "address_2": "Apt 4B",
      "city": "City Name",
      "pincode": "123456",
      "state": "State Name"
    }
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is an API key from the API Integration section of your dashboard. Keys are scoped to the company they are generated in — for testing, add a separate test company and generate the key there, so requests never touch your real books.

Path Parameters

gstin · string · required

GSTIN Number

Response

200

application/json

success

success · boolean

Success

Example:

false

message · string

Message

Example:

""

error_code · string

Error Code

Example:

""

errors · object

Error details

data · object

Show child attributes