tencentcloud-sdk-nodejs 4.0.969 → 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 (74) hide show
  1. package/CHANGELOG.md +437 -0
  2. package/SERVICE_CHANGELOG.md +710 -44
  3. package/package.json +1 -1
  4. package/products.md +22 -22
  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/cam/v20190116/cam_models.ts +10 -10
  9. package/src/services/cds/v20180420/cds_models.ts +27 -31
  10. package/src/services/cfg/v20210820/cfg_models.ts +4 -0
  11. package/src/services/cloudaudit/v20190319/cloudaudit_client.ts +2 -2
  12. package/src/services/cloudaudit/v20190319/cloudaudit_models.ts +25 -16
  13. package/src/services/cls/v20201016/cls_models.ts +29 -9
  14. package/src/services/dasb/v20191018/dasb_models.ts +70 -166
  15. package/src/services/dcdb/v20180411/dcdb_client.ts +32 -20
  16. package/src/services/dcdb/v20180411/dcdb_models.ts +104 -40
  17. package/src/services/essbasic/v20210526/essbasic_client.ts +2 -1
  18. package/src/services/essbasic/v20210526/essbasic_models.ts +4 -3
  19. package/src/services/faceid/v20180301/faceid_models.ts +428 -361
  20. package/src/services/ioa/v20220601/ioa_client.ts +2 -3
  21. package/src/services/ioa/v20220601/ioa_models.ts +0 -8
  22. package/src/services/iss/v20230517/iss_models.ts +4 -0
  23. package/src/services/ocr/v20181119/ocr_client.ts +30 -8
  24. package/src/services/ocr/v20181119/ocr_models.ts +645 -191
  25. package/src/services/organization/v20210331/organization_models.ts +7 -3
  26. package/src/services/privatedns/v20201028/privatedns_client.ts +114 -65
  27. package/src/services/privatedns/v20201028/privatedns_models.ts +886 -766
  28. package/src/services/ssm/v20190923/ssm_models.ts +0 -2
  29. package/src/services/tdmq/v20200217/tdmq_client.ts +1 -0
  30. package/src/services/tdmq/v20200217/tdmq_models.ts +134 -119
  31. package/src/services/tke/v20180525/tke_models.ts +6 -2
  32. package/src/services/tke/v20220501/tke_models.ts +9 -0
  33. package/src/services/trp/v20210515/trp_models.ts +10 -9
  34. package/src/services/wedata/v20210820/wedata_client.ts +1 -0
  35. package/src/services/wedata/v20210820/wedata_models.ts +300 -17
  36. package/tencentcloud/common/sdk_version.d.ts +1 -1
  37. package/tencentcloud/common/sdk_version.js +1 -1
  38. package/tencentcloud/services/as/v20180419/as_models.d.ts +2 -2
  39. package/tencentcloud/services/bi/v20220105/bi_models.d.ts +25 -0
  40. package/tencentcloud/services/cam/v20190116/cam_models.d.ts +10 -10
  41. package/tencentcloud/services/cds/v20180420/cds_models.d.ts +27 -31
  42. package/tencentcloud/services/cfg/v20210820/cfg_models.d.ts +4 -0
  43. package/tencentcloud/services/cloudaudit/v20190319/cloudaudit_client.d.ts +2 -2
  44. package/tencentcloud/services/cloudaudit/v20190319/cloudaudit_client.js +2 -2
  45. package/tencentcloud/services/cloudaudit/v20190319/cloudaudit_models.d.ts +25 -16
  46. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +29 -9
  47. package/tencentcloud/services/dasb/v20191018/dasb_models.d.ts +69 -165
  48. package/tencentcloud/services/dcdb/v20180411/dcdb_client.d.ts +11 -7
  49. package/tencentcloud/services/dcdb/v20180411/dcdb_client.js +15 -9
  50. package/tencentcloud/services/dcdb/v20180411/dcdb_models.d.ts +102 -40
  51. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +2 -1
  52. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +2 -1
  53. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +4 -3
  54. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +428 -361
  55. package/tencentcloud/services/ioa/v20220601/ioa_client.d.ts +0 -1
  56. package/tencentcloud/services/ioa/v20220601/ioa_client.js +0 -1
  57. package/tencentcloud/services/ioa/v20220601/ioa_models.d.ts +0 -8
  58. package/tencentcloud/services/iss/v20230517/iss_models.d.ts +4 -0
  59. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +7 -1
  60. package/tencentcloud/services/ocr/v20181119/ocr_client.js +8 -0
  61. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +636 -192
  62. package/tencentcloud/services/organization/v20210331/organization_models.d.ts +7 -3
  63. package/tencentcloud/services/privatedns/v20201028/privatedns_client.d.ts +21 -5
  64. package/tencentcloud/services/privatedns/v20201028/privatedns_client.js +30 -6
  65. package/tencentcloud/services/privatedns/v20201028/privatedns_models.d.ts +821 -710
  66. package/tencentcloud/services/ssm/v20190923/ssm_models.d.ts +0 -2
  67. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +133 -119
  68. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +6 -2
  69. package/tencentcloud/services/tke/v20220501/tke_models.d.ts +9 -0
  70. package/tencentcloud/services/trp/v20210515/trp_models.d.ts +10 -9
  71. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +299 -17
  72. package/test/dcdb.v20180411.test.js +16 -6
  73. package/test/ocr.v20181119.test.js +10 -0
  74. package/test/privatedns.v20201028.test.js +44 -4
