tencentcloud-sdk-nodejs-essbasic 4.0.618 → 4.0.619

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.
@@ -28,41 +28,41 @@ export interface CreateSubOrganizationRequest {
28
28
  */
29
29
  Caller: Caller;
30
30
  /**
31
- * 机构证件号码类型可选值:
31
+ * 机构证件号码类型可选值:
32
32
  1. USCC - 统一社会信用代码
33
33
  2. BIZREGISTNO - 营业执照注册号
34
- */
34
+ */
35
35
  IdCardType: string;
36
36
  /**
37
37
  * 机构证件号码
38
38
  */
39
39
  IdCardNumber: string;
40
40
  /**
41
- * 机构类型可选值:
41
+ * 机构类型可选值:
42
42
  1. ENTERPRISE - 企业
43
43
  2. INDIVIDUALBIZ - 个体工商户
44
44
  3. PUBLICINSTITUTION - 政府/事业单位
45
45
  4. OTHERS - 其他组织
46
- */
46
+ */
47
47
  OrganizationType: string;
48
48
  /**
49
49
  * 机构法人/经营者姓名
50
50
  */
51
51
  LegalName: string;
52
52
  /**
53
- * 机构法人/经营者证件类型可选值:
53
+ * 机构法人/经营者证件类型可选值:
54
54
  1. ID_CARD - 居民身份证
55
55
  2. PASSPORT - 护照
56
56
  3. MAINLAND_TRAVEL_PERMIT_FOR_HONGKONG_AND_MACAO_RESIDENTS - 港澳居民来往内地通行证
57
57
  4. MAINLAND_TRAVEL_PERMIT_FOR_TAIWAN_RESIDENTS - 台湾居民来往大陆通行证
58
58
  5. HOUSEHOLD_REGISTER - 户口本
59
59
  6. TEMP_ID_CARD - 临时居民身份证
60
- */
60
+ */
61
61
  LegalIdCardType: string;
62
62
  /**
63
- * 机构法人/经营者证件号码;
63
+ * 机构法人/经营者证件号码;
64
64
  OrganizationType 为 ENTERPRISE时,INDIVIDUALBIZ 时必填,其他情况选填
65
- */
65
+ */
66
66
  LegalIdCardNumber: string;
67
67
  /**
68
68
  * 机构名称全称
@@ -77,10 +77,10 @@ export interface CreateSubOrganizationRequest {
77
77
  */
78
78
  UseOpenId?: boolean;
79
79
  /**
80
- * 机构证件文件类型可选值:
80
+ * 机构证件文件类型可选值:
81
81
  1. USCCFILE - 统一社会信用代码证书
82
82
  2. LICENSEFILE - 营业执照
83
- */
83
+ */
84
84
  IdCardFileType?: string;
85
85
  /**
86
86
  * 机构证件照片文件,base64编码,支持jpg、jpeg、png格式
@@ -120,17 +120,17 @@ export interface CreateSubOrganizationRequest {
120
120
  */
121
121
  export interface Component {
122
122
  /**
123
- * 控件编号
123
+ * 控件编号
124
124
 
125
125
  注:
126
126
  当GenerateMode=3时,通过"^"来决定是否使用关键字整词匹配能力。
127
127
  例:
128
128
  当GenerateMode=3时,如果传入关键字"^甲方签署^",则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。
129
129
  如传入的关键字为"甲方签署",则PDF文件中每个出现关键字的位置都会执行相应操作。
130
- */
130
+ */
131
131
  ComponentId?: string;
132
132
  /**
133
- * 如果是Component控件类型,则可选的字段为:
133
+ * 如果是Component控件类型,则可选的字段为:
134
134
  TEXT - 普通文本控件;
135
135
  DATE - 普通日期控件;
136
136
  SELECT- 勾选框控件;
@@ -138,7 +138,7 @@ export interface Component {
138
138
  SIGN_SEAL- 签署印章控件;
139
139
  SIGN_DATE- 签署日期控件;
140
140
  SIGN_SIGNATURE - 用户签名控件;
141
- */
141
+ */
142
142
  ComponentType?: string;
143
143
  /**
144
144
  * 控件名称
@@ -153,12 +153,12 @@ export interface Component {
153
153
  */
154
154
  FileIndex?: number;
155
155
  /**
156
- * 控件生成的方式:
156
+ * 控件生成的方式:
157
157
  0 - 普通控件
158
158
  1 - 表单域
159
159
  2 - html 控件
160
160
  3 - 关键字
161
- */
161
+ */
162
162
  GenerateMode?: number;
163
163
  /**
164
164
  * 参数控件宽度,单位px
@@ -185,12 +185,12 @@ export interface Component {
185
185
  */
186
186
  ComponentExtra?: string;
187
187
  /**
188
- * 印章ID,如果是手写签名则为jpg或png格式的base64图片
188
+ * 印章ID,如果是手写签名则为jpg或png格式的base64图片
189
189
 
190
190
  SIGN_SEAL控件,可以用ORG_DEFAULT_SEAL表示主企业的默认印章
191
191
  SIGN_SEAL控件,可以用SUBORG_DEFAULT_SEAL表示子企业的默认印章
192
192
  SIGN_SEAL控件,可以用USER_DEFAULT_SEAL表示个人默认印章
193
- */
193
+ */
194
194
  ComponentValue?: string;
195
195
  /**
196
196
  * 如果是SIGN_SEAL类型的签署控件, 参数标识H5签署界面是否在该签署区上进行放置展示, 1为放置,其他为不放置
@@ -210,7 +210,7 @@ export interface CreateSealRequest {
210
210
  */
211
211
  Caller: Caller;
212
212
  /**
213
- * 印章类型:
213
+ * 印章类型:
214
214
  1. PERSONAL - 个人私章
215
215
  2. OFFICIAL - 公章
216
216
  3. SPECIAL_FINANCIAL - 财务专用章
@@ -218,7 +218,7 @@ export interface CreateSealRequest {
218
218
  5. LEGAL_REPRESENTATIVE - 法定代表人章
219
219
  6. SPECIAL_NATIONWIDE_INVOICE - 发票专用章
220
220
  7. OTHER-其他
221
- */
221
+ */
222
222
  SealType: string;
223
223
  /**
224
224
  * 印章名称
@@ -259,10 +259,10 @@ export interface CancelFlowResponse {
259
259
  */
260
260
  export interface FaceIdPhoto {
261
261
  /**
262
- * 核身结果:
262
+ * 核身结果:
263
263
  0 - 通过;
264
264
  1 - 未通过
265
- */
265
+ */
266
266
  Result: number;
267
267
  /**
268
268
  * 核身失败描述
@@ -303,9 +303,9 @@ export interface VerifyUserRequest {
303
303
  */
304
304
  UserId: string;
305
305
  /**
306
- * 是否需要下发个人长效证书,默认为false
306
+ * 是否需要下发个人长效证书,默认为false
307
307
  注:如您有下发个人长效证书需求,请提前邮件至e-contract@oa.com进行申请。
308
- */
308
+ */
309
309
  CertificateRequired?: boolean;
310
310
  }
311
311
  /**
@@ -436,10 +436,10 @@ export interface CheckFaceIdentifyRequest {
436
436
  */
437
437
  export interface CreateServerFlowSignResponse {
438
438
  /**
439
- * 任务状态:
439
+ * 任务状态:
440
440
  0:失败
441
441
  1:成功
442
- */
442
+ */
443
443
  SignStatus: number;
444
444
  /**
445
445
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -464,7 +464,7 @@ export interface ModifyUserResponse {
464
464
  */
465
465
  export interface CheckBankCard4EVerificationResponse {
466
466
  /**
467
- * 检测结果
467
+ * 检测结果
468
468
  计费结果码:
469
469
  0: 认证通过
470
470
  1: 认证未通过
@@ -486,7 +486,7 @@ export interface CheckBankCard4EVerificationResponse {
486
486
  103: 验证中心服务繁忙
487
487
  104: 身份证号码有误
488
488
  105: 手机号码不合法
489
- */
489
+ */
490
490
  Result?: number;
491
491
  /**
492
492
  * 结果描述; 未通过时必选
@@ -510,12 +510,12 @@ export interface DescribeFileUrlsRequest {
510
510
  */
511
511
  BusinessIds: Array<string>;
512
512
  /**
513
- * 业务类型:
513
+ * 业务类型:
514
514
  1. TEMPLATE - 模板
515
515
  2. SEAL - 印章
516
516
  3. FLOW - 流程
517
517
  4.CATALOG - 目录
518
- */
518
+ */
519
519
  BusinessType: string;
520
520
  /**
521
521
  * 下载后的文件命名,只有FileType为“ZIP”时生效
@@ -656,7 +656,7 @@ export interface GenerateUserSealRequest {
656
656
  */
657
657
  export interface CheckIdCardVerificationResponse {
658
658
  /**
659
- * 检测结果;
659
+ * 检测结果;
660
660
  收费错误码:
661
661
  0: 通过,
662
662
  1: 姓名和身份证号不一致,
@@ -665,7 +665,7 @@ export interface CheckIdCardVerificationResponse {
665
665
  102: 非法姓名(长度,格式等不正确),
666
666
  103: 验证平台异常,
667
667
  104: 证件库中无此身份证记录
668
- */
668
+ */
669
669
  Result?: number;
670
670
  /**
671
671
  * 结果描述; 未通过时必选
@@ -701,7 +701,7 @@ export interface DescribeFlowResponse {
701
701
  */
702
702
  FlowType: string;
703
703
  /**
704
- * 流程状态:
704
+ * 流程状态:
705
705
  0-创建;
706
706
  1-签署中;
707
707
  2-拒签;
@@ -710,7 +710,7 @@ export interface DescribeFlowResponse {
710
710
  5-已过期;
711
711
  6-已销毁
712
712
  7-签署完成未归档
713
- */
713
+ */
714
714
  FlowStatus: number;
715
715
  /**
716
716
  * 流程创建时间
@@ -750,41 +750,41 @@ export interface CreateSubOrganizationAndSealRequest {
750
750
  */
751
751
  Name: string;
752
752
  /**
753
- * 机构证件号码类型可选值:
753
+ * 机构证件号码类型可选值:
754
754
  1. USCC - 统一社会信用代码
755
755
  2. BIZREGISTNO - 营业执照注册号
756
- */
756
+ */
757
757
  IdCardType: string;
758
758
  /**
759
759
  * 机构证件号码
760
760
  */
761
761
  IdCardNumber: string;
762
762
  /**
763
- * 机构类型可选值:
763
+ * 机构类型可选值:
764
764
  1. ENTERPRISE - 企业
765
765
  2. INDIVIDUALBIZ - 个体工商户
766
766
  3. PUBLICINSTITUTION - 政府/事业单位
767
767
  4. OTHERS - 其他组织
768
- */
768
+ */
769
769
  OrganizationType: string;
770
770
  /**
771
771
  * 机构法人/经营者姓名
772
772
  */
773
773
  LegalName: string;
774
774
  /**
775
- * 机构法人/经营者证件类型可选值:
775
+ * 机构法人/经营者证件类型可选值:
776
776
  1. ID_CARD - 居民身份证
777
777
  2. PASSPORT - 护照
778
778
  3. MAINLAND_TRAVEL_PERMIT_FOR_HONGKONG_AND_MACAO_RESIDENTS - 港澳居民来往内地通行证
779
779
  4. MAINLAND_TRAVEL_PERMIT_FOR_TAIWAN_RESIDENTS - 台湾居民来往大陆通行证
780
780
  5. HOUSEHOLD_REGISTER - 户口本
781
781
  6. TEMP_ID_CARD - 临时居民身份证
782
- */
782
+ */
783
783
  LegalIdCardType: string;
784
784
  /**
785
- * 机构法人/经营者证件号码;
785
+ * 机构法人/经营者证件号码;
786
786
  OrganizationType 为 ENTERPRISE时,INDIVIDUALBIZ 时必填,其他情况选填
787
- */
787
+ */
788
788
  LegalIdCardNumber: string;
789
789
  /**
790
790
  * 实名认证的客户端IP/请求生成企业印章的客户端Ip
@@ -795,10 +795,10 @@ export interface CreateSubOrganizationAndSealRequest {
795
795
  */
796
796
  Email?: string;
797
797
  /**
798
- * 机构证件文件类型可选值:
798
+ * 机构证件文件类型可选值:
799
799
  1. USCCFILE - 统一社会信用代码证书
800
800
  2. LICENSEFILE - 营业执照
801
- */
801
+ */
802
802
  IdCardFileType?: string;
803
803
  /**
804
804
  * 机构证件照片文件,base64编码,支持jpg、jpeg、png格式
@@ -829,14 +829,14 @@ export interface CreateSubOrganizationAndSealRequest {
829
829
  */
830
830
  SealName?: string;
831
831
  /**
832
- * 印章类型:默认: CONTRACT
832
+ * 印章类型:默认: CONTRACT
833
833
  1. OFFICIAL-公章
834
834
  2. SPECIAL_FINANCIAL-财务专用章
835
835
  3. CONTRACT-合同专用章
836
836
  4. LEGAL_REPRESENTATIVE-法定代表人章
837
837
  5. SPECIAL_NATIONWIDE_INVOICE-发票专用章
838
838
  6. OTHER-其他
839
- */
839
+ */
840
840
  SealType?: string;
841
841
  /**
842
842
  * 企业印章横向文字,最多可填8个汉字(可为空,默认为"电子签名专用章")
@@ -971,15 +971,15 @@ export interface FlowApproverInfo {
971
971
  */
972
972
  UserId: string;
973
973
  /**
974
- * 认证方式:
974
+ * 认证方式:
975
975
  WEIXINAPP - 微信小程序;
976
976
  FACEID - 慧眼 (默认);
977
977
  VERIFYCODE - 验证码;
978
978
  THIRD - 第三方 (暂不支持)
979
- */
979
+ */
980
980
  VerifyChannel: Array<string>;
981
981
  /**
982
- * 签署状态:
982
+ * 签署状态:
983
983
  0 - 待签署;
984
984
  1- 已签署;
985
985
  2 - 拒绝;
@@ -988,32 +988,32 @@ export interface FlowApproverInfo {
988
988
  12-审核中,
989
989
  13-审核驳回
990
990
  注意:此字段可能返回 null,表示取不到有效值。
991
- */
991
+ */
992
992
  ApproveStatus: number;
993
993
  /**
994
- * 拒签/签署/审核驳回原因
994
+ * 拒签/签署/审核驳回原因
995
995
  注意:此字段可能返回 null,表示取不到有效值。
996
- */
996
+ */
997
997
  ApproveMessage: string;
998
998
  /**
999
- * 签约时间的时间戳
999
+ * 签约时间的时间戳
1000
1000
  注意:此字段可能返回 null,表示取不到有效值。
1001
- */
1001
+ */
1002
1002
  ApproveTime: number;
1003
1003
  /**
1004
- * 签署企业ID
1004
+ * 签署企业ID
1005
1005
  注意:此字段可能返回 null,表示取不到有效值。
1006
- */
1006
+ */
1007
1007
  SubOrganizationId: string;
1008
1008
  /**
1009
- * 签署完成后跳转的URL
1009
+ * 签署完成后跳转的URL
1010
1010
  注意:此字段可能返回 null,表示取不到有效值。
1011
- */
1011
+ */
1012
1012
  JumpUrl: string;
1013
1013
  /**
1014
- * 用户签署区ID到印章ID的映射集合
1014
+ * 用户签署区ID到印章ID的映射集合
1015
1015
  注意:此字段可能返回 null,表示取不到有效值。
1016
- */
1016
+ */
1017
1017
  ComponentSeals: Array<ComponentSeal>;
1018
1018
  /**
1019
1019
  * 签署前置条件:是否强制用户全文阅读,即阅读到待签署文档的最后一页。默认FALSE
@@ -1036,9 +1036,9 @@ export interface FlowApproverInfo {
1036
1036
  */
1037
1037
  IsLastApprover: boolean;
1038
1038
  /**
1039
- * 短信模板
1039
+ * 短信模板
1040
1040
  注意:此字段可能返回 null,表示取不到有效值。
1041
- */
1041
+ */
1042
1042
  SmsTemplate: SmsTemplate;
1043
1043
  /**
1044
1044
  * 身份证号,脱敏显示
@@ -1053,19 +1053,19 @@ export interface FlowApproverInfo {
1053
1053
  */
1054
1054
  CanOffLine: boolean;
1055
1055
  /**
1056
- * 证件号码类型:ID_CARD - 身份证,PASSPORT - 护照,MAINLAND_TRAVEL_PERMIT_FOR_HONGKONG_AND_MACAO_RESIDENTS - 港澳居民来往内地通行证; 暂不支持用于电子签自有平台实名认证,MAINLAND_TRAVEL_PERMIT_FOR_TAIWAN_RESIDENTS - 台湾居民来往大陆通行证; 暂不支持用于电子签自有平台实名认证,HOUSEHOLD_REGISTER - 户口本; 暂不支持用于电子签自有平台实名认证,TEMP_ID_CARD - 临时居民身份证; 暂不支持用于电子签自有平台实名认证
1056
+ * 证件号码类型:ID_CARD - 身份证,PASSPORT - 护照,MAINLAND_TRAVEL_PERMIT_FOR_HONGKONG_AND_MACAO_RESIDENTS - 港澳居民来往内地通行证; 暂不支持用于电子签自有平台实名认证,MAINLAND_TRAVEL_PERMIT_FOR_TAIWAN_RESIDENTS - 台湾居民来往大陆通行证; 暂不支持用于电子签自有平台实名认证,HOUSEHOLD_REGISTER - 户口本; 暂不支持用于电子签自有平台实名认证,TEMP_ID_CARD - 临时居民身份证; 暂不支持用于电子签自有平台实名认证
1057
1057
  注意:此字段可能返回 null,表示取不到有效值。
1058
- */
1058
+ */
1059
1059
  IdCardType: string;
1060
1060
  /**
1061
- * 签署回调地址
1061
+ * 签署回调地址
1062
1062
  注意:此字段可能返回 null,表示取不到有效值。
1063
- */
1063
+ */
1064
1064
  CallbackUrl: string;
1065
1065
  /**
1066
- * 签署任务ID,标识每一次的流程发送
1066
+ * 签署任务ID,标识每一次的流程发送
1067
1067
  注意:此字段可能返回 null,表示取不到有效值。
1068
- */
1068
+ */
1069
1069
  SignId: string;
1070
1070
  }
1071
1071
  /**
@@ -1123,14 +1123,14 @@ export interface SubOrganizationDetail {
1123
1123
  */
1124
1124
  OrganizationType: string;
1125
1125
  /**
1126
- * 机构证件文件类型
1126
+ * 机构证件文件类型
1127
1127
  注意:此字段可能返回 null,表示取不到有效值。
1128
- */
1128
+ */
1129
1129
  IdCardFileType: string;
1130
1130
  /**
1131
- * 机构证件照片文件,base64编码
1131
+ * 机构证件照片文件,base64编码
1132
1132
  注意:此字段可能返回 null,表示取不到有效值。
1133
- */
1133
+ */
1134
1134
  BizLicenseFile: string;
1135
1135
  /**
1136
1136
  * 机构证件照片文件名
@@ -1153,42 +1153,42 @@ export interface SubOrganizationDetail {
1153
1153
  */
1154
1154
  LegalMobile: string;
1155
1155
  /**
1156
- * 组织联系人姓名
1156
+ * 组织联系人姓名
1157
1157
  注意:此字段可能返回 null,表示取不到有效值。
1158
- */
1158
+ */
1159
1159
  ContactName: string;
1160
1160
  /**
1161
1161
  * 机构实名状态
1162
1162
  */
1163
1163
  VerifyStatus: string;
1164
1164
  /**
1165
- * 机构通过实名时间
1165
+ * 机构通过实名时间
1166
1166
  注意:此字段可能返回 null,表示取不到有效值。
1167
- */
1167
+ */
1168
1168
  VerifiedOn: number;
1169
1169
  /**
1170
1170
  * 机构创建时间
1171
1171
  */
1172
1172
  CreatedOn: number;
1173
1173
  /**
1174
- * 机构更新时间
1174
+ * 机构更新时间
1175
1175
  注意:此字段可能返回 null,表示取不到有效值。
1176
- */
1176
+ */
1177
1177
  UpdatedOn: number;
1178
1178
  /**
1179
- * 实名认证的客户端IP
1179
+ * 实名认证的客户端IP
1180
1180
  注意:此字段可能返回 null,表示取不到有效值。
1181
- */
1181
+ */
1182
1182
  VerifyClientIp: string;
1183
1183
  /**
1184
- * 实名认证的服务器IP
1184
+ * 实名认证的服务器IP
1185
1185
  注意:此字段可能返回 null,表示取不到有效值。
1186
- */
1186
+ */
1187
1187
  VerifyServerIp: string;
1188
1188
  /**
1189
- * 企业联系地址
1189
+ * 企业联系地址
1190
1190
  注意:此字段可能返回 null,表示取不到有效值。
1191
- */
1191
+ */
1192
1192
  ContactAddress: Address;
1193
1193
  }
1194
1194
  /**
@@ -1242,12 +1242,12 @@ export interface ModifySubOrganizationInfoRequest {
1242
1242
  */
1243
1243
  Name?: string;
1244
1244
  /**
1245
- * 机构类型可选值:
1245
+ * 机构类型可选值:
1246
1246
  1. ENTERPRISE - 企业;
1247
1247
  2. INDIVIDUALBIZ - 个体工商户;
1248
1248
  3. PUBLICINSTITUTION - 政府/事业单位
1249
1249
  4. OTHERS - 其他组织
1250
- */
1250
+ */
1251
1251
  OrganizationType?: string;
1252
1252
  /**
1253
1253
  * 机构证件照片文件,base64编码。支持jpg,jpeg,png格式;如果传值,则重新上传文件后,机构状态将变为未实名,需要调用实名接口重新实名。
@@ -1359,9 +1359,9 @@ export interface CheckVerifyCodeMatchFlowIdResponse {
1359
1359
  */
1360
1360
  Success: boolean;
1361
1361
  /**
1362
- * 0: 验证码正确 1:验证码错误或过期 2:验证码错误 3:验证码和流程不匹配 4:验证码输入错误超过次数 5:内部错误
1362
+ * 0: 验证码正确 1:验证码错误或过期 2:验证码错误 3:验证码和流程不匹配 4:验证码输入错误超过次数 5:内部错误
1363
1363
  6:参数错误
1364
- */
1364
+ */
1365
1365
  Result: number;
1366
1366
  /**
1367
1367
  * 结果描述
@@ -1462,7 +1462,7 @@ export interface DeleteSealRequest {
1462
1462
  */
1463
1463
  export interface CheckBankCardVerificationResponse {
1464
1464
  /**
1465
- * 检测结果
1465
+ * 检测结果
1466
1466
  计费结果码:
1467
1467
  0: 认证通过
1468
1468
  1: 认证未通过
@@ -1484,7 +1484,7 @@ export interface CheckBankCardVerificationResponse {
1484
1484
  103: 验证中心服务繁忙
1485
1485
  104: 身份证号码有误
1486
1486
  105: 手机号码不合法
1487
- */
1487
+ */
1488
1488
  Result?: number;
1489
1489
  /**
1490
1490
  * 结果描述; 未通过时必选
@@ -1530,10 +1530,10 @@ export interface CreateUserAndSealResponse {
1530
1530
  */
1531
1531
  export interface FaceIdResult {
1532
1532
  /**
1533
- * 核身结果:
1533
+ * 核身结果:
1534
1534
  0 - 通过;
1535
1535
  1 - 未通过
1536
- */
1536
+ */
1537
1537
  Result: number;
1538
1538
  /**
1539
1539
  * 核身失败描述
@@ -1544,45 +1544,45 @@ export interface FaceIdResult {
1544
1544
  */
1545
1545
  OrderNumber: string;
1546
1546
  /**
1547
- * 姓名
1547
+ * 姓名
1548
1548
  注意:此字段可能返回 null,表示取不到有效值。
1549
- */
1549
+ */
1550
1550
  Name: string;
1551
1551
  /**
1552
- * 身份证件类型:
1552
+ * 身份证件类型:
1553
1553
  ID_CARD - 居民身份证
1554
1554
  注意:此字段可能返回 null,表示取不到有效值。
1555
- */
1555
+ */
1556
1556
  IdCardType: string;
1557
1557
  /**
1558
- * 身份证件号码
1558
+ * 身份证件号码
1559
1559
  注意:此字段可能返回 null,表示取不到有效值。
1560
- */
1560
+ */
1561
1561
  IdCardNumber: string;
1562
1562
  /**
1563
- * 活体检测得分 (百分制)
1563
+ * 活体检测得分 (百分制)
1564
1564
  注意:此字段可能返回 null,表示取不到有效值。
1565
- */
1565
+ */
1566
1566
  LiveRate: number;
1567
1567
  /**
1568
- * 人脸检测得分 (百分制)
1568
+ * 人脸检测得分 (百分制)
1569
1569
  注意:此字段可能返回 null,表示取不到有效值。
1570
- */
1570
+ */
1571
1571
  Similarity: number;
1572
1572
  /**
1573
- * 刷脸时间 (UNIX时间戳)
1573
+ * 刷脸时间 (UNIX时间戳)
1574
1574
  注意:此字段可能返回 null,表示取不到有效值。
1575
- */
1575
+ */
1576
1576
  OccurredTime: number;
1577
1577
  /**
1578
- * 照片数据 (base64编码, 一般为JPG或PNG)
1578
+ * 照片数据 (base64编码, 一般为JPG或PNG)
1579
1579
  注意:此字段可能返回 null,表示取不到有效值。
1580
- */
1580
+ */
1581
1581
  Photo: string;
1582
1582
  /**
1583
- * 视频数据 (base64编码, 一般为MP4)
1583
+ * 视频数据 (base64编码, 一般为MP4)
1584
1584
  注意:此字段可能返回 null,表示取不到有效值。
1585
- */
1585
+ */
1586
1586
  Video: string;
1587
1587
  }
1588
1588
  /**
@@ -1610,10 +1610,10 @@ export interface CreateSignUrlRequest {
1610
1610
  */
1611
1611
  FlowId?: string;
1612
1612
  /**
1613
- * 签署链接类型:
1613
+ * 签署链接类型:
1614
1614
  1. FLOW - 单流程签署 (默认)
1615
1615
  2. CATALOG - 目录签署
1616
- */
1616
+ */
1617
1617
  SignUrlType?: string;
1618
1618
  /**
1619
1619
  * 发送流程或目录时生成的签署任务ID
@@ -1651,14 +1651,14 @@ export interface UploadFilesRequest {
1651
1651
  */
1652
1652
  Caller: Caller;
1653
1653
  /**
1654
- * 文件对应业务类型,用于区分文件存储路径:
1654
+ * 文件对应业务类型,用于区分文件存储路径:
1655
1655
  1. TEMPLATE - 模版; 文件类型:.pdf/.html
1656
1656
  2. DOCUMENT - 签署过程及签署后的合同文档 文件类型:.pdf/.html
1657
1657
  3. FLOW - 签署过程 文件类型:.pdf/.html
1658
1658
  4. SEAL - 印章; 文件类型:.jpg/.jpeg/.png
1659
1659
  5. BUSINESSLICENSE - 营业执照 文件类型:.jpg/.jpeg/.png
1660
1660
  6. IDCARD - 身份证 文件类型:.jpg/.jpeg/.png
1661
- */
1661
+ */
1662
1662
  BusinessType: string;
1663
1663
  /**
1664
1664
  * 上传文件内容数组,最多支持20个文件
@@ -1669,15 +1669,15 @@ export interface UploadFilesRequest {
1669
1669
  */
1670
1670
  FileUrls?: Array<string>;
1671
1671
  /**
1672
- * 是否将pdf灰色矩阵置白
1672
+ * 是否将pdf灰色矩阵置白
1673
1673
  true--是,处理置白
1674
1674
  false--否,不处理
1675
- */
1675
+ */
1676
1676
  CoverRect?: boolean;
1677
1677
  /**
1678
- * 特殊文件类型需要指定文件类型:
1678
+ * 特殊文件类型需要指定文件类型:
1679
1679
  HTML-- .html文件
1680
- */
1680
+ */
1681
1681
  FileType?: string;
1682
1682
  /**
1683
1683
  * 用户自定义ID数组,与上传文件一一对应
@@ -1761,12 +1761,12 @@ export interface FlowInfo {
1761
1761
  */
1762
1762
  FlowDescription?: string;
1763
1763
  /**
1764
- * 合同类型:
1764
+ * 合同类型:
1765
1765
  1. “劳务”
1766
1766
  2. “销售”
1767
1767
  3. “租赁”
1768
1768
  4. “其他”
1769
- */
1769
+ */
1770
1770
  FlowType?: string;
1771
1771
  /**
1772
1772
  * 回调地址
@@ -1794,10 +1794,10 @@ export interface UserDescribe {
1794
1794
  */
1795
1795
  CreatedOn: number;
1796
1796
  /**
1797
- * 实名认证状态:
1797
+ * 实名认证状态:
1798
1798
  0 - 未实名;
1799
1799
  1 - 通过实名
1800
- */
1800
+ */
1801
1801
  VerifyStatus: number;
1802
1802
  /**
1803
1803
  * 真实姓名
@@ -1808,14 +1808,14 @@ export interface UserDescribe {
1808
1808
  */
1809
1809
  VerifiedOn: number;
1810
1810
  /**
1811
- * 身份证件类型;
1811
+ * 身份证件类型;
1812
1812
  ID_CARD - 居民身份证;
1813
1813
  PASSPORT - 护照;
1814
1814
  MAINLAND_TRAVEL_PERMIT_FOR_HONGKONG_AND_MACAO_RESIDENTS - 港澳居民来往内地通行证;
1815
1815
  MAINLAND_TRAVEL_PERMIT_FOR_TAIWAN_RESIDENTS - 台湾居民来往大陆通行证;
1816
1816
  HOUSEHOLD_REGISTER - 户口本;
1817
1817
  TEMP_ID_CARD - 临时居民身份证
1818
- */
1818
+ */
1819
1819
  IdCardType: string;
1820
1820
  /**
1821
1821
  * 身份证件号码 (脱敏)
@@ -1827,7 +1827,7 @@ export interface UserDescribe {
1827
1827
  */
1828
1828
  export interface CheckBankCard2EVerificationResponse {
1829
1829
  /**
1830
- * 检测结果
1830
+ * 检测结果
1831
1831
  计费结果码:
1832
1832
  0: 认证通过
1833
1833
  1: 认证未通过
@@ -1849,7 +1849,7 @@ export interface CheckBankCard2EVerificationResponse {
1849
1849
  103: 验证中心服务繁忙
1850
1850
  104: 身份证号码有误
1851
1851
  105: 手机号码不合法
1852
- */
1852
+ */
1853
1853
  Result?: number;
1854
1854
  /**
1855
1855
  * 结果描述; 未通过时必选
@@ -2003,23 +2003,23 @@ export interface RejectFlowRequest {
2003
2003
  */
2004
2004
  FlowId: string;
2005
2005
  /**
2006
- * 意愿确认票据。
2006
+ * 意愿确认票据。
2007
2007
  1. VerifyChannel 为 WEIXINAPP,使用响应的VerifyResult;
2008
2008
  2. VerifyChannel 为 FACEID时,使用OrderNo;
2009
2009
  3. VerifyChannel 为 VERIFYCODE,使用短信验证码
2010
2010
  4. VerifyChannel 为 NONE,传空值
2011
2011
  (注:普通情况下,VerifyResult不能为None,如您不希望腾讯电子签对用户签署意愿做校验,请提前与客户经理或邮件至e-contract@tencent.com与我们联系)
2012
- */
2012
+ */
2013
2013
  VerifyResult: string;
2014
2014
  /**
2015
- * 意愿确认渠道:
2015
+ * 意愿确认渠道:
2016
2016
  1. WEIXINAPP - 微信小程序
2017
2017
  2. FACEID - 慧眼 (默认)
2018
2018
  3. VERIFYCODE - 验证码
2019
2019
  4. THIRD - 第三方 (暂不支持)
2020
2020
  5. NONE - 无需电子签系统验证
2021
2021
  (注:普通情况下,VerifyChannel不能为None,如您不希望腾讯电子签对用户签署意愿做校验,请提前与客户经理或邮件至e-contract@tencent.com与我们联系)
2022
- */
2022
+ */
2023
2023
  VerifyChannel: string;
2024
2024
  /**
2025
2025
  * 客户端来源IP
@@ -2056,12 +2056,12 @@ export interface SignSeal {
2056
2056
  */
2057
2057
  ComponentId: string;
2058
2058
  /**
2059
- * 签署印章类型:
2059
+ * 签署印章类型:
2060
2060
  SIGN_SIGNATURE - 签名
2061
2061
  SIGN_SEAL - 印章
2062
2062
  SIGN_DATE - 日期
2063
2063
  SIGN_IMAGE - 图片
2064
- */
2064
+ */
2065
2065
  SignType: string;
2066
2066
  /**
2067
2067
  * 合同文件ID
@@ -2142,7 +2142,7 @@ export interface UploadFilesResponse {
2142
2142
  */
2143
2143
  export interface CheckBankCard3EVerificationResponse {
2144
2144
  /**
2145
- * 检测结果
2145
+ * 检测结果
2146
2146
  计费结果码:
2147
2147
  0: 认证通过
2148
2148
  1: 认证未通过
@@ -2164,7 +2164,7 @@ export interface CheckBankCard3EVerificationResponse {
2164
2164
  103: 验证中心服务繁忙
2165
2165
  104: 身份证号码有误
2166
2166
  105: 手机号码不合法
2167
- */
2167
+ */
2168
2168
  Result?: number;
2169
2169
  /**
2170
2170
  * 结果描述; 未通过时必选
@@ -2188,23 +2188,23 @@ export interface SignFlowRequest {
2188
2188
  */
2189
2189
  FlowId: string;
2190
2190
  /**
2191
- * 意愿确认票据。
2191
+ * 意愿确认票据。
2192
2192
  1. VerifyChannel 为 WEIXINAPP,使用响应的VerifyResult;
2193
2193
  2. VerifyChannel 为 FACEID时,使用OrderNo;
2194
2194
  3. VerifyChannel 为 VERIFYCODE,使用短信验证码
2195
2195
  4. VerifyChannel 为 NONE,传空值
2196
2196
  (注:普通情况下,VerifyResult不能为None,如您不希望腾讯电子签对用户签署意愿做校验,请提前与客户经理或邮件至e-contract@tencent.com与我们联系)
2197
- */
2197
+ */
2198
2198
  VerifyResult: string;
2199
2199
  /**
2200
- * 意愿确认渠道:
2200
+ * 意愿确认渠道:
2201
2201
  1. WEIXINAPP - 微信小程序
2202
2202
  2. FACEID - 慧眼 (默认)
2203
2203
  3. VERIFYCODE - 验证码
2204
2204
  4. THIRD - 第三方 (暂不支持)
2205
2205
  5. NONE - 无需电子签系统验证
2206
2206
  (注:普通情况下,VerifyChannel不能为None,如您不希望腾讯电子签对用户签署意愿做校验,请提前与客户经理或邮件至e-contract@tencent.com与我们联系)
2207
- */
2207
+ */
2208
2208
  VerifyChannel: string;
2209
2209
  /**
2210
2210
  * 客户端来源IP
@@ -2321,7 +2321,7 @@ export interface CreateH5FaceIdUrlRequest {
2321
2321
  */
2322
2322
  export interface CheckMobileVerificationResponse {
2323
2323
  /**
2324
- * 检测结果
2324
+ * 检测结果
2325
2325
  计费结果码:
2326
2326
  0: 验证结果一致
2327
2327
  1: 手机号未实名
@@ -2334,7 +2334,7 @@ export interface CheckMobileVerificationResponse {
2334
2334
  104: 非法身份证号(长度,校验位等不正确)
2335
2335
  105: 认证未通过
2336
2336
  106: 验证平台异常
2337
- */
2337
+ */
2338
2338
  Result?: number;
2339
2339
  /**
2340
2340
  * 结果描述; 未通过时必选
@@ -2379,14 +2379,14 @@ export interface CreateUserRequest {
2379
2379
  */
2380
2380
  Name: string;
2381
2381
  /**
2382
- * 用户证件类型:
2382
+ * 用户证件类型:
2383
2383
  1. ID_CARD - 居民身份证
2384
2384
  2. PASSPORT - 护照
2385
2385
  3. MAINLAND_TRAVEL_PERMIT_FOR_HONGKONG_AND_MACAO_RESIDENTS - 港澳居民来往内地通行证
2386
2386
  4. MAINLAND_TRAVEL_PERMIT_FOR_TAIWAN_RESIDENTS - 台湾居民来往大陆通行证
2387
2387
  5. HOUSEHOLD_REGISTER - 户口本
2388
2388
  6. TEMP_ID_CARD - 临时居民身份证
2389
- */
2389
+ */
2390
2390
  IdCardType: string;
2391
2391
  /**
2392
2392
  * 用户证件号
@@ -2426,10 +2426,10 @@ export interface CreatePreviewSignUrlRequest {
2426
2426
  */
2427
2427
  FlowId?: string;
2428
2428
  /**
2429
- * 签署链接类型:
2429
+ * 签署链接类型:
2430
2430
  1. FLOW - 单流程签署 (默认)
2431
2431
  2. CATALOG - 目录签署
2432
- */
2432
+ */
2433
2433
  SignUrlType?: string;
2434
2434
  }
2435
2435
  /**
@@ -2449,11 +2449,11 @@ export interface CreateUserAndSealRequest {
2449
2449
  */
2450
2450
  Name: string;
2451
2451
  /**
2452
- * 用户证件类型:
2452
+ * 用户证件类型:
2453
2453
  1. ID_CARD - 居民身份证
2454
2454
  5. HOUSEHOLD_REGISTER - 户口本
2455
2455
  6. TEMP_ID_CARD - 临时居民身份证
2456
- */
2456
+ */
2457
2457
  IdCardType: string;
2458
2458
  /**
2459
2459
  * 用户证件号
@@ -2636,28 +2636,28 @@ export interface CheckFaceIdentifyResponse {
2636
2636
  */
2637
2637
  ChannelName?: string;
2638
2638
  /**
2639
- * 认证通过时间
2639
+ * 认证通过时间
2640
2640
  注意:此字段可能返回 null,表示取不到有效值。
2641
- */
2641
+ */
2642
2642
  VerifiedOn?: number;
2643
2643
  /**
2644
2644
  * 核身流水号
2645
2645
  */
2646
2646
  SerialNumber?: string;
2647
2647
  /**
2648
- * 渠道核身服务器IP
2648
+ * 渠道核身服务器IP
2649
2649
  注意:此字段可能返回 null,表示取不到有效值。
2650
- */
2650
+ */
2651
2651
  VerifyServerIp?: string;
2652
2652
  /**
2653
- * 核身照片文件名
2653
+ * 核身照片文件名
2654
2654
  注意:此字段可能返回 null,表示取不到有效值。
2655
- */
2655
+ */
2656
2656
  PhotoFileName?: string;
2657
2657
  /**
2658
- * 核身照片内容base64(文件格式见文件名后缀,一般为jpg)
2658
+ * 核身照片内容base64(文件格式见文件名后缀,一般为jpg)
2659
2659
  注意:此字段可能返回 null,表示取不到有效值。
2660
- */
2660
+ */
2661
2661
  PhotoFileData?: string;
2662
2662
  /**
2663
2663
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -2681,10 +2681,10 @@ export interface Seal {
2681
2681
  */
2682
2682
  SealType: string;
2683
2683
  /**
2684
- * 电子印章来源:
2684
+ * 电子印章来源:
2685
2685
  CREATE - 通过图片上传
2686
2686
  GENERATE - 通过文字生成
2687
- */
2687
+ */
2688
2688
  SealSource: string;
2689
2689
  /**
2690
2690
  * 电子印章创建者
@@ -2736,14 +2736,14 @@ export interface SendFlowUrlRequest {
2736
2736
  */
2737
2737
  SubOrganizationId?: string;
2738
2738
  /**
2739
- * 签名后校验方式:
2739
+ * 签名后校验方式:
2740
2740
  1. WEIXINAPP - 微信小程序;
2741
2741
  2. FACEID - 慧眼 (默认) ;
2742
2742
  3. VERIFYCODE - 验证码;
2743
2743
  4. NONE - 无。此选项为白名单参数,暂不支持公开调用。如需开通权限,请通过客户经理或邮件至e-contract@tencent.com与我们联系;
2744
2744
  5. THIRD - 第三方 (暂不支持)
2745
2745
  6. OFFLINE - 线下人工审核
2746
- */
2746
+ */
2747
2747
  VerifyChannel?: Array<string>;
2748
2748
  /**
2749
2749
  * 签署链接失效截止时间,默认为7天
@@ -2758,9 +2758,9 @@ export interface SendFlowUrlRequest {
2758
2758
  */
2759
2759
  JumpUrl?: string;
2760
2760
  /**
2761
- * 短信模板
2761
+ * 短信模板
2762
2762
  默认使用腾讯电子签官方短信模板,如有自定义需求,请通过客户经理或邮件至e-contract@tencent.com与我们联系。
2763
- */
2763
+ */
2764
2764
  SmsTemplate?: SmsTemplate;
2765
2765
  /**
2766
2766
  * 签署前置条件:是否要全文阅读,默认否
@@ -2920,14 +2920,14 @@ export interface GenerateOrganizationSealRequest {
2920
2920
  */
2921
2921
  Caller: Caller;
2922
2922
  /**
2923
- * 印章类型:
2923
+ * 印章类型:
2924
2924
  OFFICIAL-公章
2925
2925
  SPECIAL_FINANCIAL-财务专用章
2926
2926
  CONTRACT-合同专用章
2927
2927
  LEGAL_REPRESENTATIVE-法定代表人章
2928
2928
  SPECIAL_NATIONWIDE_INVOICE-发票专用章
2929
2929
  OTHER-其他
2930
- */
2930
+ */
2931
2931
  SealType: string;
2932
2932
  /**
2933
2933
  * 请求生成企业印章的客户端Ip
@@ -3026,13 +3026,13 @@ export interface SendFlowRequest {
3026
3026
  */
3027
3027
  SubOrganizationId?: string;
3028
3028
  /**
3029
- * 签名后校验方式:
3029
+ * 签名后校验方式:
3030
3030
  1. WEIXINAPP - 微信小程序;
3031
3031
  2. FACEID - 慧眼 (默认) ;
3032
3032
  3. VERIFYCODE - 验证码;
3033
3033
  4. NONE - 无。此选项为白名单参数,暂不支持公开调用。如需开通权限,请通过客户经理或邮件至e-contract@tencent.com与我们联系;
3034
3034
  5. THIRD - 第三方 (暂不支持)
3035
- */
3035
+ */
3036
3036
  VerifyChannel?: Array<string>;
3037
3037
  /**
3038
3038
  * 签署链接失效截止时间,默认为7天
@@ -3177,7 +3177,7 @@ export interface ModifyUserRequest {
3177
3177
  */
3178
3178
  export interface CheckMobileAndNameResponse {
3179
3179
  /**
3180
- * 检测结果
3180
+ * 检测结果
3181
3181
  计费结果码:
3182
3182
  0: 验证结果一致
3183
3183
  1: 手机号未实名
@@ -3190,7 +3190,7 @@ export interface CheckMobileAndNameResponse {
3190
3190
  104: 非法身份证号(长度,校验位等不正确)
3191
3191
  105: 认证未通过
3192
3192
  106: 验证平台异常
3193
- */
3193
+ */
3194
3194
  Result?: number;
3195
3195
  /**
3196
3196
  * 结果描述; 未通过时必选