Search GSTIN

Overview

The Search GSTIN API takes in the gstin of a business entity and provides you the information of *the business entities as registered on the GST Portal.

Endpoint

HTTP Method

Resource

Description

GET

/gsp/public/gstin/:gstin

Returns GSTIN entity for given GSTIN

API EndpointAPI Endpoint

Usecase

Problem

  • You require information from the GST Portal to verify an entity before onboarding them on your workflow.
  • You wish to cross-check the information provided to you against the information available on the GST Portal using this API.

Solution

  • The Search GSTIN API provides you with the necessary information to verify the entity
  • An E-commerce platform has to verify businesses coming onboard on their platform. By cross-checking the information provided by the API, the E-commerce platform can verify the businesses.

Making the API call

You would only require the GSTIN of the entity to get their business information. These would be passed as path parameters.

Path Parameters

Param

Type

Description

Example

gstin

string

15-character alphanumeric unique identifier assigned to business entities registering under the GST regime

24AAACJ3770E2ZV

Once the values are added, Your curl will look something like this

curl --location --request GET 'https://api.sandbox.co.in/gsp/public/gstin/24AAACJ3770E2ZZ' \
--header 'Authorization: eyJhbGciOiJIUzUxMiJ9.eyJhdWQiOiJBUEkiLCJyZWZyZXNoX3Rva2VuIjoiZXlKaGJHY2lPaUpJVXpVeE1pSjkuZXlKaGRXUWlPaUpCVUVraUxDSnpkV0lpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1Gd2FWOXJaWGtpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1semN5STZJbUZ3YVM1eGRXbGphMjh1WTI5dElpd2laWGh3SWpveE5Ua3dPVFk1TmpBd0xDSnBiblJsYm5RaU9pSlNSVVpTUlZOSVgxUlBTMFZPSWl3aWFXRjBJam94TlRVNU16UTNNakF3ZlEueHNmYkhQTERFRlRvTy1OUWdaUUpLM25OUjFxdlhvWmhaOHRqS3gzSExydjZiVkJaMHpJZEZ5ai1MUTg1YnJZS0xXQnFnZHlzZ1NDSXlDUXNtV2VOYkEiLCJzdWIiOiJqb2huQGRvZS5jb20iLCJhcGlfa2V5Ijoia2V5X2xpdmVfQWRlKioqKioqKioqKioqKioqKioqKioqKioqKipVeHMiLCJpc3MiOiJhcGkucXVpY2tvLmNvbSIsImV4cCI6MTU5MTA1NjAwMCwiaW50ZW50IjoiQUNDRVNTX1RPS0VOIiwiaWF0IjoxNTkwOTY5NjAwfQ.nH23CR5RHGQ0U19I_vq3vyJ_85A1a2iEMQij5QHgJQdDuS9x7FmTidsr1CQabSFF5ujE40SFxHv1gJM20TauUw' \
--header 'x-api-key: key_live_Ade**************************Uxs' \
--header 'x-api-version: 3.4.0'

📘

Test this API

We provide Test Data for this API. You can access it on the endpoint page. Note that you need to use your test keys with this data.

Response

The response would have the following params

Param

Type

Description

Example

lgnm

string

Legal Name of Business

JOHN DOE PRIVATE LIMITED

stj

string

State Jurisdiction

Ghatak 9 (Ahmedabad)

ctj

string

Centre Jurisdiction

RANGE I

rgdt

string

Date of Registration

01/07/2017

ctb

string

Constitution of Business

Private Limited Company

dty

string

Taxpayer type

Regular

nba

string

Nature of Business Activity

Service Provision

sts

string

GSTN status

Active

cxdt

string

Date Of Cancellation

lstupddt

string

Last Updated Date

14/04/2018

stjCd

string

State Jurisdiction Code

GJ009

ctjCd

string

Centre Jurisdiction Code

WS0601

tradeNam

string

Trade Name

John Doe Private Limited

adadr

string

Additional Place of Business Fields

[]

pradr

object

Pricipal Place of Business fields

Look Below :point-down:

addr

object

Pricipal Place of Business Address

Look Below :point-down:

bnm

object

Building Name

ABC Lakeview Tower

st

string

Street

Opp. Vastrapur Lake

loc

string

Location

Vastrapur

bno

string

Door Number

123

stcd

string

State name

Gujarat

flno

string

Floor Number

1

lt

string

Lattitude

1231231231

lg

string

Longitude

1231223121

pncd

string

Pin Code

380015

ntr

string

Nature of pricipal place of Business

Service Provision

gstin

string

GSTIN of the entity

dist

string

district

city

string

city

Let's go over the response table

  • The pradr and addr objects will provide the principal place of business address which is registered with the GST portal.

  • ntr provides the nature of pradr. In the example above, the address is for service provision.

  • The response also provides the legal name of the business in lgnm, as well as the state and centre jurisdiction (stj & ctj) along with their respective codes (stjCd & cjCd)

  • We can also see when the entity was registered (rgdt), canceled if applicable (cxdt), and lstupddt tells us when was the last time their details were updated.

  • tradeNam provides the trade name of the entity, while nba tells the nature of the business activity. Taxpayer type (dty) & constitution of business (ctb) are given to us as well.

Wallet Charge

Since Track GST Return is a Paid APIs, a wallet charge of INR 0.25 + GST per API call will be applicable.


What’s Next

Click below to go on Search GSTIN Endpoint

Did this page help you?