# 获取用户安全等级

调试诊断

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:getUserRiskRank

该接口用于根据提交的用户信息数据获取用户的安全等级 risk_rank(无需用户授权)。详见用户安全解决方案

# 1. 调用方式

# HTTPS 调用

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

支持加密请求: 本接口支持服务通信二次加密和签名,可有效防止数据篡改与泄露。查看详情

# 云调用

  • 调用方法:riskControl.getUserRiskRank

  • 出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档

# 第三方调用

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

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填说明
access_tokenstring接口调用凭证,可使用 access_token

# 请求体 Request Payload

参数名类型必填说明
appidstring小程序appid
openidstring用户的openid
scenenumber场景值,0:注册,1:营销作弊
mobile_nostring用户手机号
client_ipstring用户访问源ip
email_addressstring用户邮箱地址
extended_infostring额外补充信息
is_testboolean默认值false。false:正式调用,true:测试调用

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息
risk_ranknumber用户风险等级,合法值为0,1,2,3,4,数字越大风险越高。
unoin_idnumber唯一请求标识,标记单次请求

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

# 5.1 HTTPS请求示例

请求示例

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

返回示例

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

# 5.2 云函数调用示例

请求示例

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
  }
}

返回示例

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

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。

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

# 7. 适用范围

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