Overview

This API provides taxpayer details from the GST Portal for the given gstin.

Endpoint

HTTP Method	Resource
`GET`	/irp/tax-payer/gstin?gstin={gstin}

Request

Follow the below guidelines to pass GSTIN in path parameters to call the API.

Headers

Param	Type	Description	Example
x-api-key	`string`	An API key is a public key to identify users when calling any Sandbox API.	key_live_ZUQT5UEf4......
Authorization	`string`	JWT Authorization token which is generated using e-Invoice Authentication API.	eyJhsebihGyUf......

Query Parameter

Param	Type	Description	Example
gstin	`string`	15-character alphanumeric unique identifier assigned to business entities registering under the GST regime. GSTIN of the business whose details are required.	24AAACJ3770E2ZV

Sample CURL Request

curl --request GET \
     --url 'https://api.sandbox.co.in/irp/tax-payer/gstin?gstin=22AAAAA0000A1Z5' \
     --header 'Authorization: xxxxxxxxxx' \
     --header 'accept: application/json' \
     --header 'x-api-key: xxxxxxxxxx' \
     --header 'x-api-version: 1.0'

❗️
Test Environment Not Available

Response

Param	Type	Description	Example
Gstin	`string`	GSTIN for which the details are provided	29AWGPV7107B1Z1
TradeName	`string`	Trade Name of the GSTIN .	VIKAS EXPORTS
LegalName	`string`	Legal Name of the GSTIN	VIKAS EXPORTS
AddrBnm	`string`	Address	RAMANAGARA
AddrBno	`string`	Address	562160
AddrFlno	`string`	Floor number	1st floor
AddrSt	`string`	Street	6th main
AddrLoc	`string`	Location	CHANNAPATNA
StateCode	`num`	State Code	29
AddrPncd	`num`	PIN code	562160
TxpType	`string`	Taxpayer Type	REG
BlkStatus	`string`	Block Status	null
DtReg	`string`	Date of Registration	2021-05-03
DtDReg	`string`	Date of De-registration	2021-05-04

Response Caching

Response caching is not available for this API. Learn more about our response caching mechanism here

Wallet Charges

Since the Get GSTIN Details API is a Paid API, a wallet charge of INR 0.25 + GST will take place.

Versioning

This API is currently in major version 1.0. Refer to our versioning policies here