/check/check_black_info

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

1.API Specification

This API is used to query a person's blacklist history through his mobile number and other personal related parameters.

Request Method

POST

Request URL

https://cloudapi.indonesia.accuauth.com/check/check_black_info

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

Fields Type Description
option mobile string Mobile number
option mobile_md5 string MD5 value of mobile number, you can use this parameter instead of mobile
option idcard string ID card number
option bankcard string Bankcard number
option gaid string Google Advertising ID or Apple IDFV
option email string Email address

Note: Either parameter mobile or mobile_md5 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 request success, other if failed; See Error Codes for details
result array blacklist history
Element in result:
Fields Type Description
field str Field to query by, depending on your paramter
result bool Hit result, true: hit; false: not hit
in_black_reason int Reason for the hit, 0: default value when not hit; 1: Overdue; 2: external data source; 3: for risk reason
Response Syntax
{
  "status": "OK",
  "result": [
    {
      "field": "mobile",
      "result": true,
      "in_black_reason": 1
    },
    {
      "field": "idcard",
      "result": false,
      "in_black_reason": 0
    },
    {
      "field": "bankcard",
      "result": false,
      "in_black_reason": 0
    },
    {
      "field": "gaid",
      "result": false,
      "in_black_reason": 0
    },
    {
      "field": "email",
      "result": false,
      "in_black_reason": 0
    }
  ],
  "request_id": "TID591cb9fb0e284cf296912a4d0ffea889"
}

4.Error Codes

Common error codes of this API:

Http Status Code Status field Description
400 INVALID_ARGUMENT Request parameter is invalid
400 NOT_HIT Target is not in the blacklist
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': not found",
    "request_id": "TID0bb59f6aa6454717b870b16202ccf36f"
}

5.Sample

results matching ""

    No results matching ""