/check/blacklist/o1
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 mobile number.
Request Method
POST
Request URL
https://cloudapi.accuauth.in/check/blacklist/o1
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 | |
|---|---|---|---|
| required | mobile_no | string | MD5 value of the mobile number with country code, example: md5(915586685366) |
| optional | count | int | Hit count threshold, default is 3; Hits greater than or equal to the threshold will be considered a blacklisted user |
| optional | date | string | Backtrack start time, format: YYYY-MM-DD, default is current date |
3.Response Params
| Fields | Type | Description |
|---|---|---|
| request_id | string | Unique id of each request |
| status | string | Response status, OK if request success, other if failed; See Error Codes for details |
| result | object | Check result，See result belowed for details |
Elements in result:
| Fields | Type | Description |
|---|---|---|
| target | string | Hit result, true: hit; false: not hit |
| target_days | list | List of hit dates, format such as: ["2022-10-03", "2022-10-01"], it is returned only when target is true |
Response Syntax
- When target is hit
{
"status": "OK",
"result": {
"target": true,
"target_days": [
"2022-10-03",
"2022-10-01"
]
},
"request_id": "TID591cb9fb0e284cf296912a4d0ffea889"
}
- When target is not hit
{
"status": "NOT_HIT",
"reason": "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": "argument 'mobile_no': not found",
"request_id": "TID0bb59f6aa6454717b870b16202ccf36f"
}