生态文档
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

小程序人脸核身接入文档 .md 3.6KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. # 人脸核身
  2. ### 注意事项
  3. - 获取结果的方式分为 **请求url传回** 和 **重定向带回**
  4. - **请求url传回** 通常适用于“业务端”与“验证端”在不同设备,例如pc端做业务,手机端扫码进入活体核身;**重定向带回** 通常适用于“业务端”与“验证端”在同一浏览器窗口。
  5. - 请调用方根据业务情景选择获取结果的方式
  6. ### 调用流程
  7. 1. 接入方调用 `faceCheckInit` 接口初始化人脸小程序sdk
  8. | 参数名称 |类型|传入/传出| 说明 |
  9. | -------- |--------|-------- |-------- |
  10. | errcode | int | 传出 |非0为异常情况 |
  11. | errmsg | **String** |传出 | 异常情况下的错误信息|
  12. 2. 初始化成功后,调用 `applyUrlToken` 接口换取token(该接口其它参数详见[接口文档](https://docs.qq.com/doc/DWHpQRUZiUk5wSGZa))
  13. | 参数名称 |类型| 说明 |
  14. | -------- |--------|-------- |
  15. | action | String |固定传空 |
  16. | bizContent | **String** | 见下表bizContent参数,**注意将json对象转字符串** |
  17. | bizContent参数 |是否必传| 说明 |
  18. | -------- | -------- | -------- |
  19. | mode |是| 视频类型<br/>动作活体:ACTION<br/>数字活体:LIP<br/>静默活体:SILENT |
  20. | idNum |条件必传| 身份证号 |
  21. | name |条件必传| 姓名 |
  22. | origin |条件必传| 图片文件类型<br/> base64传输:self<br/>来自文件服务器:fds (**带压缩效果,推荐使用,详见[fds使用文档](../file/文件服务器接口.md))**<br/>链接:uri |
  23. | data |条件必传| 文件内容(base64,文件服务器文件名或链接) |
  24. | | | **idNum和name一组,origin和data一组,两组数据必传一组,不能同时传两组** |
  25. | feedback |是| 传url链接,根据feedbackWay的值使用该链接 |
  26. | feedbackWay |否| feedback的使用方式<br/>redirect:**重定向带回**,人脸验证完成重定向回feedback; <br/>空:**请求url传回**,人脸验证完成post feedback 的url带回结果|
  27. 2. 收到token后,调用方传入token信息,调用`startFaceCheck`方法采集人脸,完成核身流程,生态平台查询并存储核身结果,然后给调用方返回Id\Key\Token信息,调用方通过Id\Key\Token调用 `feedback2UrlToken` 接口换取核验结果。
  28. `startFaceCheck`接口
  29. | 参数名称 |类型|传入/传出| 说明 |
  30. | -------- |--------|-------- |-------- |
  31. | token | String | 传入 |访问token,上一步申请的token |
  32. | errcode | int | 传出 |非0为异常情况 |
  33. | errmsg | **String** |传出 | 异常情况下的错误信息|
  34. ### 获取结果
  35. * 请求url传回
  36. * 用户录完视频得到核验结果后,浏览器将带上以下三个参数post请求 feedback的url。
  37. | 参数名称 | 类型 | 说明 |
  38. | -------- | -------- | -------- |
  39. | token | String | 访问token,上一步申请的token |
  40. | id | String | 对应的反馈信息id,回调时反馈 |
  41. | key | String | 对应的反馈信息密钥,回调时反馈 |
  42. * 得到三个参数后,调用方调用 `feedback2UrlToken` 接口换取核验结果(详见[接口文档](https://docs.qq.com/doc/DWHpQRUZiUk5wSGZa))
  43. * 页面显示核验结果
  44. * 重定向带回
  45. * 用户录完视频得到核验结果后,浏览器将feedback拼接上token,id,key三个参数,再跳回到新的feedback。
  46. ` [feedback]?token=[######]&id=[######]&key=[######]`
  47. * 得到三个参数后,调用方调用 `feedback2UrlToken` 接口换取核验结果(详见[接口文档](https://docs.qq.com/doc/DWHpQRUZiUk5wSGZa))