# 获取用户人脸核身会话唯一标识
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:getVerifyId
业务方后台根据「用户实名信息(姓名+身份证)」调用 getVerifyId 接口获取人脸核身会话唯一标识 verifyId 字段,然后给到小程序前端调用 wx.requestFacialVerify 接口使用。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/cityservice/face/identify/getverifyid?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用。
# 第三方调用
- 本接口不支持第三方平台调用。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| out_seq_no | string | 是 | 用户身份信息 |
| cert_info | object | 是 | 用户身份信息 |
| openid | string | 是 | 用户身份标识 |
# Body.cert_info Object Payload
用户身份信息
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| cert_type | string | 是 | 证件类型,身份证填 IDENTITY_CARD |
| cert_name | string | 是 | 证件姓名 |
| cert_no | string | 是 | 证件号码 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| verify_id | string | 微信侧生成的人脸核身会话唯一标识,用于后续接口调用。长度不超过 256 字符 |
| expires_in | number | verify_id 有效期,过期后无法发起核身,默认值3600,单位:秒 |
# 4. 注意事项
用于生成 openid 的小程序 appid 一定要和前端调用 wx.requestFacialVerify 接口进行人脸核身时的小程序 appid 保持一致,不然就会人脸核身失败。
用于生成 verify_id 的 openid 用户身份标识一定要和前端调用 wx.requestFacialVerify 接口进行人脸核身时的用户身份保持一致,不然就会人脸核身失败。
# 5. 代码示例
请求示例
{
"out_seq_no": "xxx",
"cert_info": {
"cert_type": "xxx",
"cert_name": "xxx",
"cert_no": "xxx"
},
"openid": "xxx"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"verify_id": "verify_id_xxxx",
"expires_in": 3600,
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| 40003 | openid 无效 | |
| 84010 | 缺少 out_seq_no 参数 | |
| 84011 | out_seq_no 格式无效 | |
| 84012 | 缺少 cert_info 参数 | |
| 84013 | 证件类型无效 | |
| 84014 | 证件姓名无效 | cert_name 不能为空,且必须是 UTF-8 编码 |
| 84015 | 证件号码无效 | |
| 84016 | 缺少 openid 参数 | |
| 84019 | out_seq_no 已存在 | 更换新的 out_seq_no |
# 7. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请已实际调用情况为准。