GST Authentication

Module ID

Name of the Module	Documents Supported
module_kyb_gst_authentication	GSTIN

Module Description

This module authenticates a 15 digit alphanumeric GSTIN input issued by the Goods and Service Tax Network in India and returns the details of the business associated with this GSTIN number.

Module Inputs

The following table provides the details of the parameter required for the module.

Parameter	Mandatory or Optional	Description
gstin	Mandatory	The unique 15-digit GSTIN value.

Module Configurations

This module does not support any additional configurations.

Module Outputs

The following section provides the sample and the corresponding details of the various responses you can expect from the module.

Success Response

You will receive a success response in a format similar to the following code if the GSTIN input is correct.

  {
 "status":"success",
 "statusCode":"200",
 "result":{
    "code":200,
    "data":{
       "gstin":"18AIBCB5518L1ZR",
       "stateJurisdictionCode":"AS035",
       "taxpayerType":"Regular",
       "stateJurisdiction":"GUWAHATI - A - 2",
       "legalName":"BKKAJ FINANCE LIMITED",
       "additionalPlaceOfBusiness":[
          {
             "addr":{
                "blockName":"",
                "street":"Moran Hut, Sd Complex, Nh 37 Moran, Moran Hat",
                "location":"Ps Khowang, Dist , Moran Assam, Dibrugarh",
                "doorNumber":"1st floor",
                "state":"Assam",
                "district":"Dibrugarh",
                "flatNumber":"",
                "latitude":"",
                "pincode":"786613",
                "longitude":""
             },
             "natureOfBusiness":"Supplier of Services"
          },
          {
             "addr":{
                "blockName":"",
                "street":"On Way Dhekilajuli, Tezpur Main Road",
                "location":"Opp. Indian Bank, Dhekiajuli",
                "doorNumber":"1st Floor, Ward No.6",
                "state":"Assam",
                "district":"Sonitpur",
                "flatNumber":"",
                "latitude":"",
                "pincode":"784110",
                "longitude":""
             },
             "natureOfBusiness":"Supplier of Services"
          }
       ],
       "dateOfCancellation":"",
       "natureOfBusinessAtAddress":[
          "Supplier of Services"
       ],
       "lastUpdated":"30/09/2021",
       "constitutionOfBusiness":"Public Limited Company",
       "registeredDate":"13/09/2017",
       "centralJurisdictionCode":"UQ0205",
       "status":"Active",
       "tradeName":"BKKAJ FINANCE LIMITED",
       "centralJurisdiction":"II-E RANGE"
    },
    "timestamp":1629119825803
 }

Success Response Details

A success response from the module reflects the success status with a status code of 200 and a result object containing the response data with the following attributes-value pair.

Attributes	Description	Values Returned
data	It returns the details of the business associated with the GSTIN number .	This is an object with values.

Failure Response Sample - Invalid GSTIN

You will receive an error response in a format similar to the following code sample if the request is correct but the module fails to find a match against the input.

  {
 "status":"failure",
 "statusCode":"422",
 "error":{
    "code":422,
    "message":"Invalid GSTIN pattern",
    "timestamp":1629118399096
 }
}

Failure Response Details

A failure response from the module contains a failure status with a relavant status code and error object. The following table lists the failure response values.

Status Code	message	Error Description
422	Invalid GSTIN pattern	The request has an incorrect GSTIN input.

Error Response Sample

You will receive an error response in a format similar to the following code if the request is incorrect.

  {
 "status":"failure",
 "statusCode":"400",
 "error":"gstin is required"
}

Error Response Details

An error response from the module contains a failure status, with a relavant status code and error message. The following table lists all error responses.

Status Code	Error	Error Description
400	gstin is required	The request did not have the gstin input.
504	Issue with external service	There is an issue with the service. Kindly contact the HyperVerge Team for support.

Additionally, you might receive the following error response if the credentials used in the request are incorrect.

Status Code	Code	Error Description
401	Missing/Invalid credentials	The request is either missing the mandatory credentials or has invalid credentials.