/check/check_black

1.API Specification

This API is used to check whether a person is in the blacklist through his mobile number and other personal related parameters.

POST

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

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

	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.

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	bool	Whether the user is hit

{
    "status": "OK",
    "result": true,
    "request_id": "TID591cb9fb0e284cf296912a4d0ffea889"
}

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

{
    "status": "INVALID_ARGUMENT",
    "reason": "argument 'mobile': not found",
    "request_id": "TID0bb59f6aa6454717b870b16202ccf36f"
}