tencentcloud-sdk-nodejs 4.0.968 → 4.0.970

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 (110) hide show
  1. package/CHANGELOG.md +579 -0
  2. package/SERVICE_CHANGELOG.md +783 -82
  3. package/package.json +1 -1
  4. package/products.md +41 -41
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/as/v20180419/as_models.ts +2 -2
  7. package/src/services/bi/v20220105/bi_models.ts +25 -0
  8. package/src/services/billing/v20180709/billing_models.ts +16 -16
  9. package/src/services/btoe/v20210514/btoe_models.ts +4 -4
  10. package/src/services/cam/v20190116/cam_models.ts +10 -10
  11. package/src/services/ccc/v20200210/ccc_client.ts +4 -2
  12. package/src/services/ccc/v20200210/ccc_models.ts +113 -50
  13. package/src/services/cds/v20180420/cds_models.ts +27 -31
  14. package/src/services/cdwdoris/v20211228/cdwdoris_models.ts +7 -0
  15. package/src/services/cfg/v20210820/cfg_models.ts +4 -0
  16. package/src/services/cloudaudit/v20190319/cloudaudit_client.ts +2 -2
  17. package/src/services/cloudaudit/v20190319/cloudaudit_models.ts +25 -16
  18. package/src/services/cls/v20201016/cls_models.ts +29 -9
  19. package/src/services/dasb/v20191018/dasb_models.ts +70 -166
  20. package/src/services/dcdb/v20180411/dcdb_client.ts +32 -20
  21. package/src/services/dcdb/v20180411/dcdb_models.ts +111 -47
  22. package/src/services/essbasic/v20210526/essbasic_client.ts +2 -1
  23. package/src/services/essbasic/v20210526/essbasic_models.ts +7 -3
  24. package/src/services/faceid/v20180301/faceid_models.ts +428 -361
  25. package/src/services/hunyuan/v20230901/hunyuan_models.ts +6 -2
  26. package/src/services/ioa/v20220601/ioa_client.ts +2 -3
  27. package/src/services/ioa/v20220601/ioa_models.ts +3 -29
  28. package/src/services/iotexplorer/v20190423/iotexplorer_models.ts +16 -6
  29. package/src/services/iss/v20230517/iss_models.ts +5 -1
  30. package/src/services/lighthouse/v20200324/lighthouse_client.ts +1 -0
  31. package/src/services/lighthouse/v20200324/lighthouse_models.ts +31 -0
  32. package/src/services/mariadb/v20170312/mariadb_models.ts +7 -7
  33. package/src/services/ocr/v20181119/ocr_client.ts +30 -8
  34. package/src/services/ocr/v20181119/ocr_models.ts +645 -191
  35. package/src/services/organization/v20210331/organization_models.ts +7 -3
  36. package/src/services/privatedns/v20201028/privatedns_client.ts +114 -65
  37. package/src/services/privatedns/v20201028/privatedns_models.ts +886 -766
  38. package/src/services/pts/v20210728/pts_models.ts +5 -0
  39. package/src/services/ssl/v20191205/ssl_models.ts +1 -1
  40. package/src/services/ssm/v20190923/ssm_models.ts +0 -2
  41. package/src/services/tdmq/v20200217/tdmq_client.ts +1 -0
  42. package/src/services/tdmq/v20200217/tdmq_models.ts +134 -119
  43. package/src/services/tke/v20180525/tke_models.ts +6 -2
  44. package/src/services/tke/v20220501/tke_models.ts +9 -0
  45. package/src/services/trp/v20210515/trp_models.ts +10 -9
  46. package/src/services/tse/v20201207/tse_client.ts +18 -6
  47. package/src/services/tse/v20201207/tse_models.ts +28 -0
  48. package/src/services/vod/v20180717/vod_client.ts +27 -2
  49. package/src/services/vod/v20180717/vod_models.ts +111 -26
  50. package/src/services/wedata/v20210820/wedata_client.ts +1 -0
  51. package/src/services/wedata/v20210820/wedata_models.ts +300 -17
  52. package/tencentcloud/common/sdk_version.d.ts +1 -1
  53. package/tencentcloud/common/sdk_version.js +1 -1
  54. package/tencentcloud/services/as/v20180419/as_models.d.ts +2 -2
  55. package/tencentcloud/services/bi/v20220105/bi_models.d.ts +25 -0
  56. package/tencentcloud/services/billing/v20180709/billing_models.d.ts +16 -16
  57. package/tencentcloud/services/btoe/v20210514/btoe_models.d.ts +4 -4
  58. package/tencentcloud/services/cam/v20190116/cam_models.d.ts +10 -10
  59. package/tencentcloud/services/ccc/v20200210/ccc_client.d.ts +3 -1
  60. package/tencentcloud/services/ccc/v20200210/ccc_client.js +3 -1
  61. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +113 -50
  62. package/tencentcloud/services/cds/v20180420/cds_models.d.ts +27 -31
  63. package/tencentcloud/services/cdwdoris/v20211228/cdwdoris_models.d.ts +7 -0
  64. package/tencentcloud/services/cfg/v20210820/cfg_models.d.ts +4 -0
  65. package/tencentcloud/services/cloudaudit/v20190319/cloudaudit_client.d.ts +2 -2
  66. package/tencentcloud/services/cloudaudit/v20190319/cloudaudit_client.js +2 -2
  67. package/tencentcloud/services/cloudaudit/v20190319/cloudaudit_models.d.ts +25 -16
  68. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +29 -9
  69. package/tencentcloud/services/dasb/v20191018/dasb_models.d.ts +69 -165
  70. package/tencentcloud/services/dcdb/v20180411/dcdb_client.d.ts +11 -7
  71. package/tencentcloud/services/dcdb/v20180411/dcdb_client.js +15 -9
  72. package/tencentcloud/services/dcdb/v20180411/dcdb_models.d.ts +109 -47
  73. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +2 -1
  74. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +2 -1
  75. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +7 -3
  76. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +428 -361
  77. package/tencentcloud/services/hunyuan/v20230901/hunyuan_models.d.ts +6 -2
  78. package/tencentcloud/services/ioa/v20220601/ioa_client.d.ts +0 -1
  79. package/tencentcloud/services/ioa/v20220601/ioa_client.js +0 -1
  80. package/tencentcloud/services/ioa/v20220601/ioa_models.d.ts +3 -29
  81. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_models.d.ts +16 -6
  82. package/tencentcloud/services/iss/v20230517/iss_models.d.ts +5 -1
  83. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +30 -0
  84. package/tencentcloud/services/mariadb/v20170312/mariadb_models.d.ts +7 -7
  85. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +7 -1
  86. package/tencentcloud/services/ocr/v20181119/ocr_client.js +8 -0
  87. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +636 -192
  88. package/tencentcloud/services/organization/v20210331/organization_models.d.ts +7 -3
  89. package/tencentcloud/services/privatedns/v20201028/privatedns_client.d.ts +21 -5
  90. package/tencentcloud/services/privatedns/v20201028/privatedns_client.js +30 -6
  91. package/tencentcloud/services/privatedns/v20201028/privatedns_models.d.ts +821 -710
  92. package/tencentcloud/services/pts/v20210728/pts_models.d.ts +5 -0
  93. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +1 -1
  94. package/tencentcloud/services/ssm/v20190923/ssm_models.d.ts +0 -2
  95. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +133 -119
  96. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +6 -2
  97. package/tencentcloud/services/tke/v20220501/tke_models.d.ts +9 -0
  98. package/tencentcloud/services/trp/v20210515/trp_models.d.ts +10 -9
  99. package/tencentcloud/services/tse/v20201207/tse_client.d.ts +7 -3
  100. package/tencentcloud/services/tse/v20201207/tse_client.js +9 -3
  101. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +26 -0
  102. package/tencentcloud/services/vod/v20180717/vod_client.d.ts +16 -1
  103. package/tencentcloud/services/vod/v20180717/vod_client.js +17 -0
  104. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +107 -26
  105. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +299 -17
  106. package/test/dcdb.v20180411.test.js +16 -6
  107. package/test/ocr.v20181119.test.js +10 -0
  108. package/test/privatedns.v20201028.test.js +44 -4
  109. package/test/tse.v20201207.test.js +12 -2
  110. package/test/vod.v20180717.test.js +10 -0
