tccli 3.0.1216.1__py2.py3-none-any.whl → 3.0.1217.1__py2.py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (252) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/argparser.py +1 -1
  3. tccli/command.py +2 -2
  4. tccli/credentials.py +25 -0
  5. tccli/main.py +6 -2
  6. tccli/plugins/sso/__init__.py +61 -0
  7. tccli/plugins/sso/configs.py +4 -0
  8. tccli/plugins/sso/configure.py +45 -0
  9. tccli/plugins/sso/login.py +144 -0
  10. tccli/plugins/sso/logout.py +21 -0
  11. tccli/plugins/sso/terminal.py +161 -0
  12. tccli/plugins/sso/texts.py +40 -0
  13. tccli/services/__init__.py +6 -0
  14. tccli/services/acp/v20220105/api.json +7 -7
  15. tccli/services/acp/v20220105/examples.json +2 -2
  16. tccli/services/aiart/v20221229/api.json +29 -29
  17. tccli/services/aiart/v20221229/examples.json +8 -8
  18. tccli/services/apigateway/v20180808/api.json +18 -17
  19. tccli/services/apigateway/v20180808/examples.json +12 -12
  20. tccli/services/apm/v20210622/api.json +98 -4
  21. tccli/services/asr/v20190614/api.json +18 -17
  22. tccli/services/asr/v20190614/examples.json +13 -13
  23. tccli/services/autoscaling/v20180419/api.json +371 -309
  24. tccli/services/autoscaling/v20180419/examples.json +17 -17
  25. tccli/services/batch/v20170312/api.json +7 -7
  26. tccli/services/bda/v20200324/api.json +39 -31
  27. tccli/services/bda/v20200324/examples.json +9 -9
  28. tccli/services/bh/__init__.py +4 -0
  29. tccli/services/bh/bh_client.py +3428 -0
  30. tccli/services/bh/v20230418/api.json +8180 -0
  31. tccli/services/bh/v20230418/examples.json +519 -0
  32. tccli/services/bi/v20220105/api.json +48 -0
  33. tccli/services/billing/v20180709/api.json +26 -24
  34. tccli/services/bsca/v20210811/api.json +1 -1
  35. tccli/services/btoe/v20210514/api.json +4 -4
  36. tccli/services/btoe/v20210514/examples.json +2 -2
  37. tccli/services/ca/v20230228/api.json +60 -0
  38. tccli/services/cam/v20190116/api.json +11 -11
  39. tccli/services/cat/v20180409/api.json +9 -0
  40. tccli/services/cbs/v20170312/api.json +200 -188
  41. tccli/services/cbs/v20170312/examples.json +4 -4
  42. tccli/services/ccc/v20200210/api.json +390 -323
  43. tccli/services/ccc/v20200210/examples.json +15 -15
  44. tccli/services/cdb/cdb_client.py +13 -13
  45. tccli/services/cdb/v20170320/api.json +295 -270
  46. tccli/services/cdb/v20170320/examples.json +38 -38
  47. tccli/services/cdc/v20201214/api.json +283 -270
  48. tccli/services/cdc/v20201214/examples.json +26 -26
  49. tccli/services/cds/v20180420/api.json +82 -76
  50. tccli/services/cds/v20180420/examples.json +1 -1
  51. tccli/services/cdwch/v20200915/api.json +1 -1
  52. tccli/services/cdwdoris/v20211228/api.json +42 -2
  53. tccli/services/cdz/v20221123/api.json +41 -5
  54. tccli/services/cfg/v20210820/api.json +31 -0
  55. tccli/services/cfs/v20190719/api.json +89 -1
  56. tccli/services/cfs/v20190719/examples.json +1 -1
  57. tccli/services/cfw/cfw_client.py +0 -53
  58. tccli/services/cfw/v20190904/api.json +1849 -1999
  59. tccli/services/cfw/v20190904/examples.json +157 -159
  60. tccli/services/ckafka/v20190819/api.json +104 -75
  61. tccli/services/clb/v20180317/api.json +48 -26
  62. tccli/services/clb/v20180317/examples.json +1 -1
  63. tccli/services/cloudapp/v20220530/api.json +5 -1
  64. tccli/services/cloudaudit/v20190319/api.json +58 -44
  65. tccli/services/cloudaudit/v20190319/examples.json +6 -6
  66. tccli/services/cloudstudio/v20230508/api.json +38 -37
  67. tccli/services/cloudstudio/v20230508/examples.json +4 -4
  68. tccli/services/cls/cls_client.py +216 -4
  69. tccli/services/cls/v20201016/api.json +536 -47
  70. tccli/services/cls/v20201016/examples.json +34 -2
  71. tccli/services/csip/v20221121/api.json +2562 -2382
  72. tccli/services/csip/v20221121/examples.json +108 -108
  73. tccli/services/cvm/v20170312/api.json +149 -112
  74. tccli/services/cvm/v20170312/examples.json +2 -2
  75. tccli/services/cwp/cwp_client.py +4 -110
  76. tccli/services/cwp/v20180228/api.json +6338 -6146
  77. tccli/services/cwp/v20180228/examples.json +342 -370
  78. tccli/services/cynosdb/v20190107/api.json +93 -81
  79. tccli/services/cynosdb/v20190107/examples.json +70 -70
  80. tccli/services/dasb/v20191018/api.json +796 -651
  81. tccli/services/dasb/v20191018/examples.json +101 -101
  82. tccli/services/dcdb/dcdb_client.py +114 -61
  83. tccli/services/dcdb/v20180411/api.json +141 -7
  84. tccli/services/dcdb/v20180411/examples.json +32 -0
  85. tccli/services/dlc/v20210125/api.json +21 -11
  86. tccli/services/dnspod/dnspod_client.py +417 -46
  87. tccli/services/dnspod/v20210323/api.json +751 -30
  88. tccli/services/dnspod/v20210323/examples.json +62 -0
  89. tccli/services/dts/v20211206/api.json +4 -4
  90. tccli/services/ecm/v20190719/api.json +2 -2
  91. tccli/services/emr/v20190103/api.json +339 -114
  92. tccli/services/emr/v20190103/examples.json +64 -82
  93. tccli/services/es/v20180416/api.json +29 -0
  94. tccli/services/es/v20180416/examples.json +1 -1
  95. tccli/services/ess/v20201111/api.json +49 -31
  96. tccli/services/ess/v20201111/examples.json +20 -8
  97. tccli/services/essbasic/v20210526/api.json +54 -49
  98. tccli/services/essbasic/v20210526/examples.json +36 -18
  99. tccli/services/facefusion/v20181201/api.json +47 -45
  100. tccli/services/facefusion/v20181201/examples.json +2 -2
  101. tccli/services/facefusion/v20220927/api.json +54 -48
  102. tccli/services/facefusion/v20220927/examples.json +5 -5
  103. tccli/services/faceid/v20180301/api.json +497 -496
  104. tccli/services/faceid/v20180301/examples.json +219 -101
  105. tccli/services/fmu/v20191213/api.json +59 -67
  106. tccli/services/fmu/v20191213/examples.json +22 -22
  107. tccli/services/ft/v20200304/api.json +53 -57
  108. tccli/services/ft/v20200304/examples.json +14 -14
  109. tccli/services/gme/v20180711/api.json +21 -11
  110. tccli/services/gme/v20180711/examples.json +1 -1
  111. tccli/services/hai/v20230812/api.json +116 -9
  112. tccli/services/hai/v20230812/examples.json +4 -4
  113. tccli/services/hunyuan/hunyuan_client.py +436 -12
  114. tccli/services/hunyuan/v20230901/api.json +1482 -118
  115. tccli/services/hunyuan/v20230901/examples.json +82 -18
  116. tccli/services/iai/v20180301/api.json +23 -19
  117. tccli/services/iai/v20180301/examples.json +2 -2
  118. tccli/services/iai/v20200303/api.json +530 -511
  119. tccli/services/iai/v20200303/examples.json +116 -86
  120. tccli/services/ig/__init__.py +4 -0
  121. tccli/services/ig/ig_client.py +195 -0
  122. tccli/services/ig/v20210518/api.json +83 -0
  123. tccli/services/ig/v20210518/examples.json +13 -0
  124. tccli/services/ioa/ioa_client.py +53 -0
  125. tccli/services/ioa/v20220601/api.json +662 -413
  126. tccli/services/ioa/v20220601/examples.json +24 -10
  127. tccli/services/iotexplorer/v20190423/api.json +33 -13
  128. tccli/services/iotexplorer/v20190423/examples.json +3 -3
  129. tccli/services/iotvideo/iotvideo_client.py +106 -0
  130. tccli/services/iotvideo/v20191126/api.json +256 -24
  131. tccli/services/iotvideo/v20191126/examples.json +19 -3
  132. tccli/services/iotvideo/v20201215/api.json +1 -1
  133. tccli/services/iotvideo/v20201215/examples.json +1 -1
  134. tccli/services/iotvideo/v20211125/api.json +1 -1
  135. tccli/services/iotvideo/v20211125/examples.json +2 -2
  136. tccli/services/iss/iss_client.py +69 -122
  137. tccli/services/iss/v20230517/api.json +10 -54
  138. tccli/services/iss/v20230517/examples.json +0 -14
  139. tccli/services/kms/v20190118/api.json +301 -268
  140. tccli/services/kms/v20190118/examples.json +45 -51
  141. tccli/services/lcic/lcic_client.py +159 -0
  142. tccli/services/lcic/v20220817/api.json +273 -1
  143. tccli/services/lcic/v20220817/examples.json +24 -0
  144. tccli/services/lighthouse/v20200324/api.json +56 -0
  145. tccli/services/live/live_client.py +159 -0
  146. tccli/services/live/v20180801/api.json +244 -0
  147. tccli/services/live/v20180801/examples.json +24 -0
  148. tccli/services/lke/v20231130/api.json +17 -17
  149. tccli/services/lke/v20231130/examples.json +19 -25
  150. tccli/services/mariadb/v20170312/api.json +7 -7
  151. tccli/services/market/v20191010/api.json +3 -3
  152. tccli/services/market/v20191010/examples.json +2 -2
  153. tccli/services/mmps/v20200710/api.json +47 -47
  154. tccli/services/mmps/v20200710/examples.json +3 -3
  155. tccli/services/mongodb/v20190725/api.json +4 -4
  156. tccli/services/monitor/v20180724/api.json +46 -19
  157. tccli/services/mps/v20190612/api.json +282 -5
  158. tccli/services/mps/v20190612/examples.json +25 -1
  159. tccli/services/mqtt/v20240516/api.json +2 -2
  160. tccli/services/mrs/v20200910/api.json +72 -34
  161. tccli/services/mrs/v20200910/examples.json +2 -2
  162. tccli/services/ms/v20180408/api.json +535 -506
  163. tccli/services/ms/v20180408/examples.json +25 -25
  164. tccli/services/oceanus/v20190422/api.json +130 -0
  165. tccli/services/ocr/ocr_client.py +232 -20
  166. tccli/services/ocr/v20181119/api.json +2265 -760
  167. tccli/services/ocr/v20181119/examples.json +200 -180
  168. tccli/services/omics/v20221128/api.json +614 -553
  169. tccli/services/omics/v20221128/examples.json +9 -9
  170. tccli/services/organization/v20210331/api.json +13 -4
  171. tccli/services/organization/v20210331/examples.json +2 -2
  172. tccli/services/partners/v20180321/api.json +244 -234
  173. tccli/services/partners/v20180321/examples.json +19 -19
  174. tccli/services/privatedns/privatedns_client.py +428 -4
  175. tccli/services/privatedns/v20201028/api.json +815 -11
  176. tccli/services/privatedns/v20201028/examples.json +64 -0
  177. tccli/services/pts/v20210728/api.json +18 -0
  178. tccli/services/pts/v20210728/examples.json +1 -1
  179. tccli/services/rce/rce_client.py +53 -0
  180. tccli/services/rce/v20201103/api.json +146 -0
  181. tccli/services/rce/v20201103/examples.json +8 -0
  182. tccli/services/redis/v20180412/api.json +42 -42
  183. tccli/services/redis/v20180412/examples.json +19 -19
  184. tccli/services/rum/v20210622/api.json +9 -0
  185. tccli/services/scf/v20180416/api.json +15 -15
  186. tccli/services/scf/v20180416/examples.json +1 -1
  187. tccli/services/smop/v20201203/api.json +46 -42
  188. tccli/services/smop/v20201203/examples.json +2 -2
  189. tccli/services/soe/v20180724/api.json +10 -10
  190. tccli/services/sqlserver/v20180328/api.json +21 -8
  191. tccli/services/sqlserver/v20180328/examples.json +5 -5
  192. tccli/services/ssl/v20191205/api.json +97 -4
  193. tccli/services/ssm/v20190923/api.json +292 -231
  194. tccli/services/ssm/v20190923/examples.json +42 -42
  195. tccli/services/tat/v20201028/api.json +97 -97
  196. tccli/services/tat/v20201028/examples.json +20 -26
  197. tccli/services/tchd/v20230306/api.json +5 -5
  198. tccli/services/tchd/v20230306/examples.json +3 -3
  199. tccli/services/tcr/v20190924/api.json +1 -1
  200. tccli/services/tcr/v20190924/examples.json +1 -1
  201. tccli/services/tcss/v20201101/api.json +1973 -1426
  202. tccli/services/tcss/v20201101/examples.json +346 -364
  203. tccli/services/tdmq/v20200217/api.json +539 -401
  204. tccli/services/tdmq/v20200217/examples.json +104 -104
  205. tccli/services/tds/v20220801/api.json +4 -4
  206. tccli/services/tem/v20210701/api.json +287 -271
  207. tccli/services/tem/v20210701/examples.json +59 -59
  208. tccli/services/teo/v20220901/api.json +37 -9
  209. tccli/services/teo/v20220901/examples.json +13 -7
  210. tccli/services/thpc/v20230321/api.json +5 -5
  211. tccli/services/tke/tke_client.py +217 -58
  212. tccli/services/tke/v20180525/api.json +36 -27
  213. tccli/services/tke/v20180525/examples.json +1 -1
  214. tccli/services/tke/v20220501/api.json +176 -0
  215. tccli/services/tke/v20220501/examples.json +24 -0
  216. tccli/services/tmt/v20180321/api.json +38 -8
  217. tccli/services/trp/v20210515/api.json +86 -74
  218. tccli/services/trp/v20210515/examples.json +65 -65
  219. tccli/services/trro/v20220325/api.json +72 -71
  220. tccli/services/trro/v20220325/examples.json +8 -8
  221. tccli/services/trtc/trtc_client.py +8 -61
  222. tccli/services/trtc/v20190722/api.json +72 -30
  223. tccli/services/trtc/v20190722/examples.json +3 -11
  224. tccli/services/tse/tse_client.py +110 -4
  225. tccli/services/tse/v20201207/api.json +122 -7
  226. tccli/services/tse/v20201207/examples.json +25 -9
  227. tccli/services/vclm/v20240523/api.json +225 -82
  228. tccli/services/vclm/v20240523/examples.json +13 -19
  229. tccli/services/vod/v20180717/api.json +431 -4
  230. tccli/services/vod/v20180717/examples.json +25 -5
  231. tccli/services/vod/v20240718/api.json +11 -11
  232. tccli/services/vod/v20240718/examples.json +4 -4
  233. tccli/services/vod/vod_client.py +53 -0
  234. tccli/services/vpc/v20170312/api.json +1090 -862
  235. tccli/services/vpc/v20170312/examples.json +74 -66
  236. tccli/services/vpc/vpc_client.py +61 -8
  237. tccli/services/waf/v20180125/api.json +2540 -2177
  238. tccli/services/waf/v20180125/examples.json +216 -284
  239. tccli/services/waf/waf_client.py +172 -119
  240. tccli/services/wav/v20210129/api.json +48 -48
  241. tccli/services/wav/v20210129/examples.json +4 -4
  242. tccli/services/wedata/v20210820/api.json +909 -25
  243. tccli/services/wedata/v20210820/examples.json +28 -4
  244. tccli/services/wedata/wedata_client.py +159 -0
  245. tccli/services/weilingwith/v20230427/api.json +6 -6
  246. tccli/services/weilingwith/v20230427/examples.json +3 -3
  247. tccli/sso.py +229 -0
  248. {tccli-3.0.1216.1.dist-info → tccli-3.0.1217.1.dist-info}/METADATA +2 -2
  249. {tccli-3.0.1216.1.dist-info → tccli-3.0.1217.1.dist-info}/RECORD +252 -235
  250. {tccli-3.0.1216.1.dist-info → tccli-3.0.1217.1.dist-info}/WHEEL +0 -0
  251. {tccli-3.0.1216.1.dist-info → tccli-3.0.1217.1.dist-info}/entry_points.txt +0 -0
  252. {tccli-3.0.1216.1.dist-info → tccli-3.0.1217.1.dist-info}/license_files/LICENSE +0 -0
