生态文档
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 5.2KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138
  1. ### 注意事项
  2. 1. 以下接口请求头必须加入`Authorization`,值为授权token([如何获取token](../core/Token使用文档.md))
  3. 2. 接口数据格式 `Json`
  4. ### 合作方后台上传身份信息
  5. > 合作方后台上传身份信息,活体+比对需传入自带源照片;活体+核身需传入姓名、身份证号<br>
  6. > 请求方式 ` POST http://172.20.109.105:7007/tech/ai/face/faceAdv` <br>
  7. | 请求参数 || 类型 | 是否必填 | 说明 |
  8. | --- | --- |--- | --- | --- |
  9. | async || boolean| 否 | 是否开启异步反馈模式,默认为false |
  10. | extData || | 否 | 附加参数登记,详见[接口调用附加信息登记](./接口调用附加信息登记.md) |
  11. | userId || String| 是 | 用户ID ,用户的唯一标识(不能带有特殊字符)。<br/>同一个用户的 userId 请保持一致,不同用户请不要使用同一个userId |
  12. | type || String| 是 | 活体+自带源比对传入 match <br/>活体+权威源比对传入 authmatch |
  13. | sourcePhotoStr || -| - | 活体+自带源比对时必须传入 |
  14. || origin | String| 否 | sourcePhotoStr的数据类型。<br/> base64字符串:self (**base64内容需在400k以内**)<br/>来自文件服务器:fds (**带压缩效果,推荐使用,详见[fds使用文档](../file/文件服务器接口.md))**<br/>图片链接:uri <br/>默认为 self |
  15. || data | String| 是 | 图片数据(base64,文件服务器文件路径或链接) |
  16. | name || String| 否 | 姓名,活体+权威源比对时必须传入 |
  17. | idNo || String| 否 | 身份证号,活体+权威源比对时必须传入 |
  18. | 返回参数 || | 类型 | 是否必返 | 说明 |
  19. | --- | --- | --- |--- | --- | --- |
  20. | errcode ||| Num| 是 | 0交易成功<br>其它为异常情况 |
  21. | errmsg ||| String | 否 | errcode不为0时有值 |
  22. | data| || - | - | 包含数据见下 |
  23. | |status || String | 是 | “SUCCESS”为业务成功 |
  24. | |traceNo || String | 是 | 当前业务的唯一id |
  25. | |result|| String | 是 | 业务结果 |
  26. | ||bizSeqNo | String | 否 | 业务流水号 |
  27. | ||orderNo | String | 否 | 订单编号 |
  28. | ||faceId | String | 否 | 此次刷脸用户标识,调 SDK 时传入 |
  29. | ||sign | String | 否 | 签名 |
  30. | ||nonce | String | 否 | 随机数 |
  31. | ||appId | String | 否 | 业务流程唯一标识,即 WBappid |
  32. 请求示例
  33. ```
  34. {
  35. "async":false,
  36. "userId":"user123",
  37. "type":"match",
  38. "sourcePhotoStr":{
  39. "origin":"fds",
  40. "data":"xxxxxxxxxxxxxx.jpg"
  41. }
  42. }
  43. ```
  44. 返回示例
  45. ```
  46. {
  47. "errcode":0,
  48. "data":{
  49. "status":"SUCCESS",
  50. "traceNo":"45646513218465123",
  51. "result":{
  52. "bizSeqNo":"业务流水号",
  53. "orderNo":"合作方订单号",
  54. "faceId":"cc1184c3995c71a731357f9812aab988"
  55. },
  56. },
  57. "errmsg":"SUCCESS"
  58. }
  59. ```
  60. ### 人脸核身结果查询
  61. > 查询人脸核身结果<br>
  62. > 请求方式 ` POST http://172.20.109.105:7007/tech/ai/face/faceAdvResult`
  63. | 请求参数 || 类型 | 是否必填 | 说明 |
  64. | --- | ---| --- | --- | --- |
  65. | async || boolean| 否 | 是否开启异步反馈模式,默认为false |
  66. | extData || | 否 | 附加参数登记,详见[接口调用附加信息登记](./接口调用附加信息登记.md) |
  67. | orderNo || String| 是 | 订单编号 |
  68. | getFile || String| 否 | 是否需要获取人脸识别的视频和文件,值为1则返回视频和照片、值为2则返回照片、值为3则返回视频;其他则不返回 |
  69. | 返回参数 || | 类型 | 是否必返 | 说明 |
  70. | --- | --- | --- |--- | --- | --- |
  71. | errcode ||| Num| 是 | 0交易成功<br>其它为异常情况 |
  72. | errmsg ||| String | 否 | errcode不为0时有值 |
  73. | data| || - | - | 包含数据见下 |
  74. | |status || String | 是 | “SUCCESS”为业务成功 |
  75. | |traceNo || String | 是 | 当前业务的唯一id |
  76. | |result|| String | 是 | 业务结果 |
  77. | ||tencentCode | String | 否 | 腾讯返回错误码 |
  78. | ||tencentMsg | String | 否 | 腾讯返回错误信息|
  79. | ||bizSeqNo | String | 否 | 业务流水号|
  80. | ||transactionTime | String | 否 | 请求接口的时间|
  81. | ||orderNo | String | 否 | 订单编号|
  82. | ||liveRate | String | 否 | 活体检测得分|
  83. | ||similarity | String | 否 | 人脸比对得分|
  84. | ||occurredTime | String | 否 | 进行刷脸的时间|
  85. | ||photo | String | 否 | 人脸核身时的照片,base64 位编码|
  86. | ||video | String | 否 | 人脸核身时的视频,base64 位编码|
  87. | ||sdkVersion | String | 否 | 人脸核身时的 sdk 版本号|
  88. | ||trtcFlag | String | 否 | Trtc 渠道刷脸则标识"Y"|
  89. | ||appId | String | 否 | 腾讯云控制台申请的 appid|
  90. 请求示例
  91. ```
  92. {
  93. "async":false,
  94. "orderNo":"订单编号",
  95. "getFile":"2"
  96. }
  97. ```
  98. 返回示例
  99. ```
  100. {
  101. "errcode":0,
  102. "data":{
  103. "status":"SUCCESS",
  104. "traceNo":"45646513218465123",
  105. "result":{
  106. "tencentCode":"0",
  107. "tencentMsg":"请求成功",
  108. "bizSeqNo":"22041520001184442415491408594474",
  109. "orderNo":"testReflect1650008613761",
  110. "occurredTime":"20220415154341",
  111. "liveRate":"99",
  112. "similarity":"97.0",
  113. "photo":"*",
  114. "video":"*"
  115. },
  116. },
  117. "errmsg":"SUCCESS"
  118. }
  119. ```