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
@@ -113,11 +113,15 @@ export interface IdCardVerificationRequest {
113
113
  */
114
114
  export interface ImageRecognitionV2Response {
115
115
  /**
116
- * 相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
116
+ * 相似度。
117
+ - 取值范围 [0.00, 100.00]。
118
+ - 推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
117
119
  */
118
120
  Sim?: number
119
121
  /**
120
- * 业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
122
+ * 业务错误码。
123
+ - 成功情况返回Success。
124
+ - 错误情况请参考下方错误码 列表中FailedOperation部分
121
125
  */
122
126
  Result?: string
123
127
  /**
@@ -160,22 +164,26 @@ export interface GetDetectInfoEnhancedResponse {
160
164
  */
161
165
  Encryption?: Encryption
162
166
  /**
163
- * 意愿核身朗读模式结果信息。若未使用意愿核身功能,该字段返回值可以不处理。
167
+ * 意愿核身朗读模式结果信息。
168
+ - 若未使用意愿核身功能,该字段返回值可以不处理。
164
169
  注意:此字段可能返回 null,表示取不到有效值。
165
170
  */
166
171
  IntentionVerifyData?: IntentionVerifyData
167
172
  /**
168
- * 意愿核身问答模式结果。若未使用该意愿核身功能,该字段返回值可以不处理。
173
+ * 意愿核身问答模式结果。
174
+
175
+ - 若未使用该意愿核身功能,该字段返回值可以不处理。
169
176
  注意:此字段可能返回 null,表示取不到有效值。
170
177
  */
171
178
  IntentionQuestionResult?: IntentionQuestionResult
172
179
  /**
173
- * 意愿核身点头确认模式的结果信息,若未使用该意愿核身功能,该字段返回值可以不处理。
180
+ * 意愿核身点头确认模式的结果信息。
181
+ - 若未使用该意愿核身功能,该字段返回值可以不处理。
174
182
  注意:此字段可能返回 null,表示取不到有效值。
175
183
  */
176
184
  IntentionActionResult?: IntentionActionResult
177
185
  /**
178
- * 加密后的数据
186
+ * 加密后的数据。
179
187
  注意:此字段可能返回 null,表示取不到有效值。
180
188
  */
181
189
  EncryptedBody?: string
@@ -186,69 +194,75 @@ export interface GetDetectInfoEnhancedResponse {
186
194
  }
187
195
 
188
196
  /**
189
- * 意愿核身问答模式结果
197
+ * 意愿核身问答模式结果。
190
198
  */
191
199
  export interface IntentionQuestionResult {
192
200
  /**
193
- * 意愿核身错误码:
194
- 0: "成功"
195
- -1: "参数错误"
196
- -2: "系统异常"
197
- -101: "请保持人脸在框内"
198
- -102: "检测到多张人脸"
199
- -103: "人脸检测失败"
200
- -104: "人脸检测不完整"
201
- -105: "请勿遮挡眼睛"
202
- -106: "请勿遮挡嘴巴"
203
- -107: "请勿遮挡鼻子"
204
- -201: "人脸比对相似度低"
205
- -202: "人脸比对失败"
206
- -301: "意愿核验不通过"
207
- -302: "用户回答阶段未检测到张嘴动作"
208
- -800: "前端不兼容错误"
209
- -801: "用户未授权摄像头和麦克风权限"
210
- -802: "核验流程异常中断,请勿切屏或进行其他操作"
211
- -803: "用户主动关闭链接/异常断开链接"
212
- -998: "系统数据异常"
213
- -999: "系统未知错误,请联系人工核实"
214
- 若在人脸核身过程失败、未进入意愿确认过程,则该参数返回为空,请参考人脸核身错误码结果(DetectInfoText.ErrCode)
201
+ * 意愿核身错误码。
202
+ - 取值范围:
203
+ 0: "成功"
204
+ -1: "参数错误"
205
+ -2: "系统异常"
206
+ -101: "请保持人脸在框内"
207
+ -102: "检测到多张人脸"
208
+ -103: "人脸检测失败"
209
+ -104: "人脸检测不完整"
210
+ -105: "请勿遮挡眼睛"
211
+ -106: "请勿遮挡嘴巴"
212
+ -107: "请勿遮挡鼻子"
213
+ -201: "人脸比对相似度低"
214
+ -202: "人脸比对失败"
215
+ -301: "意愿核验不通过"
216
+ -302: "用户回答阶段未检测到张嘴动作"
217
+ -800: "前端不兼容错误"
218
+ -801: "用户未授权摄像头和麦克风权限"
219
+ -802: "核验流程异常中断,请勿切屏或进行其他操作"
220
+ -803: "用户主动关闭链接/异常断开链接"
221
+ -998: "系统数据异常"
222
+ -999: "系统未知错误,请联系人工核实"
223
+ - 若在人脸核身过程失败、未进入意愿确认过程,则该参数返回为空,请参考人脸核身错误码结果(DetectInfoText.ErrCode)
215
224
  注意:此字段可能返回 null,表示取不到有效值。
216
225
  */
217
226
  FinalResultDetailCode?: number
218
227
  /**
219
- * 意愿核身错误信息
228
+ * 意愿核身错误信息。
220
229
  注意:此字段可能返回 null,表示取不到有效值。
221
230
  */
222
231
  FinalResultMessage?: string
223
232
  /**
224
- * 视频base64(其中包含全程问题和回答音频,mp4格式)
233
+ * 视频base64
234
+ - 其中包含全程问题和回答音频,mp4格式。
225
235
  注意:此字段可能返回 null,表示取不到有效值。
226
236
  */
227
237
  Video?: string
228
238
  /**
229
- * 屏幕截图base64列表
239
+ * 屏幕截图base64列表。
230
240
  注意:此字段可能返回 null,表示取不到有效值。
231
241
  */
232
242
  ScreenShot?: Array<string>
233
243
  /**
234
- * 和答案匹配结果列表
235
- 0:成功,-1:不匹配
244
+ * 和答案匹配结果列表。
245
+ - 取值范围(0:成功;-1:不匹配)
236
246
  注意:此字段可能返回 null,表示取不到有效值。
237
247
  */
238
248
  ResultCode?: Array<string>
239
249
  /**
240
- * 回答问题语音识别结果列表
250
+ * 回答问题语音识别结果列表。
241
251
  注意:此字段可能返回 null,表示取不到有效值。
242
252
  */
243
253
  AsrResult?: Array<string>
244
254
  /**
245
- * 答案录音音频
255
+ * 答案录音音频。
246
256
  注意:此字段可能返回 null,表示取不到有效值。
247
257
  */
248
258
  Audios?: Array<string>
249
259
  /**
250
- * 意愿核身最终结果:
251
- 0:认证通过,-1:认证未通过,-2:浏览器内核不兼容,无法进行意愿校验。建议使用“FinalResultDetailCode”参数获取详细的错误码信息。
260
+ * 意愿核身最终结果。
261
+ - 取值范围:
262
+ 0:认证通过。
263
+ -1:认证未通过。
264
+ -2:浏览器内核不兼容,无法进行意愿校验。
265
+ - 建议使用“FinalResultDetailCode”参数获取详细的错误码信息。
252
266
  注意:此字段可能返回 null,表示取不到有效值。
253
267
  */
254
268
  FinalResultCode?: string
@@ -302,107 +316,126 @@ export interface MobileStatusRequest {
302
316
  */
303
317
  export interface ParseNfcDataResponse {
304
318
  /**
305
- * 0为首次查询成功,-1为查询失败。
319
+ * 结果码。
320
+ - 取值范围:0为首次查询成功,-1为查询失败。
306
321
  注意:此字段可能返回 null,表示取不到有效值。
307
322
  */
308
- ResultCode: string
323
+ ResultCode?: string
309
324
  /**
310
- * 身份证号
325
+ * 身份证号。
311
326
  注意:此字段可能返回 null,表示取不到有效值。
312
327
  */
313
- IdNum: string
328
+ IdNum?: string
314
329
  /**
315
- * 姓名
330
+ * 姓名。
316
331
  注意:此字段可能返回 null,表示取不到有效值。
317
332
  */
318
- Name: string
333
+ Name?: string
319
334
  /**
320
- * 照片
335
+ * 照片。
321
336
  注意:此字段可能返回 null,表示取不到有效值。
322
337
  */
323
- Picture: string
338
+ Picture?: string
324
339
  /**
325
- * 出生日期
340
+ * 出生日期。
326
341
  注意:此字段可能返回 null,表示取不到有效值。
327
342
  */
328
- BirthDate: string
343
+ BirthDate?: string
329
344
  /**
330
- * 有效期起始时间
345
+ * 有效期起始时间。
331
346
  注意:此字段可能返回 null,表示取不到有效值。
332
347
  */
333
- BeginTime: string
348
+ BeginTime?: string
334
349
  /**
335
- * 有效期结束时间
350
+ * 有效期结束时间。
336
351
  注意:此字段可能返回 null,表示取不到有效值。
337
352
  */
338
- EndTime: string
353
+ EndTime?: string
339
354
  /**
340
- * 住址
355
+ * 住址。
341
356
  注意:此字段可能返回 null,表示取不到有效值。
342
357
  */
343
- Address: string
358
+ Address?: string
344
359
  /**
345
- * 民族
360
+ * 民族。
346
361
  注意:此字段可能返回 null,表示取不到有效值。
347
362
  */
348
- Nation: string
363
+ Nation?: string
349
364
  /**
350
- * 性别
365
+ * 性别。
351
366
  注意:此字段可能返回 null,表示取不到有效值。
352
367
  */
353
- Sex: string
368
+ Sex?: string
354
369
  /**
355
- * 身份证 01 中国护照 03 军官证 04 武警证 05 港澳通行证 06 台胞证 07 外国护照 08 士兵证 09 临时身份证 10 户口本 11 警官证 12 外国人永久居留证 13 港澳台居民居住证 14 回乡证 15 大陆居民来往台湾通行证 16 其他证件 99
370
+ * 类型。
371
+ - 取值范围:
372
+ 01:身份证。
373
+ 03 :中国护照。
374
+ 04 :军官证。
375
+ 05 :武警证。
376
+ 06:港澳通行证 。
377
+ 07 :台胞证 。
378
+ 08:外国护照 。
379
+ 09 :士兵证。
380
+ 09 :临时身份证。
381
+ 11:户口本 。
382
+ 12 :警官证 。
383
+ 13:外国人永久居留证。
384
+ 14:港澳台居民居住证。
385
+ 15:回乡证。
386
+ 16:大陆居民来往台湾通行证。
387
+ 99:其他证件。
356
388
  注意:此字段可能返回 null,表示取不到有效值。
357
389
  */
358
- IdType: string
390
+ IdType?: string
359
391
  /**
360
- * 英文姓名
392
+ * 英文姓名。
361
393
  注意:此字段可能返回 null,表示取不到有效值。
362
394
  */
363
- EnName: string
395
+ EnName?: string
364
396
  /**
365
397
  * 签发机关
366
398
  注意:此字段可能返回 null,表示取不到有效值。
367
399
  */
368
- SigningOrganization: string
400
+ SigningOrganization?: string
369
401
  /**
370
- * 港澳台居民居住证,通行证号码
402
+ * 港澳台居民居住证,通行证号码。
371
403
  注意:此字段可能返回 null,表示取不到有效值。
372
404
  */
373
- OtherIdNum: string
405
+ OtherIdNum?: string
374
406
  /**
375
- * 旅行证件国籍
407
+ * 旅行证件国籍。
376
408
  注意:此字段可能返回 null,表示取不到有效值。
377
409
  */
378
- Nationality: string
410
+ Nationality?: string
379
411
  /**
380
- * 旅行证件机读区第二行 29~42
412
+ * 旅行证件机读区第二行 29~42 位。
381
413
  注意:此字段可能返回 null,表示取不到有效值。
382
414
  */
383
- PersonalNumber: string
415
+ PersonalNumber?: string
384
416
  /**
385
- * 旅行证件类的核验结果。JSON格式如下:
386
- {"result_issuer ":"签发者证书合法性验证结果 ","result_pape r":"证件安全对象合法性验证 结果 ","result_data" :"防数据篡改验证结果 ","result_chip" :"防证书件芯片被复制验证结果"}
387
- 0:验证通过,1: 验证不通过,2: 未验证,3:部分通过,当4项核验结果都为0时,表示证件为真
417
+ * 旅行证件类的核验结果。
418
+ - JSON格式如下:
419
+ {"result_issuer ":"签发者证书合法性验证结果 ","result_pape r":"证件安全对象合法性验证 结果 ","result_data" :"防数据篡改验证结果 ","result_chip" :"防证书件芯片被复制验证结果"} 。
420
+ - 取值范围: 0:验证通过,1: 验证不通过,2: 未验证,3:部分通过,当4项核验结果都为0时,表示证件为真。
388
421
  注意:此字段可能返回 null,表示取不到有效值。
389
422
  */
390
- CheckMRTD: string
423
+ CheckMRTD?: string
391
424
  /**
392
- * 身份证照片面合成图片
425
+ * 身份证照片面合成图片。
393
426
  注意:此字段可能返回 null,表示取不到有效值。
394
427
  */
395
- ImageA: string
428
+ ImageA?: string
396
429
  /**
397
- * 身份证国徽面合成图片
430
+ * 身份证国徽面合成图片。
398
431
  注意:此字段可能返回 null,表示取不到有效值。
399
432
  */
400
- ImageB: string
433
+ ImageB?: string
401
434
  /**
402
- * 对result code的结果描述
435
+ * 对result code的结果描述。
403
436
  注意:此字段可能返回 null,表示取不到有效值。
404
437
  */
405
- ResultDescription: string
438
+ ResultDescription?: string
406
439
  /**
407
440
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
408
441
  */
@@ -414,16 +447,18 @@ export interface ParseNfcDataResponse {
414
447
  */
415
448
  export interface LivenessRecognitionRequest {
416
449
  /**
417
- * 身份证号
450
+ * 身份证号。
418
451
  */
419
452
  IdCard: string
420
453
  /**
421
- * 姓名。中文请使用UTF-8编码。
454
+ * 姓名。
455
+ - 中文请使用UTF-8编码。
422
456
  */
423
457
  Name: string
424
458
  /**
425
- * 活体检测类型,取值:LIP/ACTION/SILENT。
426
- LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。
459
+ * 活体检测类型。
460
+ - 取值:LIP/ACTION/SILENT
461
+ - LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。
427
462
  */
428
463
  LivenessType: string
429
464
  /**
@@ -432,28 +467,31 @@ BASE64编码后的大小不超过8M,支持mp4、avi、flv格式。
432
467
  */
433
468
  VideoBase64?: string
434
469
  /**
435
- * 用于活体检测的视频Url 地址。视频下载后经Base64编码不超过 8M,视频下载耗时不超过4S,支持mp4、avi、flv格式。
436
-
437
- 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
438
-
439
- 建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议视频存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
470
+ * 用于活体检测的视频Url 地址。
471
+ - 视频下载后经Base64编码不超过 8M,视频下载耗时不超过4S,支持mp4、avi、flv格式。
472
+ - 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
473
+ - 建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议视频存储于腾讯云。
474
+ - 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
440
475
  */
441
476
  VideoUrl?: string
442
477
  /**
443
- * 数字模式传参:传数字验证码,验证码需先调用<a href="https://cloud.tencent.com/document/product/1007/31821">获取数字验证码接口</a>得到;
444
- 动作模式传参:传动作顺序,动作顺序需先调用<a href="https://cloud.tencent.com/document/product/1007/31822">获取动作顺序接口</a>得到;
445
- 静默模式传参:空。
478
+ * 验证数据。
479
+ - 数字模式传参:传数字验证码,验证码需先调用<a href="https://cloud.tencent.com/document/product/1007/31821">获取数字验证码接口</a>得到;
480
+ - 动作模式传参:传动作顺序,动作顺序需先调用<a href="https://cloud.tencent.com/document/product/1007/31822">获取动作顺序接口</a>得到;
481
+ - 静默模式传参:空。
446
482
  */
447
483
  ValidateData?: string
448
484
  /**
449
485
  * 额外配置,传入JSON字符串。
486
+ - 格式如下:
450
487
  {
451
488
  "BestFrameNum": 2 //需要返回多张最佳截图,取值范围2-10
452
489
  }
453
490
  */
454
491
  Optional?: string
455
492
  /**
456
- * 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
493
+ * 敏感数据加密信息。
494
+ - 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
457
495
  */
458
496
  Encryption?: Encryption
459
497
  }
@@ -481,21 +519,21 @@ export interface CheckEidTokenStatusResponse {
481
519
  */
482
520
  export interface EidInfo {
483
521
  /**
484
- * 商户方 appeIDcode 的数字证书
522
+ * 商户方 appeIDcode 的数字证书。
485
523
  */
486
- EidCode: string
524
+ EidCode?: string
487
525
  /**
488
- * Eid中心针对商户方EidCode的电子签名
526
+ * Eid中心针对商户方EidCode的电子签名。
489
527
  */
490
- EidSign: string
528
+ EidSign?: string
491
529
  /**
492
- * 商户方公钥加密的会话密钥的base64字符串,[指引详见](https://cloud.tencent.com/document/product/1007/63370)
530
+ * 商户方公钥加密的会话密钥的base64字符串,[指引详见](https://cloud.tencent.com/document/product/1007/63370)
493
531
  */
494
- DesKey: string
532
+ DesKey?: string
495
533
  /**
496
- * 会话密钥sm2加密后的base64字符串,[指引详见](https://cloud.tencent.com/document/product/1007/63370)
534
+ * 会话密钥sm2加密后的base64字符串,[指引详见](https://cloud.tencent.com/document/product/1007/63370)
497
535
  */
498
- UserInfo: string
536
+ UserInfo?: string
499
537
  }
500
538
 
501
539
  /**
@@ -503,7 +541,10 @@ export interface EidInfo {
503
541
  */
504
542
  export interface DetectAuthRequest {
505
543
  /**
506
- * 用于细分客户使用场景,申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。如有疑问,请添加[腾讯云人脸核身小助手](https://cloud.tencent.com/document/product/1007/56130)进行咨询。
544
+ * 业务流程ID。
545
+ - 用于细分客户使用场景, 可为业务配置不同的业务流程。
546
+ - 申请开通服务后,登录腾讯云[慧眼人脸核身控制](https://console.cloud.tencent.com/faceid)进行创建,审核通过后即可调用。
547
+ - 如有疑问,请添加[腾讯云人脸核身小助手](https://cloud.tencent.com/document/product/1007/56130)进行咨询。
507
548
  */
508
549
  RuleId: string
509
550
  /**
@@ -511,17 +552,20 @@ export interface DetectAuthRequest {
511
552
  */
512
553
  TerminalType?: string
513
554
  /**
514
- * 身份标识(是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示)。
515
- 规则:a-z,A-Z,0-9组合。最长长度32位。
555
+ * 验证人的身份证号码。
556
+ - 是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示。
557
+
516
558
  */
517
559
  IdCard?: string
518
560
  /**
519
- * 姓名。(是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示)。
520
- 最长长度32位。中文请使用UTF-8编码。
561
+ * 验证人的姓名。
562
+ - 是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示。
563
+ - 最长长度32位。中文请使用UTF-8编码。
521
564
  */
522
565
  Name?: string
523
566
  /**
524
- * 认证结束后重定向的回调链接地址。最长长度1024位。
567
+ * 认证结束后重定向的回调链接地址。
568
+ - 最长长度1024位。
525
569
  */
526
570
  RedirectUrl?: string
527
571
  /**
@@ -529,8 +573,10 @@ export interface DetectAuthRequest {
529
573
  */
530
574
  Extra?: string
531
575
  /**
532
- * 用于人脸比对的照片,图片的Base64值;
533
- Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648
576
+ * 用于人脸比对的图像数据,使用base64编码。
577
+ - Base64编码后的图片数据大小不超过3M。
578
+ - 仅支持jpg、png格式。
579
+ - 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
534
580
  */
535
581
  ImageBase64?: string
536
582
  /**
@@ -538,21 +584,27 @@ Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。请
538
584
  */
539
585
  Encryption?: Encryption
540
586
  /**
541
- * 意愿核身(朗读模式)使用的文案,若未使用意愿核身(朗读模式),则该字段无需传入。默认为空,最长可接受120的字符串长度。
587
+ * 意愿核身(朗读模式)使用的文案。
588
+ - 若未使用意愿核身(朗读模式),则该字段无需传入。
589
+ - 最长可接受120的字符串长度。
542
590
  */
543
591
  IntentionVerifyText?: string
544
592
  /**
545
- * 意愿核身语音问答模式(即语音播报+语音回答)使用的文案,包括:系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。
593
+ * 意愿核身(语音播报+语音回答模式)使用的文案。
594
+ - 包括:系统语音播报的文本、需要核验的标准文本。
595
+ - 当前仅支持1轮问答。
546
596
  */
547
597
  IntentionQuestions?: Array<IntentionQuestion>
548
598
  /**
549
- * RuleId相关配置
599
+ * 意愿核身(点头确认模式)使用的文案。
600
+ - 若未使用意愿核身(点头确认模式),则该字段无需传入。
601
+ - 当前仅支持一个提示文本。
550
602
  */
551
- Config?: RuleIdConfig
603
+ IntentionActions?: Array<IntentionActionConfig>
552
604
  /**
553
- * 意愿核身(点头确认模式)使用的文案,若未使用意愿核身(点头确认模式),则该字段无需传入。当前仅支持一个提示文本。
605
+ * 意愿核身流程配置。
554
606
  */
555
- IntentionActions?: Array<IntentionActionConfig>
607
+ Config?: RuleIdConfig
556
608
  }
557
609
 
558
610
  /**
@@ -570,32 +622,60 @@ export interface CheckEidTokenStatusRequest {
570
622
  */
571
623
  export interface GetFaceIdRiskInfoResponse {
572
624
  /**
573
- * 描述当前请求所在设备的风险标签,详情如下: 01-设备疑似被Root/设备疑似越狱 02-设备疑似被注入 03-设备疑似为模拟器 04-设备疑似存在风险操作 05-摄像头疑似被劫持 06-疑似黑产设备
625
+ * 描述当前请求所在设备的风险标签
626
+ - 详情如下:
627
+ 01-设备疑似被Root/设备疑似越狱。
628
+ 02-设备疑似被注入。
629
+ 03-设备疑似为模拟器。
630
+ 04-设备疑似存在风险操作。
631
+ 05-摄像头疑似被劫持。
632
+ 06-疑似黑产设备。
574
633
  注意:此字段可能返回 null,表示取不到有效值。
575
634
  */
576
635
  DeviceInfoTag?: string
577
636
  /**
578
- * 描述当前请求所在设备的风险等级,共4级,详情如下: 1 - 低风险 2 - 中风险 3 - 高风险 4 - 攻击 ,-1表示未获取到风险等级
637
+ * 描述当前请求所在设备的风险等级,共4级。
638
+ - 详情如下:
639
+ 1 - 低风险。
640
+ 2 - 中风险。
641
+ 3 - 高风险。
642
+ 4 - 攻击。
643
+ -1表示未获取到风险等级。
579
644
  注意:此字段可能返回 null,表示取不到有效值。
580
645
  */
581
646
  DeviceInfoLevel?: number
582
647
  /**
583
- * 设备id标识
648
+ * 设备id标识。
584
649
  注意:此字段可能返回 null,表示取不到有效值。
585
650
  */
586
651
  OpenId?: string
587
652
  /**
588
- * 描述当前请求所在设备的相机指纹风险等级,共4级,详情如下: 1 - 低风险 2 - 中风险 3 - 高风险 4 - 攻击 ,-1表示未获取到风险等级
653
+ * 描述当前请求所在设备的相机指纹风险等级,共4级。
654
+ - 详情如下:
655
+ 1 - 低风险。
656
+ 2 - 中风险。
657
+ 3 - 高风险。
658
+ 4 - 攻击。
659
+ -1表示未获取到风险等级。
589
660
  注意:此字段可能返回 null,表示取不到有效值。
590
661
  */
591
662
  CameraInfoLevel?: number
592
663
  /**
593
- * 描述当前请求所在设备的相机指纹风险标签,详情如下: 01-设备疑似被Root/设备疑似越狱 02-设备疑似被注入 03-设备疑似为模拟器 04-设备疑似存在风险操作 05-摄像头疑似被劫持 06-疑似黑产设备,空表示没有相机指纹风险
664
+ * 描述当前请求所在设备的相机指纹风险标签。
665
+
666
+ - 详情如下:
667
+ 01-设备疑似被Root/设备疑似越狱。
668
+ 02-设备疑似被注入。
669
+ 03-设备疑似为模拟器。
670
+ 04-设备疑似存在风险操作。
671
+ 05-摄像头疑似被劫持。
672
+ 06-疑似黑产设备。
673
+ 空表示没有相机指纹风险。
594
674
  注意:此字段可能返回 null,表示取不到有效值。
595
675
  */
596
676
  CameraInfoTag?: string
597
677
  /**
598
- * 获取token时透传的信息
678
+ * 获取token时透传的信息。
599
679
  注意:此字段可能返回 null,表示取不到有效值。
600
680
  */
601
681
  Extra?: string
@@ -808,14 +888,14 @@ export interface EncryptedPhoneVerificationResponse {
808
888
  }
809
889
 
810
890
  /**
811
- * 核身视频信息
891
+ * 核身视频信息。
812
892
  */
813
893
  export interface DetectInfoVideoData {
814
894
  /**
815
- * 活体视频的base64编码
895
+ * 活体视频的base64编码。
816
896
  注意:此字段可能返回 null,表示取不到有效值。
817
897
  */
818
- LivenessVideo: string
898
+ LivenessVideo?: string
819
899
  }
820
900
 
821
901
  /**
@@ -931,20 +1011,27 @@ export interface CheckBankCardInformationResponse {
931
1011
  */
932
1012
  export interface GetEidTokenRequest {
933
1013
  /**
934
- * EID商户id,字段长度最长50位。
1014
+ * EID商户id
1015
+ - 字段长度最长50位。
935
1016
  */
936
1017
  MerchantId: string
937
1018
  /**
938
- * 身份标识(未使用OCR服务时,必须传入)。
939
- 规则:a-z,A-Z,0-9组合。最长长度32位。
1019
+ * 身份标识。
1020
+ - 未使用OCR服务时,必须传入。
1021
+ - 规则:a-z,A-Z,0-9组合。
1022
+ - 最长长度32位。
940
1023
  */
941
1024
  IdCard?: string
942
1025
  /**
943
- * 姓名。(未使用OCR服务时,必须传入)最长长度32位。中文请使用UTF-8编码。
1026
+ * 姓名。
1027
+ - 未使用OCR服务时,必须传入。
1028
+ - 最长长度32位。
1029
+ - 中文请使用UTF-8编码。
944
1030
  */
945
1031
  Name?: string
946
1032
  /**
947
- * 透传字段,在获取验证结果时返回。最长长度1024位。
1033
+ * 透传字段,在获取验证结果时返回。
1034
+ - 最长长度1024位。
948
1035
  */
949
1036
  Extra?: string
950
1037
  /**
@@ -952,11 +1039,14 @@ export interface GetEidTokenRequest {
952
1039
  */
953
1040
  Config?: GetEidTokenConfig
954
1041
  /**
955
- * 最长长度1024位。用户从Url中进入核身认证结束后重定向的回调链接地址。EidToken会在该链接的query参数中。
1042
+ * 用户从Url中进入核身认证结束后重定向的回调链接地址。
1043
+ - 最长长度1024位。
1044
+ - EidToken会在该链接的query参数中。
956
1045
  */
957
1046
  RedirectUrl?: string
958
1047
  /**
959
- * 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1048
+ * 敏感数据加密信息。
1049
+ - 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
960
1050
  */
961
1051
  Encryption?: Encryption
962
1052
  }
@@ -995,7 +1085,7 @@ export interface CheckIdNameDateRequest {
995
1085
  */
996
1086
  export interface GetFaceIdTokenResponse {
997
1087
  /**
998
- * 有效期 10分钟。只能完成1次核身。
1088
+ * token值。- 有效期 10分钟。- 只能完成1次核身。
999
1089
  */
1000
1090
  FaceIdToken?: string
1001
1091
  /**
@@ -1055,72 +1145,97 @@ export interface MinorsVerificationRequest {
1055
1145
  */
1056
1146
  export interface GetFaceIdResultResponse {
1057
1147
  /**
1058
- * 身份证
1148
+ * 身份证。
1059
1149
  */
1060
1150
  IdCard?: string
1061
1151
  /**
1062
- * 姓名
1152
+ * 姓名。
1063
1153
  */
1064
1154
  Name?: string
1065
1155
  /**
1066
- * 业务核验结果,参考https://cloud.tencent.com/document/product/1007/47912
1156
+ * 业务核验结果。
1157
+ - 参考:https://cloud.tencent.com/document/product/1007/47912。
1067
1158
  */
1068
1159
  Result?: string
1069
1160
  /**
1070
- * 业务核验描述
1161
+ * 业务核验描述。
1071
1162
  */
1072
1163
  Description?: string
1073
1164
  /**
1074
- * 相似度,0-100,数值越大相似度越高
1165
+ * 相似度。
1166
+ - 取值:0-100。
1167
+ - 数值越大相似度越高。
1075
1168
  */
1076
1169
  Similarity?: number
1077
1170
  /**
1078
- * 用户核验的视频base64,如果选择了使用cos,返回完整cos地址如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey
1171
+ * 用户核验的视频base64
1172
+ - 如果选择了使用cos,返回完整cos地址,如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey。
1079
1173
  注意:此字段可能返回 null,表示取不到有效值。
1080
1174
  */
1081
1175
  VideoBase64?: string
1082
1176
  /**
1083
- * 用户核验视频的截帧base64,如果选择了使用cos,返回完整cos地址如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey
1177
+ * 用户核验视频的截帧base64
1178
+ - 如果选择了使用cos,返回完整cos地址如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey。
1084
1179
  注意:此字段可能返回 null,表示取不到有效值。
1085
1180
  */
1086
1181
  BestFrameBase64?: string
1087
1182
  /**
1088
- * 获取token时透传的信息
1183
+ * 获取token时透传的信息。
1089
1184
  注意:此字段可能返回 null,表示取不到有效值。
1090
1185
  */
1091
1186
  Extra?: string
1092
1187
  /**
1093
- * plus版:描述当前请求所在设备的风险标签,详情如下:
1094
- 01-设备疑似被Root/设备疑似越狱
1095
- 02-设备疑似被注入
1096
- 03-设备疑似为模拟器
1097
- 04-设备疑似存在风险操作
1098
- 05-摄像头疑似被劫持
1099
- 06-疑似黑产设备
1100
- null-无设备风险
1101
- 增强版:此字段不生效,默认为null
1188
+ * plus版:描述当前请求所在设备的风险标签。
1189
+ - 详情如下:
1190
+ 01-设备疑似被Root/设备疑似越狱。
1191
+ 02-设备疑似被注入。
1192
+ 03-设备疑似为模拟器。
1193
+ 04-设备疑似存在风险操作。
1194
+ 05-摄像头疑似被劫持。
1195
+ 06-疑似黑产设备。
1196
+ null-无设备风险。
1197
+ - 增强版:此字段不生效,默认为null。
1102
1198
  注意:此字段可能返回 null,表示取不到有效值。
1103
1199
  */
1104
1200
  DeviceInfoTag?: string
1105
1201
  /**
1106
- * 行为风险标签,仅错误码返回1007(设备疑似被劫持)时返回风险标签。标签说明:
1202
+ * 行为风险标签。
1203
+ - 仅错误码返回1007(设备疑似被劫持)时返回风险标签。
1204
+ - 标签说明:
1107
1205
  02:攻击风险
1108
1206
  注意:此字段可能返回 null,表示取不到有效值。
1109
1207
  */
1110
1208
  RiskInfoTag?: string
1111
1209
  /**
1112
- * plus版:描述当前请求活体阶段被拒绝的详细原因,详情如下:01-用户全程闭眼02-用户未完成指定动作03-疑似翻拍攻击04-疑似合成图片05-疑似合成视频06-疑似合成动作07-疑似黑产模板08-疑似存在水印09-反光校验未通过10-最佳帧校验未通过11-人脸质量过差12-人脸距离不匹配13-疑似对抗样本攻击null-无增强版:此字段不生效,默认为null
1210
+ * plus版:描述当前请求活体阶段被拒绝的详细原因。
1211
+ - 详情如下:
1212
+ 01-用户全程闭眼。
1213
+ 02-用户未完成指定动作。
1214
+ 03-疑似翻拍攻击。
1215
+ 04-疑似合成图片。
1216
+ 05-疑似合成视频。
1217
+ 06-疑似合成动作。
1218
+ 07-疑似黑产模板。
1219
+ 08-疑似存在水印。
1220
+ 09-反光校验未通过。
1221
+ 10-最佳帧校验未通过。
1222
+ 11-人脸质量过差。
1223
+ 12-人脸距离不匹配。
1224
+ 13-疑似对抗样本攻击。
1225
+ null-无。
1226
+ - 增强版:此字段不生效,默认为null。
1113
1227
  注意:此字段可能返回 null,表示取不到有效值。
1114
1228
  */
1115
1229
  LivenessInfoTag?: string
1116
1230
  /**
1117
- * plus版:描述当前请求所在设备的风险等级,共4级,详情如下:
1118
- 1 - 安全
1119
- 2 - 低风险
1120
- 3 - 中风险
1121
- 4 - 高危
1122
- null - 未获取到风险等级
1123
- 增强版:此字段不生效,默认为null
1231
+ * plus版:描述当前请求所在设备的风险等级,共4级。
1232
+ - 详情如下:
1233
+ 1 - 安全。
1234
+ 2 - 低风险。
1235
+ 3 - 中风险。
1236
+ 4 - 高危。
1237
+ null - 未获取到风险等级。
1238
+ - 增强版:此字段不生效,默认为null。
1124
1239
  注意:此字段可能返回 null,表示取不到有效值。
1125
1240
  */
1126
1241
  DeviceInfoLevel?: string
@@ -1158,21 +1273,24 @@ export interface DetectAIFakeFacesResponse {
1158
1273
  }
1159
1274
 
1160
1275
  /**
1161
- * 意愿核身相关结果
1276
+ * 意愿核身相关结果。
1162
1277
  */
1163
1278
  export interface IntentionVerifyData {
1164
1279
  /**
1165
- * 意愿确认环节中录制的视频(base64)。若不存在则为空字符串。
1280
+ * 意愿确认环节中录制的视频(base64)。
1281
+ - 若不存在则为空字符串。
1166
1282
  注意:此字段可能返回 null,表示取不到有效值。
1167
1283
  */
1168
1284
  IntentionVerifyVideo?: string
1169
1285
  /**
1170
- * 意愿确认环节中用户语音转文字的识别结果。若不存在则为空字符串。
1286
+ * 意愿确认环节中用户语音转文字的识别结果。
1287
+ - 若不存在则为空字符串。
1171
1288
  注意:此字段可能返回 null,表示取不到有效值。
1172
1289
  */
1173
1290
  AsrResult?: string
1174
1291
  /**
1175
- * 意愿确认环节的结果码。当该结果码为0时,语音朗读的视频与语音识别结果才会返回。
1292
+ * 意愿确认环节的结果码。
1293
+ - 当该结果码为0时,语音朗读的视频与语音识别结果才会返回。
1176
1294
  注意:此字段可能返回 null,表示取不到有效值。
1177
1295
  */
1178
1296
  ErrorCode?: number
@@ -1182,7 +1300,8 @@ export interface IntentionVerifyData {
1182
1300
  */
1183
1301
  ErrorMessage?: string
1184
1302
  /**
1185
- * 意愿确认环节中录制视频的最佳帧(base64)。若不存在则为空字符串。
1303
+ * 意愿确认环节中录制视频的最佳帧(base64)。
1304
+ - 若不存在则为空字符串。
1186
1305
  注意:此字段可能返回 null,表示取不到有效值。
1187
1306
  */
1188
1307
  IntentionVerifyBestFrame?: string
@@ -1414,19 +1533,19 @@ export interface BankCardVerificationRequest {
1414
1533
  }
1415
1534
 
1416
1535
  /**
1417
- * 核身最佳帧信息
1536
+ * 核身最佳帧信息。
1418
1537
  */
1419
1538
  export interface DetectInfoBestFrame {
1420
1539
  /**
1421
1540
  * 活体比对最佳帧Base64编码。
1422
1541
  注意:此字段可能返回 null,表示取不到有效值。
1423
1542
  */
1424
- BestFrame: string
1543
+ BestFrame?: string
1425
1544
  /**
1426
1545
  * 自截帧Base64编码数组。
1427
1546
  注意:此字段可能返回 null,表示取不到有效值。
1428
1547
  */
1429
- BestFrames: Array<string>
1548
+ BestFrames?: Array<string>
1430
1549
  }
1431
1550
 
1432
1551
  /**
@@ -1544,21 +1663,34 @@ export interface GetEidResultRequest {
1544
1663
  */
1545
1664
  EidToken: string
1546
1665
  /**
1547
- * 指定拉取的结果信息,取值(0:全部;1:文本类;2:身份证信息;3:最佳截图信息;5:意愿核身朗读模式相关结果;6:意愿核身问答模式相关结果)。
1548
- 13表示拉取文本类、最佳截图信息。
1549
- 默认值:0
1666
+ * 指定拉取的结果信息。
1667
+ - 取值范围:
1668
+ 0:全部。
1669
+ 1:文本类。
1670
+ 2:身份证信息。
1671
+ 3:最佳截图信息。
1672
+ 5:意愿核身朗读模式相关结果。
1673
+ 6:意愿核身问答模式相关结果。
1674
+ - 例如 13表示拉取文本类、最佳截图信息。
1675
+ - 默认值:0
1550
1676
  */
1551
1677
  InfoType?: string
1552
1678
  /**
1553
- * 从活体视频中截取一定张数的最佳帧。默认为0,最大为3,超出3的最多只给3张。(InfoType需要包含3)
1679
+ * 从活体视频中截取一定张数的最佳帧。
1680
+ - 默认为0,最大为3,超出3的最多只给3张。
1681
+ - InfoType需要包含3。
1554
1682
  */
1555
1683
  BestFramesCount?: number
1556
1684
  /**
1557
- * 是否对身份证照片进行裁边。默认为false。(InfoType需要包含2)
1685
+ * 是否对身份证照片进行裁边。
1686
+ - 默认为false。
1687
+ - InfoType需要包含2。
1558
1688
  */
1559
1689
  IsCutIdCardImage?: boolean
1560
1690
  /**
1561
- * 是否需要从身份证中抠出头像。默认为false。(InfoType需要包含2)
1691
+ * 是否需要从身份证中抠出头像。
1692
+ - 默认为false。
1693
+ - InfoType需要包含2。
1562
1694
  */
1563
1695
  IsNeedIdCardAvatar?: boolean
1564
1696
  }
@@ -1572,8 +1704,9 @@ export interface DetectAuthResponse {
1572
1704
  */
1573
1705
  Url?: string
1574
1706
  /**
1575
- * 一次核身流程的标识,有效时间为7,200秒;
1576
- 完成核身后,可用该标识获取验证结果信息。
1707
+ * 一次核验流程的唯一标识。
1708
+ - 有效时间为7,200秒,超过有效期再进行人脸核验会报错,请在有效期内进行核验。
1709
+ - 完成人脸核验后,需根据此标识调用[获取实名核身结果信息增强版](https://cloud.tencent.com/document/api/1007/41957)获取用户最终验证结果信息。
1577
1710
  */
1578
1711
  BizToken?: string
1579
1712
  /**
@@ -1908,48 +2041,73 @@ Config = {"CopyWarn":true,"ReshootWarn":true}。
1908
2041
  export interface GetEidTokenConfig {
1909
2042
  /**
1910
2043
  * 姓名身份证输入方式。
1911
- 1:传身份证正反面OCR
1912
- 2:传身份证正面OCR
1913
- 3:用户手动输入
1914
- 4:客户后台传入
1915
- 默认1
1916
- 注:使用OCR时仅支持用户修改结果中的姓名
2044
+ - 取值范围:
2045
+ 1:传身份证正反面OCR
2046
+ 2:传身份证正面OCR。
2047
+ 3:用户手动输入。
2048
+ 4:客户后台传入。
2049
+ - 默认值:1。
2050
+ - 注意:使用OCR时仅支持用户修改结果中的姓名。
1917
2051
  */
1918
2052
  InputType?: string
1919
2053
  /**
1920
- * 是否使用意愿核身,默认不使用。注意:如开启使用,则计费标签按【意愿核身】计费标签计价;如不开启,则计费标签按【E证通】计费标签计价,价格详见:[价格说明](https://cloud.tencent.com/document/product/1007/56804)。
2054
+ * 是否使用意愿核身。
2055
+
2056
+ - 默认不使用。
2057
+ - 注意:如开启使用,则计费标签按【意愿核身】计费标签计价;如不开启,则计费标签按【E证通】计费标签计价,价格详见:[价格说明](https://cloud.tencent.com/document/product/1007/56804)。
1921
2058
  */
1922
2059
  UseIntentionVerify?: boolean
1923
2060
  /**
1924
- * 意愿核身模式。枚举值:1( 语音朗读模式),2(语音问答模式) ,3(点头确认模式)。默认值为1。
2061
+ * 意愿核身模式。
2062
+ - 取值范围:
2063
+ 1:语音朗读模式。
2064
+ 2:语音问答模式。
2065
+ 3:点头确认模式。
2066
+ - 默认值为1。
1925
2067
  */
1926
2068
  IntentionMode?: string
1927
2069
  /**
1928
- * 意愿核身朗读模式使用的文案,若未使用意愿核身朗读功能,该字段无需传入。默认为空,最长可接受120的字符串长度。
2070
+ * 意愿核身朗读模式使用的文案。
2071
+ - 若未使用意愿核身朗读功能,该字段无需传入。
2072
+ - 默认为空,最长可接受120的字符串长度。
1929
2073
  */
1930
2074
  IntentionVerifyText?: string
1931
2075
  /**
1932
- * 意愿核身问答模式的配置列表。当前仅支持一个问答。
2076
+ * 意愿核身问答模式的配置列表。
2077
+ - 当前仅支持一个问答。
1933
2078
  */
1934
2079
  IntentionQuestions?: Array<IntentionQuestion>
1935
2080
  /**
1936
- * 意愿核身(点头确认模式)使用的文案,若未使用意愿核身(点头确认模式),则该字段无需传入。默认为空,最长可接受150的字符串长度。
2081
+ * 意愿核身(点头确认模式)使用的文案。
2082
+ - 若未使用意愿核身(点头确认模式),则该字段无需传入。
2083
+ - 默认为空,最长可接受150的字符串长度。
1937
2084
  */
1938
2085
  IntentionActions?: Array<IntentionActionConfig>
1939
2086
  /**
1940
- * 意愿核身过程中识别用户的回答意图,开启后除了IntentionQuestions的Answers列表中的标准回答会通过,近似意图的回答也会通过,默认开启。
2087
+ * 意愿核身过程中识别用户的回答意图。
2088
+ - 开启后除了IntentionQuestions的Answers列表中的标准回答会通过,近似意图的回答也会通过。
2089
+ - 默认开启。
1941
2090
  */
1942
2091
  IntentionRecognition?: boolean
1943
2092
  /**
1944
- * 是否支持港澳台居住证识别
2093
+ * 是否支持港澳台居住证识别。
1945
2094
  */
1946
2095
  IsSupportHMTResidentPermitOCR?: boolean
1947
2096
  /**
1948
- * 用户语音回答过程中是否开启张嘴识别检测,默认不开启,仅在意愿核身问答模式中使用。
2097
+ * 用户语音回答过程中是否开启张嘴识别检测。
2098
+ - 默认不开启。
2099
+ - 仅在意愿核身问答模式中使用。
1949
2100
  */
1950
2101
  MouthOpenRecognition?: boolean
1951
2102
  /**
1952
- * 意愿核身语音播报速度,配置后问答模式和点头模式的语音播报环节都会生效,默认值为0: 0:智能语速(根据播报文案的长度自动调整语音播报速度) 1:固定1倍速 2:固定1.2倍速 3:固定1.5倍速
2103
+ * 意愿核身语音播报速度。
2104
+ - 配置后问答模式和点头模式的语音播报环节都会生效。
2105
+ - 默认值为0。
2106
+ - 取值范围:
2107
+ 0:智能语速(根据播报文案的长度自动调整语音播报速度)。
2108
+ 1:固定1倍速。
2109
+ 2:固定1.2倍速。
2110
+ 3:固定1.5倍速。
1953
2111
  */
1954
2112
  Speed?: number
1955
2113
  }
@@ -2098,16 +2256,19 @@ export interface PhoneVerificationCMCCRequest {
2098
2256
  }
2099
2257
 
2100
2258
  /**
2101
- * 核身文本信息
2259
+ * 核身文本信息。
2102
2260
  */
2103
2261
  export interface DetectInfoText {
2104
2262
  /**
2105
- * 本次流程最终验证结果。0为成功(仅包含活体人脸核身结果,不包含意愿核身结果)
2263
+ * 本次流程最终验证结果。
2264
+ - 取值范围:0为成功。
2265
+ - 仅包含活体人脸核身结果,不包含意愿核身结果。
2106
2266
  注意:此字段可能返回 null,表示取不到有效值。
2107
2267
  */
2108
2268
  ErrCode?: number
2109
2269
  /**
2110
- * 本次流程最终验证结果描述。(仅描述用,文案更新时不会通知。)
2270
+ * 本次流程最终验证结果描述。
2271
+ - 仅描述用,文案更新时不会通知。
2111
2272
  注意:此字段可能返回 null,表示取不到有效值。
2112
2273
  */
2113
2274
  ErrMsg?: string
@@ -2117,10 +2278,11 @@ export interface DetectInfoText {
2117
2278
  */
2118
2279
  IdCard?: string
2119
2280
  /**
2120
- * 用户认证时使用的证件号码类型:
2121
- 0:二代身份证的证件号码
2122
- 1:港澳台居住证的证件号码
2123
- 2:其他(核验使用的证件号码非合法身份号码)
2281
+ * 用户认证时使用的证件号码类型。
2282
+ - 取值范围:
2283
+ 0:二代身份证的证件号码。
2284
+ 1:港澳台居住证的证件号码。
2285
+ 2:其他(核验使用的证件号码非合法身份号码)。
2124
2286
  注意:此字段可能返回 null,表示取不到有效值。
2125
2287
  */
2126
2288
  UseIDType?: number
@@ -2140,7 +2302,8 @@ export interface DetectInfoText {
2140
2302
  */
2141
2303
  OcrAddress?: string
2142
2304
  /**
2143
- * 身份校验环节识别结果:生日。格式为:YYYY/M/D
2305
+ * 身份校验环节识别结果:生日。
2306
+ - 格式为:YYYY/M/D
2144
2307
  注意:此字段可能返回 null,表示取不到有效值。
2145
2308
  */
2146
2309
  OcrBirth?: string
@@ -2150,7 +2313,8 @@ export interface DetectInfoText {
2150
2313
  */
2151
2314
  OcrAuthority?: string
2152
2315
  /**
2153
- * 身份校验环节识别结果:有效日期。格式为:YYYY.MM.DD-YYYY.MM.DD
2316
+ * 身份校验环节识别结果:有效日期。
2317
+ - 格式为:YYYY.MM.DD-YYYY.MM.DD。
2154
2318
  注意:此字段可能返回 null,表示取不到有效值。
2155
2319
  */
2156
2320
  OcrValidDate?: string
@@ -2171,32 +2335,39 @@ export interface DetectInfoText {
2171
2335
  OcrGender?: string
2172
2336
  /**
2173
2337
  * 身份校验环节采用的信息上传方式。
2174
- 取值有"NFC"、"OCR"、"手动输入"、"其他"
2338
+ - 取值有"NFC"、"OCR"、"手动输入"、"其他"
2175
2339
  注意:此字段可能返回 null,表示取不到有效值。
2176
2340
  */
2177
2341
  IdInfoFrom?: string
2178
2342
  /**
2179
- * 本次流程最终活体结果。0为成功
2343
+ * 本次流程最终活体结果。
2344
+ - 0为成功
2180
2345
  注意:此字段可能返回 null,表示取不到有效值。
2181
2346
  */
2182
2347
  LiveStatus?: number
2183
2348
  /**
2184
- * 本次流程最终活体结果描述。(仅描述用,文案更新时不会通知。)
2349
+ * 本次流程最终活体结果描述。
2350
+ - 仅描述用,文案更新时不会通知。
2185
2351
  注意:此字段可能返回 null,表示取不到有效值。
2186
2352
  */
2187
2353
  LiveMsg?: string
2188
2354
  /**
2189
- * 本次流程最终一比一结果。0为成功
2355
+ * 本次流程最终一比一结果。
2356
+ - 0为成功
2190
2357
  注意:此字段可能返回 null,表示取不到有效值。
2191
2358
  */
2192
2359
  Comparestatus?: number
2193
2360
  /**
2194
- * 本次流程最终一比一结果描述。(仅描述用,文案更新时不会通知。)
2361
+ * 本次流程最终一比一结果描述。
2362
+ - 仅描述用,文案更新时不会通知。
2195
2363
  注意:此字段可能返回 null,表示取不到有效值。
2196
2364
  */
2197
2365
  Comparemsg?: string
2198
2366
  /**
2199
- * 本次流程活体一比一的分数,取值范围 [0.00, 100.00]。相似度大于等于70时才判断为同一人,也可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
2367
+ * 本次流程活体一比一的分数。
2368
+ - 取值范围 [0.00, 100.00]。
2369
+ - 相似度大于等于70时才判断为同一人,也可根据具体场景自行调整阈值。
2370
+ - 阈值70的误通过率为千分之一,阈值80的误通过率是万分之一。
2200
2371
  注意:此字段可能返回 null,表示取不到有效值。
2201
2372
  */
2202
2373
  Sim?: string
@@ -2216,21 +2387,22 @@ export interface DetectInfoText {
2216
2387
  */
2217
2388
  LivenessDetail?: Array<DetectDetail>
2218
2389
  /**
2219
- * 描述当前请求活体阶段被拒绝的详细原因,详情如下:
2220
- 01-用户全程闭眼
2221
- 02-用户未完成指定动作
2222
- 03-疑似翻拍攻击
2223
- 04-疑似合成攻击
2224
- 05-疑似黑产模版
2225
- 06-疑似存在水印
2226
- 07-反光校验未通过
2227
- 08-疑似中途换人
2228
- 09-人脸质量过差
2229
- 10-距离校验不通过
2230
- 11-疑似对抗样本攻击
2231
- 12-嘴巴区域疑似存在攻击痕迹
2232
- 13-眼睛区域疑似存在攻击痕迹
2233
- 14-眼睛或嘴巴被遮挡
2390
+ * 描述当前请求活体阶段被拒绝的详细原因,该参数仅限PLUS版本核身服务返回。
2391
+ - 详情如下:
2392
+ 01-用户全程闭眼
2393
+ 02-用户未完成指定动作
2394
+ 03-疑似翻拍攻击
2395
+ 04-疑似合成攻击
2396
+ 05-疑似黑产模版
2397
+ 06-疑似存在水印
2398
+ 07-反光校验未通过
2399
+ 08-疑似中途换人
2400
+ 09-人脸质量过差
2401
+ 10-距离校验不通过
2402
+ 11-疑似对抗样本攻击
2403
+ 12-嘴巴区域疑似存在攻击痕迹
2404
+ 13-眼睛区域疑似存在攻击痕迹
2405
+ 14-眼睛或嘴巴被遮挡
2234
2406
  注意:此字段可能返回 null,表示取不到有效值。
2235
2407
  */
2236
2408
  LivenessInfoTag?: Array<string>
@@ -2240,41 +2412,43 @@ export interface DetectInfoText {
2240
2412
  */
2241
2413
  Mobile?: string
2242
2414
  /**
2243
- * 本次流程最终比对库源类型。包括:
2244
- 权威库;
2245
- 业务方自有库(用户上传照片、客户的混合库、混合部署库);
2246
- 二次验证库;
2247
- 人工审核库;
2415
+ * 本次流程最终比对库源类型。
2416
+ - 取值范围:
2417
+ 权威库。
2418
+ 业务方自有库(用户上传照片、客户的混合库、混合部署库)。
2419
+ 二次验证库。
2420
+ 人工审核库。
2248
2421
  注意:此字段可能返回 null,表示取不到有效值。
2249
2422
  */
2250
2423
  CompareLibType?: string
2251
2424
  /**
2252
- * 本次流程最终活体类型。包括:
2253
- 0:未知
2254
- 1:数字活体
2255
- 2:动作活体
2256
- 3:静默活体
2257
- 4:一闪活体(动作+光线)
2425
+ * 本次流程最终活体类型。
2426
+ - 取值范围:
2427
+ 0:未知
2428
+ 1:数字活体
2429
+ 2:动作活体
2430
+ 3:静默活体
2431
+ 4:一闪活体(动作+光线)
2258
2432
  注意:此字段可能返回 null,表示取不到有效值。
2259
2433
  */
2260
2434
  LivenessMode?: number
2261
2435
  /**
2262
- * nfc重复计费requestId列表
2436
+ * nfc重复计费requestId列表。
2263
2437
  注意:此字段可能返回 null,表示取不到有效值。
2264
2438
  */
2265
2439
  NFCRequestIds?: Array<string>
2266
2440
  /**
2267
- * nfc重复计费计数
2441
+ * nfc重复计费计数。
2268
2442
  注意:此字段可能返回 null,表示取不到有效值。
2269
2443
  */
2270
2444
  NFCBillingCounts?: number
2271
2445
  /**
2272
- * 港澳台居住证通行证号码
2446
+ * 港澳台居住证通行证号码。
2273
2447
  注意:此字段可能返回 null,表示取不到有效值。
2274
2448
  */
2275
2449
  PassNo?: string
2276
2450
  /**
2277
- * 港澳台居住证签发次数
2451
+ * 港澳台居住证签发次数。
2278
2452
  注意:此字段可能返回 null,表示取不到有效值。
2279
2453
  */
2280
2454
  VisaNum?: string
@@ -2471,21 +2645,29 @@ export interface GetDetectInfoEnhancedRequest {
2471
2645
  */
2472
2646
  RuleId: string
2473
2647
  /**
2474
- * 指定拉取的结果信息,取值(0:全部;1:文本类;2:身份证信息;3:视频最佳截图信息)。
2475
- 13表示拉取文本类、视频最佳截图信息。
2476
- 默认值:0
2648
+ * 指定拉取的结果信息。
2649
+ - 取值(0:全部;1:文本类;2:身份证信息;3:视频最佳截图信息)。
2650
+ - 例如 13 表示拉取文本类、视频最佳截图信息。
2651
+ - 默认值:0
2477
2652
  */
2478
2653
  InfoType?: string
2479
2654
  /**
2480
- * 从活体视频中截取一定张数的最佳帧(仅部分服务支持,若需使用请与慧眼小助手沟通)。默认为0,最大为10,超出10的最多只给10张。(InfoType需要包含3)
2655
+ * 从活体视频中截取一定张数的最佳帧。
2656
+ - 仅部分服务支持,若需使用请与慧眼小助手沟通。
2657
+ - 默认值为0,最大值为10,超出10的最多只给10张。
2658
+ - InfoType需要包含3。
2481
2659
  */
2482
2660
  BestFramesCount?: number
2483
2661
  /**
2484
- * 是否对身份证照片进行裁边。默认为false。(InfoType需要包含2)
2662
+ * 是否对身份证照片进行裁边。
2663
+ - 默认为false。
2664
+ - InfoType需要包含2。
2485
2665
  */
2486
2666
  IsCutIdCardImage?: boolean
2487
2667
  /**
2488
- * 是否需要从身份证中抠出头像。默认为false。(InfoType需要包含2)
2668
+ * 是否需要从身份证中抠出头像。
2669
+ - 默认为false。
2670
+ - InfoType需要包含2。
2489
2671
  */
2490
2672
  IsNeedIdCardAvatar?: boolean
2491
2673
  /**
@@ -2493,11 +2675,13 @@ export interface GetDetectInfoEnhancedRequest {
2493
2675
  */
2494
2676
  IsEncrypt?: boolean
2495
2677
  /**
2496
- * 是否需要对返回中的敏感信息进行加密。仅指定加密算法Algorithm即可,其余字段传入默认值。其中敏感信息包括:Response.Text.IdCard、Response.Text.Name、Response.Text.OcrIdCard、Response.Text.OcrName
2678
+ * 是否需要对返回中的敏感信息进行加密。
2679
+ - 只需指定加密算法Algorithm即可,其余字段传入默认值。
2680
+ - 敏感信息包括:Response.Text.IdCard、Response.Text.Name、Response.Text.OcrIdCard、Response.Text.OcrName。
2497
2681
  */
2498
2682
  Encryption?: Encryption
2499
2683
  /**
2500
- * 是否对回包整体进行加密
2684
+ * 是否对回包整体进行加密。
2501
2685
  */
2502
2686
  IsEncryptResponse?: boolean
2503
2687
  }
@@ -2507,16 +2691,21 @@ export interface GetDetectInfoEnhancedRequest {
2507
2691
  */
2508
2692
  export interface LivenessRecognitionResponse {
2509
2693
  /**
2510
- * 验证通过后的视频最佳截图照片,照片为BASE64编码后的值,jpg格式。
2694
+ * 验证通过后的视频最佳截图照片。
2695
+ - 照片为BASE64编码后的值,jpg格式。
2511
2696
  注意:此字段可能返回 null,表示取不到有效值。
2512
2697
  */
2513
2698
  BestFrameBase64?: string
2514
2699
  /**
2515
- * 相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
2700
+ * 相似度。
2701
+ - 取值范围 [0.00, 100.00]。
2702
+ - 推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
2516
2703
  */
2517
2704
  Sim?: number
2518
2705
  /**
2519
- * 业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
2706
+ * 业务错误码。
2707
+ - 成功情况返回Success。
2708
+ - 错误情况请参考下方错误码 列表中FailedOperation部分
2520
2709
  */
2521
2710
  Result?: string
2522
2711
  /**
@@ -2544,7 +2733,9 @@ export type GetLiveCodeRequest = null
2544
2733
  */
2545
2734
  export interface GetEidResultResponse {
2546
2735
  /**
2547
- * 文本类信息。(基于对敏感信息的保护,验证使用的姓名和身份证号统一通过加密后从Eidinfo参数中返回,如需获取请在控制台申请返回身份信息,详见[E证通获取实名信息指引](https://cloud.tencent.com/document/product/1007/63370))
2736
+ * 文本类信息。
2737
+ - 基于对敏感信息的保护,验证使用的姓名和身份证号统一通过加密后从EidInfo参数中返回。
2738
+ - 如需获取请在控制台申请返回身份信息,详见[E证通获取实名信息指引](https://cloud.tencent.com/document/product/1007/63370)。
2548
2739
  注意:此字段可能返回 null,表示取不到有效值。
2549
2740
  */
2550
2741
  Text?: DetectInfoText
@@ -2559,22 +2750,27 @@ export interface GetEidResultResponse {
2559
2750
  */
2560
2751
  BestFrame?: DetectInfoBestFrame
2561
2752
  /**
2562
- * Eid信息。(包括商户下用户唯一标识以及加密后的姓名、身份证号信息。解密方式详见[E证通获取实名信息指引](https://cloud.tencent.com/document/product/1007/63370))
2753
+ * Eid信息。
2754
+ - 包括商户下用户唯一标识以及加密后的姓名、身份证号信息。
2755
+ - 解密方式详见[E证通获取实名信息指引](https://cloud.tencent.com/document/product/1007/63370)
2563
2756
  注意:此字段可能返回 null,表示取不到有效值。
2564
2757
  */
2565
2758
  EidInfo?: EidInfo
2566
2759
  /**
2567
- * 意愿核身朗读模式相关信息。若未使用意愿核身朗读功能,该字段返回值可以不处理。
2760
+ * 意愿核身朗读模式相关信息。
2761
+ - 若未使用意愿核身朗读功能,该字段返回值可以不处理。
2568
2762
  注意:此字段可能返回 null,表示取不到有效值。
2569
2763
  */
2570
2764
  IntentionVerifyData?: IntentionVerifyData
2571
2765
  /**
2572
- * 意愿核身问答模式相关信息。若未使用意愿核身问答模式功能,该字段返回值可以不处理。
2766
+ * 意愿核身问答模式相关信息。
2767
+ - 若未使用意愿核身问答模式功能,该字段返回值可以不处理。
2573
2768
  注意:此字段可能返回 null,表示取不到有效值。
2574
2769
  */
2575
2770
  IntentionQuestionResult?: IntentionQuestionResult
2576
2771
  /**
2577
- * 意愿核身点头确认模式的结果信息,若未使用该意愿核身功能,该字段返回值可以不处理。
2772
+ * 意愿核身点头确认模式的结果信息。
2773
+ - 若未使用该意愿核身功能,该字段返回值可以不处理。
2578
2774
  注意:此字段可能返回 null,表示取不到有效值。
2579
2775
  */
2580
2776
  IntentionActionResult?: IntentionActionResult
@@ -2649,15 +2845,18 @@ export interface PhoneVerificationRequest {
2649
2845
  */
2650
2846
  export interface GetFaceIdResultRequest {
2651
2847
  /**
2652
- * SDK人脸核身流程的标识,调用GetFaceIdToken接口时生成。
2848
+ * SDK人脸核身流程的标识。
2849
+ - 调用GetFaceIdToken接口时生成。
2653
2850
  */
2654
2851
  FaceIdToken: string
2655
2852
  /**
2656
- * 是否需要拉取视频,默认false不需要
2853
+ * 是否需要拉取视频。
2854
+ - 默认false:不需要。
2657
2855
  */
2658
2856
  IsNeedVideo?: boolean
2659
2857
  /**
2660
- * 是否需要拉取截帧,默认false不需要
2858
+ * 是否需要拉取截帧。
2859
+ - 默认false:不需要。
2661
2860
  */
2662
2861
  IsNeedBestFrame?: boolean
2663
2862
  }
@@ -2696,33 +2895,44 @@ export interface CheckPhoneAndNameResponse {
2696
2895
  */
2697
2896
  export interface GetFaceIdTokenRequest {
2698
2897
  /**
2699
- * 本地上传照片(LOCAL)、商业库(BUSINESS)
2898
+ * 比对库。
2899
+ - 取值范围:
2900
+ LOCAL:本地上传照片。
2901
+ BUSINESS:商业库。
2700
2902
  */
2701
2903
  CompareLib: string
2702
2904
  /**
2703
- * CompareLib为商业库时必传。
2905
+ * 身份证。
2906
+ - CompareLib为商业库时必传。
2704
2907
  */
2705
2908
  IdCard?: string
2706
2909
  /**
2707
- * CompareLib为商业库时必传。
2910
+ * 姓名。
2911
+ - CompareLib为商业库时必传。
2708
2912
  */
2709
2913
  Name?: string
2710
2914
  /**
2711
- * CompareLib为上传照片比对时必传,Base64后图片最大8MB
2712
- 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
2915
+ * 图片的Base64。
2916
+ - CompareLib为上传照片比对时必传。
2917
+ - Base64后图片最大8MB。
2918
+ - 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
2713
2919
  */
2714
2920
  ImageBase64?: string
2715
2921
  /**
2716
- * SDK中生成的Meta字符串
2922
+ * SDK中生成的Meta字符串。
2717
2923
  */
2718
2924
  Meta?: string
2719
2925
  /**
2720
- * 透传参数 1000长度字符串
2926
+ * 透传参数。
2927
+ - 1000长度字符串
2721
2928
  */
2722
2929
  Extra?: string
2723
2930
  /**
2724
- * 默认为false,设置该参数为true后,核身过程中的视频图片将会存储在人脸核身控制台授权cos的bucket中,拉取结果时会返回对应资源完整cos地址。开通地址见https://console.cloud.tencent.com/faceid/cos
2725
- 【注意】选择该参数为true后将不返回base64数据,请根据接入情况谨慎修改。
2931
+ * 是否使用cos桶。
2932
+ - 默认为false。
2933
+ - 设置该参数为true后,核身过程中的视频图片将会存储在人脸核身控制台授权cos的bucket中,拉取结果时会返回对应资源完整cos地址。
2934
+ - 开通地址见https://console.cloud.tencent.com/faceid/cos
2935
+ - 【注意】选择该参数为true后将不返回base64数据,请根据接入情况谨慎修改。
2726
2936
  */
2727
2937
  UseCos?: boolean
2728
2938
  /**
@@ -2730,8 +2940,9 @@ export interface GetFaceIdTokenRequest {
2730
2940
  */
2731
2941
  Encryption?: Encryption
2732
2942
  /**
2733
- * 用于细分客户使用场景,申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。如有疑问,请添加腾讯云人脸核身小助手进行咨询。
2734
- 示例值:1
2943
+ * 用于细分客户使用场景。
2944
+ - 申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。
2945
+ - 如有疑问,请添加腾讯云人脸核身小助手进行咨询。
2735
2946
  */
2736
2947
  RuleId?: string
2737
2948
  }
@@ -2782,11 +2993,11 @@ export interface IntentionActionResult {
2782
2993
  */
2783
2994
  export interface GetFaceidRiskInfoTokenRequest {
2784
2995
  /**
2785
- * SDK中生成的Meta字符串
2996
+ * SDK中生成的Meta字符串。
2786
2997
  */
2787
2998
  Meta?: string
2788
2999
  /**
2789
- * 透传参数 1000长度字符串
3000
+ * 透传参数 1000长度字符串。
2790
3001
  */
2791
3002
  Extra?: string
2792
3003
  }
@@ -2815,11 +3026,12 @@ export interface BankCard2EVerificationRequest {
2815
3026
  */
2816
3027
  export interface ImageRecognitionV2Request {
2817
3028
  /**
2818
- * 身份证号
3029
+ * 身份证号。
2819
3030
  */
2820
3031
  IdCard: string
2821
3032
  /**
2822
- * 姓名。中文请使用UTF-8编码。
3033
+ * 姓名。
3034
+ - 中文请使用UTF-8编码。
2823
3035
  */
2824
3036
  Name: string
2825
3037
  /**
@@ -2833,7 +3045,8 @@ Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。
2833
3045
  */
2834
3046
  Optional?: string
2835
3047
  /**
2836
- * 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
3048
+ * 敏感数据加密信息。
3049
+ - 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2837
3050
  */
2838
3051
  Encryption?: Encryption
2839
3052
  }
@@ -2923,7 +3136,7 @@ export interface ChargeDetail {
2923
3136
  */
2924
3137
  export interface ParseNfcDataRequest {
2925
3138
  /**
2926
- * 前端SDK返回
3139
+ * 前端SDK返回。
2927
3140
  */
2928
3141
  ReqId: string
2929
3142
  }
@@ -3073,7 +3286,7 @@ export interface GetDetectInfoRequest {
3073
3286
  }
3074
3287
 
3075
3288
  /**
3076
- * 核身身份证图片信息
3289
+ * 核身身份证图片信息。
3077
3290
  */
3078
3291
  export interface DetectInfoIdCardData {
3079
3292
  /**
@@ -3082,7 +3295,7 @@ export interface DetectInfoIdCardData {
3082
3295
  */
3083
3296
  OcrFront?: string
3084
3297
  /**
3085
- * OCR反面照片的base64编码
3298
+ * OCR反面照片的base64编码。
3086
3299
  注意:此字段可能返回 null,表示取不到有效值。
3087
3300
  */
3088
3301
  OcrBack?: string
@@ -3102,28 +3315,32 @@ export interface DetectInfoIdCardData {
3102
3315
  */
3103
3316
  Avatar?: string
3104
3317
  /**
3105
- * 身份证人像面告警码,开启身份证告警功能后才会返回,返回数组中可能出现的告警码如下:
3106
- -9100 身份证有效日期不合法告警,
3107
- -9101 身份证边框不完整告警,
3108
- -9102 身份证复印件告警,
3109
- -9103 身份证翻拍告警,
3110
- -9105 身份证框内遮挡告警,
3111
- -9104 临时身份证告警,
3112
- -9106 身份证 PS 告警(疑似存在PS痕迹),
3113
- -9107 身份证反光告警。
3318
+ * 身份证人像面告警码。
3319
+ - 开启身份证告警功能后才会返回。
3320
+ - 返回数组中可能出现的告警码如下:
3321
+ - -9100 身份证有效日期不合法告警。
3322
+ - -9101 身份证边框不完整告警。
3323
+ - -9102 身份证复印件告警。
3324
+ - -9103 身份证翻拍告警。
3325
+ - -9105 身份证框内遮挡告警。
3326
+ - -9104 临时身份证告警。
3327
+ - -9106 身份证 PS 告警(疑似存在PS痕迹)。
3328
+ - -9107 身份证反光告警。
3114
3329
  注意:此字段可能返回 null,表示取不到有效值。
3115
3330
  */
3116
3331
  WarnInfos?: Array<number | bigint>
3117
3332
  /**
3118
- * 身份证国徽面告警码,开启身份证告警功能后才会返回,返回数组中可能出现的告警码如下:
3119
- -9100 身份证有效日期不合法告警,
3120
- -9101 身份证边框不完整告警,
3121
- -9102 身份证复印件告警,
3122
- -9103 身份证翻拍告警,
3123
- -9105 身份证框内遮挡告警,
3124
- -9104 临时身份证告警,
3125
- -9106 身份证 PS 告警(疑似存在PS痕迹),
3126
- -9107 身份证反光告警。
3333
+ * 身份证国徽面告警码。
3334
+ - 开启身份证告警功能后才会返回。
3335
+ - 返回数组中可能出现的告警码如下:
3336
+ - -9100 身份证有效日期不合法告警,
3337
+ - -9101 身份证边框不完整告警,
3338
+ - -9102 身份证复印件告警,
3339
+ - -9103 身份证翻拍告警,
3340
+ - -9105 身份证框内遮挡告警,
3341
+ - -9104 临时身份证告警,
3342
+ - -9106 身份证 PS 告警(疑似存在PS痕迹),
3343
+ - -9107 身份证反光告警。
3127
3344
  注意:此字段可能返回 null,表示取不到有效值。
3128
3345
  */
3129
3346
  BackWarnInfos?: Array<number | bigint>
@@ -3153,12 +3370,14 @@ export interface CheckPhoneAndNameRequest {
3153
3370
  */
3154
3371
  export interface GetEidTokenResponse {
3155
3372
  /**
3156
- * 一次核身流程的标识,有效时间为600秒;
3157
- 完成核身后,可用该标识获取验证结果信息。
3373
+ * 一次核身流程的标识。
3374
+ - 有效时间为600秒。
3375
+ - 完成核身后,可用该标识获取验证结果信息。
3158
3376
  */
3159
3377
  EidToken?: string
3160
3378
  /**
3161
- * 发起核身流程的URL,用于H5场景核身。
3379
+ * 发起核身流程的URL
3380
+ - 用于H5场景核身。
3162
3381
  */
3163
3382
  Url?: string
3164
3383
  /**
@@ -3172,11 +3391,14 @@ export interface GetEidTokenResponse {
3172
3391
  */
3173
3392
  export interface IntentionQuestion {
3174
3393
  /**
3175
- * 当选择语音问答模式时,系统自动播报的问题文本,最大长度为150个字符。
3394
+ * 当选择语音问答模式时,系统自动播报的问题文本。
3395
+ - 最大长度为150个字符。
3176
3396
  */
3177
3397
  Question: string
3178
3398
  /**
3179
- * 当选择语音问答模式时,用于判断用户回答是否通过的标准答案列表,传入后可自动判断用户回答文本是否在标准文本列表中。列表长度最大为50,单个答案长度限制10个字符。
3399
+ * 当选择语音问答模式时,用于判断用户回答是否通过的标准答案列表。
3400
+ - 传入后可自动判断用户回答文本是否在标准文本列表中。
3401
+ - 列表长度最大为50,单个答案长度限制10个字符。
3180
3402
  */
3181
3403
  Answers: Array<string>
3182
3404
  }