# 上传业务方纯活体验证唯一流水号
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:getuseridkey
小程序后台根据「业务方系统内部纯活体验证唯一流水号」调用getuseridkey接口获取纯活体检测唯一标识user_id_key字段,并提供给小程序前端调用wx.startLivenessDetection接口使用。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/cityservice/face/liveness/getuseridkey?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用。
# 第三方调用
- 本接口不支持第三方平台调用。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| out_seq_no | string | 是 | 业务方系统内部流水号,要求5-32个字符内,只能包含数字、大小写字母和_-字符,且在同一个appid下唯一。 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| user_id_key | string | 纯活体检测唯一标识,用于后台交互表示该请求的凭证 |
| expires_in | number | user_id_key有效期,过期需重新获取 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
无
返回示例
{
"errcode": 0,
"errmsg": "ok",
"user_id_key" : "xxxx",
"expires_in": 3600
}
# 6. 错误码
此接口没有特殊错误码,可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
# 7. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请以实际调用情况为准。