tencentcloud-sdk-nodejs 4.0.972 → 4.0.973

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (136) hide show
  1. package/CHANGELOG.md +631 -0
  2. package/SERVICE_CHANGELOG.md +1092 -31
  3. package/package.json +1 -1
  4. package/products.md +47 -47
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/apm/v20210622/apm_models.ts +36 -0
  7. package/src/services/as/v20180419/as_client.ts +0 -1
  8. package/src/services/as/v20180419/as_models.ts +11 -6
  9. package/src/services/batch/v20170312/batch_models.ts +10 -1
  10. package/src/services/bda/v20200324/bda_client.ts +2 -3
  11. package/src/services/bda/v20200324/bda_models.ts +7 -7
  12. package/src/services/cat/v20180409/cat_models.ts +4 -0
  13. package/src/services/cbs/v20170312/cbs_models.ts +126 -99
  14. package/src/services/ccc/v20200210/ccc_models.ts +4 -0
  15. package/src/services/cdb/v20170320/cdb_client.ts +2 -2
  16. package/src/services/cdb/v20170320/cdb_models.ts +5 -3
  17. package/src/services/cdc/v20201214/cdc_models.ts +78 -104
  18. package/src/services/cdz/v20221123/cdz_client.ts +1 -0
  19. package/src/services/cdz/v20221123/cdz_models.ts +21 -0
  20. package/src/services/ckafka/v20190819/ckafka_models.ts +13 -9
  21. package/src/services/cloudstudio/v20230508/cloudstudio_models.ts +11 -20
  22. package/src/services/cls/v20201016/cls_client.ts +1 -1
  23. package/src/services/cls/v20201016/cls_models.ts +27 -1
  24. package/src/services/cvm/v20170312/cvm_models.ts +52 -24
  25. package/src/services/cwp/v20180228/cwp_client.ts +2 -17
  26. package/src/services/cwp/v20180228/cwp_models.ts +48 -103
  27. package/src/services/dasb/v20191018/dasb_models.ts +16 -0
  28. package/src/services/emr/v20190103/emr_client.ts +14 -12
  29. package/src/services/emr/v20190103/emr_models.ts +164 -76
  30. package/src/services/es/v20180416/es_models.ts +8 -0
  31. package/src/services/ess/v20201111/ess_client.ts +22 -30
  32. package/src/services/ess/v20201111/ess_models.ts +21 -7
  33. package/src/services/essbasic/v20210526/essbasic_client.ts +9 -3
  34. package/src/services/essbasic/v20210526/essbasic_models.ts +31 -14
  35. package/src/services/faceid/v20180301/faceid_models.ts +516 -294
  36. package/src/services/fmu/v20191213/fmu_client.ts +0 -1
  37. package/src/services/fmu/v20191213/fmu_models.ts +4 -4
  38. package/src/services/ft/v20200304/ft_models.ts +10 -10
  39. package/src/services/gme/v20180711/gme_models.ts +5 -1
  40. package/src/services/hai/v20230812/hai_models.ts +1 -1
  41. package/src/services/iai/v20180301/iai_models.ts +20 -13
  42. package/src/services/iai/v20200303/iai_client.ts +2 -3
  43. package/src/services/iai/v20200303/iai_models.ts +380 -273
  44. package/src/services/lke/v20231130/lke_models.ts +6 -6
  45. package/src/services/mrs/v20200910/mrs_models.ts +6 -0
  46. package/src/services/ms/v20180408/ms_client.ts +4 -2
  47. package/src/services/ocr/v20181119/ocr_client.ts +42 -16
  48. package/src/services/ocr/v20181119/ocr_models.ts +213 -66
  49. package/src/services/omics/v20221128/omics_models.ts +1 -31
  50. package/src/services/partners/v20180321/partners_models.ts +74 -113
  51. package/src/services/scf/v20180416/scf_models.ts +14 -14
  52. package/src/services/ssl/v20191205/ssl_models.ts +3 -3
  53. package/src/services/tds/v20220801/tds_models.ts +4 -4
  54. package/src/services/thpc/v20230321/thpc_models.ts +1 -1
  55. package/src/services/tke/v20180525/tke_models.ts +0 -1
  56. package/src/services/trro/v20220325/trro_models.ts +22 -37
  57. package/src/services/trtc/v20190722/trtc_client.ts +1 -0
  58. package/src/services/trtc/v20190722/trtc_models.ts +29 -1
  59. package/src/services/vclm/v20240523/vclm_client.ts +52 -52
  60. package/src/services/vclm/v20240523/vclm_models.ts +61 -41
  61. package/src/services/vod/v20180717/vod_client.ts +1 -0
  62. package/src/services/vod/v20180717/vod_models.ts +32 -0
  63. package/src/services/vpc/v20170312/vpc_models.ts +62 -46
  64. package/src/services/waf/v20180125/waf_models.ts +4 -0
  65. package/tencentcloud/common/sdk_version.d.ts +1 -1
  66. package/tencentcloud/common/sdk_version.js +1 -1
  67. package/tencentcloud/services/apm/v20210622/apm_models.d.ts +36 -0
  68. package/tencentcloud/services/as/v20180419/as_client.d.ts +0 -1
  69. package/tencentcloud/services/as/v20180419/as_client.js +0 -1
  70. package/tencentcloud/services/as/v20180419/as_models.d.ts +11 -6
  71. package/tencentcloud/services/batch/v20170312/batch_models.d.ts +10 -1
  72. package/tencentcloud/services/bda/v20200324/bda_client.d.ts +0 -1
  73. package/tencentcloud/services/bda/v20200324/bda_client.js +0 -1
  74. package/tencentcloud/services/bda/v20200324/bda_models.d.ts +7 -7
  75. package/tencentcloud/services/cat/v20180409/cat_models.d.ts +4 -0
  76. package/tencentcloud/services/cbs/v20170312/cbs_models.d.ts +126 -99
  77. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +4 -0
  78. package/tencentcloud/services/cdb/v20170320/cdb_client.d.ts +2 -2
  79. package/tencentcloud/services/cdb/v20170320/cdb_client.js +2 -2
  80. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +5 -3
  81. package/tencentcloud/services/cdc/v20201214/cdc_models.d.ts +78 -104
  82. package/tencentcloud/services/cdz/v20221123/cdz_models.d.ts +20 -0
  83. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +13 -9
  84. package/tencentcloud/services/cloudstudio/v20230508/cloudstudio_models.d.ts +11 -20
  85. package/tencentcloud/services/cls/v20201016/cls_client.d.ts +1 -1
  86. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +27 -1
  87. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +52 -24
  88. package/tencentcloud/services/cwp/v20180228/cwp_client.d.ts +1 -7
  89. package/tencentcloud/services/cwp/v20180228/cwp_client.js +0 -8
  90. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +48 -100
  91. package/tencentcloud/services/dasb/v20191018/dasb_models.d.ts +16 -0
  92. package/tencentcloud/services/emr/v20190103/emr_client.d.ts +10 -10
  93. package/tencentcloud/services/emr/v20190103/emr_client.js +9 -9
  94. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +162 -76
  95. package/tencentcloud/services/es/v20180416/es_models.d.ts +8 -0
  96. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +22 -30
  97. package/tencentcloud/services/ess/v20201111/ess_client.js +22 -30
  98. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +21 -7
  99. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +9 -3
  100. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +9 -3
  101. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +31 -14
  102. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +516 -294
  103. package/tencentcloud/services/fmu/v20191213/fmu_client.d.ts +0 -1
  104. package/tencentcloud/services/fmu/v20191213/fmu_client.js +0 -1
  105. package/tencentcloud/services/fmu/v20191213/fmu_models.d.ts +4 -4
  106. package/tencentcloud/services/ft/v20200304/ft_models.d.ts +10 -10
  107. package/tencentcloud/services/gme/v20180711/gme_models.d.ts +5 -1
  108. package/tencentcloud/services/hai/v20230812/hai_models.d.ts +1 -1
  109. package/tencentcloud/services/iai/v20180301/iai_models.d.ts +20 -13
  110. package/tencentcloud/services/iai/v20200303/iai_client.d.ts +0 -1
  111. package/tencentcloud/services/iai/v20200303/iai_client.js +0 -1
  112. package/tencentcloud/services/iai/v20200303/iai_models.d.ts +380 -273
  113. package/tencentcloud/services/lke/v20231130/lke_models.d.ts +6 -6
  114. package/tencentcloud/services/mrs/v20200910/mrs_models.d.ts +6 -0
  115. package/tencentcloud/services/ms/v20180408/ms_client.d.ts +3 -1
  116. package/tencentcloud/services/ms/v20180408/ms_client.js +3 -1
  117. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +15 -5
  118. package/tencentcloud/services/ocr/v20181119/ocr_client.js +20 -6
  119. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +209 -66
  120. package/tencentcloud/services/omics/v20221128/omics_models.d.ts +0 -30
  121. package/tencentcloud/services/partners/v20180321/partners_models.d.ts +74 -113
  122. package/tencentcloud/services/scf/v20180416/scf_models.d.ts +14 -14
  123. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +3 -3
  124. package/tencentcloud/services/tds/v20220801/tds_models.d.ts +4 -4
  125. package/tencentcloud/services/thpc/v20230321/thpc_models.d.ts +1 -1
  126. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +0 -1
  127. package/tencentcloud/services/trro/v20220325/trro_models.d.ts +22 -37
  128. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +28 -1
  129. package/tencentcloud/services/vclm/v20240523/vclm_client.d.ts +52 -52
  130. package/tencentcloud/services/vclm/v20240523/vclm_client.js +52 -52
  131. package/tencentcloud/services/vclm/v20240523/vclm_models.d.ts +61 -41
  132. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +31 -0
  133. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +62 -46
  134. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +4 -0
  135. package/test/cwp.v20180228.test.js +0 -10
  136. package/test/ocr.v20181119.test.js +24 -4
