上传文件至 'AI'

AI/腾讯人脸增强版接口.md

@@ -0,0 +1,138 @@
+### 注意事项
+1. 以下接口请求头必须加入`Authorization`，值为授权token([如何获取token](../core/Token使用文档.md))
+2. 接口数据格式 `Json`
+
+### 合作方后台上传身份信息
+> 合作方后台上传身份信息，活体+比对需传入自带源照片；活体+核身需传入姓名、身份证号<br>
+> 请求方式  ` POST http://172.20.109.105:7007/tech/ai/face/faceAdv` <br> 
+
+
+| 请求参数  || 类型 | 是否必填 | 说明 |
+| --- | --- |--- | --- | --- | 
+| async || boolean| 否 | 是否开启异步反馈模式，默认为false |
+| extData  || | 否 | 附加参数登记，详见[接口调用附加信息登记](./接口调用附加信息登记.md) |
+| userId || String| 是 | 用户ID ，用户的唯一标识（不能带有特殊字符)。<br/>同一个用户的 userId 请保持一致，不同用户请不要使用同一个userId  | 
+| type || String| 是 | 活体+自带源比对传入 match <br/>活体+权威源比对传入 authmatch | 
+| sourcePhotoStr || -| - | 活体+自带源比对时必须传入 |
+|| origin | String| 否 | sourcePhotoStr的数据类型。<br/> base64字符串：self (**base64内容需在400k以内**)<br/>来自文件服务器：fds （**带压缩效果，推荐使用，详见[fds使用文档](../file/文件服务器接口.md)）**<br/>图片链接：uri <br/>默认为 self |
+|| data | String| 是 | 图片数据（base64，文件服务器文件路径或链接） |
+| name || String| 否 | 姓名，活体+权威源比对时必须传入 | 
+| idNo || String| 否 | 身份证号，活体+权威源比对时必须传入 | 
+
+
+| 返回参数  || | 类型 | 是否必返 | 说明 |
+| --- | --- | --- |--- | --- | --- |
+| errcode ||| Num| 是 | 0交易成功<br>其它为异常情况 |
+| errmsg ||| String | 否 | errcode不为0时有值 | 
+| data| || - | - | 包含数据见下 |
+| |status || String | 是 | “SUCCESS”为业务成功 |
+| |traceNo || String | 是 | 当前业务的唯一id |
+| |result|| String | 是 | 业务结果 |
+| ||bizSeqNo | String | 否 | 业务流水号 |
+| ||orderNo | String | 否 | 订单编号 |
+| ||faceId | String | 否 | 此次刷脸用户标识，调 SDK 时传入 |
+| ||sign | String | 否 | 签名 |
+| ||nonce | String | 否 | 随机数 |
+| ||appId | String | 否 | 业务流程唯一标识，即 WBappid |
+
+请求示例
+
+```
+{
+     "async":false,
+     "userId":"user123",
+     "type":"match",
+     "sourcePhotoStr":{
+         "origin":"fds",
+         "data":"xxxxxxxxxxxxxx.jpg"
+     }
+}
+```
+
+返回示例
+
+```
+{
+    "errcode":0,
+    "data":{
+        "status":"SUCCESS",
+        "traceNo":"45646513218465123",
+        "result":{
+            "bizSeqNo":"业务流水号"，
+            "orderNo":"合作方订单号", 
+            "faceId":"cc1184c3995c71a731357f9812aab988"
+        }, 
+    },
+    "errmsg":"SUCCESS"
+}
+```
+
+### 人脸核身结果查询
+> 查询人脸核身结果<br>
+> 请求方式  ` POST http://172.20.109.105:7007/tech/ai/face/faceAdvResult`
+
+| 请求参数  || 类型 | 是否必填 | 说明 |
+| --- | ---| --- | --- | --- | 
+| async || boolean| 否 | 是否开启异步反馈模式，默认为false |
+| extData  || | 否 | 附加参数登记，详见[接口调用附加信息登记](./接口调用附加信息登记.md) |
+| orderNo || String| 是 | 订单编号 |
+| getFile || String| 否 | 是否需要获取人脸识别的视频和文件，值为1则返回视频和照片、值为2则返回照片、值为3则返回视频；其他则不返回 |
+
+
+| 返回参数  || | 类型 | 是否必返 | 说明 |
+| --- | --- | --- |--- | --- | --- |
+| errcode ||| Num| 是 | 0交易成功<br>其它为异常情况 |
+| errmsg ||| String | 否 | errcode不为0时有值 | 
+| data| || - | - | 包含数据见下 |
+| |status || String | 是 | “SUCCESS”为业务成功 |
+| |traceNo || String | 是 | 当前业务的唯一id |
+| |result|| String | 是 | 业务结果 |
+| ||tencentCode | String | 否 | 腾讯返回错误码 |
+| ||tencentMsg | String | 否 | 腾讯返回错误信息|
+| ||bizSeqNo | String | 否 | 业务流水号|
+| ||transactionTime | String | 否 | 请求接口的时间|
+| ||orderNo | String | 否 | 订单编号|
+| ||liveRate | String | 否 | 活体检测得分|
+| ||similarity | String | 否 | 人脸比对得分|
+| ||occurredTime | String | 否 | 进行刷脸的时间|
+| ||photo | String | 否 | 人脸核身时的照片，base64 位编码|
+| ||video | String | 否 | 人脸核身时的视频，base64 位编码|
+| ||sdkVersion | String | 否 | 人脸核身时的 sdk 版本号|
+| ||trtcFlag | String | 否 | Trtc 渠道刷脸则标识"Y"|
+| ||appId | String | 否 | 腾讯云控制台申请的 appid|
+
+请求示例
+
+```
+{
+     "async":false,
+     "orderNo":"订单编号",
+     "getFile":"2"
+}
+```
+
+返回示例
+
+```
+{
+    "errcode":0,
+    "data":{
+        "status":"SUCCESS",
+        "traceNo":"45646513218465123",
+        "result":{
+            "tencentCode":"0",
+            "tencentMsg":"请求成功",
+            "bizSeqNo":"22041520001184442415491408594474",
+            "orderNo":"testReflect1650008613761",
+            "occurredTime":"20220415154341",
+            "liveRate":"99",
+            "similarity":"97.0",
+            "photo":"*",
+            "video":"*"
+        }, 
+        
+
+    },
+    "errmsg":"SUCCESS"
+}
+```