# 获取用户安全等级

[调试诊断](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_tools)

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：getUserRiskRank

该接口用于根据提交的用户信息数据获取用户的安全等级 risk_rank（无需用户授权）。详见[用户安全解决方案](/miniprogram/dev/framework/operation.md)。

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/wxa/getuserriskrank?access_token=ACCESS_TOKEN
```

> **支持加密请求：** 本接口支持服务通信二次加密和签名，可有效防止数据篡改与泄露。[查看详情](/miniprogram/dev/server/getting_started/api_signature.md)

### 云调用

- 调用方法：riskControl.getUserRiskRank

- 出入参和 HTTPS 调用相同，调用方式可查看 [云调用](/doc/oplatform/developers/dev/cloudCall.md) 说明文档。

### 第三方调用

- 本接口不支持第三方平台调用。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "说明": "接口调用凭证，可使用 [access_token](/minigame/dev/api-backend/access-token/api_getaccesstoken)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "appid",
    "类型": "string",
    "必填": "是",
    "说明": "小程序appid"
  },
  {
    "参数名": "openid",
    "类型": "string",
    "必填": "是",
    "说明": "用户的openid"
  },
  {
    "参数名": "scene",
    "类型": "number",
    "必填": "是",
    "说明": "场景值，0:注册，1:营销作弊, 2:UGC"
  },
  {
    "参数名": "mobile_no",
    "类型": "string",
    "必填": "否",
    "说明": "用户手机号"
  },
  {
    "参数名": "client_ip",
    "类型": "string",
    "必填": "是",
    "说明": "用户访问源ip"
  },
  {
    "参数名": "email_address",
    "类型": "string",
    "必填": "否",
    "说明": "用户邮箱地址"
  },
  {
    "参数名": "extended_info",
    "类型": "string",
    "必填": "否",
    "说明": "额外补充信息"
  },
  {
    "参数名": "is_test",
    "类型": "boolean",
    "必填": "否",
    "说明": "默认值false。false：正式调用，true：测试调用"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  },
  {
    "参数名": "risk_rank",
    "类型": "number",
    "说明": "用户风险等级，合法值为0,1,2,3,4，数字越大风险越高。"
  },
  {
    "参数名": "unoin_id",
    "类型": "number",
    "说明": "唯一请求标识，标记单次请求"
  }
]
```

## 4. 注意事项

本接口无特殊注意事项

## 5. 代码示例

### 5.1 HTTPS请求示例

请求示例

```json
{
  "appid": "wx*******",
  "openid": "*****",
  "scene": 1,
  "mobile_no": "12345678",
  "bank_card_no": "******",
  "cert_no": "*******",
  "client_ip": "******",
  "email_address": "***@qq.com",
  "extended_info": ""
}
```

返回示例

```json
{
  "errcode": 0,
  "errmsg": "getuserriskrank succ",
  "risk_rank": 0,
  "unoin_id": 123456
}
```

### 5.2 云函数调用示例

请求示例

```json
const cloud = require('wx-server-sdk')
cloud.init({
  env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.riskControl.getUserRiskRank({
        "appid": 'wx*******',
        "openid": '*****',
        "scene": 1,
        "mobileNo": '12345678',
        "bankCardNo": '******',
        "certNo": '*******',
        "clientIp": '******',
        "emailAddress": '***@qq.com',
        "extendedInfo": ''
      })
    return result
  } catch (err) {
    return err
  }
}
```

返回示例

```json
{
  "errCode": 0,
  "errMsg": "openapi.riskControl.getUserRiskRank:ok",
  "riskRank": 0,
  "unoinId": 123456
}
```

## 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "-1",
    "错误描述": "system error",
    "解决方案": "系统繁忙，此时请开发者稍候再试"
  },
  {
    "错误码": "40001",
    "错误描述": "invalid credential  access_token isinvalid or not latest",
    "解决方案": "access_token 无效或不为最新获取的 access_token，请开发者确认access_token的有效性"
  },
  {
    "错误码": "40003",
    "错误描述": "invalid openid",
    "解决方案": "不合法的 OpenID ，请开发者确认 OpenID 的有效性"
  },
  {
    "错误码": "40129",
    "错误描述": "invalid scene",
    "解决方案": "场景值错误（目前支持场景 0 注册；1 营销作弊；2 UGC）"
  },
  {
    "错误码": "41001",
    "错误描述": "access_token missing",
    "解决方案": "缺少 access_token 参数"
  },
  {
    "错误码": "42001",
    "错误描述": "access_token expired",
    "解决方案": "access_token 超时，请检查 access_token 的有效期，请参考基础支持 - 获取 access_token 中，对 access_token 的详细机制说明"
  },
  {
    "错误码": "43002",
    "错误描述": "require POST method",
    "解决方案": "方法调用错误，请用 post 方法调用"
  },
  {
    "错误码": "43104",
    "错误描述": "The openid does not match the appid",
    "解决方案": "appid与 openid 不匹配"
  },
  {
    "错误码": "44002",
    "错误描述": "empty post data",
    "解决方案": "POST 的数据包为空。post请求body参数不能为空。"
  },
  {
    "错误码": "47001",
    "错误描述": "data format error",
    "解决方案": "解析 JSON/XML 内容错误;post 数据中参数缺失;参数需以 JSON 字符串格式写在post请求的 body 中，请检查修正后重试"
  },
  {
    "错误码": "48001",
    "错误描述": "api unauthorized",
    "解决方案": "小程序无该 api 权限，可在mp.weixin.qq.com开通接口权限"
  },
  {
    "错误码": "61007",
    "错误描述": "api is unauthorized to component",
    "解决方案": "小程序尚未将对应的权限集授权给第三方平台"
  },
  {
    "错误码": "61010",
    "错误描述": "code is expired",
    "解决方案": "用户访问记录超时（用户未在近两小时访问小程序）"
  },
  {
    "错误码": "61080",
    "错误描述": "the service of getuserriskrank is unavailable now",
    "解决方案": "当前用户安全服务不可用"
  },
  {
    "错误码": "61081",
    "错误描述": "get riskrank too frequently",
    "解决方案": "用户安全接口调用过于频繁"
  },
  {
    "错误码": "9410009",
    "错误描述": "the quota is not enough;please apply again!",
    "解决方案": "测试额度已耗尽"
  }
]
```

## 7. 适用范围

本接口暂未明确可调用账号类型，或在业务中根据调用传参自行确定是否可调用，请以实际调用情况为准。