/check/debts_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 debts report through his mobile number and other personal related parameters.
Request Method
POST
Request URL
https://cloudapi.indonesia.accuauth.com/check/debts_report
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 | 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 |
---|---|---|
reg_total_num | int | Total number of registrations |
apply_total_num | int | Total number of applications |
approved_total_num | int | Total number of approvals |
reject_total_num | int | Total number of rejections |
loan_total_num | int | Total number of loans |
apply_amount_min | float | The minimum amount applied for |
apply_amount_max | float | The maximum amount applied for |
apply_amount_avg | float | The average amount applied for |
loan_amount_min | float | The minimum amount of loan |
loan_amount_max | float | The maximum amount of loan |
loan_amount_avg | float | The average amount of loan |
platform_reg_total | int | Number of registered platforms |
platform_apply_total | int | Number of platforms applied for |
platform_approved_total | int | Number of Approved Platforms |
platform_reject_total | int | Number of rejected platforms |
platform_loan_total | int | Total number of loan platforms |
Response Syntax
{
"status": "OK",
"result": {
"reg_total_num": 24,
"apply_total_num ": 6,
"approved_total_num ": 2,
"reject_total_num ": 4,
"loan_total_num ": 2,
"apply_amount_min ": 4000,
"apply_amount_max ": 8000,
"apply_amount_avg ": 6000,
"loan_amount_min ": 3000,
"loan_amount_max ": 6000,
"loan_amount_avg ": 4500,
"platform_reg_total ": 7,
"platform_apply_total": 4,
"platform_approved_total ": 3,
"platform_reject_total ": 1,
"platform_loan_total ": 2
},
"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"
}