/verify/search_gst
1.API Specification
2.Request Params
3.Response Params
4.Error Codes
5.Sample
1.API Specification
This API is used to search gstin numbers by taxplayer's PAN number.
Request Method
POST
Request URL
https://cloudapi.accuauth.in/verify/search_gst
Debugging Tool
2.Request Params
| 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 |
pan_no |
string |
The PAN number |
| 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 |
array |
The search result |
3.1 Elements of dict in result
| Fields |
Type |
Description |
| auth_status |
string |
Auth Status, Active or Inactive |
| gstin |
string |
Unique GSTIN |
| state |
string |
State code |
3.2 Result Code Description
| Value |
Description |
Billable |
| 101 |
Valid authentication |
Yes |
| 102 |
Invalid ID number or combination of inputs |
Yes |
Response Syntax
{
"result": [
{
"auth_status": "Active",
"gstin": "0818IND00XXXXXX",
"state": "08"
},
{
"auth_status": "Inactive",
"gstin": "0818IND00XXXXXX",
"state": "08"
}
],
"result_code": 101,
"result_message": "Success",
"status": "OK",
"request_id": "TIDa191aada069d4957b35e3a36d5e212ab"
}
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 'pan_no': not found",
"request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}
5.Sample