/verify/v2/gst

1.API Specification
2.Request Params
3.Response Params
4.Error Codes
5.Sample

1.API Specification

This API is used to authenticate 15 Digit GSTIN.
For another version of gst verification API, please see: /verify/indian_gst

Request Method

POST

Request URL

https://cloudapi.accuauth.in/verify/v2/gst

Debugging Tool

Debugging Tool

2.Request Params

2.1 Request Header

Parameter Type Required Description
X-DF-API-ID string Yes For API credentials，Please visit API Request
X-DF-API-SECRET string Yes For API credentials，Please visit API Request

2.2 Request Body

Required Fields Type Description
required gstin string Unique GSTIN
required consent string This must be Y
required consent_text string Consent message

3.Response Params

Fields Type Description
request_id string Unique id of each request
status string Response status, OK for success request, Error Codes for failed request
result_code integer Result code, see Result Codes for detail
result_message string Result message
result object The verfication result

3.1 Elements in result

Fields Type Description
trade_nam string Trade name
rgdt string Registration date under GST
pradr object Primary business contact information including, pradr
stj string State Jurisdiction
ctj string Central Jurisdiction
dty string Taxpayer type
cmp_rt string Compliance rating if provided by GSP
cxdt string Date of cancellation of registration
ctb string Constitution of business (proprietorship, partnership, private limited company, public limited company etc)
sts string Current status of registration under GST
gstin string Given GSTIN
lgnm string Legal name of the business or individual corresponding to the GSTIN
nba stringArray Nature of business registered under GST
is_field_visit_conducted string Whether field is visit conducted
3.1.1 Elements in pradr
Fields Type Description
adr string Complete address

3.2 Result Code Description

Value Description Billable
101 Valid authentication Yes
102 Invalid ID number or combination of inputs Yes
Response Syntax
{
    "result": {
        "cmp_rt": "NA",
        "ctb": "Proprietorship",
        "ctj": "RANGE-III (Jurisdictional Office)",
        "cxdt": "",
        "dty": "Composition",
        "gstin": "27AKEPC61XXXXXX",
        "is_field_visit_conducted": "No",
        "lgnm": "XXX XXXXX XXXXXXX",
        "nba": [
            "Retail Business"
        ],
        "pradr": {
            "adr": "XXXX XXXXX"
        },
        "rgdt": "01/05/2017",
        "stj": "SANPADA_xxx",
        "sts": "Active",
        "trade_nam": "xxxxx xxx xxx"
    },
    "result_code": 101,
    "result_message": "Success",
    "status": "OK",
    "request_id": "TIDf06ad18308804acfb6db468c0a6f79c0"
}

4.Error Codes

Common error codes of this API:

Http Status Code Status Field Description
400 INVALID_ARGUMENT Request parameter is invalid
400 QUERY_FAILED Query failed
400 ABNORMAL_BEHAVIOURS_DETECTED Request with same parameters repeated more than amount of times
401 UNAUTHORIZED Unauthorized or access is denied
401 KEY_EXPIRED Your API ID has expired
403 NO_PERMISSION You are not authorized to use this API
403 OUT_OF_QUOTA API calls quota exceeded
403 RATE_LIMIT_EXCEEDED API request frequency exceeds the limit
404 NOT_FOUND Requested API cannot be found
500 INTERNAL_ERROR Internal server error
512 SOURCE_SERVICE_UNAVAILABLE Source service is unavailable
513 SOURCE_SERVICE_TIMEOUT Source service is timeout

Comment: Please see the reason field for details when the above 40X / 51X error occurred

Response Syntax
{
  "status": "INVALID_ARGUMENT",
  "reason": "argument 'gstin': not found",
  "request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}

5.Sample

results matching ""

    No results matching ""