Detailed search by GSTIN API
Introduction
Every GST Certificate holds a unique 15-digit alphanumeric GST Identification Number or GSTIN for the business. This is just like the ID number on any other ID card. Using the GSTIN Based Search API, Signzy uses its proprietary algorithms to extract the details of the GSTIN-registered business and its owner.
API Usecase
Similar to GSTIN Search API, the detailed search is designed with the objective of generating even more details about the business and its owner using the GSTIN.
The following information will be extracted :
- Reference ID
- TIN Number
- Registration Type
- Constitution of business
- Legal name of business
- Trade name of business
- Centre Jurisdiction
- State Jurisdiction
- Registration Date
- Date of tax payment
- Tax payer type
- Cancellation date
- Nature of business activities
- Principal place of address
How to call the API
You will need to login before sending GSTIN request. You are required to pass the access token received from the login call, as authorization header in the GSTIN request along with GSTIN Number
API Input Guidelines
Provide unique 15-digit alphanumeric GSTIN issued by Goods and Services Tax department
curl --location --request POST 'https://signzy.tech/api/v2/patrons/<Patron ID>/gstns' \
--header 'Content-Type: application/json' \
--header 'Authorization: <Token>' \
--data-raw '{
"task" : "detailedGstinSearch",
"essentials": {
"gstin": "<GSTIN Number>",
""
}
}'Response parameters
PARAMETER NAME | DESCRIPTION |
|---|---|
task | The type of task to be performed - "Detailed GSTIN Search" |
essentials | This parameter contains the essential data for generating output. |
essentials.gstin | The GST identification number that is required for the GST Search. |
id | The access token that was received during login request. |
patronId | This parameter is returned as userId parameter of login request. |
result | The final response parameters are displayed here. |
result.gstnDetailed This parameter provides detailed information about the owner/business to which the GST number has been assigned. | This parameter provides detailed information about the owner/business to which the GST number has been assigned. |
result.gstnRecords | The detailed information associated with the records of the GST number are contained in this parameter. |
gstnRecords.regType | The type of registration done for the GST number being searched is displayed by this parameter. |
gstnRecords.gstinRefId | The reference ID associated with the GSTIN is contained in this parameter. |
gstnRecords.applicationStatus | The current status of the application of the GST number. |
gstnRecords.registrationName | The registration name of the individual/business owner associated with the GST number. |
gstnRecords.mobNum | The mobile number of the individual/ business owner associated with the GST number. |
gstnRecords.emailId | The email ID of the individual/ business owner associated with the GST number. |
gstnRecords.gstin | The GST identification number for which PAN number is being searched. |
gstnDetailed.constitutionOfBusiness | This parameter denotes the type of company or organisation i.e Public or Private Limited Company. |
gstnDetailed.legalNameOfBusiness | The legal name of the business as registered with the GST number. |
gstnDetailed.tradeNameOfBusiness | The trading/commercial name under which the company/organization operates. |
gstnDetailed.centreJurisdiction | This parameter assigns a code that depicts jurisdiction of the central government on the company. |
gstnDetailed.stateJurisdiction | This parameter assigns a code that depicts jurisdiction of the state government on the company. |
gstnDetailed.registrationDate | The date of registration of GST for the business/organization is displayed by this parameter. |
gstnDetailed.taxPayerDate | The due date for the taxpayer associated with the GST number. |
gstnDetailed.taxPayerType | This parameter denotes the type of taxpayer i.e regular taxpayer. |
gstnDetailed.gstinStatus | The current status of the GST identification number is active/inactive. |
gstnDetailed.cancellationDate | This parameter shows the date of cancellation for the GST if applicable. |
gstnDetailed.natureOfBusinessActivities | This parameter shows the type of business provider. Ex: Supplier of Services. |
gstnDetailed.principalPlaceLatitude | This parameter shows principal latitude |
gstnDetailed.principalPlace.Longitude | This parameter shows principal longitude |
gstnDetailed.principalPlaceStreet | This parameter shows principal street |
gstnDetailed.principalPlaceLocality | This parameter shows principal locality |
gstnDetailed.principalPlaceCity | This parameter shows principal city |
gstnDetailed.principalPlaceDistrict | This parameter shows principal district |
gstnDetailed.principalPlaceState | This parameter shows principal state |
gstnDetailed.principalPlacePincode | This parameter shows principal pincode |
gstnDetailed.additionalPlaceLatitude | This parameter shows additional latitude |
gstnDetailed..additionalPlaceLongitude | This parameter shows additional longitude |
gstnDetailed..additionalPlaceStreet | This parameter shows additional steet name |
gstnDetailed..additionalPlaceLoclity | This parameter shows additional locality |
gstnDetailed..additionalPlaceCity | This parameter shows additional city |
gstnDetailed..additionalPlaceDistrict | This parameter shows additional district |
gstnDetailed..additionalPlaceState | This parameter shows additional state |
gstnDetailed..additionalPlacePincode | This parameter shows additional pincode |
gstnDetailed.complianceRating | The compliance rating that has been assigned to the business/organization. |
gstnDetailed.directorNames | The names of the directors are contained in this parameter. |
gstnDetailed.principalPlaceAddress | This parameter contains the details of the principal address of the business/organization. |
principalPlaceAddress.emailId | The email ID of the business. |
principalPlaceAddress.address | The principal address of the business/organization. |
principalPlaceAddress.natureOfBusiness | The type of business/organization. |
principalPlaceAddress.mobile | The mobile number registered to the owner/business with the GST. |
principalPlaceAddress.lastUpdatedDate | This parameter contains the date when the details were last updated for the particular business/organization. |
principalPlaceAddress.splitAddress | This parameter distinguishes the various parts of the address of the principal place address into separate categories like district, state, city, pincode and country. For the country category, acceptable values are “IN”,”IND”and”INDIA”. |
gstnDetailed.additionalPlaceAddress | This parameter contains the details of the additional address of the business/organization. |
additionalPlaceAddress.emailId | The email ID of the additional place address of the business. |
additionalPlaceAddress.address | The additional address of the business/organization. |
additionalPlaceAddress.natureOfBusiness | The additional type of business/organization. |
additionalPlaceAddress.mobile | The mobile number registered to the additional address of the owner/business with the GST. |
additionalPlaceAddress.lastUpdatedDate | This parameter contains the date when the details were last updated for the additional place address of the particular business/organization. |
additionalPlaceAddress.splitAddress | This parameter distinguishes the various parts of the address of the additional place address into separate categories like district, state, city, pincode and country. For the country category, acceptable values are “IN”,”IND”and”INDIA”. |
splitaddress.addressLine | The first line of the registered principal/additional address is displayed by this parameter. |
gstnDetailed.gstin | The GST identification number. |
Getting help
Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.
You can reach out to us at [email protected].