@@ -64,17 +64,19 @@ export interface GetFaceidRiskInfoTokenResponse {
64
64
  export interface CheckIdNameDateResponse {
65
65
  /**
66
66
  * 认证结果码,收费情况如下。
67
- 收费结果码:
68
- 0: 一致
69
- -1: 不一致
70
- 不收费结果码:
71
- -2: 非法身份证号(长度、校验位等不正确)
72
- -3: 非法姓名(长度、格式等不正确)
73
- -4: 非法有效期(长度、格式等不正确)
74
- -5: 身份信息无效
75
- -6: 证件库服务异常
76
- -7: 证件库中无此身份证记录
77
- -8: 认证次数超过当日限制,请次日重试
67
+
68
+ - 收费结果码:
69
+ 0: 一致。
70
+ -1: 不一致。
71
+
72
+ - 不收费结果码:
73
+ -2: 非法身份证号(长度、校验位等不正确)。
74
+ -3: 非法姓名(长度、格式等不正确)。
75
+ -4: 非法有效期(长度、格式等不正确)。
76
+ -5: 身份信息无效。
77
+ -6: 证件库服务异常。
78
+ -7: 证件库中无此身份证记录。
79
+ -8: 认证次数超过当日限制,请次日重试。
78
80
  */
79
81
  Result?: string
80
82
  /**
@@ -92,15 +94,16 @@ export interface CheckIdNameDateResponse {
92
94
  */
93
95
  export interface IdCardVerificationRequest {
94
96
  /**
95
- * 身份证号
97
+ * 身份证号。
96
98
  */
97
99
  IdCard: string
98
100
  /**
99
- * 姓名
101
+ * 姓名。
100
102
  */
101
103
  Name: string
102
104
  /**
103
- * 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
105
+ * 敏感数据加密信息。
106
+ - 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
104
107
  */
105
108
  Encryption?: Encryption
106
109
  }
@@ -284,11 +287,12 @@ export interface RuleIdConfig {
284
287
  */
285
288
  export interface MobileStatusRequest {
286
289
  /**
287
- * 手机号码
290
+ * 手机号码。
288
291
  */
289
292
  Mobile: string
290
293
  /**
291
- * 敏感数据加密信息。对传入信息(手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
294
+ * 敏感数据加密信息。
295
+ - 对传入信息(手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
292
296
  */
293
297
  Encryption?: Encryption
294
298
  }
@@ -459,13 +463,13 @@ BASE64编码后的大小不超过8M,支持mp4、avi、flv格式。
459
463
  */
460
464
  export interface CheckEidTokenStatusResponse {
461
465
  /**
462
- * 枚举:
463
- init:token未验证
464
- doing: 验证中
465
- finished: 验证完成
466
- timeout: token已超时
466
+ * 状态。
467
+ - init:EidToken未验证。
468
+ - doing: EidToken验证中。
469
+ - finished: EidToken验证完成。
470
+ - timeout: EidToken已超时。
467
471
  */
468
- Status: string
472
+ Status?: string
469
473
  /**
470
474
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
471
475
  */
@@ -606,27 +610,33 @@ export interface GetFaceIdRiskInfoResponse {
606
610
  */
607
611
  export interface LivenessCompareResponse {
608
612
  /**
609
- * 验证通过后的视频最佳截图照片,照片为BASE64编码后的值,jpg格式。
613
+ * 验证通过后的视频最佳截图照片。
614
+ - 照片为BASE64编码后的值,jpg格式。
610
615
  注意:此字段可能返回 null,表示取不到有效值。
611
616
  */
612
- BestFrameBase64: string
617
+ BestFrameBase64?: string
613
618
  /**
614
- * 相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)。
619
+ * 相似度。
620
+ - 取值范围 [0.00, 100.00]。
621
+ - 推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)。
615
622
  */
616
- Sim: number
623
+ Sim?: number
617
624
  /**
618
- * 业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
625
+ * 业务错误码。
626
+ - 成功情况返回Success。
627
+ - 错误情况请参考下方错误码,列表中FailedOperation部分。
619
628
  */
620
- Result: string
629
+ Result?: string
621
630
  /**
622
631
  * 业务结果描述。
623
632
  */
624
- Description: string
633
+ Description?: string
625
634
  /**
626
- * 最佳截图列表,仅在配置了返回多张最佳截图时返回。
635
+ * 最佳截图列表。
636
+ - 仅在配置了返回多张最佳截图时返回。
627
637
  注意:此字段可能返回 null,表示取不到有效值。
628
638
  */
629
- BestFrameList: Array<string>
639
+ BestFrameList?: Array<string>
630
640
  /**
631
641
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
632
642
  */
@@ -638,27 +648,28 @@ export interface LivenessCompareResponse {
638
648
  */
639
649
  export interface BankCard2EVerificationResponse {
640
650
  /**
641
- * 认证结果码
642
- 计费结果码:
643
- '0': '认证通过'
644
- '-1': '认证未通过'
645
- '-4': '持卡人信息有误'
646
- '-5': '未开通无卡支付'
647
- '-6': '此卡被没收'
648
- '-7': '无效卡号'
649
- '-8': '此卡无对应发卡行'
650
- '-9': '该卡未初始化或睡眠卡'
651
- '-10': '作弊卡、吞卡'
652
- '-11': '此卡已挂失'
653
- '-12': '该卡已过期'
654
- '-13': '受限制的卡'
655
- '-14': '密码错误次数超限'
656
- '-15': '发卡行不支持此交易'
657
- 不计费结果码:
658
- '-2': '姓名校验不通过'
659
- '-3': '银行卡号码有误'
660
- '-16': '验证中心服务繁忙'
661
- '-17': '验证次数超限,请次日重试'
651
+ * 认证结果码。
652
+ - 计费结果码:
653
+ '0': '认证通过'
654
+ '-1': '认证未通过'
655
+ '-4': '持卡人信息有误'
656
+ '-5': '未开通无卡支付'
657
+ '-6': '此卡被没收'
658
+ '-7': '无效卡号'
659
+ '-8': '此卡无对应发卡行'
660
+ '-9': '该卡未初始化或睡眠卡'
661
+ '-10': '作弊卡、吞卡'
662
+ '-11': '此卡已挂失'
663
+ '-12': '该卡已过期'
664
+ '-13': '受限制的卡'
665
+ '-14': '密码错误次数超限'
666
+ '-15': '发卡行不支持此交易'
667
+
668
+ - 不计费结果码:
669
+ '-2': '姓名校验不通过'
670
+ '-3': '银行卡号码有误'
671
+ '-16': '验证中心服务繁忙'
672
+ '-17': '验证次数超限,请次日重试'。
662
673
 
663
674
  */
664
675
  Result?: string
@@ -678,13 +689,14 @@ export interface BankCard2EVerificationResponse {
678
689
  export interface MobileStatusResponse {
679
690
  /**
680
691
  * 认证结果码,收费情况如下。
681
- 收费结果码:
682
- 0:成功
683
- 不收费结果码:
684
- -1:未查询到结果
685
- -2:手机号格式不正确
686
- -3:验证中心服务繁忙
687
- -4:认证次数超过当日限制,请次日重试
692
+ - 收费结果码:
693
+ 0:成功。
694
+
695
+ - 不收费结果码:
696
+ -1:未查询到结果。
697
+ -2:手机号格式不正确。
698
+ -3:验证中心服务繁忙。
699
+ -4:认证次数超过当日限制,请次日重试。
688
700
  */
689
701
  Result?: string
690
702
  /**
@@ -692,13 +704,14 @@ export interface MobileStatusResponse {
692
704
  */
693
705
  Description?: string
694
706
  /**
695
- * 状态码:
696
- 0:正常
697
- 1:停机
698
- 2:销号
699
- 3:空号
700
- 4:不在网
701
- 99:未知状态
707
+ * 状态码。
708
+ - 取值范围:
709
+ 0:正常。
710
+ 1:停机。
711
+ 2:销号。
712
+ 3:空号。
713
+ 4:不在网。
714
+ 99:未知状态。
702
715
  */
703
716
  StatusCode?: number
704
717
  /**
@@ -840,12 +853,12 @@ LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模
840
853
  export interface DetectAIFakeFacesRequest {
841
854
  /**
842
855
  * 传入需要进行检测的带有人脸的图片或视频,使用base64编码的形式。
856
+ - 图片的Base64值:
857
+ 建议整体图像480x640的分辨率,脸部 大小 100X100 以上。
858
+ Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。
859
+ 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
843
860
 
844
- 图片的Base64值:
845
- 建议整体图像480x640的分辨率,脸部 大小 100X100 以上;
846
- Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
847
-
848
- 视频的Base64值:
861
+ - 视频的Base64值:
849
862
  Base64编码后的大小不超过8M,支持mp4、avi、flv格式。
850
863
  请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
851
864
  视频时长最大支持20s,建议时长2~5s。
@@ -853,18 +866,22 @@ Base64编码后的大小不超过8M,支持mp4、avi、flv格式。
853
866
  */
854
867
  FaceInput?: string
855
868
  /**
856
- * 传入的类型
857
- 1- 传入的是图片类型
858
- 2- 传入的是视频类型
859
- 其他 - 返回错误码InvalidParameter
869
+ * 传入的类型。
870
+ - 取值范围:
871
+ 1:传入的是图片类型。
872
+ 2:传入的是视频类型。
873
+ 其他:返回错误码InvalidParameter。
860
874
  */
861
875
  FaceInputType?: number
862
876
  /**
863
- * 是否需要对请求信息进行全包体加密; 支持的加密算法:AES-256-CBC、SM4-GCM; 有加密需求的用户可使用此参数,详情请点击左侧链接。
877
+ * 是否需要对请求信息进行全包体加密。
878
+ - 支持的加密算法:AES-256-CBC、SM4-GCM。
879
+ - 有加密需求的用户可使用此参数,详情请点击左侧链接。
864
880
  */
865
881
  Encryption?: Encryption
866
882
  /**
867
- * 加密后的密文; 加密前的数据格式如下:{"FaceInput":"AAAAA","FaceInputType":1}
883
+ * 加密后的密文。
884
+ - 加密前的数据格式如下:{"FaceInput":"AAAAA","FaceInputType":1}。
868
885
  */
869
886
  EncryptedBody?: string
870
887
  }
@@ -875,10 +892,11 @@ Base64编码后的大小不超过8M,支持mp4、avi、flv格式。
875
892
  export interface CheckBankCardInformationResponse {
876
893
  /**
877
894
  * 认证结果码,收费情况如下。
878
- 收费结果码:
895
+ - 收费结果码:
879
896
  0: 查询成功
880
897
  -1: 未查到信息
881
- 不收费结果码:
898
+
899
+ - 不收费结果码:
882
900
  -2:验证中心服务繁忙
883
901
  -3:银行卡不存在
884
902
  -4:认证次数超过当日限制,请次日重试
@@ -886,15 +904,20 @@ export interface CheckBankCardInformationResponse {
886
904
  */
887
905
  Result?: string
888
906
  /**
889
- * 业务结果描述
907
+ * 业务结果描述。
890
908
  */
891
909
  Description?: string
892
910
  /**
893
- * 开户行
911
+ * 开户行。
894
912
  */
895
913
  AccountBank?: string
896
914
  /**
897
- * 卡性质:1. 借记卡;2. 贷记卡;3. 预付费卡;4. 准贷记卡
915
+ * 卡性质。
916
+ - 取值范围:
917
+ 1:借记卡。
918
+ 2:贷记卡。
919
+ 3:预付费卡。
920
+ 4:准贷记卡
898
921
  */
899
922
  AccountType?: number
900
923
  /**
@@ -943,23 +966,26 @@ export interface GetEidTokenRequest {
943
966
  */
944
967
  export interface CheckIdNameDateRequest {
945
968
  /**
946
- * 姓名
969
+ * 姓名。
947
970
  */
948
971
  Name: string
949
972
  /**
950
- * 身份证号
973
+ * 身份证号。
951
974
  */
952
975
  IdCard: string
953
976
  /**
954
- * 身份证有效期开始时间,格式:YYYYMMDD。如:20210701
977
+ * 身份证有效期开始时间。
978
+ - 格式:YYYYMMDD,如:20210701。
955
979
  */
956
980
  ValidityBegin: string
957
981
  /**
958
- * 身份证有效期到期时间,格式:YYYYMMDD,长期用“00000000”代替;如:20210701
982
+ * 身份证有效期到期时间。
983
+ 格式:YYYYMMDD,长期用“00000000”代替,如:20210701。
959
984
  */
960
985
  ValidityEnd: string
961
986
  /**
962
- * 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
987
+ * 敏感数据加密信息。
988
+ - 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
963
989
  */
964
990
  Encryption?: Encryption
965
991
  }
@@ -1109,20 +1135,20 @@ null - 未获取到风险等级
1109
1135
  */
1110
1136
  export interface DetectAIFakeFacesResponse {
1111
1137
  /**
1112
- * 检测到的图片是否存在攻击:
1113
- Low:无攻击风险
1114
- Mid:中度疑似攻击
1115
- High:高度疑似攻击
1138
+ * 检测到的图片是否存在攻击。
1139
+ - Low:无攻击风险。
1140
+ - Mid:中度疑似攻击。
1141
+ - High:高度疑似攻击。
1116
1142
  */
1117
1143
  AttackRiskLevel?: string
1118
1144
  /**
1119
- * 检测到疑似的攻击痕迹列表
1120
- 说明:未检测到攻击痕迹时,返回空数组
1121
- 此出参仅作为结果判断的参考,实际应用仍建议使用AttackRiskLevel的结果。
1145
+ * 检测到疑似的攻击痕迹列表。
1146
+ - 说明:未检测到攻击痕迹时,返回空数组。
1147
+ - 此出参仅作为结果判断的参考,实际应用仍建议使用AttackRiskLevel的结果。
1122
1148
  */
1123
1149
  AttackRiskDetailList?: Array<AttackRiskDetail>
1124
1150
  /**
1125
- * 额外信息
1151
+ * 额外信息。
1126
1152
  */
1127
1153
  ExtraInfo?: ExtraInfo
1128
1154
  /**
@@ -1173,53 +1199,55 @@ export interface IntentionVerifyData {
1173
1199
  */
1174
1200
  export interface LivenessCompareRequest {
1175
1201
  /**
1176
- * 活体检测类型,取值:LIP/ACTION/SILENT。
1177
- LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。
1202
+ * 活体检测类型。
1203
+ - 取值:LIP/ACTION/SILENT
1204
+ - LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。
1178
1205
  */
1179
1206
  LivenessType: string
1180
1207
  /**
1181
- * 用于人脸比对的照片的Base64值;
1182
- Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。
1183
- 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
1184
-
1185
- 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageBase64。
1208
+ * 用于人脸比对的照片的Base64值。
1209
+ - Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。
1210
+ - 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
1211
+ - 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageBase64。
1186
1212
  */
1187
1213
  ImageBase64?: string
1188
1214
  /**
1189
- * 用于人脸比对照片的URL地址;图片下载后经Base64编码后的数据大小不超过3M,仅支持jpg、png格式。
1190
-
1191
- 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageBase64。
1192
-
1193
- 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
1215
+ * 用于人脸比对照片的URL地址。
1216
+ - 图片下载后经Base64编码后的数据大小不超过3M,仅支持jpg、png格式。
1217
+ - 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageBase64。
1218
+ - 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
1219
+ - 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
1194
1220
  */
1195
1221
  ImageUrl?: string
1196
1222
  /**
1197
- * 数字模式传参:传数字验证码,验证码需先调用<a href="https://cloud.tencent.com/document/product/1007/31821">获取数字验证码接口</a>得到;
1198
- 动作模式传参:传动作顺序,动作顺序需先调用<a href="https://cloud.tencent.com/document/product/1007/31822">获取动作顺序接口</a>得到;
1199
- 静默模式传参:空。
1223
+ * 验证数据。
1224
+ - 数字模式传参:传数字验证码,验证码需先调用<a href="https://cloud.tencent.com/document/product/1007/31821">获取数字验证码接口</a>得到;
1225
+ - 动作模式传参:传动作顺序,动作顺序需先调用<a href="https://cloud.tencent.com/document/product/1007/31822">获取动作顺序接口</a>得到;
1226
+ - 静默模式传参:空。
1200
1227
  */
1201
1228
  ValidateData?: string
1202
1229
  /**
1203
1230
  * 额外配置,传入JSON字符串。
1231
+
1232
+ - 格式如下:
1204
1233
  {
1205
1234
  "BestFrameNum": 2 //需要返回多张最佳截图,取值范围2-10
1206
1235
  }
1207
1236
  */
1208
1237
  Optional?: string
1209
1238
  /**
1210
- * 用于活体检测的视频,视频的Base64值;
1211
- Base64编码后的大小不超过8M,支持mp4、avi、flv格式。
1212
- 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
1213
-
1214
- 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
1239
+ * 用于活体检测的视频,视频的Base64值。
1240
+ - Base64编码后的大小不超过8M,支持mp4、avi、flv格式。
1241
+ - 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
1242
+ - 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
1215
1243
  */
1216
1244
  VideoBase64?: string
1217
1245
  /**
1218
- * 用于活体检测的视频Url 地址。视频下载后经Base64编码后不超过 8M,视频下载耗时不超过4S,支持mp4、avi、flv格式。
1219
-
1220
- 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
1221
-
1222
- 建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议视频存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
1246
+ * 用于活体检测的视频Url 地址。
1247
+ - 视频下载后经Base64编码后不超过 8M,视频下载耗时不超过4S,支持mp4、avi、flv格式。
1248
+ - 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
1249
+ - 建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议视频存储于腾讯云。
1250
+ - 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
1223
1251
  */
1224
1252
  VideoUrl?: string
1225
1253
  }
@@ -1349,7 +1377,8 @@ export interface CheckBankCardInformationRequest {
1349
1377
  */
1350
1378
  BankCard: string
1351
1379
  /**
1352
- * 敏感数据加密信息。对传入信息(银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1380
+ * 敏感数据加密信息。
1381
+ - 对传入信息(银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1353
1382
  */
1354
1383
  Encryption?: Encryption
1355
1384
  }
@@ -1359,24 +1388,27 @@ export interface CheckBankCardInformationRequest {
1359
1388
  */
1360
1389
  export interface BankCardVerificationRequest {
1361
1390
  /**
1362
- * 开户证件号,与CertType参数的证件类型一致,如:身份证,则传入身份证号。
1391
+ * 开户证件号。
1392
+ - 与CertType参数的证件类型一致,如:身份证,则传入身份证号。
1363
1393
  */
1364
1394
  IdCard: string
1365
1395
  /**
1366
- * 姓名
1396
+ * 姓名。
1367
1397
  */
1368
1398
  Name: string
1369
1399
  /**
1370
- * 银行卡
1400
+ * 银行卡。
1371
1401
  */
1372
1402
  BankCard: string
1373
1403
  /**
1374
- * 证件类型,请确认该证件为开户时使用的证件类型,未用于开户的证件信息不支持验证。
1375
- 目前默认:0 身份证,其他证件类型暂不支持。
1404
+ * 证件类型。
1405
+ - 请确认该证件为开户时使用的证件类型,未用于开户的证件信息不支持验证。
1406
+ - 目前默认:0 身份证,其他证件类型暂不支持。
1376
1407
  */
1377
1408
  CertType?: number
1378
1409
  /**
1379
- * 敏感数据加密信息。对传入信息(姓名、身份证号、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1410
+ * 敏感数据加密信息。
1411
+ - 对传入信息(姓名、身份证号、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1380
1412
  */
1381
1413
  Encryption?: Encryption
1382
1414
  }
@@ -1424,11 +1456,15 @@ export interface GetWeChatBillDetailsResponse {
1424
1456
  */
1425
1457
  export interface CheckIdCardInformationResponse {
1426
1458
  /**
1427
- * 相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
1459
+ * 相似度。
1460
+ - 取值范围 [0.00, 100.00]。
1461
+ - 推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)。
1428
1462
  */
1429
1463
  Sim?: number
1430
1464
  /**
1431
- * 业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
1465
+ * 业务错误码。
1466
+ - 成功情况返回Success,。
1467
+ - 错误情况请参考下方错误码 列表中FailedOperation部分
1432
1468
  */
1433
1469
  Result?: string
1434
1470
  /**
@@ -1436,27 +1472,27 @@ export interface CheckIdCardInformationResponse {
1436
1472
  */
1437
1473
  Description?: string
1438
1474
  /**
1439
- * 姓名
1475
+ * 姓名。
1440
1476
  */
1441
1477
  Name?: string
1442
1478
  /**
1443
- * 性别
1479
+ * 性别。
1444
1480
  */
1445
1481
  Sex?: string
1446
1482
  /**
1447
- * 民族
1483
+ * 民族。
1448
1484
  */
1449
1485
  Nation?: string
1450
1486
  /**
1451
- * 出生日期
1487
+ * 出生日期。
1452
1488
  */
1453
1489
  Birth?: string
1454
1490
  /**
1455
- * 地址
1491
+ * 地址。
1456
1492
  */
1457
1493
  Address?: string
1458
1494
  /**
1459
- * 身份证号
1495
+ * 身份证号。
1460
1496
  */
1461
1497
  IdNum?: string
1462
1498
  /**
@@ -1464,20 +1500,24 @@ export interface CheckIdCardInformationResponse {
1464
1500
  */
1465
1501
  Portrait?: string
1466
1502
  /**
1467
- * 告警信息,当在Config中配置了告警信息会停止人像比对,Result返回错误(FailedOperation.OcrWarningOccurred)并有此告警信息,Code 告警码列表和释义:
1503
+ * 告警信息。
1504
+ - 当在Config中配置了告警信息会停止人像比对,Result返回错误(FailedOperation.OcrWarningOccurred)并有此告警信息。
1505
+ - Code 告警码列表和释义:
1506
+ '-9101':身份证边框不完整告警。
1507
+ '-9102':身份证复印件告警。
1508
+ '-9103':身份证翻拍告警。
1509
+ '-9105':身份证框内遮挡告警。
1510
+ '-9104':临时身份证告警。
1511
+ '-9106':身份证 PS 告警(疑似存在PS痕迹)。
1512
+ '-8001':图片模糊告警。
1468
1513
 
1469
- -9101 身份证边框不完整告警,
1470
- -9102 身份证复印件告警,
1471
- -9103 身份证翻拍告警,
1472
- -9105 身份证框内遮挡告警,
1473
- -9104 临时身份证告警,
1474
- -9106 身份证 PS 告警(疑似存在PS痕迹)。
1475
- -8001 图片模糊告警
1476
- 多个会 | 隔开如 "-9101|-9106|-9104"
1514
+ - 多个会用“|” 隔开,如 "-9101|-9106|-9104"。
1477
1515
  */
1478
1516
  Warnings?: string
1479
1517
  /**
1480
- * 图片质量分数,当请求Config中配置图片模糊告警该参数才有意义,取值范围(0~100),目前默认阈值是50分,低于50分会触发模糊告警。
1518
+ * 图片质量分数。
1519
+ - 当请求Config中配置图片模糊告警该参数才有意义。
1520
+ - 取值范围(0~100),目前默认阈值是50分,低于50分会触发模糊告警。
1481
1521
  */
1482
1522
  Quality?: number
1483
1523
  /**
@@ -1486,7 +1526,7 @@ export interface CheckIdCardInformationResponse {
1486
1526
  */
1487
1527
  Encryption?: Encryption
1488
1528
  /**
1489
- * 加密后的数据
1529
+ * 加密后的数据。
1490
1530
  */
1491
1531
  EncryptedBody?: string
1492
1532
  /**
@@ -1547,17 +1587,18 @@ export interface DetectAuthResponse {
1547
1587
  */
1548
1588
  export interface PhoneVerificationResponse {
1549
1589
  /**
1550
- * 认证结果码:
1551
- 收费结果码
1552
- 0: 三要素信息一致
1553
- -4: 三要素信息不一致
1554
- 不收费结果码
1555
- -6: 手机号码不合法
1556
- -7: 身份证号码有误
1557
- -8: 姓名校验不通过
1558
- -9: 没有记录
1559
- -11: 验证中心服务繁忙
1560
- -12: 认证次数超过当日限制,请次日重试
1590
+ * 认证结果码。
1591
+ - 收费结果码
1592
+ 0: 三要素信息一致。
1593
+ -4: 三要素信息不一致。
1594
+
1595
+ - 不收费结果码
1596
+ -6: 手机号码不合法。
1597
+ -7: 身份证号码有误。
1598
+ -8: 姓名校验不通过。
1599
+ -9: 没有记录。
1600
+ -11: 验证中心服务繁忙。
1601
+ -12: 认证次数超过当日限制,请次日重试。
1561
1602
  */
1562
1603
  Result?: string
1563
1604
  /**
@@ -1566,17 +1607,18 @@ export interface PhoneVerificationResponse {
1566
1607
  Description?: string
1567
1608
  /**
1568
1609
  * 运营商名称。
1569
- 取值范围为["","移动","电信","联通"]
1610
+ - 取值范围为["","移动","电信","联通"]
1570
1611
  */
1571
1612
  Isp?: string
1572
1613
  /**
1573
- * 业务结果详细信息。(当VerifyMode配置"详版",且Result为"-4: 三要素信息不一致"时返回)
1574
- 枚举值:
1575
- PhoneIdCardMismatch:手机号码与姓名一致,与身份证号不一致;
1576
- PhoneNameMismatch:手机号码身份证号一致,与姓名不一致;
1577
- PhoneNameIdCardMismatch:手机号码与姓名和身份证号均不一致;
1578
- NameIdCardMismatch:姓名和身份证号不一致;
1579
- OtherMismatch:其他不一致;
1614
+ * 业务结果详细信息。
1615
+ - 当VerifyMode配置"详版",且Result为"-4: 三要素信息不一致"时返回。
1616
+ - 枚举值:
1617
+ PhoneIdCardMismatch:手机号码与姓名一致,与身份证号不一致。
1618
+ PhoneNameMismatch:手机号码身份证号一致,与姓名不一致。
1619
+ PhoneNameIdCardMismatch:手机号码与姓名和身份证号均不一致。
1620
+ NameIdCardMismatch:姓名和身份证号不一致。
1621
+ OtherMismatch:其他不一致。
1580
1622
  */
1581
1623
  ResultDetail?: string
1582
1624
  /**
@@ -1590,30 +1632,32 @@ OtherMismatch:其他不一致;
1590
1632
  */
1591
1633
  export interface IdCardOCRVerificationRequest {
1592
1634
  /**
1593
- * 身份证号
1594
- 姓名和身份证号、ImageBase64、ImageUrl三者必须提供其中之一。若都提供了,则按照姓名和身份证号>ImageBase64>ImageUrl的优先级使用参数。
1635
+ * 身份证号。
1636
+ - 姓名和身份证号、ImageBase64、ImageUrl三者必须提供其中之一。
1637
+ - 若都提供了,则按照姓名和身份证号>ImageBase64>ImageUrl的优先级使用参数。
1595
1638
  */
1596
1639
  IdCard?: string
1597
1640
  /**
1598
- * 姓名
1641
+ * 姓名。
1599
1642
  */
1600
1643
  Name?: string
1601
1644
  /**
1602
- * 身份证人像面的 Base64
1603
- 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
1604
- 支持的图片大小:所下载图片经Base64编码后不超过 3M。请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
1645
+ * 身份证人像面的 Base64 值。
1646
+ - 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
1647
+ - 支持的图片大小:所下载图片经Base64编码后不超过 3M。请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
1605
1648
  */
1606
1649
  ImageBase64?: string
1607
1650
  /**
1608
- * 身份证人像面的 Url 地址
1609
- 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
1610
- 支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。
1611
- 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
1612
- 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
1651
+ * 身份证人像面的 Url 地址。
1652
+ - 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
1653
+ - 支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。
1654
+ - 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
1655
+ - 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
1613
1656
  */
1614
1657
  ImageUrl?: string
1615
1658
  /**
1616
- * 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1659
+ * 敏感数据加密信息。
1660
+ - 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1617
1661
  */
1618
1662
  Encryption?: Encryption
1619
1663
  }
@@ -1623,30 +1667,31 @@ export interface IdCardOCRVerificationRequest {
1623
1667
  */
1624
1668
  export interface BankCard4EVerificationResponse {
1625
1669
  /**
1626
- * 认证结果码
1627
- 收费结果码:
1628
- '0': '认证通过'
1629
- '-1': '认证未通过'
1630
- '-6': '持卡人信息有误'
1631
- '-7': '未开通无卡支付'
1632
- '-8': '此卡被没收'
1633
- '-9': '无效卡号'
1634
- '-10': '此卡无对应发卡行'
1635
- '-11': '该卡未初始化或睡眠卡'
1636
- '-12': '作弊卡、吞卡'
1637
- '-13': '此卡已挂失'
1638
- '-14': '该卡已过期'
1639
- '-15': '受限制的卡'
1640
- '-16': '密码错误次数超限'
1641
- '-17': '发卡行不支持此交易'
1642
- 不收费结果码:
1643
- '-2': '姓名校验不通过'
1644
- '-3': '身份证号码有误'
1645
- '-4': '银行卡号码有误'
1646
- '-5': '手机号码不合法'
1647
- '-18': '验证中心服务繁忙'
1648
- '-19': '验证次数超限,请次日重试'
1649
- '-20': '该证件号暂不支持核验,当前仅支持二代身份证'
1670
+ * 认证结果码。
1671
+ - 收费结果码:
1672
+ '0': '认证通过'
1673
+ '-1': '认证未通过'
1674
+ '-6': '持卡人信息有误'
1675
+ '-7': '未开通无卡支付'
1676
+ '-8': '此卡被没收'
1677
+ '-9': '无效卡号'
1678
+ '-10': '此卡无对应发卡行'
1679
+ '-11': '该卡未初始化或睡眠卡'
1680
+ '-12': '作弊卡、吞卡'
1681
+ '-13': '此卡已挂失'
1682
+ '-14': '该卡已过期'
1683
+ '-15': '受限制的卡'
1684
+ '-16': '密码错误次数超限'
1685
+ '-17': '发卡行不支持此交易'
1686
+
1687
+ - 不收费结果码:
1688
+ '-2': '姓名校验不通过'
1689
+ '-3': '身份证号码有误'
1690
+ '-4': '银行卡号码有误'
1691
+ '-5': '手机号码不合法'
1692
+ '-18': '验证中心服务繁忙'
1693
+ '-19': '验证次数超限,请次日重试'
1694
+ '-20': '该证件号暂不支持核验,当前仅支持二代身份证'。
1650
1695
  */
1651
1696
  Result?: string
1652
1697
  /**
@@ -1695,11 +1740,12 @@ export interface Encryption {
1695
1740
  */
1696
1741
  export interface MobileNetworkTimeVerificationRequest {
1697
1742
  /**
1698
- * 手机号码
1743
+ * 手机号码。
1699
1744
  */
1700
1745
  Mobile: string
1701
1746
  /**
1702
- * 敏感数据加密信息。对传入信息(手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1747
+ * 敏感数据加密信息。
1748
+ - 对传入信息(手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1703
1749
  */
1704
1750
  Encryption?: Encryption
1705
1751
  }
@@ -1710,20 +1756,21 @@ export interface MobileNetworkTimeVerificationRequest {
1710
1756
  export interface PhoneVerificationCMCCResponse {
1711
1757
  /**
1712
1758
  * 认证结果码,收费情况如下。
1713
- 收费结果码:
1714
- 0: 认证通过
1715
- -4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)
1716
- 不收费结果码:
1717
- -6: 手机号码不合法
1718
- -7: 身份证号码有误
1719
- -8: 姓名校验不通过
1720
- -9: 没有记录
1721
- -11: 验证中心服务繁忙
1759
+ - 收费结果码:
1760
+ 0: 认证通过。
1761
+ -4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)。
1762
+
1763
+ - 不收费结果码:
1764
+ -6: 手机号码不合法。
1765
+ -7: 身份证号码有误。
1766
+ -8: 姓名校验不通过。
1767
+ -9: 没有记录。
1768
+ -11: 验证中心服务繁忙。
1722
1769
  */
1723
1770
  Result?: string
1724
1771
  /**
1725
1772
  * 运营商名称。
1726
- 取值范围为["移动","联通","电信",""]
1773
+ - 取值范围为["移动","联通","电信",""]
1727
1774
  */
1728
1775
  Isp?: string
1729
1776
  /**
@@ -1742,14 +1789,15 @@ export interface PhoneVerificationCMCCResponse {
1742
1789
  export interface MobileNetworkTimeVerificationResponse {
1743
1790
  /**
1744
1791
  * 认证结果码,收费情况如下。
1745
- 收费结果码:
1746
- 0: 成功
1747
- -2: 手机号不存在
1748
- -3: 手机号存在,但无法查询到在网时长
1749
- 不收费结果码:
1750
- -1: 手机号格式不正确
1751
- -4: 验证中心服务繁忙
1752
- -5:认证次数超过当日限制,请次日重试
1792
+ - 收费结果码:
1793
+ 0: 成功。
1794
+ -2: 手机号不存在。
1795
+ -3: 手机号存在,但无法查询到在网时长。
1796
+
1797
+ - 不收费结果码:
1798
+ -1: 手机号格式不正确。
1799
+ -4: 验证中心服务繁忙。
1800
+ -5:认证次数超过当日限制,请次日重试。
1753
1801
  */
1754
1802
  Result?: string
1755
1803
  /**
@@ -1758,7 +1806,8 @@ export interface MobileNetworkTimeVerificationResponse {
1758
1806
  Description?: string
1759
1807
  /**
1760
1808
  * 在网时长区间。
1761
- 格式为(a,b],表示在网时长在a个月以上,b个月以下。若b为+时表示没有上限。
1809
+ - 格式为(a,b],表示在网时长在a个月以上,b个月以下。
1810
+ - 若b为+时表示没有上限。
1762
1811
  */
1763
1812
  Range?: string
1764
1813
  /**
@@ -1773,20 +1822,21 @@ export interface MobileNetworkTimeVerificationResponse {
1773
1822
  export interface PhoneVerificationCUCCResponse {
1774
1823
  /**
1775
1824
  * 认证结果码,收费情况如下。
1776
- 收费结果码:
1777
- 0: 认证通过
1778
- -4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)
1779
- 不收费结果码:
1780
- -6: 手机号码不合法
1781
- -7: 身份证号码有误
1782
- -8: 姓名校验不通过
1783
- -9: 没有记录
1784
- -11: 验证中心服务繁忙
1825
+ - 收费结果码:
1826
+ 0: 认证通过。
1827
+ -4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)。
1828
+
1829
+ - 不收费结果码:
1830
+ -6: 手机号码不合法。
1831
+ -7: 身份证号码有误。
1832
+ -8: 姓名校验不通过。
1833
+ -9: 没有记录。
1834
+ -11: 验证中心服务繁忙。
1785
1835
  */
1786
1836
  Result?: string
1787
1837
  /**
1788
1838
  * 运营商名称。
1789
- 取值范围为["移动","联通","电信",""]
1839
+ - 取值范围为["移动","联通","电信",""]
1790
1840
  */
1791
1841
  Isp?: string
1792
1842
  /**
@@ -1804,43 +1854,46 @@ export interface PhoneVerificationCUCCResponse {
1804
1854
  */
1805
1855
  export interface CheckIdCardInformationRequest {
1806
1856
  /**
1807
- * 身份证人像面的 Base64
1808
- 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
1809
- 支持的图片大小:所下载图片经Base64编码后不超过 7M。
1810
- 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
1811
- ImageBase64、ImageUrl二者必须提供其中之一。若都提供了,则按照ImageUrl>ImageBase64的优先级使用参数。
1857
+ * 身份证人像面的 Base64 值。
1858
+ - 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
1859
+ - 支持的图片大小:所下载图片经Base64编码后不超过 7M。
1860
+ - 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
1861
+ - ImageBase64、ImageUrl二者必须提供其中之一。若都提供了,则按照ImageUrl>ImageBase64的优先级使用参数。
1812
1862
  */
1813
1863
  ImageBase64?: string
1814
1864
  /**
1815
1865
  * 身份证人像面的 Url 地址
1816
- 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
1817
- 支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。
1818
- 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
1819
- 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
1866
+ - 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
1867
+ - 支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。
1868
+ - 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
1869
+ - 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
1820
1870
  */
1821
1871
  ImageUrl?: string
1822
1872
  /**
1823
- * 以下可选字段均为bool 类型,默认false:
1824
- CopyWarn,复印件告警
1825
- BorderCheckWarn,边框和框内遮挡告警
1826
- ReshootWarn,翻拍告警
1827
- DetectPsWarn,PS检测告警(疑似存在PS痕迹)
1828
- TempIdWarn,临时身份证告警
1829
- Quality,图片质量告警(评价图片模糊程度)
1873
+ * 配置。
1874
+ - 以下可选字段均为bool 类型,默认false。
1875
+ CopyWarn,复印件告警。
1876
+ BorderCheckWarn,边框和框内遮挡告警。
1877
+ ReshootWarn,翻拍告警。
1878
+ DetectPsWarn,PS检测告警(疑似存在PS痕迹)。
1879
+ TempIdWarn,临时身份证告警。
1880
+ Quality,图片质量告警(评价图片模糊程度)。
1830
1881
 
1831
- SDK 设置方式参考:
1832
- Config = Json.stringify({"CopyWarn":true,"ReshootWarn":true})
1833
- API 3.0 Explorer 设置方式参考:
1834
- Config = {"CopyWarn":true,"ReshootWarn":true}
1882
+ - SDK 设置方式参考:
1883
+ Config = Json.stringify({"CopyWarn":true,"ReshootWarn":true})
1884
+
1885
+ - API 3.0 Explorer 设置方式参考:
1886
+ Config = {"CopyWarn":true,"ReshootWarn":true}。
1835
1887
  */
1836
1888
  Config?: string
1837
1889
  /**
1838
- * 是否需要对返回中的敏感信息进行加密。默认false。
1839
- 其中敏感信息包括:Response.IdNum、Response.Name
1890
+ * 是否需要对返回中的敏感信息进行加密。
1891
+ - 默认false。
1892
+ - 敏感信息包括:Response.IdNum、Response.Name。
1840
1893
  */
1841
1894
  IsEncrypt?: boolean
1842
1895
  /**
1843
- * 是否需要对响应体加密
1896
+ * 是否需要对响应体加密。
1844
1897
  */
1845
1898
  IsEncryptResponse?: boolean
1846
1899
  /**
@@ -1962,29 +2015,30 @@ export interface GetWeChatBillDetailsRequest {
1962
2015
  */
1963
2016
  export interface BankCardVerificationResponse {
1964
2017
  /**
1965
- * 认证结果码
1966
- 收费结果码:
1967
- '0': '认证通过'
1968
- '-1': '认证未通过'
1969
- '-5': '持卡人信息有误'
1970
- '-6': '未开通无卡支付'
1971
- '-7': '此卡被没收'
1972
- '-8': '无效卡号'
1973
- '-9': '此卡无对应发卡行'
1974
- '-10': '该卡未初始化或睡眠卡'
1975
- '-11': '作弊卡、吞卡'
1976
- '-12': '此卡已挂失'
1977
- '-13': '该卡已过期'
1978
- '-14': '受限制的卡'
1979
- '-15': '密码错误次数超限'
1980
- '-16': '发卡行不支持此交易'
1981
- 不收费结果码:
1982
- '-2': '姓名校验不通过'
1983
- '-3': '身份证号码有误'
1984
- '-4': '银行卡号码有误'
1985
- '-17': '验证中心服务繁忙'
1986
- '-18': '验证次数超限,请次日重试'
1987
- '-19': '该证件号暂不支持核验,当前仅支持二代身份证'
2018
+ * 认证结果码。
2019
+ - 收费结果码:
2020
+ '0': '认证通过'
2021
+ '-1': '认证未通过'
2022
+ '-5': '持卡人信息有误'
2023
+ '-6': '未开通无卡支付'
2024
+ '-7': '此卡被没收'
2025
+ '-8': '无效卡号'
2026
+ '-9': '此卡无对应发卡行'
2027
+ '-10': '该卡未初始化或睡眠卡'
2028
+ '-11': '作弊卡、吞卡'
2029
+ '-12': '此卡已挂失'
2030
+ '-13': '该卡已过期'
2031
+ '-14': '受限制的卡'
2032
+ '-15': '密码错误次数超限'
2033
+ '-16': '发卡行不支持此交易'
2034
+
2035
+ - 不收费结果码:
2036
+ '-2': '姓名校验不通过'
2037
+ '-3': '身份证号码有误'
2038
+ '-4': '银行卡号码有误'
2039
+ '-17': '验证中心服务繁忙'
2040
+ '-18': '验证次数超限,请次日重试'
2041
+ '-19': '该证件号暂不支持核验,当前仅支持二代身份证'。
1988
2042
  */
1989
2043
  Result?: string
1990
2044
  /**
@@ -2002,19 +2056,20 @@ export interface BankCardVerificationResponse {
2002
2056
  */
2003
2057
  export interface PhoneVerificationCUCCRequest {
2004
2058
  /**
2005
- * 身份证号
2059
+ * 身份证号。
2006
2060
  */
2007
2061
  IdCard: string
2008
2062
  /**
2009
- * 姓名
2063
+ * 姓名。
2010
2064
  */
2011
2065
  Name: string
2012
2066
  /**
2013
- * 手机号
2067
+ * 手机号。
2014
2068
  */
2015
2069
  Phone: string
2016
2070
  /**
2017
- * 敏感数据加密信息。对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2071
+ * 敏感数据加密信息。
2072
+ - 对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2018
2073
  */
2019
2074
  Encryption?: Encryption
2020
2075
  }
@@ -2024,19 +2079,20 @@ export interface PhoneVerificationCUCCRequest {
2024
2079
  */
2025
2080
  export interface PhoneVerificationCMCCRequest {
2026
2081
  /**
2027
- * 身份证号
2082
+ * 身份证号。
2028
2083
  */
2029
2084
  IdCard: string
2030
2085
  /**
2031
- * 姓名
2086
+ * 姓名。
2032
2087
  */
2033
2088
  Name: string
2034
2089
  /**
2035
- * 手机号
2090
+ * 手机号。
2036
2091
  */
2037
2092
  Phone: string
2038
2093
  /**
2039
- * 敏感数据加密信息。对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2094
+ * 敏感数据加密信息。
2095
+ - 对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2040
2096
  */
2041
2097
  Encryption?: Encryption
2042
2098
  }
@@ -2314,50 +2370,50 @@ export interface GetDetectInfoResponse {
2314
2370
  export interface IdCardOCRVerificationResponse {
2315
2371
  /**
2316
2372
  * 认证结果码,收费情况如下。
2317
- 收费结果码:
2318
- 0: 姓名和身份证号一致
2319
- -1: 姓名和身份证号不一致
2320
- 不收费结果码:
2321
- -2: 非法身份证号(长度、校验位等不正确)
2322
- -3: 非法姓名(长度、格式等不正确)
2323
- -4: 证件库服务异常
2324
- -5: 证件库中无此身份证记录
2325
- -6: 权威比对系统升级中,请稍后再试
2326
- -7: 认证次数超过当日限制
2373
+ - 收费结果码:
2374
+ 0: 姓名和身份证号一致。
2375
+ -1: 姓名和身份证号不一致。
2376
+ - 不收费结果码:
2377
+ -2: 非法身份证号(长度、校验位等不正确)。
2378
+ -3: 非法姓名(长度、格式等不正确)。
2379
+ -4: 证件库服务异常。
2380
+ -5: 证件库中无此身份证记录。
2381
+ -6: 权威比对系统升级中,请稍后再试。
2382
+ -7: 认证次数超过当日限制。
2327
2383
  */
2328
- Result: string
2384
+ Result?: string
2329
2385
  /**
2330
2386
  * 业务结果描述。
2331
2387
  */
2332
- Description: string
2388
+ Description?: string
2333
2389
  /**
2334
- * 用于验证的姓名
2390
+ * 用于验证的姓名。
2335
2391
  */
2336
- Name: string
2392
+ Name?: string
2337
2393
  /**
2338
- * 用于验证的身份证号
2394
+ * 用于验证的身份证号。
2339
2395
  */
2340
- IdCard: string
2396
+ IdCard?: string
2341
2397
  /**
2342
- * OCR得到的性别
2398
+ * OCR得到的性别。
2343
2399
  注意:此字段可能返回 null,表示取不到有效值。
2344
2400
  */
2345
- Sex: string
2401
+ Sex?: string
2346
2402
  /**
2347
- * OCR得到的民族
2403
+ * OCR得到的民族。
2348
2404
  注意:此字段可能返回 null,表示取不到有效值。
2349
2405
  */
2350
- Nation: string
2406
+ Nation?: string
2351
2407
  /**
2352
- * OCR得到的生日
2408
+ * OCR得到的生日。
2353
2409
  注意:此字段可能返回 null,表示取不到有效值。
2354
2410
  */
2355
- Birth: string
2411
+ Birth?: string
2356
2412
  /**
2357
- * OCR得到的地址
2413
+ * OCR得到的地址。
2358
2414
  注意:此字段可能返回 null,表示取不到有效值。
2359
2415
  */
2360
- Address: string
2416
+ Address?: string
2361
2417
  /**
2362
2418
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2363
2419
  */
@@ -2370,7 +2426,7 @@ export interface IdCardOCRVerificationResponse {
2370
2426
  export interface IdCardVerificationResponse {
2371
2427
  /**
2372
2428
  * 认证结果码,收费情况如下。
2373
- 收费结果码:
2429
+ - 收费结果码:
2374
2430
  0: 姓名和身份证号一致
2375
2431
  -1: 姓名和身份证号不一致
2376
2432
  不收费结果码:
@@ -2397,7 +2453,7 @@ export interface IdCardVerificationResponse {
2397
2453
  */
2398
2454
  export interface GetActionSequenceRequest {
2399
2455
  /**
2400
- * 默认不需要使用
2456
+ * 默认不需要使用。
2401
2457
  */
2402
2458
  ActionType?: string
2403
2459
  }
@@ -2555,29 +2611,31 @@ export interface WeChatBillDetail {
2555
2611
  */
2556
2612
  export interface PhoneVerificationRequest {
2557
2613
  /**
2558
- * 身份证号
2614
+ * 身份证号。
2559
2615
  */
2560
2616
  IdCard: string
2561
2617
  /**
2562
- * 姓名
2618
+ * 姓名。
2563
2619
  */
2564
2620
  Name: string
2565
2621
  /**
2566
- * 手机号
2622
+ * 手机号。
2567
2623
  */
2568
2624
  Phone: string
2569
2625
  /**
2570
- * 验证模式(详版/简版)。简版与详版价格不一致,详见[价格说明](https://cloud.tencent.com/document/product/1007/84321)。
2571
-
2572
- 枚举值:0(简版),1(详版)。默认值为0。
2626
+ * 验证模式(详版/简版)。
2627
+ - 简版与详版价格不一致,详见[价格说明](https://cloud.tencent.com/document/product/1007/84321)。
2628
+ - 枚举值:0(简版);1(详版)。
2629
+ - 默认值为0。
2573
2630
  */
2574
2631
  VerifyMode?: string
2575
2632
  /**
2576
- * 有加密需求的用户,传入kms的CiphertextBlob,关于数据加密可查阅 <a href="https://cloud.tencent.com/document/product/1007/47180">数据加密</a> 文档。
2633
+ * 有加密需求的用户,传入kms的CiphertextBlob。关于数据加密可查阅 <a href="https://cloud.tencent.com/document/product/1007/47180">数据加密</a> 文档。
2577
2634
  */
2578
2635
  CiphertextBlob?: string
2579
2636
  /**
2580
- * 在使用加密服务时,填入要被加密的字段。本接口中可填入加密后的IdCard,Name,Phone中的一个或多个。
2637
+ * 在使用加密服务时,填入要被加密的字段。
2638
+ - 本接口中可填入加密后的IdCard,Name,Phone中的一个或多个。
2581
2639
  */
2582
2640
  EncryptList?: Array<string>
2583
2641
  /**
@@ -2610,20 +2668,21 @@ export interface GetFaceIdResultRequest {
2610
2668
  export interface CheckPhoneAndNameResponse {
2611
2669
  /**
2612
2670
  * 认证结果码,收费情况如下。
2613
- 收费结果码:
2614
- 0: 验证结果一致
2615
- 1: 验证结果不一致
2616
- 不收费结果码:
2617
- -1:查无记录
2618
- -2:引擎未知错误
2619
- -3:引擎服务异常
2620
- -4:姓名校验不通过
2621
- -5:手机号码不合法
2622
- -6: 认证次数超过当日限制,请次日重试
2671
+ - 收费结果码:
2672
+ 0: 验证结果一致。
2673
+ 1: 验证结果不一致。
2674
+
2675
+ - 不收费结果码:
2676
+ -1:查无记录。
2677
+ -2:引擎未知错误。
2678
+ -3:引擎服务异常。
2679
+ -4:姓名校验不通过。
2680
+ -5:手机号码不合法。
2681
+ -6: 认证次数超过当日限制,请次日重试。
2623
2682
  */
2624
2683
  Result?: string
2625
2684
  /**
2626
- * 业务结果描述
2685
+ * 业务结果描述。
2627
2686
  */
2628
2687
  Description?: string
2629
2688
  /**
@@ -2737,15 +2796,16 @@ export interface GetFaceidRiskInfoTokenRequest {
2737
2796
  */
2738
2797
  export interface BankCard2EVerificationRequest {
2739
2798
  /**
2740
- * 姓名
2799
+ * 姓名。
2741
2800
  */
2742
2801
  Name: string
2743
2802
  /**
2744
- * 银行卡
2803
+ * 银行卡。
2745
2804
  */
2746
2805
  BankCard: string
2747
2806
  /**
2748
- * 敏感数据加密信息。对传入信息(姓名、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2807
+ * 敏感数据加密信息。
2808
+ - 对传入信息(姓名、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2749
2809
  */
2750
2810
  Encryption?: Encryption
2751
2811
  }
@@ -2784,20 +2844,21 @@ Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。
2784
2844
  export interface PhoneVerificationCTCCResponse {
2785
2845
  /**
2786
2846
  * 认证结果码,收费情况如下。
2787
- 收费结果码:
2788
- 0: 认证通过
2789
- -4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)
2790
- 不收费结果码:
2791
- -6: 手机号码不合法
2792
- -7: 身份证号码有误
2793
- -8: 姓名校验不通过
2794
- -9: 没有记录
2795
- -11: 验证中心服务繁忙
2847
+ - 收费结果码:
2848
+ 0: 认证通过。
2849
+ -4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)。
2850
+
2851
+ - 不收费结果码:
2852
+ -6: 手机号码不合法。
2853
+ -7: 身份证号码有误。
2854
+ -8: 姓名校验不通过。
2855
+ -9: 没有记录。
2856
+ -11: 验证中心服务繁忙。
2796
2857
  */
2797
2858
  Result?: string
2798
2859
  /**
2799
2860
  * 运营商名称。
2800
- 取值范围为["移动","联通","电信",""]
2861
+ - 取值范围为["移动","联通","电信",""]
2801
2862
  */
2802
2863
  Isp?: string
2803
2864
  /**
@@ -2872,19 +2933,20 @@ export interface ParseNfcDataRequest {
2872
2933
  */
2873
2934
  export interface PhoneVerificationCTCCRequest {
2874
2935
  /**
2875
- * 身份证号
2936
+ * 身份证号。
2876
2937
  */
2877
2938
  IdCard: string
2878
2939
  /**
2879
- * 姓名
2940
+ * 姓名。
2880
2941
  */
2881
2942
  Name: string
2882
2943
  /**
2883
- * 手机号
2944
+ * 手机号。
2884
2945
  */
2885
2946
  Phone: string
2886
2947
  /**
2887
- * 敏感数据加密信息。对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2948
+ * 敏感数据加密信息。
2949
+ - 对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2888
2950
  */
2889
2951
  Encryption?: Encryption
2890
2952
  }
@@ -2922,28 +2984,31 @@ Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。
2922
2984
  */
2923
2985
  export interface BankCard4EVerificationRequest {
2924
2986
  /**
2925
- * 姓名
2987
+ * 姓名。
2926
2988
  */
2927
2989
  Name: string
2928
2990
  /**
2929
- * 银行卡
2991
+ * 银行卡。
2930
2992
  */
2931
2993
  BankCard: string
2932
2994
  /**
2933
- * 手机号码
2995
+ * 手机号码。
2934
2996
  */
2935
2997
  Phone: string
2936
2998
  /**
2937
- * 开户证件号,与CertType参数的证件类型一致,如:身份证,则传入身份证号。
2999
+ * 开户证件号。
3000
+ - 与CertType参数的证件类型一致,如:身份证,则传入身份证号。
2938
3001
  */
2939
3002
  IdCard: string
2940
3003
  /**
2941
- * 证件类型,请确认该证件为开户时使用的证件类型,未用于开户的证件信息不支持验证。
2942
- 目前默认为0:身份证,其他证件类型暂不支持。
3004
+ * 证件类型。
3005
+ - 请确认该证件为开户时使用的证件类型,未用于开户的证件信息不支持验证。
3006
+ - 目前默认为0:身份证,其他证件类型暂不支持。
2943
3007
  */
2944
3008
  CertType?: number
2945
3009
  /**
2946
- * 敏感数据加密信息。对传入信息(姓名、身份证号、手机号、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
3010
+ * 敏感数据加密信息。
3011
+ - 对传入信息(姓名、身份证号、手机号、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2947
3012
  */
2948
3013
  Encryption?: Encryption
2949
3014
  }
@@ -2953,7 +3018,8 @@ export interface BankCard4EVerificationRequest {
2953
3018
  */
2954
3019
  export interface GetActionSequenceResponse {
2955
3020
  /**
2956
- * 动作顺序(2,1 or 1,2) 1代表张嘴,2代表闭眼。
3021
+ * 动作顺序,例如:2,1 or 1,2。
3022
+ - 1代表张嘴,2代表闭眼。
2957
3023
  */
2958
3024
  ActionSequence?: string
2959
3025
  /**
@@ -2977,9 +3043,9 @@ export interface GetFaceIdRiskInfoRequest {
2977
3043
  */
2978
3044
  export interface GetLiveCodeResponse {
2979
3045
  /**
2980
- * 数字验证码,如:1234
3046
+ * 数字验证码。
2981
3047
  */
2982
- LiveCode: string
3048
+ LiveCode?: string
2983
3049
  /**
2984
3050
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2985
3051
  */
@@ -3068,15 +3134,16 @@ export interface DetectInfoIdCardData {
3068
3134
  */
3069
3135
  export interface CheckPhoneAndNameRequest {
3070
3136
  /**
3071
- * ⼿机号
3137
+ * ⼿机号。
3072
3138
  */
3073
3139
  Mobile: string
3074
3140
  /**
3075
- * 姓名
3141
+ * 姓名。
3076
3142
  */
3077
3143
  Name: string
3078
3144
  /**
3079
- * 敏感数据加密信息。对传入信息(姓名、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
3145
+ * 敏感数据加密信息。
3146
+ - 对传入信息(姓名、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
3080
3147
  */
3081
3148
  Encryption?: Encryption
3082
3149
  }