@@ -44,17 +44,19 @@ export interface GetFaceidRiskInfoTokenResponse {
44
44
  export interface CheckIdNameDateResponse {
45
45
  /**
46
46
  * 认证结果码,收费情况如下。
47
- 收费结果码:
48
- 0: 一致
49
- -1: 不一致
50
- 不收费结果码:
51
- -2: 非法身份证号(长度、校验位等不正确)
52
- -3: 非法姓名(长度、格式等不正确)
53
- -4: 非法有效期(长度、格式等不正确)
54
- -5: 身份信息无效
55
- -6: 证件库服务异常
56
- -7: 证件库中无此身份证记录
57
- -8: 认证次数超过当日限制,请次日重试
47
+
48
+ - 收费结果码:
49
+ 0: 一致。
50
+ -1: 不一致。
51
+
52
+ - 不收费结果码:
53
+ -2: 非法身份证号(长度、校验位等不正确)。
54
+ -3: 非法姓名(长度、格式等不正确)。
55
+ -4: 非法有效期(长度、格式等不正确)。
56
+ -5: 身份信息无效。
57
+ -6: 证件库服务异常。
58
+ -7: 证件库中无此身份证记录。
59
+ -8: 认证次数超过当日限制,请次日重试。
58
60
  */
59
61
  Result?: string;
60
62
  /**
@@ -71,15 +73,16 @@ export interface CheckIdNameDateResponse {
71
73
  */
72
74
  export interface IdCardVerificationRequest {
73
75
  /**
74
- * 身份证号
76
+ * 身份证号。
75
77
  */
76
78
  IdCard: string;
77
79
  /**
78
- * 姓名
80
+ * 姓名。
79
81
  */
80
82
  Name: string;
81
83
  /**
82
- * 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
84
+ * 敏感数据加密信息。
85
+ - 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
83
86
  */
84
87
  Encryption?: Encryption;
85
88
  }
@@ -258,11 +261,12 @@ export interface RuleIdConfig {
258
261
  */
259
262
  export interface MobileStatusRequest {
260
263
  /**
261
- * 手机号码
264
+ * 手机号码。
262
265
  */
263
266
  Mobile: string;
264
267
  /**
265
- * 敏感数据加密信息。对传入信息(手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
268
+ * 敏感数据加密信息。
269
+ - 对传入信息(手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
266
270
  */
267
271
  Encryption?: Encryption;
268
272
  }
@@ -430,13 +434,13 @@ export interface LivenessRecognitionRequest {
430
434
  */
431
435
  export interface CheckEidTokenStatusResponse {
432
436
  /**
433
- * 枚举:
434
- init:token未验证
435
- doing: 验证中
436
- finished: 验证完成
437
- timeout: token已超时
437
+ * 状态。
438
+ - init:EidToken未验证。
439
+ - doing: EidToken验证中。
440
+ - finished: EidToken验证完成。
441
+ - timeout: EidToken已超时。
438
442
  */
439
- Status: string;
443
+ Status?: string;
440
444
  /**
441
445
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
442
446
  */
@@ -572,27 +576,33 @@ export interface GetFaceIdRiskInfoResponse {
572
576
  */
573
577
  export interface LivenessCompareResponse {
574
578
  /**
575
- * 验证通过后的视频最佳截图照片,照片为BASE64编码后的值,jpg格式。
579
+ * 验证通过后的视频最佳截图照片。
580
+ - 照片为BASE64编码后的值,jpg格式。
576
581
  注意:此字段可能返回 null,表示取不到有效值。
577
582
  */
578
- BestFrameBase64: string;
583
+ BestFrameBase64?: string;
579
584
  /**
580
- * 相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)。
585
+ * 相似度。
586
+ - 取值范围 [0.00, 100.00]。
587
+ - 推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)。
581
588
  */
582
- Sim: number;
589
+ Sim?: number;
583
590
  /**
584
- * 业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
591
+ * 业务错误码。
592
+ - 成功情况返回Success。
593
+ - 错误情况请参考下方错误码,列表中FailedOperation部分。
585
594
  */
586
- Result: string;
595
+ Result?: string;
587
596
  /**
588
597
  * 业务结果描述。
589
598
  */
590
- Description: string;
599
+ Description?: string;
591
600
  /**
592
- * 最佳截图列表,仅在配置了返回多张最佳截图时返回。
601
+ * 最佳截图列表。
602
+ - 仅在配置了返回多张最佳截图时返回。
593
603
  注意:此字段可能返回 null,表示取不到有效值。
594
604
  */
595
- BestFrameList: Array<string>;
605
+ BestFrameList?: Array<string>;
596
606
  /**
597
607
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
598
608
  */
@@ -603,27 +613,28 @@ export interface LivenessCompareResponse {
603
613
  */
604
614
  export interface BankCard2EVerificationResponse {
605
615
  /**
606
- * 认证结果码
607
- 计费结果码:
608
- '0': '认证通过'
609
- '-1': '认证未通过'
610
- '-4': '持卡人信息有误'
611
- '-5': '未开通无卡支付'
612
- '-6': '此卡被没收'
613
- '-7': '无效卡号'
614
- '-8': '此卡无对应发卡行'
615
- '-9': '该卡未初始化或睡眠卡'
616
- '-10': '作弊卡、吞卡'
617
- '-11': '此卡已挂失'
618
- '-12': '该卡已过期'
619
- '-13': '受限制的卡'
620
- '-14': '密码错误次数超限'
621
- '-15': '发卡行不支持此交易'
622
- 不计费结果码:
623
- '-2': '姓名校验不通过'
624
- '-3': '银行卡号码有误'
625
- '-16': '验证中心服务繁忙'
626
- '-17': '验证次数超限,请次日重试'
616
+ * 认证结果码。
617
+ - 计费结果码:
618
+ '0': '认证通过'
619
+ '-1': '认证未通过'
620
+ '-4': '持卡人信息有误'
621
+ '-5': '未开通无卡支付'
622
+ '-6': '此卡被没收'
623
+ '-7': '无效卡号'
624
+ '-8': '此卡无对应发卡行'
625
+ '-9': '该卡未初始化或睡眠卡'
626
+ '-10': '作弊卡、吞卡'
627
+ '-11': '此卡已挂失'
628
+ '-12': '该卡已过期'
629
+ '-13': '受限制的卡'
630
+ '-14': '密码错误次数超限'
631
+ '-15': '发卡行不支持此交易'
632
+
633
+ - 不计费结果码:
634
+ '-2': '姓名校验不通过'
635
+ '-3': '银行卡号码有误'
636
+ '-16': '验证中心服务繁忙'
637
+ '-17': '验证次数超限,请次日重试'。
627
638
 
628
639
  */
629
640
  Result?: string;
@@ -642,13 +653,14 @@ export interface BankCard2EVerificationResponse {
642
653
  export interface MobileStatusResponse {
643
654
  /**
644
655
  * 认证结果码,收费情况如下。
645
- 收费结果码:
646
- 0:成功
647
- 不收费结果码:
648
- -1:未查询到结果
649
- -2:手机号格式不正确
650
- -3:验证中心服务繁忙
651
- -4:认证次数超过当日限制,请次日重试
656
+ - 收费结果码:
657
+ 0:成功。
658
+
659
+ - 不收费结果码:
660
+ -1:未查询到结果。
661
+ -2:手机号格式不正确。
662
+ -3:验证中心服务繁忙。
663
+ -4:认证次数超过当日限制,请次日重试。
652
664
  */
653
665
  Result?: string;
654
666
  /**
@@ -656,13 +668,14 @@ export interface MobileStatusResponse {
656
668
  */
657
669
  Description?: string;
658
670
  /**
659
- * 状态码:
660
- 0:正常
661
- 1:停机
662
- 2:销号
663
- 3:空号
664
- 4:不在网
665
- 99:未知状态
671
+ * 状态码。
672
+ - 取值范围:
673
+ 0:正常。
674
+ 1:停机。
675
+ 2:销号。
676
+ 3:空号。
677
+ 4:不在网。
678
+ 99:未知状态。
666
679
  */
667
680
  StatusCode?: number;
668
681
  /**
@@ -798,12 +811,12 @@ export interface LivenessRequest {
798
811
  export interface DetectAIFakeFacesRequest {
799
812
  /**
800
813
  * 传入需要进行检测的带有人脸的图片或视频,使用base64编码的形式。
814
+ - 图片的Base64值:
815
+ 建议整体图像480x640的分辨率,脸部 大小 100X100 以上。
816
+ Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。
817
+ 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
801
818
 
802
- 图片的Base64值:
803
- 建议整体图像480x640的分辨率,脸部 大小 100X100 以上;
804
- Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
805
-
806
- 视频的Base64值:
819
+ - 视频的Base64值:
807
820
  Base64编码后的大小不超过8M,支持mp4、avi、flv格式。
808
821
  请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
809
822
  视频时长最大支持20s,建议时长2~5s。
@@ -811,18 +824,22 @@ export interface DetectAIFakeFacesRequest {
811
824
  */
812
825
  FaceInput?: string;
813
826
  /**
814
- * 传入的类型
815
- 1- 传入的是图片类型
816
- 2- 传入的是视频类型
817
- 其他 - 返回错误码InvalidParameter
827
+ * 传入的类型。
828
+ - 取值范围:
829
+ 1:传入的是图片类型。
830
+ 2:传入的是视频类型。
831
+ 其他:返回错误码InvalidParameter。
818
832
  */
819
833
  FaceInputType?: number;
820
834
  /**
821
- * 是否需要对请求信息进行全包体加密; 支持的加密算法:AES-256-CBC、SM4-GCM; 有加密需求的用户可使用此参数,详情请点击左侧链接。
835
+ * 是否需要对请求信息进行全包体加密。
836
+ - 支持的加密算法:AES-256-CBC、SM4-GCM。
837
+ - 有加密需求的用户可使用此参数,详情请点击左侧链接。
822
838
  */
823
839
  Encryption?: Encryption;
824
840
  /**
825
- * 加密后的密文; 加密前的数据格式如下:{"FaceInput":"AAAAA","FaceInputType":1}
841
+ * 加密后的密文。
842
+ - 加密前的数据格式如下:{"FaceInput":"AAAAA","FaceInputType":1}。
826
843
  */
827
844
  EncryptedBody?: string;
828
845
  }
@@ -832,10 +849,11 @@ export interface DetectAIFakeFacesRequest {
832
849
  export interface CheckBankCardInformationResponse {
833
850
  /**
834
851
  * 认证结果码,收费情况如下。
835
- 收费结果码:
852
+ - 收费结果码:
836
853
  0: 查询成功
837
854
  -1: 未查到信息
838
- 不收费结果码:
855
+
856
+ - 不收费结果码:
839
857
  -2:验证中心服务繁忙
840
858
  -3:银行卡不存在
841
859
  -4:认证次数超过当日限制,请次日重试
@@ -843,15 +861,20 @@ export interface CheckBankCardInformationResponse {
843
861
  */
844
862
  Result?: string;
845
863
  /**
846
- * 业务结果描述
864
+ * 业务结果描述。
847
865
  */
848
866
  Description?: string;
849
867
  /**
850
- * 开户行
868
+ * 开户行。
851
869
  */
852
870
  AccountBank?: string;
853
871
  /**
854
- * 卡性质:1. 借记卡;2. 贷记卡;3. 预付费卡;4. 准贷记卡
872
+ * 卡性质。
873
+ - 取值范围:
874
+ 1:借记卡。
875
+ 2:贷记卡。
876
+ 3:预付费卡。
877
+ 4:准贷记卡
855
878
  */
856
879
  AccountType?: number;
857
880
  /**
@@ -898,23 +921,26 @@ export interface GetEidTokenRequest {
898
921
  */
899
922
  export interface CheckIdNameDateRequest {
900
923
  /**
901
- * 姓名
924
+ * 姓名。
902
925
  */
903
926
  Name: string;
904
927
  /**
905
- * 身份证号
928
+ * 身份证号。
906
929
  */
907
930
  IdCard: string;
908
931
  /**
909
- * 身份证有效期开始时间,格式:YYYYMMDD。如:20210701
932
+ * 身份证有效期开始时间。
933
+ - 格式:YYYYMMDD,如:20210701。
910
934
  */
911
935
  ValidityBegin: string;
912
936
  /**
913
- * 身份证有效期到期时间,格式:YYYYMMDD,长期用“00000000”代替;如:20210701
937
+ * 身份证有效期到期时间。
938
+ 格式:YYYYMMDD,长期用“00000000”代替,如:20210701。
914
939
  */
915
940
  ValidityEnd: string;
916
941
  /**
917
- * 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
942
+ * 敏感数据加密信息。
943
+ - 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
918
944
  */
919
945
  Encryption?: Encryption;
920
946
  }
@@ -1059,20 +1085,20 @@ export interface GetFaceIdResultResponse {
1059
1085
  */
1060
1086
  export interface DetectAIFakeFacesResponse {
1061
1087
  /**
1062
- * 检测到的图片是否存在攻击:
1063
- Low:无攻击风险
1064
- Mid:中度疑似攻击
1065
- High:高度疑似攻击
1088
+ * 检测到的图片是否存在攻击。
1089
+ - Low:无攻击风险。
1090
+ - Mid:中度疑似攻击。
1091
+ - High:高度疑似攻击。
1066
1092
  */
1067
1093
  AttackRiskLevel?: string;
1068
1094
  /**
1069
- * 检测到疑似的攻击痕迹列表
1070
- 说明:未检测到攻击痕迹时,返回空数组
1071
- 此出参仅作为结果判断的参考,实际应用仍建议使用AttackRiskLevel的结果。
1095
+ * 检测到疑似的攻击痕迹列表。
1096
+ - 说明:未检测到攻击痕迹时,返回空数组。
1097
+ - 此出参仅作为结果判断的参考,实际应用仍建议使用AttackRiskLevel的结果。
1072
1098
  */
1073
1099
  AttackRiskDetailList?: Array<AttackRiskDetail>;
1074
1100
  /**
1075
- * 额外信息
1101
+ * 额外信息。
1076
1102
  */
1077
1103
  ExtraInfo?: ExtraInfo;
1078
1104
  /**
@@ -1121,53 +1147,55 @@ export interface IntentionVerifyData {
1121
1147
  */
1122
1148
  export interface LivenessCompareRequest {
1123
1149
  /**
1124
- * 活体检测类型,取值:LIP/ACTION/SILENT。
1125
- LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。
1150
+ * 活体检测类型。
1151
+ - 取值:LIP/ACTION/SILENT
1152
+ - LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。
1126
1153
  */
1127
1154
  LivenessType: string;
1128
1155
  /**
1129
- * 用于人脸比对的照片的Base64值;
1130
- Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。
1131
- 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
1132
-
1133
- 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageBase64。
1156
+ * 用于人脸比对的照片的Base64值。
1157
+ - Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。
1158
+ - 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
1159
+ - 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageBase64。
1134
1160
  */
1135
1161
  ImageBase64?: string;
1136
1162
  /**
1137
- * 用于人脸比对照片的URL地址;图片下载后经Base64编码后的数据大小不超过3M,仅支持jpg、png格式。
1138
-
1139
- 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageBase64。
1140
-
1141
- 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
1163
+ * 用于人脸比对照片的URL地址。
1164
+ - 图片下载后经Base64编码后的数据大小不超过3M,仅支持jpg、png格式。
1165
+ - 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageBase64。
1166
+ - 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
1167
+ - 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
1142
1168
  */
1143
1169
  ImageUrl?: string;
1144
1170
  /**
1145
- * 数字模式传参:传数字验证码,验证码需先调用<a href="https://cloud.tencent.com/document/product/1007/31821">获取数字验证码接口</a>得到;
1146
- 动作模式传参:传动作顺序,动作顺序需先调用<a href="https://cloud.tencent.com/document/product/1007/31822">获取动作顺序接口</a>得到;
1147
- 静默模式传参:空。
1171
+ * 验证数据。
1172
+ - 数字模式传参:传数字验证码,验证码需先调用<a href="https://cloud.tencent.com/document/product/1007/31821">获取数字验证码接口</a>得到;
1173
+ - 动作模式传参:传动作顺序,动作顺序需先调用<a href="https://cloud.tencent.com/document/product/1007/31822">获取动作顺序接口</a>得到;
1174
+ - 静默模式传参:空。
1148
1175
  */
1149
1176
  ValidateData?: string;
1150
1177
  /**
1151
1178
  * 额外配置,传入JSON字符串。
1179
+
1180
+ - 格式如下:
1152
1181
  {
1153
1182
  "BestFrameNum": 2 //需要返回多张最佳截图,取值范围2-10
1154
1183
  }
1155
1184
  */
1156
1185
  Optional?: string;
1157
1186
  /**
1158
- * 用于活体检测的视频,视频的Base64值;
1159
- Base64编码后的大小不超过8M,支持mp4、avi、flv格式。
1160
- 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
1161
-
1162
- 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
1187
+ * 用于活体检测的视频,视频的Base64值。
1188
+ - Base64编码后的大小不超过8M,支持mp4、avi、flv格式。
1189
+ - 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
1190
+ - 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
1163
1191
  */
1164
1192
  VideoBase64?: string;
1165
1193
  /**
1166
- * 用于活体检测的视频Url 地址。视频下载后经Base64编码后不超过 8M,视频下载耗时不超过4S,支持mp4、avi、flv格式。
1167
-
1168
- 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
1169
-
1170
- 建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议视频存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
1194
+ * 用于活体检测的视频Url 地址。
1195
+ - 视频下载后经Base64编码后不超过 8M,视频下载耗时不超过4S,支持mp4、avi、flv格式。
1196
+ - 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
1197
+ - 建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议视频存储于腾讯云。
1198
+ - 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
1171
1199
  */
1172
1200
  VideoUrl?: string;
1173
1201
  }
@@ -1293,7 +1321,8 @@ export interface CheckBankCardInformationRequest {
1293
1321
  */
1294
1322
  BankCard: string;
1295
1323
  /**
1296
- * 敏感数据加密信息。对传入信息(银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1324
+ * 敏感数据加密信息。
1325
+ - 对传入信息(银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1297
1326
  */
1298
1327
  Encryption?: Encryption;
1299
1328
  }
@@ -1302,24 +1331,27 @@ export interface CheckBankCardInformationRequest {
1302
1331
  */
1303
1332
  export interface BankCardVerificationRequest {
1304
1333
  /**
1305
- * 开户证件号,与CertType参数的证件类型一致,如:身份证,则传入身份证号。
1334
+ * 开户证件号。
1335
+ - 与CertType参数的证件类型一致,如:身份证,则传入身份证号。
1306
1336
  */
1307
1337
  IdCard: string;
1308
1338
  /**
1309
- * 姓名
1339
+ * 姓名。
1310
1340
  */
1311
1341
  Name: string;
1312
1342
  /**
1313
- * 银行卡
1343
+ * 银行卡。
1314
1344
  */
1315
1345
  BankCard: string;
1316
1346
  /**
1317
- * 证件类型,请确认该证件为开户时使用的证件类型,未用于开户的证件信息不支持验证。
1318
- 目前默认:0 身份证,其他证件类型暂不支持。
1347
+ * 证件类型。
1348
+ - 请确认该证件为开户时使用的证件类型,未用于开户的证件信息不支持验证。
1349
+ - 目前默认:0 身份证,其他证件类型暂不支持。
1319
1350
  */
1320
1351
  CertType?: number;
1321
1352
  /**
1322
- * 敏感数据加密信息。对传入信息(姓名、身份证号、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1353
+ * 敏感数据加密信息。
1354
+ - 对传入信息(姓名、身份证号、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1323
1355
  */
1324
1356
  Encryption?: Encryption;
1325
1357
  }
@@ -1364,11 +1396,15 @@ export interface GetWeChatBillDetailsResponse {
1364
1396
  */
1365
1397
  export interface CheckIdCardInformationResponse {
1366
1398
  /**
1367
- * 相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
1399
+ * 相似度。
1400
+ - 取值范围 [0.00, 100.00]。
1401
+ - 推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)。
1368
1402
  */
1369
1403
  Sim?: number;
1370
1404
  /**
1371
- * 业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
1405
+ * 业务错误码。
1406
+ - 成功情况返回Success,。
1407
+ - 错误情况请参考下方错误码 列表中FailedOperation部分
1372
1408
  */
1373
1409
  Result?: string;
1374
1410
  /**
@@ -1376,27 +1412,27 @@ export interface CheckIdCardInformationResponse {
1376
1412
  */
1377
1413
  Description?: string;
1378
1414
  /**
1379
- * 姓名
1415
+ * 姓名。
1380
1416
  */
1381
1417
  Name?: string;
1382
1418
  /**
1383
- * 性别
1419
+ * 性别。
1384
1420
  */
1385
1421
  Sex?: string;
1386
1422
  /**
1387
- * 民族
1423
+ * 民族。
1388
1424
  */
1389
1425
  Nation?: string;
1390
1426
  /**
1391
- * 出生日期
1427
+ * 出生日期。
1392
1428
  */
1393
1429
  Birth?: string;
1394
1430
  /**
1395
- * 地址
1431
+ * 地址。
1396
1432
  */
1397
1433
  Address?: string;
1398
1434
  /**
1399
- * 身份证号
1435
+ * 身份证号。
1400
1436
  */
1401
1437
  IdNum?: string;
1402
1438
  /**
@@ -1404,20 +1440,24 @@ export interface CheckIdCardInformationResponse {
1404
1440
  */
1405
1441
  Portrait?: string;
1406
1442
  /**
1407
- * 告警信息,当在Config中配置了告警信息会停止人像比对,Result返回错误(FailedOperation.OcrWarningOccurred)并有此告警信息,Code 告警码列表和释义:
1443
+ * 告警信息。
1444
+ - 当在Config中配置了告警信息会停止人像比对,Result返回错误(FailedOperation.OcrWarningOccurred)并有此告警信息。
1445
+ - Code 告警码列表和释义:
1446
+ '-9101':身份证边框不完整告警。
1447
+ '-9102':身份证复印件告警。
1448
+ '-9103':身份证翻拍告警。
1449
+ '-9105':身份证框内遮挡告警。
1450
+ '-9104':临时身份证告警。
1451
+ '-9106':身份证 PS 告警(疑似存在PS痕迹)。
1452
+ '-8001':图片模糊告警。
1408
1453
 
1409
- -9101 身份证边框不完整告警,
1410
- -9102 身份证复印件告警,
1411
- -9103 身份证翻拍告警,
1412
- -9105 身份证框内遮挡告警,
1413
- -9104 临时身份证告警,
1414
- -9106 身份证 PS 告警(疑似存在PS痕迹)。
1415
- -8001 图片模糊告警
1416
- 多个会 | 隔开如 "-9101|-9106|-9104"
1454
+ - 多个会用“|” 隔开,如 "-9101|-9106|-9104"。
1417
1455
  */
1418
1456
  Warnings?: string;
1419
1457
  /**
1420
- * 图片质量分数,当请求Config中配置图片模糊告警该参数才有意义,取值范围(0~100),目前默认阈值是50分,低于50分会触发模糊告警。
1458
+ * 图片质量分数。
1459
+ - 当请求Config中配置图片模糊告警该参数才有意义。
1460
+ - 取值范围(0~100),目前默认阈值是50分,低于50分会触发模糊告警。
1421
1461
  */
1422
1462
  Quality?: number;
1423
1463
  /**
@@ -1426,7 +1466,7 @@ export interface CheckIdCardInformationResponse {
1426
1466
  */
1427
1467
  Encryption?: Encryption;
1428
1468
  /**
1429
- * 加密后的数据
1469
+ * 加密后的数据。
1430
1470
  */
1431
1471
  EncryptedBody?: string;
1432
1472
  /**
@@ -1484,17 +1524,18 @@ export interface DetectAuthResponse {
1484
1524
  */
1485
1525
  export interface PhoneVerificationResponse {
1486
1526
  /**
1487
- * 认证结果码:
1488
- 收费结果码
1489
- 0: 三要素信息一致
1490
- -4: 三要素信息不一致
1491
- 不收费结果码
1492
- -6: 手机号码不合法
1493
- -7: 身份证号码有误
1494
- -8: 姓名校验不通过
1495
- -9: 没有记录
1496
- -11: 验证中心服务繁忙
1497
- -12: 认证次数超过当日限制,请次日重试
1527
+ * 认证结果码。
1528
+ - 收费结果码
1529
+ 0: 三要素信息一致。
1530
+ -4: 三要素信息不一致。
1531
+
1532
+ - 不收费结果码
1533
+ -6: 手机号码不合法。
1534
+ -7: 身份证号码有误。
1535
+ -8: 姓名校验不通过。
1536
+ -9: 没有记录。
1537
+ -11: 验证中心服务繁忙。
1538
+ -12: 认证次数超过当日限制,请次日重试。
1498
1539
  */
1499
1540
  Result?: string;
1500
1541
  /**
@@ -1503,17 +1544,18 @@ export interface PhoneVerificationResponse {
1503
1544
  Description?: string;
1504
1545
  /**
1505
1546
  * 运营商名称。
1506
- 取值范围为["","移动","电信","联通"]
1547
+ - 取值范围为["","移动","电信","联通"]
1507
1548
  */
1508
1549
  Isp?: string;
1509
1550
  /**
1510
- * 业务结果详细信息。(当VerifyMode配置"详版",且Result为"-4: 三要素信息不一致"时返回)
1511
- 枚举值:
1512
- PhoneIdCardMismatch:手机号码与姓名一致,与身份证号不一致;
1513
- PhoneNameMismatch:手机号码身份证号一致,与姓名不一致;
1514
- PhoneNameIdCardMismatch:手机号码与姓名和身份证号均不一致;
1515
- NameIdCardMismatch:姓名和身份证号不一致;
1516
- OtherMismatch:其他不一致;
1551
+ * 业务结果详细信息。
1552
+ - 当VerifyMode配置"详版",且Result为"-4: 三要素信息不一致"时返回。
1553
+ - 枚举值:
1554
+ PhoneIdCardMismatch:手机号码与姓名一致,与身份证号不一致。
1555
+ PhoneNameMismatch:手机号码身份证号一致,与姓名不一致。
1556
+ PhoneNameIdCardMismatch:手机号码与姓名和身份证号均不一致。
1557
+ NameIdCardMismatch:姓名和身份证号不一致。
1558
+ OtherMismatch:其他不一致。
1517
1559
  */
1518
1560
  ResultDetail?: string;
1519
1561
  /**
@@ -1526,30 +1568,32 @@ export interface PhoneVerificationResponse {
1526
1568
  */
1527
1569
  export interface IdCardOCRVerificationRequest {
1528
1570
  /**
1529
- * 身份证号
1530
- 姓名和身份证号、ImageBase64、ImageUrl三者必须提供其中之一。若都提供了,则按照姓名和身份证号>ImageBase64>ImageUrl的优先级使用参数。
1571
+ * 身份证号。
1572
+ - 姓名和身份证号、ImageBase64、ImageUrl三者必须提供其中之一。
1573
+ - 若都提供了,则按照姓名和身份证号>ImageBase64>ImageUrl的优先级使用参数。
1531
1574
  */
1532
1575
  IdCard?: string;
1533
1576
  /**
1534
- * 姓名
1577
+ * 姓名。
1535
1578
  */
1536
1579
  Name?: string;
1537
1580
  /**
1538
- * 身份证人像面的 Base64
1539
- 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
1540
- 支持的图片大小:所下载图片经Base64编码后不超过 3M。请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
1581
+ * 身份证人像面的 Base64 值。
1582
+ - 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
1583
+ - 支持的图片大小:所下载图片经Base64编码后不超过 3M。请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
1541
1584
  */
1542
1585
  ImageBase64?: string;
1543
1586
  /**
1544
- * 身份证人像面的 Url 地址
1545
- 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
1546
- 支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。
1547
- 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
1548
- 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
1587
+ * 身份证人像面的 Url 地址。
1588
+ - 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
1589
+ - 支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。
1590
+ - 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
1591
+ - 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
1549
1592
  */
1550
1593
  ImageUrl?: string;
1551
1594
  /**
1552
- * 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1595
+ * 敏感数据加密信息。
1596
+ - 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1553
1597
  */
1554
1598
  Encryption?: Encryption;
1555
1599
  }
@@ -1558,30 +1602,31 @@ export interface IdCardOCRVerificationRequest {
1558
1602
  */
1559
1603
  export interface BankCard4EVerificationResponse {
1560
1604
  /**
1561
- * 认证结果码
1562
- 收费结果码:
1563
- '0': '认证通过'
1564
- '-1': '认证未通过'
1565
- '-6': '持卡人信息有误'
1566
- '-7': '未开通无卡支付'
1567
- '-8': '此卡被没收'
1568
- '-9': '无效卡号'
1569
- '-10': '此卡无对应发卡行'
1570
- '-11': '该卡未初始化或睡眠卡'
1571
- '-12': '作弊卡、吞卡'
1572
- '-13': '此卡已挂失'
1573
- '-14': '该卡已过期'
1574
- '-15': '受限制的卡'
1575
- '-16': '密码错误次数超限'
1576
- '-17': '发卡行不支持此交易'
1577
- 不收费结果码:
1578
- '-2': '姓名校验不通过'
1579
- '-3': '身份证号码有误'
1580
- '-4': '银行卡号码有误'
1581
- '-5': '手机号码不合法'
1582
- '-18': '验证中心服务繁忙'
1583
- '-19': '验证次数超限,请次日重试'
1584
- '-20': '该证件号暂不支持核验,当前仅支持二代身份证'
1605
+ * 认证结果码。
1606
+ - 收费结果码:
1607
+ '0': '认证通过'
1608
+ '-1': '认证未通过'
1609
+ '-6': '持卡人信息有误'
1610
+ '-7': '未开通无卡支付'
1611
+ '-8': '此卡被没收'
1612
+ '-9': '无效卡号'
1613
+ '-10': '此卡无对应发卡行'
1614
+ '-11': '该卡未初始化或睡眠卡'
1615
+ '-12': '作弊卡、吞卡'
1616
+ '-13': '此卡已挂失'
1617
+ '-14': '该卡已过期'
1618
+ '-15': '受限制的卡'
1619
+ '-16': '密码错误次数超限'
1620
+ '-17': '发卡行不支持此交易'
1621
+
1622
+ - 不收费结果码:
1623
+ '-2': '姓名校验不通过'
1624
+ '-3': '身份证号码有误'
1625
+ '-4': '银行卡号码有误'
1626
+ '-5': '手机号码不合法'
1627
+ '-18': '验证中心服务繁忙'
1628
+ '-19': '验证次数超限,请次日重试'
1629
+ '-20': '该证件号暂不支持核验,当前仅支持二代身份证'。
1585
1630
  */
1586
1631
  Result?: string;
1587
1632
  /**
@@ -1628,11 +1673,12 @@ export interface Encryption {
1628
1673
  */
1629
1674
  export interface MobileNetworkTimeVerificationRequest {
1630
1675
  /**
1631
- * 手机号码
1676
+ * 手机号码。
1632
1677
  */
1633
1678
  Mobile: string;
1634
1679
  /**
1635
- * 敏感数据加密信息。对传入信息(手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1680
+ * 敏感数据加密信息。
1681
+ - 对传入信息(手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1636
1682
  */
1637
1683
  Encryption?: Encryption;
1638
1684
  }
@@ -1642,20 +1688,21 @@ export interface MobileNetworkTimeVerificationRequest {
1642
1688
  export interface PhoneVerificationCMCCResponse {
1643
1689
  /**
1644
1690
  * 认证结果码,收费情况如下。
1645
- 收费结果码:
1646
- 0: 认证通过
1647
- -4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)
1648
- 不收费结果码:
1649
- -6: 手机号码不合法
1650
- -7: 身份证号码有误
1651
- -8: 姓名校验不通过
1652
- -9: 没有记录
1653
- -11: 验证中心服务繁忙
1691
+ - 收费结果码:
1692
+ 0: 认证通过。
1693
+ -4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)。
1694
+
1695
+ - 不收费结果码:
1696
+ -6: 手机号码不合法。
1697
+ -7: 身份证号码有误。
1698
+ -8: 姓名校验不通过。
1699
+ -9: 没有记录。
1700
+ -11: 验证中心服务繁忙。
1654
1701
  */
1655
1702
  Result?: string;
1656
1703
  /**
1657
1704
  * 运营商名称。
1658
- 取值范围为["移动","联通","电信",""]
1705
+ - 取值范围为["移动","联通","电信",""]
1659
1706
  */
1660
1707
  Isp?: string;
1661
1708
  /**
@@ -1673,14 +1720,15 @@ export interface PhoneVerificationCMCCResponse {
1673
1720
  export interface MobileNetworkTimeVerificationResponse {
1674
1721
  /**
1675
1722
  * 认证结果码,收费情况如下。
1676
- 收费结果码:
1677
- 0: 成功
1678
- -2: 手机号不存在
1679
- -3: 手机号存在,但无法查询到在网时长
1680
- 不收费结果码:
1681
- -1: 手机号格式不正确
1682
- -4: 验证中心服务繁忙
1683
- -5:认证次数超过当日限制,请次日重试
1723
+ - 收费结果码:
1724
+ 0: 成功。
1725
+ -2: 手机号不存在。
1726
+ -3: 手机号存在,但无法查询到在网时长。
1727
+
1728
+ - 不收费结果码:
1729
+ -1: 手机号格式不正确。
1730
+ -4: 验证中心服务繁忙。
1731
+ -5:认证次数超过当日限制,请次日重试。
1684
1732
  */
1685
1733
  Result?: string;
1686
1734
  /**
@@ -1689,7 +1737,8 @@ export interface MobileNetworkTimeVerificationResponse {
1689
1737
  Description?: string;
1690
1738
  /**
1691
1739
  * 在网时长区间。
1692
- 格式为(a,b],表示在网时长在a个月以上,b个月以下。若b为+时表示没有上限。
1740
+ - 格式为(a,b],表示在网时长在a个月以上,b个月以下。
1741
+ - 若b为+时表示没有上限。
1693
1742
  */
1694
1743
  Range?: string;
1695
1744
  /**
@@ -1703,20 +1752,21 @@ export interface MobileNetworkTimeVerificationResponse {
1703
1752
  export interface PhoneVerificationCUCCResponse {
1704
1753
  /**
1705
1754
  * 认证结果码,收费情况如下。
1706
- 收费结果码:
1707
- 0: 认证通过
1708
- -4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)
1709
- 不收费结果码:
1710
- -6: 手机号码不合法
1711
- -7: 身份证号码有误
1712
- -8: 姓名校验不通过
1713
- -9: 没有记录
1714
- -11: 验证中心服务繁忙
1755
+ - 收费结果码:
1756
+ 0: 认证通过。
1757
+ -4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)。
1758
+
1759
+ - 不收费结果码:
1760
+ -6: 手机号码不合法。
1761
+ -7: 身份证号码有误。
1762
+ -8: 姓名校验不通过。
1763
+ -9: 没有记录。
1764
+ -11: 验证中心服务繁忙。
1715
1765
  */
1716
1766
  Result?: string;
1717
1767
  /**
1718
1768
  * 运营商名称。
1719
- 取值范围为["移动","联通","电信",""]
1769
+ - 取值范围为["移动","联通","电信",""]
1720
1770
  */
1721
1771
  Isp?: string;
1722
1772
  /**
@@ -1733,43 +1783,46 @@ export interface PhoneVerificationCUCCResponse {
1733
1783
  */
1734
1784
  export interface CheckIdCardInformationRequest {
1735
1785
  /**
1736
- * 身份证人像面的 Base64
1737
- 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
1738
- 支持的图片大小:所下载图片经Base64编码后不超过 7M。
1739
- 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
1740
- ImageBase64、ImageUrl二者必须提供其中之一。若都提供了,则按照ImageUrl>ImageBase64的优先级使用参数。
1786
+ * 身份证人像面的 Base64 值。
1787
+ - 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
1788
+ - 支持的图片大小:所下载图片经Base64编码后不超过 7M。
1789
+ - 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
1790
+ - ImageBase64、ImageUrl二者必须提供其中之一。若都提供了,则按照ImageUrl>ImageBase64的优先级使用参数。
1741
1791
  */
1742
1792
  ImageBase64?: string;
1743
1793
  /**
1744
1794
  * 身份证人像面的 Url 地址
1745
- 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
1746
- 支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。
1747
- 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
1748
- 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
1795
+ - 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
1796
+ - 支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。
1797
+ - 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
1798
+ - 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
1749
1799
  */
1750
1800
  ImageUrl?: string;
1751
1801
  /**
1752
- * 以下可选字段均为bool 类型,默认false:
1753
- CopyWarn,复印件告警
1754
- BorderCheckWarn,边框和框内遮挡告警
1755
- ReshootWarn,翻拍告警
1756
- DetectPsWarn,PS检测告警(疑似存在PS痕迹)
1757
- TempIdWarn,临时身份证告警
1758
- Quality,图片质量告警(评价图片模糊程度)
1802
+ * 配置。
1803
+ - 以下可选字段均为bool 类型,默认false。
1804
+ CopyWarn,复印件告警。
1805
+ BorderCheckWarn,边框和框内遮挡告警。
1806
+ ReshootWarn,翻拍告警。
1807
+ DetectPsWarn,PS检测告警(疑似存在PS痕迹)。
1808
+ TempIdWarn,临时身份证告警。
1809
+ Quality,图片质量告警(评价图片模糊程度)。
1759
1810
 
1760
- SDK 设置方式参考:
1761
- Config = Json.stringify({"CopyWarn":true,"ReshootWarn":true})
1762
- API 3.0 Explorer 设置方式参考:
1763
- Config = {"CopyWarn":true,"ReshootWarn":true}
1811
+ - SDK 设置方式参考:
1812
+ Config = Json.stringify({"CopyWarn":true,"ReshootWarn":true})
1813
+
1814
+ - API 3.0 Explorer 设置方式参考:
1815
+ Config = {"CopyWarn":true,"ReshootWarn":true}。
1764
1816
  */
1765
1817
  Config?: string;
1766
1818
  /**
1767
- * 是否需要对返回中的敏感信息进行加密。默认false。
1768
- 其中敏感信息包括:Response.IdNum、Response.Name
1819
+ * 是否需要对返回中的敏感信息进行加密。
1820
+ - 默认false。
1821
+ - 敏感信息包括:Response.IdNum、Response.Name。
1769
1822
  */
1770
1823
  IsEncrypt?: boolean;
1771
1824
  /**
1772
- * 是否需要对响应体加密
1825
+ * 是否需要对响应体加密。
1773
1826
  */
1774
1827
  IsEncryptResponse?: boolean;
1775
1828
  /**
@@ -1887,29 +1940,30 @@ export interface GetWeChatBillDetailsRequest {
1887
1940
  */
1888
1941
  export interface BankCardVerificationResponse {
1889
1942
  /**
1890
- * 认证结果码
1891
- 收费结果码:
1892
- '0': '认证通过'
1893
- '-1': '认证未通过'
1894
- '-5': '持卡人信息有误'
1895
- '-6': '未开通无卡支付'
1896
- '-7': '此卡被没收'
1897
- '-8': '无效卡号'
1898
- '-9': '此卡无对应发卡行'
1899
- '-10': '该卡未初始化或睡眠卡'
1900
- '-11': '作弊卡、吞卡'
1901
- '-12': '此卡已挂失'
1902
- '-13': '该卡已过期'
1903
- '-14': '受限制的卡'
1904
- '-15': '密码错误次数超限'
1905
- '-16': '发卡行不支持此交易'
1906
- 不收费结果码:
1907
- '-2': '姓名校验不通过'
1908
- '-3': '身份证号码有误'
1909
- '-4': '银行卡号码有误'
1910
- '-17': '验证中心服务繁忙'
1911
- '-18': '验证次数超限,请次日重试'
1912
- '-19': '该证件号暂不支持核验,当前仅支持二代身份证'
1943
+ * 认证结果码。
1944
+ - 收费结果码:
1945
+ '0': '认证通过'
1946
+ '-1': '认证未通过'
1947
+ '-5': '持卡人信息有误'
1948
+ '-6': '未开通无卡支付'
1949
+ '-7': '此卡被没收'
1950
+ '-8': '无效卡号'
1951
+ '-9': '此卡无对应发卡行'
1952
+ '-10': '该卡未初始化或睡眠卡'
1953
+ '-11': '作弊卡、吞卡'
1954
+ '-12': '此卡已挂失'
1955
+ '-13': '该卡已过期'
1956
+ '-14': '受限制的卡'
1957
+ '-15': '密码错误次数超限'
1958
+ '-16': '发卡行不支持此交易'
1959
+
1960
+ - 不收费结果码:
1961
+ '-2': '姓名校验不通过'
1962
+ '-3': '身份证号码有误'
1963
+ '-4': '银行卡号码有误'
1964
+ '-17': '验证中心服务繁忙'
1965
+ '-18': '验证次数超限,请次日重试'
1966
+ '-19': '该证件号暂不支持核验,当前仅支持二代身份证'。
1913
1967
  */
1914
1968
  Result?: string;
1915
1969
  /**
@@ -1926,19 +1980,20 @@ export interface BankCardVerificationResponse {
1926
1980
  */
1927
1981
  export interface PhoneVerificationCUCCRequest {
1928
1982
  /**
1929
- * 身份证号
1983
+ * 身份证号。
1930
1984
  */
1931
1985
  IdCard: string;
1932
1986
  /**
1933
- * 姓名
1987
+ * 姓名。
1934
1988
  */
1935
1989
  Name: string;
1936
1990
  /**
1937
- * 手机号
1991
+ * 手机号。
1938
1992
  */
1939
1993
  Phone: string;
1940
1994
  /**
1941
- * 敏感数据加密信息。对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1995
+ * 敏感数据加密信息。
1996
+ - 对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1942
1997
  */
1943
1998
  Encryption?: Encryption;
1944
1999
  }
@@ -1947,19 +2002,20 @@ export interface PhoneVerificationCUCCRequest {
1947
2002
  */
1948
2003
  export interface PhoneVerificationCMCCRequest {
1949
2004
  /**
1950
- * 身份证号
2005
+ * 身份证号。
1951
2006
  */
1952
2007
  IdCard: string;
1953
2008
  /**
1954
- * 姓名
2009
+ * 姓名。
1955
2010
  */
1956
2011
  Name: string;
1957
2012
  /**
1958
- * 手机号
2013
+ * 手机号。
1959
2014
  */
1960
2015
  Phone: string;
1961
2016
  /**
1962
- * 敏感数据加密信息。对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2017
+ * 敏感数据加密信息。
2018
+ - 对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1963
2019
  */
1964
2020
  Encryption?: Encryption;
1965
2021
  }
@@ -2233,50 +2289,50 @@ export interface GetDetectInfoResponse {
2233
2289
  export interface IdCardOCRVerificationResponse {
2234
2290
  /**
2235
2291
  * 认证结果码,收费情况如下。
2236
- 收费结果码:
2237
- 0: 姓名和身份证号一致
2238
- -1: 姓名和身份证号不一致
2239
- 不收费结果码:
2240
- -2: 非法身份证号(长度、校验位等不正确)
2241
- -3: 非法姓名(长度、格式等不正确)
2242
- -4: 证件库服务异常
2243
- -5: 证件库中无此身份证记录
2244
- -6: 权威比对系统升级中,请稍后再试
2245
- -7: 认证次数超过当日限制
2292
+ - 收费结果码:
2293
+ 0: 姓名和身份证号一致。
2294
+ -1: 姓名和身份证号不一致。
2295
+ - 不收费结果码:
2296
+ -2: 非法身份证号(长度、校验位等不正确)。
2297
+ -3: 非法姓名(长度、格式等不正确)。
2298
+ -4: 证件库服务异常。
2299
+ -5: 证件库中无此身份证记录。
2300
+ -6: 权威比对系统升级中,请稍后再试。
2301
+ -7: 认证次数超过当日限制。
2246
2302
  */
2247
- Result: string;
2303
+ Result?: string;
2248
2304
  /**
2249
2305
  * 业务结果描述。
2250
2306
  */
2251
- Description: string;
2307
+ Description?: string;
2252
2308
  /**
2253
- * 用于验证的姓名
2309
+ * 用于验证的姓名。
2254
2310
  */
2255
- Name: string;
2311
+ Name?: string;
2256
2312
  /**
2257
- * 用于验证的身份证号
2313
+ * 用于验证的身份证号。
2258
2314
  */
2259
- IdCard: string;
2315
+ IdCard?: string;
2260
2316
  /**
2261
- * OCR得到的性别
2317
+ * OCR得到的性别。
2262
2318
  注意:此字段可能返回 null,表示取不到有效值。
2263
2319
  */
2264
- Sex: string;
2320
+ Sex?: string;
2265
2321
  /**
2266
- * OCR得到的民族
2322
+ * OCR得到的民族。
2267
2323
  注意:此字段可能返回 null,表示取不到有效值。
2268
2324
  */
2269
- Nation: string;
2325
+ Nation?: string;
2270
2326
  /**
2271
- * OCR得到的生日
2327
+ * OCR得到的生日。
2272
2328
  注意:此字段可能返回 null,表示取不到有效值。
2273
2329
  */
2274
- Birth: string;
2330
+ Birth?: string;
2275
2331
  /**
2276
- * OCR得到的地址
2332
+ * OCR得到的地址。
2277
2333
  注意:此字段可能返回 null,表示取不到有效值。
2278
2334
  */
2279
- Address: string;
2335
+ Address?: string;
2280
2336
  /**
2281
2337
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2282
2338
  */
@@ -2288,7 +2344,7 @@ export interface IdCardOCRVerificationResponse {
2288
2344
  export interface IdCardVerificationResponse {
2289
2345
  /**
2290
2346
  * 认证结果码,收费情况如下。
2291
- 收费结果码:
2347
+ - 收费结果码:
2292
2348
  0: 姓名和身份证号一致
2293
2349
  -1: 姓名和身份证号不一致
2294
2350
  不收费结果码:
@@ -2314,7 +2370,7 @@ export interface IdCardVerificationResponse {
2314
2370
  */
2315
2371
  export interface GetActionSequenceRequest {
2316
2372
  /**
2317
- * 默认不需要使用
2373
+ * 默认不需要使用。
2318
2374
  */
2319
2375
  ActionType?: string;
2320
2376
  }
@@ -2466,29 +2522,31 @@ export interface WeChatBillDetail {
2466
2522
  */
2467
2523
  export interface PhoneVerificationRequest {
2468
2524
  /**
2469
- * 身份证号
2525
+ * 身份证号。
2470
2526
  */
2471
2527
  IdCard: string;
2472
2528
  /**
2473
- * 姓名
2529
+ * 姓名。
2474
2530
  */
2475
2531
  Name: string;
2476
2532
  /**
2477
- * 手机号
2533
+ * 手机号。
2478
2534
  */
2479
2535
  Phone: string;
2480
2536
  /**
2481
- * 验证模式(详版/简版)。简版与详版价格不一致,详见[价格说明](https://cloud.tencent.com/document/product/1007/84321)。
2482
-
2483
- 枚举值:0(简版),1(详版)。默认值为0。
2537
+ * 验证模式(详版/简版)。
2538
+ - 简版与详版价格不一致,详见[价格说明](https://cloud.tencent.com/document/product/1007/84321)。
2539
+ - 枚举值:0(简版);1(详版)。
2540
+ - 默认值为0。
2484
2541
  */
2485
2542
  VerifyMode?: string;
2486
2543
  /**
2487
- * 有加密需求的用户,传入kms的CiphertextBlob,关于数据加密可查阅 <a href="https://cloud.tencent.com/document/product/1007/47180">数据加密</a> 文档。
2544
+ * 有加密需求的用户,传入kms的CiphertextBlob。关于数据加密可查阅 <a href="https://cloud.tencent.com/document/product/1007/47180">数据加密</a> 文档。
2488
2545
  */
2489
2546
  CiphertextBlob?: string;
2490
2547
  /**
2491
- * 在使用加密服务时,填入要被加密的字段。本接口中可填入加密后的IdCard,Name,Phone中的一个或多个。
2548
+ * 在使用加密服务时,填入要被加密的字段。
2549
+ - 本接口中可填入加密后的IdCard,Name,Phone中的一个或多个。
2492
2550
  */
2493
2551
  EncryptList?: Array<string>;
2494
2552
  /**
@@ -2519,20 +2577,21 @@ export interface GetFaceIdResultRequest {
2519
2577
  export interface CheckPhoneAndNameResponse {
2520
2578
  /**
2521
2579
  * 认证结果码,收费情况如下。
2522
- 收费结果码:
2523
- 0: 验证结果一致
2524
- 1: 验证结果不一致
2525
- 不收费结果码:
2526
- -1:查无记录
2527
- -2:引擎未知错误
2528
- -3:引擎服务异常
2529
- -4:姓名校验不通过
2530
- -5:手机号码不合法
2531
- -6: 认证次数超过当日限制,请次日重试
2580
+ - 收费结果码:
2581
+ 0: 验证结果一致。
2582
+ 1: 验证结果不一致。
2583
+
2584
+ - 不收费结果码:
2585
+ -1:查无记录。
2586
+ -2:引擎未知错误。
2587
+ -3:引擎服务异常。
2588
+ -4:姓名校验不通过。
2589
+ -5:手机号码不合法。
2590
+ -6: 认证次数超过当日限制,请次日重试。
2532
2591
  */
2533
2592
  Result?: string;
2534
2593
  /**
2535
- * 业务结果描述
2594
+ * 业务结果描述。
2536
2595
  */
2537
2596
  Description?: string;
2538
2597
  /**
@@ -2642,15 +2701,16 @@ export interface GetFaceidRiskInfoTokenRequest {
2642
2701
  */
2643
2702
  export interface BankCard2EVerificationRequest {
2644
2703
  /**
2645
- * 姓名
2704
+ * 姓名。
2646
2705
  */
2647
2706
  Name: string;
2648
2707
  /**
2649
- * 银行卡
2708
+ * 银行卡。
2650
2709
  */
2651
2710
  BankCard: string;
2652
2711
  /**
2653
- * 敏感数据加密信息。对传入信息(姓名、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2712
+ * 敏感数据加密信息。
2713
+ - 对传入信息(姓名、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2654
2714
  */
2655
2715
  Encryption?: Encryption;
2656
2716
  }
@@ -2687,20 +2747,21 @@ export interface ImageRecognitionV2Request {
2687
2747
  export interface PhoneVerificationCTCCResponse {
2688
2748
  /**
2689
2749
  * 认证结果码,收费情况如下。
2690
- 收费结果码:
2691
- 0: 认证通过
2692
- -4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)
2693
- 不收费结果码:
2694
- -6: 手机号码不合法
2695
- -7: 身份证号码有误
2696
- -8: 姓名校验不通过
2697
- -9: 没有记录
2698
- -11: 验证中心服务繁忙
2750
+ - 收费结果码:
2751
+ 0: 认证通过。
2752
+ -4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)。
2753
+
2754
+ - 不收费结果码:
2755
+ -6: 手机号码不合法。
2756
+ -7: 身份证号码有误。
2757
+ -8: 姓名校验不通过。
2758
+ -9: 没有记录。
2759
+ -11: 验证中心服务繁忙。
2699
2760
  */
2700
2761
  Result?: string;
2701
2762
  /**
2702
2763
  * 运营商名称。
2703
- 取值范围为["移动","联通","电信",""]
2764
+ - 取值范围为["移动","联通","电信",""]
2704
2765
  */
2705
2766
  Isp?: string;
2706
2767
  /**
@@ -2772,19 +2833,20 @@ export interface ParseNfcDataRequest {
2772
2833
  */
2773
2834
  export interface PhoneVerificationCTCCRequest {
2774
2835
  /**
2775
- * 身份证号
2836
+ * 身份证号。
2776
2837
  */
2777
2838
  IdCard: string;
2778
2839
  /**
2779
- * 姓名
2840
+ * 姓名。
2780
2841
  */
2781
2842
  Name: string;
2782
2843
  /**
2783
- * 手机号
2844
+ * 手机号。
2784
2845
  */
2785
2846
  Phone: string;
2786
2847
  /**
2787
- * 敏感数据加密信息。对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2848
+ * 敏感数据加密信息。
2849
+ - 对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2788
2850
  */
2789
2851
  Encryption?: Encryption;
2790
2852
  }
@@ -2820,28 +2882,31 @@ export interface ImageRecognitionRequest {
2820
2882
  */
2821
2883
  export interface BankCard4EVerificationRequest {
2822
2884
  /**
2823
- * 姓名
2885
+ * 姓名。
2824
2886
  */
2825
2887
  Name: string;
2826
2888
  /**
2827
- * 银行卡
2889
+ * 银行卡。
2828
2890
  */
2829
2891
  BankCard: string;
2830
2892
  /**
2831
- * 手机号码
2893
+ * 手机号码。
2832
2894
  */
2833
2895
  Phone: string;
2834
2896
  /**
2835
- * 开户证件号,与CertType参数的证件类型一致,如:身份证,则传入身份证号。
2897
+ * 开户证件号。
2898
+ - 与CertType参数的证件类型一致,如:身份证,则传入身份证号。
2836
2899
  */
2837
2900
  IdCard: string;
2838
2901
  /**
2839
- * 证件类型,请确认该证件为开户时使用的证件类型,未用于开户的证件信息不支持验证。
2840
- 目前默认为0:身份证,其他证件类型暂不支持。
2902
+ * 证件类型。
2903
+ - 请确认该证件为开户时使用的证件类型,未用于开户的证件信息不支持验证。
2904
+ - 目前默认为0:身份证,其他证件类型暂不支持。
2841
2905
  */
2842
2906
  CertType?: number;
2843
2907
  /**
2844
- * 敏感数据加密信息。对传入信息(姓名、身份证号、手机号、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2908
+ * 敏感数据加密信息。
2909
+ - 对传入信息(姓名、身份证号、手机号、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2845
2910
  */
2846
2911
  Encryption?: Encryption;
2847
2912
  }
@@ -2850,7 +2915,8 @@ export interface BankCard4EVerificationRequest {
2850
2915
  */
2851
2916
  export interface GetActionSequenceResponse {
2852
2917
  /**
2853
- * 动作顺序(2,1 or 1,2) 1代表张嘴,2代表闭眼。
2918
+ * 动作顺序,例如:2,1 or 1,2。
2919
+ - 1代表张嘴,2代表闭眼。
2854
2920
  */
2855
2921
  ActionSequence?: string;
2856
2922
  /**
@@ -2872,9 +2938,9 @@ export interface GetFaceIdRiskInfoRequest {
2872
2938
  */
2873
2939
  export interface GetLiveCodeResponse {
2874
2940
  /**
2875
- * 数字验证码,如:1234
2941
+ * 数字验证码。
2876
2942
  */
2877
- LiveCode: string;
2943
+ LiveCode?: string;
2878
2944
  /**
2879
2945
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2880
2946
  */
@@ -2960,15 +3026,16 @@ export interface DetectInfoIdCardData {
2960
3026
  */
2961
3027
  export interface CheckPhoneAndNameRequest {
2962
3028
  /**
2963
- * ⼿机号
3029
+ * ⼿机号。
2964
3030
  */
2965
3031
  Mobile: string;
2966
3032
  /**
2967
- * 姓名
3033
+ * 姓名。
2968
3034
  */
2969
3035
  Name: string;
2970
3036
  /**
2971
- * 敏感数据加密信息。对传入信息(姓名、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
3037
+ * 敏感数据加密信息。
3038
+ - 对传入信息(姓名、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2972
3039
  */
2973
3040
  Encryption?: Encryption;
2974
3041
  }