/check/risk_report

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 risk report through his mobile number and other personal related parameters.

Request Method

POST

Request URL

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

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 risk report
Element in result:
Fields Type Description
past_overdue_num int The number of historical overdue orders
past_overdue_rate float Historical overdue rate
past_overdue_amount_max float Historical maximum overdue amount
past_overdue_amount_min float Historical minimum overdue amount
past_overdue_amount_avg float Historical average overdue amount
past_overdue_amount_total float Total historical overdue amount
past_overdue_days_max int Historical maximum overdue days
past_overdue_days_min int Historical minimum overdue days
past_overdue_days_avg int Historical average overdue days
past_overdue_3days_num int The number of orders overdue for more than 3 days in history
past_overdue_3days_rate float Overdue rate of more than 3 days in history
past_overdue_5days_num int The number of orders overdue for more than 5 days in history
past_overdue_5days_rate float Overdue rate of more than 5 days in history
unsettled_overdue_num int The number of overdue unsettled orders
unsettled_overdue_amount_avg float Average amount of overdue for unsettled orders
unsettled_overdue_amount_min int Minimum amount of overdue for unsettled orders
unsettled_overdue_amount_max int Maximum amount of overdue for unsettled orders
unsettled_overdue_amount_total int Total amount of overdue for unsettled orders
unsettled_overdue_days_avg int Average number of days overdue for unsettled orders
unsettled_overdue_days_min int Minimum number of days overdue for unsettled orders
unsettled_overdue_days_max int Maximum number of days overdue for unsettled orders
Response Syntax
{
  "status": "OK",
  "result": {
    "past_overdue_num": 1,
    "past_overdue_rate": 0.5,
    "past_overdue_amount_max": 3000,
    "past_overdue_amount_min": 3000,
    "past_overdue_amount_avg": 3000,
    "past_overdue_amount_total": 3000,
    "past_overdue_days_max": 21,
    "past_overdue_days_avg": 21,
    "past_overdue_3days_num": 1,
    "past_overdue_3days_rate": 0.5,
    "past_overdue_5days_num": 1,
    "past_overdue_5days_rate": 0.5,
    "unsettled_overdue_num": 1,
    "unsettled_overdue_amount_avg": 3000,
    "unsettled_overdue_days_avg": 21,
    "past_overdue_days_min": 21,
    "unsettled_overdue_amount_min": 3000,
    "unsettled_overdue_amount_max": 3000,
    "unsettled_overdue_amount_total": 3000,
    "unsettled_overdue_days_min": 21,
    "unsettled_overdue_days_max": 21
  },
  "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 hit
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 ""