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

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

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

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.