/verify/indian_pan
1.API Specification
2.Request Params
3.Response Params
4.Error Codes
5.Sample
1.API Specification
This API is used to verify Indian pan card.
For a basic version of this API, please see: /verify/indian_pan_lite
Request Method
POST
Request URL
https://cloudapi.accuauth.in/verify/indian_pan
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 |
string |
The PAN number |
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 verification result |
3.1 Elements in `result`
| Fields |
Type |
Description |
| pan_number |
string |
The PAN number |
| pan_status |
string |
VALID or INVALID |
| first_name |
string |
First name of the PAN holder |
| last_name |
string |
Last name of the PAN holder |
| middle_name |
string |
Middle name of the PAN holder |
| pan_holder_title |
string |
Title of the PAN holder |
| pan_last_updated |
string |
Last updated date of the PAN |
3.2 Result Codes
| Value |
Description |
Billable |
| 101 |
Valid authentication |
Yes |
| 102 |
Invalid ID number or combination of inputs |
Yes |
| 103 |
No records found for the given ID or combination of inputs |
No |
| 104 |
Max retries exceeded |
No |
| 105 |
Missing Consent |
No |
Response Syntax
{
"request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e",
"status": "OK",
"result": {
"pan_number": "***",
"pan_status": "VALID",
"last_name": "***",
"first_name": "***",
"middle_name": "***",
"pan_holder_title": "<Shri/MR/MRS etc>",
"pan_last_updated": "<DD/MM/YYYY>"
},
"result_code": 101,
"result_message": "Success"
}
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': not found",
"request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}
5.Sample