注意
如果因自身业务需要对人脸核身的影像文件进行存储或其他用途,请合作方务必自行保存订单号,通过订单号拉取人脸核身的影像文件是唯一方式。
生成签名
准备步骤
下载 SDK,请到控制台自助接入列表页获取密码。
Normal 插件地址:https://ext.dcloud.net.cn/plugin?id=1491
前置条件:请合作方确保 SIGN ticket 已经正常获取,获取方式请参见 获取 SIGN ticket。
SIGN 类型的 ticket,其有效期为60分钟,且可多次使用。
合作方为人脸核身服务生成签名,需要具有下表中的参数:
参数 | 说明 | 来源 |
appId | 业务流程唯一标识 | |
userId | 用户唯一标识,同一个用户的 userId 请保持一致,不同用户请不要使用同一个userId,我们会根据 userId 来做防重复点击优化以及登录态校验 | 合作方自行分配,需跟用户绑定,32位以内,不包含特殊字符 |
version | 参数值为:1.0.0 | - |
ticket | 合作伙伴服务端获取的 ticket,注意是 SIGN 类型 | 获取方式请参见 获取 SIGN ticket |
nonce | 必须是32位随机数 | 合作方自行生成 |
注意
参与签名的数据需要与使用该签名的 SDK 中的请求参数保持一致。
基本步骤
1. 生成一个32位的随机字符串 nonce(其为字母和数字,登录时也要用到)。
2. 将 appId、userId、version 连同 ticket、nonce 共五个参数的值进行字典序排序。
3. 将排序后的所有参数字符串拼接成一个字符串。
4. 将排序后的字符串进行 SHA1 编码,编码后的40位字符串作为签名(sign)。
注意
参考示例
请求参数:
参数 | 参数值 |
appId | IDAXXXXX |
userId | userID19959248596551 |
nonce | kHoSxvLZGxSoFsjxlbzEoUzh5PAnTU7T |
version | 1.0.0 |
ticket | XO99Qfxlti9iTVgHAjwvJdAZKN3nMuUhrsPdPlPVKlcyS50N6tlLnfuFBPIucaMS |
字典排序后的参数为:
[1.0.0, IDAXXXXX, XO99Qfxlti9iTVgHAjwvJdAZKN3nMuUhrsPdPlPVKlcyS50N6tlLnfuFBPIucaMS, kHoSxvLZGxSoFsjxlbzEoUzh5PAnTU7T, userID19959248596551]
拼接后的字符串为:
1.0.0IDAXXXXXXO99Qfxlti9iTVgHAjwvJdAZKN3nMuUhrsPdPlPVKlcyS50N6tlLnfuFBPIucaMSkHoSxvLZGxSoFsjxlbzEoUzh5PAnTU7TuserID19959248596551
计算 SHA1 得到签名:
该字符串就是最终生成的签名(40位),不区分大小写。
D7606F1741DDCF90757DA924EDCF152A200AC7F0
合作方后台上传身份信息
请求
请求 URL:https://kyc1.qcloud.com/api/server/getfaceid?orderNo=xxx
注意
为方便查询耗时,该请求 url 后面请拼接 orderNo 订单号参数。
请求方法:POST
报文格式:Content-Type: application/json
请求参数:
参数 | 说明 | 类型 | 长度(字节) | 是否必填 |
appId | String | 8 | 是 | |
orderNo | 订单号,字母/数字组成的字符串,由合作方上传,每次唯一,不能超过32位 | String | 不能超过32位 | 是 |
name | 姓名 | String | - | 使用权威源比对时:姓名+证件号必须输入 使用自带源比对时:姓名+证件号可不输入 |
idNo | 证件号码 | String | - | 使用权威源比对时:姓名+证件号必须输入 使用自带源比对时:姓名+证件号可不输入 |
userId | 用户 ID ,用户的唯一标识(不能带有特殊字符),需要跟生成签名的 userId 保持一致。同一个用户的 userId 请保持一致,不同用户请不要使用同一个userId,我们会根据 userId 来做防重复点击优化以及登录态校验 | String | 不能超过32位 | 是 |
sourcePhotoStr | 比对源照片,注意:原始图片不能超过500k,且必须为 JPG 或 PNG、BMP 格式。 参数有值:使用合作伙伴提供的比对源照片进行比对,必须注意是正脸可信照片,照片质量由合作方保证 参数为空 :根据身份证号 + 姓名使用权威数据源比对 | BASE64 String | 1048576 | 否,非必填请使用标准的图片转 base64方法,base64编码不可包含换行符,不需要加前缀 注意:只有您需要使用自带比对源比对时上传,使用权威比对源比对时请不要上传该字段 |
sourcePhotoType | 比对源照片类型 参数值为1 时是:水纹正脸照 参数值为 2 时是:高清正脸照 重要提示:照片上无水波纹的为高清照,请勿传错,否则影响比对准确率。 如有疑问,请联系腾讯云技术支持线下确认 | String | 1 | 否,提供比对源照片需要传 注意:只有您需要使用自带比对源比对时上传,使用权威比对源比对时请不要上传该字段 |
version | 默认参数值为:1.0.0 | String | 20 | 是 |
sign | 签名:使用上面生成的签名 | String | 40 | 是 |
nonce | 随机数 | String | 32 | 是 |
水纹照示例
响应
响应参数:
参数 | 类型 | 说明 |
code | String | 0:成功 非0:失败 |
msg | String | 请求结果描述 |
bizSeqNo | String | 请求业务流水号 |
orderNo | String | 订单编号 |
faceId | String | 此次刷脸用户标识,调 SDK 时传入 |
响应示例:
{"code": "0","msg": "请求成功","bizSeqNo": "业务流水号","result": {"bizSeqNo": "业务流水号","transactionTime": "20201019110305","orderNo": "合作方订单号","faceId": "175177e03bc53d57222418e18c731488","success": false},"transactionTime": "20201019110305"}
说明
success:false 无意义,合作伙伴可忽略,无需处理。
faceId 有效期为5分钟,每次进行人脸核身都需要重新获取。