/check/blacklist/o2
1.API Specification
2.Request Params
3.Response Params
4.Error Codes
5.Sample
1.API Specification
This API is used to check if someone is on the blacklist by at least one number of mobile/panNo/bankCard/imei/email.
Request Method
POST
Request URL
https://cloudapi.accuauth.in/check/blacklist/o2
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
| Fields | Type | Description | |
|---|---|---|---|
| optional | mobile_no | string | Mobile number of a person |
| optional | aadhaar_no | string | Aadhaar number of a person |
| optional | pan_no | string | Pan number of a person |
| optional | bank_card_no | string | Bank card number of a person |
| optional | imei | string | IMEI code of a person's mobile |
| optional | string | Email address of a person |
One of the above fields must be provided as a request parameter.
3.Response Params
| Fields | Type | Description |
|---|---|---|
| request_id | string | Unique id of each request |
| status | string | Response status, OK if hit success, other if failed; See Error Codes for details |
| result_code | int | 4000: target is not hit; 4001: target is hit |
| result_message | string | result message |
Response Syntax
- When target is hit
{
"status": "OK",
"result_code": 4001,
"result_message": "Hit blacklist",
"request_id": "TID591cb9fb0e284cf296912a4d0ffea889"
}
- When target is not hit
{
"status": "NOT_HIT",
"result_code": 4000,
"result_message": "Miss blacklist",
"request_id": "TIDcd85e0df9451457f90147a994edf9647"
}
4.Error Codes
Common error codes of this API:
| Http Status Code | Status field |
Description |
|---|---|---|
400 |
NOT_HIT | Miss blacklist |
400 |
INVALID_ARGUMENT | Request parameter is invalid |
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 |
Comment: Please see the reason field for details when the above 40X error occurred
Response Syntax
{
"status": "INVALID_ARGUMENT",
"reason": "no valid param is provided",
"request_id": "TIDef7b0d24569949a8b7a907eea16c509a"
}