@@ -288,8 +288,8 @@
288
288
  "members": [
289
289
  {
290
290
  "disabled": false,
291
- "document": "姓名",
292
- "example": "张三",
291
+ "document": "姓名。",
292
+ "example": "韦小宝",
293
293
  "member": "string",
294
294
  "name": "Name",
295
295
  "required": true,
@@ -297,8 +297,8 @@
297
297
  },
298
298
  {
299
299
  "disabled": false,
300
- "document": "银行卡",
301
- "example": "6222222222222222222",
300
+ "document": "银行卡。",
301
+ "example": "6225768888888888",
302
302
  "member": "string",
303
303
  "name": "BankCard",
304
304
  "required": true,
@@ -306,7 +306,7 @@
306
306
  },
307
307
  {
308
308
  "disabled": false,
309
- "document": "敏感数据加密信息。对传入信息(姓名、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
309
+ "document": "敏感数据加密信息。\n- 对传入信息(姓名、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
310
310
  "example": "无",
311
311
  "member": "Encryption",
312
312
  "name": "Encryption",
@@ -321,7 +321,7 @@
321
321
  "members": [
322
322
  {
323
323
  "disabled": false,
324
- "document": "认证结果码\n计费结果码:\n '0': '认证通过'\n '-1': '认证未通过'\n '-4': '持卡人信息有误'\n '-5': '未开通无卡支付'\n '-6': '此卡被没收'\n '-7': '无效卡号'\n '-8': '此卡无对应发卡行'\n '-9': '该卡未初始化或睡眠卡'\n '-10': '作弊卡、吞卡'\n '-11': '此卡已挂失'\n '-12': '该卡已过期'\n '-13': '受限制的卡'\n '-14': '密码错误次数超限'\n '-15': '发卡行不支持此交易'\n不计费结果码:\n '-2': '姓名校验不通过'\n '-3': '银行卡号码有误'\n '-16': '验证中心服务繁忙'\n '-17': '验证次数超限,请次日重试'\n",
324
+ "document": "认证结果码。\n- 计费结果码:\n '0': '认证通过'。\n '-1': '认证未通过'。\n '-4': '持卡人信息有误'。\n '-5': '未开通无卡支付'。\n '-6': '此卡被没收'。\n '-7': '无效卡号'。\n '-8': '此卡无对应发卡行'。\n '-9': '该卡未初始化或睡眠卡'。\n '-10': '作弊卡、吞卡'。\n '-11': '此卡已挂失'。\n '-12': '该卡已过期'。\n '-13': '受限制的卡'。\n '-14': '密码错误次数超限'。\n '-15': '发卡行不支持此交易'。\n\n- 不计费结果码:\n '-2': '姓名校验不通过'。\n '-3': '银行卡号码有误'。\n '-16': '验证中心服务繁忙'。\n '-17': '验证次数超限,请次日重试'。\n",
325
325
  "example": "0",
326
326
  "member": "string",
327
327
  "name": "Result",
@@ -353,8 +353,8 @@
353
353
  "members": [
354
354
  {
355
355
  "disabled": false,
356
- "document": "姓名",
357
- "example": "张三",
356
+ "document": "姓名。",
357
+ "example": "韦小宝",
358
358
  "member": "string",
359
359
  "name": "Name",
360
360
  "required": true,
@@ -362,8 +362,8 @@
362
362
  },
363
363
  {
364
364
  "disabled": false,
365
- "document": "银行卡",
366
- "example": "6222222222222222222",
365
+ "document": "银行卡。",
366
+ "example": "6225768888888888",
367
367
  "member": "string",
368
368
  "name": "BankCard",
369
369
  "required": true,
@@ -371,8 +371,8 @@
371
371
  },
372
372
  {
373
373
  "disabled": false,
374
- "document": "手机号码",
375
- "example": "6222222222222222222",
374
+ "document": "手机号码。",
375
+ "example": "16137688175",
376
376
  "member": "string",
377
377
  "name": "Phone",
378
378
  "required": true,
@@ -380,8 +380,8 @@
380
380
  },
381
381
  {
382
382
  "disabled": false,
383
- "document": "开户证件号,与CertType参数的证件类型一致,如:身份证,则传入身份证号。",
384
- "example": "6222222222222222222",
383
+ "document": "开户证件号。\n- 与CertType参数的证件类型一致,如:身份证,则传入身份证号。",
384
+ "example": "11204416541220243X",
385
385
  "member": "string",
386
386
  "name": "IdCard",
387
387
  "required": true,
@@ -389,7 +389,7 @@
389
389
  },
390
390
  {
391
391
  "disabled": false,
392
- "document": "证件类型,请确认该证件为开户时使用的证件类型,未用于开户的证件信息不支持验证。\n目前默认为0:身份证,其他证件类型暂不支持。",
392
+ "document": "证件类型。\n- 请确认该证件为开户时使用的证件类型,未用于开户的证件信息不支持验证。\n- 目前默认为0:身份证,其他证件类型暂不支持。",
393
393
  "example": "0",
394
394
  "member": "int64",
395
395
  "name": "CertType",
@@ -398,7 +398,7 @@
398
398
  },
399
399
  {
400
400
  "disabled": false,
401
- "document": "敏感数据加密信息。对传入信息(姓名、身份证号、手机号、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
401
+ "document": "敏感数据加密信息。\n- 对传入信息(姓名、身份证号、手机号、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
402
402
  "example": "无",
403
403
  "member": "Encryption",
404
404
  "name": "Encryption",
@@ -413,7 +413,7 @@
413
413
  "members": [
414
414
  {
415
415
  "disabled": false,
416
- "document": "认证结果码\n收费结果码:\n'0': '认证通过'\n'-1': '认证未通过'\n'-6': '持卡人信息有误'\n'-7': '未开通无卡支付'\n'-8': '此卡被没收'\n'-9': '无效卡号'\n'-10': '此卡无对应发卡行'\n'-11': '该卡未初始化或睡眠卡'\n'-12': '作弊卡、吞卡'\n'-13': '此卡已挂失'\n'-14': '该卡已过期'\n'-15': '受限制的卡'\n'-16': '密码错误次数超限'\n'-17': '发卡行不支持此交易'\n不收费结果码:\n'-2': '姓名校验不通过'\n'-3': '身份证号码有误'\n'-4': '银行卡号码有误'\n'-5': '手机号码不合法'\n'-18': '验证中心服务繁忙'\n'-19': '验证次数超限,请次日重试'\n'-20': '该证件号暂不支持核验,当前仅支持二代身份证'",
416
+ "document": "认证结果码。\n- 收费结果码:\n'0': '认证通过'。\n'-1': '认证未通过'。\n'-6': '持卡人信息有误'。\n'-7': '未开通无卡支付'。\n'-8': '此卡被没收'。\n'-9': '无效卡号'。\n'-10': '此卡无对应发卡行'。\n'-11': '该卡未初始化或睡眠卡'。\n'-12': '作弊卡、吞卡'。\n'-13': '此卡已挂失'。\n'-14': '该卡已过期'。\n'-15': '受限制的卡'。\n'-16': '密码错误次数超限'。\n'-17': '发卡行不支持此交易'。\n\n- 不收费结果码:\n'-2': '姓名校验不通过'。\n'-3': '身份证号码有误'。\n'-4': '银行卡号码有误'。\n'-5': '手机号码不合法'。\n'-18': '验证中心服务繁忙'。\n'-19': '验证次数超限,请次日重试'。\n'-20': '该证件号暂不支持核验,当前仅支持二代身份证'",
417
417
  "example": "0",
418
418
  "member": "string",
419
419
  "name": "Result",
@@ -445,7 +445,7 @@
445
445
  "members": [
446
446
  {
447
447
  "disabled": false,
448
- "document": "开户证件号,与CertType参数的证件类型一致,如:身份证,则传入身份证号。",
448
+ "document": "开户证件号。\n- 与CertType参数的证件类型一致,如:身份证,则传入身份证号。",
449
449
  "example": "440111201903211111",
450
450
  "member": "string",
451
451
  "name": "IdCard",
@@ -454,8 +454,8 @@
454
454
  },
455
455
  {
456
456
  "disabled": false,
457
- "document": "姓名",
458
- "example": "张三",
457
+ "document": "姓名。",
458
+ "example": "韦小宝",
459
459
  "member": "string",
460
460
  "name": "Name",
461
461
  "required": true,
@@ -463,8 +463,8 @@
463
463
  },
464
464
  {
465
465
  "disabled": false,
466
- "document": "银行卡",
467
- "example": "6222222222222222222",
466
+ "document": "银行卡。",
467
+ "example": "6225768888888888",
468
468
  "member": "string",
469
469
  "name": "BankCard",
470
470
  "required": true,
@@ -472,7 +472,7 @@
472
472
  },
473
473
  {
474
474
  "disabled": false,
475
- "document": "证件类型,请确认该证件为开户时使用的证件类型,未用于开户的证件信息不支持验证。\n目前默认:0 身份证,其他证件类型暂不支持。",
475
+ "document": "证件类型。\n- 请确认该证件为开户时使用的证件类型,未用于开户的证件信息不支持验证。\n- 目前默认:0 身份证,其他证件类型暂不支持。",
476
476
  "example": "0",
477
477
  "member": "int64",
478
478
  "name": "CertType",
@@ -481,7 +481,7 @@
481
481
  },
482
482
  {
483
483
  "disabled": false,
484
- "document": "敏感数据加密信息。对传入信息(姓名、身份证号、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
484
+ "document": "敏感数据加密信息。\n- 对传入信息(姓名、身份证号、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
485
485
  "example": "无",
486
486
  "member": "Encryption",
487
487
  "name": "Encryption",
@@ -496,7 +496,7 @@
496
496
  "members": [
497
497
  {
498
498
  "disabled": false,
499
- "document": "认证结果码\n收费结果码:\n'0': '认证通过'\n'-1': '认证未通过'\n'-5': '持卡人信息有误'\n'-6': '未开通无卡支付'\n'-7': '此卡被没收'\n'-8': '无效卡号'\n'-9': '此卡无对应发卡行'\n'-10': '该卡未初始化或睡眠卡'\n'-11': '作弊卡、吞卡'\n'-12': '此卡已挂失'\n'-13': '该卡已过期'\n'-14': '受限制的卡'\n'-15': '密码错误次数超限'\n'-16': '发卡行不支持此交易'\n不收费结果码:\n'-2': '姓名校验不通过'\n'-3': '身份证号码有误'\n'-4': '银行卡号码有误'\n'-17': '验证中心服务繁忙'\n'-18': '验证次数超限,请次日重试'\n'-19': '该证件号暂不支持核验,当前仅支持二代身份证'\t",
499
+ "document": "认证结果码。\n- 收费结果码:\n'0': '认证通过'。\n'-1': '认证未通过'。\n'-5': '持卡人信息有误'。\n'-6': '未开通无卡支付'。\n'-7': '此卡被没收'。\n'-8': '无效卡号'。\n'-9': '此卡无对应发卡行'。\n'-10': '该卡未初始化或睡眠卡'。\n'-11': '作弊卡、吞卡'。\n'-12': '此卡已挂失'。\n'-13': '该卡已过期'。\n'-14': '受限制的卡'。\n'-15': '密码错误次数超限'。\n'-16': '发卡行不支持此交易'。\n\n- 不收费结果码:\n'-2': '姓名校验不通过'。\n'-3': '身份证号码有误'。\n'-4': '银行卡号码有误'。\n'-17': '验证中心服务繁忙'。\n'-18': '验证次数超限,请次日重试'。\n'-19': '该证件号暂不支持核验,当前仅支持二代身份证'。\t",
500
500
  "example": "0",
501
501
  "member": "string",
502
502
  "name": "Result",
@@ -635,7 +635,7 @@
635
635
  {
636
636
  "disabled": false,
637
637
  "document": "银行卡号。",
638
- "example": "xxxxxxxxxx",
638
+ "example": "6225768888888888",
639
639
  "member": "string",
640
640
  "name": "BankCard",
641
641
  "required": true,
@@ -643,7 +643,7 @@
643
643
  },
644
644
  {
645
645
  "disabled": false,
646
- "document": "敏感数据加密信息。对传入信息(银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
646
+ "document": "敏感数据加密信息。\n- 对传入信息(银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
647
647
  "example": "无",
648
648
  "member": "Encryption",
649
649
  "name": "Encryption",
@@ -658,7 +658,7 @@
658
658
  "members": [
659
659
  {
660
660
  "disabled": false,
661
- "document": "认证结果码,收费情况如下。\n收费结果码:\n0: 查询成功\n-1: 未查到信息\n不收费结果码:\n-2:验证中心服务繁忙\n-3:银行卡不存在\n-4:认证次数超过当日限制,请次日重试\n",
661
+ "document": "认证结果码,收费情况如下。\n- 收费结果码:\n0: 查询成功\n-1: 未查到信息\n\n- 不收费结果码:\n-2:验证中心服务繁忙\n-3:银行卡不存在\n-4:认证次数超过当日限制,请次日重试\n",
662
662
  "example": "0",
663
663
  "member": "string",
664
664
  "name": "Result",
@@ -668,7 +668,7 @@
668
668
  },
669
669
  {
670
670
  "disabled": false,
671
- "document": "业务结果描述",
671
+ "document": "业务结果描述。",
672
672
  "example": "查询成功",
673
673
  "member": "string",
674
674
  "name": "Description",
@@ -678,7 +678,7 @@
678
678
  },
679
679
  {
680
680
  "disabled": false,
681
- "document": "开户行",
681
+ "document": "开户行。",
682
682
  "example": "中国工商银行",
683
683
  "member": "string",
684
684
  "name": "AccountBank",
@@ -688,7 +688,7 @@
688
688
  },
689
689
  {
690
690
  "disabled": false,
691
- "document": "卡性质:1. 借记卡;2. 贷记卡;3. 预付费卡;4. 准贷记卡",
691
+ "document": "卡性质。\n- 取值范围:\n1:借记卡。\n2:贷记卡。\n3:预付费卡。\n4:准贷记卡",
692
692
  "example": "1",
693
693
  "member": "int64",
694
694
  "name": "AccountType",
@@ -711,7 +711,7 @@
711
711
  {
712
712
  "disabled": false,
713
713
  "document": "E证通流程的唯一标识,调用GetEidToken接口时生成。",
714
- "example": "2132323",
714
+ "example": "2B3B265E-2C91-5A62-B32D-D0CA5C3F1A15",
715
715
  "member": "string",
716
716
  "name": "EidToken",
717
717
  "required": true,
@@ -725,11 +725,11 @@
725
725
  "members": [
726
726
  {
727
727
  "disabled": false,
728
- "document": "枚举:\ninittoken未验证\ndoing: 验证中\nfinished: 验证完成\ntimeout: token已超时",
728
+ "document": "状态。\n- initEidToken未验证。\n- doing: EidToken验证中。\n- finished: EidToken验证完成。\n- timeout: EidToken已超时。",
729
729
  "example": "init",
730
730
  "member": "string",
731
731
  "name": "Status",
732
- "required": true,
732
+ "output_required": true,
733
733
  "type": "string",
734
734
  "value_allowed_null": false
735
735
  },
@@ -747,8 +747,8 @@
747
747
  "members": [
748
748
  {
749
749
  "disabled": false,
750
- "document": "身份证人像面的 Base64 值\n支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。\n支持的图片大小:所下载图片经Base64编码后不超过 7M。\n请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。\nImageBase64、ImageUrl二者必须提供其中之一。若都提供了,则按照ImageUrl>ImageBase64的优先级使用参数。",
751
- "example": "\"\"",
750
+ "document": "身份证人像面的 Base64 值。\n- 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。\n- 支持的图片大小:所下载图片经Base64编码后不超过 7M。\n- 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。\n- ImageBase64、ImageUrl二者必须提供其中之一。若都提供了,则按照ImageUrl>ImageBase64的优先级使用参数。",
751
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
752
752
  "member": "string",
753
753
  "name": "ImageBase64",
754
754
  "required": false,
@@ -756,8 +756,8 @@
756
756
  },
757
757
  {
758
758
  "disabled": false,
759
- "document": "身份证人像面的 Url 地址\n支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。\n支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。\n图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。\n非腾讯云存储的 Url 速度和稳定性可能受一定影响。",
760
- "example": "\"\"",
759
+ "document": "身份证人像面的 Url 地址\n- 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。\n- 支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。\n- 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。\n- 非腾讯云存储的 Url 速度和稳定性可能受一定影响。",
760
+ "example": "http://www.qq.com/image.jpg",
761
761
  "member": "string",
762
762
  "name": "ImageUrl",
763
763
  "required": false,
@@ -765,8 +765,8 @@
765
765
  },
766
766
  {
767
767
  "disabled": false,
768
- "document": "以下可选字段均为bool 类型,默认false:\nCopyWarn,复印件告警\nBorderCheckWarn,边框和框内遮挡告警\nReshootWarn,翻拍告警\nDetectPsWarn,PS检测告警(疑似存在PS痕迹)\nTempIdWarn,临时身份证告警\nQuality,图片质量告警(评价图片模糊程度)\n\nSDK 设置方式参考:\nConfig = Json.stringify({\"CopyWarn\":true,\"ReshootWarn\":true})\nAPI 3.0 Explorer 设置方式参考:\nConfig = {\"CopyWarn\":true,\"ReshootWarn\":true}",
769
- "example": "",
768
+ "document": "配置。\n- 以下可选字段均为bool 类型,默认false。\nCopyWarn,复印件告警。\nBorderCheckWarn,边框和框内遮挡告警。\nReshootWarn,翻拍告警。\nDetectPsWarn,PS检测告警(疑似存在PS痕迹)。\nTempIdWarn,临时身份证告警。\nQuality,图片质量告警(评价图片模糊程度)。\n\n- SDK 设置方式参考:\nConfig = Json.stringify({\"CopyWarn\":true,\"ReshootWarn\":true})。\n\n- API 3.0 Explorer 设置方式参考:\nConfig = {\"CopyWarn\":true,\"ReshootWarn\":true}",
769
+ "example": " {\"CopyWarn\":true,\"ReshootWarn\":true}",
770
770
  "member": "string",
771
771
  "name": "Config",
772
772
  "required": false,
@@ -774,7 +774,7 @@
774
774
  },
775
775
  {
776
776
  "disabled": false,
777
- "document": "是否需要对返回中的敏感信息进行加密。默认false。\n其中敏感信息包括:Response.IdNum、Response.Name",
777
+ "document": "是否需要对返回中的敏感信息进行加密。\n- 默认false。\n- 敏感信息包括:Response.IdNum、Response.Name",
778
778
  "example": "false",
779
779
  "member": "bool",
780
780
  "name": "IsEncrypt",
@@ -783,7 +783,7 @@
783
783
  },
784
784
  {
785
785
  "disabled": false,
786
- "document": "是否需要对响应体加密",
786
+ "document": "是否需要对响应体加密。",
787
787
  "example": "false",
788
788
  "member": "bool",
789
789
  "name": "IsEncryptResponse",
@@ -807,8 +807,8 @@
807
807
  "members": [
808
808
  {
809
809
  "disabled": false,
810
- "document": "相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)",
811
- "example": "98.819999694824",
810
+ "document": "相似度。\n- 取值范围 [0.00, 100.00]。\n- 推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)。",
811
+ "example": "99.76",
812
812
  "member": "float",
813
813
  "name": "Sim",
814
814
  "output_required": true,
@@ -817,7 +817,7 @@
817
817
  },
818
818
  {
819
819
  "disabled": false,
820
- "document": "业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分",
820
+ "document": "业务错误码。\n- 成功情况返回Success,。\n- 错误情况请参考下方错误码 列表中FailedOperation部分",
821
821
  "example": "FailedOperation.OcrWarningOccurred",
822
822
  "member": "string",
823
823
  "name": "Result",
@@ -837,8 +837,8 @@
837
837
  },
838
838
  {
839
839
  "disabled": false,
840
- "document": "姓名",
841
- "example": "洪**",
840
+ "document": "姓名。",
841
+ "example": "韦小宝",
842
842
  "member": "string",
843
843
  "name": "Name",
844
844
  "output_required": true,
@@ -847,7 +847,7 @@
847
847
  },
848
848
  {
849
849
  "disabled": false,
850
- "document": "性别",
850
+ "document": "性别。",
851
851
  "example": "男",
852
852
  "member": "string",
853
853
  "name": "Sex",
@@ -857,7 +857,7 @@
857
857
  },
858
858
  {
859
859
  "disabled": false,
860
- "document": "民族",
860
+ "document": "民族。",
861
861
  "example": "汉",
862
862
  "member": "string",
863
863
  "name": "Nation",
@@ -867,8 +867,8 @@
867
867
  },
868
868
  {
869
869
  "disabled": false,
870
- "document": "出生日期",
871
- "example": "1995/8/6",
870
+ "document": "出生日期。",
871
+ "example": "1654/12/20",
872
872
  "member": "string",
873
873
  "name": "Birth",
874
874
  "output_required": true,
@@ -877,8 +877,8 @@
877
877
  },
878
878
  {
879
879
  "disabled": false,
880
- "document": "地址",
881
- "example": "广东省xxxxxxxxxxxx",
880
+ "document": "地址。",
881
+ "example": "北京市东城区景山前街4号紫禁城敬事房",
882
882
  "member": "string",
883
883
  "name": "Address",
884
884
  "output_required": true,
@@ -887,8 +887,8 @@
887
887
  },
888
888
  {
889
889
  "disabled": false,
890
- "document": "身份证号",
891
- "example": "xxxxxxx",
890
+ "document": "身份证号。",
891
+ "example": "11204416541220243X",
892
892
  "member": "string",
893
893
  "name": "IdNum",
894
894
  "output_required": true,
@@ -898,7 +898,7 @@
898
898
  {
899
899
  "disabled": false,
900
900
  "document": "身份证头像照片的base64编码,如果抠图失败会拿整张身份证做比对并返回空。",
901
- "example": "zok/tK7k2bLjyJE",
901
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
902
902
  "member": "string",
903
903
  "name": "Portrait",
904
904
  "output_required": true,
@@ -907,7 +907,7 @@
907
907
  },
908
908
  {
909
909
  "disabled": false,
910
- "document": "告警信息,当在Config中配置了告警信息会停止人像比对,Result返回错误(FailedOperation.OcrWarningOccurred)并有此告警信息,Code 告警码列表和释义:\n\n-9101 身份证边框不完整告警,\n-9102 身份证复印件告警,\n-9103 身份证翻拍告警,\n-9105 身份证框内遮挡告警,\n-9104 临时身份证告警,\n-9106 身份证 PS 告警(疑似存在PS痕迹)。\n-8001 图片模糊告警\n多个会 | 隔开如 \"-9101|-9106|-9104\"",
910
+ "document": "告警信息。\n- 当在Config中配置了告警信息会停止人像比对,Result返回错误(FailedOperation.OcrWarningOccurred)并有此告警信息。\n- Code 告警码列表和释义:\n'-9101':身份证边框不完整告警。\n'-9102':身份证复印件告警。\n'-9103':身份证翻拍告警。\n'-9105':身份证框内遮挡告警。\n'-9104':临时身份证告警。\n'-9106':身份证 PS 告警(疑似存在PS痕迹)。\n'-8001':图片模糊告警。\n\n- 多个会用“|” 隔开,如 \"-9101|-9106|-9104\"",
911
911
  "example": "-9101|-9106|-9104",
912
912
  "member": "string",
913
913
  "name": "Warnings",
@@ -917,7 +917,7 @@
917
917
  },
918
918
  {
919
919
  "disabled": false,
920
- "document": "图片质量分数,当请求Config中配置图片模糊告警该参数才有意义,取值范围(0~100),目前默认阈值是50分,低于50分会触发模糊告警。",
920
+ "document": "图片质量分数。\n- 当请求Config中配置图片模糊告警该参数才有意义。\n- 取值范围(0~100),目前默认阈值是50分,低于50分会触发模糊告警。",
921
921
  "example": "0",
922
922
  "member": "float",
923
923
  "name": "Quality",
@@ -937,7 +937,7 @@
937
937
  },
938
938
  {
939
939
  "disabled": false,
940
- "document": "加密后的数据",
940
+ "document": "加密后的数据。",
941
941
  "example": "无",
942
942
  "member": "string",
943
943
  "name": "EncryptedBody",
@@ -959,8 +959,8 @@
959
959
  "members": [
960
960
  {
961
961
  "disabled": false,
962
- "document": "姓名",
963
- "example": "张三",
962
+ "document": "姓名。",
963
+ "example": "韦小宝",
964
964
  "member": "string",
965
965
  "name": "Name",
966
966
  "required": true,
@@ -968,8 +968,8 @@
968
968
  },
969
969
  {
970
970
  "disabled": false,
971
- "document": "身份证号",
972
- "example": "620xxxxxxxxxxx0321",
971
+ "document": "身份证号。",
972
+ "example": "11204416541220243X",
973
973
  "member": "string",
974
974
  "name": "IdCard",
975
975
  "required": true,
@@ -977,7 +977,7 @@
977
977
  },
978
978
  {
979
979
  "disabled": false,
980
- "document": "身份证有效期开始时间,格式:YYYYMMDD。如:20210701",
980
+ "document": "身份证有效期开始时间。\n- 格式:YYYYMMDD,如:20210701",
981
981
  "example": "20160607",
982
982
  "member": "string",
983
983
  "name": "ValidityBegin",
@@ -986,7 +986,7 @@
986
986
  },
987
987
  {
988
988
  "disabled": false,
989
- "document": "身份证有效期到期时间,格式:YYYYMMDD,长期用“00000000”代替;如:20210701",
989
+ "document": "身份证有效期到期时间。\n格式:YYYYMMDD,长期用“00000000”代替,如:20210701",
990
990
  "example": "20250607",
991
991
  "member": "string",
992
992
  "name": "ValidityEnd",
@@ -995,7 +995,7 @@
995
995
  },
996
996
  {
997
997
  "disabled": false,
998
- "document": "敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
998
+ "document": "敏感数据加密信息。\n- 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
999
999
  "example": "无",
1000
1000
  "member": "Encryption",
1001
1001
  "name": "Encryption",
@@ -1010,7 +1010,7 @@
1010
1010
  "members": [
1011
1011
  {
1012
1012
  "disabled": false,
1013
- "document": "认证结果码,收费情况如下。\n收费结果码:\n0: 一致\n-1: 不一致\n不收费结果码:\n-2: 非法身份证号(长度、校验位等不正确)\n-3: 非法姓名(长度、格式等不正确)\n-4: 非法有效期(长度、格式等不正确)\n-5: 身份信息无效\n-6: 证件库服务异常\n-7: 证件库中无此身份证记录\n-8: 认证次数超过当日限制,请次日重试",
1013
+ "document": "认证结果码,收费情况如下。\n\n- 收费结果码:\n0: 一致。\n-1: 不一致。\n\n- 不收费结果码:\n-2: 非法身份证号(长度、校验位等不正确)。\n-3: 非法姓名(长度、格式等不正确)。\n-4: 非法有效期(长度、格式等不正确)。\n-5: 身份信息无效。\n-6: 证件库服务异常。\n-7: 证件库中无此身份证记录。\n-8: 认证次数超过当日限制,请次日重试。",
1014
1014
  "example": "\"0\"",
1015
1015
  "member": "string",
1016
1016
  "name": "Result",
@@ -1042,8 +1042,8 @@
1042
1042
  "members": [
1043
1043
  {
1044
1044
  "disabled": false,
1045
- "document": "⼿机号",
1046
- "example": "1399999999909",
1045
+ "document": "⼿机号。",
1046
+ "example": "16137688175",
1047
1047
  "member": "string",
1048
1048
  "name": "Mobile",
1049
1049
  "required": true,
@@ -1051,8 +1051,8 @@
1051
1051
  },
1052
1052
  {
1053
1053
  "disabled": false,
1054
- "document": "姓名",
1055
- "example": "李四",
1054
+ "document": "姓名。",
1055
+ "example": "韦小宝",
1056
1056
  "member": "string",
1057
1057
  "name": "Name",
1058
1058
  "required": true,
@@ -1060,7 +1060,7 @@
1060
1060
  },
1061
1061
  {
1062
1062
  "disabled": false,
1063
- "document": "敏感数据加密信息。对传入信息(姓名、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
1063
+ "document": "敏感数据加密信息。\n- 对传入信息(姓名、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
1064
1064
  "example": "无",
1065
1065
  "member": "Encryption",
1066
1066
  "name": "Encryption",
@@ -1075,7 +1075,7 @@
1075
1075
  "members": [
1076
1076
  {
1077
1077
  "disabled": false,
1078
- "document": "认证结果码,收费情况如下。\n收费结果码:\n0: 验证结果一致\n1: 验证结果不一致\n不收费结果码:\n-1:查无记录\n-2:引擎未知错误\n-3:引擎服务异常\n-4:姓名校验不通过\n-5:手机号码不合法\n-6: 认证次数超过当日限制,请次日重试",
1078
+ "document": "认证结果码,收费情况如下。\n- 收费结果码:\n0: 验证结果一致。\n1: 验证结果不一致。\n\n- 不收费结果码:\n-1:查无记录。\n-2:引擎未知错误。\n-3:引擎服务异常。\n-4:姓名校验不通过。\n-5:手机号码不合法。\n-6: 认证次数超过当日限制,请次日重试。",
1079
1079
  "example": "0",
1080
1080
  "member": "string",
1081
1081
  "name": "Result",
@@ -1085,7 +1085,7 @@
1085
1085
  },
1086
1086
  {
1087
1087
  "disabled": false,
1088
- "document": "业务结果描述",
1088
+ "document": "业务结果描述。",
1089
1089
  "example": "验证结果一致",
1090
1090
  "member": "string",
1091
1091
  "name": "Description",
@@ -1107,8 +1107,8 @@
1107
1107
  "members": [
1108
1108
  {
1109
1109
  "disabled": false,
1110
- "document": "传入需要进行检测的带有人脸的图片或视频,使用base64编码的形式。\n\n图片的Base64值:\n建议整体图像480x640的分辨率,脸部 大小 100X100 以上;\nBase64编码后的图片数据大小不超过3M,仅支持jpg、png格式。请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。\n\n视频的Base64值:\nBase64编码后的大小不超过8M,支持mp4、avi、flv格式。\n请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。\n视频时长最大支持20s,建议时长2~5s。\n建议视频分辨率为480x640,帧率在25fps~30fps之间。",
1111
- "example": "iVBORw0KGgoAA......",
1110
+ "document": "传入需要进行检测的带有人脸的图片或视频,使用base64编码的形式。\n- 图片的Base64值:\n建议整体图像480x640的分辨率,脸部 大小 100X100 以上。\nBase64编码后的图片数据大小不超过3M,仅支持jpg、png格式。\n请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。\n\n- 视频的Base64值:\nBase64编码后的大小不超过8M,支持mp4、avi、flv格式。\n请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。\n视频时长最大支持20s,建议时长2~5s。\n建议视频分辨率为480x640,帧率在25fps~30fps之间。",
1111
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
1112
1112
  "member": "string",
1113
1113
  "name": "FaceInput",
1114
1114
  "required": false,
@@ -1116,7 +1116,7 @@
1116
1116
  },
1117
1117
  {
1118
1118
  "disabled": false,
1119
- "document": "传入的类型\n1- 传入的是图片类型\n2- 传入的是视频类型\n其他 - 返回错误码InvalidParameter",
1119
+ "document": "传入的类型。\n- 取值范围:\n1:传入的是图片类型。\n2:传入的是视频类型。\n其他:返回错误码InvalidParameter",
1120
1120
  "example": "true",
1121
1121
  "member": "int64",
1122
1122
  "name": "FaceInputType",
@@ -1125,7 +1125,7 @@
1125
1125
  },
1126
1126
  {
1127
1127
  "disabled": false,
1128
- "document": "是否需要对请求信息进行全包体加密; 支持的加密算法:AES-256-CBC、SM4-GCM 有加密需求的用户可使用此参数,详情请点击左侧链接。",
1128
+ "document": "是否需要对请求信息进行全包体加密。\n- 支持的加密算法:AES-256-CBC、SM4-GCM。\n- 有加密需求的用户可使用此参数,详情请点击左侧链接。",
1129
1129
  "example": "无",
1130
1130
  "member": "Encryption",
1131
1131
  "name": "Encryption",
@@ -1134,8 +1134,8 @@
1134
1134
  },
1135
1135
  {
1136
1136
  "disabled": false,
1137
- "document": "加密后的密文; 加密前的数据格式如下:{\"FaceInput\":\"AAAAA\",\"FaceInputType\":1}",
1138
- "example": "",
1137
+ "document": "加密后的密文。\n- 加密前的数据格式如下:{\"FaceInput\":\"AAAAA\",\"FaceInputType\":1}",
1138
+ "example": "fH6Fc1xHm......UrjSoYE",
1139
1139
  "member": "string",
1140
1140
  "name": "EncryptedBody",
1141
1141
  "required": false,
@@ -1149,7 +1149,7 @@
1149
1149
  "members": [
1150
1150
  {
1151
1151
  "disabled": false,
1152
- "document": "检测到的图片是否存在攻击:\nLow:无攻击风险\nMid:中度疑似攻击\nHigh:高度疑似攻击",
1152
+ "document": "检测到的图片是否存在攻击。\n- Low:无攻击风险。\n- Mid:中度疑似攻击。\n- High:高度疑似攻击。",
1153
1153
  "example": "Mid",
1154
1154
  "member": "string",
1155
1155
  "name": "AttackRiskLevel",
@@ -1159,7 +1159,7 @@
1159
1159
  },
1160
1160
  {
1161
1161
  "disabled": false,
1162
- "document": "检测到疑似的攻击痕迹列表\n说明:未检测到攻击痕迹时,返回空数组\n此出参仅作为结果判断的参考,实际应用仍建议使用AttackRiskLevel的结果。",
1162
+ "document": "检测到疑似的攻击痕迹列表。\n- 说明:未检测到攻击痕迹时,返回空数组。\n- 此出参仅作为结果判断的参考,实际应用仍建议使用AttackRiskLevel的结果。",
1163
1163
  "example": "[{ Type:\"SuspectedSpoofingAttack\" }]",
1164
1164
  "member": "AttackRiskDetail",
1165
1165
  "name": "AttackRiskDetailList",
@@ -1169,7 +1169,7 @@
1169
1169
  },
1170
1170
  {
1171
1171
  "disabled": false,
1172
- "document": "额外信息",
1172
+ "document": "额外信息。",
1173
1173
  "example": "无",
1174
1174
  "member": "ExtraInfo",
1175
1175
  "name": "ExtraInfo",
@@ -1191,8 +1191,8 @@
1191
1191
  "members": [
1192
1192
  {
1193
1193
  "disabled": false,
1194
- "document": "用于细分客户使用场景,申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid 自助接入里面创建,审核通过后即可调用。如有疑问,请添加[腾讯云人脸核身小助手](https://cloud.tencent.com/document/product/1007/56130)进行咨询。",
1195
- "example": "0",
1194
+ "document": "业务流程ID。\n- 用于细分客户使用场景, 可为业务配置不同的业务流程。\n- 申请开通服务后,登录腾讯云[慧眼人脸核身控制](https://console.cloud.tencent.com/faceid)进行创建,审核通过后即可调用。\n- 如有疑问,请添加[腾讯云人脸核身小助手](https://cloud.tencent.com/document/product/1007/56130)进行咨询。",
1195
+ "example": "1",
1196
1196
  "member": "string",
1197
1197
  "name": "RuleId",
1198
1198
  "required": true,
@@ -1209,8 +1209,8 @@
1209
1209
  },
1210
1210
  {
1211
1211
  "disabled": false,
1212
- "document": "身份标识(是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示)。\n规则:a-z,A-Z,0-9组合。最长长度32位。",
1213
- "example": "",
1212
+ "document": "验证人的身份证号码。\n- 是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示。\n",
1213
+ "example": "11204416541220243X",
1214
1214
  "member": "string",
1215
1215
  "name": "IdCard",
1216
1216
  "required": false,
@@ -1218,8 +1218,8 @@
1218
1218
  },
1219
1219
  {
1220
1220
  "disabled": false,
1221
- "document": "姓名。(是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示)。\n最长长度32位。中文请使用UTF-8编码。",
1222
- "example": "",
1221
+ "document": "验证人的姓名。\n- 是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示。\n- 最长长度32位。中文请使用UTF-8编码。",
1222
+ "example": "韦小宝",
1223
1223
  "member": "string",
1224
1224
  "name": "Name",
1225
1225
  "required": false,
@@ -1227,8 +1227,8 @@
1227
1227
  },
1228
1228
  {
1229
1229
  "disabled": false,
1230
- "document": "认证结束后重定向的回调链接地址。最长长度1024位。",
1231
- "example": "",
1230
+ "document": "认证结束后重定向的回调链接地址。\n- 最长长度1024位。",
1231
+ "example": "https://www.qq.com",
1232
1232
  "member": "string",
1233
1233
  "name": "RedirectUrl",
1234
1234
  "required": false,
@@ -1237,7 +1237,7 @@
1237
1237
  {
1238
1238
  "disabled": false,
1239
1239
  "document": "透传字段,在获取验证结果时返回。",
1240
- "example": "",
1240
+ "example": "Orderid=f904f4cf75db4f8fdc4f942c7f7a",
1241
1241
  "member": "string",
1242
1242
  "name": "Extra",
1243
1243
  "required": false,
@@ -1245,8 +1245,8 @@
1245
1245
  },
1246
1246
  {
1247
1247
  "disabled": false,
1248
- "document": "用于人脸比对的照片,图片的Base64值;\nBase64编码后的图片数据大小不超过3M,仅支持jpg、png格式。请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。",
1249
- "example": "",
1248
+ "document": "用于人脸比对的图像数据,使用base64编码。\n- Base64编码后的图片数据大小不超过3M。\n- 仅支持jpg、png格式。\n- 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。",
1249
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
1250
1250
  "member": "string",
1251
1251
  "name": "ImageBase64",
1252
1252
  "required": false,
@@ -1263,7 +1263,7 @@
1263
1263
  },
1264
1264
  {
1265
1265
  "disabled": false,
1266
- "document": "意愿核身(朗读模式)使用的文案,若未使用意愿核身(朗读模式),则该字段无需传入。默认为空,最长可接受120的字符串长度。",
1266
+ "document": "意愿核身(朗读模式)使用的文案。\n- 若未使用意愿核身(朗读模式),则该字段无需传入。\n- 最长可接受120的字符串长度。",
1267
1267
  "example": "无",
1268
1268
  "member": "string",
1269
1269
  "name": "IntentionVerifyText",
@@ -1272,7 +1272,7 @@
1272
1272
  },
1273
1273
  {
1274
1274
  "disabled": false,
1275
- "document": "意愿核身语音问答模式(即语音播报+语音回答)使用的文案,包括:系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。",
1275
+ "document": "意愿核身(语音播报+语音回答模式)使用的文案。\n- 包括:系统语音播报的文本、需要核验的标准文本。\n- 当前仅支持1轮问答。",
1276
1276
  "example": "无",
1277
1277
  "member": "IntentionQuestion",
1278
1278
  "name": "IntentionQuestions",
@@ -1281,21 +1281,21 @@
1281
1281
  },
1282
1282
  {
1283
1283
  "disabled": false,
1284
- "document": "RuleId相关配置",
1284
+ "document": "意愿核身(点头确认模式)使用的文案。\n- 若未使用意愿核身(点头确认模式),则该字段无需传入。\n- 当前仅支持一个提示文本。",
1285
1285
  "example": "无",
1286
- "member": "RuleIdConfig",
1287
- "name": "Config",
1286
+ "member": "IntentionActionConfig",
1287
+ "name": "IntentionActions",
1288
1288
  "required": false,
1289
- "type": "object"
1289
+ "type": "list"
1290
1290
  },
1291
1291
  {
1292
1292
  "disabled": false,
1293
- "document": "意愿核身(点头确认模式)使用的文案,若未使用意愿核身(点头确认模式),则该字段无需传入。当前仅支持一个提示文本。",
1293
+ "document": "意愿核身流程配置。",
1294
1294
  "example": "无",
1295
- "member": "IntentionActionConfig",
1296
- "name": "IntentionActions",
1295
+ "member": "RuleIdConfig",
1296
+ "name": "Config",
1297
1297
  "required": false,
1298
- "type": "list"
1298
+ "type": "object"
1299
1299
  }
1300
1300
  ],
1301
1301
  "type": "object"
@@ -1306,7 +1306,7 @@
1306
1306
  {
1307
1307
  "disabled": false,
1308
1308
  "document": "用于发起核身流程的URL,仅微信H5场景使用。",
1309
- "example": "",
1309
+ "example": "https://faceid.qq.com?token=81EEF678-28EE-4759-A82E-6CBBBE6BC442",
1310
1310
  "member": "string",
1311
1311
  "name": "Url",
1312
1312
  "output_required": true,
@@ -1315,8 +1315,8 @@
1315
1315
  },
1316
1316
  {
1317
1317
  "disabled": false,
1318
- "document": "一次核身流程的标识,有效时间为7,200秒;\n完成核身后,可用该标识获取验证结果信息。",
1319
- "example": "CE661F1A-0F1E-45BD-BE13-34C05CEA7681",
1318
+ "document": "一次核验流程的唯一标识。\n- 有效时间为7,200秒,超过有效期再进行人脸核验会报错,请在有效期内进行核验。\n- 完成人脸核验后,需根据此标识调用[获取实名核身结果信息增强版](https://cloud.tencent.com/document/api/1007/41957)获取用户最终验证结果信息。",
1319
+ "example": "81EEF6178-28EE-4759-A823E-6CBBBE6BC442",
1320
1320
  "member": "string",
1321
1321
  "name": "BizToken",
1322
1322
  "output_required": true,
@@ -1479,25 +1479,25 @@
1479
1479
  "usage": "out"
1480
1480
  },
1481
1481
  "DetectInfoBestFrame": {
1482
- "document": "核身最佳帧信息",
1482
+ "document": "核身最佳帧信息。",
1483
1483
  "members": [
1484
1484
  {
1485
1485
  "disabled": false,
1486
1486
  "document": "活体比对最佳帧Base64编码。\n注意:此字段可能返回 null,表示取不到有效值。",
1487
- "example": "",
1487
+ "example": "/9j/4AAQSk...NFFFJjP//Z",
1488
1488
  "member": "string",
1489
1489
  "name": "BestFrame",
1490
- "required": true,
1490
+ "output_required": true,
1491
1491
  "type": "string",
1492
1492
  "value_allowed_null": true
1493
1493
  },
1494
1494
  {
1495
1495
  "disabled": false,
1496
1496
  "document": "自截帧Base64编码数组。\n注意:此字段可能返回 null,表示取不到有效值。",
1497
- "example": "",
1497
+ "example": "[\"/9j/4AAQSk...7+lc5J/9k=\"]",
1498
1498
  "member": "string",
1499
1499
  "name": "BestFrames",
1500
- "required": true,
1500
+ "output_required": true,
1501
1501
  "type": "list",
1502
1502
  "value_allowed_null": true
1503
1503
  }
@@ -1505,12 +1505,12 @@
1505
1505
  "usage": "out"
1506
1506
  },
1507
1507
  "DetectInfoIdCardData": {
1508
- "document": "核身身份证图片信息",
1508
+ "document": "核身身份证图片信息。",
1509
1509
  "members": [
1510
1510
  {
1511
1511
  "disabled": false,
1512
1512
  "document": "OCR正面照片的base64编码。\n注意:此字段可能返回 null,表示取不到有效值。",
1513
- "example": "xxx",
1513
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
1514
1514
  "member": "string",
1515
1515
  "name": "OcrFront",
1516
1516
  "output_required": true,
@@ -1519,8 +1519,8 @@
1519
1519
  },
1520
1520
  {
1521
1521
  "disabled": false,
1522
- "document": "OCR反面照片的base64编码\n注意:此字段可能返回 null,表示取不到有效值。",
1523
- "example": "xxx",
1522
+ "document": "OCR反面照片的base64编码。\n注意:此字段可能返回 null,表示取不到有效值。",
1523
+ "example": "/9j/4AAQSk.../S7s2f/9k=",
1524
1524
  "member": "string",
1525
1525
  "name": "OcrBack",
1526
1526
  "output_required": true,
@@ -1530,7 +1530,7 @@
1530
1530
  {
1531
1531
  "disabled": false,
1532
1532
  "document": "旋转裁边后的正面照片base64编码。\n注意:此字段可能返回 null,表示取不到有效值。",
1533
- "example": "xxx",
1533
+ "example": "/9j/4AAQSk...PnUZx//9k=",
1534
1534
  "member": "string",
1535
1535
  "name": "ProcessedFrontImage",
1536
1536
  "output_required": true,
@@ -1540,7 +1540,7 @@
1540
1540
  {
1541
1541
  "disabled": false,
1542
1542
  "document": "旋转裁边后的背面照片base64编码。\n注意:此字段可能返回 null,表示取不到有效值。",
1543
- "example": "xxx",
1543
+ "example": "/9j/4AAQSk...Vr0Ej/2Q==",
1544
1544
  "member": "string",
1545
1545
  "name": "ProcessedBackImage",
1546
1546
  "output_required": true,
@@ -1550,7 +1550,7 @@
1550
1550
  {
1551
1551
  "disabled": false,
1552
1552
  "document": "身份证正面人像图base64编码。\n注意:此字段可能返回 null,表示取不到有效值。",
1553
- "example": "xxx",
1553
+ "example": "/9j/4AAQSk...iiiisyz//Z",
1554
1554
  "member": "string",
1555
1555
  "name": "Avatar",
1556
1556
  "output_required": true,
@@ -1559,8 +1559,8 @@
1559
1559
  },
1560
1560
  {
1561
1561
  "disabled": false,
1562
- "document": "身份证人像面告警码,开启身份证告警功能后才会返回,返回数组中可能出现的告警码如下:\n-9100 身份证有效日期不合法告警,\n-9101 身份证边框不完整告警,\n-9102 身份证复印件告警,\n-9103 身份证翻拍告警,\n-9105 身份证框内遮挡告警,\n-9104 临时身份证告警,\n-9106 身份证 PS 告警(疑似存在PS痕迹),\n-9107 身份证反光告警。\n注意:此字段可能返回 null,表示取不到有效值。",
1563
- "example": "[]",
1562
+ "document": "身份证人像面告警码。\n- 开启身份证告警功能后才会返回。\n- 返回数组中可能出现的告警码如下:\n - -9100 身份证有效日期不合法告警。\n - -9101 身份证边框不完整告警。\n - -9102 身份证复印件告警。\n - -9103 身份证翻拍告警。\n - -9105 身份证框内遮挡告警。\n - -9104 临时身份证告警。\n - -9106 身份证 PS 告警(疑似存在PS痕迹)。\n - -9107 身份证反光告警。\n注意:此字段可能返回 null,表示取不到有效值。",
1563
+ "example": "[\"-9100\"]",
1564
1564
  "member": "int64",
1565
1565
  "name": "WarnInfos",
1566
1566
  "output_required": true,
@@ -1569,8 +1569,8 @@
1569
1569
  },
1570
1570
  {
1571
1571
  "disabled": false,
1572
- "document": "身份证国徽面告警码,开启身份证告警功能后才会返回,返回数组中可能出现的告警码如下:\n-9100 身份证有效日期不合法告警,\n-9101 身份证边框不完整告警,\n-9102 身份证复印件告警,\n-9103 身份证翻拍告警,\n-9105 身份证框内遮挡告警,\n-9104 临时身份证告警,\n-9106 身份证 PS 告警(疑似存在PS痕迹),\n-9107 身份证反光告警。\n注意:此字段可能返回 null,表示取不到有效值。",
1573
- "example": "[]",
1572
+ "document": "身份证国徽面告警码。\n- 开启身份证告警功能后才会返回。\n- 返回数组中可能出现的告警码如下:\n - -9100 身份证有效日期不合法告警,\n - -9101 身份证边框不完整告警,\n - -9102 身份证复印件告警,\n - -9103 身份证翻拍告警,\n - -9105 身份证框内遮挡告警,\n - -9104 临时身份证告警,\n - -9106 身份证 PS 告警(疑似存在PS痕迹),\n - -9107 身份证反光告警。\n注意:此字段可能返回 null,表示取不到有效值。",
1573
+ "example": "[\"-9100\"]",
1574
1574
  "member": "int64",
1575
1575
  "name": "BackWarnInfos",
1576
1576
  "output_required": true,
@@ -1581,11 +1581,11 @@
1581
1581
  "usage": "out"
1582
1582
  },
1583
1583
  "DetectInfoText": {
1584
- "document": "核身文本信息",
1584
+ "document": "核身文本信息。",
1585
1585
  "members": [
1586
1586
  {
1587
1587
  "disabled": false,
1588
- "document": "本次流程最终验证结果。0为成功(仅包含活体人脸核身结果,不包含意愿核身结果)\n注意:此字段可能返回 null,表示取不到有效值。",
1588
+ "document": "本次流程最终验证结果。\n- 取值范围:0为成功。\n- 仅包含活体人脸核身结果,不包含意愿核身结果。\n注意:此字段可能返回 null,表示取不到有效值。",
1589
1589
  "example": "0",
1590
1590
  "member": "int64",
1591
1591
  "name": "ErrCode",
@@ -1595,7 +1595,7 @@
1595
1595
  },
1596
1596
  {
1597
1597
  "disabled": false,
1598
- "document": "本次流程最终验证结果描述。(仅描述用,文案更新时不会通知。)\n注意:此字段可能返回 null,表示取不到有效值。",
1598
+ "document": "本次流程最终验证结果描述。\n- 仅描述用,文案更新时不会通知。\n注意:此字段可能返回 null,表示取不到有效值。",
1599
1599
  "example": "成功",
1600
1600
  "member": "string",
1601
1601
  "name": "ErrMsg",
@@ -1606,7 +1606,7 @@
1606
1606
  {
1607
1607
  "disabled": false,
1608
1608
  "document": "本次验证使用的身份证号。\n注意:此字段可能返回 null,表示取不到有效值。",
1609
- "example": "440111111111111111",
1609
+ "example": "11204416541220243X",
1610
1610
  "member": "string",
1611
1611
  "name": "IdCard",
1612
1612
  "output_required": true,
@@ -1615,7 +1615,7 @@
1615
1615
  },
1616
1616
  {
1617
1617
  "disabled": false,
1618
- "document": "用户认证时使用的证件号码类型:\n0:二代身份证的证件号码\n1:港澳台居住证的证件号码\n2:其他(核验使用的证件号码非合法身份号码)\n注意:此字段可能返回 null,表示取不到有效值。",
1618
+ "document": "用户认证时使用的证件号码类型。\n- 取值范围:\n 0:二代身份证的证件号码。\n 1:港澳台居住证的证件号码。\n 2:其他(核验使用的证件号码非合法身份号码)。\n注意:此字段可能返回 null,表示取不到有效值。",
1619
1619
  "example": "0",
1620
1620
  "member": "uint64",
1621
1621
  "name": "UseIDType",
@@ -1626,7 +1626,7 @@
1626
1626
  {
1627
1627
  "disabled": false,
1628
1628
  "document": "本次验证使用的姓名。\n注意:此字段可能返回 null,表示取不到有效值。",
1629
- "example": "爱新觉罗永琪",
1629
+ "example": "韦小宝",
1630
1630
  "member": "string",
1631
1631
  "name": "Name",
1632
1632
  "output_required": true,
@@ -1646,7 +1646,7 @@
1646
1646
  {
1647
1647
  "disabled": false,
1648
1648
  "document": "身份校验环节识别结果:家庭住址。\n注意:此字段可能返回 null,表示取不到有效值。",
1649
- "example": "广东省",
1649
+ "example": "北京市东城区景山前街4号紫禁城敬事房",
1650
1650
  "member": "string",
1651
1651
  "name": "OcrAddress",
1652
1652
  "output_required": true,
@@ -1655,8 +1655,8 @@
1655
1655
  },
1656
1656
  {
1657
1657
  "disabled": false,
1658
- "document": "身份校验环节识别结果:生日。格式为:YYYY/M/D\n注意:此字段可能返回 null,表示取不到有效值。",
1659
- "example": "1999/1/12",
1658
+ "document": "身份校验环节识别结果:生日。\n- 格式为:YYYY/M/D\n注意:此字段可能返回 null,表示取不到有效值。",
1659
+ "example": "1995/5/13",
1660
1660
  "member": "string",
1661
1661
  "name": "OcrBirth",
1662
1662
  "output_required": true,
@@ -1666,7 +1666,7 @@
1666
1666
  {
1667
1667
  "disabled": false,
1668
1668
  "document": "身份校验环节识别结果:签发机关。\n注意:此字段可能返回 null,表示取不到有效值。",
1669
- "example": "广东省",
1669
+ "example": "北京市",
1670
1670
  "member": "string",
1671
1671
  "name": "OcrAuthority",
1672
1672
  "output_required": true,
@@ -1675,7 +1675,7 @@
1675
1675
  },
1676
1676
  {
1677
1677
  "disabled": false,
1678
- "document": "身份校验环节识别结果:有效日期。格式为:YYYY.MM.DD-YYYY.MM.DD\n注意:此字段可能返回 null,表示取不到有效值。",
1678
+ "document": "身份校验环节识别结果:有效日期。\n- 格式为:YYYY.MM.DD-YYYY.MM.DD。\n注意:此字段可能返回 null,表示取不到有效值。",
1679
1679
  "example": "1999.01.01-2009.01.01",
1680
1680
  "member": "string",
1681
1681
  "name": "OcrValidDate",
@@ -1686,7 +1686,7 @@
1686
1686
  {
1687
1687
  "disabled": false,
1688
1688
  "document": "身份校验环节识别结果:姓名。\n注意:此字段可能返回 null,表示取不到有效值。",
1689
- "example": "爱新觉罗永琪",
1689
+ "example": "韦小宝",
1690
1690
  "member": "string",
1691
1691
  "name": "OcrName",
1692
1692
  "output_required": true,
@@ -1696,7 +1696,7 @@
1696
1696
  {
1697
1697
  "disabled": false,
1698
1698
  "document": "身份校验环节识别结果:身份证号。\n注意:此字段可能返回 null,表示取不到有效值。",
1699
- "example": "440111111111111111",
1699
+ "example": "11204416541220243X",
1700
1700
  "member": "string",
1701
1701
  "name": "OcrIdCard",
1702
1702
  "output_required": true,
@@ -1706,7 +1706,7 @@
1706
1706
  {
1707
1707
  "disabled": false,
1708
1708
  "document": "身份校验环节识别结果:性别。\n注意:此字段可能返回 null,表示取不到有效值。",
1709
- "example": "",
1709
+ "example": "",
1710
1710
  "member": "string",
1711
1711
  "name": "OcrGender",
1712
1712
  "output_required": true,
@@ -1715,7 +1715,7 @@
1715
1715
  },
1716
1716
  {
1717
1717
  "disabled": false,
1718
- "document": "身份校验环节采用的信息上传方式。\n取值有\"NFC\"、\"OCR\"、\"手动输入\"、\"其他\"\n注意:此字段可能返回 null,表示取不到有效值。",
1718
+ "document": "身份校验环节采用的信息上传方式。\n- 取值有\"NFC\"、\"OCR\"、\"手动输入\"、\"其他\"\n注意:此字段可能返回 null,表示取不到有效值。",
1719
1719
  "example": "NFC",
1720
1720
  "member": "string",
1721
1721
  "name": "IdInfoFrom",
@@ -1725,7 +1725,7 @@
1725
1725
  },
1726
1726
  {
1727
1727
  "disabled": false,
1728
- "document": "本次流程最终活体结果。0为成功\n注意:此字段可能返回 null,表示取不到有效值。",
1728
+ "document": "本次流程最终活体结果。\n- 0为成功\n注意:此字段可能返回 null,表示取不到有效值。",
1729
1729
  "example": "0",
1730
1730
  "member": "int64",
1731
1731
  "name": "LiveStatus",
@@ -1735,7 +1735,7 @@
1735
1735
  },
1736
1736
  {
1737
1737
  "disabled": false,
1738
- "document": "本次流程最终活体结果描述。(仅描述用,文案更新时不会通知。)\n注意:此字段可能返回 null,表示取不到有效值。",
1738
+ "document": "本次流程最终活体结果描述。\n- 仅描述用,文案更新时不会通知。\n注意:此字段可能返回 null,表示取不到有效值。",
1739
1739
  "example": "成功",
1740
1740
  "member": "string",
1741
1741
  "name": "LiveMsg",
@@ -1745,7 +1745,7 @@
1745
1745
  },
1746
1746
  {
1747
1747
  "disabled": false,
1748
- "document": "本次流程最终一比一结果。0为成功\n注意:此字段可能返回 null,表示取不到有效值。",
1748
+ "document": "本次流程最终一比一结果。\n- 0为成功\n注意:此字段可能返回 null,表示取不到有效值。",
1749
1749
  "example": "0",
1750
1750
  "member": "int64",
1751
1751
  "name": "Comparestatus",
@@ -1755,7 +1755,7 @@
1755
1755
  },
1756
1756
  {
1757
1757
  "disabled": false,
1758
- "document": "本次流程最终一比一结果描述。(仅描述用,文案更新时不会通知。)\n注意:此字段可能返回 null,表示取不到有效值。",
1758
+ "document": "本次流程最终一比一结果描述。\n- 仅描述用,文案更新时不会通知。\n注意:此字段可能返回 null,表示取不到有效值。",
1759
1759
  "example": "成功",
1760
1760
  "member": "string",
1761
1761
  "name": "Comparemsg",
@@ -1765,7 +1765,7 @@
1765
1765
  },
1766
1766
  {
1767
1767
  "disabled": false,
1768
- "document": "本次流程活体一比一的分数,取值范围 [0.00, 100.00]。相似度大于等于70时才判断为同一人,也可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)\n注意:此字段可能返回 null,表示取不到有效值。",
1768
+ "document": "本次流程活体一比一的分数。\n- 取值范围 [0.00, 100.00]。\n- 相似度大于等于70时才判断为同一人,也可根据具体场景自行调整阈值。\n- 阈值70的误通过率为千分之一,阈值80的误通过率是万分之一。\n注意:此字段可能返回 null,表示取不到有效值。",
1769
1769
  "example": "88.3",
1770
1770
  "member": "string",
1771
1771
  "name": "Sim",
@@ -1796,7 +1796,7 @@
1796
1796
  {
1797
1797
  "disabled": false,
1798
1798
  "document": "本次流程进行的活体一比一流水。\n注意:此字段可能返回 null,表示取不到有效值。",
1799
- "example": "{}",
1799
+ "example": "",
1800
1800
  "member": "DetectDetail",
1801
1801
  "name": "LivenessDetail",
1802
1802
  "output_required": true,
@@ -1805,8 +1805,8 @@
1805
1805
  },
1806
1806
  {
1807
1807
  "disabled": false,
1808
- "document": "描述当前请求活体阶段被拒绝的详细原因,详情如下:\n01-用户全程闭眼\n02-用户未完成指定动作\n03-疑似翻拍攻击\n04-疑似合成攻击\n05-疑似黑产模版\n06-疑似存在水印\n07-反光校验未通过\n08-疑似中途换人\n09-人脸质量过差\n10-距离校验不通过\n11-疑似对抗样本攻击\n12-嘴巴区域疑似存在攻击痕迹\n13-眼睛区域疑似存在攻击痕迹\n14-眼睛或嘴巴被遮挡\n注意:此字段可能返回 null,表示取不到有效值。",
1809
- "example": "[]",
1808
+ "document": "描述当前请求活体阶段被拒绝的详细原因,该参数仅限PLUS版本核身服务返回。\n- 详情如下:\n 01-用户全程闭眼\n 02-用户未完成指定动作\n 03-疑似翻拍攻击\n 04-疑似合成攻击\n 05-疑似黑产模版\n 06-疑似存在水印\n 07-反光校验未通过\n 08-疑似中途换人\n 09-人脸质量过差\n 10-距离校验不通过\n 11-疑似对抗样本攻击\n 12-嘴巴区域疑似存在攻击痕迹\n 13-眼睛区域疑似存在攻击痕迹\n 14-眼睛或嘴巴被遮挡\n注意:此字段可能返回 null,表示取不到有效值。",
1809
+ "example": "[01]",
1810
1810
  "member": "string",
1811
1811
  "name": "LivenessInfoTag",
1812
1812
  "output_required": true,
@@ -1816,7 +1816,7 @@
1816
1816
  {
1817
1817
  "disabled": false,
1818
1818
  "document": "手机号码。\n注意:此字段可能返回 null,表示取不到有效值。",
1819
- "example": "1",
1819
+ "example": "16137688175",
1820
1820
  "member": "string",
1821
1821
  "name": "Mobile",
1822
1822
  "output_required": true,
@@ -1825,7 +1825,7 @@
1825
1825
  },
1826
1826
  {
1827
1827
  "disabled": false,
1828
- "document": "本次流程最终比对库源类型。包括:\n权威库;\n业务方自有库(用户上传照片、客户的混合库、混合部署库);\n二次验证库;\n人工审核库;\n注意:此字段可能返回 null,表示取不到有效值。",
1828
+ "document": "本次流程最终比对库源类型。\n- 取值范围:\n 权威库。\n 业务方自有库(用户上传照片、客户的混合库、混合部署库)。\n 二次验证库。\n 人工审核库。\n注意:此字段可能返回 null,表示取不到有效值。",
1829
1829
  "example": "权威库",
1830
1830
  "member": "string",
1831
1831
  "name": "CompareLibType",
@@ -1835,7 +1835,7 @@
1835
1835
  },
1836
1836
  {
1837
1837
  "disabled": false,
1838
- "document": "本次流程最终活体类型。包括:\n0:未知\n1:数字活体\n2:动作活体\n3:静默活体\n4:一闪活体(动作+光线)\n注意:此字段可能返回 null,表示取不到有效值。",
1838
+ "document": "本次流程最终活体类型。\n- 取值范围:\n 0:未知\n 1:数字活体\n 2:动作活体\n 3:静默活体\n 4:一闪活体(动作+光线)\n注意:此字段可能返回 null,表示取不到有效值。",
1839
1839
  "example": "0",
1840
1840
  "member": "uint64",
1841
1841
  "name": "LivenessMode",
@@ -1845,8 +1845,8 @@
1845
1845
  },
1846
1846
  {
1847
1847
  "disabled": false,
1848
- "document": "nfc重复计费requestId列表\n注意:此字段可能返回 null,表示取不到有效值。",
1849
- "example": "[\"\"]",
1848
+ "document": "nfc重复计费requestId列表。\n注意:此字段可能返回 null,表示取不到有效值。",
1849
+ "example": "[\"5bd763c5-3dd9-4d40-8043-00f90fe75acb\"]",
1850
1850
  "member": "string",
1851
1851
  "name": "NFCRequestIds",
1852
1852
  "output_required": true,
@@ -1855,7 +1855,7 @@
1855
1855
  },
1856
1856
  {
1857
1857
  "disabled": false,
1858
- "document": "nfc重复计费计数\n注意:此字段可能返回 null,表示取不到有效值。",
1858
+ "document": "nfc重复计费计数。\n注意:此字段可能返回 null,表示取不到有效值。",
1859
1859
  "example": "1",
1860
1860
  "member": "int64",
1861
1861
  "name": "NFCBillingCounts",
@@ -1865,8 +1865,8 @@
1865
1865
  },
1866
1866
  {
1867
1867
  "disabled": false,
1868
- "document": "港澳台居住证通行证号码\n注意:此字段可能返回 null,表示取不到有效值。",
1869
- "example": "1",
1868
+ "document": "港澳台居住证通行证号码。\n注意:此字段可能返回 null,表示取不到有效值。",
1869
+ "example": "08320271",
1870
1870
  "member": "string",
1871
1871
  "name": "PassNo",
1872
1872
  "output_required": true,
@@ -1875,8 +1875,8 @@
1875
1875
  },
1876
1876
  {
1877
1877
  "disabled": false,
1878
- "document": "港澳台居住证签发次数\n注意:此字段可能返回 null,表示取不到有效值。",
1879
- "example": "1",
1878
+ "document": "港澳台居住证签发次数。\n注意:此字段可能返回 null,表示取不到有效值。",
1879
+ "example": "02",
1880
1880
  "member": "string",
1881
1881
  "name": "VisaNum",
1882
1882
  "output_required": true,
@@ -1887,15 +1887,15 @@
1887
1887
  "usage": "out"
1888
1888
  },
1889
1889
  "DetectInfoVideoData": {
1890
- "document": "核身视频信息",
1890
+ "document": "核身视频信息。",
1891
1891
  "members": [
1892
1892
  {
1893
1893
  "disabled": false,
1894
- "document": "活体视频的base64编码\n注意:此字段可能返回 null,表示取不到有效值。",
1895
- "example": "",
1894
+ "document": "活体视频的base64编码。\n注意:此字段可能返回 null,表示取不到有效值。",
1895
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
1896
1896
  "member": "string",
1897
1897
  "name": "LivenessVideo",
1898
- "required": true,
1898
+ "output_required": true,
1899
1899
  "type": "string",
1900
1900
  "value_allowed_null": true
1901
1901
  }
@@ -1907,41 +1907,41 @@
1907
1907
  "members": [
1908
1908
  {
1909
1909
  "disabled": false,
1910
- "document": "商户方 appeIDcode 的数字证书",
1911
- "example": "1",
1910
+ "document": "商户方 appeIDcode 的数字证书。",
1911
+ "example": "DtROLOW1......UJWtn+4UNOPrC10wO/bWkP0xPDAw",
1912
1912
  "member": "string",
1913
1913
  "name": "EidCode",
1914
- "required": true,
1914
+ "output_required": true,
1915
1915
  "type": "string",
1916
1916
  "value_allowed_null": false
1917
1917
  },
1918
1918
  {
1919
1919
  "disabled": false,
1920
- "document": "Eid中心针对商户方EidCode的电子签名",
1921
- "example": "1",
1920
+ "document": "Eid中心针对商户方EidCode的电子签名。",
1921
+ "example": "RFQSPB8CxI...qi5fVVyQ==",
1922
1922
  "member": "string",
1923
1923
  "name": "EidSign",
1924
- "required": true,
1924
+ "output_required": true,
1925
1925
  "type": "string",
1926
1926
  "value_allowed_null": false
1927
1927
  },
1928
1928
  {
1929
1929
  "disabled": false,
1930
- "document": "商户方公钥加密的会话密钥的base64字符串,[指引详见](https://cloud.tencent.com/document/product/1007/63370)",
1931
- "example": "saus+9hdsdks=",
1930
+ "document": "商户方公钥加密的会话密钥的base64字符串,[指引详见](https://cloud.tencent.com/document/product/1007/63370)",
1931
+ "example": "VDsTCWy/VU...lf26IlaWD=",
1932
1932
  "member": "string",
1933
1933
  "name": "DesKey",
1934
- "required": true,
1934
+ "output_required": true,
1935
1935
  "type": "string",
1936
1936
  "value_allowed_null": false
1937
1937
  },
1938
1938
  {
1939
1939
  "disabled": false,
1940
- "document": "会话密钥sm2加密后的base64字符串,[指引详见](https://cloud.tencent.com/document/product/1007/63370)",
1941
- "example": "ug7gdwsg7898shs9=",
1940
+ "document": "会话密钥sm2加密后的base64字符串,[指引详见](https://cloud.tencent.com/document/product/1007/63370)",
1941
+ "example": "Py6yFkw90h...VenILSag==",
1942
1942
  "member": "string",
1943
1943
  "name": "UserInfo",
1944
- "required": true,
1944
+ "output_required": true,
1945
1945
  "type": "string",
1946
1946
  "value_allowed_null": false
1947
1947
  }
@@ -2114,8 +2114,8 @@
2114
2114
  "members": [
2115
2115
  {
2116
2116
  "disabled": false,
2117
- "document": "默认不需要使用",
2118
- "example": "",
2117
+ "document": "默认不需要使用。",
2118
+ "example": "",
2119
2119
  "member": "string",
2120
2120
  "name": "ActionType",
2121
2121
  "required": false,
@@ -2129,10 +2129,11 @@
2129
2129
  "members": [
2130
2130
  {
2131
2131
  "disabled": false,
2132
- "document": "动作顺序(2,1 or 1,2) 1代表张嘴,2代表闭眼。",
2133
- "example": "",
2132
+ "document": "动作顺序,例如:2,1 or 1,2。\n- 1代表张嘴,2代表闭眼。",
2133
+ "example": "2,1",
2134
2134
  "member": "string",
2135
2135
  "name": "ActionSequence",
2136
+ "output_required": true,
2136
2137
  "type": "string",
2137
2138
  "value_allowed_null": false
2138
2139
  },
@@ -2151,7 +2152,7 @@
2151
2152
  {
2152
2153
  "disabled": false,
2153
2154
  "document": "人脸核身流程的标识,调用DetectAuth接口时生成。",
2154
- "example": "CE661F1A-0F1E-45BD-BE13-34C05CEA7681",
2155
+ "example": "CF742D11-BD49-4704-A33F-B9372D6322D6",
2155
2156
  "member": "string",
2156
2157
  "name": "BizToken",
2157
2158
  "required": true,
@@ -2160,7 +2161,7 @@
2160
2161
  {
2161
2162
  "disabled": false,
2162
2163
  "document": "用于细分客户使用场景,由腾讯侧在线下对接时分配。",
2163
- "example": "0",
2164
+ "example": "5",
2164
2165
  "member": "string",
2165
2166
  "name": "RuleId",
2166
2167
  "required": true,
@@ -2168,8 +2169,8 @@
2168
2169
  },
2169
2170
  {
2170
2171
  "disabled": false,
2171
- "document": "指定拉取的结果信息,取值(0:全部;1:文本类;2:身份证信息;3:视频最佳截图信息)。\n 13表示拉取文本类、视频最佳截图信息。\n默认值:0",
2172
- "example": "1",
2172
+ "document": "指定拉取的结果信息。\n- 取值(0:全部;1:文本类;2:身份证信息;3:视频最佳截图信息)。\n- 例如 13 表示拉取文本类、视频最佳截图信息。\n- 默认值:0",
2173
+ "example": "13",
2173
2174
  "member": "string",
2174
2175
  "name": "InfoType",
2175
2176
  "required": false,
@@ -2177,8 +2178,8 @@
2177
2178
  },
2178
2179
  {
2179
2180
  "disabled": false,
2180
- "document": "从活体视频中截取一定张数的最佳帧(仅部分服务支持,若需使用请与慧眼小助手沟通)。默认为0,最大为10,超出10的最多只给10张。(InfoType需要包含3",
2181
- "example": "0",
2181
+ "document": "从活体视频中截取一定张数的最佳帧。\n- 仅部分服务支持,若需使用请与慧眼小助手沟通。\n- 默认值为0,最大值为10,超出10的最多只给10张。\n- InfoType需要包含3",
2182
+ "example": "1",
2182
2183
  "member": "uint64",
2183
2184
  "name": "BestFramesCount",
2184
2185
  "required": false,
@@ -2186,7 +2187,7 @@
2186
2187
  },
2187
2188
  {
2188
2189
  "disabled": false,
2189
- "document": "是否对身份证照片进行裁边。默认为false。(InfoType需要包含2",
2190
+ "document": "是否对身份证照片进行裁边。\n- 默认为false。\n- InfoType需要包含2",
2190
2191
  "example": "false",
2191
2192
  "member": "bool",
2192
2193
  "name": "IsCutIdCardImage",
@@ -2195,7 +2196,7 @@
2195
2196
  },
2196
2197
  {
2197
2198
  "disabled": false,
2198
- "document": "是否需要从身份证中抠出头像。默认为false。(InfoType需要包含2",
2199
+ "document": "是否需要从身份证中抠出头像。\n- 默认为false。\n- InfoType需要包含2",
2199
2200
  "example": "false",
2200
2201
  "member": "bool",
2201
2202
  "name": "IsNeedIdCardAvatar",
@@ -2213,7 +2214,7 @@
2213
2214
  },
2214
2215
  {
2215
2216
  "disabled": false,
2216
- "document": "是否需要对返回中的敏感信息进行加密。仅指定加密算法Algorithm即可,其余字段传入默认值。其中敏感信息包括:Response.Text.IdCard、Response.Text.Name、Response.Text.OcrIdCard、Response.Text.OcrName",
2217
+ "document": "是否需要对返回中的敏感信息进行加密。\n- 只需指定加密算法Algorithm即可,其余字段传入默认值。\n- 敏感信息包括:Response.Text.IdCard、Response.Text.Name、Response.Text.OcrIdCard、Response.Text.OcrName",
2217
2218
  "example": "无",
2218
2219
  "member": "Encryption",
2219
2220
  "name": "Encryption",
@@ -2222,8 +2223,8 @@
2222
2223
  },
2223
2224
  {
2224
2225
  "disabled": false,
2225
- "document": "是否对回包整体进行加密",
2226
- "example": "",
2226
+ "document": "是否对回包整体进行加密。",
2227
+ "example": "false",
2227
2228
  "member": "bool",
2228
2229
  "name": "IsEncryptResponse",
2229
2230
  "required": false,
@@ -2287,7 +2288,7 @@
2287
2288
  },
2288
2289
  {
2289
2290
  "disabled": false,
2290
- "document": "意愿核身朗读模式结果信息。若未使用意愿核身功能,该字段返回值可以不处理。\n注意:此字段可能返回 null,表示取不到有效值。",
2291
+ "document": "意愿核身朗读模式结果信息。\n- 若未使用意愿核身功能,该字段返回值可以不处理。\n注意:此字段可能返回 null,表示取不到有效值。",
2291
2292
  "example": "无",
2292
2293
  "member": "IntentionVerifyData",
2293
2294
  "name": "IntentionVerifyData",
@@ -2297,7 +2298,7 @@
2297
2298
  },
2298
2299
  {
2299
2300
  "disabled": false,
2300
- "document": "意愿核身问答模式结果。若未使用该意愿核身功能,该字段返回值可以不处理。\n注意:此字段可能返回 null,表示取不到有效值。",
2301
+ "document": "意愿核身问答模式结果。\n\n- 若未使用该意愿核身功能,该字段返回值可以不处理。\n注意:此字段可能返回 null,表示取不到有效值。",
2301
2302
  "example": "无",
2302
2303
  "member": "IntentionQuestionResult",
2303
2304
  "name": "IntentionQuestionResult",
@@ -2307,7 +2308,7 @@
2307
2308
  },
2308
2309
  {
2309
2310
  "disabled": false,
2310
- "document": "意愿核身点头确认模式的结果信息,若未使用该意愿核身功能,该字段返回值可以不处理。\n注意:此字段可能返回 null,表示取不到有效值。",
2311
+ "document": "意愿核身点头确认模式的结果信息。\n- 若未使用该意愿核身功能,该字段返回值可以不处理。\n注意:此字段可能返回 null,表示取不到有效值。",
2311
2312
  "example": "无",
2312
2313
  "member": "IntentionActionResult",
2313
2314
  "name": "IntentionActionResult",
@@ -2317,8 +2318,8 @@
2317
2318
  },
2318
2319
  {
2319
2320
  "disabled": false,
2320
- "document": "加密后的数据\n注意:此字段可能返回 null,表示取不到有效值。",
2321
- "example": "",
2321
+ "document": "加密后的数据。\n注意:此字段可能返回 null,表示取不到有效值。",
2322
+ "example": "0hMvx6fX6n...gXE0adJA==",
2322
2323
  "member": "string",
2323
2324
  "name": "EncryptedBody",
2324
2325
  "output_required": true,
@@ -2395,7 +2396,7 @@
2395
2396
  {
2396
2397
  "disabled": false,
2397
2398
  "document": "E证通流程的唯一标识,调用GetEidToken接口时生成。",
2398
- "example": "CE661F1A-0F1E-45BD-BE13-34C05CEA7681",
2399
+ "example": "CE661F1A-0F1E-45BD-BE133-34C05CEA76812",
2399
2400
  "member": "string",
2400
2401
  "name": "EidToken",
2401
2402
  "required": true,
@@ -2403,7 +2404,7 @@
2403
2404
  },
2404
2405
  {
2405
2406
  "disabled": false,
2406
- "document": "指定拉取的结果信息,取值(0:全部;1:文本类;2:身份证信息;3:最佳截图信息;5:意愿核身朗读模式相关结果;6:意愿核身问答模式相关结果)。\n 13表示拉取文本类、最佳截图信息。\n默认值:0",
2407
+ "document": "指定拉取的结果信息。\n- 取值范围:\n 0:全部。\n 1:文本类。\n 2:身份证信息。\n 3:最佳截图信息。\n 5:意愿核身朗读模式相关结果。\n 6:意愿核身问答模式相关结果。\n- 例如 13表示拉取文本类、最佳截图信息。\n- 默认值:0",
2407
2408
  "example": "1",
2408
2409
  "member": "string",
2409
2410
  "name": "InfoType",
@@ -2412,7 +2413,7 @@
2412
2413
  },
2413
2414
  {
2414
2415
  "disabled": false,
2415
- "document": "从活体视频中截取一定张数的最佳帧。默认为0,最大为3,超出3的最多只给3张。(InfoType需要包含3",
2416
+ "document": "从活体视频中截取一定张数的最佳帧。\n- 默认为0,最大为3,超出3的最多只给3张。\n- InfoType需要包含3",
2416
2417
  "example": "1",
2417
2418
  "member": "uint64",
2418
2419
  "name": "BestFramesCount",
@@ -2421,7 +2422,7 @@
2421
2422
  },
2422
2423
  {
2423
2424
  "disabled": false,
2424
- "document": "是否对身份证照片进行裁边。默认为false。(InfoType需要包含2",
2425
+ "document": "是否对身份证照片进行裁边。\n- 默认为false。\n- InfoType需要包含2",
2425
2426
  "example": "false",
2426
2427
  "member": "bool",
2427
2428
  "name": "IsCutIdCardImage",
@@ -2430,7 +2431,7 @@
2430
2431
  },
2431
2432
  {
2432
2433
  "disabled": false,
2433
- "document": "是否需要从身份证中抠出头像。默认为false。(InfoType需要包含2",
2434
+ "document": "是否需要从身份证中抠出头像。\n- 默认为false。\n- InfoType需要包含2",
2434
2435
  "example": "false",
2435
2436
  "member": "bool",
2436
2437
  "name": "IsNeedIdCardAvatar",
@@ -2445,7 +2446,7 @@
2445
2446
  "members": [
2446
2447
  {
2447
2448
  "disabled": false,
2448
- "document": "文本类信息。(基于对敏感信息的保护,验证使用的姓名和身份证号统一通过加密后从Eidinfo参数中返回,如需获取请在控制台申请返回身份信息,详见[E证通获取实名信息指引](https://cloud.tencent.com/document/product/1007/63370))\n注意:此字段可能返回 null,表示取不到有效值。",
2449
+ "document": "文本类信息。\n- 基于对敏感信息的保护,验证使用的姓名和身份证号统一通过加密后从EidInfo参数中返回。\n- 如需获取请在控制台申请返回身份信息,详见[E证通获取实名信息指引](https://cloud.tencent.com/document/product/1007/63370)。\n注意:此字段可能返回 null,表示取不到有效值。",
2449
2450
  "example": "无",
2450
2451
  "member": "DetectInfoText",
2451
2452
  "name": "Text",
@@ -2475,7 +2476,7 @@
2475
2476
  },
2476
2477
  {
2477
2478
  "disabled": false,
2478
- "document": "Eid信息。(包括商户下用户唯一标识以及加密后的姓名、身份证号信息。解密方式详见[E证通获取实名信息指引](https://cloud.tencent.com/document/product/1007/63370))\n注意:此字段可能返回 null,表示取不到有效值。",
2479
+ "document": "Eid信息。\n- 包括商户下用户唯一标识以及加密后的姓名、身份证号信息。\n- 解密方式详见[E证通获取实名信息指引](https://cloud.tencent.com/document/product/1007/63370)\n注意:此字段可能返回 null,表示取不到有效值。",
2479
2480
  "example": "无",
2480
2481
  "member": "EidInfo",
2481
2482
  "name": "EidInfo",
@@ -2485,7 +2486,7 @@
2485
2486
  },
2486
2487
  {
2487
2488
  "disabled": false,
2488
- "document": "意愿核身朗读模式相关信息。若未使用意愿核身朗读功能,该字段返回值可以不处理。\n注意:此字段可能返回 null,表示取不到有效值。",
2489
+ "document": "意愿核身朗读模式相关信息。\n- 若未使用意愿核身朗读功能,该字段返回值可以不处理。\n注意:此字段可能返回 null,表示取不到有效值。",
2489
2490
  "example": "无",
2490
2491
  "member": "IntentionVerifyData",
2491
2492
  "name": "IntentionVerifyData",
@@ -2495,7 +2496,7 @@
2495
2496
  },
2496
2497
  {
2497
2498
  "disabled": false,
2498
- "document": "意愿核身问答模式相关信息。若未使用意愿核身问答模式功能,该字段返回值可以不处理。\n注意:此字段可能返回 null,表示取不到有效值。",
2499
+ "document": "意愿核身问答模式相关信息。\n- 若未使用意愿核身问答模式功能,该字段返回值可以不处理。\n注意:此字段可能返回 null,表示取不到有效值。",
2499
2500
  "example": "无",
2500
2501
  "member": "IntentionQuestionResult",
2501
2502
  "name": "IntentionQuestionResult",
@@ -2505,7 +2506,7 @@
2505
2506
  },
2506
2507
  {
2507
2508
  "disabled": false,
2508
- "document": "意愿核身点头确认模式的结果信息,若未使用该意愿核身功能,该字段返回值可以不处理。\n注意:此字段可能返回 null,表示取不到有效值。",
2509
+ "document": "意愿核身点头确认模式的结果信息。\n- 若未使用该意愿核身功能,该字段返回值可以不处理。\n注意:此字段可能返回 null,表示取不到有效值。",
2509
2510
  "example": "无",
2510
2511
  "member": "IntentionActionResult",
2511
2512
  "name": "IntentionActionResult",
@@ -2527,7 +2528,7 @@
2527
2528
  "members": [
2528
2529
  {
2529
2530
  "disabled": false,
2530
- "document": "姓名身份证输入方式。\n1:传身份证正反面OCR \n2:传身份证正面OCR \n3:用户手动输入 \n4:客户后台传入 \n默认1\n注:使用OCR时仅支持用户修改结果中的姓名",
2531
+ "document": "姓名身份证输入方式。\n- 取值范围:\n1:传身份证正反面OCR。\n2:传身份证正面OCR。\n3:用户手动输入。\n4:客户后台传入。\n- 默认值:1。\n- 注意:使用OCR时仅支持用户修改结果中的姓名。",
2531
2532
  "example": "1",
2532
2533
  "member": "string",
2533
2534
  "name": "InputType",
@@ -2536,7 +2537,7 @@
2536
2537
  },
2537
2538
  {
2538
2539
  "disabled": false,
2539
- "document": "是否使用意愿核身,默认不使用。注意:如开启使用,则计费标签按【意愿核身】计费标签计价;如不开启,则计费标签按【E证通】计费标签计价,价格详见:[价格说明](https://cloud.tencent.com/document/product/1007/56804)。",
2540
+ "document": "是否使用意愿核身。\n\n- 默认不使用。\n- 注意:如开启使用,则计费标签按【意愿核身】计费标签计价;如不开启,则计费标签按【E证通】计费标签计价,价格详见:[价格说明](https://cloud.tencent.com/document/product/1007/56804)。",
2540
2541
  "example": "true",
2541
2542
  "member": "bool",
2542
2543
  "name": "UseIntentionVerify",
@@ -2545,7 +2546,7 @@
2545
2546
  },
2546
2547
  {
2547
2548
  "disabled": false,
2548
- "document": "意愿核身模式。枚举值:1( 语音朗读模式),2(语音问答模式) ,3(点头确认模式)。默认值为1。",
2549
+ "document": "意愿核身模式。\n- 取值范围:\n1:语音朗读模式。\n2:语音问答模式。\n3:点头确认模式。\n- 默认值为1。",
2549
2550
  "example": "1",
2550
2551
  "member": "string",
2551
2552
  "name": "IntentionMode",
@@ -2554,8 +2555,8 @@
2554
2555
  },
2555
2556
  {
2556
2557
  "disabled": false,
2557
- "document": "意愿核身朗读模式使用的文案,若未使用意愿核身朗读功能,该字段无需传入。默认为空,最长可接受120的字符串长度。",
2558
- "example": "",
2558
+ "document": "意愿核身朗读模式使用的文案。\n- 若未使用意愿核身朗读功能,该字段无需传入。\n- 默认为空,最长可接受120的字符串长度。",
2559
+ "example": "\"\"",
2559
2560
  "member": "string",
2560
2561
  "name": "IntentionVerifyText",
2561
2562
  "required": false,
@@ -2563,7 +2564,7 @@
2563
2564
  },
2564
2565
  {
2565
2566
  "disabled": false,
2566
- "document": "意愿核身问答模式的配置列表。当前仅支持一个问答。",
2567
+ "document": "意愿核身问答模式的配置列表。\n- 当前仅支持一个问答。",
2567
2568
  "example": "无",
2568
2569
  "member": "IntentionQuestion",
2569
2570
  "name": "IntentionQuestions",
@@ -2572,7 +2573,7 @@
2572
2573
  },
2573
2574
  {
2574
2575
  "disabled": false,
2575
- "document": "意愿核身(点头确认模式)使用的文案,若未使用意愿核身(点头确认模式),则该字段无需传入。默认为空,最长可接受150的字符串长度。",
2576
+ "document": "意愿核身(点头确认模式)使用的文案。\n- 若未使用意愿核身(点头确认模式),则该字段无需传入。\n- 默认为空,最长可接受150的字符串长度。",
2576
2577
  "example": "无",
2577
2578
  "member": "IntentionActionConfig",
2578
2579
  "name": "IntentionActions",
@@ -2581,7 +2582,7 @@
2581
2582
  },
2582
2583
  {
2583
2584
  "disabled": false,
2584
- "document": "意愿核身过程中识别用户的回答意图,开启后除了IntentionQuestions的Answers列表中的标准回答会通过,近似意图的回答也会通过,默认开启。",
2585
+ "document": "意愿核身过程中识别用户的回答意图。\n- 开启后除了IntentionQuestions的Answers列表中的标准回答会通过,近似意图的回答也会通过。\n- 默认开启。",
2585
2586
  "example": "true",
2586
2587
  "member": "bool",
2587
2588
  "name": "IntentionRecognition",
@@ -2590,7 +2591,7 @@
2590
2591
  },
2591
2592
  {
2592
2593
  "disabled": false,
2593
- "document": "是否支持港澳台居住证识别",
2594
+ "document": "是否支持港澳台居住证识别。",
2594
2595
  "example": "false",
2595
2596
  "member": "bool",
2596
2597
  "name": "IsSupportHMTResidentPermitOCR",
@@ -2599,7 +2600,7 @@
2599
2600
  },
2600
2601
  {
2601
2602
  "disabled": false,
2602
- "document": "用户语音回答过程中是否开启张嘴识别检测,默认不开启,仅在意愿核身问答模式中使用。",
2603
+ "document": "用户语音回答过程中是否开启张嘴识别检测。\n- 默认不开启。\n- 仅在意愿核身问答模式中使用。",
2603
2604
  "example": "false",
2604
2605
  "member": "bool",
2605
2606
  "name": "MouthOpenRecognition",
@@ -2608,7 +2609,7 @@
2608
2609
  },
2609
2610
  {
2610
2611
  "disabled": false,
2611
- "document": "意愿核身语音播报速度,配置后问答模式和点头模式的语音播报环节都会生效,默认值为0: 0:智能语速(根据播报文案的长度自动调整语音播报速度) 1:固定1倍速 2:固定1.2倍速 3:固定1.5倍速",
2612
+ "document": "意愿核身语音播报速度。\n- 配置后问答模式和点头模式的语音播报环节都会生效。\n- 默认值为0。\n- 取值范围: \n0:智能语速(根据播报文案的长度自动调整语音播报速度)。\n1:固定1倍速。\n2:固定1.2倍速。\n3:固定1.5倍速。",
2612
2613
  "example": "0",
2613
2614
  "member": "uint64",
2614
2615
  "name": "Speed",
@@ -2623,8 +2624,8 @@
2623
2624
  "members": [
2624
2625
  {
2625
2626
  "disabled": false,
2626
- "document": "EID商户id,字段长度最长50位。",
2627
- "example": "3232",
2627
+ "document": "EID商户id。\n- 字段长度最长50位。",
2628
+ "example": "0NSJ243206261600932123",
2628
2629
  "member": "string",
2629
2630
  "name": "MerchantId",
2630
2631
  "required": true,
@@ -2632,8 +2633,8 @@
2632
2633
  },
2633
2634
  {
2634
2635
  "disabled": false,
2635
- "document": "身份标识(未使用OCR服务时,必须传入)。\n规则:a-z,A-Z,0-9组合。最长长度32位。",
2636
- "example": "",
2636
+ "document": "身份标识。\n- 未使用OCR服务时,必须传入。\n- 规则:a-z,A-Z,0-9组合。\n- 最长长度32位。",
2637
+ "example": "11204416541220243X",
2637
2638
  "member": "string",
2638
2639
  "name": "IdCard",
2639
2640
  "required": false,
@@ -2641,8 +2642,8 @@
2641
2642
  },
2642
2643
  {
2643
2644
  "disabled": false,
2644
- "document": "姓名。(未使用OCR服务时,必须传入)最长长度32位。中文请使用UTF-8编码。",
2645
- "example": "",
2645
+ "document": "姓名。\n- 未使用OCR服务时,必须传入。\n- 最长长度32位。\n- 中文请使用UTF-8编码。",
2646
+ "example": "韦小宝",
2646
2647
  "member": "string",
2647
2648
  "name": "Name",
2648
2649
  "required": false,
@@ -2650,8 +2651,8 @@
2650
2651
  },
2651
2652
  {
2652
2653
  "disabled": false,
2653
- "document": "透传字段,在获取验证结果时返回。最长长度1024位。",
2654
- "example": "",
2654
+ "document": "透传字段,在获取验证结果时返回。\n- 最长长度1024位。",
2655
+ "example": "202411011707591990200060000",
2655
2656
  "member": "string",
2656
2657
  "name": "Extra",
2657
2658
  "required": false,
@@ -2668,8 +2669,8 @@
2668
2669
  },
2669
2670
  {
2670
2671
  "disabled": false,
2671
- "document": "最长长度1024位。用户从Url中进入核身认证结束后重定向的回调链接地址。EidToken会在该链接的query参数中。",
2672
- "example": "",
2672
+ "document": "用户从Url中进入核身认证结束后重定向的回调链接地址。\n- 最长长度1024位。\n- EidToken会在该链接的query参数中。",
2673
+ "example": "https://faceid.qq.com",
2673
2674
  "member": "string",
2674
2675
  "name": "RedirectUrl",
2675
2676
  "required": false,
@@ -2677,7 +2678,7 @@
2677
2678
  },
2678
2679
  {
2679
2680
  "disabled": false,
2680
- "document": "敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
2681
+ "document": "敏感数据加密信息。\n- 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
2681
2682
  "example": "无",
2682
2683
  "member": "Encryption",
2683
2684
  "name": "Encryption",
@@ -2692,8 +2693,8 @@
2692
2693
  "members": [
2693
2694
  {
2694
2695
  "disabled": false,
2695
- "document": "一次核身流程的标识,有效时间为600秒;\n完成核身后,可用该标识获取验证结果信息。",
2696
- "example": "CE661F1A-0F1E-45BD-BE13-34C05CEA7681",
2696
+ "document": "一次核身流程的标识。\n- 有效时间为600秒。\n- 完成核身后,可用该标识获取验证结果信息。",
2697
+ "example": "CE6621F1A-0F1E-45BD-BE13-34C045CEA7681",
2697
2698
  "member": "string",
2698
2699
  "name": "EidToken",
2699
2700
  "output_required": true,
@@ -2702,8 +2703,8 @@
2702
2703
  },
2703
2704
  {
2704
2705
  "disabled": false,
2705
- "document": "发起核身流程的URL,用于H5场景核身。",
2706
- "example": "https://www.qq.com",
2706
+ "document": "发起核身流程的URL。\n- 用于H5场景核身。",
2707
+ "example": "https://open.weixin.qq.com/connect/oauth2/authorize?appid=wxa50a8f2ac379585f53&redirect_uri=https%3A%2F%2Feid.faceid.qq.com%2Fapi%2Fv1%2FGetOpenId%3Ftoken%3DCE6611F1A-0F1E-455BD-BE13-34C05CEA7681&response_type=code&scope=snsapi_base&state=&component_appid=wx9802ee81e68d6dee#wechat_redirec",
2707
2708
  "member": "string",
2708
2709
  "name": "Url",
2709
2710
  "output_required": true,
@@ -2724,8 +2725,8 @@
2724
2725
  "members": [
2725
2726
  {
2726
2727
  "disabled": false,
2727
- "document": "SDK人脸核身流程的标识,调用GetFaceIdToken接口时生成。",
2728
- "example": "CE661F1A-0F1E-45BD-BE13-34C05CEA7681",
2728
+ "document": "SDK人脸核身流程的标识。\n- 调用GetFaceIdToken接口时生成。",
2729
+ "example": "CE6613F1A-0F1E-45BD-BE13-34C05CEA76181",
2729
2730
  "member": "string",
2730
2731
  "name": "FaceIdToken",
2731
2732
  "required": true,
@@ -2733,7 +2734,7 @@
2733
2734
  },
2734
2735
  {
2735
2736
  "disabled": false,
2736
- "document": "是否需要拉取视频,默认false不需要",
2737
+ "document": "是否需要拉取视频。\n- 默认false:不需要。",
2737
2738
  "example": "false",
2738
2739
  "member": "bool",
2739
2740
  "name": "IsNeedVideo",
@@ -2742,7 +2743,7 @@
2742
2743
  },
2743
2744
  {
2744
2745
  "disabled": false,
2745
- "document": "是否需要拉取截帧,默认false不需要",
2746
+ "document": "是否需要拉取截帧。\n- 默认false:不需要。",
2746
2747
  "example": "false",
2747
2748
  "member": "bool",
2748
2749
  "name": "IsNeedBestFrame",
@@ -2757,8 +2758,8 @@
2757
2758
  "members": [
2758
2759
  {
2759
2760
  "disabled": false,
2760
- "document": "身份证",
2761
- "example": "23232323232",
2761
+ "document": "身份证。",
2762
+ "example": "11204416541220243X",
2762
2763
  "member": "string",
2763
2764
  "name": "IdCard",
2764
2765
  "output_required": true,
@@ -2767,8 +2768,8 @@
2767
2768
  },
2768
2769
  {
2769
2770
  "disabled": false,
2770
- "document": "姓名",
2771
- "example": "王五",
2771
+ "document": "姓名。",
2772
+ "example": "韦小宝",
2772
2773
  "member": "string",
2773
2774
  "name": "Name",
2774
2775
  "output_required": true,
@@ -2777,7 +2778,7 @@
2777
2778
  },
2778
2779
  {
2779
2780
  "disabled": false,
2780
- "document": "业务核验结果,参考https://cloud.tencent.com/document/product/1007/47912",
2781
+ "document": "业务核验结果。\n- 参考:https://cloud.tencent.com/document/product/1007/47912",
2781
2782
  "example": "0",
2782
2783
  "member": "string",
2783
2784
  "name": "Result",
@@ -2787,7 +2788,7 @@
2787
2788
  },
2788
2789
  {
2789
2790
  "disabled": false,
2790
- "document": "业务核验描述",
2791
+ "document": "业务核验描述。",
2791
2792
  "example": "成功",
2792
2793
  "member": "string",
2793
2794
  "name": "Description",
@@ -2797,7 +2798,7 @@
2797
2798
  },
2798
2799
  {
2799
2800
  "disabled": false,
2800
- "document": "相似度,0-100,数值越大相似度越高",
2801
+ "document": "相似度。\n- 取值:0-100。\n- 数值越大相似度越高。",
2801
2802
  "example": "97.7",
2802
2803
  "member": "float",
2803
2804
  "name": "Similarity",
@@ -2807,8 +2808,8 @@
2807
2808
  },
2808
2809
  {
2809
2810
  "disabled": false,
2810
- "document": "用户核验的视频base64,如果选择了使用cos,返回完整cos地址如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey\n注意:此字段可能返回 null,表示取不到有效值。",
2811
- "example": "xx",
2811
+ "document": "用户核验的视频base64。\n- 如果选择了使用cos,返回完整cos地址,如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey。\n注意:此字段可能返回 null,表示取不到有效值。",
2812
+ "example": "AAAAGGZ0eX...5Zin4btI4A",
2812
2813
  "member": "string",
2813
2814
  "name": "VideoBase64",
2814
2815
  "output_required": true,
@@ -2817,8 +2818,8 @@
2817
2818
  },
2818
2819
  {
2819
2820
  "disabled": false,
2820
- "document": "用户核验视频的截帧base64,如果选择了使用cos,返回完整cos地址如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey\n注意:此字段可能返回 null,表示取不到有效值。",
2821
- "example": "xx",
2821
+ "document": "用户核验视频的截帧base64。\n- 如果选择了使用cos,返回完整cos地址如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey。\n注意:此字段可能返回 null,表示取不到有效值。",
2822
+ "example": "/9j/4AAQSk...TYkEBjj//Z",
2822
2823
  "member": "string",
2823
2824
  "name": "BestFrameBase64",
2824
2825
  "output_required": true,
@@ -2827,8 +2828,8 @@
2827
2828
  },
2828
2829
  {
2829
2830
  "disabled": false,
2830
- "document": "获取token时透传的信息\n注意:此字段可能返回 null,表示取不到有效值。",
2831
- "example": "xx",
2831
+ "document": "获取token时透传的信息。\n注意:此字段可能返回 null,表示取不到有效值。",
2832
+ "example": "202411011707591990200060000",
2832
2833
  "member": "string",
2833
2834
  "name": "Extra",
2834
2835
  "output_required": true,
@@ -2837,7 +2838,7 @@
2837
2838
  },
2838
2839
  {
2839
2840
  "disabled": false,
2840
- "document": "plus版:描述当前请求所在设备的风险标签,详情如下:\n01-设备疑似被Root/设备疑似越狱\n02-设备疑似被注入\n03-设备疑似为模拟器\n04-设备疑似存在风险操作\n05-摄像头疑似被劫持\n06-疑似黑产设备\nnull-无设备风险\n增强版:此字段不生效,默认为null\n注意:此字段可能返回 null,表示取不到有效值。",
2841
+ "document": "plus版:描述当前请求所在设备的风险标签。\n- 详情如下:\n01-设备疑似被Root/设备疑似越狱。\n02-设备疑似被注入。\n03-设备疑似为模拟器。\n04-设备疑似存在风险操作。\n05-摄像头疑似被劫持。\n06-疑似黑产设备。\nnull-无设备风险。\n- 增强版:此字段不生效,默认为null。\n注意:此字段可能返回 null,表示取不到有效值。",
2841
2842
  "example": "01",
2842
2843
  "member": "string",
2843
2844
  "name": "DeviceInfoTag",
@@ -2847,7 +2848,7 @@
2847
2848
  },
2848
2849
  {
2849
2850
  "disabled": false,
2850
- "document": "行为风险标签,仅错误码返回1007(设备疑似被劫持)时返回风险标签。标签说明:\n02:攻击风险\n注意:此字段可能返回 null,表示取不到有效值。",
2851
+ "document": "行为风险标签。\n- 仅错误码返回1007(设备疑似被劫持)时返回风险标签。\n- 标签说明:\n02:攻击风险\n注意:此字段可能返回 null,表示取不到有效值。",
2851
2852
  "example": "02",
2852
2853
  "member": "string",
2853
2854
  "name": "RiskInfoTag",
@@ -2857,7 +2858,7 @@
2857
2858
  },
2858
2859
  {
2859
2860
  "disabled": false,
2860
- "document": "plus版:描述当前请求活体阶段被拒绝的详细原因,详情如下:01-用户全程闭眼02-用户未完成指定动作03-疑似翻拍攻击04-疑似合成图片05-疑似合成视频06-疑似合成动作07-疑似黑产模板08-疑似存在水印09-反光校验未通过10-最佳帧校验未通过11-人脸质量过差12-人脸距离不匹配13-疑似对抗样本攻击null-无增强版:此字段不生效,默认为null\n注意:此字段可能返回 null,表示取不到有效值。",
2861
+ "document": "plus版:描述当前请求活体阶段被拒绝的详细原因。\n- 详情如下:\n01-用户全程闭眼。\n02-用户未完成指定动作。\n03-疑似翻拍攻击。\n04-疑似合成图片。\n05-疑似合成视频。\n06-疑似合成动作。\n07-疑似黑产模板。\n08-疑似存在水印。\n09-反光校验未通过。\n10-最佳帧校验未通过。\n11-人脸质量过差。\n12-人脸距离不匹配。\n13-疑似对抗样本攻击。\nnull-无。\n- 增强版:此字段不生效,默认为null。\n注意:此字段可能返回 null,表示取不到有效值。",
2861
2862
  "example": "01",
2862
2863
  "member": "string",
2863
2864
  "name": "LivenessInfoTag",
@@ -2867,7 +2868,7 @@
2867
2868
  },
2868
2869
  {
2869
2870
  "disabled": false,
2870
- "document": "plus版:描述当前请求所在设备的风险等级,共4级,详情如下:\n1 - 安全\n2 - 低风险\n3 - 中风险\n4 - 高危\nnull - 未获取到风险等级\n增强版:此字段不生效,默认为null\n注意:此字段可能返回 null,表示取不到有效值。",
2871
+ "document": "plus版:描述当前请求所在设备的风险等级,共4级。\n- 详情如下:\n1 - 安全。\n2 - 低风险。\n3 - 中风险。\n4 - 高危。\nnull - 未获取到风险等级。\n- 增强版:此字段不生效,默认为null。\n注意:此字段可能返回 null,表示取不到有效值。",
2871
2872
  "example": "1",
2872
2873
  "member": "string",
2873
2874
  "name": "DeviceInfoLevel",
@@ -2890,7 +2891,7 @@
2890
2891
  {
2891
2892
  "disabled": false,
2892
2893
  "document": "SDK人脸核身流程的标识,调用GetFaceidRiskInfoToken接口时生成。",
2893
- "example": "CE661F1A-0F1E-45BD-BE13-34C05CEA7681",
2894
+ "example": "CE6621F1A-0F1E-45BD-BE13-34C025CEA7681",
2894
2895
  "member": "string",
2895
2896
  "name": "FaceIdToken",
2896
2897
  "required": true,
@@ -2904,7 +2905,7 @@
2904
2905
  "members": [
2905
2906
  {
2906
2907
  "disabled": false,
2907
- "document": "描述当前请求所在设备的风险标签,详情如下: 01-设备疑似被Root/设备疑似越狱 02-设备疑似被注入 03-设备疑似为模拟器 04-设备疑似存在风险操作 05-摄像头疑似被劫持 06-疑似黑产设备\n注意:此字段可能返回 null,表示取不到有效值。",
2908
+ "document": "描述当前请求所在设备的风险标签\n- 详情如下:\n01-设备疑似被Root/设备疑似越狱。\n02-设备疑似被注入。\n03-设备疑似为模拟器。\n04-设备疑似存在风险操作。\n05-摄像头疑似被劫持。\n06-疑似黑产设备。\n注意:此字段可能返回 null,表示取不到有效值。",
2908
2909
  "example": "01_03",
2909
2910
  "member": "string",
2910
2911
  "name": "DeviceInfoTag",
@@ -2914,7 +2915,7 @@
2914
2915
  },
2915
2916
  {
2916
2917
  "disabled": false,
2917
- "document": "描述当前请求所在设备的风险等级,共4级,详情如下: 1 - 低风险 2 - 中风险 3 - 高风险 4 - 攻击 ,-1表示未获取到风险等级\n注意:此字段可能返回 null,表示取不到有效值。",
2918
+ "document": "描述当前请求所在设备的风险等级,共4级。\n- 详情如下:\n 1 - 低风险。\n 2 - 中风险。\n 3 - 高风险。\n 4 - 攻击。 \n-1表示未获取到风险等级。\n注意:此字段可能返回 null,表示取不到有效值。",
2918
2919
  "example": "1",
2919
2920
  "member": "int64",
2920
2921
  "name": "DeviceInfoLevel",
@@ -2924,8 +2925,8 @@
2924
2925
  },
2925
2926
  {
2926
2927
  "disabled": false,
2927
- "document": "设备id标识\n注意:此字段可能返回 null,表示取不到有效值。",
2928
- "example": "",
2928
+ "document": "设备id标识。\n注意:此字段可能返回 null,表示取不到有效值。",
2929
+ "example": "DB1904203FA986234030BDFAB",
2929
2930
  "member": "string",
2930
2931
  "name": "OpenId",
2931
2932
  "output_required": true,
@@ -2934,7 +2935,7 @@
2934
2935
  },
2935
2936
  {
2936
2937
  "disabled": false,
2937
- "document": "描述当前请求所在设备的相机指纹风险等级,共4级,详情如下: 1 - 低风险 2 - 中风险 3 - 高风险 4 - 攻击 ,-1表示未获取到风险等级\n注意:此字段可能返回 null,表示取不到有效值。",
2938
+ "document": "描述当前请求所在设备的相机指纹风险等级,共4级。\n- 详情如下:\n 1 - 低风险。\n 2 - 中风险。\n 3 - 高风险。\n 4 - 攻击。\n -1表示未获取到风险等级。\n注意:此字段可能返回 null,表示取不到有效值。",
2938
2939
  "example": "1",
2939
2940
  "member": "int64",
2940
2941
  "name": "CameraInfoLevel",
@@ -2944,7 +2945,7 @@
2944
2945
  },
2945
2946
  {
2946
2947
  "disabled": false,
2947
- "document": "描述当前请求所在设备的相机指纹风险标签,详情如下: 01-设备疑似被Root/设备疑似越狱 02-设备疑似被注入 03-设备疑似为模拟器 04-设备疑似存在风险操作 05-摄像头疑似被劫持 06-疑似黑产设备,空表示没有相机指纹风险\n注意:此字段可能返回 null,表示取不到有效值。",
2948
+ "document": "描述当前请求所在设备的相机指纹风险标签。\n\n- 详情如下:\n 01-设备疑似被Root/设备疑似越狱。\n 02-设备疑似被注入。\n 03-设备疑似为模拟器。\n 04-设备疑似存在风险操作。\n 05-摄像头疑似被劫持。\n 06-疑似黑产设备。\n 空表示没有相机指纹风险。\n注意:此字段可能返回 null,表示取不到有效值。",
2948
2949
  "example": "01_03",
2949
2950
  "member": "string",
2950
2951
  "name": "CameraInfoTag",
@@ -2954,7 +2955,7 @@
2954
2955
  },
2955
2956
  {
2956
2957
  "disabled": false,
2957
- "document": "获取token时透传的信息\t\n注意:此字段可能返回 null,表示取不到有效值。",
2958
+ "document": "获取token时透传的信息。\n注意:此字段可能返回 null,表示取不到有效值。",
2958
2959
  "example": "无",
2959
2960
  "member": "string",
2960
2961
  "name": "Extra",
@@ -2976,7 +2977,7 @@
2976
2977
  "members": [
2977
2978
  {
2978
2979
  "disabled": false,
2979
- "document": "本地上传照片(LOCAL)、商业库(BUSINESS)",
2980
+ "document": "比对库。\n- 取值范围:\nLOCAL:本地上传照片。\nBUSINESS:商业库。",
2980
2981
  "example": "BUSINESS",
2981
2982
  "member": "string",
2982
2983
  "name": "CompareLib",
@@ -2985,8 +2986,8 @@
2985
2986
  },
2986
2987
  {
2987
2988
  "disabled": false,
2988
- "document": "CompareLib为商业库时必传。",
2989
- "example": "xxxxxxxxxxxxxxxxx",
2989
+ "document": "身份证。\n- CompareLib为商业库时必传。",
2990
+ "example": "11204416541220243X",
2990
2991
  "member": "string",
2991
2992
  "name": "IdCard",
2992
2993
  "required": false,
@@ -2994,8 +2995,8 @@
2994
2995
  },
2995
2996
  {
2996
2997
  "disabled": false,
2997
- "document": "CompareLib为商业库时必传。",
2998
- "example": "xxxxxxxxxxxxxxxxx",
2998
+ "document": "姓名。\n- CompareLib为商业库时必传。",
2999
+ "example": "韦小宝",
2999
3000
  "member": "string",
3000
3001
  "name": "Name",
3001
3002
  "required": false,
@@ -3003,8 +3004,8 @@
3003
3004
  },
3004
3005
  {
3005
3006
  "disabled": false,
3006
- "document": "CompareLib为上传照片比对时必传,Base64后图片最大8MB。\n请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。",
3007
- "example": "1",
3007
+ "document": "图片的Base64。\n- CompareLib为上传照片比对时必传。\n- Base64后图片最大8MB。\n- 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。",
3008
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
3008
3009
  "member": "string",
3009
3010
  "name": "ImageBase64",
3010
3011
  "required": false,
@@ -3012,8 +3013,8 @@
3012
3013
  },
3013
3014
  {
3014
3015
  "disabled": false,
3015
- "document": "SDK中生成的Meta字符串",
3016
- "example": "1",
3016
+ "document": "SDK中生成的Meta字符串。",
3017
+ "example": "\"\"",
3017
3018
  "member": "string",
3018
3019
  "name": "Meta",
3019
3020
  "required": false,
@@ -3021,8 +3022,8 @@
3021
3022
  },
3022
3023
  {
3023
3024
  "disabled": false,
3024
- "document": "透传参数 1000长度字符串",
3025
- "example": "1",
3025
+ "document": "透传参数。\n- 1000长度字符串",
3026
+ "example": "\"\"",
3026
3027
  "member": "string",
3027
3028
  "name": "Extra",
3028
3029
  "required": false,
@@ -3030,7 +3031,7 @@
3030
3031
  },
3031
3032
  {
3032
3033
  "disabled": false,
3033
- "document": "默认为false,设置该参数为true后,核身过程中的视频图片将会存储在人脸核身控制台授权cos的bucket中,拉取结果时会返回对应资源完整cos地址。开通地址见https://console.cloud.tencent.com/faceid/cos\n【注意】选择该参数为true后将不返回base64数据,请根据接入情况谨慎修改。",
3034
+ "document": "是否使用cos桶。\n- 默认为false。\n- 设置该参数为true后,核身过程中的视频图片将会存储在人脸核身控制台授权cos的bucket中,拉取结果时会返回对应资源完整cos地址。\n- 开通地址见https://console.cloud.tencent.com/faceid/cos\n- 【注意】选择该参数为true后将不返回base64数据,请根据接入情况谨慎修改。",
3034
3035
  "example": "true",
3035
3036
  "member": "bool",
3036
3037
  "name": "UseCos",
@@ -3048,8 +3049,8 @@
3048
3049
  },
3049
3050
  {
3050
3051
  "disabled": false,
3051
- "document": "用于细分客户使用场景,申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。如有疑问,请添加腾讯云人脸核身小助手进行咨询。\n示例值:1",
3052
- "example": "1",
3052
+ "document": "用于细分客户使用场景。\n- 申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。\n- 如有疑问,请添加腾讯云人脸核身小助手进行咨询。",
3053
+ "example": "12",
3053
3054
  "member": "string",
3054
3055
  "name": "RuleId",
3055
3056
  "required": false,
@@ -3063,8 +3064,8 @@
3063
3064
  "members": [
3064
3065
  {
3065
3066
  "disabled": false,
3066
- "document": "有效期 10分钟。只能完成1次核身。",
3067
- "example": "asdasdadasdasd",
3067
+ "document": "token值。- 有效期 10分钟。- 只能完成1次核身。",
3068
+ "example": "42S4B131D-5974-4674-EABB-8FFF1EC99F189",
3068
3069
  "member": "string",
3069
3070
  "name": "FaceIdToken",
3070
3071
  "output_required": true,
@@ -3085,8 +3086,8 @@
3085
3086
  "members": [
3086
3087
  {
3087
3088
  "disabled": false,
3088
- "document": "SDK中生成的Meta字符串",
3089
- "example": "1",
3089
+ "document": "SDK中生成的Meta字符串。",
3090
+ "example": "\"\"",
3090
3091
  "member": "string",
3091
3092
  "name": "Meta",
3092
3093
  "required": false,
@@ -3094,8 +3095,8 @@
3094
3095
  },
3095
3096
  {
3096
3097
  "disabled": false,
3097
- "document": "透传参数 1000长度字符串",
3098
- "example": "1",
3098
+ "document": "透传参数 1000长度字符串。",
3099
+ "example": "\"\"",
3099
3100
  "member": "string",
3100
3101
  "name": "Extra",
3101
3102
  "required": false,
@@ -3110,7 +3111,7 @@
3110
3111
  {
3111
3112
  "disabled": false,
3112
3113
  "document": "有效期 10分钟。只能完成1次核身。",
3113
- "example": "9C6677E5-053C-425C-B5C3-D378427DFE28",
3114
+ "example": "9C66717E5-053C-425C-B5C3-D3784271DFE28",
3114
3115
  "member": "string",
3115
3116
  "name": "FaceIdToken",
3116
3117
  "output_required": true,
@@ -3136,11 +3137,11 @@
3136
3137
  "members": [
3137
3138
  {
3138
3139
  "disabled": false,
3139
- "document": "数字验证码,如:1234",
3140
+ "document": "数字验证码。",
3140
3141
  "example": "4392",
3141
3142
  "member": "string",
3142
3143
  "name": "LiveCode",
3143
- "required": true,
3144
+ "output_required": true,
3144
3145
  "type": "string",
3145
3146
  "value_allowed_null": false
3146
3147
  },
@@ -3233,8 +3234,8 @@
3233
3234
  "members": [
3234
3235
  {
3235
3236
  "disabled": false,
3236
- "document": "身份证号\n姓名和身份证号、ImageBase64、ImageUrl三者必须提供其中之一。若都提供了,则按照姓名和身份证号>ImageBase64>ImageUrl的优先级使用参数。",
3237
- "example": "360*************50",
3237
+ "document": "身份证号。\n- 姓名和身份证号、ImageBase64、ImageUrl三者必须提供其中之一。\n- 若都提供了,则按照姓名和身份证号>ImageBase64>ImageUrl的优先级使用参数。",
3238
+ "example": "11204416541220243X",
3238
3239
  "member": "string",
3239
3240
  "name": "IdCard",
3240
3241
  "required": false,
@@ -3242,8 +3243,8 @@
3242
3243
  },
3243
3244
  {
3244
3245
  "disabled": false,
3245
- "document": "姓名",
3246
- "example": "**杰",
3246
+ "document": "姓名。",
3247
+ "example": "韦小宝",
3247
3248
  "member": "string",
3248
3249
  "name": "Name",
3249
3250
  "required": false,
@@ -3251,8 +3252,8 @@
3251
3252
  },
3252
3253
  {
3253
3254
  "disabled": false,
3254
- "document": "身份证人像面的 Base64 值\n支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。\n支持的图片大小:所下载图片经Base64编码后不超过 3M。请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。",
3255
- "example": "\"\"",
3255
+ "document": "身份证人像面的 Base64 值。\n- 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。\n- 支持的图片大小:所下载图片经Base64编码后不超过 3M。请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。",
3256
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
3256
3257
  "member": "string",
3257
3258
  "name": "ImageBase64",
3258
3259
  "required": false,
@@ -3260,8 +3261,8 @@
3260
3261
  },
3261
3262
  {
3262
3263
  "disabled": false,
3263
- "document": "身份证人像面的 Url 地址\n支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。\n支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。\n图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。\n非腾讯云存储的 Url 速度和稳定性可能受一定影响。",
3264
- "example": "\"\"",
3264
+ "document": "身份证人像面的 Url 地址。\n- 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。\n- 支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。\n- 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。\n- 非腾讯云存储的 Url 速度和稳定性可能受一定影响。",
3265
+ "example": "https://www.qq.com/image.jpg",
3265
3266
  "member": "string",
3266
3267
  "name": "ImageUrl",
3267
3268
  "required": false,
@@ -3269,7 +3270,7 @@
3269
3270
  },
3270
3271
  {
3271
3272
  "disabled": false,
3272
- "document": "敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
3273
+ "document": "敏感数据加密信息。\n- 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
3273
3274
  "example": "无",
3274
3275
  "member": "Encryption",
3275
3276
  "name": "Encryption",
@@ -3284,11 +3285,11 @@
3284
3285
  "members": [
3285
3286
  {
3286
3287
  "disabled": false,
3287
- "document": "认证结果码,收费情况如下。\n收费结果码:\n0: 姓名和身份证号一致\n-1: 姓名和身份证号不一致\n不收费结果码:\n-2: 非法身份证号(长度、校验位等不正确)\n-3: 非法姓名(长度、格式等不正确)\n-4: 证件库服务异常\n-5: 证件库中无此身份证记录\n-6: 权威比对系统升级中,请稍后再试\n-7: 认证次数超过当日限制",
3288
+ "document": "认证结果码,收费情况如下。\n- 收费结果码:\n0: 姓名和身份证号一致。\n-1: 姓名和身份证号不一致。\n- 不收费结果码:\n-2: 非法身份证号(长度、校验位等不正确)。\n-3: 非法姓名(长度、格式等不正确)。\n-4: 证件库服务异常。\n-5: 证件库中无此身份证记录。\n-6: 权威比对系统升级中,请稍后再试。\n-7: 认证次数超过当日限制。",
3288
3289
  "example": "0",
3289
3290
  "member": "string",
3290
3291
  "name": "Result",
3291
- "required": true,
3292
+ "output_required": true,
3292
3293
  "type": "string",
3293
3294
  "value_allowed_null": false
3294
3295
  },
@@ -3298,67 +3299,67 @@
3298
3299
  "example": "姓名和身份证号一致",
3299
3300
  "member": "string",
3300
3301
  "name": "Description",
3301
- "required": true,
3302
+ "output_required": true,
3302
3303
  "type": "string",
3303
3304
  "value_allowed_null": false
3304
3305
  },
3305
3306
  {
3306
3307
  "disabled": false,
3307
- "document": "用于验证的姓名",
3308
- "example": "**杰",
3308
+ "document": "用于验证的姓名。",
3309
+ "example": "韦小宝",
3309
3310
  "member": "string",
3310
3311
  "name": "Name",
3311
- "required": true,
3312
+ "output_required": true,
3312
3313
  "type": "string",
3313
3314
  "value_allowed_null": false
3314
3315
  },
3315
3316
  {
3316
3317
  "disabled": false,
3317
- "document": "用于验证的身份证号",
3318
- "example": "360*************50",
3318
+ "document": "用于验证的身份证号。",
3319
+ "example": "11204416541220243X",
3319
3320
  "member": "string",
3320
3321
  "name": "IdCard",
3321
- "required": true,
3322
+ "output_required": true,
3322
3323
  "type": "string",
3323
3324
  "value_allowed_null": false
3324
3325
  },
3325
3326
  {
3326
3327
  "disabled": false,
3327
- "document": "OCR得到的性别\n注意:此字段可能返回 null,表示取不到有效值。",
3328
+ "document": "OCR得到的性别。\n注意:此字段可能返回 null,表示取不到有效值。",
3328
3329
  "example": "男",
3329
3330
  "member": "string",
3330
3331
  "name": "Sex",
3331
- "required": true,
3332
+ "output_required": true,
3332
3333
  "type": "string",
3333
3334
  "value_allowed_null": true
3334
3335
  },
3335
3336
  {
3336
3337
  "disabled": false,
3337
- "document": "OCR得到的民族\n注意:此字段可能返回 null,表示取不到有效值。",
3338
+ "document": "OCR得到的民族。\n注意:此字段可能返回 null,表示取不到有效值。",
3338
3339
  "example": "汉",
3339
3340
  "member": "string",
3340
3341
  "name": "Nation",
3341
- "required": true,
3342
+ "output_required": true,
3342
3343
  "type": "string",
3343
3344
  "value_allowed_null": true
3344
3345
  },
3345
3346
  {
3346
3347
  "disabled": false,
3347
- "document": "OCR得到的生日\n注意:此字段可能返回 null,表示取不到有效值。",
3348
- "example": "\"\"",
3348
+ "document": "OCR得到的生日。\n注意:此字段可能返回 null,表示取不到有效值。",
3349
+ "example": "1654/12/20",
3349
3350
  "member": "string",
3350
3351
  "name": "Birth",
3351
- "required": true,
3352
+ "output_required": true,
3352
3353
  "type": "string",
3353
3354
  "value_allowed_null": true
3354
3355
  },
3355
3356
  {
3356
3357
  "disabled": false,
3357
- "document": "OCR得到的地址\n注意:此字段可能返回 null,表示取不到有效值。",
3358
- "example": "\"\"",
3358
+ "document": "OCR得到的地址。\n注意:此字段可能返回 null,表示取不到有效值。",
3359
+ "example": "北京市东城区景山前街4号紫禁城敬事房",
3359
3360
  "member": "string",
3360
3361
  "name": "Address",
3361
- "required": true,
3362
+ "output_required": true,
3362
3363
  "type": "string",
3363
3364
  "value_allowed_null": true
3364
3365
  },
@@ -3376,8 +3377,8 @@
3376
3377
  "members": [
3377
3378
  {
3378
3379
  "disabled": false,
3379
- "document": "身份证号",
3380
- "example": "xxxxxxxxxxxxxxxxx",
3380
+ "document": "身份证号。",
3381
+ "example": "11204416541220243X",
3381
3382
  "member": "string",
3382
3383
  "name": "IdCard",
3383
3384
  "required": true,
@@ -3385,8 +3386,8 @@
3385
3386
  },
3386
3387
  {
3387
3388
  "disabled": false,
3388
- "document": "姓名",
3389
- "example": "xxxxxxxxxxxxxxxxx",
3389
+ "document": "姓名。",
3390
+ "example": "韦小宝",
3390
3391
  "member": "string",
3391
3392
  "name": "Name",
3392
3393
  "required": true,
@@ -3394,7 +3395,7 @@
3394
3395
  },
3395
3396
  {
3396
3397
  "disabled": false,
3397
- "document": "敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
3398
+ "document": "敏感数据加密信息。\n- 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
3398
3399
  "example": "无",
3399
3400
  "member": "Encryption",
3400
3401
  "name": "Encryption",
@@ -3409,7 +3410,7 @@
3409
3410
  "members": [
3410
3411
  {
3411
3412
  "disabled": false,
3412
- "document": "认证结果码,收费情况如下。\n收费结果码:\n0: 姓名和身份证号一致\n-1: 姓名和身份证号不一致\n不收费结果码:\n-2: 非法身份证号(长度、校验位等不正确)\n-3: 非法姓名(长度、格式等不正确)\n-4: 证件库服务异常\n-5: 证件库中无此身份证记录\n-6: 权威比对系统升级中,请稍后再试\n-7: 认证次数超过当日限制",
3413
+ "document": "认证结果码,收费情况如下。\n- 收费结果码:\n0: 姓名和身份证号一致\n-1: 姓名和身份证号不一致\n不收费结果码:\n-2: 非法身份证号(长度、校验位等不正确)\n-3: 非法姓名(长度、格式等不正确)\n-4: 证件库服务异常\n-5: 证件库中无此身份证记录\n-6: 权威比对系统升级中,请稍后再试\n-7: 认证次数超过当日限制",
3413
3414
  "example": "0",
3414
3415
  "member": "string",
3415
3416
  "name": "Result",
@@ -3534,7 +3535,7 @@
3534
3535
  "members": [
3535
3536
  {
3536
3537
  "disabled": false,
3537
- "document": "身份证号",
3538
+ "document": "身份证号。",
3538
3539
  "example": "11204416541220243X",
3539
3540
  "member": "string",
3540
3541
  "name": "IdCard",
@@ -3543,7 +3544,7 @@
3543
3544
  },
3544
3545
  {
3545
3546
  "disabled": false,
3546
- "document": "姓名。中文请使用UTF-8编码。",
3547
+ "document": "姓名。\n- 中文请使用UTF-8编码。",
3547
3548
  "example": "韦小宝",
3548
3549
  "member": "string",
3549
3550
  "name": "Name",
@@ -3553,7 +3554,7 @@
3553
3554
  {
3554
3555
  "disabled": false,
3555
3556
  "document": "用于人脸比对的照片,图片的Base64值;\nBase64编码后的图片数据大小不超过3M,仅支持jpg、png格式。\n请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。",
3556
- "example": "<ImageBase64>",
3557
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
3557
3558
  "member": "string",
3558
3559
  "name": "ImageBase64",
3559
3560
  "required": true,
@@ -3570,7 +3571,7 @@
3570
3571
  },
3571
3572
  {
3572
3573
  "disabled": false,
3573
- "document": "敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
3574
+ "document": "敏感数据加密信息。\n- 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
3574
3575
  "example": "无",
3575
3576
  "member": "Encryption",
3576
3577
  "name": "Encryption",
@@ -3585,7 +3586,7 @@
3585
3586
  "members": [
3586
3587
  {
3587
3588
  "disabled": false,
3588
- "document": "相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)",
3589
+ "document": "相似度。\n- 取值范围 [0.00, 100.00]。\n- 推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)",
3589
3590
  "example": "89.88",
3590
3591
  "member": "float",
3591
3592
  "name": "Sim",
@@ -3595,7 +3596,7 @@
3595
3596
  },
3596
3597
  {
3597
3598
  "disabled": false,
3598
- "document": "业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分",
3599
+ "document": "业务错误码。\n- 成功情况返回Success。\n- 错误情况请参考下方错误码 列表中FailedOperation部分",
3599
3600
  "example": "Success",
3600
3601
  "member": "string",
3601
3602
  "name": "Result",
@@ -3679,7 +3680,7 @@
3679
3680
  {
3680
3681
  "disabled": false,
3681
3682
  "document": "视频base64编码(其中包含全程提示文本和点头音频,mp4格式)\n注意:此字段可能返回 null,表示取不到有效值。",
3682
- "example": "VideoBase64String",
3683
+ "example": "AAAAIGZ0eX...0tLS0tLS8=",
3683
3684
  "member": "string",
3684
3685
  "name": "Video",
3685
3686
  "output_required": true,
@@ -3689,7 +3690,7 @@
3689
3690
  {
3690
3691
  "disabled": false,
3691
3692
  "document": "屏幕截图base64编码列表\n注意:此字段可能返回 null,表示取不到有效值。",
3692
- "example": "ScreenShotBase64String",
3693
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
3693
3694
  "member": "string",
3694
3695
  "name": "ScreenShot",
3695
3696
  "output_required": true,
@@ -3704,7 +3705,7 @@
3704
3705
  "members": [
3705
3706
  {
3706
3707
  "disabled": false,
3707
- "document": "当选择语音问答模式时,系统自动播报的问题文本,最大长度为150个字符。",
3708
+ "document": "当选择语音问答模式时,系统自动播报的问题文本。\n- 最大长度为150个字符。",
3708
3709
  "example": "请问您本次业务是本人自愿办理吗?如是,请回复“我同意”。",
3709
3710
  "member": "string",
3710
3711
  "name": "Question",
@@ -3713,7 +3714,7 @@
3713
3714
  },
3714
3715
  {
3715
3716
  "disabled": false,
3716
- "document": "当选择语音问答模式时,用于判断用户回答是否通过的标准答案列表,传入后可自动判断用户回答文本是否在标准文本列表中。列表长度最大为50,单个答案长度限制10个字符。",
3717
+ "document": "当选择语音问答模式时,用于判断用户回答是否通过的标准答案列表。\n- 传入后可自动判断用户回答文本是否在标准文本列表中。\n- 列表长度最大为50,单个答案长度限制10个字符。",
3717
3718
  "example": "“同意”,“我同意”,“确认”,“我确认”",
3718
3719
  "member": "string",
3719
3720
  "name": "Answers",
@@ -3724,12 +3725,12 @@
3724
3725
  "usage": "in"
3725
3726
  },
3726
3727
  "IntentionQuestionResult": {
3727
- "document": "意愿核身问答模式结果",
3728
+ "document": "意愿核身问答模式结果。",
3728
3729
  "members": [
3729
3730
  {
3730
3731
  "disabled": false,
3731
- "document": "意愿核身错误码:\n0: \"成功\" \n-1: \"参数错误\" \n-2: \"系统异常\" \n-101: \"请保持人脸在框内\" \n-102: \"检测到多张人脸\" \n-103: \"人脸检测失败\" \n-104: \"人脸检测不完整\" \n-105: \"请勿遮挡眼睛\" \n-106: \"请勿遮挡嘴巴\" \n-107: \"请勿遮挡鼻子\" \n-201: \"人脸比对相似度低\" \n-202: \"人脸比对失败\" \n-301: \"意愿核验不通过\" \n-302: \"用户回答阶段未检测到张嘴动作\" \n-800: \"前端不兼容错误\" \n-801: \"用户未授权摄像头和麦克风权限\" \n-802: \"核验流程异常中断,请勿切屏或进行其他操作\" \n-803: \"用户主动关闭链接/异常断开链接\" \n-998: \"系统数据异常\" \n-999: \"系统未知错误,请联系人工核实\" \n若在人脸核身过程失败、未进入意愿确认过程,则该参数返回为空,请参考人脸核身错误码结果(DetectInfoText.ErrCode)\n注意:此字段可能返回 null,表示取不到有效值。",
3732
- "example": "",
3732
+ "document": "意愿核身错误码。\n- 取值范围:\n 0: \"成功\" \n -1: \"参数错误\" \n -2: \"系统异常\" \n -101: \"请保持人脸在框内\" \n -102: \"检测到多张人脸\" \n -103: \"人脸检测失败\" \n -104: \"人脸检测不完整\" \n -105: \"请勿遮挡眼睛\" \n -106: \"请勿遮挡嘴巴\" \n -107: \"请勿遮挡鼻子\" \n -201: \"人脸比对相似度低\" \n -202: \"人脸比对失败\" \n -301: \"意愿核验不通过\" \n -302: \"用户回答阶段未检测到张嘴动作\" \n -800: \"前端不兼容错误\" \n -801: \"用户未授权摄像头和麦克风权限\" \n -802: \"核验流程异常中断,请勿切屏或进行其他操作\" \n -803: \"用户主动关闭链接/异常断开链接\" \n -998: \"系统数据异常\" \n -999: \"系统未知错误,请联系人工核实\" \n- 若在人脸核身过程失败、未进入意愿确认过程,则该参数返回为空,请参考人脸核身错误码结果(DetectInfoText.ErrCode)\n注意:此字段可能返回 null,表示取不到有效值。",
3733
+ "example": "\"-202\"",
3733
3734
  "member": "int64",
3734
3735
  "name": "FinalResultDetailCode",
3735
3736
  "output_required": true,
@@ -3738,8 +3739,8 @@
3738
3739
  },
3739
3740
  {
3740
3741
  "disabled": false,
3741
- "document": "意愿核身错误信息\n注意:此字段可能返回 null,表示取不到有效值。",
3742
- "example": "",
3742
+ "document": "意愿核身错误信息。\n注意:此字段可能返回 null,表示取不到有效值。",
3743
+ "example": "人脸比对失败",
3743
3744
  "member": "string",
3744
3745
  "name": "FinalResultMessage",
3745
3746
  "output_required": true,
@@ -3748,8 +3749,8 @@
3748
3749
  },
3749
3750
  {
3750
3751
  "disabled": false,
3751
- "document": "视频base64(其中包含全程问题和回答音频,mp4格式)\n注意:此字段可能返回 null,表示取不到有效值。",
3752
- "example": "",
3752
+ "document": "视频base64。\n- 其中包含全程问题和回答音频,mp4格式。\n注意:此字段可能返回 null,表示取不到有效值。",
3753
+ "example": "/9j/4AAQSk...1fp8+5/9k=",
3753
3754
  "member": "string",
3754
3755
  "name": "Video",
3755
3756
  "output_required": true,
@@ -3758,8 +3759,8 @@
3758
3759
  },
3759
3760
  {
3760
3761
  "disabled": false,
3761
- "document": "屏幕截图base64列表\n注意:此字段可能返回 null,表示取不到有效值。",
3762
- "example": "",
3762
+ "document": "屏幕截图base64列表。\n注意:此字段可能返回 null,表示取不到有效值。",
3763
+ "example": "[\"/9j/4AAQSkZJRg.....s97n//2Q==\"]",
3763
3764
  "member": "string",
3764
3765
  "name": "ScreenShot",
3765
3766
  "output_required": true,
@@ -3768,7 +3769,7 @@
3768
3769
  },
3769
3770
  {
3770
3771
  "disabled": false,
3771
- "document": "和答案匹配结果列表\n0:成功,-1:不匹配\n注意:此字段可能返回 null,表示取不到有效值。",
3772
+ "document": "和答案匹配结果列表。\n- 取值范围(0:成功;-1:不匹配)\n注意:此字段可能返回 null,表示取不到有效值。",
3772
3773
  "example": "0",
3773
3774
  "member": "string",
3774
3775
  "name": "ResultCode",
@@ -3778,8 +3779,8 @@
3778
3779
  },
3779
3780
  {
3780
3781
  "disabled": false,
3781
- "document": "回答问题语音识别结果列表\n注意:此字段可能返回 null,表示取不到有效值。",
3782
- "example": "",
3782
+ "document": "回答问题语音识别结果列表。\n注意:此字段可能返回 null,表示取不到有效值。",
3783
+ "example": "\"\"",
3783
3784
  "member": "string",
3784
3785
  "name": "AsrResult",
3785
3786
  "output_required": true,
@@ -3788,8 +3789,8 @@
3788
3789
  },
3789
3790
  {
3790
3791
  "disabled": false,
3791
- "document": "答案录音音频\n注意:此字段可能返回 null,表示取不到有效值。",
3792
- "example": "",
3792
+ "document": "答案录音音频。\n注意:此字段可能返回 null,表示取不到有效值。",
3793
+ "example": "\"\"",
3793
3794
  "member": "string",
3794
3795
  "name": "Audios",
3795
3796
  "output_required": true,
@@ -3798,7 +3799,7 @@
3798
3799
  },
3799
3800
  {
3800
3801
  "disabled": false,
3801
- "document": "意愿核身最终结果:\n0:认证通过,-1:认证未通过,-2:浏览器内核不兼容,无法进行意愿校验。建议使用“FinalResultDetailCode”参数获取详细的错误码信息。\n注意:此字段可能返回 null,表示取不到有效值。",
3802
+ "document": "意愿核身最终结果。\n- 取值范围:\n0:认证通过。\n-1:认证未通过。\n-2:浏览器内核不兼容,无法进行意愿校验。\n- 建议使用“FinalResultDetailCode”参数获取详细的错误码信息。\n注意:此字段可能返回 null,表示取不到有效值。",
3802
3803
  "example": "0",
3803
3804
  "member": "string",
3804
3805
  "name": "FinalResultCode",
@@ -3810,12 +3811,12 @@
3810
3811
  "usage": "out"
3811
3812
  },
3812
3813
  "IntentionVerifyData": {
3813
- "document": "意愿核身相关结果",
3814
+ "document": "意愿核身相关结果。",
3814
3815
  "members": [
3815
3816
  {
3816
3817
  "disabled": false,
3817
- "document": "意愿确认环节中录制的视频(base64)。若不存在则为空字符串。\n注意:此字段可能返回 null,表示取不到有效值。",
3818
- "example": "",
3818
+ "document": "意愿确认环节中录制的视频(base64)。\n- 若不存在则为空字符串。\n注意:此字段可能返回 null,表示取不到有效值。",
3819
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
3819
3820
  "member": "string",
3820
3821
  "name": "IntentionVerifyVideo",
3821
3822
  "output_required": true,
@@ -3824,8 +3825,8 @@
3824
3825
  },
3825
3826
  {
3826
3827
  "disabled": false,
3827
- "document": "意愿确认环节中用户语音转文字的识别结果。若不存在则为空字符串。\n注意:此字段可能返回 null,表示取不到有效值。",
3828
- "example": "",
3828
+ "document": "意愿确认环节中用户语音转文字的识别结果。\n- 若不存在则为空字符串。\n注意:此字段可能返回 null,表示取不到有效值。",
3829
+ "example": "\"\"",
3829
3830
  "member": "string",
3830
3831
  "name": "AsrResult",
3831
3832
  "output_required": true,
@@ -3834,7 +3835,7 @@
3834
3835
  },
3835
3836
  {
3836
3837
  "disabled": false,
3837
- "document": "意愿确认环节的结果码。当该结果码为0时,语音朗读的视频与语音识别结果才会返回。\n注意:此字段可能返回 null,表示取不到有效值。",
3838
+ "document": "意愿确认环节的结果码。\n- 当该结果码为0时,语音朗读的视频与语音识别结果才会返回。\n注意:此字段可能返回 null,表示取不到有效值。",
3838
3839
  "example": "0",
3839
3840
  "member": "int64",
3840
3841
  "name": "ErrorCode",
@@ -3845,7 +3846,7 @@
3845
3846
  {
3846
3847
  "disabled": false,
3847
3848
  "document": "意愿确认环节的结果信息。\n注意:此字段可能返回 null,表示取不到有效值。",
3848
- "example": "",
3849
+ "example": "\"\"",
3849
3850
  "member": "string",
3850
3851
  "name": "ErrorMessage",
3851
3852
  "output_required": true,
@@ -3854,8 +3855,8 @@
3854
3855
  },
3855
3856
  {
3856
3857
  "disabled": false,
3857
- "document": "意愿确认环节中录制视频的最佳帧(base64)。若不存在则为空字符串。\n注意:此字段可能返回 null,表示取不到有效值。",
3858
- "example": "",
3858
+ "document": "意愿确认环节中录制视频的最佳帧(base64)。\n- 若不存在则为空字符串。\n注意:此字段可能返回 null,表示取不到有效值。",
3859
+ "example": "/9j/4AAQSk...+0s8R/ef/Z",
3859
3860
  "member": "string",
3860
3861
  "name": "IntentionVerifyBestFrame",
3861
3862
  "output_required": true,
@@ -3880,8 +3881,8 @@
3880
3881
  "members": [
3881
3882
  {
3882
3883
  "disabled": false,
3883
- "document": "活体检测类型,取值:LIP/ACTION/SILENT。\nLIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。",
3884
- "example": "\"\"",
3884
+ "document": "活体检测类型。\n- 取值:LIP/ACTION/SILENT。\n- LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。",
3885
+ "example": "LIP",
3885
3886
  "member": "string",
3886
3887
  "name": "LivenessType",
3887
3888
  "required": true,
@@ -3889,8 +3890,8 @@
3889
3890
  },
3890
3891
  {
3891
3892
  "disabled": false,
3892
- "document": "用于人脸比对的照片的Base64值;\nBase64编码后的图片数据大小不超过3M,仅支持jpg、png格式。\n请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。\n\n图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageBase64。",
3893
- "example": "\"\"",
3893
+ "document": "用于人脸比对的照片的Base64值。\n- Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。\n- 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。\n- 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageBase64。",
3894
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
3894
3895
  "member": "string",
3895
3896
  "name": "ImageBase64",
3896
3897
  "required": false,
@@ -3898,8 +3899,8 @@
3898
3899
  },
3899
3900
  {
3900
3901
  "disabled": false,
3901
- "document": "用于人脸比对照片的URL地址;图片下载后经Base64编码后的数据大小不超过3M,仅支持jpg、png格式。\n\n图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageBase64。\n\n图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。",
3902
- "example": "\"\"",
3902
+ "document": "用于人脸比对照片的URL地址。\n- 图片下载后经Base64编码后的数据大小不超过3M,仅支持jpg、png格式。\n- 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageBase64。\n- 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。\n- 非腾讯云存储的 Url 速度和稳定性可能受一定影响。",
3903
+ "example": "http://www.qq.com/image.jpg",
3903
3904
  "member": "string",
3904
3905
  "name": "ImageUrl",
3905
3906
  "required": false,
@@ -3907,8 +3908,8 @@
3907
3908
  },
3908
3909
  {
3909
3910
  "disabled": false,
3910
- "document": "数字模式传参:传数字验证码,验证码需先调用<a href=\"https://cloud.tencent.com/document/product/1007/31821\">获取数字验证码接口</a>得到;\n动作模式传参:传动作顺序,动作顺序需先调用<a href=\"https://cloud.tencent.com/document/product/1007/31822\">获取动作顺序接口</a>得到;\n静默模式传参:空。",
3911
- "example": "\"\"",
3911
+ "document": "验证数据。\n- 数字模式传参:传数字验证码,验证码需先调用<a href=\"https://cloud.tencent.com/document/product/1007/31821\">获取数字验证码接口</a>得到;\n- 动作模式传参:传动作顺序,动作顺序需先调用<a href=\"https://cloud.tencent.com/document/product/1007/31822\">获取动作顺序接口</a>得到;\n- 静默模式传参:空。",
3912
+ "example": "2,1",
3912
3913
  "member": "string",
3913
3914
  "name": "ValidateData",
3914
3915
  "required": false,
@@ -3916,8 +3917,8 @@
3916
3917
  },
3917
3918
  {
3918
3919
  "disabled": false,
3919
- "document": "额外配置,传入JSON字符串。\n{\n\"BestFrameNum\": 2 //需要返回多张最佳截图,取值范围2-10\n}",
3920
- "example": "\"\"",
3920
+ "document": "额外配置,传入JSON字符串。\n\n- 格式如下:\n{\n\"BestFrameNum\": 2 //需要返回多张最佳截图,取值范围2-10\n}",
3921
+ "example": "{\\\"BestFrameNum\\\":1}",
3921
3922
  "member": "string",
3922
3923
  "name": "Optional",
3923
3924
  "required": false,
@@ -3925,8 +3926,8 @@
3925
3926
  },
3926
3927
  {
3927
3928
  "disabled": false,
3928
- "document": "用于活体检测的视频,视频的Base64值;\nBase64编码后的大小不超过8M,支持mp4、avi、flv格式。\n请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。\n\n视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。",
3929
- "example": "\"\"",
3929
+ "document": "用于活体检测的视频,视频的Base64值。\n- Base64编码后的大小不超过8M,支持mp4、avi、flv格式。\n- 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。\n- 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。",
3930
+ "example": "AAAAIGZ0eX...0tLS0tLS8=",
3930
3931
  "member": "string",
3931
3932
  "name": "VideoBase64",
3932
3933
  "required": false,
@@ -3934,8 +3935,8 @@
3934
3935
  },
3935
3936
  {
3936
3937
  "disabled": false,
3937
- "document": "用于活体检测的视频Url 地址。视频下载后经Base64编码后不超过 8M,视频下载耗时不超过4S,支持mp4、avi、flv格式。\n\n视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。\n\n建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议视频存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。",
3938
- "example": "\"\"",
3938
+ "document": "用于活体检测的视频Url 地址。\n- 视频下载后经Base64编码后不超过 8M,视频下载耗时不超过4S,支持mp4、avi、flv格式。\n- 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。\n- 建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议视频存储于腾讯云。\n- 非腾讯云存储的 Url 速度和稳定性可能受一定影响。",
3939
+ "example": "http://www.qq.com/video.mp4",
3939
3940
  "member": "string",
3940
3941
  "name": "VideoUrl",
3941
3942
  "required": false,
@@ -3949,51 +3950,51 @@
3949
3950
  "members": [
3950
3951
  {
3951
3952
  "disabled": false,
3952
- "document": "验证通过后的视频最佳截图照片,照片为BASE64编码后的值,jpg格式。\n注意:此字段可能返回 null,表示取不到有效值。",
3953
- "example": "\"\"",
3953
+ "document": "验证通过后的视频最佳截图照片。\n- 照片为BASE64编码后的值,jpg格式。\n注意:此字段可能返回 null,表示取不到有效值。",
3954
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
3954
3955
  "member": "string",
3955
3956
  "name": "BestFrameBase64",
3956
- "required": true,
3957
+ "output_required": true,
3957
3958
  "type": "string",
3958
3959
  "value_allowed_null": true
3959
3960
  },
3960
3961
  {
3961
3962
  "disabled": false,
3962
- "document": "相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)。",
3963
- "example": "\"\"",
3963
+ "document": "相似度。\n- 取值范围 [0.00, 100.00]。\n- 推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)。",
3964
+ "example": "88.33",
3964
3965
  "member": "float",
3965
3966
  "name": "Sim",
3966
- "required": true,
3967
+ "output_required": true,
3967
3968
  "type": "float",
3968
3969
  "value_allowed_null": false
3969
3970
  },
3970
3971
  {
3971
3972
  "disabled": false,
3972
- "document": "业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分",
3973
- "example": "\"\"",
3973
+ "document": "业务错误码。\n- 成功情况返回Success。\n- 错误情况请参考下方错误码,列表中FailedOperation部分。",
3974
+ "example": "Success",
3974
3975
  "member": "string",
3975
3976
  "name": "Result",
3976
- "required": true,
3977
+ "output_required": true,
3977
3978
  "type": "string",
3978
3979
  "value_allowed_null": false
3979
3980
  },
3980
3981
  {
3981
3982
  "disabled": false,
3982
3983
  "document": "业务结果描述。",
3983
- "example": "\"\"",
3984
+ "example": "成功",
3984
3985
  "member": "string",
3985
3986
  "name": "Description",
3986
- "required": true,
3987
+ "output_required": true,
3987
3988
  "type": "string",
3988
3989
  "value_allowed_null": false
3989
3990
  },
3990
3991
  {
3991
3992
  "disabled": false,
3992
- "document": "最佳截图列表,仅在配置了返回多张最佳截图时返回。\n注意:此字段可能返回 null,表示取不到有效值。",
3993
- "example": "\"\"",
3993
+ "document": "最佳截图列表。\n- 仅在配置了返回多张最佳截图时返回。\n注意:此字段可能返回 null,表示取不到有效值。",
3994
+ "example": "[\"/9j/4AAQSk...vv56s//9k=\"]",
3994
3995
  "member": "string",
3995
3996
  "name": "BestFrameList",
3996
- "required": true,
3997
+ "output_required": true,
3997
3998
  "type": "list",
3998
3999
  "value_allowed_null": true
3999
4000
  },
@@ -4011,7 +4012,7 @@
4011
4012
  "members": [
4012
4013
  {
4013
4014
  "disabled": false,
4014
- "document": "身份证号",
4015
+ "document": "身份证号。",
4015
4016
  "example": "11204416541220243X",
4016
4017
  "member": "string",
4017
4018
  "name": "IdCard",
@@ -4020,7 +4021,7 @@
4020
4021
  },
4021
4022
  {
4022
4023
  "disabled": false,
4023
- "document": "姓名。中文请使用UTF-8编码。",
4024
+ "document": "姓名。\n- 中文请使用UTF-8编码。",
4024
4025
  "example": "韦小宝",
4025
4026
  "member": "string",
4026
4027
  "name": "Name",
@@ -4029,7 +4030,7 @@
4029
4030
  },
4030
4031
  {
4031
4032
  "disabled": false,
4032
- "document": "活体检测类型,取值:LIP/ACTION/SILENT。\nLIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。",
4033
+ "document": "活体检测类型。\n- 取值:LIP/ACTION/SILENT。\n- LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。",
4033
4034
  "example": "SILENT",
4034
4035
  "member": "string",
4035
4036
  "name": "LivenessType",
@@ -4039,7 +4040,7 @@
4039
4040
  {
4040
4041
  "disabled": false,
4041
4042
  "document": "用于活体检测的视频,视频的BASE64值;\nBASE64编码后的大小不超过8M,支持mp4、avi、flv格式。",
4042
- "example": "<VideoBase64>",
4043
+ "example": "AAAAIGZ0eX...0tLS0tLS8=",
4043
4044
  "member": "string",
4044
4045
  "name": "VideoBase64",
4045
4046
  "required": false,
@@ -4047,8 +4048,8 @@
4047
4048
  },
4048
4049
  {
4049
4050
  "disabled": false,
4050
- "document": "用于活体检测的视频Url 地址。视频下载后经Base64编码不超过 8M,视频下载耗时不超过4S,支持mp4、avi、flv格式。\n\n视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。\n\n建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议视频存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。",
4051
- "example": "",
4051
+ "document": "用于活体检测的视频Url 地址。\n- 视频下载后经Base64编码不超过 8M,视频下载耗时不超过4S,支持mp4、avi、flv格式。\n- 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。\n- 建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议视频存储于腾讯云。\n- 非腾讯云存储的 Url 速度和稳定性可能受一定影响。",
4052
+ "example": "http://www.qq.com/image.jpg",
4052
4053
  "member": "string",
4053
4054
  "name": "VideoUrl",
4054
4055
  "required": false,
@@ -4056,8 +4057,8 @@
4056
4057
  },
4057
4058
  {
4058
4059
  "disabled": false,
4059
- "document": "数字模式传参:传数字验证码,验证码需先调用<a href=\"https://cloud.tencent.com/document/product/1007/31821\">获取数字验证码接口</a>得到;\n动作模式传参:传动作顺序,动作顺序需先调用<a href=\"https://cloud.tencent.com/document/product/1007/31822\">获取动作顺序接口</a>得到;\n静默模式传参:空。",
4060
- "example": "1234",
4060
+ "document": "验证数据。\n- 数字模式传参:传数字验证码,验证码需先调用<a href=\"https://cloud.tencent.com/document/product/1007/31821\">获取数字验证码接口</a>得到;\n- 动作模式传参:传动作顺序,动作顺序需先调用<a href=\"https://cloud.tencent.com/document/product/1007/31822\">获取动作顺序接口</a>得到;\n- 静默模式传参:空。",
4061
+ "example": "4903",
4061
4062
  "member": "string",
4062
4063
  "name": "ValidateData",
4063
4064
  "required": false,
@@ -4065,8 +4066,8 @@
4065
4066
  },
4066
4067
  {
4067
4068
  "disabled": false,
4068
- "document": "额外配置,传入JSON字符串。\n{\n\"BestFrameNum\": 2 //需要返回多张最佳截图,取值范围2-10\n}",
4069
- "example": "{}",
4069
+ "document": "额外配置,传入JSON字符串。\n- 格式如下:\n{\n\"BestFrameNum\": 2 //需要返回多张最佳截图,取值范围2-10\n}",
4070
+ "example": "{\\\"BestFrameNum\\\":1}",
4070
4071
  "member": "string",
4071
4072
  "name": "Optional",
4072
4073
  "required": false,
@@ -4074,7 +4075,7 @@
4074
4075
  },
4075
4076
  {
4076
4077
  "disabled": false,
4077
- "document": "敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
4078
+ "document": "敏感数据加密信息。\n- 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
4078
4079
  "example": "无",
4079
4080
  "member": "Encryption",
4080
4081
  "name": "Encryption",
@@ -4089,8 +4090,8 @@
4089
4090
  "members": [
4090
4091
  {
4091
4092
  "disabled": false,
4092
- "document": "验证通过后的视频最佳截图照片,照片为BASE64编码后的值,jpg格式。\n注意:此字段可能返回 null,表示取不到有效值。",
4093
- "example": "<Imagebase64>",
4093
+ "document": "验证通过后的视频最佳截图照片。\n- 照片为BASE64编码后的值,jpg格式。\n注意:此字段可能返回 null,表示取不到有效值。",
4094
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
4094
4095
  "member": "string",
4095
4096
  "name": "BestFrameBase64",
4096
4097
  "output_required": true,
@@ -4099,7 +4100,7 @@
4099
4100
  },
4100
4101
  {
4101
4102
  "disabled": false,
4102
- "document": "相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)",
4103
+ "document": "相似度。\n- 取值范围 [0.00, 100.00]。\n- 推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)",
4103
4104
  "example": "89.88",
4104
4105
  "member": "float",
4105
4106
  "name": "Sim",
@@ -4109,7 +4110,7 @@
4109
4110
  },
4110
4111
  {
4111
4112
  "disabled": false,
4112
- "document": "业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分",
4113
+ "document": "业务错误码。\n- 成功情况返回Success。\n- 错误情况请参考下方错误码 列表中FailedOperation部分",
4113
4114
  "example": "Success",
4114
4115
  "member": "string",
4115
4116
  "name": "Result",
@@ -4130,7 +4131,7 @@
4130
4131
  {
4131
4132
  "disabled": false,
4132
4133
  "document": "最佳截图列表,仅在配置了返回多张最佳截图时返回。\n注意:此字段可能返回 null,表示取不到有效值。",
4133
- "example": "",
4134
+ "example": "[\"/9j/4AAQSk...Kff7/+Af/Z\"]",
4134
4135
  "member": "string",
4135
4136
  "name": "BestFrameList",
4136
4137
  "output_required": true,
@@ -4334,8 +4335,8 @@
4334
4335
  "members": [
4335
4336
  {
4336
4337
  "disabled": false,
4337
- "document": "手机号码",
4338
- "example": "13800138000",
4338
+ "document": "手机号码。",
4339
+ "example": "16137688175",
4339
4340
  "member": "string",
4340
4341
  "name": "Mobile",
4341
4342
  "required": true,
@@ -4343,7 +4344,7 @@
4343
4344
  },
4344
4345
  {
4345
4346
  "disabled": false,
4346
- "document": "敏感数据加密信息。对传入信息(手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
4347
+ "document": "敏感数据加密信息。\n- 对传入信息(手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
4347
4348
  "example": "无",
4348
4349
  "member": "Encryption",
4349
4350
  "name": "Encryption",
@@ -4358,7 +4359,7 @@
4358
4359
  "members": [
4359
4360
  {
4360
4361
  "disabled": false,
4361
- "document": "认证结果码,收费情况如下。\n收费结果码:\n0: 成功\n-2: 手机号不存在\n-3: 手机号存在,但无法查询到在网时长\n不收费结果码:\n-1: 手机号格式不正确\n-4: 验证中心服务繁忙\n-5:认证次数超过当日限制,请次日重试",
4362
+ "document": "认证结果码,收费情况如下。\n- 收费结果码:\n0: 成功。\n-2: 手机号不存在。\n-3: 手机号存在,但无法查询到在网时长。\n\n- 不收费结果码:\n-1: 手机号格式不正确。\n-4: 验证中心服务繁忙。\n-5:认证次数超过当日限制,请次日重试。",
4362
4363
  "example": "0",
4363
4364
  "member": "string",
4364
4365
  "name": "Result",
@@ -4378,7 +4379,7 @@
4378
4379
  },
4379
4380
  {
4380
4381
  "disabled": false,
4381
- "document": "在网时长区间。\n格式为(a,b],表示在网时长在a个月以上,b个月以下。若b为+时表示没有上限。",
4382
+ "document": "在网时长区间。\n- 格式为(a,b],表示在网时长在a个月以上,b个月以下。\n- 若b为+时表示没有上限。",
4382
4383
  "example": "(23,+]",
4383
4384
  "member": "string",
4384
4385
  "name": "Range",
@@ -4400,8 +4401,8 @@
4400
4401
  "members": [
4401
4402
  {
4402
4403
  "disabled": false,
4403
- "document": "手机号码",
4404
- "example": "13800138000",
4404
+ "document": "手机号码。",
4405
+ "example": "16137688175",
4405
4406
  "member": "string",
4406
4407
  "name": "Mobile",
4407
4408
  "required": true,
@@ -4409,7 +4410,7 @@
4409
4410
  },
4410
4411
  {
4411
4412
  "disabled": false,
4412
- "document": "敏感数据加密信息。对传入信息(手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
4413
+ "document": "敏感数据加密信息。\n- 对传入信息(手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
4413
4414
  "example": "无",
4414
4415
  "member": "Encryption",
4415
4416
  "name": "Encryption",
@@ -4424,7 +4425,7 @@
4424
4425
  "members": [
4425
4426
  {
4426
4427
  "disabled": false,
4427
- "document": "认证结果码,收费情况如下。\n收费结果码:\n0:成功\n不收费结果码:\n-1:未查询到结果\n-2:手机号格式不正确\n-3:验证中心服务繁忙\n-4:认证次数超过当日限制,请次日重试",
4428
+ "document": "认证结果码,收费情况如下。\n- 收费结果码:\n0:成功。\n\n- 不收费结果码:\n-1:未查询到结果。\n-2:手机号格式不正确。\n-3:验证中心服务繁忙。\n-4:认证次数超过当日限制,请次日重试。",
4428
4429
  "example": "0",
4429
4430
  "member": "string",
4430
4431
  "name": "Result",
@@ -4444,7 +4445,7 @@
4444
4445
  },
4445
4446
  {
4446
4447
  "disabled": false,
4447
- "document": "状态码:\n0:正常\n1:停机\n2:销号\n3:空号\n4:不在网\n99:未知状态",
4448
+ "document": "状态码。\n- 取值范围:\n0:正常。\n1:停机。\n2:销号。\n3:空号。\n4:不在网。\n99:未知状态。",
4448
4449
  "example": "1",
4449
4450
  "member": "int64",
4450
4451
  "name": "StatusCode",
@@ -4466,8 +4467,8 @@
4466
4467
  "members": [
4467
4468
  {
4468
4469
  "disabled": false,
4469
- "document": "前端SDK返回",
4470
- "example": "ECBEC1E6-F05A-40DE-9CC3-C9EF19F55FE1",
4470
+ "document": "前端SDK返回。",
4471
+ "example": "ECBEC11E6-F05A-40DE-9CC3-C9EF119F55FE1",
4471
4472
  "member": "string",
4472
4473
  "name": "ReqId",
4473
4474
  "required": true,
@@ -4481,121 +4482,121 @@
4481
4482
  "members": [
4482
4483
  {
4483
4484
  "disabled": false,
4484
- "document": "0为首次查询成功,-1为查询失败。\n注意:此字段可能返回 null,表示取不到有效值。",
4485
+ "document": "结果码。\n- 取值范围:0为首次查询成功,-1为查询失败。\n注意:此字段可能返回 null,表示取不到有效值。",
4485
4486
  "example": "0",
4486
4487
  "member": "string",
4487
4488
  "name": "ResultCode",
4488
- "required": true,
4489
+ "output_required": true,
4489
4490
  "type": "string",
4490
4491
  "value_allowed_null": true
4491
4492
  },
4492
4493
  {
4493
4494
  "disabled": false,
4494
- "document": "身份证号\n注意:此字段可能返回 null,表示取不到有效值。",
4495
- "example": "12345",
4495
+ "document": "身份证号。\n注意:此字段可能返回 null,表示取不到有效值。",
4496
+ "example": "11204416541220243X",
4496
4497
  "member": "string",
4497
4498
  "name": "IdNum",
4498
- "required": true,
4499
+ "output_required": true,
4499
4500
  "type": "string",
4500
4501
  "value_allowed_null": true
4501
4502
  },
4502
4503
  {
4503
4504
  "disabled": false,
4504
- "document": "姓名\n注意:此字段可能返回 null,表示取不到有效值。",
4505
- "example": "李四",
4505
+ "document": "姓名。\n注意:此字段可能返回 null,表示取不到有效值。",
4506
+ "example": "韦小宝",
4506
4507
  "member": "string",
4507
4508
  "name": "Name",
4508
- "required": true,
4509
+ "output_required": true,
4509
4510
  "type": "string",
4510
4511
  "value_allowed_null": true
4511
4512
  },
4512
4513
  {
4513
4514
  "disabled": false,
4514
- "document": "照片\n注意:此字段可能返回 null,表示取不到有效值。",
4515
- "example": "",
4515
+ "document": "照片。\n注意:此字段可能返回 null,表示取不到有效值。",
4516
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
4516
4517
  "member": "string",
4517
4518
  "name": "Picture",
4518
- "required": true,
4519
+ "output_required": true,
4519
4520
  "type": "string",
4520
4521
  "value_allowed_null": true
4521
4522
  },
4522
4523
  {
4523
4524
  "disabled": false,
4524
- "document": "出生日期\n注意:此字段可能返回 null,表示取不到有效值。",
4525
+ "document": "出生日期。\n注意:此字段可能返回 null,表示取不到有效值。",
4525
4526
  "example": "20220222",
4526
4527
  "member": "string",
4527
4528
  "name": "BirthDate",
4528
- "required": true,
4529
+ "output_required": true,
4529
4530
  "type": "string",
4530
4531
  "value_allowed_null": true
4531
4532
  },
4532
4533
  {
4533
4534
  "disabled": false,
4534
- "document": "有效期起始时间\n注意:此字段可能返回 null,表示取不到有效值。",
4535
+ "document": "有效期起始时间。\n注意:此字段可能返回 null,表示取不到有效值。",
4535
4536
  "example": "20220222",
4536
4537
  "member": "string",
4537
4538
  "name": "BeginTime",
4538
- "required": true,
4539
+ "output_required": true,
4539
4540
  "type": "string",
4540
4541
  "value_allowed_null": true
4541
4542
  },
4542
4543
  {
4543
4544
  "disabled": false,
4544
- "document": "有效期结束时间\n注意:此字段可能返回 null,表示取不到有效值。",
4545
+ "document": "有效期结束时间。\n注意:此字段可能返回 null,表示取不到有效值。",
4545
4546
  "example": "20220222",
4546
4547
  "member": "string",
4547
4548
  "name": "EndTime",
4548
- "required": true,
4549
+ "output_required": true,
4549
4550
  "type": "string",
4550
4551
  "value_allowed_null": true
4551
4552
  },
4552
4553
  {
4553
4554
  "disabled": false,
4554
- "document": "住址\n注意:此字段可能返回 null,表示取不到有效值。",
4555
- "example": "广东省",
4555
+ "document": "住址。\n注意:此字段可能返回 null,表示取不到有效值。",
4556
+ "example": "北京市东城区景山前街4号紫禁城敬事房",
4556
4557
  "member": "string",
4557
4558
  "name": "Address",
4558
- "required": true,
4559
+ "output_required": true,
4559
4560
  "type": "string",
4560
4561
  "value_allowed_null": true
4561
4562
  },
4562
4563
  {
4563
4564
  "disabled": false,
4564
- "document": "民族\n注意:此字段可能返回 null,表示取不到有效值。",
4565
+ "document": "民族。\n注意:此字段可能返回 null,表示取不到有效值。",
4565
4566
  "example": "汉",
4566
4567
  "member": "string",
4567
4568
  "name": "Nation",
4568
- "required": true,
4569
+ "output_required": true,
4569
4570
  "type": "string",
4570
4571
  "value_allowed_null": true
4571
4572
  },
4572
4573
  {
4573
4574
  "disabled": false,
4574
- "document": "性别\n注意:此字段可能返回 null,表示取不到有效值。",
4575
+ "document": "性别。\n注意:此字段可能返回 null,表示取不到有效值。",
4575
4576
  "example": "男",
4576
4577
  "member": "string",
4577
4578
  "name": "Sex",
4578
- "required": true,
4579
+ "output_required": true,
4579
4580
  "type": "string",
4580
4581
  "value_allowed_null": true
4581
4582
  },
4582
4583
  {
4583
4584
  "disabled": false,
4584
- "document": "身份证 01 中国护照 03 军官证 04 武警证 05 港澳通行证 06 台胞证 07 外国护照 08 士兵证 09 临时身份证 10 户口本 11 警官证 12 外国人永久居留证 13 港澳台居民居住证 14 回乡证 15 大陆居民来往台湾通行证 16 其他证件 99\n注意:此字段可能返回 null,表示取不到有效值。",
4585
+ "document": "类型。\n- 取值范围:\n01:身份证。 \n03 :中国护照。\n04 :军官证。\n05 :武警证。\n06:港澳通行证 。\n07 :台胞证 。\n08:外国护照 。\n09 :士兵证。\n09 :临时身份证。\n11:户口本 。\n12 :警官证 。\n13:外国人永久居留证。\n14:港澳台居民居住证。\n15:回乡证。\n16:大陆居民来往台湾通行证。\n99:其他证件。\n注意:此字段可能返回 null,表示取不到有效值。",
4585
4586
  "example": "01",
4586
4587
  "member": "string",
4587
4588
  "name": "IdType",
4588
- "required": true,
4589
+ "output_required": true,
4589
4590
  "type": "string",
4590
4591
  "value_allowed_null": true
4591
4592
  },
4592
4593
  {
4593
4594
  "disabled": false,
4594
- "document": "英文姓名\n注意:此字段可能返回 null,表示取不到有效值。",
4595
- "example": "lisi",
4595
+ "document": "英文姓名。\n注意:此字段可能返回 null,表示取不到有效值。",
4596
+ "example": "lily",
4596
4597
  "member": "string",
4597
4598
  "name": "EnName",
4598
- "required": true,
4599
+ "output_required": true,
4599
4600
  "type": "string",
4600
4601
  "value_allowed_null": true
4601
4602
  },
@@ -4605,77 +4606,77 @@
4605
4606
  "example": "广东省",
4606
4607
  "member": "string",
4607
4608
  "name": "SigningOrganization",
4608
- "required": true,
4609
+ "output_required": true,
4609
4610
  "type": "string",
4610
4611
  "value_allowed_null": true
4611
4612
  },
4612
4613
  {
4613
4614
  "disabled": false,
4614
- "document": "港澳台居民居住证,通行证号码\n注意:此字段可能返回 null,表示取不到有效值。",
4615
- "example": "123",
4615
+ "document": "港澳台居民居住证,通行证号码。\n注意:此字段可能返回 null,表示取不到有效值。",
4616
+ "example": "830000199706020042",
4616
4617
  "member": "string",
4617
4618
  "name": "OtherIdNum",
4618
- "required": true,
4619
+ "output_required": true,
4619
4620
  "type": "string",
4620
4621
  "value_allowed_null": true
4621
4622
  },
4622
4623
  {
4623
4624
  "disabled": false,
4624
- "document": "旅行证件国籍\n注意:此字段可能返回 null,表示取不到有效值。",
4625
- "example": "123",
4625
+ "document": "旅行证件国籍。\n注意:此字段可能返回 null,表示取不到有效值。",
4626
+ "example": "英国",
4626
4627
  "member": "string",
4627
4628
  "name": "Nationality",
4628
- "required": true,
4629
+ "output_required": true,
4629
4630
  "type": "string",
4630
4631
  "value_allowed_null": true
4631
4632
  },
4632
4633
  {
4633
4634
  "disabled": false,
4634
- "document": "旅行证件机读区第二行 29~42 位\n注意:此字段可能返回 null,表示取不到有效值。",
4635
- "example": "123",
4635
+ "document": "旅行证件机读区第二行 29~42 位。\n注意:此字段可能返回 null,表示取不到有效值。",
4636
+ "example": "0602004212071",
4636
4637
  "member": "string",
4637
4638
  "name": "PersonalNumber",
4638
- "required": true,
4639
+ "output_required": true,
4639
4640
  "type": "string",
4640
4641
  "value_allowed_null": true
4641
4642
  },
4642
4643
  {
4643
4644
  "disabled": false,
4644
- "document": "旅行证件类的核验结果。JSON格式如下:\n{\"result_issuer \":\"签发者证书合法性验证结果 \",\"result_pape r\":\"证件安全对象合法性验证 结果 \",\"result_data\" :\"防数据篡改验证结果 \",\"result_chip\" :\"防证书件芯片被复制验证结果\"} \n 0:验证通过,1: 验证不通过,2: 未验证,3:部分通过,当4项核验结果都为0时,表示证件为真\n注意:此字段可能返回 null,表示取不到有效值。",
4645
- "example": "123",
4645
+ "document": "旅行证件类的核验结果。\n- JSON格式如下:\n{\"result_issuer \":\"签发者证书合法性验证结果 \",\"result_pape r\":\"证件安全对象合法性验证 结果 \",\"result_data\" :\"防数据篡改验证结果 \",\"result_chip\" :\"防证书件芯片被复制验证结果\"} 。\n- 取值范围: 0:验证通过,1: 验证不通过,2: 未验证,3:部分通过,当4项核验结果都为0时,表示证件为真。\n注意:此字段可能返回 null,表示取不到有效值。",
4646
+ "example": "{\"result_issuer \":\"签发者证书合法性验证结果 \",\"result_pape r\":\"证件安全对象合法性验证 结果 \",\"result_data\" :\"防数据篡改验证结果 \",\"result_chip\" :\"防证书件芯片被复制验证结果\"} ",
4646
4647
  "member": "string",
4647
4648
  "name": "CheckMRTD",
4648
- "required": true,
4649
+ "output_required": true,
4649
4650
  "type": "string",
4650
4651
  "value_allowed_null": true
4651
4652
  },
4652
4653
  {
4653
4654
  "disabled": false,
4654
- "document": "身份证照片面合成图片\n注意:此字段可能返回 null,表示取不到有效值。",
4655
- "example": "123",
4655
+ "document": "身份证照片面合成图片。\n注意:此字段可能返回 null,表示取不到有效值。",
4656
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
4656
4657
  "member": "string",
4657
4658
  "name": "ImageA",
4658
- "required": true,
4659
+ "output_required": true,
4659
4660
  "type": "string",
4660
4661
  "value_allowed_null": true
4661
4662
  },
4662
4663
  {
4663
4664
  "disabled": false,
4664
- "document": "身份证国徽面合成图片\n注意:此字段可能返回 null,表示取不到有效值。",
4665
- "example": "123",
4665
+ "document": "身份证国徽面合成图片。\n注意:此字段可能返回 null,表示取不到有效值。",
4666
+ "example": "/9j/4AAQSk......j+5QVYZKxU",
4666
4667
  "member": "string",
4667
4668
  "name": "ImageB",
4668
- "required": true,
4669
+ "output_required": true,
4669
4670
  "type": "string",
4670
4671
  "value_allowed_null": true
4671
4672
  },
4672
4673
  {
4673
4674
  "disabled": false,
4674
- "document": "对result code的结果描述\n注意:此字段可能返回 null,表示取不到有效值。",
4675
- "example": "123",
4675
+ "document": "对result code的结果描述。\n注意:此字段可能返回 null,表示取不到有效值。",
4676
+ "example": "首次查询成功",
4676
4677
  "member": "string",
4677
4678
  "name": "ResultDescription",
4678
- "required": true,
4679
+ "output_required": true,
4679
4680
  "type": "string",
4680
4681
  "value_allowed_null": true
4681
4682
  },
@@ -4693,8 +4694,8 @@
4693
4694
  "members": [
4694
4695
  {
4695
4696
  "disabled": false,
4696
- "document": "身份证号",
4697
- "example": "622222222222222222X",
4697
+ "document": "身份证号。",
4698
+ "example": "11204416541220243X",
4698
4699
  "member": "string",
4699
4700
  "name": "IdCard",
4700
4701
  "required": true,
@@ -4702,8 +4703,8 @@
4702
4703
  },
4703
4704
  {
4704
4705
  "disabled": false,
4705
- "document": "姓名",
4706
- "example": "张三",
4706
+ "document": "姓名。",
4707
+ "example": "韦小宝",
4707
4708
  "member": "string",
4708
4709
  "name": "Name",
4709
4710
  "required": true,
@@ -4711,8 +4712,8 @@
4711
4712
  },
4712
4713
  {
4713
4714
  "disabled": false,
4714
- "document": "手机号",
4715
- "example": "15123567346",
4715
+ "document": "手机号。",
4716
+ "example": "16137688175",
4716
4717
  "member": "string",
4717
4718
  "name": "Phone",
4718
4719
  "required": true,
@@ -4720,7 +4721,7 @@
4720
4721
  },
4721
4722
  {
4722
4723
  "disabled": false,
4723
- "document": "敏感数据加密信息。对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
4724
+ "document": "敏感数据加密信息。\n- 对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
4724
4725
  "example": "无",
4725
4726
  "member": "Encryption",
4726
4727
  "name": "Encryption",
@@ -4735,7 +4736,7 @@
4735
4736
  "members": [
4736
4737
  {
4737
4738
  "disabled": false,
4738
- "document": "认证结果码,收费情况如下。\n收费结果码:\n0: 认证通过\n-4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)\n不收费结果码:\n-6: 手机号码不合法\n-7: 身份证号码有误\n-8: 姓名校验不通过\n-9: 没有记录\n-11: 验证中心服务繁忙",
4739
+ "document": "认证结果码,收费情况如下。\n- 收费结果码:\n0: 认证通过。\n-4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)。\n\n- 不收费结果码:\n-6: 手机号码不合法。\n-7: 身份证号码有误。\n-8: 姓名校验不通过。\n-9: 没有记录。\n-11: 验证中心服务繁忙。",
4739
4740
  "example": "0",
4740
4741
  "member": "string",
4741
4742
  "name": "Result",
@@ -4745,7 +4746,7 @@
4745
4746
  },
4746
4747
  {
4747
4748
  "disabled": false,
4748
- "document": "运营商名称。\n取值范围为[\"移动\",\"联通\",\"电信\",\"\"]",
4749
+ "document": "运营商名称。\n- 取值范围为[\"移动\",\"联通\",\"电信\",\"\"]",
4749
4750
  "example": "移动",
4750
4751
  "member": "string",
4751
4752
  "name": "Isp",
@@ -4777,8 +4778,8 @@
4777
4778
  "members": [
4778
4779
  {
4779
4780
  "disabled": false,
4780
- "document": "身份证号",
4781
- "example": "622222222222222222X",
4781
+ "document": "身份证号。",
4782
+ "example": "11204416541220243X",
4782
4783
  "member": "string",
4783
4784
  "name": "IdCard",
4784
4785
  "required": true,
@@ -4786,8 +4787,8 @@
4786
4787
  },
4787
4788
  {
4788
4789
  "disabled": false,
4789
- "document": "姓名",
4790
- "example": "张三",
4790
+ "document": "姓名。",
4791
+ "example": "韦小宝",
4791
4792
  "member": "string",
4792
4793
  "name": "Name",
4793
4794
  "required": true,
@@ -4795,8 +4796,8 @@
4795
4796
  },
4796
4797
  {
4797
4798
  "disabled": false,
4798
- "document": "手机号",
4799
- "example": "15123567346",
4799
+ "document": "手机号。",
4800
+ "example": "16137688175",
4800
4801
  "member": "string",
4801
4802
  "name": "Phone",
4802
4803
  "required": true,
@@ -4804,7 +4805,7 @@
4804
4805
  },
4805
4806
  {
4806
4807
  "disabled": false,
4807
- "document": "敏感数据加密信息。对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
4808
+ "document": "敏感数据加密信息。\n- 对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
4808
4809
  "example": "无",
4809
4810
  "member": "Encryption",
4810
4811
  "name": "Encryption",
@@ -4819,7 +4820,7 @@
4819
4820
  "members": [
4820
4821
  {
4821
4822
  "disabled": false,
4822
- "document": "认证结果码,收费情况如下。\n收费结果码:\n0: 认证通过\n-4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)\n不收费结果码:\n-6: 手机号码不合法\n-7: 身份证号码有误\n-8: 姓名校验不通过\n-9: 没有记录\n-11: 验证中心服务繁忙",
4823
+ "document": "认证结果码,收费情况如下。\n- 收费结果码:\n0: 认证通过。\n-4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)。\n\n- 不收费结果码:\n-6: 手机号码不合法。\n-7: 身份证号码有误。\n-8: 姓名校验不通过。\n-9: 没有记录。\n-11: 验证中心服务繁忙。",
4823
4824
  "example": "0",
4824
4825
  "member": "string",
4825
4826
  "name": "Result",
@@ -4829,7 +4830,7 @@
4829
4830
  },
4830
4831
  {
4831
4832
  "disabled": false,
4832
- "document": "运营商名称。\n取值范围为[\"移动\",\"联通\",\"电信\",\"\"]",
4833
+ "document": "运营商名称。\n- 取值范围为[\"移动\",\"联通\",\"电信\",\"\"]",
4833
4834
  "example": "电信",
4834
4835
  "member": "string",
4835
4836
  "name": "Isp",
@@ -4861,8 +4862,8 @@
4861
4862
  "members": [
4862
4863
  {
4863
4864
  "disabled": false,
4864
- "document": "身份证号",
4865
- "example": "622222222222222222X",
4865
+ "document": "身份证号。",
4866
+ "example": "11204416541220243X",
4866
4867
  "member": "string",
4867
4868
  "name": "IdCard",
4868
4869
  "required": true,
@@ -4870,8 +4871,8 @@
4870
4871
  },
4871
4872
  {
4872
4873
  "disabled": false,
4873
- "document": "姓名",
4874
- "example": "张三",
4874
+ "document": "姓名。",
4875
+ "example": "韦小宝",
4875
4876
  "member": "string",
4876
4877
  "name": "Name",
4877
4878
  "required": true,
@@ -4879,8 +4880,8 @@
4879
4880
  },
4880
4881
  {
4881
4882
  "disabled": false,
4882
- "document": "手机号",
4883
- "example": "15123567346",
4883
+ "document": "手机号。",
4884
+ "example": "16137688175",
4884
4885
  "member": "string",
4885
4886
  "name": "Phone",
4886
4887
  "required": true,
@@ -4888,7 +4889,7 @@
4888
4889
  },
4889
4890
  {
4890
4891
  "disabled": false,
4891
- "document": "敏感数据加密信息。对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
4892
+ "document": "敏感数据加密信息。\n- 对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。",
4892
4893
  "example": "无",
4893
4894
  "member": "Encryption",
4894
4895
  "name": "Encryption",
@@ -4903,7 +4904,7 @@
4903
4904
  "members": [
4904
4905
  {
4905
4906
  "disabled": false,
4906
- "document": "认证结果码,收费情况如下。\n收费结果码:\n0: 认证通过\n-4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)\n不收费结果码:\n-6: 手机号码不合法\n-7: 身份证号码有误\n-8: 姓名校验不通过\n-9: 没有记录\n-11: 验证中心服务繁忙",
4907
+ "document": "认证结果码,收费情况如下。\n- 收费结果码:\n0: 认证通过。\n-4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)。\n\n- 不收费结果码:\n-6: 手机号码不合法。\n-7: 身份证号码有误。\n-8: 姓名校验不通过。\n-9: 没有记录。\n-11: 验证中心服务繁忙。",
4907
4908
  "example": "0",
4908
4909
  "member": "string",
4909
4910
  "name": "Result",
@@ -4913,7 +4914,7 @@
4913
4914
  },
4914
4915
  {
4915
4916
  "disabled": false,
4916
- "document": "运营商名称。\n取值范围为[\"移动\",\"联通\",\"电信\",\"\"]",
4917
+ "document": "运营商名称。\n- 取值范围为[\"移动\",\"联通\",\"电信\",\"\"]",
4917
4918
  "example": "联通",
4918
4919
  "member": "string",
4919
4920
  "name": "Isp",
@@ -4945,8 +4946,8 @@
4945
4946
  "members": [
4946
4947
  {
4947
4948
  "disabled": false,
4948
- "document": "身份证号",
4949
- "example": "1234561999010112345",
4949
+ "document": "身份证号。",
4950
+ "example": "11204416541220243X",
4950
4951
  "member": "string",
4951
4952
  "name": "IdCard",
4952
4953
  "required": true,
@@ -4954,8 +4955,8 @@
4954
4955
  },
4955
4956
  {
4956
4957
  "disabled": false,
4957
- "document": "姓名",
4958
- "example": "张三",
4958
+ "document": "姓名。",
4959
+ "example": "韦小宝",
4959
4960
  "member": "string",
4960
4961
  "name": "Name",
4961
4962
  "required": true,
@@ -4963,8 +4964,8 @@
4963
4964
  },
4964
4965
  {
4965
4966
  "disabled": false,
4966
- "document": "手机号",
4967
- "example": "12345678965",
4967
+ "document": "手机号。",
4968
+ "example": "16137688175",
4968
4969
  "member": "string",
4969
4970
  "name": "Phone",
4970
4971
  "required": true,
@@ -4972,7 +4973,7 @@
4972
4973
  },
4973
4974
  {
4974
4975
  "disabled": false,
4975
- "document": "验证模式(详版/简版)。简版与详版价格不一致,详见[价格说明](https://cloud.tencent.com/document/product/1007/84321)。\n\n枚举值:0(简版),1(详版)。默认值为0。",
4976
+ "document": "验证模式(详版/简版)。\n- 简版与详版价格不一致,详见[价格说明](https://cloud.tencent.com/document/product/1007/84321)。\n- 枚举值:0(简版);1(详版)。\n- 默认值为0。",
4976
4977
  "example": "0",
4977
4978
  "member": "string",
4978
4979
  "name": "VerifyMode",
@@ -4981,8 +4982,8 @@
4981
4982
  },
4982
4983
  {
4983
4984
  "disabled": false,
4984
- "document": "有加密需求的用户,传入kms的CiphertextBlob,关于数据加密可查阅 <a href=\"https://cloud.tencent.com/document/product/1007/47180\">数据加密</a> 文档。",
4985
- "example": "iyuhfafhsad72bd",
4985
+ "document": "有加密需求的用户,传入kms的CiphertextBlob。关于数据加密可查阅 <a href=\"https://cloud.tencent.com/document/product/1007/47180\">数据加密</a> 文档。",
4986
+ "example": "BKD5+E/euB3mXQ9pqKNLvazmrSB/XdTsOasrx+m......UY7JJ7p/WTFirTINnU4=",
4986
4987
  "member": "string",
4987
4988
  "name": "CiphertextBlob",
4988
4989
  "required": false,
@@ -4990,7 +4991,7 @@
4990
4991
  },
4991
4992
  {
4992
4993
  "disabled": false,
4993
- "document": "在使用加密服务时,填入要被加密的字段。本接口中可填入加密后的IdCard,Name,Phone中的一个或多个。",
4994
+ "document": "在使用加密服务时,填入要被加密的字段。\n- 本接口中可填入加密后的IdCard,Name,Phone中的一个或多个。",
4994
4995
  "example": "[IdCard]",
4995
4996
  "member": "string",
4996
4997
  "name": "EncryptList",
@@ -5000,7 +5001,7 @@
5000
5001
  {
5001
5002
  "disabled": false,
5002
5003
  "document": "有加密需求的用户,传入CBC加密的初始向量。",
5003
- "example": "ihds8d0s9fhs8fud0f",
5004
+ "example": "+am/h1FrULT8Y39M",
5004
5005
  "member": "string",
5005
5006
  "name": "Iv",
5006
5007
  "required": false,
@@ -5014,7 +5015,7 @@
5014
5015
  "members": [
5015
5016
  {
5016
5017
  "disabled": false,
5017
- "document": "认证结果码:\n收费结果码\n0: 三要素信息一致\n-4: 三要素信息不一致\n不收费结果码\n-6: 手机号码不合法\n-7: 身份证号码有误\n-8: 姓名校验不通过\n-9: 没有记录\n-11: 验证中心服务繁忙\n-12: 认证次数超过当日限制,请次日重试",
5018
+ "document": "认证结果码。\n- 收费结果码\n0: 三要素信息一致。\n-4: 三要素信息不一致。\n\n- 不收费结果码\n-6: 手机号码不合法。\n-7: 身份证号码有误。\n-8: 姓名校验不通过。\n-9: 没有记录。\n-11: 验证中心服务繁忙。\n-12: 认证次数超过当日限制,请次日重试。",
5018
5019
  "example": "0",
5019
5020
  "member": "string",
5020
5021
  "name": "Result",
@@ -5034,7 +5035,7 @@
5034
5035
  },
5035
5036
  {
5036
5037
  "disabled": false,
5037
- "document": "运营商名称。\n取值范围为[\"\",\"移动\",\"电信\",\"联通\"]",
5038
+ "document": "运营商名称。\n- 取值范围为[\"\",\"移动\",\"电信\",\"联通\"]",
5038
5039
  "example": "移动",
5039
5040
  "member": "string",
5040
5041
  "name": "Isp",
@@ -5044,7 +5045,7 @@
5044
5045
  },
5045
5046
  {
5046
5047
  "disabled": false,
5047
- "document": "业务结果详细信息。(当VerifyMode配置\"详版\",且Result为\"-4: 三要素信息不一致\"时返回)\n枚举值:\nPhoneIdCardMismatch:手机号码与姓名一致,与身份证号不一致;\nPhoneNameMismatch:手机号码身份证号一致,与姓名不一致;\nPhoneNameIdCardMismatch:手机号码与姓名和身份证号均不一致;\nNameIdCardMismatch:姓名和身份证号不一致;\nOtherMismatch:其他不一致;",
5048
+ "document": "业务结果详细信息。\n- 当VerifyMode配置\"详版\",且Result为\"-4: 三要素信息不一致\"时返回。\n- 枚举值:\nPhoneIdCardMismatch:手机号码与姓名一致,与身份证号不一致。\nPhoneNameMismatch:手机号码身份证号一致,与姓名不一致。\nPhoneNameIdCardMismatch:手机号码与姓名和身份证号均不一致。\nNameIdCardMismatch:姓名和身份证号不一致。\nOtherMismatch:其他不一致。",
5048
5049
  "example": "无",
5049
5050
  "member": "string",
5050
5051
  "name": "ResultDetail",