tencentcloud-sdk-nodejs-essbasic 4.0.618 → 4.0.620
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.
- package/CHANGELOG.md +487 -0
- package/SERVICE_CHANGELOG.md +478 -156
- package/package.json +1 -1
- package/products.md +30 -30
- package/src/services/essbasic/v20201222/essbasic_models.ts +164 -602
- package/src/services/essbasic/v20210526/essbasic_client.ts +1 -1
- package/src/services/essbasic/v20210526/essbasic_models.ts +357 -823
- package/tencentcloud/services/essbasic/v20201222/essbasic_models.d.ts +164 -164
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +1 -1
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +1 -1
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +357 -300
|
@@ -23,17 +23,14 @@ export interface DescribeFaceIdResultsRequest {
|
|
|
23
23
|
* 调用方信息
|
|
24
24
|
*/
|
|
25
25
|
Caller: Caller
|
|
26
|
-
|
|
27
26
|
/**
|
|
28
27
|
* 慧眼业务ID
|
|
29
28
|
*/
|
|
30
29
|
WbAppId: string
|
|
31
|
-
|
|
32
30
|
/**
|
|
33
31
|
* 订单号(orderNo); 限制在3个或以内
|
|
34
32
|
*/
|
|
35
33
|
OrderNumbers: Array<string>
|
|
36
|
-
|
|
37
34
|
/**
|
|
38
35
|
* 1:视频+照片,2:照片,3:视频,0(或其他数字):无; 可选
|
|
39
36
|
*/
|
|
@@ -48,107 +45,89 @@ export interface CreateSubOrganizationRequest {
|
|
|
48
45
|
* 调用方信息
|
|
49
46
|
*/
|
|
50
47
|
Caller: Caller
|
|
51
|
-
|
|
52
48
|
/**
|
|
53
|
-
|
|
49
|
+
* 机构证件号码类型可选值:
|
|
54
50
|
1. USCC - 统一社会信用代码
|
|
55
51
|
2. BIZREGISTNO - 营业执照注册号
|
|
56
|
-
|
|
52
|
+
*/
|
|
57
53
|
IdCardType: string
|
|
58
|
-
|
|
59
54
|
/**
|
|
60
55
|
* 机构证件号码
|
|
61
56
|
*/
|
|
62
57
|
IdCardNumber: string
|
|
63
|
-
|
|
64
58
|
/**
|
|
65
|
-
|
|
59
|
+
* 机构类型可选值:
|
|
66
60
|
1. ENTERPRISE - 企业
|
|
67
61
|
2. INDIVIDUALBIZ - 个体工商户
|
|
68
62
|
3. PUBLICINSTITUTION - 政府/事业单位
|
|
69
63
|
4. OTHERS - 其他组织
|
|
70
|
-
|
|
64
|
+
*/
|
|
71
65
|
OrganizationType: string
|
|
72
|
-
|
|
73
66
|
/**
|
|
74
67
|
* 机构法人/经营者姓名
|
|
75
68
|
*/
|
|
76
69
|
LegalName: string
|
|
77
|
-
|
|
78
70
|
/**
|
|
79
|
-
|
|
71
|
+
* 机构法人/经营者证件类型可选值:
|
|
80
72
|
1. ID_CARD - 居民身份证
|
|
81
73
|
2. PASSPORT - 护照
|
|
82
74
|
3. MAINLAND_TRAVEL_PERMIT_FOR_HONGKONG_AND_MACAO_RESIDENTS - 港澳居民来往内地通行证
|
|
83
75
|
4. MAINLAND_TRAVEL_PERMIT_FOR_TAIWAN_RESIDENTS - 台湾居民来往大陆通行证
|
|
84
76
|
5. HOUSEHOLD_REGISTER - 户口本
|
|
85
77
|
6. TEMP_ID_CARD - 临时居民身份证
|
|
86
|
-
|
|
78
|
+
*/
|
|
87
79
|
LegalIdCardType: string
|
|
88
|
-
|
|
89
80
|
/**
|
|
90
|
-
|
|
81
|
+
* 机构法人/经营者证件号码;
|
|
91
82
|
OrganizationType 为 ENTERPRISE时,INDIVIDUALBIZ 时必填,其他情况选填
|
|
92
|
-
|
|
83
|
+
*/
|
|
93
84
|
LegalIdCardNumber: string
|
|
94
|
-
|
|
95
85
|
/**
|
|
96
86
|
* 机构名称全称
|
|
97
87
|
*/
|
|
98
88
|
Name: string
|
|
99
|
-
|
|
100
89
|
/**
|
|
101
90
|
* 机构在第三方的唯一标识,32位以内标识符
|
|
102
91
|
*/
|
|
103
92
|
OpenId?: string
|
|
104
|
-
|
|
105
93
|
/**
|
|
106
94
|
* 是否使用OpenId作为数据主键,如果为true,请确保OpenId在当前应用号唯一
|
|
107
95
|
*/
|
|
108
96
|
UseOpenId?: boolean
|
|
109
|
-
|
|
110
97
|
/**
|
|
111
|
-
|
|
98
|
+
* 机构证件文件类型可选值:
|
|
112
99
|
1. USCCFILE - 统一社会信用代码证书
|
|
113
100
|
2. LICENSEFILE - 营业执照
|
|
114
|
-
|
|
101
|
+
*/
|
|
115
102
|
IdCardFileType?: string
|
|
116
|
-
|
|
117
103
|
/**
|
|
118
104
|
* 机构证件照片文件,base64编码,支持jpg、jpeg、png格式
|
|
119
105
|
*/
|
|
120
106
|
BizLicenseFile?: string
|
|
121
|
-
|
|
122
107
|
/**
|
|
123
108
|
* 机构证件照片文件名
|
|
124
109
|
*/
|
|
125
110
|
BizLicenseFileName?: string
|
|
126
|
-
|
|
127
111
|
/**
|
|
128
112
|
* 机构法人/经营者/联系人手机号码
|
|
129
113
|
*/
|
|
130
114
|
LegalMobile?: string
|
|
131
|
-
|
|
132
115
|
/**
|
|
133
116
|
* 组织联系人姓名
|
|
134
117
|
*/
|
|
135
118
|
ContactName?: string
|
|
136
|
-
|
|
137
119
|
/**
|
|
138
120
|
* 实名认证的客户端IP
|
|
139
121
|
*/
|
|
140
122
|
VerifyClientIp?: string
|
|
141
|
-
|
|
142
123
|
/**
|
|
143
124
|
* 实名认证的服务器IP
|
|
144
125
|
*/
|
|
145
126
|
VerifyServerIp?: string
|
|
146
|
-
|
|
147
127
|
/**
|
|
148
128
|
* 企业联系地址
|
|
149
129
|
*/
|
|
150
130
|
ContactAddress?: Address
|
|
151
|
-
|
|
152
131
|
/**
|
|
153
132
|
* 机构电子邮箱
|
|
154
133
|
*/
|
|
@@ -160,18 +139,17 @@ OrganizationType 为 ENTERPRISE时,INDIVIDUALBIZ 时必填,其他情况选
|
|
|
160
139
|
*/
|
|
161
140
|
export interface Component {
|
|
162
141
|
/**
|
|
163
|
-
|
|
142
|
+
* 控件编号
|
|
164
143
|
|
|
165
144
|
注:
|
|
166
145
|
当GenerateMode=3时,通过"^"来决定是否使用关键字整词匹配能力。
|
|
167
146
|
例:
|
|
168
147
|
当GenerateMode=3时,如果传入关键字"^甲方签署^",则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。
|
|
169
148
|
如传入的关键字为"甲方签署",则PDF文件中每个出现关键字的位置都会执行相应操作。
|
|
170
|
-
|
|
149
|
+
*/
|
|
171
150
|
ComponentId?: string
|
|
172
|
-
|
|
173
151
|
/**
|
|
174
|
-
|
|
152
|
+
* 如果是Component控件类型,则可选的字段为:
|
|
175
153
|
TEXT - 普通文本控件;
|
|
176
154
|
DATE - 普通日期控件;
|
|
177
155
|
SELECT- 勾选框控件;
|
|
@@ -179,77 +157,64 @@ SELECT- 勾选框控件;
|
|
|
179
157
|
SIGN_SEAL- 签署印章控件;
|
|
180
158
|
SIGN_DATE- 签署日期控件;
|
|
181
159
|
SIGN_SIGNATURE - 用户签名控件;
|
|
182
|
-
|
|
160
|
+
*/
|
|
183
161
|
ComponentType?: string
|
|
184
|
-
|
|
185
162
|
/**
|
|
186
163
|
* 控件名称
|
|
187
164
|
*/
|
|
188
165
|
ComponentName?: string
|
|
189
|
-
|
|
190
166
|
/**
|
|
191
167
|
* 定义控件是否为必填项,默认为false
|
|
192
168
|
*/
|
|
193
169
|
ComponentRequired?: boolean
|
|
194
|
-
|
|
195
170
|
/**
|
|
196
171
|
* 控件所属文件的序号 (模板中的resourceId排列序号)
|
|
197
172
|
*/
|
|
198
173
|
FileIndex?: number
|
|
199
|
-
|
|
200
174
|
/**
|
|
201
|
-
|
|
175
|
+
* 控件生成的方式:
|
|
202
176
|
0 - 普通控件
|
|
203
177
|
1 - 表单域
|
|
204
178
|
2 - html 控件
|
|
205
179
|
3 - 关键字
|
|
206
|
-
|
|
180
|
+
*/
|
|
207
181
|
GenerateMode?: number
|
|
208
|
-
|
|
209
182
|
/**
|
|
210
183
|
* 参数控件宽度,单位px
|
|
211
184
|
*/
|
|
212
185
|
ComponentWidth?: number
|
|
213
|
-
|
|
214
186
|
/**
|
|
215
187
|
* 参数控件高度,单位px
|
|
216
188
|
*/
|
|
217
189
|
ComponentHeight?: number
|
|
218
|
-
|
|
219
190
|
/**
|
|
220
191
|
* 参数控件所在页码
|
|
221
192
|
*/
|
|
222
193
|
ComponentPage?: number
|
|
223
|
-
|
|
224
194
|
/**
|
|
225
195
|
* 参数控件X位置,单位px
|
|
226
196
|
*/
|
|
227
197
|
ComponentPosX?: number
|
|
228
|
-
|
|
229
198
|
/**
|
|
230
199
|
* 参数控件Y位置,单位px
|
|
231
200
|
*/
|
|
232
201
|
ComponentPosY?: number
|
|
233
|
-
|
|
234
202
|
/**
|
|
235
203
|
* 参数控件样式
|
|
236
204
|
*/
|
|
237
205
|
ComponentExtra?: string
|
|
238
|
-
|
|
239
206
|
/**
|
|
240
|
-
|
|
207
|
+
* 印章ID,如果是手写签名则为jpg或png格式的base64图片
|
|
241
208
|
|
|
242
209
|
SIGN_SEAL控件,可以用ORG_DEFAULT_SEAL表示主企业的默认印章
|
|
243
210
|
SIGN_SEAL控件,可以用SUBORG_DEFAULT_SEAL表示子企业的默认印章
|
|
244
211
|
SIGN_SEAL控件,可以用USER_DEFAULT_SEAL表示个人默认印章
|
|
245
|
-
|
|
212
|
+
*/
|
|
246
213
|
ComponentValue?: string
|
|
247
|
-
|
|
248
214
|
/**
|
|
249
215
|
* 如果是SIGN_SEAL类型的签署控件, 参数标识H5签署界面是否在该签署区上进行放置展示, 1为放置,其他为不放置
|
|
250
216
|
*/
|
|
251
217
|
SealOperate?: number
|
|
252
|
-
|
|
253
218
|
/**
|
|
254
219
|
* 不同GenerateMode对应的额外信息
|
|
255
220
|
*/
|
|
@@ -264,9 +229,8 @@ export interface CreateSealRequest {
|
|
|
264
229
|
* 调用方信息
|
|
265
230
|
*/
|
|
266
231
|
Caller: Caller
|
|
267
|
-
|
|
268
232
|
/**
|
|
269
|
-
|
|
233
|
+
* 印章类型:
|
|
270
234
|
1. PERSONAL - 个人私章
|
|
271
235
|
2. OFFICIAL - 公章
|
|
272
236
|
3. SPECIAL_FINANCIAL - 财务专用章
|
|
@@ -274,34 +238,28 @@ export interface CreateSealRequest {
|
|
|
274
238
|
5. LEGAL_REPRESENTATIVE - 法定代表人章
|
|
275
239
|
6. SPECIAL_NATIONWIDE_INVOICE - 发票专用章
|
|
276
240
|
7. OTHER-其他
|
|
277
|
-
|
|
241
|
+
*/
|
|
278
242
|
SealType: string
|
|
279
|
-
|
|
280
243
|
/**
|
|
281
244
|
* 印章名称
|
|
282
245
|
*/
|
|
283
246
|
SealName: string
|
|
284
|
-
|
|
285
247
|
/**
|
|
286
248
|
* 请求创建印章的客户端IP
|
|
287
249
|
*/
|
|
288
250
|
SourceIp: string
|
|
289
|
-
|
|
290
251
|
/**
|
|
291
252
|
* 印章图片,base64编码(与FileId参数二选一,同时传入参数时优先使用Image参数)
|
|
292
253
|
*/
|
|
293
254
|
Image?: string
|
|
294
|
-
|
|
295
255
|
/**
|
|
296
256
|
* 印章文件图片ID(与Image参数二选一,同时传入参数时优先使用Image参数)
|
|
297
257
|
*/
|
|
298
258
|
FileId?: string
|
|
299
|
-
|
|
300
259
|
/**
|
|
301
260
|
* 需要创建印章的用户ID
|
|
302
261
|
*/
|
|
303
262
|
UserId?: string
|
|
304
|
-
|
|
305
263
|
/**
|
|
306
264
|
* 是否是默认印章 true:是,false:否
|
|
307
265
|
*/
|
|
@@ -323,22 +281,19 @@ export interface CancelFlowResponse {
|
|
|
323
281
|
*/
|
|
324
282
|
export interface FaceIdPhoto {
|
|
325
283
|
/**
|
|
326
|
-
|
|
284
|
+
* 核身结果:
|
|
327
285
|
0 - 通过;
|
|
328
286
|
1 - 未通过
|
|
329
|
-
|
|
287
|
+
*/
|
|
330
288
|
Result: number
|
|
331
|
-
|
|
332
289
|
/**
|
|
333
290
|
* 核身失败描述
|
|
334
291
|
*/
|
|
335
292
|
Description: string
|
|
336
|
-
|
|
337
293
|
/**
|
|
338
294
|
* 照片数据 (base64编码, 一般为JPG或PNG)
|
|
339
295
|
*/
|
|
340
296
|
Photo: string
|
|
341
|
-
|
|
342
297
|
/**
|
|
343
298
|
* 订单号 (orderNo)
|
|
344
299
|
*/
|
|
@@ -353,7 +308,6 @@ export interface VerifySubOrganizationRequest {
|
|
|
353
308
|
* 调用方信息,该接口SubOrganizationId必填
|
|
354
309
|
*/
|
|
355
310
|
Caller: Caller
|
|
356
|
-
|
|
357
311
|
/**
|
|
358
312
|
* 机构在第三方的唯一标识,32位定长字符串,与 Caller 中 SubOrgnizationId 二者至少需要传入一个,全部传入时则使用 SubOrganizationId 信息
|
|
359
313
|
*/
|
|
@@ -368,16 +322,14 @@ export interface VerifyUserRequest {
|
|
|
368
322
|
* 调用方信息
|
|
369
323
|
*/
|
|
370
324
|
Caller: Caller
|
|
371
|
-
|
|
372
325
|
/**
|
|
373
326
|
* 电子签平台用户ID
|
|
374
327
|
*/
|
|
375
328
|
UserId: string
|
|
376
|
-
|
|
377
329
|
/**
|
|
378
|
-
|
|
330
|
+
* 是否需要下发个人长效证书,默认为false
|
|
379
331
|
注:如您有下发个人长效证书需求,请提前邮件至e-contract@oa.com进行申请。
|
|
380
|
-
|
|
332
|
+
*/
|
|
381
333
|
CertificateRequired?: boolean
|
|
382
334
|
}
|
|
383
335
|
|
|
@@ -389,7 +341,6 @@ export interface DescribeFaceIdPhotosResponse {
|
|
|
389
341
|
* 照片信息列表
|
|
390
342
|
*/
|
|
391
343
|
Photos?: Array<FaceIdPhoto>
|
|
392
|
-
|
|
393
344
|
/**
|
|
394
345
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
395
346
|
*/
|
|
@@ -404,17 +355,14 @@ export interface CheckVerifyCodeMatchFlowIdRequest {
|
|
|
404
355
|
* 调用方信息
|
|
405
356
|
*/
|
|
406
357
|
Caller: Caller
|
|
407
|
-
|
|
408
358
|
/**
|
|
409
359
|
* 手机号
|
|
410
360
|
*/
|
|
411
361
|
Mobile: string
|
|
412
|
-
|
|
413
362
|
/**
|
|
414
363
|
* 验证码
|
|
415
364
|
*/
|
|
416
365
|
VerifyCode: string
|
|
417
|
-
|
|
418
366
|
/**
|
|
419
367
|
* 流程(目录) id
|
|
420
368
|
*/
|
|
@@ -429,12 +377,10 @@ export interface CheckBankCard2EVerificationRequest {
|
|
|
429
377
|
* 调用方信息; 必选
|
|
430
378
|
*/
|
|
431
379
|
Caller: Caller
|
|
432
|
-
|
|
433
380
|
/**
|
|
434
381
|
* 银行卡号
|
|
435
382
|
*/
|
|
436
383
|
BankCard: string
|
|
437
|
-
|
|
438
384
|
/**
|
|
439
385
|
* 姓名
|
|
440
386
|
*/
|
|
@@ -449,7 +395,6 @@ export interface DescribeFileIdsByCustomIdsResponse {
|
|
|
449
395
|
* <自定义Id,文件id>数组
|
|
450
396
|
*/
|
|
451
397
|
CustomIdList: Array<CustomFileIdMap>
|
|
452
|
-
|
|
453
398
|
/**
|
|
454
399
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
455
400
|
*/
|
|
@@ -464,7 +409,6 @@ export interface ModifySubOrganizationInfoResponse {
|
|
|
464
409
|
* 子机构ID
|
|
465
410
|
*/
|
|
466
411
|
SubOrganizationId: string
|
|
467
|
-
|
|
468
412
|
/**
|
|
469
413
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
470
414
|
*/
|
|
@@ -479,12 +423,10 @@ export interface DescribeCatalogApproversRequest {
|
|
|
479
423
|
* 调用方信息
|
|
480
424
|
*/
|
|
481
425
|
Caller: Caller
|
|
482
|
-
|
|
483
426
|
/**
|
|
484
427
|
* 目录ID
|
|
485
428
|
*/
|
|
486
429
|
CatalogId: string
|
|
487
|
-
|
|
488
430
|
/**
|
|
489
431
|
* 查询指定用户是否为参与者,为空表示查询所有参与者
|
|
490
432
|
*/
|
|
@@ -499,27 +441,22 @@ export interface CheckFaceIdentifyRequest {
|
|
|
499
441
|
* 调用方信息; 必选
|
|
500
442
|
*/
|
|
501
443
|
Caller: Caller
|
|
502
|
-
|
|
503
444
|
/**
|
|
504
445
|
* 人脸核身渠道; 必选; WEIXINAPP:腾讯电子签小程序,FACEID:腾讯电子签慧眼,None:白名单中的客户直接通过
|
|
505
446
|
*/
|
|
506
447
|
VerifyChannel: string
|
|
507
|
-
|
|
508
448
|
/**
|
|
509
449
|
* 核身订单号; 必选; 对于WEIXINAPP,直接取响应的{VerifyResult};对于FACEID,使用{WbAppId}:{OrderNo}拼接
|
|
510
450
|
*/
|
|
511
451
|
VerifyResult: string
|
|
512
|
-
|
|
513
452
|
/**
|
|
514
453
|
* 要对比的姓名; 可选; 未填写时对比caller.OperatorId的实名信息
|
|
515
454
|
*/
|
|
516
455
|
Name?: string
|
|
517
|
-
|
|
518
456
|
/**
|
|
519
457
|
* 要对比的身份证号码; 可选; 未填写时对比caller.OperatorId的实名信息
|
|
520
458
|
*/
|
|
521
459
|
IdCardNumber?: string
|
|
522
|
-
|
|
523
460
|
/**
|
|
524
461
|
* 是否取认证时的照片
|
|
525
462
|
*/
|
|
@@ -531,12 +468,11 @@ export interface CheckFaceIdentifyRequest {
|
|
|
531
468
|
*/
|
|
532
469
|
export interface CreateServerFlowSignResponse {
|
|
533
470
|
/**
|
|
534
|
-
|
|
471
|
+
* 任务状态:
|
|
535
472
|
0:失败
|
|
536
473
|
1:成功
|
|
537
|
-
|
|
474
|
+
*/
|
|
538
475
|
SignStatus: number
|
|
539
|
-
|
|
540
476
|
/**
|
|
541
477
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
542
478
|
*/
|
|
@@ -551,7 +487,6 @@ export interface ModifyUserResponse {
|
|
|
551
487
|
* 腾讯电子签平台用户唯一标识
|
|
552
488
|
*/
|
|
553
489
|
UserId: string
|
|
554
|
-
|
|
555
490
|
/**
|
|
556
491
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
557
492
|
*/
|
|
@@ -563,7 +498,7 @@ export interface ModifyUserResponse {
|
|
|
563
498
|
*/
|
|
564
499
|
export interface CheckBankCard4EVerificationResponse {
|
|
565
500
|
/**
|
|
566
|
-
|
|
501
|
+
* 检测结果
|
|
567
502
|
计费结果码:
|
|
568
503
|
0: 认证通过
|
|
569
504
|
1: 认证未通过
|
|
@@ -585,14 +520,12 @@ export interface CheckBankCard4EVerificationResponse {
|
|
|
585
520
|
103: 验证中心服务繁忙
|
|
586
521
|
104: 身份证号码有误
|
|
587
522
|
105: 手机号码不合法
|
|
588
|
-
|
|
523
|
+
*/
|
|
589
524
|
Result?: number
|
|
590
|
-
|
|
591
525
|
/**
|
|
592
526
|
* 结果描述; 未通过时必选
|
|
593
527
|
*/
|
|
594
528
|
Description?: string
|
|
595
|
-
|
|
596
529
|
/**
|
|
597
530
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
598
531
|
*/
|
|
@@ -607,36 +540,30 @@ export interface DescribeFileUrlsRequest {
|
|
|
607
540
|
* 调用方信息
|
|
608
541
|
*/
|
|
609
542
|
Caller: Caller
|
|
610
|
-
|
|
611
543
|
/**
|
|
612
544
|
* 业务编号数组,如模板编号、文档编号、印章编号、流程编号、目录编号
|
|
613
545
|
*/
|
|
614
546
|
BusinessIds: Array<string>
|
|
615
|
-
|
|
616
547
|
/**
|
|
617
|
-
|
|
548
|
+
* 业务类型:
|
|
618
549
|
1. TEMPLATE - 模板
|
|
619
550
|
2. SEAL - 印章
|
|
620
551
|
3. FLOW - 流程
|
|
621
552
|
4.CATALOG - 目录
|
|
622
|
-
|
|
553
|
+
*/
|
|
623
554
|
BusinessType: string
|
|
624
|
-
|
|
625
555
|
/**
|
|
626
556
|
* 下载后的文件命名,只有FileType为“ZIP”时生效
|
|
627
557
|
*/
|
|
628
558
|
FileName?: string
|
|
629
|
-
|
|
630
559
|
/**
|
|
631
560
|
* 单个业务ID多个资源情况下,指定资源起始偏移量
|
|
632
561
|
*/
|
|
633
562
|
ResourceOffset?: number
|
|
634
|
-
|
|
635
563
|
/**
|
|
636
564
|
* 单个业务ID多个资源情况下,指定资源数量
|
|
637
565
|
*/
|
|
638
566
|
ResourceLimit?: number
|
|
639
|
-
|
|
640
567
|
/**
|
|
641
568
|
* 文件类型,支持"JPG", "PDF","ZIP"等,默认为上传的文件类型
|
|
642
569
|
*/
|
|
@@ -651,32 +578,26 @@ export interface FlowFileInfo {
|
|
|
651
578
|
* 文件序号
|
|
652
579
|
*/
|
|
653
580
|
FileIndex: number
|
|
654
|
-
|
|
655
581
|
/**
|
|
656
582
|
* 文件类型
|
|
657
583
|
*/
|
|
658
584
|
FileType: string
|
|
659
|
-
|
|
660
585
|
/**
|
|
661
586
|
* 文件的MD5码
|
|
662
587
|
*/
|
|
663
588
|
FileMd5: string
|
|
664
|
-
|
|
665
589
|
/**
|
|
666
590
|
* 文件名
|
|
667
591
|
*/
|
|
668
592
|
FileName: string
|
|
669
|
-
|
|
670
593
|
/**
|
|
671
594
|
* 文件大小,单位为Byte
|
|
672
595
|
*/
|
|
673
596
|
FileSize: number
|
|
674
|
-
|
|
675
597
|
/**
|
|
676
598
|
* 文件创建时间戳
|
|
677
599
|
*/
|
|
678
600
|
CreatedOn: number
|
|
679
|
-
|
|
680
601
|
/**
|
|
681
602
|
* 文件的下载地址
|
|
682
603
|
*/
|
|
@@ -691,7 +612,6 @@ export interface SmsTemplate {
|
|
|
691
612
|
* 模板ID,必须填写已审核通过的模板ID。模板ID可登录短信控制台查看。
|
|
692
613
|
*/
|
|
693
614
|
TemplateId: string
|
|
694
|
-
|
|
695
615
|
/**
|
|
696
616
|
* 短信签名内容,使用UTF-8编码,必须填写已审核通过的签名,签名信息可登录短信控制台查看。
|
|
697
617
|
*/
|
|
@@ -706,22 +626,18 @@ export interface Address {
|
|
|
706
626
|
* 省份
|
|
707
627
|
*/
|
|
708
628
|
Province: string
|
|
709
|
-
|
|
710
629
|
/**
|
|
711
630
|
* 城市
|
|
712
631
|
*/
|
|
713
632
|
City: string
|
|
714
|
-
|
|
715
633
|
/**
|
|
716
634
|
* 区县
|
|
717
635
|
*/
|
|
718
636
|
County: string
|
|
719
|
-
|
|
720
637
|
/**
|
|
721
638
|
* 详细地址
|
|
722
639
|
*/
|
|
723
640
|
Details: string
|
|
724
|
-
|
|
725
641
|
/**
|
|
726
642
|
* 国家,默认中国
|
|
727
643
|
*/
|
|
@@ -736,17 +652,14 @@ export interface ModifyUserDefaultSealRequest {
|
|
|
736
652
|
* 调用方信息
|
|
737
653
|
*/
|
|
738
654
|
Caller: Caller
|
|
739
|
-
|
|
740
655
|
/**
|
|
741
656
|
* 用户唯一标识,需要重新指定默认印章的用户ID
|
|
742
657
|
*/
|
|
743
658
|
UserId: string
|
|
744
|
-
|
|
745
659
|
/**
|
|
746
660
|
* 重新指定的默认印章ID
|
|
747
661
|
*/
|
|
748
662
|
SealId: string
|
|
749
|
-
|
|
750
663
|
/**
|
|
751
664
|
* 请求重新指定个人默认印章的客户端IP
|
|
752
665
|
*/
|
|
@@ -761,22 +674,18 @@ export interface GenerateUserSealRequest {
|
|
|
761
674
|
* 调用方信息
|
|
762
675
|
*/
|
|
763
676
|
Caller: Caller
|
|
764
|
-
|
|
765
677
|
/**
|
|
766
678
|
* 用户ID
|
|
767
679
|
*/
|
|
768
680
|
UserId: string
|
|
769
|
-
|
|
770
681
|
/**
|
|
771
682
|
* 请求生成个人印章的客户端IP
|
|
772
683
|
*/
|
|
773
684
|
SourceIp: string
|
|
774
|
-
|
|
775
685
|
/**
|
|
776
686
|
* 电子印章名称
|
|
777
687
|
*/
|
|
778
688
|
SealName?: string
|
|
779
|
-
|
|
780
689
|
/**
|
|
781
690
|
* 是否是默认印章 true:是,false:否
|
|
782
691
|
*/
|
|
@@ -788,7 +697,7 @@ export interface GenerateUserSealRequest {
|
|
|
788
697
|
*/
|
|
789
698
|
export interface CheckIdCardVerificationResponse {
|
|
790
699
|
/**
|
|
791
|
-
|
|
700
|
+
* 检测结果;
|
|
792
701
|
收费错误码:
|
|
793
702
|
0: 通过,
|
|
794
703
|
1: 姓名和身份证号不一致,
|
|
@@ -797,14 +706,12 @@ export interface CheckIdCardVerificationResponse {
|
|
|
797
706
|
102: 非法姓名(长度,格式等不正确),
|
|
798
707
|
103: 验证平台异常,
|
|
799
708
|
104: 证件库中无此身份证记录
|
|
800
|
-
|
|
709
|
+
*/
|
|
801
710
|
Result?: number
|
|
802
|
-
|
|
803
711
|
/**
|
|
804
712
|
* 结果描述; 未通过时必选
|
|
805
713
|
*/
|
|
806
714
|
Description?: string
|
|
807
|
-
|
|
808
715
|
/**
|
|
809
716
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
810
717
|
*/
|
|
@@ -819,29 +726,24 @@ export interface DescribeFlowResponse {
|
|
|
819
726
|
* 流程创建者信息
|
|
820
727
|
*/
|
|
821
728
|
Creator: Caller
|
|
822
|
-
|
|
823
729
|
/**
|
|
824
730
|
* 流程编号
|
|
825
731
|
*/
|
|
826
732
|
FlowId: string
|
|
827
|
-
|
|
828
733
|
/**
|
|
829
734
|
* 流程名称
|
|
830
735
|
*/
|
|
831
736
|
FlowName: string
|
|
832
|
-
|
|
833
737
|
/**
|
|
834
738
|
* 流程描述
|
|
835
739
|
*/
|
|
836
740
|
FlowDescription: string
|
|
837
|
-
|
|
838
741
|
/**
|
|
839
742
|
* 流程的类型: ”劳务合同“,”租赁合同“,”销售合同“,”其他“
|
|
840
743
|
*/
|
|
841
744
|
FlowType: string
|
|
842
|
-
|
|
843
745
|
/**
|
|
844
|
-
|
|
746
|
+
* 流程状态:
|
|
845
747
|
0-创建;
|
|
846
748
|
1-签署中;
|
|
847
749
|
2-拒签;
|
|
@@ -850,34 +752,28 @@ export interface DescribeFlowResponse {
|
|
|
850
752
|
5-已过期;
|
|
851
753
|
6-已销毁
|
|
852
754
|
7-签署完成未归档
|
|
853
|
-
|
|
755
|
+
*/
|
|
854
756
|
FlowStatus: number
|
|
855
|
-
|
|
856
757
|
/**
|
|
857
758
|
* 流程创建时间
|
|
858
759
|
*/
|
|
859
760
|
CreatedOn: number
|
|
860
|
-
|
|
861
761
|
/**
|
|
862
762
|
* 流程完成时间
|
|
863
763
|
*/
|
|
864
764
|
UpdatedOn: number
|
|
865
|
-
|
|
866
765
|
/**
|
|
867
766
|
* 流程截止日期
|
|
868
767
|
*/
|
|
869
768
|
Deadline: number
|
|
870
|
-
|
|
871
769
|
/**
|
|
872
770
|
* 回调地址
|
|
873
771
|
*/
|
|
874
772
|
CallbackUrl: string
|
|
875
|
-
|
|
876
773
|
/**
|
|
877
774
|
* 流程中止原因
|
|
878
775
|
*/
|
|
879
776
|
FlowMessage: string
|
|
880
|
-
|
|
881
777
|
/**
|
|
882
778
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
883
779
|
*/
|
|
@@ -892,128 +788,107 @@ export interface CreateSubOrganizationAndSealRequest {
|
|
|
892
788
|
* 调用方信息
|
|
893
789
|
*/
|
|
894
790
|
Caller: Caller
|
|
895
|
-
|
|
896
791
|
/**
|
|
897
792
|
* 机构名称全称
|
|
898
793
|
*/
|
|
899
794
|
Name: string
|
|
900
|
-
|
|
901
795
|
/**
|
|
902
|
-
|
|
796
|
+
* 机构证件号码类型可选值:
|
|
903
797
|
1. USCC - 统一社会信用代码
|
|
904
798
|
2. BIZREGISTNO - 营业执照注册号
|
|
905
|
-
|
|
799
|
+
*/
|
|
906
800
|
IdCardType: string
|
|
907
|
-
|
|
908
801
|
/**
|
|
909
802
|
* 机构证件号码
|
|
910
803
|
*/
|
|
911
804
|
IdCardNumber: string
|
|
912
|
-
|
|
913
805
|
/**
|
|
914
|
-
|
|
806
|
+
* 机构类型可选值:
|
|
915
807
|
1. ENTERPRISE - 企业
|
|
916
808
|
2. INDIVIDUALBIZ - 个体工商户
|
|
917
809
|
3. PUBLICINSTITUTION - 政府/事业单位
|
|
918
810
|
4. OTHERS - 其他组织
|
|
919
|
-
|
|
811
|
+
*/
|
|
920
812
|
OrganizationType: string
|
|
921
|
-
|
|
922
813
|
/**
|
|
923
814
|
* 机构法人/经营者姓名
|
|
924
815
|
*/
|
|
925
816
|
LegalName: string
|
|
926
|
-
|
|
927
817
|
/**
|
|
928
|
-
|
|
818
|
+
* 机构法人/经营者证件类型可选值:
|
|
929
819
|
1. ID_CARD - 居民身份证
|
|
930
820
|
2. PASSPORT - 护照
|
|
931
821
|
3. MAINLAND_TRAVEL_PERMIT_FOR_HONGKONG_AND_MACAO_RESIDENTS - 港澳居民来往内地通行证
|
|
932
822
|
4. MAINLAND_TRAVEL_PERMIT_FOR_TAIWAN_RESIDENTS - 台湾居民来往大陆通行证
|
|
933
823
|
5. HOUSEHOLD_REGISTER - 户口本
|
|
934
824
|
6. TEMP_ID_CARD - 临时居民身份证
|
|
935
|
-
|
|
825
|
+
*/
|
|
936
826
|
LegalIdCardType: string
|
|
937
|
-
|
|
938
827
|
/**
|
|
939
|
-
|
|
828
|
+
* 机构法人/经营者证件号码;
|
|
940
829
|
OrganizationType 为 ENTERPRISE时,INDIVIDUALBIZ 时必填,其他情况选填
|
|
941
|
-
|
|
830
|
+
*/
|
|
942
831
|
LegalIdCardNumber: string
|
|
943
|
-
|
|
944
832
|
/**
|
|
945
833
|
* 实名认证的客户端IP/请求生成企业印章的客户端Ip
|
|
946
834
|
*/
|
|
947
835
|
VerifyClientIp: string
|
|
948
|
-
|
|
949
836
|
/**
|
|
950
837
|
* 机构电子邮箱
|
|
951
838
|
*/
|
|
952
839
|
Email?: string
|
|
953
|
-
|
|
954
840
|
/**
|
|
955
|
-
|
|
841
|
+
* 机构证件文件类型可选值:
|
|
956
842
|
1. USCCFILE - 统一社会信用代码证书
|
|
957
843
|
2. LICENSEFILE - 营业执照
|
|
958
|
-
|
|
844
|
+
*/
|
|
959
845
|
IdCardFileType?: string
|
|
960
|
-
|
|
961
846
|
/**
|
|
962
847
|
* 机构证件照片文件,base64编码,支持jpg、jpeg、png格式
|
|
963
848
|
*/
|
|
964
849
|
BizLicenseFile?: string
|
|
965
|
-
|
|
966
850
|
/**
|
|
967
851
|
* 机构证件照片文件名
|
|
968
852
|
*/
|
|
969
853
|
BizLicenseFileName?: string
|
|
970
|
-
|
|
971
854
|
/**
|
|
972
855
|
* 机构法人/经营者/联系人手机号码
|
|
973
856
|
*/
|
|
974
857
|
LegalMobile?: string
|
|
975
|
-
|
|
976
858
|
/**
|
|
977
859
|
* 组织联系人姓名
|
|
978
860
|
*/
|
|
979
861
|
ContactName?: string
|
|
980
|
-
|
|
981
862
|
/**
|
|
982
863
|
* 实名认证的服务器IP
|
|
983
864
|
*/
|
|
984
865
|
VerifyServerIp?: string
|
|
985
|
-
|
|
986
866
|
/**
|
|
987
867
|
* 企业联系地址
|
|
988
868
|
*/
|
|
989
869
|
ContactAddress?: Address
|
|
990
|
-
|
|
991
870
|
/**
|
|
992
871
|
* 电子印章名称
|
|
993
872
|
*/
|
|
994
873
|
SealName?: string
|
|
995
|
-
|
|
996
874
|
/**
|
|
997
|
-
|
|
875
|
+
* 印章类型:默认: CONTRACT
|
|
998
876
|
1. OFFICIAL-公章
|
|
999
877
|
2. SPECIAL_FINANCIAL-财务专用章
|
|
1000
878
|
3. CONTRACT-合同专用章
|
|
1001
879
|
4. LEGAL_REPRESENTATIVE-法定代表人章
|
|
1002
880
|
5. SPECIAL_NATIONWIDE_INVOICE-发票专用章
|
|
1003
881
|
6. OTHER-其他
|
|
1004
|
-
|
|
882
|
+
*/
|
|
1005
883
|
SealType?: string
|
|
1006
|
-
|
|
1007
884
|
/**
|
|
1008
885
|
* 企业印章横向文字,最多可填8个汉字(可为空,默认为"电子签名专用章")
|
|
1009
886
|
*/
|
|
1010
887
|
SealHorizontalText?: string
|
|
1011
|
-
|
|
1012
888
|
/**
|
|
1013
889
|
* 机构在第三方的唯一标识,32位以内标识符
|
|
1014
890
|
*/
|
|
1015
891
|
OpenId?: string
|
|
1016
|
-
|
|
1017
892
|
/**
|
|
1018
893
|
* 是否使用OpenId作为数据主键,如果为true,请确保OpenId在当前应用号唯一
|
|
1019
894
|
*/
|
|
@@ -1028,22 +903,18 @@ export interface CheckMobileVerificationRequest {
|
|
|
1028
903
|
* 调用方信息; 必选
|
|
1029
904
|
*/
|
|
1030
905
|
Caller: Caller
|
|
1031
|
-
|
|
1032
906
|
/**
|
|
1033
907
|
* 手机号
|
|
1034
908
|
*/
|
|
1035
909
|
Mobile: string
|
|
1036
|
-
|
|
1037
910
|
/**
|
|
1038
911
|
* 姓名
|
|
1039
912
|
*/
|
|
1040
913
|
Name: string
|
|
1041
|
-
|
|
1042
914
|
/**
|
|
1043
915
|
* 身份证件号码
|
|
1044
916
|
*/
|
|
1045
917
|
IdCardNumber: string
|
|
1046
|
-
|
|
1047
918
|
/**
|
|
1048
919
|
* 身份证件类型; ID_CARD
|
|
1049
920
|
*/
|
|
@@ -1058,12 +929,10 @@ export interface SendFlowUrlResponse {
|
|
|
1058
929
|
* 签署任务ID,标识每一次的流程发送
|
|
1059
930
|
*/
|
|
1060
931
|
SignId: string
|
|
1061
|
-
|
|
1062
932
|
/**
|
|
1063
933
|
* 签署链接
|
|
1064
934
|
*/
|
|
1065
935
|
SignUrl?: string
|
|
1066
|
-
|
|
1067
936
|
/**
|
|
1068
937
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1069
938
|
*/
|
|
@@ -1078,7 +947,6 @@ export interface DescribeCatalogApproversResponse {
|
|
|
1078
947
|
* 参与者列表
|
|
1079
948
|
*/
|
|
1080
949
|
Approvers: Array<CatalogApprovers>
|
|
1081
|
-
|
|
1082
950
|
/**
|
|
1083
951
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1084
952
|
*/
|
|
@@ -1093,7 +961,6 @@ export interface CustomFileIdMap {
|
|
|
1093
961
|
* 用户自定义ID
|
|
1094
962
|
*/
|
|
1095
963
|
CustomId: string
|
|
1096
|
-
|
|
1097
964
|
/**
|
|
1098
965
|
* 文件id
|
|
1099
966
|
*/
|
|
@@ -1108,7 +975,6 @@ export interface SendFlowResponse {
|
|
|
1108
975
|
* 签署任务ID,标识每一次的流程发送
|
|
1109
976
|
*/
|
|
1110
977
|
SignId: string
|
|
1111
|
-
|
|
1112
978
|
/**
|
|
1113
979
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1114
980
|
*/
|
|
@@ -1123,7 +989,6 @@ export interface CatalogApprovers {
|
|
|
1123
989
|
* 流程ID
|
|
1124
990
|
*/
|
|
1125
991
|
FlowId: string
|
|
1126
|
-
|
|
1127
992
|
/**
|
|
1128
993
|
* 参与者列表
|
|
1129
994
|
*/
|
|
@@ -1138,12 +1003,10 @@ export interface DescribeSealsRequest {
|
|
|
1138
1003
|
* 调用方信息
|
|
1139
1004
|
*/
|
|
1140
1005
|
Caller: Caller
|
|
1141
|
-
|
|
1142
1006
|
/**
|
|
1143
1007
|
* 印章ID列表
|
|
1144
1008
|
*/
|
|
1145
1009
|
SealIds: Array<string>
|
|
1146
|
-
|
|
1147
1010
|
/**
|
|
1148
1011
|
* 用户唯一标识
|
|
1149
1012
|
*/
|
|
@@ -1158,18 +1021,16 @@ export interface FlowApproverInfo {
|
|
|
1158
1021
|
* 用户ID
|
|
1159
1022
|
*/
|
|
1160
1023
|
UserId: string
|
|
1161
|
-
|
|
1162
1024
|
/**
|
|
1163
|
-
|
|
1025
|
+
* 认证方式:
|
|
1164
1026
|
WEIXINAPP - 微信小程序;
|
|
1165
1027
|
FACEID - 慧眼 (默认);
|
|
1166
1028
|
VERIFYCODE - 验证码;
|
|
1167
1029
|
THIRD - 第三方 (暂不支持)
|
|
1168
|
-
|
|
1030
|
+
*/
|
|
1169
1031
|
VerifyChannel: Array<string>
|
|
1170
|
-
|
|
1171
1032
|
/**
|
|
1172
|
-
|
|
1033
|
+
* 签署状态:
|
|
1173
1034
|
0 - 待签署;
|
|
1174
1035
|
1- 已签署;
|
|
1175
1036
|
2 - 拒绝;
|
|
@@ -1178,101 +1039,84 @@ THIRD - 第三方 (暂不支持)
|
|
|
1178
1039
|
12-审核中,
|
|
1179
1040
|
13-审核驳回
|
|
1180
1041
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1181
|
-
|
|
1042
|
+
*/
|
|
1182
1043
|
ApproveStatus: number
|
|
1183
|
-
|
|
1184
1044
|
/**
|
|
1185
|
-
|
|
1045
|
+
* 拒签/签署/审核驳回原因
|
|
1186
1046
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1187
|
-
|
|
1047
|
+
*/
|
|
1188
1048
|
ApproveMessage: string
|
|
1189
|
-
|
|
1190
1049
|
/**
|
|
1191
|
-
|
|
1050
|
+
* 签约时间的时间戳
|
|
1192
1051
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1193
|
-
|
|
1052
|
+
*/
|
|
1194
1053
|
ApproveTime: number
|
|
1195
|
-
|
|
1196
1054
|
/**
|
|
1197
|
-
|
|
1055
|
+
* 签署企业ID
|
|
1198
1056
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1199
|
-
|
|
1057
|
+
*/
|
|
1200
1058
|
SubOrganizationId: string
|
|
1201
|
-
|
|
1202
1059
|
/**
|
|
1203
|
-
|
|
1060
|
+
* 签署完成后跳转的URL
|
|
1204
1061
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1205
|
-
|
|
1062
|
+
*/
|
|
1206
1063
|
JumpUrl: string
|
|
1207
|
-
|
|
1208
1064
|
/**
|
|
1209
|
-
|
|
1065
|
+
* 用户签署区ID到印章ID的映射集合
|
|
1210
1066
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1211
|
-
|
|
1067
|
+
*/
|
|
1212
1068
|
ComponentSeals: Array<ComponentSeal>
|
|
1213
|
-
|
|
1214
1069
|
/**
|
|
1215
1070
|
* 签署前置条件:是否强制用户全文阅读,即阅读到待签署文档的最后一页。默认FALSE
|
|
1216
1071
|
*/
|
|
1217
1072
|
IsFullText: boolean
|
|
1218
|
-
|
|
1219
1073
|
/**
|
|
1220
1074
|
* 签署前置条件:强制阅读时长,页面停留时长不足则不允许签署。默认不限制
|
|
1221
1075
|
*/
|
|
1222
1076
|
PreReadTime: number
|
|
1223
|
-
|
|
1224
1077
|
/**
|
|
1225
1078
|
* 签署人手机号,脱敏显示
|
|
1226
1079
|
*/
|
|
1227
1080
|
Mobile: string
|
|
1228
|
-
|
|
1229
1081
|
/**
|
|
1230
1082
|
* 签署链接截止时间,默认签署流程发起后7天失效
|
|
1231
1083
|
*/
|
|
1232
1084
|
Deadline: number
|
|
1233
|
-
|
|
1234
1085
|
/**
|
|
1235
1086
|
* 是否为最后一个签署人, 若为最后一人,则其签署完成后自动归档
|
|
1236
1087
|
*/
|
|
1237
1088
|
IsLastApprover: boolean
|
|
1238
|
-
|
|
1239
1089
|
/**
|
|
1240
|
-
|
|
1090
|
+
* 短信模板
|
|
1241
1091
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1242
|
-
|
|
1092
|
+
*/
|
|
1243
1093
|
SmsTemplate: SmsTemplate
|
|
1244
|
-
|
|
1245
1094
|
/**
|
|
1246
1095
|
* 身份证号,脱敏显示
|
|
1247
1096
|
*/
|
|
1248
1097
|
IdCardNumber: string
|
|
1249
|
-
|
|
1250
1098
|
/**
|
|
1251
1099
|
* 用户姓名
|
|
1252
1100
|
*/
|
|
1253
1101
|
Name: string
|
|
1254
|
-
|
|
1255
1102
|
/**
|
|
1256
1103
|
* 是否支持线下核身
|
|
1257
1104
|
*/
|
|
1258
1105
|
CanOffLine: boolean
|
|
1259
|
-
|
|
1260
1106
|
/**
|
|
1261
|
-
|
|
1107
|
+
* 证件号码类型:ID_CARD - 身份证,PASSPORT - 护照,MAINLAND_TRAVEL_PERMIT_FOR_HONGKONG_AND_MACAO_RESIDENTS - 港澳居民来往内地通行证; 暂不支持用于电子签自有平台实名认证,MAINLAND_TRAVEL_PERMIT_FOR_TAIWAN_RESIDENTS - 台湾居民来往大陆通行证; 暂不支持用于电子签自有平台实名认证,HOUSEHOLD_REGISTER - 户口本; 暂不支持用于电子签自有平台实名认证,TEMP_ID_CARD - 临时居民身份证; 暂不支持用于电子签自有平台实名认证
|
|
1262
1108
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1263
|
-
|
|
1109
|
+
*/
|
|
1264
1110
|
IdCardType: string
|
|
1265
|
-
|
|
1266
1111
|
/**
|
|
1267
|
-
|
|
1112
|
+
* 签署回调地址
|
|
1268
1113
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1269
|
-
|
|
1114
|
+
*/
|
|
1270
1115
|
CallbackUrl: string
|
|
1271
|
-
|
|
1272
1116
|
/**
|
|
1273
|
-
|
|
1117
|
+
* 签署任务ID,标识每一次的流程发送
|
|
1274
1118
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1275
|
-
|
|
1119
|
+
*/
|
|
1276
1120
|
SignId: string
|
|
1277
1121
|
}
|
|
1278
1122
|
|
|
@@ -1284,7 +1128,6 @@ export interface DescribeFlowFilesRequest {
|
|
|
1284
1128
|
* 调用方信息; 必选
|
|
1285
1129
|
*/
|
|
1286
1130
|
Caller: Caller
|
|
1287
|
-
|
|
1288
1131
|
/**
|
|
1289
1132
|
* 需要查询的流程ID
|
|
1290
1133
|
*/
|
|
@@ -1299,7 +1142,6 @@ export interface DescribeCustomFlowIdsResponse {
|
|
|
1299
1142
|
* 自定义流程 id 映射列表
|
|
1300
1143
|
*/
|
|
1301
1144
|
CustomIdList: Array<CustomFlowIdMap>
|
|
1302
|
-
|
|
1303
1145
|
/**
|
|
1304
1146
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1305
1147
|
*/
|
|
@@ -1314,113 +1156,93 @@ export interface SubOrganizationDetail {
|
|
|
1314
1156
|
* 组织ID
|
|
1315
1157
|
*/
|
|
1316
1158
|
Id: string
|
|
1317
|
-
|
|
1318
1159
|
/**
|
|
1319
1160
|
* 机构名称全称
|
|
1320
1161
|
*/
|
|
1321
1162
|
Name: string
|
|
1322
|
-
|
|
1323
1163
|
/**
|
|
1324
1164
|
* 机构电子邮箱
|
|
1325
1165
|
*/
|
|
1326
1166
|
Email: string
|
|
1327
|
-
|
|
1328
1167
|
/**
|
|
1329
1168
|
* 机构证件号码类型
|
|
1330
1169
|
*/
|
|
1331
1170
|
IdCardType: string
|
|
1332
|
-
|
|
1333
1171
|
/**
|
|
1334
1172
|
* 机构证件号码
|
|
1335
1173
|
*/
|
|
1336
1174
|
IdCardNumber: string
|
|
1337
|
-
|
|
1338
1175
|
/**
|
|
1339
1176
|
* 机构类型
|
|
1340
1177
|
*/
|
|
1341
1178
|
OrganizationType: string
|
|
1342
|
-
|
|
1343
1179
|
/**
|
|
1344
|
-
|
|
1180
|
+
* 机构证件文件类型
|
|
1345
1181
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1346
|
-
|
|
1182
|
+
*/
|
|
1347
1183
|
IdCardFileType: string
|
|
1348
|
-
|
|
1349
1184
|
/**
|
|
1350
|
-
|
|
1185
|
+
* 机构证件照片文件,base64编码
|
|
1351
1186
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1352
|
-
|
|
1187
|
+
*/
|
|
1353
1188
|
BizLicenseFile: string
|
|
1354
|
-
|
|
1355
1189
|
/**
|
|
1356
1190
|
* 机构证件照片文件名
|
|
1357
1191
|
*/
|
|
1358
1192
|
BizLicenseFileName: string
|
|
1359
|
-
|
|
1360
1193
|
/**
|
|
1361
1194
|
* 机构法人/经营者姓名
|
|
1362
1195
|
*/
|
|
1363
1196
|
LegalName: string
|
|
1364
|
-
|
|
1365
1197
|
/**
|
|
1366
1198
|
* 机构法人/经营者证件类型
|
|
1367
1199
|
*/
|
|
1368
1200
|
LegalIdCardType: string
|
|
1369
|
-
|
|
1370
1201
|
/**
|
|
1371
1202
|
* 机构法人/经营者证件号码
|
|
1372
1203
|
*/
|
|
1373
1204
|
LegalIdCardNumber: string
|
|
1374
|
-
|
|
1375
1205
|
/**
|
|
1376
1206
|
* 机构法人/经营者/联系人手机号码
|
|
1377
1207
|
*/
|
|
1378
1208
|
LegalMobile: string
|
|
1379
|
-
|
|
1380
1209
|
/**
|
|
1381
|
-
|
|
1210
|
+
* 组织联系人姓名
|
|
1382
1211
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1383
|
-
|
|
1212
|
+
*/
|
|
1384
1213
|
ContactName: string
|
|
1385
|
-
|
|
1386
1214
|
/**
|
|
1387
1215
|
* 机构实名状态
|
|
1388
1216
|
*/
|
|
1389
1217
|
VerifyStatus: string
|
|
1390
|
-
|
|
1391
1218
|
/**
|
|
1392
|
-
|
|
1219
|
+
* 机构通过实名时间
|
|
1393
1220
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1394
|
-
|
|
1221
|
+
*/
|
|
1395
1222
|
VerifiedOn: number
|
|
1396
|
-
|
|
1397
1223
|
/**
|
|
1398
1224
|
* 机构创建时间
|
|
1399
1225
|
*/
|
|
1400
1226
|
CreatedOn: number
|
|
1401
|
-
|
|
1402
1227
|
/**
|
|
1403
|
-
|
|
1228
|
+
* 机构更新时间
|
|
1404
1229
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1405
|
-
|
|
1230
|
+
*/
|
|
1406
1231
|
UpdatedOn: number
|
|
1407
|
-
|
|
1408
1232
|
/**
|
|
1409
|
-
|
|
1233
|
+
* 实名认证的客户端IP
|
|
1410
1234
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1411
|
-
|
|
1235
|
+
*/
|
|
1412
1236
|
VerifyClientIp: string
|
|
1413
|
-
|
|
1414
1237
|
/**
|
|
1415
|
-
|
|
1238
|
+
* 实名认证的服务器IP
|
|
1416
1239
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1417
|
-
|
|
1240
|
+
*/
|
|
1418
1241
|
VerifyServerIp: string
|
|
1419
|
-
|
|
1420
1242
|
/**
|
|
1421
|
-
|
|
1243
|
+
* 企业联系地址
|
|
1422
1244
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1423
|
-
|
|
1245
|
+
*/
|
|
1424
1246
|
ContactAddress: Address
|
|
1425
1247
|
}
|
|
1426
1248
|
|
|
@@ -1432,17 +1254,14 @@ export interface CheckIdCardVerificationRequest {
|
|
|
1432
1254
|
* 调用方信息; 必选
|
|
1433
1255
|
*/
|
|
1434
1256
|
Caller: Caller
|
|
1435
|
-
|
|
1436
1257
|
/**
|
|
1437
1258
|
* 姓名
|
|
1438
1259
|
*/
|
|
1439
1260
|
Name: string
|
|
1440
|
-
|
|
1441
1261
|
/**
|
|
1442
1262
|
* 身份证件号码
|
|
1443
1263
|
*/
|
|
1444
1264
|
IdCardNumber: string
|
|
1445
|
-
|
|
1446
1265
|
/**
|
|
1447
1266
|
* 身份证件类型; ID_CARD
|
|
1448
1267
|
*/
|
|
@@ -1457,7 +1276,6 @@ export interface CreateSignUrlResponse {
|
|
|
1457
1276
|
* 合同签署链接
|
|
1458
1277
|
*/
|
|
1459
1278
|
SignUrl: string
|
|
1460
|
-
|
|
1461
1279
|
/**
|
|
1462
1280
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1463
1281
|
*/
|
|
@@ -1472,66 +1290,54 @@ export interface ModifySubOrganizationInfoRequest {
|
|
|
1472
1290
|
* 调用方信息,该接口 SubOrganizationId 字段与 OpenId 字段二者至少需要传入一个,全部传入时则使用 SubOrganizationId 信息
|
|
1473
1291
|
*/
|
|
1474
1292
|
Caller: Caller
|
|
1475
|
-
|
|
1476
1293
|
/**
|
|
1477
1294
|
* 机构在第三方的唯一标识,32位定长字符串,与 Caller 中 SubOrgnizationId 二者至少需要传入一个,全部传入时则使用 SubOrganizationId 信息
|
|
1478
1295
|
*/
|
|
1479
1296
|
OpenId?: string
|
|
1480
|
-
|
|
1481
1297
|
/**
|
|
1482
1298
|
* 机构名称全称,修改后机构状态将变为未实名,需要调用实名接口重新实名。
|
|
1483
1299
|
*/
|
|
1484
1300
|
Name?: string
|
|
1485
|
-
|
|
1486
1301
|
/**
|
|
1487
|
-
|
|
1302
|
+
* 机构类型可选值:
|
|
1488
1303
|
1. ENTERPRISE - 企业;
|
|
1489
1304
|
2. INDIVIDUALBIZ - 个体工商户;
|
|
1490
1305
|
3. PUBLICINSTITUTION - 政府/事业单位
|
|
1491
1306
|
4. OTHERS - 其他组织
|
|
1492
|
-
|
|
1307
|
+
*/
|
|
1493
1308
|
OrganizationType?: string
|
|
1494
|
-
|
|
1495
1309
|
/**
|
|
1496
1310
|
* 机构证件照片文件,base64编码。支持jpg,jpeg,png格式;如果传值,则重新上传文件后,机构状态将变为未实名,需要调用实名接口重新实名。
|
|
1497
1311
|
*/
|
|
1498
1312
|
BizLicenseFile?: string
|
|
1499
|
-
|
|
1500
1313
|
/**
|
|
1501
1314
|
* 机构证件照片文件名
|
|
1502
1315
|
*/
|
|
1503
1316
|
BizLicenseFileName?: string
|
|
1504
|
-
|
|
1505
1317
|
/**
|
|
1506
1318
|
* 机构法人/经营者姓名
|
|
1507
1319
|
*/
|
|
1508
1320
|
LegalName?: string
|
|
1509
|
-
|
|
1510
1321
|
/**
|
|
1511
1322
|
* 机构法人/经营者证件类型,可选值:ID_CARD - 居民身份证。OrganizationType 为 ENTERPRISE、INDIVIDUALBIZ 时,此项必填,其他情况选填。
|
|
1512
1323
|
*/
|
|
1513
1324
|
LegalIdCardType?: string
|
|
1514
|
-
|
|
1515
1325
|
/**
|
|
1516
1326
|
* 机构法人/经营者证件号码。OrganizationType 为 ENTERPRISE、INDIVIDUALBIZ 时,此项必填,其他情况选填
|
|
1517
1327
|
*/
|
|
1518
1328
|
LegalIdCardNumber?: string
|
|
1519
|
-
|
|
1520
1329
|
/**
|
|
1521
1330
|
* 机构法人/经营者/联系人手机号码
|
|
1522
1331
|
*/
|
|
1523
1332
|
LegalMobile?: string
|
|
1524
|
-
|
|
1525
1333
|
/**
|
|
1526
1334
|
* 组织联系人姓名
|
|
1527
1335
|
*/
|
|
1528
1336
|
ContactName?: string
|
|
1529
|
-
|
|
1530
1337
|
/**
|
|
1531
1338
|
* 企业联系地址
|
|
1532
1339
|
*/
|
|
1533
1340
|
ContactAddress?: Address
|
|
1534
|
-
|
|
1535
1341
|
/**
|
|
1536
1342
|
* 机构电子邮箱
|
|
1537
1343
|
*/
|
|
@@ -1546,7 +1352,6 @@ export interface SendSignInnerVerifyCodeResponse {
|
|
|
1546
1352
|
* true: 验证码正确,false: 验证码错误
|
|
1547
1353
|
*/
|
|
1548
1354
|
Result: boolean
|
|
1549
|
-
|
|
1550
1355
|
/**
|
|
1551
1356
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1552
1357
|
*/
|
|
@@ -1561,12 +1366,10 @@ export interface DescribeFaceIdPhotosRequest {
|
|
|
1561
1366
|
* 调用方信息
|
|
1562
1367
|
*/
|
|
1563
1368
|
Caller: Caller
|
|
1564
|
-
|
|
1565
1369
|
/**
|
|
1566
1370
|
* 慧眼业务ID
|
|
1567
1371
|
*/
|
|
1568
1372
|
WbAppId: string
|
|
1569
|
-
|
|
1570
1373
|
/**
|
|
1571
1374
|
* 订单号(orderNo); 限制在3个或以内
|
|
1572
1375
|
*/
|
|
@@ -1581,17 +1384,14 @@ export interface FileUrl {
|
|
|
1581
1384
|
* 下载文件的URL
|
|
1582
1385
|
*/
|
|
1583
1386
|
Url: string
|
|
1584
|
-
|
|
1585
1387
|
/**
|
|
1586
1388
|
* 下载文件的附加信息
|
|
1587
1389
|
*/
|
|
1588
1390
|
Option: string
|
|
1589
|
-
|
|
1590
1391
|
/**
|
|
1591
1392
|
* 下载文件所属的资源序号
|
|
1592
1393
|
*/
|
|
1593
1394
|
Index: number
|
|
1594
|
-
|
|
1595
1395
|
/**
|
|
1596
1396
|
* 目录业务下,文件对应的流程
|
|
1597
1397
|
*/
|
|
@@ -1606,7 +1406,6 @@ export interface CreateUserResponse {
|
|
|
1606
1406
|
* 用户ID,按应用号隔离
|
|
1607
1407
|
*/
|
|
1608
1408
|
UserId: string
|
|
1609
|
-
|
|
1610
1409
|
/**
|
|
1611
1410
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1612
1411
|
*/
|
|
@@ -1621,18 +1420,15 @@ export interface CheckVerifyCodeMatchFlowIdResponse {
|
|
|
1621
1420
|
* true: 验证码正确,false: 验证码错误
|
|
1622
1421
|
*/
|
|
1623
1422
|
Success: boolean
|
|
1624
|
-
|
|
1625
1423
|
/**
|
|
1626
|
-
|
|
1424
|
+
* 0: 验证码正确 1:验证码错误或过期 2:验证码错误 3:验证码和流程不匹配 4:验证码输入错误超过次数 5:内部错误
|
|
1627
1425
|
6:参数错误
|
|
1628
|
-
|
|
1426
|
+
*/
|
|
1629
1427
|
Result: number
|
|
1630
|
-
|
|
1631
1428
|
/**
|
|
1632
1429
|
* 结果描述
|
|
1633
1430
|
*/
|
|
1634
1431
|
Description: string
|
|
1635
|
-
|
|
1636
1432
|
/**
|
|
1637
1433
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1638
1434
|
*/
|
|
@@ -1647,12 +1443,10 @@ export interface ModifyOrganizationDefaultSealRequest {
|
|
|
1647
1443
|
* 调用方信息
|
|
1648
1444
|
*/
|
|
1649
1445
|
Caller: Caller
|
|
1650
|
-
|
|
1651
1446
|
/**
|
|
1652
1447
|
* 重新指定的默认印章ID
|
|
1653
1448
|
*/
|
|
1654
1449
|
SealId: string
|
|
1655
|
-
|
|
1656
1450
|
/**
|
|
1657
1451
|
* 请求重新指定企业默认印章的客户端IP
|
|
1658
1452
|
*/
|
|
@@ -1667,7 +1461,6 @@ export interface CreateFaceIdSignResponse {
|
|
|
1667
1461
|
* 慧眼API签名
|
|
1668
1462
|
*/
|
|
1669
1463
|
Sign?: string
|
|
1670
|
-
|
|
1671
1464
|
/**
|
|
1672
1465
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1673
1466
|
*/
|
|
@@ -1682,12 +1475,10 @@ export interface DescribeFlowApproversResponse {
|
|
|
1682
1475
|
* 流程编号
|
|
1683
1476
|
*/
|
|
1684
1477
|
FlowId: string
|
|
1685
|
-
|
|
1686
1478
|
/**
|
|
1687
1479
|
* 流程参与者信息
|
|
1688
1480
|
*/
|
|
1689
1481
|
Approvers: Array<FlowApproverInfo>
|
|
1690
|
-
|
|
1691
1482
|
/**
|
|
1692
1483
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1693
1484
|
*/
|
|
@@ -1702,12 +1493,10 @@ export interface CheckMobileAndNameRequest {
|
|
|
1702
1493
|
* 调用方信息; 必选
|
|
1703
1494
|
*/
|
|
1704
1495
|
Caller: Caller
|
|
1705
|
-
|
|
1706
1496
|
/**
|
|
1707
1497
|
* 手机号
|
|
1708
1498
|
*/
|
|
1709
1499
|
Mobile: string
|
|
1710
|
-
|
|
1711
1500
|
/**
|
|
1712
1501
|
* 姓名
|
|
1713
1502
|
*/
|
|
@@ -1722,17 +1511,14 @@ export interface DeleteSealRequest {
|
|
|
1722
1511
|
* 调用方信息
|
|
1723
1512
|
*/
|
|
1724
1513
|
Caller: Caller
|
|
1725
|
-
|
|
1726
1514
|
/**
|
|
1727
1515
|
* 印章ID
|
|
1728
1516
|
*/
|
|
1729
1517
|
SealId: string
|
|
1730
|
-
|
|
1731
1518
|
/**
|
|
1732
1519
|
* 请求删除印章的客户端IP
|
|
1733
1520
|
*/
|
|
1734
1521
|
SourceIp: string
|
|
1735
|
-
|
|
1736
1522
|
/**
|
|
1737
1523
|
* 用户唯一标识,默认为空时删除企业印章,如非空则删除个人印章
|
|
1738
1524
|
*/
|
|
@@ -1744,7 +1530,7 @@ export interface DeleteSealRequest {
|
|
|
1744
1530
|
*/
|
|
1745
1531
|
export interface CheckBankCardVerificationResponse {
|
|
1746
1532
|
/**
|
|
1747
|
-
|
|
1533
|
+
* 检测结果
|
|
1748
1534
|
计费结果码:
|
|
1749
1535
|
0: 认证通过
|
|
1750
1536
|
1: 认证未通过
|
|
@@ -1766,14 +1552,12 @@ export interface CheckBankCardVerificationResponse {
|
|
|
1766
1552
|
103: 验证中心服务繁忙
|
|
1767
1553
|
104: 身份证号码有误
|
|
1768
1554
|
105: 手机号码不合法
|
|
1769
|
-
|
|
1555
|
+
*/
|
|
1770
1556
|
Result?: number
|
|
1771
|
-
|
|
1772
1557
|
/**
|
|
1773
1558
|
* 结果描述; 未通过时必选
|
|
1774
1559
|
*/
|
|
1775
1560
|
Description?: string
|
|
1776
|
-
|
|
1777
1561
|
/**
|
|
1778
1562
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1779
1563
|
*/
|
|
@@ -1788,7 +1572,6 @@ export interface ArchiveFlowRequest {
|
|
|
1788
1572
|
* 调用方信息
|
|
1789
1573
|
*/
|
|
1790
1574
|
Caller: Caller
|
|
1791
|
-
|
|
1792
1575
|
/**
|
|
1793
1576
|
* 流程ID
|
|
1794
1577
|
*/
|
|
@@ -1803,12 +1586,10 @@ export interface CreateUserAndSealResponse {
|
|
|
1803
1586
|
* 用户唯一标识,按应用号隔离
|
|
1804
1587
|
*/
|
|
1805
1588
|
UserId: string
|
|
1806
|
-
|
|
1807
1589
|
/**
|
|
1808
1590
|
* 默认印章ID
|
|
1809
1591
|
*/
|
|
1810
1592
|
SealId: string
|
|
1811
|
-
|
|
1812
1593
|
/**
|
|
1813
1594
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1814
1595
|
*/
|
|
@@ -1820,69 +1601,59 @@ export interface CreateUserAndSealResponse {
|
|
|
1820
1601
|
*/
|
|
1821
1602
|
export interface FaceIdResult {
|
|
1822
1603
|
/**
|
|
1823
|
-
|
|
1604
|
+
* 核身结果:
|
|
1824
1605
|
0 - 通过;
|
|
1825
1606
|
1 - 未通过
|
|
1826
|
-
|
|
1607
|
+
*/
|
|
1827
1608
|
Result: number
|
|
1828
|
-
|
|
1829
1609
|
/**
|
|
1830
1610
|
* 核身失败描述
|
|
1831
1611
|
*/
|
|
1832
1612
|
Description: string
|
|
1833
|
-
|
|
1834
1613
|
/**
|
|
1835
1614
|
* 订单号 (orderNo)
|
|
1836
1615
|
*/
|
|
1837
1616
|
OrderNumber: string
|
|
1838
|
-
|
|
1839
1617
|
/**
|
|
1840
|
-
|
|
1618
|
+
* 姓名
|
|
1841
1619
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1842
|
-
|
|
1620
|
+
*/
|
|
1843
1621
|
Name: string
|
|
1844
|
-
|
|
1845
1622
|
/**
|
|
1846
|
-
|
|
1623
|
+
* 身份证件类型:
|
|
1847
1624
|
ID_CARD - 居民身份证
|
|
1848
1625
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1849
|
-
|
|
1626
|
+
*/
|
|
1850
1627
|
IdCardType: string
|
|
1851
|
-
|
|
1852
1628
|
/**
|
|
1853
|
-
|
|
1629
|
+
* 身份证件号码
|
|
1854
1630
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1855
|
-
|
|
1631
|
+
*/
|
|
1856
1632
|
IdCardNumber: string
|
|
1857
|
-
|
|
1858
1633
|
/**
|
|
1859
|
-
|
|
1634
|
+
* 活体检测得分 (百分制)
|
|
1860
1635
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1861
|
-
|
|
1636
|
+
*/
|
|
1862
1637
|
LiveRate: number
|
|
1863
|
-
|
|
1864
1638
|
/**
|
|
1865
|
-
|
|
1639
|
+
* 人脸检测得分 (百分制)
|
|
1866
1640
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1867
|
-
|
|
1641
|
+
*/
|
|
1868
1642
|
Similarity: number
|
|
1869
|
-
|
|
1870
1643
|
/**
|
|
1871
|
-
|
|
1644
|
+
* 刷脸时间 (UNIX时间戳)
|
|
1872
1645
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1873
|
-
|
|
1646
|
+
*/
|
|
1874
1647
|
OccurredTime: number
|
|
1875
|
-
|
|
1876
1648
|
/**
|
|
1877
|
-
|
|
1649
|
+
* 照片数据 (base64编码, 一般为JPG或PNG)
|
|
1878
1650
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1879
|
-
|
|
1651
|
+
*/
|
|
1880
1652
|
Photo: string
|
|
1881
|
-
|
|
1882
1653
|
/**
|
|
1883
|
-
|
|
1654
|
+
* 视频数据 (base64编码, 一般为MP4)
|
|
1884
1655
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1885
|
-
|
|
1656
|
+
*/
|
|
1886
1657
|
Video: string
|
|
1887
1658
|
}
|
|
1888
1659
|
|
|
@@ -1894,34 +1665,28 @@ export interface CreateSignUrlRequest {
|
|
|
1894
1665
|
* 调用方信息
|
|
1895
1666
|
*/
|
|
1896
1667
|
Caller: Caller
|
|
1897
|
-
|
|
1898
1668
|
/**
|
|
1899
1669
|
* 签署人ID
|
|
1900
1670
|
*/
|
|
1901
1671
|
UserId: string
|
|
1902
|
-
|
|
1903
1672
|
/**
|
|
1904
1673
|
* 文件签署截止时间戳
|
|
1905
1674
|
*/
|
|
1906
1675
|
Deadline: number
|
|
1907
|
-
|
|
1908
1676
|
/**
|
|
1909
1677
|
* 目录ID。当 SignUrlType 为 CATALOG 时必填
|
|
1910
1678
|
*/
|
|
1911
1679
|
CatalogId?: string
|
|
1912
|
-
|
|
1913
1680
|
/**
|
|
1914
1681
|
* 流程ID。当 SignUrlType 为 FLOW 时必填
|
|
1915
1682
|
*/
|
|
1916
1683
|
FlowId?: string
|
|
1917
|
-
|
|
1918
1684
|
/**
|
|
1919
|
-
|
|
1685
|
+
* 签署链接类型:
|
|
1920
1686
|
1. FLOW - 单流程签署 (默认)
|
|
1921
1687
|
2. CATALOG - 目录签署
|
|
1922
|
-
|
|
1688
|
+
*/
|
|
1923
1689
|
SignUrlType?: string
|
|
1924
|
-
|
|
1925
1690
|
/**
|
|
1926
1691
|
* 发送流程或目录时生成的签署任务ID
|
|
1927
1692
|
*/
|
|
@@ -1936,7 +1701,6 @@ export interface ComponentSeal {
|
|
|
1936
1701
|
* 签署区ID
|
|
1937
1702
|
*/
|
|
1938
1703
|
ComponentId: string
|
|
1939
|
-
|
|
1940
1704
|
/**
|
|
1941
1705
|
* 印章ID
|
|
1942
1706
|
*/
|
|
@@ -1961,41 +1725,35 @@ export interface UploadFilesRequest {
|
|
|
1961
1725
|
* 调用方信息
|
|
1962
1726
|
*/
|
|
1963
1727
|
Caller: Caller
|
|
1964
|
-
|
|
1965
1728
|
/**
|
|
1966
|
-
|
|
1729
|
+
* 文件对应业务类型,用于区分文件存储路径:
|
|
1967
1730
|
1. TEMPLATE - 模版; 文件类型:.pdf/.html
|
|
1968
1731
|
2. DOCUMENT - 签署过程及签署后的合同文档 文件类型:.pdf/.html
|
|
1969
1732
|
3. FLOW - 签署过程 文件类型:.pdf/.html
|
|
1970
1733
|
4. SEAL - 印章; 文件类型:.jpg/.jpeg/.png
|
|
1971
1734
|
5. BUSINESSLICENSE - 营业执照 文件类型:.jpg/.jpeg/.png
|
|
1972
1735
|
6. IDCARD - 身份证 文件类型:.jpg/.jpeg/.png
|
|
1973
|
-
|
|
1736
|
+
*/
|
|
1974
1737
|
BusinessType: string
|
|
1975
|
-
|
|
1976
1738
|
/**
|
|
1977
1739
|
* 上传文件内容数组,最多支持20个文件
|
|
1978
1740
|
*/
|
|
1979
1741
|
FileInfos?: Array<UploadFile>
|
|
1980
|
-
|
|
1981
1742
|
/**
|
|
1982
1743
|
* 上传文件链接数组,最多支持20个URL
|
|
1983
1744
|
*/
|
|
1984
1745
|
FileUrls?: Array<string>
|
|
1985
|
-
|
|
1986
1746
|
/**
|
|
1987
|
-
|
|
1747
|
+
* 是否将pdf灰色矩阵置白
|
|
1988
1748
|
true--是,处理置白
|
|
1989
1749
|
false--否,不处理
|
|
1990
|
-
|
|
1750
|
+
*/
|
|
1991
1751
|
CoverRect?: boolean
|
|
1992
|
-
|
|
1993
1752
|
/**
|
|
1994
|
-
|
|
1753
|
+
* 特殊文件类型需要指定文件类型:
|
|
1995
1754
|
HTML-- .html文件
|
|
1996
|
-
|
|
1755
|
+
*/
|
|
1997
1756
|
FileType?: string
|
|
1998
|
-
|
|
1999
1757
|
/**
|
|
2000
1758
|
* 用户自定义ID数组,与上传文件一一对应
|
|
2001
1759
|
*/
|
|
@@ -2010,7 +1768,6 @@ export interface DescribeUsersRequest {
|
|
|
2010
1768
|
* 调用方信息
|
|
2011
1769
|
*/
|
|
2012
1770
|
Caller: Caller
|
|
2013
|
-
|
|
2014
1771
|
/**
|
|
2015
1772
|
* UserId列表,最多支持100个UserId
|
|
2016
1773
|
*/
|
|
@@ -2025,17 +1782,14 @@ export interface CreateFlowByFilesRequest {
|
|
|
2025
1782
|
* 调用方信息
|
|
2026
1783
|
*/
|
|
2027
1784
|
Caller: Caller
|
|
2028
|
-
|
|
2029
1785
|
/**
|
|
2030
1786
|
* 流程创建信息
|
|
2031
1787
|
*/
|
|
2032
1788
|
FlowInfo: FlowInfo
|
|
2033
|
-
|
|
2034
1789
|
/**
|
|
2035
1790
|
* 文件资源列表 (支持多文件)
|
|
2036
1791
|
*/
|
|
2037
1792
|
FileIds: Array<string>
|
|
2038
|
-
|
|
2039
1793
|
/**
|
|
2040
1794
|
* 自定义流程id
|
|
2041
1795
|
*/
|
|
@@ -2050,12 +1804,10 @@ export interface CatalogComponents {
|
|
|
2050
1804
|
* 流程ID
|
|
2051
1805
|
*/
|
|
2052
1806
|
FlowId: string
|
|
2053
|
-
|
|
2054
1807
|
/**
|
|
2055
1808
|
* 签署区列表
|
|
2056
1809
|
*/
|
|
2057
1810
|
SignComponents: Array<Component>
|
|
2058
|
-
|
|
2059
1811
|
/**
|
|
2060
1812
|
* 签署任务ID
|
|
2061
1813
|
*/
|
|
@@ -2080,31 +1832,26 @@ export interface FlowInfo {
|
|
|
2080
1832
|
* 合同名字
|
|
2081
1833
|
*/
|
|
2082
1834
|
FlowName: string
|
|
2083
|
-
|
|
2084
1835
|
/**
|
|
2085
1836
|
* 签署截止时间戳,超过有效签署时间则该签署流程失败
|
|
2086
1837
|
*/
|
|
2087
1838
|
Deadline: number
|
|
2088
|
-
|
|
2089
1839
|
/**
|
|
2090
1840
|
* 合同描述
|
|
2091
1841
|
*/
|
|
2092
1842
|
FlowDescription?: string
|
|
2093
|
-
|
|
2094
1843
|
/**
|
|
2095
|
-
|
|
1844
|
+
* 合同类型:
|
|
2096
1845
|
1. “劳务”
|
|
2097
1846
|
2. “销售”
|
|
2098
1847
|
3. “租赁”
|
|
2099
1848
|
4. “其他”
|
|
2100
|
-
|
|
1849
|
+
*/
|
|
2101
1850
|
FlowType?: string
|
|
2102
|
-
|
|
2103
1851
|
/**
|
|
2104
1852
|
* 回调地址
|
|
2105
1853
|
*/
|
|
2106
1854
|
CallbackUrl?: string
|
|
2107
|
-
|
|
2108
1855
|
/**
|
|
2109
1856
|
* 用户自定义数据
|
|
2110
1857
|
*/
|
|
@@ -2119,45 +1866,38 @@ export interface UserDescribe {
|
|
|
2119
1866
|
* 用户ID
|
|
2120
1867
|
*/
|
|
2121
1868
|
UserId: string
|
|
2122
|
-
|
|
2123
1869
|
/**
|
|
2124
1870
|
* 手机号,隐藏中间4位数字,用*代替
|
|
2125
1871
|
*/
|
|
2126
1872
|
Mobile: string
|
|
2127
|
-
|
|
2128
1873
|
/**
|
|
2129
1874
|
* 注册时间点 (UNIX时间戳)
|
|
2130
1875
|
*/
|
|
2131
1876
|
CreatedOn: number
|
|
2132
|
-
|
|
2133
1877
|
/**
|
|
2134
|
-
|
|
1878
|
+
* 实名认证状态:
|
|
2135
1879
|
0 - 未实名;
|
|
2136
1880
|
1 - 通过实名
|
|
2137
|
-
|
|
1881
|
+
*/
|
|
2138
1882
|
VerifyStatus: number
|
|
2139
|
-
|
|
2140
1883
|
/**
|
|
2141
1884
|
* 真实姓名
|
|
2142
1885
|
*/
|
|
2143
1886
|
Name: string
|
|
2144
|
-
|
|
2145
1887
|
/**
|
|
2146
1888
|
* 实名认证通过时间 (UNIX时间戳)
|
|
2147
1889
|
*/
|
|
2148
1890
|
VerifiedOn: number
|
|
2149
|
-
|
|
2150
1891
|
/**
|
|
2151
|
-
|
|
1892
|
+
* 身份证件类型;
|
|
2152
1893
|
ID_CARD - 居民身份证;
|
|
2153
1894
|
PASSPORT - 护照;
|
|
2154
1895
|
MAINLAND_TRAVEL_PERMIT_FOR_HONGKONG_AND_MACAO_RESIDENTS - 港澳居民来往内地通行证;
|
|
2155
1896
|
MAINLAND_TRAVEL_PERMIT_FOR_TAIWAN_RESIDENTS - 台湾居民来往大陆通行证;
|
|
2156
1897
|
HOUSEHOLD_REGISTER - 户口本;
|
|
2157
1898
|
TEMP_ID_CARD - 临时居民身份证
|
|
2158
|
-
|
|
1899
|
+
*/
|
|
2159
1900
|
IdCardType: string
|
|
2160
|
-
|
|
2161
1901
|
/**
|
|
2162
1902
|
* 身份证件号码 (脱敏)
|
|
2163
1903
|
*/
|
|
@@ -2169,7 +1909,7 @@ TEMP_ID_CARD - 临时居民身份证
|
|
|
2169
1909
|
*/
|
|
2170
1910
|
export interface CheckBankCard2EVerificationResponse {
|
|
2171
1911
|
/**
|
|
2172
|
-
|
|
1912
|
+
* 检测结果
|
|
2173
1913
|
计费结果码:
|
|
2174
1914
|
0: 认证通过
|
|
2175
1915
|
1: 认证未通过
|
|
@@ -2191,14 +1931,12 @@ export interface CheckBankCard2EVerificationResponse {
|
|
|
2191
1931
|
103: 验证中心服务繁忙
|
|
2192
1932
|
104: 身份证号码有误
|
|
2193
1933
|
105: 手机号码不合法
|
|
2194
|
-
|
|
1934
|
+
*/
|
|
2195
1935
|
Result?: number
|
|
2196
|
-
|
|
2197
1936
|
/**
|
|
2198
1937
|
* 结果描述; 未通过时必选
|
|
2199
1938
|
*/
|
|
2200
1939
|
Description?: string
|
|
2201
|
-
|
|
2202
1940
|
/**
|
|
2203
1941
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2204
1942
|
*/
|
|
@@ -2213,7 +1951,6 @@ export interface VerifySubOrganizationResponse {
|
|
|
2213
1951
|
* 子机构ID
|
|
2214
1952
|
*/
|
|
2215
1953
|
SubOrganizationId: string
|
|
2216
|
-
|
|
2217
1954
|
/**
|
|
2218
1955
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2219
1956
|
*/
|
|
@@ -2228,7 +1965,6 @@ export interface DescribeSealsResponse {
|
|
|
2228
1965
|
* 印章信息
|
|
2229
1966
|
*/
|
|
2230
1967
|
Seals: Array<Seal>
|
|
2231
|
-
|
|
2232
1968
|
/**
|
|
2233
1969
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2234
1970
|
*/
|
|
@@ -2243,12 +1979,10 @@ export interface DescribeFileUrlsResponse {
|
|
|
2243
1979
|
* 文件下载URL数组
|
|
2244
1980
|
*/
|
|
2245
1981
|
FileUrls: Array<FileUrl>
|
|
2246
|
-
|
|
2247
1982
|
/**
|
|
2248
1983
|
* URL数量
|
|
2249
1984
|
*/
|
|
2250
1985
|
TotalCount: number
|
|
2251
|
-
|
|
2252
1986
|
/**
|
|
2253
1987
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2254
1988
|
*/
|
|
@@ -2263,32 +1997,26 @@ export interface ModifySealRequest {
|
|
|
2263
1997
|
* 调用方信息
|
|
2264
1998
|
*/
|
|
2265
1999
|
Caller: Caller
|
|
2266
|
-
|
|
2267
2000
|
/**
|
|
2268
2001
|
* 请求更新印章的客户端IP
|
|
2269
2002
|
*/
|
|
2270
2003
|
SourceIp: string
|
|
2271
|
-
|
|
2272
2004
|
/**
|
|
2273
2005
|
* 电子印章ID。若为空,则修改个人/机构的默认印章。
|
|
2274
2006
|
*/
|
|
2275
2007
|
SealId?: string
|
|
2276
|
-
|
|
2277
2008
|
/**
|
|
2278
2009
|
* 电子印章名称
|
|
2279
2010
|
*/
|
|
2280
2011
|
SealName?: string
|
|
2281
|
-
|
|
2282
2012
|
/**
|
|
2283
2013
|
* 印章图片,base64编码(与FileId参数二选一,同时传入参数时优先使用Image参数)
|
|
2284
2014
|
*/
|
|
2285
2015
|
Image?: string
|
|
2286
|
-
|
|
2287
2016
|
/**
|
|
2288
2017
|
* 印章图片文件ID(与Image参数二选一,同时传入参数时优先使用Image参数)
|
|
2289
2018
|
*/
|
|
2290
2019
|
FileId?: string
|
|
2291
|
-
|
|
2292
2020
|
/**
|
|
2293
2021
|
* 需要更新印章的用户ID
|
|
2294
2022
|
*/
|
|
@@ -2303,22 +2031,18 @@ export interface CheckBankCard3EVerificationRequest {
|
|
|
2303
2031
|
* 调用方信息; 必选
|
|
2304
2032
|
*/
|
|
2305
2033
|
Caller: Caller
|
|
2306
|
-
|
|
2307
2034
|
/**
|
|
2308
2035
|
* 银行卡号
|
|
2309
2036
|
*/
|
|
2310
2037
|
BankCard: string
|
|
2311
|
-
|
|
2312
2038
|
/**
|
|
2313
2039
|
* 姓名
|
|
2314
2040
|
*/
|
|
2315
2041
|
Name: string
|
|
2316
|
-
|
|
2317
2042
|
/**
|
|
2318
2043
|
* 身份证件号码
|
|
2319
2044
|
*/
|
|
2320
2045
|
IdCardNumber: string
|
|
2321
|
-
|
|
2322
2046
|
/**
|
|
2323
2047
|
* 身份证件类型; ID_CARD
|
|
2324
2048
|
*/
|
|
@@ -2333,27 +2057,22 @@ export interface CheckBankCardVerificationRequest {
|
|
|
2333
2057
|
* 调用方信息; 必选
|
|
2334
2058
|
*/
|
|
2335
2059
|
Caller: Caller
|
|
2336
|
-
|
|
2337
2060
|
/**
|
|
2338
2061
|
* 银行卡号
|
|
2339
2062
|
*/
|
|
2340
2063
|
BankCard: string
|
|
2341
|
-
|
|
2342
2064
|
/**
|
|
2343
2065
|
* 姓名
|
|
2344
2066
|
*/
|
|
2345
2067
|
Name: string
|
|
2346
|
-
|
|
2347
2068
|
/**
|
|
2348
2069
|
* 身份证件号码
|
|
2349
2070
|
*/
|
|
2350
2071
|
IdCardNumber?: string
|
|
2351
|
-
|
|
2352
2072
|
/**
|
|
2353
2073
|
* 手机号
|
|
2354
2074
|
*/
|
|
2355
2075
|
Mobile?: string
|
|
2356
|
-
|
|
2357
2076
|
/**
|
|
2358
2077
|
* 身份证件类型; ID_CARD
|
|
2359
2078
|
*/
|
|
@@ -2368,43 +2087,37 @@ export interface RejectFlowRequest {
|
|
|
2368
2087
|
* 调用方信息
|
|
2369
2088
|
*/
|
|
2370
2089
|
Caller: Caller
|
|
2371
|
-
|
|
2372
2090
|
/**
|
|
2373
2091
|
* 流程编号
|
|
2374
2092
|
*/
|
|
2375
2093
|
FlowId: string
|
|
2376
|
-
|
|
2377
2094
|
/**
|
|
2378
|
-
|
|
2095
|
+
* 意愿确认票据。
|
|
2379
2096
|
1. VerifyChannel 为 WEIXINAPP,使用响应的VerifyResult;
|
|
2380
2097
|
2. VerifyChannel 为 FACEID时,使用OrderNo;
|
|
2381
2098
|
3. VerifyChannel 为 VERIFYCODE,使用短信验证码
|
|
2382
2099
|
4. VerifyChannel 为 NONE,传空值
|
|
2383
2100
|
(注:普通情况下,VerifyResult不能为None,如您不希望腾讯电子签对用户签署意愿做校验,请提前与客户经理或邮件至e-contract@tencent.com与我们联系)
|
|
2384
|
-
|
|
2101
|
+
*/
|
|
2385
2102
|
VerifyResult: string
|
|
2386
|
-
|
|
2387
2103
|
/**
|
|
2388
|
-
|
|
2104
|
+
* 意愿确认渠道:
|
|
2389
2105
|
1. WEIXINAPP - 微信小程序
|
|
2390
2106
|
2. FACEID - 慧眼 (默认)
|
|
2391
2107
|
3. VERIFYCODE - 验证码
|
|
2392
2108
|
4. THIRD - 第三方 (暂不支持)
|
|
2393
2109
|
5. NONE - 无需电子签系统验证
|
|
2394
2110
|
(注:普通情况下,VerifyChannel不能为None,如您不希望腾讯电子签对用户签署意愿做校验,请提前与客户经理或邮件至e-contract@tencent.com与我们联系)
|
|
2395
|
-
|
|
2111
|
+
*/
|
|
2396
2112
|
VerifyChannel: string
|
|
2397
|
-
|
|
2398
2113
|
/**
|
|
2399
2114
|
* 客户端来源IP
|
|
2400
2115
|
*/
|
|
2401
2116
|
SourceIp: string
|
|
2402
|
-
|
|
2403
2117
|
/**
|
|
2404
2118
|
* 拒签原因
|
|
2405
2119
|
*/
|
|
2406
2120
|
RejectMessage?: string
|
|
2407
|
-
|
|
2408
2121
|
/**
|
|
2409
2122
|
* 签署参与者编号
|
|
2410
2123
|
*/
|
|
@@ -2419,7 +2132,6 @@ export interface DescribeSubOrganizationsRequest {
|
|
|
2419
2132
|
* 调用方信息
|
|
2420
2133
|
*/
|
|
2421
2134
|
Caller: Caller
|
|
2422
|
-
|
|
2423
2135
|
/**
|
|
2424
2136
|
* 子机构ID数组
|
|
2425
2137
|
*/
|
|
@@ -2434,26 +2146,22 @@ export interface SignSeal {
|
|
|
2434
2146
|
* 签署控件ID
|
|
2435
2147
|
*/
|
|
2436
2148
|
ComponentId: string
|
|
2437
|
-
|
|
2438
2149
|
/**
|
|
2439
|
-
|
|
2150
|
+
* 签署印章类型:
|
|
2440
2151
|
SIGN_SIGNATURE - 签名
|
|
2441
2152
|
SIGN_SEAL - 印章
|
|
2442
2153
|
SIGN_DATE - 日期
|
|
2443
2154
|
SIGN_IMAGE - 图片
|
|
2444
|
-
|
|
2155
|
+
*/
|
|
2445
2156
|
SignType: string
|
|
2446
|
-
|
|
2447
2157
|
/**
|
|
2448
2158
|
* 合同文件ID
|
|
2449
2159
|
*/
|
|
2450
2160
|
FileIndex: number
|
|
2451
|
-
|
|
2452
2161
|
/**
|
|
2453
2162
|
* 印章ID,仅当 SignType 为 SIGN_SEAL 时必填
|
|
2454
2163
|
*/
|
|
2455
2164
|
SealId?: string
|
|
2456
|
-
|
|
2457
2165
|
/**
|
|
2458
2166
|
* 签名内容,仅当 SignType 为SIGN_SIGNATURE或SIGN_IMAGE 时必填,base64编码
|
|
2459
2167
|
*/
|
|
@@ -2468,7 +2176,6 @@ export interface DescribeCatalogSignComponentsRequest {
|
|
|
2468
2176
|
* 调用方信息
|
|
2469
2177
|
*/
|
|
2470
2178
|
Caller: Caller
|
|
2471
|
-
|
|
2472
2179
|
/**
|
|
2473
2180
|
* 目录ID
|
|
2474
2181
|
*/
|
|
@@ -2493,7 +2200,6 @@ export interface CreateFlowByFilesResponse {
|
|
|
2493
2200
|
* 流程ID
|
|
2494
2201
|
*/
|
|
2495
2202
|
FlowId: string
|
|
2496
|
-
|
|
2497
2203
|
/**
|
|
2498
2204
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2499
2205
|
*/
|
|
@@ -2518,12 +2224,10 @@ export interface UploadFilesResponse {
|
|
|
2518
2224
|
* 文件id数组
|
|
2519
2225
|
*/
|
|
2520
2226
|
FileIds: Array<string>
|
|
2521
|
-
|
|
2522
2227
|
/**
|
|
2523
2228
|
* 上传成功文件数量
|
|
2524
2229
|
*/
|
|
2525
2230
|
TotalCount: number
|
|
2526
|
-
|
|
2527
2231
|
/**
|
|
2528
2232
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2529
2233
|
*/
|
|
@@ -2535,7 +2239,7 @@ export interface UploadFilesResponse {
|
|
|
2535
2239
|
*/
|
|
2536
2240
|
export interface CheckBankCard3EVerificationResponse {
|
|
2537
2241
|
/**
|
|
2538
|
-
|
|
2242
|
+
* 检测结果
|
|
2539
2243
|
计费结果码:
|
|
2540
2244
|
0: 认证通过
|
|
2541
2245
|
1: 认证未通过
|
|
@@ -2557,14 +2261,12 @@ export interface CheckBankCard3EVerificationResponse {
|
|
|
2557
2261
|
103: 验证中心服务繁忙
|
|
2558
2262
|
104: 身份证号码有误
|
|
2559
2263
|
105: 手机号码不合法
|
|
2560
|
-
|
|
2264
|
+
*/
|
|
2561
2265
|
Result?: number
|
|
2562
|
-
|
|
2563
2266
|
/**
|
|
2564
2267
|
* 结果描述; 未通过时必选
|
|
2565
2268
|
*/
|
|
2566
2269
|
Description?: string
|
|
2567
|
-
|
|
2568
2270
|
/**
|
|
2569
2271
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2570
2272
|
*/
|
|
@@ -2579,48 +2281,41 @@ export interface SignFlowRequest {
|
|
|
2579
2281
|
* 调用方信息
|
|
2580
2282
|
*/
|
|
2581
2283
|
Caller: Caller
|
|
2582
|
-
|
|
2583
2284
|
/**
|
|
2584
2285
|
* 流程编号
|
|
2585
2286
|
*/
|
|
2586
2287
|
FlowId: string
|
|
2587
|
-
|
|
2588
2288
|
/**
|
|
2589
|
-
|
|
2289
|
+
* 意愿确认票据。
|
|
2590
2290
|
1. VerifyChannel 为 WEIXINAPP,使用响应的VerifyResult;
|
|
2591
2291
|
2. VerifyChannel 为 FACEID时,使用OrderNo;
|
|
2592
2292
|
3. VerifyChannel 为 VERIFYCODE,使用短信验证码
|
|
2593
2293
|
4. VerifyChannel 为 NONE,传空值
|
|
2594
2294
|
(注:普通情况下,VerifyResult不能为None,如您不希望腾讯电子签对用户签署意愿做校验,请提前与客户经理或邮件至e-contract@tencent.com与我们联系)
|
|
2595
|
-
|
|
2295
|
+
*/
|
|
2596
2296
|
VerifyResult: string
|
|
2597
|
-
|
|
2598
2297
|
/**
|
|
2599
|
-
|
|
2298
|
+
* 意愿确认渠道:
|
|
2600
2299
|
1. WEIXINAPP - 微信小程序
|
|
2601
2300
|
2. FACEID - 慧眼 (默认)
|
|
2602
2301
|
3. VERIFYCODE - 验证码
|
|
2603
2302
|
4. THIRD - 第三方 (暂不支持)
|
|
2604
2303
|
5. NONE - 无需电子签系统验证
|
|
2605
2304
|
(注:普通情况下,VerifyChannel不能为None,如您不希望腾讯电子签对用户签署意愿做校验,请提前与客户经理或邮件至e-contract@tencent.com与我们联系)
|
|
2606
|
-
|
|
2305
|
+
*/
|
|
2607
2306
|
VerifyChannel: string
|
|
2608
|
-
|
|
2609
2307
|
/**
|
|
2610
2308
|
* 客户端来源IP
|
|
2611
2309
|
*/
|
|
2612
2310
|
SourceIp: string
|
|
2613
|
-
|
|
2614
2311
|
/**
|
|
2615
2312
|
* 签署内容
|
|
2616
2313
|
*/
|
|
2617
2314
|
SignSeals: Array<SignSeal>
|
|
2618
|
-
|
|
2619
2315
|
/**
|
|
2620
2316
|
* 签署备注
|
|
2621
2317
|
*/
|
|
2622
2318
|
ApproveMessage?: string
|
|
2623
|
-
|
|
2624
2319
|
/**
|
|
2625
2320
|
* 签署参与者编号
|
|
2626
2321
|
*/
|
|
@@ -2635,7 +2330,6 @@ export interface CustomFlowIdMap {
|
|
|
2635
2330
|
* 自定义id
|
|
2636
2331
|
*/
|
|
2637
2332
|
CustomId: string
|
|
2638
|
-
|
|
2639
2333
|
/**
|
|
2640
2334
|
* 流程id
|
|
2641
2335
|
*/
|
|
@@ -2650,7 +2344,6 @@ export interface DescribeCustomFlowIdsByFlowIdRequest {
|
|
|
2650
2344
|
* 调用方信息
|
|
2651
2345
|
*/
|
|
2652
2346
|
Caller: Caller
|
|
2653
|
-
|
|
2654
2347
|
/**
|
|
2655
2348
|
* 流程 id 列表,最多同时查询 10 个流程 id
|
|
2656
2349
|
*/
|
|
@@ -2665,7 +2358,6 @@ export interface UploadFile {
|
|
|
2665
2358
|
* Base64编码后的文件内容
|
|
2666
2359
|
*/
|
|
2667
2360
|
FileBody: string
|
|
2668
|
-
|
|
2669
2361
|
/**
|
|
2670
2362
|
* 文件名
|
|
2671
2363
|
*/
|
|
@@ -2680,7 +2372,6 @@ export interface DescribeUsersResponse {
|
|
|
2680
2372
|
* 用户信息查询结果
|
|
2681
2373
|
*/
|
|
2682
2374
|
Users: Array<UserDescribe>
|
|
2683
|
-
|
|
2684
2375
|
/**
|
|
2685
2376
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2686
2377
|
*/
|
|
@@ -2695,42 +2386,34 @@ export interface CreateH5FaceIdUrlRequest {
|
|
|
2695
2386
|
* 调用方信息; 必选
|
|
2696
2387
|
*/
|
|
2697
2388
|
Caller: Caller
|
|
2698
|
-
|
|
2699
2389
|
/**
|
|
2700
2390
|
* 慧眼业务ID; 不填写时后台使用Caller反查
|
|
2701
2391
|
*/
|
|
2702
2392
|
WbAppId?: string
|
|
2703
|
-
|
|
2704
2393
|
/**
|
|
2705
2394
|
* 姓名; 可选(未通过实名认证的用户必选)
|
|
2706
2395
|
*/
|
|
2707
2396
|
Name?: string
|
|
2708
|
-
|
|
2709
2397
|
/**
|
|
2710
2398
|
* 用户证件类型; 可选; 默认ID_CARD:中国居民身份证
|
|
2711
2399
|
*/
|
|
2712
2400
|
IdCardType?: string
|
|
2713
|
-
|
|
2714
2401
|
/**
|
|
2715
2402
|
* 用户证件号; 可选(未通过实名认证的用户必选)
|
|
2716
2403
|
*/
|
|
2717
2404
|
IdCardNumber?: string
|
|
2718
|
-
|
|
2719
2405
|
/**
|
|
2720
2406
|
* H5人脸核身完成后回调的第三方Url; 可选; 不需要做Encode, 跳转的参数: ?code=XX&orderNo=XX&liveRate=xx, code=0表示成功,orderNo为订单号,liveRate为百分制活体检测得分
|
|
2721
2407
|
*/
|
|
2722
2408
|
JumpUrl?: string
|
|
2723
|
-
|
|
2724
2409
|
/**
|
|
2725
2410
|
* 参数值为"1":直接跳转到url回调地址; 可选; 其他值:跳转提供的结果页面
|
|
2726
2411
|
*/
|
|
2727
2412
|
JumpType?: string
|
|
2728
|
-
|
|
2729
2413
|
/**
|
|
2730
2414
|
* browser:表示在浏览器启动刷脸, app:表示在App里启动刷脸,默认值为browser; 可选
|
|
2731
2415
|
*/
|
|
2732
2416
|
OpenFrom?: string
|
|
2733
|
-
|
|
2734
2417
|
/**
|
|
2735
2418
|
* 跳转类型; 可选; 参数值为"1"时,刷脸页面使用replace方式跳转,不在浏览器history中留下记录;不传或其他值则正常跳转
|
|
2736
2419
|
*/
|
|
@@ -2742,7 +2425,7 @@ export interface CreateH5FaceIdUrlRequest {
|
|
|
2742
2425
|
*/
|
|
2743
2426
|
export interface CheckMobileVerificationResponse {
|
|
2744
2427
|
/**
|
|
2745
|
-
|
|
2428
|
+
* 检测结果
|
|
2746
2429
|
计费结果码:
|
|
2747
2430
|
0: 验证结果一致
|
|
2748
2431
|
1: 手机号未实名
|
|
@@ -2755,14 +2438,12 @@ export interface CheckMobileVerificationResponse {
|
|
|
2755
2438
|
104: 非法身份证号(长度,校验位等不正确)
|
|
2756
2439
|
105: 认证未通过
|
|
2757
2440
|
106: 验证平台异常
|
|
2758
|
-
|
|
2441
|
+
*/
|
|
2759
2442
|
Result?: number
|
|
2760
|
-
|
|
2761
2443
|
/**
|
|
2762
2444
|
* 结果描述; 未通过时必选
|
|
2763
2445
|
*/
|
|
2764
2446
|
Description?: string
|
|
2765
|
-
|
|
2766
2447
|
/**
|
|
2767
2448
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2768
2449
|
*/
|
|
@@ -2777,12 +2458,10 @@ export interface DescribeFlowFilesResponse {
|
|
|
2777
2458
|
* 流程编号
|
|
2778
2459
|
*/
|
|
2779
2460
|
FlowId?: string
|
|
2780
|
-
|
|
2781
2461
|
/**
|
|
2782
2462
|
* 流程文件列表
|
|
2783
2463
|
*/
|
|
2784
2464
|
FlowFileInfos?: Array<FlowFileInfo>
|
|
2785
|
-
|
|
2786
2465
|
/**
|
|
2787
2466
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2788
2467
|
*/
|
|
@@ -2797,43 +2476,36 @@ export interface CreateUserRequest {
|
|
|
2797
2476
|
* 调用方信息
|
|
2798
2477
|
*/
|
|
2799
2478
|
Caller: Caller
|
|
2800
|
-
|
|
2801
2479
|
/**
|
|
2802
2480
|
* 第三方平台唯一标识;要求应用内OpenId唯一; len<=32
|
|
2803
2481
|
*/
|
|
2804
2482
|
OpenId: string
|
|
2805
|
-
|
|
2806
2483
|
/**
|
|
2807
2484
|
* 用户姓名
|
|
2808
2485
|
*/
|
|
2809
2486
|
Name: string
|
|
2810
|
-
|
|
2811
2487
|
/**
|
|
2812
|
-
|
|
2488
|
+
* 用户证件类型:
|
|
2813
2489
|
1. ID_CARD - 居民身份证
|
|
2814
2490
|
2. PASSPORT - 护照
|
|
2815
2491
|
3. MAINLAND_TRAVEL_PERMIT_FOR_HONGKONG_AND_MACAO_RESIDENTS - 港澳居民来往内地通行证
|
|
2816
2492
|
4. MAINLAND_TRAVEL_PERMIT_FOR_TAIWAN_RESIDENTS - 台湾居民来往大陆通行证
|
|
2817
2493
|
5. HOUSEHOLD_REGISTER - 户口本
|
|
2818
2494
|
6. TEMP_ID_CARD - 临时居民身份证
|
|
2819
|
-
|
|
2495
|
+
*/
|
|
2820
2496
|
IdCardType: string
|
|
2821
|
-
|
|
2822
2497
|
/**
|
|
2823
2498
|
* 用户证件号
|
|
2824
2499
|
*/
|
|
2825
2500
|
IdCardNumber: string
|
|
2826
|
-
|
|
2827
2501
|
/**
|
|
2828
2502
|
* 是否以OpenId作为UserId (为true时将直接以OpenId生成腾讯电子签平台的UserId)
|
|
2829
2503
|
*/
|
|
2830
2504
|
UseOpenId?: boolean
|
|
2831
|
-
|
|
2832
2505
|
/**
|
|
2833
2506
|
* 用户邮箱,不要求唯一
|
|
2834
2507
|
*/
|
|
2835
2508
|
Email?: string
|
|
2836
|
-
|
|
2837
2509
|
/**
|
|
2838
2510
|
* 用户手机号码,不要求唯一
|
|
2839
2511
|
*/
|
|
@@ -2848,27 +2520,23 @@ export interface CreatePreviewSignUrlRequest {
|
|
|
2848
2520
|
* 调用方信息
|
|
2849
2521
|
*/
|
|
2850
2522
|
Caller: Caller
|
|
2851
|
-
|
|
2852
2523
|
/**
|
|
2853
2524
|
* URL过期时间戳
|
|
2854
2525
|
*/
|
|
2855
2526
|
Deadline: number
|
|
2856
|
-
|
|
2857
2527
|
/**
|
|
2858
2528
|
* 目录ID。当 SignUrlType 为 CATALOG 时必填
|
|
2859
2529
|
*/
|
|
2860
2530
|
CatalogId?: string
|
|
2861
|
-
|
|
2862
2531
|
/**
|
|
2863
2532
|
* 流程ID。当 SignUrlType 为 FLOW 时必填
|
|
2864
2533
|
*/
|
|
2865
2534
|
FlowId?: string
|
|
2866
|
-
|
|
2867
2535
|
/**
|
|
2868
|
-
|
|
2536
|
+
* 签署链接类型:
|
|
2869
2537
|
1. FLOW - 单流程签署 (默认)
|
|
2870
2538
|
2. CATALOG - 目录签署
|
|
2871
|
-
|
|
2539
|
+
*/
|
|
2872
2540
|
SignUrlType?: string
|
|
2873
2541
|
}
|
|
2874
2542
|
|
|
@@ -2880,50 +2548,41 @@ export interface CreateUserAndSealRequest {
|
|
|
2880
2548
|
* 调用方信息
|
|
2881
2549
|
*/
|
|
2882
2550
|
Caller: Caller
|
|
2883
|
-
|
|
2884
2551
|
/**
|
|
2885
2552
|
* 第三方平台唯一标识,要求应用内OpenId唯一
|
|
2886
2553
|
*/
|
|
2887
2554
|
OpenId: string
|
|
2888
|
-
|
|
2889
2555
|
/**
|
|
2890
2556
|
* 用户姓名
|
|
2891
2557
|
*/
|
|
2892
2558
|
Name: string
|
|
2893
|
-
|
|
2894
2559
|
/**
|
|
2895
|
-
|
|
2560
|
+
* 用户证件类型:
|
|
2896
2561
|
1. ID_CARD - 居民身份证
|
|
2897
2562
|
5. HOUSEHOLD_REGISTER - 户口本
|
|
2898
2563
|
6. TEMP_ID_CARD - 临时居民身份证
|
|
2899
|
-
|
|
2564
|
+
*/
|
|
2900
2565
|
IdCardType: string
|
|
2901
|
-
|
|
2902
2566
|
/**
|
|
2903
2567
|
* 用户证件号
|
|
2904
2568
|
*/
|
|
2905
2569
|
IdCardNumber: string
|
|
2906
|
-
|
|
2907
2570
|
/**
|
|
2908
2571
|
* 请求生成个人印章的客户端IP
|
|
2909
2572
|
*/
|
|
2910
2573
|
SourceIp: string
|
|
2911
|
-
|
|
2912
2574
|
/**
|
|
2913
2575
|
* 用户手机号码,不要求唯一
|
|
2914
2576
|
*/
|
|
2915
2577
|
Mobile?: string
|
|
2916
|
-
|
|
2917
2578
|
/**
|
|
2918
2579
|
* 用户邮箱,不要求唯一
|
|
2919
2580
|
*/
|
|
2920
2581
|
Email?: string
|
|
2921
|
-
|
|
2922
2582
|
/**
|
|
2923
2583
|
* 默认印章名称
|
|
2924
2584
|
*/
|
|
2925
2585
|
SealName?: string
|
|
2926
|
-
|
|
2927
2586
|
/**
|
|
2928
2587
|
* 是否以OpenId作为UserId (为true时将直接以OpenId生成腾讯电子签平台的UserId)
|
|
2929
2588
|
*/
|
|
@@ -2938,7 +2597,6 @@ export interface CreatePreviewSignUrlResponse {
|
|
|
2938
2597
|
* 合同预览URL
|
|
2939
2598
|
*/
|
|
2940
2599
|
PreviewSignUrl: string
|
|
2941
|
-
|
|
2942
2600
|
/**
|
|
2943
2601
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2944
2602
|
*/
|
|
@@ -2953,7 +2611,6 @@ export interface CreateFaceIdSignRequest {
|
|
|
2953
2611
|
* 调用方信息; 必选
|
|
2954
2612
|
*/
|
|
2955
2613
|
Caller: Caller
|
|
2956
|
-
|
|
2957
2614
|
/**
|
|
2958
2615
|
* 除api_ticket之外的其它要参与签名的参数值,包括UserId
|
|
2959
2616
|
*/
|
|
@@ -2968,7 +2625,6 @@ export interface DescribeCustomFlowIdsByFlowIdResponse {
|
|
|
2968
2625
|
* 自定义流程 id 映射列表
|
|
2969
2626
|
*/
|
|
2970
2627
|
CustomIdList: Array<CustomFlowIdMap>
|
|
2971
|
-
|
|
2972
2628
|
/**
|
|
2973
2629
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2974
2630
|
*/
|
|
@@ -2983,7 +2639,6 @@ export interface SignFlowResponse {
|
|
|
2983
2639
|
* 签署任务状态。签署成功 - SUCCESS、提交审核 - REVIEW
|
|
2984
2640
|
*/
|
|
2985
2641
|
Status: string
|
|
2986
|
-
|
|
2987
2642
|
/**
|
|
2988
2643
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2989
2644
|
*/
|
|
@@ -3008,7 +2663,6 @@ export interface DescribeFlowRequest {
|
|
|
3008
2663
|
* 调用方信息
|
|
3009
2664
|
*/
|
|
3010
2665
|
Caller: Caller
|
|
3011
|
-
|
|
3012
2666
|
/**
|
|
3013
2667
|
* 需要查询的流程ID
|
|
3014
2668
|
*/
|
|
@@ -3023,7 +2677,6 @@ export interface DescribeFileIdsByCustomIdsRequest {
|
|
|
3023
2677
|
* 调用方信息, OrganizationId必填
|
|
3024
2678
|
*/
|
|
3025
2679
|
Caller: Caller
|
|
3026
|
-
|
|
3027
2680
|
/**
|
|
3028
2681
|
* 用户自定义ID
|
|
3029
2682
|
*/
|
|
@@ -3038,7 +2691,6 @@ export interface CreateSealResponse {
|
|
|
3038
2691
|
* 电子印章Id
|
|
3039
2692
|
*/
|
|
3040
2693
|
SealId: string
|
|
3041
|
-
|
|
3042
2694
|
/**
|
|
3043
2695
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3044
2696
|
*/
|
|
@@ -3053,7 +2705,6 @@ export interface GenerateOrganizationSealResponse {
|
|
|
3053
2705
|
* 电子印章Id
|
|
3054
2706
|
*/
|
|
3055
2707
|
SealId: string
|
|
3056
|
-
|
|
3057
2708
|
/**
|
|
3058
2709
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3059
2710
|
*/
|
|
@@ -3068,7 +2719,6 @@ export interface DescribeSubOrganizationsResponse {
|
|
|
3068
2719
|
* 子机构信息列表
|
|
3069
2720
|
*/
|
|
3070
2721
|
SubOrganizationInfos: Array<SubOrganizationDetail>
|
|
3071
|
-
|
|
3072
2722
|
/**
|
|
3073
2723
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3074
2724
|
*/
|
|
@@ -3083,7 +2733,6 @@ export interface DestroyFlowFileRequest {
|
|
|
3083
2733
|
* 调用方信息
|
|
3084
2734
|
*/
|
|
3085
2735
|
Caller: Caller
|
|
3086
|
-
|
|
3087
2736
|
/**
|
|
3088
2737
|
* 流程ID
|
|
3089
2738
|
*/
|
|
@@ -3098,46 +2747,38 @@ export interface CheckFaceIdentifyResponse {
|
|
|
3098
2747
|
* 核身结果; 0:通过,1:不通过
|
|
3099
2748
|
*/
|
|
3100
2749
|
Result?: number
|
|
3101
|
-
|
|
3102
2750
|
/**
|
|
3103
2751
|
* 核身结果描述
|
|
3104
2752
|
*/
|
|
3105
2753
|
Description?: string
|
|
3106
|
-
|
|
3107
2754
|
/**
|
|
3108
2755
|
* 渠道名
|
|
3109
2756
|
*/
|
|
3110
2757
|
ChannelName?: string
|
|
3111
|
-
|
|
3112
2758
|
/**
|
|
3113
|
-
|
|
2759
|
+
* 认证通过时间
|
|
3114
2760
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3115
|
-
|
|
2761
|
+
*/
|
|
3116
2762
|
VerifiedOn?: number
|
|
3117
|
-
|
|
3118
2763
|
/**
|
|
3119
2764
|
* 核身流水号
|
|
3120
2765
|
*/
|
|
3121
2766
|
SerialNumber?: string
|
|
3122
|
-
|
|
3123
2767
|
/**
|
|
3124
|
-
|
|
2768
|
+
* 渠道核身服务器IP
|
|
3125
2769
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3126
|
-
|
|
2770
|
+
*/
|
|
3127
2771
|
VerifyServerIp?: string
|
|
3128
|
-
|
|
3129
2772
|
/**
|
|
3130
|
-
|
|
2773
|
+
* 核身照片文件名
|
|
3131
2774
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3132
|
-
|
|
2775
|
+
*/
|
|
3133
2776
|
PhotoFileName?: string
|
|
3134
|
-
|
|
3135
2777
|
/**
|
|
3136
|
-
|
|
2778
|
+
* 核身照片内容base64(文件格式见文件名后缀,一般为jpg)
|
|
3137
2779
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3138
|
-
|
|
2780
|
+
*/
|
|
3139
2781
|
PhotoFileData?: string
|
|
3140
|
-
|
|
3141
2782
|
/**
|
|
3142
2783
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3143
2784
|
*/
|
|
@@ -3152,44 +2793,36 @@ export interface Seal {
|
|
|
3152
2793
|
* 电子印章ID
|
|
3153
2794
|
*/
|
|
3154
2795
|
SealId: string
|
|
3155
|
-
|
|
3156
2796
|
/**
|
|
3157
2797
|
* 电子印章名称
|
|
3158
2798
|
*/
|
|
3159
2799
|
SealName: string
|
|
3160
|
-
|
|
3161
2800
|
/**
|
|
3162
2801
|
* 电子印章类型
|
|
3163
2802
|
*/
|
|
3164
2803
|
SealType: string
|
|
3165
|
-
|
|
3166
2804
|
/**
|
|
3167
|
-
|
|
2805
|
+
* 电子印章来源:
|
|
3168
2806
|
CREATE - 通过图片上传
|
|
3169
2807
|
GENERATE - 通过文字生成
|
|
3170
|
-
|
|
2808
|
+
*/
|
|
3171
2809
|
SealSource: string
|
|
3172
|
-
|
|
3173
2810
|
/**
|
|
3174
2811
|
* 电子印章创建者
|
|
3175
2812
|
*/
|
|
3176
2813
|
Creator: Caller
|
|
3177
|
-
|
|
3178
2814
|
/**
|
|
3179
2815
|
* 电子印章创建时间戳
|
|
3180
2816
|
*/
|
|
3181
2817
|
CreatedOn: number
|
|
3182
|
-
|
|
3183
2818
|
/**
|
|
3184
2819
|
* 电子印章所有人
|
|
3185
2820
|
*/
|
|
3186
2821
|
UserId: string
|
|
3187
|
-
|
|
3188
2822
|
/**
|
|
3189
2823
|
* 电子印章URL
|
|
3190
2824
|
*/
|
|
3191
2825
|
FileUrl: FileUrl
|
|
3192
|
-
|
|
3193
2826
|
/**
|
|
3194
2827
|
* 是否为默认印章,false-非默认,true-默认
|
|
3195
2828
|
*/
|
|
@@ -3204,79 +2837,65 @@ export interface SendFlowUrlRequest {
|
|
|
3204
2837
|
* 调用方信息
|
|
3205
2838
|
*/
|
|
3206
2839
|
Caller: Caller
|
|
3207
|
-
|
|
3208
2840
|
/**
|
|
3209
2841
|
* 需要推送合同的流程ID
|
|
3210
2842
|
*/
|
|
3211
2843
|
FlowId: string
|
|
3212
|
-
|
|
3213
2844
|
/**
|
|
3214
2845
|
* 签署人ID
|
|
3215
2846
|
*/
|
|
3216
2847
|
UserId: string
|
|
3217
|
-
|
|
3218
2848
|
/**
|
|
3219
2849
|
* 签署控件信息 (支持添加多个控件)
|
|
3220
2850
|
*/
|
|
3221
2851
|
SignComponents: Array<Component>
|
|
3222
|
-
|
|
3223
2852
|
/**
|
|
3224
2853
|
* 签署人手机号 (如果选择短信验证码签署,则此字段必填)
|
|
3225
2854
|
*/
|
|
3226
2855
|
Mobile?: string
|
|
3227
|
-
|
|
3228
2856
|
/**
|
|
3229
2857
|
* 签署人对应的子机构ID,个人签署者此字段不填
|
|
3230
2858
|
*/
|
|
3231
2859
|
SubOrganizationId?: string
|
|
3232
|
-
|
|
3233
2860
|
/**
|
|
3234
|
-
|
|
2861
|
+
* 签名后校验方式:
|
|
3235
2862
|
1. WEIXINAPP - 微信小程序;
|
|
3236
2863
|
2. FACEID - 慧眼 (默认) ;
|
|
3237
2864
|
3. VERIFYCODE - 验证码;
|
|
3238
2865
|
4. NONE - 无。此选项为白名单参数,暂不支持公开调用。如需开通权限,请通过客户经理或邮件至e-contract@tencent.com与我们联系;
|
|
3239
2866
|
5. THIRD - 第三方 (暂不支持)
|
|
3240
2867
|
6. OFFLINE - 线下人工审核
|
|
3241
|
-
|
|
2868
|
+
*/
|
|
3242
2869
|
VerifyChannel?: Array<string>
|
|
3243
|
-
|
|
3244
2870
|
/**
|
|
3245
2871
|
* 签署链接失效截止时间,默认为7天
|
|
3246
2872
|
*/
|
|
3247
2873
|
Deadline?: number
|
|
3248
|
-
|
|
3249
2874
|
/**
|
|
3250
2875
|
* 是否为最后一个签署人。若为最后一人,本次签署完成以后自动归档
|
|
3251
2876
|
*/
|
|
3252
2877
|
IsLastApprover?: boolean
|
|
3253
|
-
|
|
3254
2878
|
/**
|
|
3255
2879
|
* 签署完成后,前端跳转的url
|
|
3256
2880
|
*/
|
|
3257
2881
|
JumpUrl?: string
|
|
3258
|
-
|
|
3259
2882
|
/**
|
|
3260
|
-
|
|
2883
|
+
* 短信模板
|
|
3261
2884
|
默认使用腾讯电子签官方短信模板,如有自定义需求,请通过客户经理或邮件至e-contract@tencent.com与我们联系。
|
|
3262
|
-
|
|
2885
|
+
*/
|
|
3263
2886
|
SmsTemplate?: SmsTemplate
|
|
3264
|
-
|
|
3265
2887
|
/**
|
|
3266
2888
|
* 签署前置条件:是否要全文阅读,默认否
|
|
3267
2889
|
*/
|
|
3268
2890
|
IsFullText?: boolean
|
|
3269
|
-
|
|
3270
2891
|
/**
|
|
3271
2892
|
* 签署前置条件:强制用户阅读待签署文件时长,默认不限制
|
|
3272
2893
|
*/
|
|
3273
2894
|
PreReadTime?: number
|
|
3274
|
-
|
|
3275
2895
|
/**
|
|
3276
2896
|
* 当前参与者是否支持线下核身,默认为不支持
|
|
3277
2897
|
*/
|
|
3278
2898
|
CanOffLine?: boolean
|
|
3279
|
-
|
|
3280
2899
|
/**
|
|
3281
2900
|
* 签署任务的回调地址
|
|
3282
2901
|
*/
|
|
@@ -3291,12 +2910,10 @@ export interface CancelFlowRequest {
|
|
|
3291
2910
|
* 调用方信息
|
|
3292
2911
|
*/
|
|
3293
2912
|
Caller: Caller
|
|
3294
|
-
|
|
3295
2913
|
/**
|
|
3296
2914
|
* 流程ID
|
|
3297
2915
|
*/
|
|
3298
2916
|
FlowId: string
|
|
3299
|
-
|
|
3300
2917
|
/**
|
|
3301
2918
|
* 撤销原因
|
|
3302
2919
|
*/
|
|
@@ -3311,7 +2928,6 @@ export interface CreateH5FaceIdUrlResponse {
|
|
|
3311
2928
|
* 跳转到人脸核身页面的链接
|
|
3312
2929
|
*/
|
|
3313
2930
|
Url?: string
|
|
3314
|
-
|
|
3315
2931
|
/**
|
|
3316
2932
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3317
2933
|
*/
|
|
@@ -3326,7 +2942,6 @@ export interface DescribeCustomFlowIdsRequest {
|
|
|
3326
2942
|
* 调用方信息
|
|
3327
2943
|
*/
|
|
3328
2944
|
Caller: Caller
|
|
3329
|
-
|
|
3330
2945
|
/**
|
|
3331
2946
|
* 自定义 id 列表,最多同时查询 10 个自定义 id
|
|
3332
2947
|
*/
|
|
@@ -3341,17 +2956,14 @@ export interface DescribeFlowApproversRequest {
|
|
|
3341
2956
|
* 调用方信息
|
|
3342
2957
|
*/
|
|
3343
2958
|
Caller: Caller
|
|
3344
|
-
|
|
3345
2959
|
/**
|
|
3346
2960
|
* 需要查询的流程ID
|
|
3347
2961
|
*/
|
|
3348
2962
|
FlowId: string
|
|
3349
|
-
|
|
3350
2963
|
/**
|
|
3351
2964
|
* 需要查询的用户ID,为空则默认查询所有用户信息
|
|
3352
2965
|
*/
|
|
3353
2966
|
UserId?: string
|
|
3354
|
-
|
|
3355
2967
|
/**
|
|
3356
2968
|
* 需要查询的签署ID,为空则不按签署ID过滤
|
|
3357
2969
|
*/
|
|
@@ -3366,7 +2978,6 @@ export interface DescribeFaceIdResultsResponse {
|
|
|
3366
2978
|
* 核身结果列表
|
|
3367
2979
|
*/
|
|
3368
2980
|
Results?: Array<FaceIdResult>
|
|
3369
|
-
|
|
3370
2981
|
/**
|
|
3371
2982
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3372
2983
|
*/
|
|
@@ -3381,27 +2992,22 @@ export interface CheckBankCard4EVerificationRequest {
|
|
|
3381
2992
|
* 调用方信息; 必选
|
|
3382
2993
|
*/
|
|
3383
2994
|
Caller: Caller
|
|
3384
|
-
|
|
3385
2995
|
/**
|
|
3386
2996
|
* 银行卡号
|
|
3387
2997
|
*/
|
|
3388
2998
|
BankCard: string
|
|
3389
|
-
|
|
3390
2999
|
/**
|
|
3391
3000
|
* 姓名
|
|
3392
3001
|
*/
|
|
3393
3002
|
Name: string
|
|
3394
|
-
|
|
3395
3003
|
/**
|
|
3396
3004
|
* 身份证件号码
|
|
3397
3005
|
*/
|
|
3398
3006
|
IdCardNumber?: string
|
|
3399
|
-
|
|
3400
3007
|
/**
|
|
3401
3008
|
* 手机号
|
|
3402
3009
|
*/
|
|
3403
3010
|
Mobile?: string
|
|
3404
|
-
|
|
3405
3011
|
/**
|
|
3406
3012
|
* 身份证件类型; ID_CARD
|
|
3407
3013
|
*/
|
|
@@ -3416,7 +3022,6 @@ export interface GenerateUserSealResponse {
|
|
|
3416
3022
|
* 电子印章Id
|
|
3417
3023
|
*/
|
|
3418
3024
|
SealId: string
|
|
3419
|
-
|
|
3420
3025
|
/**
|
|
3421
3026
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3422
3027
|
*/
|
|
@@ -3431,7 +3036,6 @@ export interface DescribeCatalogSignComponentsResponse {
|
|
|
3431
3036
|
* 签署区列表
|
|
3432
3037
|
*/
|
|
3433
3038
|
SignComponents: Array<CatalogComponents>
|
|
3434
|
-
|
|
3435
3039
|
/**
|
|
3436
3040
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3437
3041
|
*/
|
|
@@ -3446,33 +3050,28 @@ export interface GenerateOrganizationSealRequest {
|
|
|
3446
3050
|
* 调用方信息
|
|
3447
3051
|
*/
|
|
3448
3052
|
Caller: Caller
|
|
3449
|
-
|
|
3450
3053
|
/**
|
|
3451
|
-
|
|
3054
|
+
* 印章类型:
|
|
3452
3055
|
OFFICIAL-公章
|
|
3453
3056
|
SPECIAL_FINANCIAL-财务专用章
|
|
3454
3057
|
CONTRACT-合同专用章
|
|
3455
3058
|
LEGAL_REPRESENTATIVE-法定代表人章
|
|
3456
3059
|
SPECIAL_NATIONWIDE_INVOICE-发票专用章
|
|
3457
3060
|
OTHER-其他
|
|
3458
|
-
|
|
3061
|
+
*/
|
|
3459
3062
|
SealType: string
|
|
3460
|
-
|
|
3461
3063
|
/**
|
|
3462
3064
|
* 请求生成企业印章的客户端Ip
|
|
3463
3065
|
*/
|
|
3464
3066
|
SourceIp: string
|
|
3465
|
-
|
|
3466
3067
|
/**
|
|
3467
3068
|
* 电子印章名称
|
|
3468
3069
|
*/
|
|
3469
3070
|
SealName?: string
|
|
3470
|
-
|
|
3471
3071
|
/**
|
|
3472
3072
|
* 企业印章横向文字,最多可填8个汉字(可不填,默认为"电子签名专用章")
|
|
3473
3073
|
*/
|
|
3474
3074
|
SealHorizontalText?: string
|
|
3475
|
-
|
|
3476
3075
|
/**
|
|
3477
3076
|
* 是否是默认印章 true:是,false:否
|
|
3478
3077
|
*/
|
|
@@ -3487,17 +3086,14 @@ export interface CreateServerFlowSignRequest {
|
|
|
3487
3086
|
* 调用方信息
|
|
3488
3087
|
*/
|
|
3489
3088
|
Caller: Caller
|
|
3490
|
-
|
|
3491
3089
|
/**
|
|
3492
3090
|
* 流程ID
|
|
3493
3091
|
*/
|
|
3494
3092
|
FlowId: string
|
|
3495
|
-
|
|
3496
3093
|
/**
|
|
3497
3094
|
* 签署区域信息
|
|
3498
3095
|
*/
|
|
3499
3096
|
SignComponents: Array<Component>
|
|
3500
|
-
|
|
3501
3097
|
/**
|
|
3502
3098
|
* 客户端IP
|
|
3503
3099
|
*/
|
|
@@ -3512,12 +3108,10 @@ export interface Caller {
|
|
|
3512
3108
|
* 应用号
|
|
3513
3109
|
*/
|
|
3514
3110
|
ApplicationId: string
|
|
3515
|
-
|
|
3516
3111
|
/**
|
|
3517
3112
|
* 下属机构ID
|
|
3518
3113
|
*/
|
|
3519
3114
|
SubOrganizationId?: string
|
|
3520
|
-
|
|
3521
3115
|
/**
|
|
3522
3116
|
* 经办人的用户ID
|
|
3523
3117
|
*/
|
|
@@ -3532,7 +3126,6 @@ export interface VerifyUserResponse {
|
|
|
3532
3126
|
* 电子签平台用户ID
|
|
3533
3127
|
*/
|
|
3534
3128
|
UserId?: string
|
|
3535
|
-
|
|
3536
3129
|
/**
|
|
3537
3130
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3538
3131
|
*/
|
|
@@ -3547,77 +3140,63 @@ export interface SendFlowRequest {
|
|
|
3547
3140
|
* 调用方信息
|
|
3548
3141
|
*/
|
|
3549
3142
|
Caller: Caller
|
|
3550
|
-
|
|
3551
3143
|
/**
|
|
3552
3144
|
* 需要推送合同的流程ID
|
|
3553
3145
|
*/
|
|
3554
3146
|
FlowId: string
|
|
3555
|
-
|
|
3556
3147
|
/**
|
|
3557
3148
|
* 签署人用户ID
|
|
3558
3149
|
*/
|
|
3559
3150
|
UserId: string
|
|
3560
|
-
|
|
3561
3151
|
/**
|
|
3562
3152
|
* 签署控件信息 (支持添加多个控件)
|
|
3563
3153
|
*/
|
|
3564
3154
|
SignComponents: Array<Component>
|
|
3565
|
-
|
|
3566
3155
|
/**
|
|
3567
3156
|
* 签署人手机号 (如果选择短信验证码签署,则此字段必填)
|
|
3568
3157
|
*/
|
|
3569
3158
|
Mobile?: string
|
|
3570
|
-
|
|
3571
3159
|
/**
|
|
3572
3160
|
* 签署人对应的子机构ID,个人签署者此字段不填
|
|
3573
3161
|
*/
|
|
3574
3162
|
SubOrganizationId?: string
|
|
3575
|
-
|
|
3576
3163
|
/**
|
|
3577
|
-
|
|
3164
|
+
* 签名后校验方式:
|
|
3578
3165
|
1. WEIXINAPP - 微信小程序;
|
|
3579
3166
|
2. FACEID - 慧眼 (默认) ;
|
|
3580
3167
|
3. VERIFYCODE - 验证码;
|
|
3581
3168
|
4. NONE - 无。此选项为白名单参数,暂不支持公开调用。如需开通权限,请通过客户经理或邮件至e-contract@tencent.com与我们联系;
|
|
3582
3169
|
5. THIRD - 第三方 (暂不支持)
|
|
3583
|
-
|
|
3170
|
+
*/
|
|
3584
3171
|
VerifyChannel?: Array<string>
|
|
3585
|
-
|
|
3586
3172
|
/**
|
|
3587
3173
|
* 签署链接失效截止时间,默认为7天
|
|
3588
3174
|
*/
|
|
3589
3175
|
Deadline?: number
|
|
3590
|
-
|
|
3591
3176
|
/**
|
|
3592
3177
|
* 是否为最后一个签署人。若为最后一人,本次签署完成以后自动归档。
|
|
3593
3178
|
*/
|
|
3594
3179
|
IsLastApprover?: boolean
|
|
3595
|
-
|
|
3596
3180
|
/**
|
|
3597
3181
|
* 签署完成后,前端跳转的URL
|
|
3598
3182
|
*/
|
|
3599
3183
|
JumpUrl?: string
|
|
3600
|
-
|
|
3601
3184
|
/**
|
|
3602
3185
|
* 短信模板。默认使用腾讯电子签官方短信模板,如有自定义需求,请通过客户经理或邮件至e-contract@tencent.com与我们联系。
|
|
3603
3186
|
*/
|
|
3604
3187
|
SmsTemplate?: SmsTemplate
|
|
3605
|
-
|
|
3606
3188
|
/**
|
|
3607
3189
|
* 签署前置条件:是否要全文阅读,默认否
|
|
3608
3190
|
*/
|
|
3609
3191
|
IsFullText?: boolean
|
|
3610
|
-
|
|
3611
3192
|
/**
|
|
3612
3193
|
* 签署前置条件:强制用户阅读待签署文件时长,默认不限制
|
|
3613
3194
|
*/
|
|
3614
3195
|
PreReadTime?: number
|
|
3615
|
-
|
|
3616
3196
|
/**
|
|
3617
3197
|
* 当前参与者是否支持线下核身,默认为不支持
|
|
3618
3198
|
*/
|
|
3619
3199
|
CanOffLine?: boolean
|
|
3620
|
-
|
|
3621
3200
|
/**
|
|
3622
3201
|
* 签署任务的回调地址
|
|
3623
3202
|
*/
|
|
@@ -3632,37 +3211,30 @@ export interface SendSignInnerVerifyCodeRequest {
|
|
|
3632
3211
|
* 调用方信息
|
|
3633
3212
|
*/
|
|
3634
3213
|
Caller: Caller
|
|
3635
|
-
|
|
3636
3214
|
/**
|
|
3637
3215
|
* 手机号
|
|
3638
3216
|
*/
|
|
3639
3217
|
Mobile: string
|
|
3640
|
-
|
|
3641
3218
|
/**
|
|
3642
3219
|
* 验证码类型,取值(SIGN)
|
|
3643
3220
|
*/
|
|
3644
3221
|
VerifyType: string
|
|
3645
|
-
|
|
3646
3222
|
/**
|
|
3647
3223
|
* 用户 id
|
|
3648
3224
|
*/
|
|
3649
3225
|
UserId?: string
|
|
3650
|
-
|
|
3651
3226
|
/**
|
|
3652
3227
|
* 模板 id
|
|
3653
3228
|
*/
|
|
3654
3229
|
VerifyTemplateId?: string
|
|
3655
|
-
|
|
3656
3230
|
/**
|
|
3657
3231
|
* 签名
|
|
3658
3232
|
*/
|
|
3659
3233
|
VerifySign?: string
|
|
3660
|
-
|
|
3661
3234
|
/**
|
|
3662
3235
|
* 流程(目录) id
|
|
3663
3236
|
*/
|
|
3664
3237
|
FlowId?: string
|
|
3665
|
-
|
|
3666
3238
|
/**
|
|
3667
3239
|
* 三要素检测结果
|
|
3668
3240
|
*/
|
|
@@ -3687,7 +3259,6 @@ export interface CreateSubOrganizationResponse {
|
|
|
3687
3259
|
* 子机构ID
|
|
3688
3260
|
*/
|
|
3689
3261
|
SubOrganizationId: string
|
|
3690
|
-
|
|
3691
3262
|
/**
|
|
3692
3263
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3693
3264
|
*/
|
|
@@ -3702,12 +3273,10 @@ export interface CreateSubOrganizationAndSealResponse {
|
|
|
3702
3273
|
* 子机构在电子文件签署平台唯一标识
|
|
3703
3274
|
*/
|
|
3704
3275
|
SubOrganizationId: string
|
|
3705
|
-
|
|
3706
3276
|
/**
|
|
3707
3277
|
* 电子印章ID
|
|
3708
3278
|
*/
|
|
3709
3279
|
SealId: string
|
|
3710
|
-
|
|
3711
3280
|
/**
|
|
3712
3281
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3713
3282
|
*/
|
|
@@ -3722,27 +3291,22 @@ export interface ModifyUserRequest {
|
|
|
3722
3291
|
* 调用方信息
|
|
3723
3292
|
*/
|
|
3724
3293
|
Caller: Caller
|
|
3725
|
-
|
|
3726
3294
|
/**
|
|
3727
3295
|
* 第三方平台用户唯一标识; OpenId 和 UserId 二选一填写, 两个都不为空则优先使用UserId
|
|
3728
3296
|
*/
|
|
3729
3297
|
OpenId?: string
|
|
3730
|
-
|
|
3731
3298
|
/**
|
|
3732
3299
|
* 腾讯电子签平台用户唯一标识; OpenId 和 UserId 二选一填写, 两个都不为空则优先使用UserId
|
|
3733
3300
|
*/
|
|
3734
3301
|
UserId?: string
|
|
3735
|
-
|
|
3736
3302
|
/**
|
|
3737
3303
|
* 用户手机号码,不要求唯一
|
|
3738
3304
|
*/
|
|
3739
3305
|
Mobile?: string
|
|
3740
|
-
|
|
3741
3306
|
/**
|
|
3742
3307
|
* 用户邮箱,不要求唯一
|
|
3743
3308
|
*/
|
|
3744
3309
|
Email?: string
|
|
3745
|
-
|
|
3746
3310
|
/**
|
|
3747
3311
|
* 用户姓名
|
|
3748
3312
|
*/
|
|
@@ -3754,7 +3318,7 @@ export interface ModifyUserRequest {
|
|
|
3754
3318
|
*/
|
|
3755
3319
|
export interface CheckMobileAndNameResponse {
|
|
3756
3320
|
/**
|
|
3757
|
-
|
|
3321
|
+
* 检测结果
|
|
3758
3322
|
计费结果码:
|
|
3759
3323
|
0: 验证结果一致
|
|
3760
3324
|
1: 手机号未实名
|
|
@@ -3767,14 +3331,12 @@ export interface CheckMobileAndNameResponse {
|
|
|
3767
3331
|
104: 非法身份证号(长度,校验位等不正确)
|
|
3768
3332
|
105: 认证未通过
|
|
3769
3333
|
106: 验证平台异常
|
|
3770
|
-
|
|
3334
|
+
*/
|
|
3771
3335
|
Result?: number
|
|
3772
|
-
|
|
3773
3336
|
/**
|
|
3774
3337
|
* 结果描述; 未通过时必选
|
|
3775
3338
|
*/
|
|
3776
3339
|
Description?: string
|
|
3777
|
-
|
|
3778
3340
|
/**
|
|
3779
3341
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3780
3342
|
*/
|