Common request and response parameters for Risk Identification API - Fraud Detection

Common request parameters

Risk Identification API requests include both common request parameters, which are required for all API operations, and service-specific event parameters. The following table describes the common request parameters.

Parameter	Type	Required	Description
Format	String	Yes	The format of the response. Valid values: JSON (default) XML
Version	String	Yes	The API version. The value must be in the YYYY-MM-DD format. The current version is 2019-05-21.
AccessKeyId	String	Yes	The access key ID that Alibaba Cloud provides for you to access the service.
Signature	String	Yes	The signature string. For more information about calculating the signature, see Section 2.0 in Call with an SDK.
SignatureMethod	String	Yes	The signature method. Only HMAC-SHA1 is supported.
Timestamp	String	Yes	The request timestamp, which must be in ISO 8601 format and UTC. The format is `yyyy-MM-ddTHH:mm:ssZ`. For example, 09:44:35 on August 22, 2019 (Beijing time) is represented as `2019-08-22T01:44:35Z`.
SignatureVersion	String	Yes	The version of the signature algorithm. Set the value to `1.0`.
SignatureNonce	String	Yes	A unique random number to prevent replay attacks. You must use a different value for each request.
Action	String	Yes	The value must be `ExecuteRequestSG` (for Singapore) or `ExecuteRequestML` (for Malaysia).
Service	String	Yes	The service code provided by Alibaba Cloud Security. Do not customize this value. The following list describes the service codes: Device Fraud Detection: `device_risk_intl` Device Fraud Detection - Enhanced Edition: `device_risk_intl_pro` Register Fraud Detection Service: `account_abuse_intl` Enhanced Registration Risk Identification: `account_abuse_intl_pro` Advertise Fraud Detection Service: `coupon_abuse_intl` Enhanced Marketing Risk Identification: `coupon_abuse_intl_pro` Email Risk: `email_risk` IP Risk Intelligence: `risk_intelligence_ip_intl`
ServiceParameters	String	Yes	The service-specific event parameters in JSON format. Example: `{"accountId":10123**** ...other request parameters for this event}`. Refer to the following topics for the parameters of each service: Event parameters and technical details of Device Risk Identification Features and parameters of Registration Risk Identification Features and parameters of Marketing Risk Identification Events and response parameters of Email Risk Events and response parameters of IP Risk Intelligence

The following example shows a request for the Device Fraud Detection - Enhanced Edition service:

    https://saf.{region}.aliyuncs.com/
    ?Format=JSON
    &Version=2019-05-21
    &Signature=vpEEL0zFHfxXYzSFV0n7%2FZiFL9o%3D 
    &SignatureMethod=Hmac-SHA1
    &SignatureNonce=15215528852396
    &SignatureVersion=1.0
    &Action=ExecuteRequest
    &AccessKeyId=123****saf 
    &Timestamp=2018-06-01T12:00:00Z
    &Service=device_risk_pro
    &ServiceParameters={"deviceToken":1012****}

Common response parameters

Every API request returns a unique identifier, RequestId, regardless of whether the call is successful. Other response parameters, such as score, tags, and extend, vary by service. For more information, see the documentation for the specific service.

The following example shows a JSON response for the Device Fraud Detection - Enhanced Edition service:

{
  //service: device_risk_pro
  
 "RequestId": "52E3208D-E7BF-32F0-9913-2A168894D2D9",
 "Message": "OK",
 "Data": {
  		"extend": "0f533f6056f50664b48f2b3866220f0f", // Unique device ID
 		 	"tags": "is_rooted" // Reason code
 },
 "Code": 200 // The request was successful.
}

Note

The sample responses in this topic are formatted for readability. The actual responses do not include line breaks or indentation.

Error codes

Code	Description
200	The request was successful.
400	The `ServiceParameters` (event parameters) are invalid.
402	The number of queries per second (QPS) exceeds the configured limit, triggering throttling.
403	Permission denied. The service may not be activated or could have expired.
404	The `Service` parameter is invalid.
500	An internal server error occurred.