Overview

This method provides the tax payer details for a given GSTIN number.

The format and details of GetGSTIN API request is depicted in following table.

URL

<URL>/api/GetGSTINDetails

Content-Type

application/json

Method

GET

URL Parameters

GSTIN

URL Parameter Description

GSTIN – GSTIN number for which the details are required

Request Payload

Request Header

Attributes Description

client_id

client id to be provided by E-Invoice System

client_secret

client secret to be provided by E-Invoice System

Gstin

GSTIN of the authenticated user

user_name

User name of the authenticated user

AuthToken

Authorization Token

Response Payload

Attributes Description
Status Status of the Get GSTIN Details API request(values 1-Success and 0- Failure)
Data If Status is 1
Gstin GSTIN for which the details are provided
TradeName Trade Name of the GSTIN .
LegalName Legal Name of the GSTIN
Address1 Address
Address2 Address
StateCode State Code
PinCode PIN code
ErrorDetails If Status is ‘0’ (Base64encoded)
ErrorCode Unique error code
ErrorMessage Error Description
Info Any additional message to be conveyed would be passed. It will be Base64 encoded string.

Sample Json for GetGSTIN (GSTIN details)

Get GSTIN Response

{
"status":"1",
"data":"pqO4DZbmV374giihBU2i8IyAIwstG5K0jajoEwb5H9Cy33aEji2MAnSauFeTduDqin/WASDoWoT9rx04Z4fNZ40NqFMq4QqqtqOXXpd7aqsl13wX0lW3EwuMpncLAm6cu5J9aylFY1ULRmQpy/aL9js/xnWcVzDdjEYXW3+OsYwB+jk4XX7jynDbtaSlHXc4","rek":"ieJ8YYyua7HW9tpJc7HtNirzoQAS5kMPIi+KEUOyvEgWGDsjNkiwEB76t4u5rai7","hmac":"mFJ+1oFDKg233BLYP9QZjHN+mLJd9YCGz7JJWqwN6no=",
"ErrorDetails": null,
"Info":"<alert message in base 64 encoded format>"
}

"data" JSON (corresponds to the data element of GetGSTIN Response(Success))

{
"gstin":"29AKLPM8755F1Z2",
"tradeName":"XYZ Traders",
"legalName":"NICTEST",
"address1":"SOME STREET",
"address2":"SOME CITY",
"stateCode":"29",
"pinCode":"560079"
}

JSON(in case of error)


"status": "0",
"Data": null,
"ErrorDetails":"<Errors JSON in base64 encoded format>",
"info": "<alert message in base 64 encoded format>"
}

On decoding (Base64), the “ErrorDetails” attribute above, the following JSON array can be obtained

[{
"ErrorCode": "110",
"ErrorMessage": "Invalid Client-ID/Client-Secret"
}]

Validations

  1. An attribute "status" has been Added('ACT' or 'CNL' or 'INA' or 'PRO')
  2. An attribute "blkStatus" has been Added
    i) 'U' or ' ' for Unblocked
    ii) 'B' for blocked