@@ -91,11 +91,15 @@ export interface IdCardVerificationRequest {
91
91
  */
92
92
  export interface ImageRecognitionV2Response {
93
93
  /**
94
- * 相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
94
+ * 相似度。
95
+ - 取值范围 [0.00, 100.00]。
96
+ - 推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
95
97
  */
96
98
  Sim?: number;
97
99
  /**
98
- * 业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
100
+ * 业务错误码。
101
+ - 成功情况返回Success。
102
+ - 错误情况请参考下方错误码 列表中FailedOperation部分
99
103
  */
100
104
  Result?: string;
101
105
  /**
@@ -137,22 +141,26 @@ export interface GetDetectInfoEnhancedResponse {
137
141
  */
138
142
  Encryption?: Encryption;
139
143
  /**
140
- * 意愿核身朗读模式结果信息。若未使用意愿核身功能,该字段返回值可以不处理。
144
+ * 意愿核身朗读模式结果信息。
145
+ - 若未使用意愿核身功能,该字段返回值可以不处理。
141
146
  注意:此字段可能返回 null,表示取不到有效值。
142
147
  */
143
148
  IntentionVerifyData?: IntentionVerifyData;
144
149
  /**
145
- * 意愿核身问答模式结果。若未使用该意愿核身功能,该字段返回值可以不处理。
150
+ * 意愿核身问答模式结果。
151
+
152
+ - 若未使用该意愿核身功能,该字段返回值可以不处理。
146
153
  注意:此字段可能返回 null,表示取不到有效值。
147
154
  */
148
155
  IntentionQuestionResult?: IntentionQuestionResult;
149
156
  /**
150
- * 意愿核身点头确认模式的结果信息,若未使用该意愿核身功能,该字段返回值可以不处理。
157
+ * 意愿核身点头确认模式的结果信息。
158
+ - 若未使用该意愿核身功能,该字段返回值可以不处理。
151
159
  注意:此字段可能返回 null,表示取不到有效值。
152
160
  */
153
161
  IntentionActionResult?: IntentionActionResult;
154
162
  /**
155
- * 加密后的数据
163
+ * 加密后的数据。
156
164
  注意:此字段可能返回 null,表示取不到有效值。
157
165
  */
158
166
  EncryptedBody?: string;
@@ -162,69 +170,75 @@ export interface GetDetectInfoEnhancedResponse {
162
170
  RequestId?: string;
163
171
  }
164
172
  /**
165
- * 意愿核身问答模式结果
173
+ * 意愿核身问答模式结果。
166
174
  */
167
175
  export interface IntentionQuestionResult {
168
176
  /**
169
- * 意愿核身错误码:
170
- 0: "成功"
171
- -1: "参数错误"
172
- -2: "系统异常"
173
- -101: "请保持人脸在框内"
174
- -102: "检测到多张人脸"
175
- -103: "人脸检测失败"
176
- -104: "人脸检测不完整"
177
- -105: "请勿遮挡眼睛"
178
- -106: "请勿遮挡嘴巴"
179
- -107: "请勿遮挡鼻子"
180
- -201: "人脸比对相似度低"
181
- -202: "人脸比对失败"
182
- -301: "意愿核验不通过"
183
- -302: "用户回答阶段未检测到张嘴动作"
184
- -800: "前端不兼容错误"
185
- -801: "用户未授权摄像头和麦克风权限"
186
- -802: "核验流程异常中断,请勿切屏或进行其他操作"
187
- -803: "用户主动关闭链接/异常断开链接"
188
- -998: "系统数据异常"
189
- -999: "系统未知错误,请联系人工核实"
190
- 若在人脸核身过程失败、未进入意愿确认过程,则该参数返回为空,请参考人脸核身错误码结果(DetectInfoText.ErrCode)
177
+ * 意愿核身错误码。
178
+ - 取值范围:
179
+ 0: "成功"
180
+ -1: "参数错误"
181
+ -2: "系统异常"
182
+ -101: "请保持人脸在框内"
183
+ -102: "检测到多张人脸"
184
+ -103: "人脸检测失败"
185
+ -104: "人脸检测不完整"
186
+ -105: "请勿遮挡眼睛"
187
+ -106: "请勿遮挡嘴巴"
188
+ -107: "请勿遮挡鼻子"
189
+ -201: "人脸比对相似度低"
190
+ -202: "人脸比对失败"
191
+ -301: "意愿核验不通过"
192
+ -302: "用户回答阶段未检测到张嘴动作"
193
+ -800: "前端不兼容错误"
194
+ -801: "用户未授权摄像头和麦克风权限"
195
+ -802: "核验流程异常中断,请勿切屏或进行其他操作"
196
+ -803: "用户主动关闭链接/异常断开链接"
197
+ -998: "系统数据异常"
198
+ -999: "系统未知错误,请联系人工核实"
199
+ - 若在人脸核身过程失败、未进入意愿确认过程,则该参数返回为空,请参考人脸核身错误码结果(DetectInfoText.ErrCode)
191
200
  注意:此字段可能返回 null,表示取不到有效值。
192
201
  */
193
202
  FinalResultDetailCode?: number;
194
203
  /**
195
- * 意愿核身错误信息
204
+ * 意愿核身错误信息。
196
205
  注意:此字段可能返回 null,表示取不到有效值。
197
206
  */
198
207
  FinalResultMessage?: string;
199
208
  /**
200
- * 视频base64(其中包含全程问题和回答音频,mp4格式)
209
+ * 视频base64
210
+ - 其中包含全程问题和回答音频,mp4格式。
201
211
  注意:此字段可能返回 null,表示取不到有效值。
202
212
  */
203
213
  Video?: string;
204
214
  /**
205
- * 屏幕截图base64列表
215
+ * 屏幕截图base64列表。
206
216
  注意:此字段可能返回 null,表示取不到有效值。
207
217
  */
208
218
  ScreenShot?: Array<string>;
209
219
  /**
210
- * 和答案匹配结果列表
211
- 0:成功,-1:不匹配
220
+ * 和答案匹配结果列表。
221
+ - 取值范围(0:成功;-1:不匹配)
212
222
  注意:此字段可能返回 null,表示取不到有效值。
213
223
  */
214
224
  ResultCode?: Array<string>;
215
225
  /**
216
- * 回答问题语音识别结果列表
226
+ * 回答问题语音识别结果列表。
217
227
  注意:此字段可能返回 null,表示取不到有效值。
218
228
  */
219
229
  AsrResult?: Array<string>;
220
230
  /**
221
- * 答案录音音频
231
+ * 答案录音音频。
222
232
  注意:此字段可能返回 null,表示取不到有效值。
223
233
  */
224
234
  Audios?: Array<string>;
225
235
  /**
226
- * 意愿核身最终结果:
227
- 0:认证通过,-1:认证未通过,-2:浏览器内核不兼容,无法进行意愿校验。建议使用“FinalResultDetailCode”参数获取详细的错误码信息。
236
+ * 意愿核身最终结果。
237
+ - 取值范围:
238
+ 0:认证通过。
239
+ -1:认证未通过。
240
+ -2:浏览器内核不兼容,无法进行意愿校验。
241
+ - 建议使用“FinalResultDetailCode”参数获取详细的错误码信息。
228
242
  注意:此字段可能返回 null,表示取不到有效值。
229
243
  */
230
244
  FinalResultCode?: string;
@@ -275,107 +289,126 @@ export interface MobileStatusRequest {
275
289
  */
276
290
  export interface ParseNfcDataResponse {
277
291
  /**
278
- * 0为首次查询成功,-1为查询失败。
292
+ * 结果码。
293
+ - 取值范围:0为首次查询成功,-1为查询失败。
279
294
  注意:此字段可能返回 null,表示取不到有效值。
280
295
  */
281
- ResultCode: string;
296
+ ResultCode?: string;
282
297
  /**
283
- * 身份证号
298
+ * 身份证号。
284
299
  注意:此字段可能返回 null,表示取不到有效值。
285
300
  */
286
- IdNum: string;
301
+ IdNum?: string;
287
302
  /**
288
- * 姓名
303
+ * 姓名。
289
304
  注意:此字段可能返回 null,表示取不到有效值。
290
305
  */
291
- Name: string;
306
+ Name?: string;
292
307
  /**
293
- * 照片
308
+ * 照片。
294
309
  注意:此字段可能返回 null,表示取不到有效值。
295
310
  */
296
- Picture: string;
311
+ Picture?: string;
297
312
  /**
298
- * 出生日期
313
+ * 出生日期。
299
314
  注意:此字段可能返回 null,表示取不到有效值。
300
315
  */
301
- BirthDate: string;
316
+ BirthDate?: string;
302
317
  /**
303
- * 有效期起始时间
318
+ * 有效期起始时间。
304
319
  注意:此字段可能返回 null,表示取不到有效值。
305
320
  */
306
- BeginTime: string;
321
+ BeginTime?: string;
307
322
  /**
308
- * 有效期结束时间
323
+ * 有效期结束时间。
309
324
  注意:此字段可能返回 null,表示取不到有效值。
310
325
  */
311
- EndTime: string;
326
+ EndTime?: string;
312
327
  /**
313
- * 住址
328
+ * 住址。
314
329
  注意:此字段可能返回 null,表示取不到有效值。
315
330
  */
316
- Address: string;
331
+ Address?: string;
317
332
  /**
318
- * 民族
333
+ * 民族。
319
334
  注意:此字段可能返回 null,表示取不到有效值。
320
335
  */
321
- Nation: string;
336
+ Nation?: string;
322
337
  /**
323
- * 性别
338
+ * 性别。
324
339
  注意:此字段可能返回 null,表示取不到有效值。
325
340
  */
326
- Sex: string;
341
+ Sex?: string;
327
342
  /**
328
- * 身份证 01 中国护照 03 军官证 04 武警证 05 港澳通行证 06 台胞证 07 外国护照 08 士兵证 09 临时身份证 10 户口本 11 警官证 12 外国人永久居留证 13 港澳台居民居住证 14 回乡证 15 大陆居民来往台湾通行证 16 其他证件 99
343
+ * 类型。
344
+ - 取值范围:
345
+ 01:身份证。
346
+ 03 :中国护照。
347
+ 04 :军官证。
348
+ 05 :武警证。
349
+ 06:港澳通行证 。
350
+ 07 :台胞证 。
351
+ 08:外国护照 。
352
+ 09 :士兵证。
353
+ 09 :临时身份证。
354
+ 11:户口本 。
355
+ 12 :警官证 。
356
+ 13:外国人永久居留证。
357
+ 14:港澳台居民居住证。
358
+ 15:回乡证。
359
+ 16:大陆居民来往台湾通行证。
360
+ 99:其他证件。
329
361
  注意:此字段可能返回 null,表示取不到有效值。
330
362
  */
331
- IdType: string;
363
+ IdType?: string;
332
364
  /**
333
- * 英文姓名
365
+ * 英文姓名。
334
366
  注意:此字段可能返回 null,表示取不到有效值。
335
367
  */
336
- EnName: string;
368
+ EnName?: string;
337
369
  /**
338
370
  * 签发机关
339
371
  注意:此字段可能返回 null,表示取不到有效值。
340
372
  */
341
- SigningOrganization: string;
373
+ SigningOrganization?: string;
342
374
  /**
343
- * 港澳台居民居住证,通行证号码
375
+ * 港澳台居民居住证,通行证号码。
344
376
  注意:此字段可能返回 null,表示取不到有效值。
345
377
  */
346
- OtherIdNum: string;
378
+ OtherIdNum?: string;
347
379
  /**
348
- * 旅行证件国籍
380
+ * 旅行证件国籍。
349
381
  注意:此字段可能返回 null,表示取不到有效值。
350
382
  */
351
- Nationality: string;
383
+ Nationality?: string;
352
384
  /**
353
- * 旅行证件机读区第二行 29~42
385
+ * 旅行证件机读区第二行 29~42 位。
354
386
  注意:此字段可能返回 null,表示取不到有效值。
355
387
  */
356
- PersonalNumber: string;
388
+ PersonalNumber?: string;
357
389
  /**
358
- * 旅行证件类的核验结果。JSON格式如下:
359
- {"result_issuer ":"签发者证书合法性验证结果 ","result_pape r":"证件安全对象合法性验证 结果 ","result_data" :"防数据篡改验证结果 ","result_chip" :"防证书件芯片被复制验证结果"}
360
- 0:验证通过,1: 验证不通过,2: 未验证,3:部分通过,当4项核验结果都为0时,表示证件为真
390
+ * 旅行证件类的核验结果。
391
+ - JSON格式如下:
392
+ {"result_issuer ":"签发者证书合法性验证结果 ","result_pape r":"证件安全对象合法性验证 结果 ","result_data" :"防数据篡改验证结果 ","result_chip" :"防证书件芯片被复制验证结果"} 。
393
+ - 取值范围: 0:验证通过,1: 验证不通过,2: 未验证,3:部分通过,当4项核验结果都为0时,表示证件为真。
361
394
  注意:此字段可能返回 null,表示取不到有效值。
362
395
  */
363
- CheckMRTD: string;
396
+ CheckMRTD?: string;
364
397
  /**
365
- * 身份证照片面合成图片
398
+ * 身份证照片面合成图片。
366
399
  注意:此字段可能返回 null,表示取不到有效值。
367
400
  */
368
- ImageA: string;
401
+ ImageA?: string;
369
402
  /**
370
- * 身份证国徽面合成图片
403
+ * 身份证国徽面合成图片。
371
404
  注意:此字段可能返回 null,表示取不到有效值。
372
405
  */
373
- ImageB: string;
406
+ ImageB?: string;
374
407
  /**
375
- * 对result code的结果描述
408
+ * 对result code的结果描述。
376
409
  注意:此字段可能返回 null,表示取不到有效值。
377
410
  */
378
- ResultDescription: string;
411
+ ResultDescription?: string;
379
412
  /**
380
413
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
381
414
  */
@@ -386,16 +419,18 @@ export interface ParseNfcDataResponse {
386
419
  */
387
420
  export interface LivenessRecognitionRequest {
388
421
  /**
389
- * 身份证号
422
+ * 身份证号。
390
423
  */
391
424
  IdCard: string;
392
425
  /**
393
- * 姓名。中文请使用UTF-8编码。
426
+ * 姓名。
427
+ - 中文请使用UTF-8编码。
394
428
  */
395
429
  Name: string;
396
430
  /**
397
- * 活体检测类型,取值:LIP/ACTION/SILENT。
398
- LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。
431
+ * 活体检测类型。
432
+ - 取值:LIP/ACTION/SILENT
433
+ - LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。
399
434
  */
400
435
  LivenessType: string;
401
436
  /**
@@ -404,28 +439,31 @@ export interface LivenessRecognitionRequest {
404
439
  */
405
440
  VideoBase64?: string;
406
441
  /**
407
- * 用于活体检测的视频Url 地址。视频下载后经Base64编码不超过 8M,视频下载耗时不超过4S,支持mp4、avi、flv格式。
408
-
409
- 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
410
-
411
- 建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议视频存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
442
+ * 用于活体检测的视频Url 地址。
443
+ - 视频下载后经Base64编码不超过 8M,视频下载耗时不超过4S,支持mp4、avi、flv格式。
444
+ - 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
445
+ - 建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议视频存储于腾讯云。
446
+ - 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
412
447
  */
413
448
  VideoUrl?: string;
414
449
  /**
415
- * 数字模式传参:传数字验证码,验证码需先调用<a href="https://cloud.tencent.com/document/product/1007/31821">获取数字验证码接口</a>得到;
416
- 动作模式传参:传动作顺序,动作顺序需先调用<a href="https://cloud.tencent.com/document/product/1007/31822">获取动作顺序接口</a>得到;
417
- 静默模式传参:空。
450
+ * 验证数据。
451
+ - 数字模式传参:传数字验证码,验证码需先调用<a href="https://cloud.tencent.com/document/product/1007/31821">获取数字验证码接口</a>得到;
452
+ - 动作模式传参:传动作顺序,动作顺序需先调用<a href="https://cloud.tencent.com/document/product/1007/31822">获取动作顺序接口</a>得到;
453
+ - 静默模式传参:空。
418
454
  */
419
455
  ValidateData?: string;
420
456
  /**
421
457
  * 额外配置,传入JSON字符串。
458
+ - 格式如下:
422
459
  {
423
460
  "BestFrameNum": 2 //需要返回多张最佳截图,取值范围2-10
424
461
  }
425
462
  */
426
463
  Optional?: string;
427
464
  /**
428
- * 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
465
+ * 敏感数据加密信息。
466
+ - 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
429
467
  */
430
468
  Encryption?: Encryption;
431
469
  }
@@ -451,28 +489,31 @@ export interface CheckEidTokenStatusResponse {
451
489
  */
452
490
  export interface EidInfo {
453
491
  /**
454
- * 商户方 appeIDcode 的数字证书
492
+ * 商户方 appeIDcode 的数字证书。
455
493
  */
456
- EidCode: string;
494
+ EidCode?: string;
457
495
  /**
458
- * Eid中心针对商户方EidCode的电子签名
496
+ * Eid中心针对商户方EidCode的电子签名。
459
497
  */
460
- EidSign: string;
498
+ EidSign?: string;
461
499
  /**
462
- * 商户方公钥加密的会话密钥的base64字符串,[指引详见](https://cloud.tencent.com/document/product/1007/63370)
500
+ * 商户方公钥加密的会话密钥的base64字符串,[指引详见](https://cloud.tencent.com/document/product/1007/63370)
463
501
  */
464
- DesKey: string;
502
+ DesKey?: string;
465
503
  /**
466
- * 会话密钥sm2加密后的base64字符串,[指引详见](https://cloud.tencent.com/document/product/1007/63370)
504
+ * 会话密钥sm2加密后的base64字符串,[指引详见](https://cloud.tencent.com/document/product/1007/63370)
467
505
  */
468
- UserInfo: string;
506
+ UserInfo?: string;
469
507
  }
470
508
  /**
471
509
  * DetectAuth请求参数结构体
472
510
  */
473
511
  export interface DetectAuthRequest {
474
512
  /**
475
- * 用于细分客户使用场景,申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。如有疑问,请添加[腾讯云人脸核身小助手](https://cloud.tencent.com/document/product/1007/56130)进行咨询。
513
+ * 业务流程ID。
514
+ - 用于细分客户使用场景, 可为业务配置不同的业务流程。
515
+ - 申请开通服务后,登录腾讯云[慧眼人脸核身控制](https://console.cloud.tencent.com/faceid)进行创建,审核通过后即可调用。
516
+ - 如有疑问,请添加[腾讯云人脸核身小助手](https://cloud.tencent.com/document/product/1007/56130)进行咨询。
476
517
  */
477
518
  RuleId: string;
478
519
  /**
@@ -480,17 +521,20 @@ export interface DetectAuthRequest {
480
521
  */
481
522
  TerminalType?: string;
482
523
  /**
483
- * 身份标识(是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示)。
484
- 规则:a-z,A-Z,0-9组合。最长长度32位。
524
+ * 验证人的身份证号码。
525
+ - 是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示。
526
+
485
527
  */
486
528
  IdCard?: string;
487
529
  /**
488
- * 姓名。(是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示)。
489
- 最长长度32位。中文请使用UTF-8编码。
530
+ * 验证人的姓名。
531
+ - 是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示。
532
+ - 最长长度32位。中文请使用UTF-8编码。
490
533
  */
491
534
  Name?: string;
492
535
  /**
493
- * 认证结束后重定向的回调链接地址。最长长度1024位。
536
+ * 认证结束后重定向的回调链接地址。
537
+ - 最长长度1024位。
494
538
  */
495
539
  RedirectUrl?: string;
496
540
  /**
@@ -498,8 +542,10 @@ export interface DetectAuthRequest {
498
542
  */
499
543
  Extra?: string;
500
544
  /**
501
- * 用于人脸比对的照片,图片的Base64值;
502
- Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648
545
+ * 用于人脸比对的图像数据,使用base64编码。
546
+ - Base64编码后的图片数据大小不超过3M。
547
+ - 仅支持jpg、png格式。
548
+ - 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
503
549
  */
504
550
  ImageBase64?: string;
505
551
  /**
@@ -507,21 +553,27 @@ export interface DetectAuthRequest {
507
553
  */
508
554
  Encryption?: Encryption;
509
555
  /**
510
- * 意愿核身(朗读模式)使用的文案,若未使用意愿核身(朗读模式),则该字段无需传入。默认为空,最长可接受120的字符串长度。
556
+ * 意愿核身(朗读模式)使用的文案。
557
+ - 若未使用意愿核身(朗读模式),则该字段无需传入。
558
+ - 最长可接受120的字符串长度。
511
559
  */
512
560
  IntentionVerifyText?: string;
513
561
  /**
514
- * 意愿核身语音问答模式(即语音播报+语音回答)使用的文案,包括:系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。
562
+ * 意愿核身(语音播报+语音回答模式)使用的文案。
563
+ - 包括:系统语音播报的文本、需要核验的标准文本。
564
+ - 当前仅支持1轮问答。
515
565
  */
516
566
  IntentionQuestions?: Array<IntentionQuestion>;
517
567
  /**
518
- * RuleId相关配置
568
+ * 意愿核身(点头确认模式)使用的文案。
569
+ - 若未使用意愿核身(点头确认模式),则该字段无需传入。
570
+ - 当前仅支持一个提示文本。
519
571
  */
520
- Config?: RuleIdConfig;
572
+ IntentionActions?: Array<IntentionActionConfig>;
521
573
  /**
522
- * 意愿核身(点头确认模式)使用的文案,若未使用意愿核身(点头确认模式),则该字段无需传入。当前仅支持一个提示文本。
574
+ * 意愿核身流程配置。
523
575
  */
524
- IntentionActions?: Array<IntentionActionConfig>;
576
+ Config?: RuleIdConfig;
525
577
  }
526
578
  /**
527
579
  * CheckEidTokenStatus请求参数结构体
@@ -537,32 +589,60 @@ export interface CheckEidTokenStatusRequest {
537
589
  */
538
590
  export interface GetFaceIdRiskInfoResponse {
539
591
  /**
540
- * 描述当前请求所在设备的风险标签,详情如下: 01-设备疑似被Root/设备疑似越狱 02-设备疑似被注入 03-设备疑似为模拟器 04-设备疑似存在风险操作 05-摄像头疑似被劫持 06-疑似黑产设备
592
+ * 描述当前请求所在设备的风险标签
593
+ - 详情如下:
594
+ 01-设备疑似被Root/设备疑似越狱。
595
+ 02-设备疑似被注入。
596
+ 03-设备疑似为模拟器。
597
+ 04-设备疑似存在风险操作。
598
+ 05-摄像头疑似被劫持。
599
+ 06-疑似黑产设备。
541
600
  注意:此字段可能返回 null,表示取不到有效值。
542
601
  */
543
602
  DeviceInfoTag?: string;
544
603
  /**
545
- * 描述当前请求所在设备的风险等级,共4级,详情如下: 1 - 低风险 2 - 中风险 3 - 高风险 4 - 攻击 ,-1表示未获取到风险等级
604
+ * 描述当前请求所在设备的风险等级,共4级。
605
+ - 详情如下:
606
+ 1 - 低风险。
607
+ 2 - 中风险。
608
+ 3 - 高风险。
609
+ 4 - 攻击。
610
+ -1表示未获取到风险等级。
546
611
  注意:此字段可能返回 null,表示取不到有效值。
547
612
  */
548
613
  DeviceInfoLevel?: number;
549
614
  /**
550
- * 设备id标识
615
+ * 设备id标识。
551
616
  注意:此字段可能返回 null,表示取不到有效值。
552
617
  */
553
618
  OpenId?: string;
554
619
  /**
555
- * 描述当前请求所在设备的相机指纹风险等级,共4级,详情如下: 1 - 低风险 2 - 中风险 3 - 高风险 4 - 攻击 ,-1表示未获取到风险等级
620
+ * 描述当前请求所在设备的相机指纹风险等级,共4级。
621
+ - 详情如下:
622
+ 1 - 低风险。
623
+ 2 - 中风险。
624
+ 3 - 高风险。
625
+ 4 - 攻击。
626
+ -1表示未获取到风险等级。
556
627
  注意:此字段可能返回 null,表示取不到有效值。
557
628
  */
558
629
  CameraInfoLevel?: number;
559
630
  /**
560
- * 描述当前请求所在设备的相机指纹风险标签,详情如下: 01-设备疑似被Root/设备疑似越狱 02-设备疑似被注入 03-设备疑似为模拟器 04-设备疑似存在风险操作 05-摄像头疑似被劫持 06-疑似黑产设备,空表示没有相机指纹风险
631
+ * 描述当前请求所在设备的相机指纹风险标签。
632
+
633
+ - 详情如下:
634
+ 01-设备疑似被Root/设备疑似越狱。
635
+ 02-设备疑似被注入。
636
+ 03-设备疑似为模拟器。
637
+ 04-设备疑似存在风险操作。
638
+ 05-摄像头疑似被劫持。
639
+ 06-疑似黑产设备。
640
+ 空表示没有相机指纹风险。
561
641
  注意:此字段可能返回 null,表示取不到有效值。
562
642
  */
563
643
  CameraInfoTag?: string;
564
644
  /**
565
- * 获取token时透传的信息
645
+ * 获取token时透传的信息。
566
646
  注意:此字段可能返回 null,表示取不到有效值。
567
647
  */
568
648
  Extra?: string;
@@ -768,14 +848,14 @@ export interface EncryptedPhoneVerificationResponse {
768
848
  RequestId?: string;
769
849
  }
770
850
  /**
771
- * 核身视频信息
851
+ * 核身视频信息。
772
852
  */
773
853
  export interface DetectInfoVideoData {
774
854
  /**
775
- * 活体视频的base64编码
855
+ * 活体视频的base64编码。
776
856
  注意:此字段可能返回 null,表示取不到有效值。
777
857
  */
778
- LivenessVideo: string;
858
+ LivenessVideo?: string;
779
859
  }
780
860
  /**
781
861
  * Liveness请求参数结构体
@@ -887,20 +967,27 @@ export interface CheckBankCardInformationResponse {
887
967
  */
888
968
  export interface GetEidTokenRequest {
889
969
  /**
890
- * EID商户id,字段长度最长50位。
970
+ * EID商户id
971
+ - 字段长度最长50位。
891
972
  */
892
973
  MerchantId: string;
893
974
  /**
894
- * 身份标识(未使用OCR服务时,必须传入)。
895
- 规则:a-z,A-Z,0-9组合。最长长度32位。
975
+ * 身份标识。
976
+ - 未使用OCR服务时,必须传入。
977
+ - 规则:a-z,A-Z,0-9组合。
978
+ - 最长长度32位。
896
979
  */
897
980
  IdCard?: string;
898
981
  /**
899
- * 姓名。(未使用OCR服务时,必须传入)最长长度32位。中文请使用UTF-8编码。
982
+ * 姓名。
983
+ - 未使用OCR服务时,必须传入。
984
+ - 最长长度32位。
985
+ - 中文请使用UTF-8编码。
900
986
  */
901
987
  Name?: string;
902
988
  /**
903
- * 透传字段,在获取验证结果时返回。最长长度1024位。
989
+ * 透传字段,在获取验证结果时返回。
990
+ - 最长长度1024位。
904
991
  */
905
992
  Extra?: string;
906
993
  /**
@@ -908,11 +995,14 @@ export interface GetEidTokenRequest {
908
995
  */
909
996
  Config?: GetEidTokenConfig;
910
997
  /**
911
- * 最长长度1024位。用户从Url中进入核身认证结束后重定向的回调链接地址。EidToken会在该链接的query参数中。
998
+ * 用户从Url中进入核身认证结束后重定向的回调链接地址。
999
+ - 最长长度1024位。
1000
+ - EidToken会在该链接的query参数中。
912
1001
  */
913
1002
  RedirectUrl?: string;
914
1003
  /**
915
- * 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1004
+ * 敏感数据加密信息。
1005
+ - 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
916
1006
  */
917
1007
  Encryption?: Encryption;
918
1008
  }
@@ -949,7 +1039,7 @@ export interface CheckIdNameDateRequest {
949
1039
  */
950
1040
  export interface GetFaceIdTokenResponse {
951
1041
  /**
952
- * 有效期 10分钟。只能完成1次核身。
1042
+ * token值。- 有效期 10分钟。- 只能完成1次核身。
953
1043
  */
954
1044
  FaceIdToken?: string;
955
1045
  /**
@@ -1006,72 +1096,97 @@ export interface MinorsVerificationRequest {
1006
1096
  */
1007
1097
  export interface GetFaceIdResultResponse {
1008
1098
  /**
1009
- * 身份证
1099
+ * 身份证。
1010
1100
  */
1011
1101
  IdCard?: string;
1012
1102
  /**
1013
- * 姓名
1103
+ * 姓名。
1014
1104
  */
1015
1105
  Name?: string;
1016
1106
  /**
1017
- * 业务核验结果,参考https://cloud.tencent.com/document/product/1007/47912
1107
+ * 业务核验结果。
1108
+ - 参考:https://cloud.tencent.com/document/product/1007/47912。
1018
1109
  */
1019
1110
  Result?: string;
1020
1111
  /**
1021
- * 业务核验描述
1112
+ * 业务核验描述。
1022
1113
  */
1023
1114
  Description?: string;
1024
1115
  /**
1025
- * 相似度,0-100,数值越大相似度越高
1116
+ * 相似度。
1117
+ - 取值:0-100。
1118
+ - 数值越大相似度越高。
1026
1119
  */
1027
1120
  Similarity?: number;
1028
1121
  /**
1029
- * 用户核验的视频base64,如果选择了使用cos,返回完整cos地址如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey
1122
+ * 用户核验的视频base64
1123
+ - 如果选择了使用cos,返回完整cos地址,如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey。
1030
1124
  注意:此字段可能返回 null,表示取不到有效值。
1031
1125
  */
1032
1126
  VideoBase64?: string;
1033
1127
  /**
1034
- * 用户核验视频的截帧base64,如果选择了使用cos,返回完整cos地址如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey
1128
+ * 用户核验视频的截帧base64
1129
+ - 如果选择了使用cos,返回完整cos地址如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey。
1035
1130
  注意:此字段可能返回 null,表示取不到有效值。
1036
1131
  */
1037
1132
  BestFrameBase64?: string;
1038
1133
  /**
1039
- * 获取token时透传的信息
1134
+ * 获取token时透传的信息。
1040
1135
  注意:此字段可能返回 null,表示取不到有效值。
1041
1136
  */
1042
1137
  Extra?: string;
1043
1138
  /**
1044
- * plus版:描述当前请求所在设备的风险标签,详情如下:
1045
- 01-设备疑似被Root/设备疑似越狱
1046
- 02-设备疑似被注入
1047
- 03-设备疑似为模拟器
1048
- 04-设备疑似存在风险操作
1049
- 05-摄像头疑似被劫持
1050
- 06-疑似黑产设备
1051
- null-无设备风险
1052
- 增强版:此字段不生效,默认为null
1139
+ * plus版:描述当前请求所在设备的风险标签。
1140
+ - 详情如下:
1141
+ 01-设备疑似被Root/设备疑似越狱。
1142
+ 02-设备疑似被注入。
1143
+ 03-设备疑似为模拟器。
1144
+ 04-设备疑似存在风险操作。
1145
+ 05-摄像头疑似被劫持。
1146
+ 06-疑似黑产设备。
1147
+ null-无设备风险。
1148
+ - 增强版:此字段不生效,默认为null。
1053
1149
  注意:此字段可能返回 null,表示取不到有效值。
1054
1150
  */
1055
1151
  DeviceInfoTag?: string;
1056
1152
  /**
1057
- * 行为风险标签,仅错误码返回1007(设备疑似被劫持)时返回风险标签。标签说明:
1153
+ * 行为风险标签。
1154
+ - 仅错误码返回1007(设备疑似被劫持)时返回风险标签。
1155
+ - 标签说明:
1058
1156
  02:攻击风险
1059
1157
  注意:此字段可能返回 null,表示取不到有效值。
1060
1158
  */
1061
1159
  RiskInfoTag?: string;
1062
1160
  /**
1063
- * plus版:描述当前请求活体阶段被拒绝的详细原因,详情如下:01-用户全程闭眼02-用户未完成指定动作03-疑似翻拍攻击04-疑似合成图片05-疑似合成视频06-疑似合成动作07-疑似黑产模板08-疑似存在水印09-反光校验未通过10-最佳帧校验未通过11-人脸质量过差12-人脸距离不匹配13-疑似对抗样本攻击null-无增强版:此字段不生效,默认为null
1161
+ * plus版:描述当前请求活体阶段被拒绝的详细原因。
1162
+ - 详情如下:
1163
+ 01-用户全程闭眼。
1164
+ 02-用户未完成指定动作。
1165
+ 03-疑似翻拍攻击。
1166
+ 04-疑似合成图片。
1167
+ 05-疑似合成视频。
1168
+ 06-疑似合成动作。
1169
+ 07-疑似黑产模板。
1170
+ 08-疑似存在水印。
1171
+ 09-反光校验未通过。
1172
+ 10-最佳帧校验未通过。
1173
+ 11-人脸质量过差。
1174
+ 12-人脸距离不匹配。
1175
+ 13-疑似对抗样本攻击。
1176
+ null-无。
1177
+ - 增强版:此字段不生效,默认为null。
1064
1178
  注意:此字段可能返回 null,表示取不到有效值。
1065
1179
  */
1066
1180
  LivenessInfoTag?: string;
1067
1181
  /**
1068
- * plus版:描述当前请求所在设备的风险等级,共4级,详情如下:
1069
- 1 - 安全
1070
- 2 - 低风险
1071
- 3 - 中风险
1072
- 4 - 高危
1073
- null - 未获取到风险等级
1074
- 增强版:此字段不生效,默认为null
1182
+ * plus版:描述当前请求所在设备的风险等级,共4级。
1183
+ - 详情如下:
1184
+ 1 - 安全。
1185
+ 2 - 低风险。
1186
+ 3 - 中风险。
1187
+ 4 - 高危。
1188
+ null - 未获取到风险等级。
1189
+ - 增强版:此字段不生效,默认为null。
1075
1190
  注意:此字段可能返回 null,表示取不到有效值。
1076
1191
  */
1077
1192
  DeviceInfoLevel?: string;
@@ -1107,21 +1222,24 @@ export interface DetectAIFakeFacesResponse {
1107
1222
  RequestId?: string;
1108
1223
  }
1109
1224
  /**
1110
- * 意愿核身相关结果
1225
+ * 意愿核身相关结果。
1111
1226
  */
1112
1227
  export interface IntentionVerifyData {
1113
1228
  /**
1114
- * 意愿确认环节中录制的视频(base64)。若不存在则为空字符串。
1229
+ * 意愿确认环节中录制的视频(base64)。
1230
+ - 若不存在则为空字符串。
1115
1231
  注意:此字段可能返回 null,表示取不到有效值。
1116
1232
  */
1117
1233
  IntentionVerifyVideo?: string;
1118
1234
  /**
1119
- * 意愿确认环节中用户语音转文字的识别结果。若不存在则为空字符串。
1235
+ * 意愿确认环节中用户语音转文字的识别结果。
1236
+ - 若不存在则为空字符串。
1120
1237
  注意:此字段可能返回 null,表示取不到有效值。
1121
1238
  */
1122
1239
  AsrResult?: string;
1123
1240
  /**
1124
- * 意愿确认环节的结果码。当该结果码为0时,语音朗读的视频与语音识别结果才会返回。
1241
+ * 意愿确认环节的结果码。
1242
+ - 当该结果码为0时,语音朗读的视频与语音识别结果才会返回。
1125
1243
  注意:此字段可能返回 null,表示取不到有效值。
1126
1244
  */
1127
1245
  ErrorCode?: number;
@@ -1131,7 +1249,8 @@ export interface IntentionVerifyData {
1131
1249
  */
1132
1250
  ErrorMessage?: string;
1133
1251
  /**
1134
- * 意愿确认环节中录制视频的最佳帧(base64)。若不存在则为空字符串。
1252
+ * 意愿确认环节中录制视频的最佳帧(base64)。
1253
+ - 若不存在则为空字符串。
1135
1254
  注意:此字段可能返回 null,表示取不到有效值。
1136
1255
  */
1137
1256
  IntentionVerifyBestFrame?: string;
@@ -1356,19 +1475,19 @@ export interface BankCardVerificationRequest {
1356
1475
  Encryption?: Encryption;
1357
1476
  }
1358
1477
  /**
1359
- * 核身最佳帧信息
1478
+ * 核身最佳帧信息。
1360
1479
  */
1361
1480
  export interface DetectInfoBestFrame {
1362
1481
  /**
1363
1482
  * 活体比对最佳帧Base64编码。
1364
1483
  注意:此字段可能返回 null,表示取不到有效值。
1365
1484
  */
1366
- BestFrame: string;
1485
+ BestFrame?: string;
1367
1486
  /**
1368
1487
  * 自截帧Base64编码数组。
1369
1488
  注意:此字段可能返回 null,表示取不到有效值。
1370
1489
  */
1371
- BestFrames: Array<string>;
1490
+ BestFrames?: Array<string>;
1372
1491
  }
1373
1492
  /**
1374
1493
  * GetWeChatBillDetails返回参数结构体
@@ -1483,21 +1602,34 @@ export interface GetEidResultRequest {
1483
1602
  */
1484
1603
  EidToken: string;
1485
1604
  /**
1486
- * 指定拉取的结果信息,取值(0:全部;1:文本类;2:身份证信息;3:最佳截图信息;5:意愿核身朗读模式相关结果;6:意愿核身问答模式相关结果)。
1487
- 13表示拉取文本类、最佳截图信息。
1488
- 默认值:0
1605
+ * 指定拉取的结果信息。
1606
+ - 取值范围:
1607
+ 0:全部。
1608
+ 1:文本类。
1609
+ 2:身份证信息。
1610
+ 3:最佳截图信息。
1611
+ 5:意愿核身朗读模式相关结果。
1612
+ 6:意愿核身问答模式相关结果。
1613
+ - 例如 13表示拉取文本类、最佳截图信息。
1614
+ - 默认值:0
1489
1615
  */
1490
1616
  InfoType?: string;
1491
1617
  /**
1492
- * 从活体视频中截取一定张数的最佳帧。默认为0,最大为3,超出3的最多只给3张。(InfoType需要包含3)
1618
+ * 从活体视频中截取一定张数的最佳帧。
1619
+ - 默认为0,最大为3,超出3的最多只给3张。
1620
+ - InfoType需要包含3。
1493
1621
  */
1494
1622
  BestFramesCount?: number;
1495
1623
  /**
1496
- * 是否对身份证照片进行裁边。默认为false。(InfoType需要包含2)
1624
+ * 是否对身份证照片进行裁边。
1625
+ - 默认为false。
1626
+ - InfoType需要包含2。
1497
1627
  */
1498
1628
  IsCutIdCardImage?: boolean;
1499
1629
  /**
1500
- * 是否需要从身份证中抠出头像。默认为false。(InfoType需要包含2)
1630
+ * 是否需要从身份证中抠出头像。
1631
+ - 默认为false。
1632
+ - InfoType需要包含2。
1501
1633
  */
1502
1634
  IsNeedIdCardAvatar?: boolean;
1503
1635
  }
@@ -1510,8 +1642,9 @@ export interface DetectAuthResponse {
1510
1642
  */
1511
1643
  Url?: string;
1512
1644
  /**
1513
- * 一次核身流程的标识,有效时间为7,200秒;
1514
- 完成核身后,可用该标识获取验证结果信息。
1645
+ * 一次核验流程的唯一标识。
1646
+ - 有效时间为7,200秒,超过有效期再进行人脸核验会报错,请在有效期内进行核验。
1647
+ - 完成人脸核验后,需根据此标识调用[获取实名核身结果信息增强版](https://cloud.tencent.com/document/api/1007/41957)获取用户最终验证结果信息。
1515
1648
  */
1516
1649
  BizToken?: string;
1517
1650
  /**
@@ -1836,48 +1969,73 @@ export interface CheckIdCardInformationRequest {
1836
1969
  export interface GetEidTokenConfig {
1837
1970
  /**
1838
1971
  * 姓名身份证输入方式。
1839
- 1:传身份证正反面OCR
1840
- 2:传身份证正面OCR
1841
- 3:用户手动输入
1842
- 4:客户后台传入
1843
- 默认1
1844
- 注:使用OCR时仅支持用户修改结果中的姓名
1972
+ - 取值范围:
1973
+ 1:传身份证正反面OCR
1974
+ 2:传身份证正面OCR。
1975
+ 3:用户手动输入。
1976
+ 4:客户后台传入。
1977
+ - 默认值:1。
1978
+ - 注意:使用OCR时仅支持用户修改结果中的姓名。
1845
1979
  */
1846
1980
  InputType?: string;
1847
1981
  /**
1848
- * 是否使用意愿核身,默认不使用。注意:如开启使用,则计费标签按【意愿核身】计费标签计价;如不开启,则计费标签按【E证通】计费标签计价,价格详见:[价格说明](https://cloud.tencent.com/document/product/1007/56804)。
1982
+ * 是否使用意愿核身。
1983
+
1984
+ - 默认不使用。
1985
+ - 注意:如开启使用,则计费标签按【意愿核身】计费标签计价;如不开启,则计费标签按【E证通】计费标签计价,价格详见:[价格说明](https://cloud.tencent.com/document/product/1007/56804)。
1849
1986
  */
1850
1987
  UseIntentionVerify?: boolean;
1851
1988
  /**
1852
- * 意愿核身模式。枚举值:1( 语音朗读模式),2(语音问答模式) ,3(点头确认模式)。默认值为1。
1989
+ * 意愿核身模式。
1990
+ - 取值范围:
1991
+ 1:语音朗读模式。
1992
+ 2:语音问答模式。
1993
+ 3:点头确认模式。
1994
+ - 默认值为1。
1853
1995
  */
1854
1996
  IntentionMode?: string;
1855
1997
  /**
1856
- * 意愿核身朗读模式使用的文案,若未使用意愿核身朗读功能,该字段无需传入。默认为空,最长可接受120的字符串长度。
1998
+ * 意愿核身朗读模式使用的文案。
1999
+ - 若未使用意愿核身朗读功能,该字段无需传入。
2000
+ - 默认为空,最长可接受120的字符串长度。
1857
2001
  */
1858
2002
  IntentionVerifyText?: string;
1859
2003
  /**
1860
- * 意愿核身问答模式的配置列表。当前仅支持一个问答。
2004
+ * 意愿核身问答模式的配置列表。
2005
+ - 当前仅支持一个问答。
1861
2006
  */
1862
2007
  IntentionQuestions?: Array<IntentionQuestion>;
1863
2008
  /**
1864
- * 意愿核身(点头确认模式)使用的文案,若未使用意愿核身(点头确认模式),则该字段无需传入。默认为空,最长可接受150的字符串长度。
2009
+ * 意愿核身(点头确认模式)使用的文案。
2010
+ - 若未使用意愿核身(点头确认模式),则该字段无需传入。
2011
+ - 默认为空,最长可接受150的字符串长度。
1865
2012
  */
1866
2013
  IntentionActions?: Array<IntentionActionConfig>;
1867
2014
  /**
1868
- * 意愿核身过程中识别用户的回答意图,开启后除了IntentionQuestions的Answers列表中的标准回答会通过,近似意图的回答也会通过,默认开启。
2015
+ * 意愿核身过程中识别用户的回答意图。
2016
+ - 开启后除了IntentionQuestions的Answers列表中的标准回答会通过,近似意图的回答也会通过。
2017
+ - 默认开启。
1869
2018
  */
1870
2019
  IntentionRecognition?: boolean;
1871
2020
  /**
1872
- * 是否支持港澳台居住证识别
2021
+ * 是否支持港澳台居住证识别。
1873
2022
  */
1874
2023
  IsSupportHMTResidentPermitOCR?: boolean;
1875
2024
  /**
1876
- * 用户语音回答过程中是否开启张嘴识别检测,默认不开启,仅在意愿核身问答模式中使用。
2025
+ * 用户语音回答过程中是否开启张嘴识别检测。
2026
+ - 默认不开启。
2027
+ - 仅在意愿核身问答模式中使用。
1877
2028
  */
1878
2029
  MouthOpenRecognition?: boolean;
1879
2030
  /**
1880
- * 意愿核身语音播报速度,配置后问答模式和点头模式的语音播报环节都会生效,默认值为0: 0:智能语速(根据播报文案的长度自动调整语音播报速度) 1:固定1倍速 2:固定1.2倍速 3:固定1.5倍速
2031
+ * 意愿核身语音播报速度。
2032
+ - 配置后问答模式和点头模式的语音播报环节都会生效。
2033
+ - 默认值为0。
2034
+ - 取值范围:
2035
+ 0:智能语速(根据播报文案的长度自动调整语音播报速度)。
2036
+ 1:固定1倍速。
2037
+ 2:固定1.2倍速。
2038
+ 3:固定1.5倍速。
1881
2039
  */
1882
2040
  Speed?: number;
1883
2041
  }
@@ -2020,16 +2178,19 @@ export interface PhoneVerificationCMCCRequest {
2020
2178
  Encryption?: Encryption;
2021
2179
  }
2022
2180
  /**
2023
- * 核身文本信息
2181
+ * 核身文本信息。
2024
2182
  */
2025
2183
  export interface DetectInfoText {
2026
2184
  /**
2027
- * 本次流程最终验证结果。0为成功(仅包含活体人脸核身结果,不包含意愿核身结果)
2185
+ * 本次流程最终验证结果。
2186
+ - 取值范围:0为成功。
2187
+ - 仅包含活体人脸核身结果,不包含意愿核身结果。
2028
2188
  注意:此字段可能返回 null,表示取不到有效值。
2029
2189
  */
2030
2190
  ErrCode?: number;
2031
2191
  /**
2032
- * 本次流程最终验证结果描述。(仅描述用,文案更新时不会通知。)
2192
+ * 本次流程最终验证结果描述。
2193
+ - 仅描述用,文案更新时不会通知。
2033
2194
  注意:此字段可能返回 null,表示取不到有效值。
2034
2195
  */
2035
2196
  ErrMsg?: string;
@@ -2039,10 +2200,11 @@ export interface DetectInfoText {
2039
2200
  */
2040
2201
  IdCard?: string;
2041
2202
  /**
2042
- * 用户认证时使用的证件号码类型:
2043
- 0:二代身份证的证件号码
2044
- 1:港澳台居住证的证件号码
2045
- 2:其他(核验使用的证件号码非合法身份号码)
2203
+ * 用户认证时使用的证件号码类型。
2204
+ - 取值范围:
2205
+ 0:二代身份证的证件号码。
2206
+ 1:港澳台居住证的证件号码。
2207
+ 2:其他(核验使用的证件号码非合法身份号码)。
2046
2208
  注意:此字段可能返回 null,表示取不到有效值。
2047
2209
  */
2048
2210
  UseIDType?: number;
@@ -2062,7 +2224,8 @@ export interface DetectInfoText {
2062
2224
  */
2063
2225
  OcrAddress?: string;
2064
2226
  /**
2065
- * 身份校验环节识别结果:生日。格式为:YYYY/M/D
2227
+ * 身份校验环节识别结果:生日。
2228
+ - 格式为:YYYY/M/D
2066
2229
  注意:此字段可能返回 null,表示取不到有效值。
2067
2230
  */
2068
2231
  OcrBirth?: string;
@@ -2072,7 +2235,8 @@ export interface DetectInfoText {
2072
2235
  */
2073
2236
  OcrAuthority?: string;
2074
2237
  /**
2075
- * 身份校验环节识别结果:有效日期。格式为:YYYY.MM.DD-YYYY.MM.DD
2238
+ * 身份校验环节识别结果:有效日期。
2239
+ - 格式为:YYYY.MM.DD-YYYY.MM.DD。
2076
2240
  注意:此字段可能返回 null,表示取不到有效值。
2077
2241
  */
2078
2242
  OcrValidDate?: string;
@@ -2093,32 +2257,39 @@ export interface DetectInfoText {
2093
2257
  OcrGender?: string;
2094
2258
  /**
2095
2259
  * 身份校验环节采用的信息上传方式。
2096
- 取值有"NFC"、"OCR"、"手动输入"、"其他"
2260
+ - 取值有"NFC"、"OCR"、"手动输入"、"其他"
2097
2261
  注意:此字段可能返回 null,表示取不到有效值。
2098
2262
  */
2099
2263
  IdInfoFrom?: string;
2100
2264
  /**
2101
- * 本次流程最终活体结果。0为成功
2265
+ * 本次流程最终活体结果。
2266
+ - 0为成功
2102
2267
  注意:此字段可能返回 null,表示取不到有效值。
2103
2268
  */
2104
2269
  LiveStatus?: number;
2105
2270
  /**
2106
- * 本次流程最终活体结果描述。(仅描述用,文案更新时不会通知。)
2271
+ * 本次流程最终活体结果描述。
2272
+ - 仅描述用,文案更新时不会通知。
2107
2273
  注意:此字段可能返回 null,表示取不到有效值。
2108
2274
  */
2109
2275
  LiveMsg?: string;
2110
2276
  /**
2111
- * 本次流程最终一比一结果。0为成功
2277
+ * 本次流程最终一比一结果。
2278
+ - 0为成功
2112
2279
  注意:此字段可能返回 null,表示取不到有效值。
2113
2280
  */
2114
2281
  Comparestatus?: number;
2115
2282
  /**
2116
- * 本次流程最终一比一结果描述。(仅描述用,文案更新时不会通知。)
2283
+ * 本次流程最终一比一结果描述。
2284
+ - 仅描述用,文案更新时不会通知。
2117
2285
  注意:此字段可能返回 null,表示取不到有效值。
2118
2286
  */
2119
2287
  Comparemsg?: string;
2120
2288
  /**
2121
- * 本次流程活体一比一的分数,取值范围 [0.00, 100.00]。相似度大于等于70时才判断为同一人,也可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
2289
+ * 本次流程活体一比一的分数。
2290
+ - 取值范围 [0.00, 100.00]。
2291
+ - 相似度大于等于70时才判断为同一人,也可根据具体场景自行调整阈值。
2292
+ - 阈值70的误通过率为千分之一,阈值80的误通过率是万分之一。
2122
2293
  注意:此字段可能返回 null,表示取不到有效值。
2123
2294
  */
2124
2295
  Sim?: string;
@@ -2138,21 +2309,22 @@ export interface DetectInfoText {
2138
2309
  */
2139
2310
  LivenessDetail?: Array<DetectDetail>;
2140
2311
  /**
2141
- * 描述当前请求活体阶段被拒绝的详细原因,详情如下:
2142
- 01-用户全程闭眼
2143
- 02-用户未完成指定动作
2144
- 03-疑似翻拍攻击
2145
- 04-疑似合成攻击
2146
- 05-疑似黑产模版
2147
- 06-疑似存在水印
2148
- 07-反光校验未通过
2149
- 08-疑似中途换人
2150
- 09-人脸质量过差
2151
- 10-距离校验不通过
2152
- 11-疑似对抗样本攻击
2153
- 12-嘴巴区域疑似存在攻击痕迹
2154
- 13-眼睛区域疑似存在攻击痕迹
2155
- 14-眼睛或嘴巴被遮挡
2312
+ * 描述当前请求活体阶段被拒绝的详细原因,该参数仅限PLUS版本核身服务返回。
2313
+ - 详情如下:
2314
+ 01-用户全程闭眼
2315
+ 02-用户未完成指定动作
2316
+ 03-疑似翻拍攻击
2317
+ 04-疑似合成攻击
2318
+ 05-疑似黑产模版
2319
+ 06-疑似存在水印
2320
+ 07-反光校验未通过
2321
+ 08-疑似中途换人
2322
+ 09-人脸质量过差
2323
+ 10-距离校验不通过
2324
+ 11-疑似对抗样本攻击
2325
+ 12-嘴巴区域疑似存在攻击痕迹
2326
+ 13-眼睛区域疑似存在攻击痕迹
2327
+ 14-眼睛或嘴巴被遮挡
2156
2328
  注意:此字段可能返回 null,表示取不到有效值。
2157
2329
  */
2158
2330
  LivenessInfoTag?: Array<string>;
@@ -2162,41 +2334,43 @@ export interface DetectInfoText {
2162
2334
  */
2163
2335
  Mobile?: string;
2164
2336
  /**
2165
- * 本次流程最终比对库源类型。包括:
2166
- 权威库;
2167
- 业务方自有库(用户上传照片、客户的混合库、混合部署库);
2168
- 二次验证库;
2169
- 人工审核库;
2337
+ * 本次流程最终比对库源类型。
2338
+ - 取值范围:
2339
+ 权威库。
2340
+ 业务方自有库(用户上传照片、客户的混合库、混合部署库)。
2341
+ 二次验证库。
2342
+ 人工审核库。
2170
2343
  注意:此字段可能返回 null,表示取不到有效值。
2171
2344
  */
2172
2345
  CompareLibType?: string;
2173
2346
  /**
2174
- * 本次流程最终活体类型。包括:
2175
- 0:未知
2176
- 1:数字活体
2177
- 2:动作活体
2178
- 3:静默活体
2179
- 4:一闪活体(动作+光线)
2347
+ * 本次流程最终活体类型。
2348
+ - 取值范围:
2349
+ 0:未知
2350
+ 1:数字活体
2351
+ 2:动作活体
2352
+ 3:静默活体
2353
+ 4:一闪活体(动作+光线)
2180
2354
  注意:此字段可能返回 null,表示取不到有效值。
2181
2355
  */
2182
2356
  LivenessMode?: number;
2183
2357
  /**
2184
- * nfc重复计费requestId列表
2358
+ * nfc重复计费requestId列表。
2185
2359
  注意:此字段可能返回 null,表示取不到有效值。
2186
2360
  */
2187
2361
  NFCRequestIds?: Array<string>;
2188
2362
  /**
2189
- * nfc重复计费计数
2363
+ * nfc重复计费计数。
2190
2364
  注意:此字段可能返回 null,表示取不到有效值。
2191
2365
  */
2192
2366
  NFCBillingCounts?: number;
2193
2367
  /**
2194
- * 港澳台居住证通行证号码
2368
+ * 港澳台居住证通行证号码。
2195
2369
  注意:此字段可能返回 null,表示取不到有效值。
2196
2370
  */
2197
2371
  PassNo?: string;
2198
2372
  /**
2199
- * 港澳台居住证签发次数
2373
+ * 港澳台居住证签发次数。
2200
2374
  注意:此字段可能返回 null,表示取不到有效值。
2201
2375
  */
2202
2376
  VisaNum?: string;
@@ -2387,21 +2561,29 @@ export interface GetDetectInfoEnhancedRequest {
2387
2561
  */
2388
2562
  RuleId: string;
2389
2563
  /**
2390
- * 指定拉取的结果信息,取值(0:全部;1:文本类;2:身份证信息;3:视频最佳截图信息)。
2391
- 13表示拉取文本类、视频最佳截图信息。
2392
- 默认值:0
2564
+ * 指定拉取的结果信息。
2565
+ - 取值(0:全部;1:文本类;2:身份证信息;3:视频最佳截图信息)。
2566
+ - 例如 13 表示拉取文本类、视频最佳截图信息。
2567
+ - 默认值:0
2393
2568
  */
2394
2569
  InfoType?: string;
2395
2570
  /**
2396
- * 从活体视频中截取一定张数的最佳帧(仅部分服务支持,若需使用请与慧眼小助手沟通)。默认为0,最大为10,超出10的最多只给10张。(InfoType需要包含3)
2571
+ * 从活体视频中截取一定张数的最佳帧。
2572
+ - 仅部分服务支持,若需使用请与慧眼小助手沟通。
2573
+ - 默认值为0,最大值为10,超出10的最多只给10张。
2574
+ - InfoType需要包含3。
2397
2575
  */
2398
2576
  BestFramesCount?: number;
2399
2577
  /**
2400
- * 是否对身份证照片进行裁边。默认为false。(InfoType需要包含2)
2578
+ * 是否对身份证照片进行裁边。
2579
+ - 默认为false。
2580
+ - InfoType需要包含2。
2401
2581
  */
2402
2582
  IsCutIdCardImage?: boolean;
2403
2583
  /**
2404
- * 是否需要从身份证中抠出头像。默认为false。(InfoType需要包含2)
2584
+ * 是否需要从身份证中抠出头像。
2585
+ - 默认为false。
2586
+ - InfoType需要包含2。
2405
2587
  */
2406
2588
  IsNeedIdCardAvatar?: boolean;
2407
2589
  /**
@@ -2409,11 +2591,13 @@ export interface GetDetectInfoEnhancedRequest {
2409
2591
  */
2410
2592
  IsEncrypt?: boolean;
2411
2593
  /**
2412
- * 是否需要对返回中的敏感信息进行加密。仅指定加密算法Algorithm即可,其余字段传入默认值。其中敏感信息包括:Response.Text.IdCard、Response.Text.Name、Response.Text.OcrIdCard、Response.Text.OcrName
2594
+ * 是否需要对返回中的敏感信息进行加密。
2595
+ - 只需指定加密算法Algorithm即可,其余字段传入默认值。
2596
+ - 敏感信息包括:Response.Text.IdCard、Response.Text.Name、Response.Text.OcrIdCard、Response.Text.OcrName。
2413
2597
  */
2414
2598
  Encryption?: Encryption;
2415
2599
  /**
2416
- * 是否对回包整体进行加密
2600
+ * 是否对回包整体进行加密。
2417
2601
  */
2418
2602
  IsEncryptResponse?: boolean;
2419
2603
  }
@@ -2422,16 +2606,21 @@ export interface GetDetectInfoEnhancedRequest {
2422
2606
  */
2423
2607
  export interface LivenessRecognitionResponse {
2424
2608
  /**
2425
- * 验证通过后的视频最佳截图照片,照片为BASE64编码后的值,jpg格式。
2609
+ * 验证通过后的视频最佳截图照片。
2610
+ - 照片为BASE64编码后的值,jpg格式。
2426
2611
  注意:此字段可能返回 null,表示取不到有效值。
2427
2612
  */
2428
2613
  BestFrameBase64?: string;
2429
2614
  /**
2430
- * 相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
2615
+ * 相似度。
2616
+ - 取值范围 [0.00, 100.00]。
2617
+ - 推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
2431
2618
  */
2432
2619
  Sim?: number;
2433
2620
  /**
2434
- * 业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
2621
+ * 业务错误码。
2622
+ - 成功情况返回Success。
2623
+ - 错误情况请参考下方错误码 列表中FailedOperation部分
2435
2624
  */
2436
2625
  Result?: string;
2437
2626
  /**
@@ -2457,7 +2646,9 @@ export declare type GetLiveCodeRequest = null;
2457
2646
  */
2458
2647
  export interface GetEidResultResponse {
2459
2648
  /**
2460
- * 文本类信息。(基于对敏感信息的保护,验证使用的姓名和身份证号统一通过加密后从Eidinfo参数中返回,如需获取请在控制台申请返回身份信息,详见[E证通获取实名信息指引](https://cloud.tencent.com/document/product/1007/63370))
2649
+ * 文本类信息。
2650
+ - 基于对敏感信息的保护,验证使用的姓名和身份证号统一通过加密后从EidInfo参数中返回。
2651
+ - 如需获取请在控制台申请返回身份信息,详见[E证通获取实名信息指引](https://cloud.tencent.com/document/product/1007/63370)。
2461
2652
  注意:此字段可能返回 null,表示取不到有效值。
2462
2653
  */
2463
2654
  Text?: DetectInfoText;
@@ -2472,22 +2663,27 @@ export interface GetEidResultResponse {
2472
2663
  */
2473
2664
  BestFrame?: DetectInfoBestFrame;
2474
2665
  /**
2475
- * Eid信息。(包括商户下用户唯一标识以及加密后的姓名、身份证号信息。解密方式详见[E证通获取实名信息指引](https://cloud.tencent.com/document/product/1007/63370))
2666
+ * Eid信息。
2667
+ - 包括商户下用户唯一标识以及加密后的姓名、身份证号信息。
2668
+ - 解密方式详见[E证通获取实名信息指引](https://cloud.tencent.com/document/product/1007/63370)
2476
2669
  注意:此字段可能返回 null,表示取不到有效值。
2477
2670
  */
2478
2671
  EidInfo?: EidInfo;
2479
2672
  /**
2480
- * 意愿核身朗读模式相关信息。若未使用意愿核身朗读功能,该字段返回值可以不处理。
2673
+ * 意愿核身朗读模式相关信息。
2674
+ - 若未使用意愿核身朗读功能,该字段返回值可以不处理。
2481
2675
  注意:此字段可能返回 null,表示取不到有效值。
2482
2676
  */
2483
2677
  IntentionVerifyData?: IntentionVerifyData;
2484
2678
  /**
2485
- * 意愿核身问答模式相关信息。若未使用意愿核身问答模式功能,该字段返回值可以不处理。
2679
+ * 意愿核身问答模式相关信息。
2680
+ - 若未使用意愿核身问答模式功能,该字段返回值可以不处理。
2486
2681
  注意:此字段可能返回 null,表示取不到有效值。
2487
2682
  */
2488
2683
  IntentionQuestionResult?: IntentionQuestionResult;
2489
2684
  /**
2490
- * 意愿核身点头确认模式的结果信息,若未使用该意愿核身功能,该字段返回值可以不处理。
2685
+ * 意愿核身点头确认模式的结果信息。
2686
+ - 若未使用该意愿核身功能,该字段返回值可以不处理。
2491
2687
  注意:此字段可能返回 null,表示取不到有效值。
2492
2688
  */
2493
2689
  IntentionActionResult?: IntentionActionResult;
@@ -2559,15 +2755,18 @@ export interface PhoneVerificationRequest {
2559
2755
  */
2560
2756
  export interface GetFaceIdResultRequest {
2561
2757
  /**
2562
- * SDK人脸核身流程的标识,调用GetFaceIdToken接口时生成。
2758
+ * SDK人脸核身流程的标识。
2759
+ - 调用GetFaceIdToken接口时生成。
2563
2760
  */
2564
2761
  FaceIdToken: string;
2565
2762
  /**
2566
- * 是否需要拉取视频,默认false不需要
2763
+ * 是否需要拉取视频。
2764
+ - 默认false:不需要。
2567
2765
  */
2568
2766
  IsNeedVideo?: boolean;
2569
2767
  /**
2570
- * 是否需要拉取截帧,默认false不需要
2768
+ * 是否需要拉取截帧。
2769
+ - 默认false:不需要。
2571
2770
  */
2572
2771
  IsNeedBestFrame?: boolean;
2573
2772
  }
@@ -2604,33 +2803,44 @@ export interface CheckPhoneAndNameResponse {
2604
2803
  */
2605
2804
  export interface GetFaceIdTokenRequest {
2606
2805
  /**
2607
- * 本地上传照片(LOCAL)、商业库(BUSINESS)
2806
+ * 比对库。
2807
+ - 取值范围:
2808
+ LOCAL:本地上传照片。
2809
+ BUSINESS:商业库。
2608
2810
  */
2609
2811
  CompareLib: string;
2610
2812
  /**
2611
- * CompareLib为商业库时必传。
2813
+ * 身份证。
2814
+ - CompareLib为商业库时必传。
2612
2815
  */
2613
2816
  IdCard?: string;
2614
2817
  /**
2615
- * CompareLib为商业库时必传。
2818
+ * 姓名。
2819
+ - CompareLib为商业库时必传。
2616
2820
  */
2617
2821
  Name?: string;
2618
2822
  /**
2619
- * CompareLib为上传照片比对时必传,Base64后图片最大8MB
2620
- 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
2823
+ * 图片的Base64。
2824
+ - CompareLib为上传照片比对时必传。
2825
+ - Base64后图片最大8MB。
2826
+ - 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
2621
2827
  */
2622
2828
  ImageBase64?: string;
2623
2829
  /**
2624
- * SDK中生成的Meta字符串
2830
+ * SDK中生成的Meta字符串。
2625
2831
  */
2626
2832
  Meta?: string;
2627
2833
  /**
2628
- * 透传参数 1000长度字符串
2834
+ * 透传参数。
2835
+ - 1000长度字符串
2629
2836
  */
2630
2837
  Extra?: string;
2631
2838
  /**
2632
- * 默认为false,设置该参数为true后,核身过程中的视频图片将会存储在人脸核身控制台授权cos的bucket中,拉取结果时会返回对应资源完整cos地址。开通地址见https://console.cloud.tencent.com/faceid/cos
2633
- 【注意】选择该参数为true后将不返回base64数据,请根据接入情况谨慎修改。
2839
+ * 是否使用cos桶。
2840
+ - 默认为false。
2841
+ - 设置该参数为true后,核身过程中的视频图片将会存储在人脸核身控制台授权cos的bucket中,拉取结果时会返回对应资源完整cos地址。
2842
+ - 开通地址见https://console.cloud.tencent.com/faceid/cos
2843
+ - 【注意】选择该参数为true后将不返回base64数据,请根据接入情况谨慎修改。
2634
2844
  */
2635
2845
  UseCos?: boolean;
2636
2846
  /**
@@ -2638,8 +2848,9 @@ export interface GetFaceIdTokenRequest {
2638
2848
  */
2639
2849
  Encryption?: Encryption;
2640
2850
  /**
2641
- * 用于细分客户使用场景,申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。如有疑问,请添加腾讯云人脸核身小助手进行咨询。
2642
- 示例值:1
2851
+ * 用于细分客户使用场景。
2852
+ - 申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。
2853
+ - 如有疑问,请添加腾讯云人脸核身小助手进行咨询。
2643
2854
  */
2644
2855
  RuleId?: string;
2645
2856
  }
@@ -2688,11 +2899,11 @@ export interface IntentionActionResult {
2688
2899
  */
2689
2900
  export interface GetFaceidRiskInfoTokenRequest {
2690
2901
  /**
2691
- * SDK中生成的Meta字符串
2902
+ * SDK中生成的Meta字符串。
2692
2903
  */
2693
2904
  Meta?: string;
2694
2905
  /**
2695
- * 透传参数 1000长度字符串
2906
+ * 透传参数 1000长度字符串。
2696
2907
  */
2697
2908
  Extra?: string;
2698
2909
  }
@@ -2719,11 +2930,12 @@ export interface BankCard2EVerificationRequest {
2719
2930
  */
2720
2931
  export interface ImageRecognitionV2Request {
2721
2932
  /**
2722
- * 身份证号
2933
+ * 身份证号。
2723
2934
  */
2724
2935
  IdCard: string;
2725
2936
  /**
2726
- * 姓名。中文请使用UTF-8编码。
2937
+ * 姓名。
2938
+ - 中文请使用UTF-8编码。
2727
2939
  */
2728
2940
  Name: string;
2729
2941
  /**
@@ -2737,7 +2949,8 @@ export interface ImageRecognitionV2Request {
2737
2949
  */
2738
2950
  Optional?: string;
2739
2951
  /**
2740
- * 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2952
+ * 敏感数据加密信息。
2953
+ - 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2741
2954
  */
2742
2955
  Encryption?: Encryption;
2743
2956
  }
@@ -2824,7 +3037,7 @@ export interface ChargeDetail {
2824
3037
  */
2825
3038
  export interface ParseNfcDataRequest {
2826
3039
  /**
2827
- * 前端SDK返回
3040
+ * 前端SDK返回。
2828
3041
  */
2829
3042
  ReqId: string;
2830
3043
  }
@@ -2966,7 +3179,7 @@ export interface GetDetectInfoRequest {
2966
3179
  InfoType?: string;
2967
3180
  }
2968
3181
  /**
2969
- * 核身身份证图片信息
3182
+ * 核身身份证图片信息。
2970
3183
  */
2971
3184
  export interface DetectInfoIdCardData {
2972
3185
  /**
@@ -2975,7 +3188,7 @@ export interface DetectInfoIdCardData {
2975
3188
  */
2976
3189
  OcrFront?: string;
2977
3190
  /**
2978
- * OCR反面照片的base64编码
3191
+ * OCR反面照片的base64编码。
2979
3192
  注意:此字段可能返回 null,表示取不到有效值。
2980
3193
  */
2981
3194
  OcrBack?: string;
@@ -2995,28 +3208,32 @@ export interface DetectInfoIdCardData {
2995
3208
  */
2996
3209
  Avatar?: string;
2997
3210
  /**
2998
- * 身份证人像面告警码,开启身份证告警功能后才会返回,返回数组中可能出现的告警码如下:
2999
- -9100 身份证有效日期不合法告警,
3000
- -9101 身份证边框不完整告警,
3001
- -9102 身份证复印件告警,
3002
- -9103 身份证翻拍告警,
3003
- -9105 身份证框内遮挡告警,
3004
- -9104 临时身份证告警,
3005
- -9106 身份证 PS 告警(疑似存在PS痕迹),
3006
- -9107 身份证反光告警。
3211
+ * 身份证人像面告警码。
3212
+ - 开启身份证告警功能后才会返回。
3213
+ - 返回数组中可能出现的告警码如下:
3214
+ - -9100 身份证有效日期不合法告警。
3215
+ - -9101 身份证边框不完整告警。
3216
+ - -9102 身份证复印件告警。
3217
+ - -9103 身份证翻拍告警。
3218
+ - -9105 身份证框内遮挡告警。
3219
+ - -9104 临时身份证告警。
3220
+ - -9106 身份证 PS 告警(疑似存在PS痕迹)。
3221
+ - -9107 身份证反光告警。
3007
3222
  注意:此字段可能返回 null,表示取不到有效值。
3008
3223
  */
3009
3224
  WarnInfos?: Array<number | bigint>;
3010
3225
  /**
3011
- * 身份证国徽面告警码,开启身份证告警功能后才会返回,返回数组中可能出现的告警码如下:
3012
- -9100 身份证有效日期不合法告警,
3013
- -9101 身份证边框不完整告警,
3014
- -9102 身份证复印件告警,
3015
- -9103 身份证翻拍告警,
3016
- -9105 身份证框内遮挡告警,
3017
- -9104 临时身份证告警,
3018
- -9106 身份证 PS 告警(疑似存在PS痕迹),
3019
- -9107 身份证反光告警。
3226
+ * 身份证国徽面告警码。
3227
+ - 开启身份证告警功能后才会返回。
3228
+ - 返回数组中可能出现的告警码如下:
3229
+ - -9100 身份证有效日期不合法告警,
3230
+ - -9101 身份证边框不完整告警,
3231
+ - -9102 身份证复印件告警,
3232
+ - -9103 身份证翻拍告警,
3233
+ - -9105 身份证框内遮挡告警,
3234
+ - -9104 临时身份证告警,
3235
+ - -9106 身份证 PS 告警(疑似存在PS痕迹),
3236
+ - -9107 身份证反光告警。
3020
3237
  注意:此字段可能返回 null,表示取不到有效值。
3021
3238
  */
3022
3239
  BackWarnInfos?: Array<number | bigint>;
@@ -3044,12 +3261,14 @@ export interface CheckPhoneAndNameRequest {
3044
3261
  */
3045
3262
  export interface GetEidTokenResponse {
3046
3263
  /**
3047
- * 一次核身流程的标识,有效时间为600秒;
3048
- 完成核身后,可用该标识获取验证结果信息。
3264
+ * 一次核身流程的标识。
3265
+ - 有效时间为600秒。
3266
+ - 完成核身后,可用该标识获取验证结果信息。
3049
3267
  */
3050
3268
  EidToken?: string;
3051
3269
  /**
3052
- * 发起核身流程的URL,用于H5场景核身。
3270
+ * 发起核身流程的URL
3271
+ - 用于H5场景核身。
3053
3272
  */
3054
3273
  Url?: string;
3055
3274
  /**
@@ -3062,11 +3281,14 @@ export interface GetEidTokenResponse {
3062
3281
  */
3063
3282
  export interface IntentionQuestion {
3064
3283
  /**
3065
- * 当选择语音问答模式时,系统自动播报的问题文本,最大长度为150个字符。
3284
+ * 当选择语音问答模式时,系统自动播报的问题文本。
3285
+ - 最大长度为150个字符。
3066
3286
  */
3067
3287
  Question: string;
3068
3288
  /**
3069
- * 当选择语音问答模式时,用于判断用户回答是否通过的标准答案列表,传入后可自动判断用户回答文本是否在标准文本列表中。列表长度最大为50,单个答案长度限制10个字符。
3289
+ * 当选择语音问答模式时,用于判断用户回答是否通过的标准答案列表。
3290
+ - 传入后可自动判断用户回答文本是否在标准文本列表中。
3291
+ - 列表长度最大为50,单个答案长度限制10个字符。
3070
3292
  */
3071
3293
  Answers: Array<string>;
3072
3294
  }