tencentcloud-sdk-nodejs 4.0.479 → 4.0.481

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.
@@ -1,28 +1,186 @@
1
1
  /**
2
- * GetLivenessResult返回参数结构体
2
+ * 核身视频信息
3
3
  */
4
- export interface GetLivenessResultResponse {
4
+ export interface DetectInfoVideoData {
5
5
  /**
6
- * 流程的最终结果
6
+ * 活体视频的base64编码
7
+ 注意:此字段可能返回 null,表示取不到有效值。
7
8
  */
8
- Result: string;
9
+ LivenessVideo: string;
10
+ }
11
+ /**
12
+ * GetDetectInfoEnhanced请求参数结构体
13
+ */
14
+ export interface GetDetectInfoEnhancedRequest {
9
15
  /**
10
- * 流程的最终结果描述
16
+ * 人脸核身流程的标识,调用DetectAuth接口时生成。
11
17
  */
12
- Description: string;
18
+ BizToken: string;
19
+ /**
20
+ * 用于细分客户使用场景,由腾讯侧在线下对接时分配。
21
+ */
22
+ RuleId: string;
23
+ /**
24
+ * 指定拉取的结果信息,取值(0:全部;1:文本类;2:身份证信息;3:视频最佳截图信息)。
25
+ 如 13表示拉取文本类、视频最佳截图信息。
26
+ 默认值:0
27
+ */
28
+ InfoType?: string;
29
+ /**
30
+ * 从活体视频中截取一定张数的最佳帧(仅部分服务支持,若需使用请与慧眼小助手沟通)。默认为0,最大为10,超出10的最多只给10张。(InfoType需要包含3)
31
+ */
32
+ BestFramesCount?: number;
33
+ /**
34
+ * 是否对身份证照片进行裁边。默认为false。(InfoType需要包含2)
35
+ */
36
+ IsCutIdCardImage?: boolean;
37
+ /**
38
+ * 是否需要从身份证中抠出头像。默认为false。(InfoType需要包含2)
39
+ */
40
+ IsNeedIdCardAvatar?: boolean;
41
+ /**
42
+ * 已弃用。
43
+ */
44
+ IsEncrypt?: boolean;
45
+ /**
46
+ * 是否需要对返回中的敏感信息进行加密。仅指定加密算法Algorithm即可,其余字段传入默认值。其中敏感信息包括:Response.Text.IdCard、Response.Text.Name、Response.Text.OcrIdCard、Response.Text.OcrName
47
+ */
48
+ Encryption?: Encryption;
49
+ }
50
+ /**
51
+ * GetFaceIdToken请求参数结构体
52
+ */
53
+ export interface GetFaceIdTokenRequest {
54
+ /**
55
+ * 本地上传照片(LOCAL)、商业库(BUSINESS)
56
+ */
57
+ CompareLib: string;
58
+ /**
59
+ * CompareLib为商业库时必传。
60
+ */
61
+ IdCard?: string;
62
+ /**
63
+ * CompareLib为商业库库时必传。
64
+ */
65
+ Name?: string;
66
+ /**
67
+ * CompareLib为上传照片比对时必传,Base64后图片最大8MB。
68
+ 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
69
+ */
70
+ ImageBase64?: string;
71
+ /**
72
+ * SDK中生成的Meta字符串
73
+ */
74
+ Meta?: string;
75
+ /**
76
+ * 透传参数 1000长度字符串
77
+ */
78
+ Extra?: string;
79
+ /**
80
+ * 默认为false,设置该参数为true后,核身过程中的视频图片将会存储在人脸核身控制台授权cos的bucket中,拉取结果时会返回对应资源完整cos地址。开通地址见https://console.cloud.tencent.com/faceid/cos
81
+ 【注意】选择该参数为true后将不返回base64数据,请根据接入情况谨慎修改。
82
+ */
83
+ UseCos?: boolean;
84
+ }
85
+ /**
86
+ * Liveness请求参数结构体
87
+ */
88
+ export interface LivenessRequest {
89
+ /**
90
+ * 用于活体检测的视频,视频的BASE64值;
91
+ BASE64编码后的大小不超过8M,支持mp4、avi、flv格式。
92
+ */
93
+ VideoBase64: string;
94
+ /**
95
+ * 活体检测类型,取值:LIP/ACTION/SILENT。
96
+ LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。
97
+ */
98
+ LivenessType: string;
99
+ /**
100
+ * 数字模式传参:数字验证码(1234),需先调用接口获取数字验证码;
101
+ 动作模式传参:传动作顺序(2,1 or 1,2),需先调用接口获取动作顺序;
102
+ 静默模式传参:不需要传递此参数。
103
+ */
104
+ ValidateData?: string;
105
+ /**
106
+ * 额外配置,传入JSON字符串。
107
+ {
108
+ "BestFrameNum": 2 //需要返回多张最佳截图,取值范围1-10
109
+ }
110
+ */
111
+ Optional?: string;
112
+ }
113
+ /**
114
+ * 敏感数据加密
115
+ */
116
+ export interface Encryption {
117
+ /**
118
+ * 在使用加密服务时,填入要被加密的字段。本接口中可填入加密后的一个或多个字段
119
+ */
120
+ EncryptList: Array<string>;
121
+ /**
122
+ * 有加密需求的用户,接入传入kms的CiphertextBlob,关于数据加密可查阅<a href="https://cloud.tencent.com/document/product/1007/47180">数据加密</a> 文档。
123
+ */
124
+ CiphertextBlob: string;
125
+ /**
126
+ * 有加密需求的用户,传入CBC加密的初始向量(客户自定义字符串,长度16字符)。
127
+ */
128
+ Iv: string;
129
+ /**
130
+ * 加密使用的算法(支持'AES-256-CBC'、'SM4-GCM'),不传默认为'AES-256-CBC'
131
+ */
132
+ Algorithm?: string;
13
133
  /**
14
- * 人像截图
134
+ * SM4-GCM算法生成的消息摘要(校验消息完整性时使用)
135
+ */
136
+ TagList?: Array<string>;
137
+ }
138
+ /**
139
+ * CheckBankCardInformation请求参数结构体
140
+ */
141
+ export interface CheckBankCardInformationRequest {
142
+ /**
143
+ * 银行卡号。
144
+ */
145
+ BankCard: string;
146
+ /**
147
+ * 敏感数据加密信息。对传入信息(银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
148
+ */
149
+ Encryption?: Encryption;
150
+ }
151
+ /**
152
+ * MobileNetworkTimeVerification返回参数结构体
153
+ */
154
+ export interface MobileNetworkTimeVerificationResponse {
155
+ /**
156
+ * 认证结果码,收费情况如下。
157
+ 收费结果码:
158
+ 0: 成功
159
+ -2: 手机号不存在
160
+ -3: 手机号存在,但无法查询到在网时长
161
+ 不收费结果码:
162
+ -1: 手机号格式不正确
163
+ -4: 验证中心服务繁忙
164
+ */
165
+ Result: string;
166
+ /**
167
+ * 业务结果描述。
15
168
  */
16
- BestFrame: FileInfo;
169
+ Description: string;
17
170
  /**
18
- * 检测过程视频
171
+ * 在网时长区间。
172
+ 格式为(a,b],表示在网时长在a个月以上,b个月以下。若b为+时表示没有上限。
19
173
  */
20
- Video: FileInfo;
174
+ Range: string;
21
175
  /**
22
176
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
23
177
  */
24
178
  RequestId?: string;
25
179
  }
180
+ /**
181
+ * GetLiveCode请求参数结构体
182
+ */
183
+ export declare type GetLiveCodeRequest = null;
26
184
  /**
27
185
  * CheckIdNameDate返回参数结构体
28
186
  */
@@ -68,308 +226,374 @@ export interface IdCardVerificationRequest {
68
226
  Encryption?: Encryption;
69
227
  }
70
228
  /**
71
- * GetDetectInfoEnhanced返回参数结构体
229
+ * BankCardVerification请求参数结构体
72
230
  */
73
- export interface GetDetectInfoEnhancedResponse {
231
+ export interface BankCardVerificationRequest {
74
232
  /**
75
- * 文本类信息。
76
- 注意:此字段可能返回 null,表示取不到有效值。
233
+ * 开户证件号,与CertType参数的证件类型一致,如:身份证,则传入身份证号。
77
234
  */
78
- Text: DetectInfoText;
235
+ IdCard: string;
79
236
  /**
80
- * 身份证照片信息。
81
- 注意:此字段可能返回 null,表示取不到有效值。
237
+ * 姓名
82
238
  */
83
- IdCardData: DetectInfoIdCardData;
239
+ Name: string;
84
240
  /**
85
- * 最佳帧信息。
86
- 注意:此字段可能返回 null,表示取不到有效值。
241
+ * 银行卡
87
242
  */
88
- BestFrame: DetectInfoBestFrame;
243
+ BankCard: string;
89
244
  /**
90
- * 视频信息。
91
- 注意:此字段可能返回 null,表示取不到有效值。
245
+ * 证件类型,请确认该证件为开户时使用的证件类型,未用于开户的证件信息不支持验证。
246
+ 目前默认:0 身份证,其他证件类型需求可以添加[腾讯云人脸核身小助手](https://cloud.tencent.com/document/product/1007/56130)进行确认。
92
247
  */
93
- VideoData: DetectInfoVideoData;
248
+ CertType?: number;
94
249
  /**
95
- * 敏感数据加密信息。
96
- 注意:此字段可能返回 null,表示取不到有效值。
250
+ * 敏感数据加密信息。对传入信息(姓名、身份证号、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
97
251
  */
98
- Encryption: Encryption;
252
+ Encryption?: Encryption;
253
+ }
254
+ /**
255
+ * CheckBankCardInformation返回参数结构体
256
+ */
257
+ export interface CheckBankCardInformationResponse {
99
258
  /**
100
- * 意愿核身相关信息。若未使用意愿核身功能,该字段返回值可以不处理。
101
- 注意:此字段可能返回 null,表示取不到有效值。
259
+ * 认证结果码,收费情况如下。
260
+ 收费结果码:
261
+ 0: 查询成功
262
+ -1: 未查到信息
263
+ 不收费结果码
264
+ -2:验证中心服务繁忙
265
+ -3:银行卡不存在
102
266
  */
103
- IntentionVerifyData: IntentionVerifyData;
267
+ Result: string;
104
268
  /**
105
- * 意愿核身问答模式结果。若未使用该意愿核身功能,该字段返回值可以不处理。
106
- 注意:此字段可能返回 null,表示取不到有效值。
269
+ * 业务结果描述
107
270
  */
108
- IntentionQuestionResult: IntentionQuestionResult;
271
+ Description: string;
272
+ /**
273
+ * 开户行
274
+ */
275
+ AccountBank: string;
276
+ /**
277
+ * 卡性质:1. 借记卡;2. 贷记卡;3. 预付费卡;4. 准贷记卡
278
+ */
279
+ AccountType: number;
109
280
  /**
110
281
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
111
282
  */
112
283
  RequestId?: string;
113
284
  }
114
285
  /**
115
- * 意愿核身问答模式结果
286
+ * 核身最佳帧信息
116
287
  */
117
- export interface IntentionQuestionResult {
288
+ export interface DetectInfoBestFrame {
118
289
  /**
119
- * 意愿核身最终结果:
120
- 0:认证通过,-1:认证未通过,-2:浏览器内核不兼容,无法进行意愿校验
290
+ * 活体比对最佳帧Base64编码。
121
291
  注意:此字段可能返回 null,表示取不到有效值。
122
292
  */
123
- FinalResultCode: string;
293
+ BestFrame: string;
124
294
  /**
125
- * 视频base64(其中包含全程问题和回答音频,mp4格式)
295
+ * 自截帧Base64编码数组。
126
296
  注意:此字段可能返回 null,表示取不到有效值。
127
297
  */
128
- Video: string;
298
+ BestFrames: Array<string>;
299
+ }
300
+ /**
301
+ * 账单详情
302
+ */
303
+ export interface WeChatBillDetail {
129
304
  /**
130
- * 屏幕截图base64列表
131
- 注意:此字段可能返回 null,表示取不到有效值。
305
+ * token
132
306
  */
133
- ScreenShot: Array<string>;
307
+ BizToken: string;
134
308
  /**
135
- * 和答案匹配结果列表
136
- 0:成功,-1:不匹配
137
- 注意:此字段可能返回 null,表示取不到有效值。
309
+ * 本token收费次数
138
310
  */
139
- ResultCode: Array<string>;
311
+ ChargeCount: number;
140
312
  /**
141
- * 回答问题语音识别结果列表
142
- 注意:此字段可能返回 null,表示取不到有效值。
313
+ * 本token计费详情
143
314
  */
144
- AsrResult: Array<string>;
315
+ ChargeDetails: Array<ChargeDetail>;
145
316
  /**
146
- * 答案录音音频
147
- 注意:此字段可能返回 null,表示取不到有效值。
317
+ * 业务RuleId
148
318
  */
149
- Audios: Array<string>;
319
+ RuleId: string;
150
320
  }
151
321
  /**
152
- * MobileStatus请求参数结构体
322
+ * 获取token时的的配置
153
323
  */
154
- export interface MobileStatusRequest {
324
+ export interface GetEidTokenConfig {
155
325
  /**
156
- * 手机号码
326
+ * 姓名身份证输入方式。
327
+ 1:传身份证正反面OCR
328
+ 2:传身份证正面OCR
329
+ 3:用户手动输入
330
+ 4:客户后台传入
331
+ 默认1
332
+ 注:使用OCR时仅支持用户修改结果中的姓名
157
333
  */
158
- Mobile: string;
334
+ InputType?: string;
159
335
  /**
160
- * 敏感数据加密信息。对传入信息(手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
336
+ * 是否使用意愿核身,默认不使用。注意:如开启使用,则计费标签按【意愿核身】计费标签计价;如不开启,则计费标签按【E证通】计费标签计价,价格详见:[价格说明](https://cloud.tencent.com/document/product/1007/56804)。
161
337
  */
162
- Encryption?: Encryption;
338
+ UseIntentionVerify?: boolean;
339
+ /**
340
+ * 意愿核身模式。枚举值:1( 朗读模式),2(问答模式) 。默认值1
341
+ */
342
+ IntentionMode?: string;
343
+ /**
344
+ * 意愿核身朗读模式使用的文案,若未使用意愿核身朗读功能,该字段无需传入。默认为空,最长可接受120的字符串长度。
345
+ */
346
+ IntentionVerifyText?: string;
347
+ /**
348
+ * 意愿核身问答模式的配置列表。当前仅支持一个问答。
349
+ */
350
+ IntentionQuestions?: Array<IntentionQuestion>;
351
+ /**
352
+ * 意愿核身过程中识别用户的回答意图,开启后除了IntentionQuestions的Answers列表中的标准回答会通过,近似意图的回答也会通过,默认不开启。
353
+ */
354
+ IntentionRecognition?: boolean;
163
355
  }
164
356
  /**
165
- * ParseNfcData返回参数结构体
357
+ * CheckIdCardInformation返回参数结构体
166
358
  */
167
- export interface ParseNfcDataResponse {
359
+ export interface CheckIdCardInformationResponse {
168
360
  /**
169
- * 0为首次查询成功,-1为查询失败。
170
- 注意:此字段可能返回 null,表示取不到有效值。
361
+ * 相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
171
362
  */
172
- ResultCode: string;
363
+ Sim: number;
173
364
  /**
174
- * 身份证号
175
- 注意:此字段可能返回 null,表示取不到有效值。
365
+ * 业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
176
366
  */
177
- IdNum: string;
367
+ Result: string;
368
+ /**
369
+ * 业务结果描述。
370
+ */
371
+ Description: string;
178
372
  /**
179
373
  * 姓名
180
- 注意:此字段可能返回 null,表示取不到有效值。
181
374
  */
182
375
  Name: string;
183
376
  /**
184
- * 照片
185
- 注意:此字段可能返回 null,表示取不到有效值。
377
+ * 性别
186
378
  */
187
- Picture: string;
379
+ Sex: string;
188
380
  /**
189
- * 出生日期
190
- 注意:此字段可能返回 null,表示取不到有效值。
381
+ * 民族
191
382
  */
192
- BirthDate: string;
383
+ Nation: string;
193
384
  /**
194
- * 有效期起始时间
195
- 注意:此字段可能返回 null,表示取不到有效值。
385
+ * 出生日期
196
386
  */
197
- BeginTime: string;
387
+ Birth: string;
198
388
  /**
199
- * 有效期结束时间
200
- 注意:此字段可能返回 null,表示取不到有效值。
389
+ * 地址
201
390
  */
202
- EndTime: string;
391
+ Address: string;
203
392
  /**
204
- * 住址
205
- 注意:此字段可能返回 null,表示取不到有效值。
393
+ * 身份证号
206
394
  */
207
- Address: string;
395
+ IdNum: string;
208
396
  /**
209
- * 民族
210
- 注意:此字段可能返回 null,表示取不到有效值。
397
+ * 身份证头像照片的base64编码,如果抠图失败会拿整张身份证做比对并返回空。
211
398
  */
212
- Nation: string;
399
+ Portrait: string;
213
400
  /**
214
- * 性别
215
- 注意:此字段可能返回 null,表示取不到有效值。
401
+ * 告警信息,当在Config中配置了告警信息会停止人像比对,Result返回错误(FailedOperation.OcrWarningOccurred)并有此告警信息,Code 告警码列表和释义:
402
+
403
+ -9101 身份证边框不完整告警,
404
+ -9102 身份证复印件告警,
405
+ -9103 身份证翻拍告警,
406
+ -9105 身份证框内遮挡告警,
407
+ -9104 临时身份证告警,
408
+ -9106 身份证 PS 告警。
409
+ -8001 图片模糊告警
410
+ 多个会 | 隔开如 "-9101|-9106|-9104"
216
411
  */
217
- Sex: string;
412
+ Warnings: string;
218
413
  /**
219
- * 身份证 01 中国护照 03 军官证 04 武警证 05 港澳通行证 06 台胞证 07 外国护照 08 士兵证 09 临时身份证 10 户口本 11 警官证 12 外国人永久居留证 13 港澳台居民居住证 14 回乡证 15 大陆居民来往台湾通行证 16 其他证件 99
220
- 注意:此字段可能返回 null,表示取不到有效值。
414
+ * 图片质量分数,当请求Config中配置图片模糊告警该参数才有意义,取值范围(0~100),目前默认阈值是50分,低于50分会触发模糊告警。
221
415
  */
222
- IdType: string;
416
+ Quality: number;
223
417
  /**
224
- * 英文姓名
418
+ * 敏感数据加密信息。
225
419
  注意:此字段可能返回 null,表示取不到有效值。
226
420
  */
227
- EnName: string;
421
+ Encryption: Encryption;
228
422
  /**
229
- * 签发机关
230
- 注意:此字段可能返回 null,表示取不到有效值。
423
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
231
424
  */
232
- SigningOrganization: string;
425
+ RequestId?: string;
426
+ }
427
+ /**
428
+ * GetDetectInfoEnhanced返回参数结构体
429
+ */
430
+ export interface GetDetectInfoEnhancedResponse {
233
431
  /**
234
- * 港澳台居民居住证,通行证号码
432
+ * 文本类信息。
235
433
  注意:此字段可能返回 null,表示取不到有效值。
236
434
  */
237
- OtherIdNum: string;
435
+ Text: DetectInfoText;
238
436
  /**
239
- * 旅行证件国籍
437
+ * 身份证照片信息。
240
438
  注意:此字段可能返回 null,表示取不到有效值。
241
439
  */
242
- Nationality: string;
440
+ IdCardData: DetectInfoIdCardData;
243
441
  /**
244
- * 旅行证件机读区第二行 29~42 位
442
+ * 最佳帧信息。
245
443
  注意:此字段可能返回 null,表示取不到有效值。
246
444
  */
247
- PersonalNumber: string;
445
+ BestFrame: DetectInfoBestFrame;
248
446
  /**
249
- * 旅行证件类的核验结果。JSON格式如下:
250
- {"result_issuer ":"签发者证书合法性验证结果 ","result_pape r":"证件安全对象合法性验证 结果 ","result_data" :"防数据篡改验证结果 ","result_chip" :"防证书件芯片被复制验证结果"}
251
- 0:验证通过,1: 验证不通过,2: 未验证,3:部分通过,当4项核验结果都为0时,表示证件为真
447
+ * 视频信息。
252
448
  注意:此字段可能返回 null,表示取不到有效值。
253
449
  */
254
- CheckMRTD: string;
450
+ VideoData: DetectInfoVideoData;
255
451
  /**
256
- * 身份证照片面合成图片
452
+ * 敏感数据加密信息。
257
453
  注意:此字段可能返回 null,表示取不到有效值。
258
454
  */
259
- ImageA: string;
455
+ Encryption: Encryption;
260
456
  /**
261
- * 身份证国徽面合成图片
457
+ * 意愿核身相关信息。若未使用意愿核身功能,该字段返回值可以不处理。
262
458
  注意:此字段可能返回 null,表示取不到有效值。
263
459
  */
264
- ImageB: string;
460
+ IntentionVerifyData: IntentionVerifyData;
265
461
  /**
266
- * 对result code的结果描述
462
+ * 意愿核身问答模式结果。若未使用该意愿核身功能,该字段返回值可以不处理。
267
463
  注意:此字段可能返回 null,表示取不到有效值。
268
464
  */
269
- ResultDescription: string;
465
+ IntentionQuestionResult: IntentionQuestionResult;
270
466
  /**
271
467
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
272
468
  */
273
469
  RequestId?: string;
274
470
  }
275
471
  /**
276
- * LivenessRecognition请求参数结构体
472
+ * PhoneVerification请求参数结构体
277
473
  */
278
- export interface LivenessRecognitionRequest {
474
+ export interface PhoneVerificationRequest {
279
475
  /**
280
476
  * 身份证号
281
477
  */
282
478
  IdCard: string;
283
479
  /**
284
- * 姓名。中文请使用UTF-8编码。
480
+ * 姓名
285
481
  */
286
482
  Name: string;
287
483
  /**
288
- * 活体检测类型,取值:LIP/ACTION/SILENT。
289
- LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。
484
+ * 手机号
290
485
  */
291
- LivenessType: string;
486
+ Phone: string;
292
487
  /**
293
- * 用于活体检测的视频,视频的BASE64值;
294
- BASE64编码后的大小不超过8M,支持mp4、avi、flv格式。
488
+ * 有加密需求的用户,传入kms的CiphertextBlob,关于数据加密可查阅 <a href="https://cloud.tencent.com/document/product/1007/47180">数据加密</a> 文档。
295
489
  */
296
- VideoBase64?: string;
490
+ CiphertextBlob?: string;
297
491
  /**
298
- * 用于活体检测的视频Url 地址。视频下载后经Base64编码不超过 8M,视频下载耗时不超过4S,支持mp4、avi、flv格式。
299
-
300
- 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
301
-
302
- 建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议视频存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
492
+ * 在使用加密服务时,填入要被加密的字段。本接口中可填入加密后的IdCard,Name,Phone中的一个或多个。
303
493
  */
304
- VideoUrl?: string;
494
+ EncryptList?: Array<string>;
305
495
  /**
306
- * 数字模式传参:传数字验证码,验证码需先调用<a href="https://cloud.tencent.com/document/product/1007/31821">获取数字验证码接口</a>得到;
307
- 动作模式传参:传动作顺序,动作顺序需先调用<a href="https://cloud.tencent.com/document/product/1007/31822">获取动作顺序接口</a>得到;
308
- 静默模式传参:空。
496
+ * 有加密需求的用户,传入CBC加密的初始向量。
309
497
  */
310
- ValidateData?: string;
311
- /**
312
- * 额外配置,传入JSON字符串。
313
- {
314
- "BestFrameNum": 2 //需要返回多张最佳截图,取值范围2-10
498
+ Iv?: string;
315
499
  }
500
+ /**
501
+ * PhoneVerificationCMCC请求参数结构体
502
+ */
503
+ export interface PhoneVerificationCMCCRequest {
504
+ /**
505
+ * 身份证号
316
506
  */
317
- Optional?: string;
507
+ IdCard: string;
318
508
  /**
319
- * 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
509
+ * 姓名
320
510
  */
321
- Encryption?: Encryption;
322
- }
323
- /**
324
- * CheckEidTokenStatus返回参数结构体
325
- */
326
- export interface CheckEidTokenStatusResponse {
511
+ Name: string;
327
512
  /**
328
- * 枚举:
329
- init:token未验证
330
- doing: 验证中
331
- finished: 验证完成
332
- timeout: token已超时
513
+ * 手机号
333
514
  */
334
- Status: string;
515
+ Phone: string;
335
516
  /**
336
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
517
+ * 敏感数据加密信息。对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
337
518
  */
338
- RequestId?: string;
519
+ Encryption?: Encryption;
339
520
  }
340
521
  /**
341
- * Eid出参,包括商户方用户的标识和加密的用户姓名身份证信息。
522
+ * GetEidResult请求参数结构体
342
523
  */
343
- export interface EidInfo {
344
- /**
345
- * 商户方 appeIDcode 的数字证书
346
- */
347
- EidCode: string;
524
+ export interface GetEidResultRequest {
348
525
  /**
349
- * Eid中心针对商户方EidCode的电子签名
526
+ * E证通流程的唯一标识,调用GetEidToken接口时生成。
350
527
  */
351
- EidSign: string;
528
+ EidToken: string;
352
529
  /**
353
- * 商户方公钥加密的会话密钥的base64字符串,[指引详见](https://cloud.tencent.com/document/product/1007/63370)
530
+ * 指定拉取的结果信息,取值(0:全部;1:文本类;2:身份证信息;3:最佳截图信息;5:意愿核身朗读模式相关结果;6:意愿核身问答模式相关结果)。
531
+ 如 13表示拉取文本类、最佳截图信息。
532
+ 默认值:0
354
533
  */
355
- DesKey: string;
534
+ InfoType?: string;
356
535
  /**
357
- * 会话密钥sm2加密后的base64字符串,[指引详见](https://cloud.tencent.com/document/product/1007/63370)
536
+ * 从活体视频中截取一定张数的最佳帧。默认为0,最大为3,超出3的最多只给3张。(InfoType需要包含3)
358
537
  */
359
- UserInfo: string;
538
+ BestFramesCount?: number;
360
539
  }
361
540
  /**
362
- * DetectAuth请求参数结构体
541
+ * DetectAuth返回参数结构体
363
542
  */
364
- export interface DetectAuthRequest {
543
+ export interface DetectAuthResponse {
365
544
  /**
366
- * 用于细分客户使用场景,申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。如有疑问,请添加[腾讯云人脸核身小助手](https://cloud.tencent.com/document/product/1007/56130)进行咨询。
545
+ * 用于发起核身流程的URL,仅微信H5场景使用。
367
546
  */
368
- RuleId: string;
547
+ Url: string;
369
548
  /**
370
- * 本接口不需要传递此参数。
549
+ * 一次核身流程的标识,有效时间为7,200秒;
550
+ 完成核身后,可用该标识获取验证结果信息。
371
551
  */
372
- TerminalType?: string;
552
+ BizToken: string;
553
+ /**
554
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
555
+ */
556
+ RequestId?: string;
557
+ }
558
+ /**
559
+ * PhoneVerification返回参数结构体
560
+ */
561
+ export interface PhoneVerificationResponse {
562
+ /**
563
+ * 认证结果码:
564
+ 收费结果码
565
+ 0: 三要素信息一致
566
+ -4: 三要素信息不一致
567
+ 不收费结果码
568
+ -6: 手机号码不合法
569
+ -7: 身份证号码有误
570
+ -8: 姓名校验不通过
571
+ -9: 没有记录
572
+ -11: 验证中心服务繁忙
573
+ */
574
+ Result: string;
575
+ /**
576
+ * 业务结果描述。
577
+ */
578
+ Description: string;
579
+ /**
580
+ * 运营商名称。
581
+ 取值范围为["","移动","电信","联通"]
582
+ */
583
+ Isp: string;
584
+ /**
585
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
586
+ */
587
+ RequestId?: string;
588
+ }
589
+ /**
590
+ * GetEidToken请求参数结构体
591
+ */
592
+ export interface GetEidTokenRequest {
593
+ /**
594
+ * EID商户id,字段长度最长50位。
595
+ */
596
+ MerchantId: string;
373
597
  /**
374
598
  * 身份标识(未使用OCR服务时,必须传入)。
375
599
  规则:a-zA-Z0-9组合。最长长度32位。
@@ -380,113 +604,97 @@ export interface DetectAuthRequest {
380
604
  */
381
605
  Name?: string;
382
606
  /**
383
- * 认证结束后重定向的回调链接地址。最长长度1024位。
607
+ * 透传字段,在获取验证结果时返回。最长长度1024位。
384
608
  */
385
- RedirectUrl?: string;
609
+ Extra?: string;
386
610
  /**
387
- * 透传字段,在获取验证结果时返回。
611
+ * 小程序模式配置,包括如何传入姓名身份证的配置,以及是否使用意愿核身。
388
612
  */
389
- Extra?: string;
613
+ Config?: GetEidTokenConfig;
390
614
  /**
391
- * 用于人脸比对的照片,图片的Base64值;
392
- Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
615
+ * 最长长度1024位。用户从Url中进入核身认证结束后重定向的回调链接地址。EidToken会在该链接的query参数中。
393
616
  */
394
- ImageBase64?: string;
617
+ RedirectUrl?: string;
395
618
  /**
396
619
  * 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
397
620
  */
398
621
  Encryption?: Encryption;
399
- /**
400
- * 意愿核身使用的文案,若未使用意愿核身功能,该字段无需传入。默认为空,最长可接受120的字符串长度。
401
- */
402
- IntentionVerifyText?: string;
403
- /**
404
- * 意愿核身过程中播报文本/问题、用户朗读/回答的文本,当前支持一个播报文本+回答文本。
405
- */
406
- IntentionQuestions?: Array<IntentionQuestion>;
407
622
  }
408
623
  /**
409
- * CheckEidTokenStatus请求参数结构体
624
+ * 意愿核身问答模式结果
410
625
  */
411
- export interface CheckEidTokenStatusRequest {
626
+ export interface IntentionQuestionResult {
412
627
  /**
413
- * E证通流程的唯一标识,调用GetEidToken接口时生成。
628
+ * 意愿核身最终结果:
629
+ 0:认证通过,-1:认证未通过,-2:浏览器内核不兼容,无法进行意愿校验
630
+ 注意:此字段可能返回 null,表示取不到有效值。
414
631
  */
415
- EidToken: string;
416
- }
417
- /**
418
- * GetActionSequence返回参数结构体
419
- */
420
- export interface GetActionSequenceResponse {
632
+ FinalResultCode: string;
421
633
  /**
422
- * 动作顺序(2,1 or 1,2) 。1代表张嘴,2代表闭眼。
634
+ * 视频base64(其中包含全程问题和回答音频,mp4格式)
635
+ 注意:此字段可能返回 null,表示取不到有效值。
423
636
  */
424
- ActionSequence?: string;
637
+ Video: string;
425
638
  /**
426
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
639
+ * 屏幕截图base64列表
640
+ 注意:此字段可能返回 null,表示取不到有效值。
427
641
  */
428
- RequestId?: string;
429
- }
430
- /**
431
- * LivenessCompare返回参数结构体
432
- */
433
- export interface LivenessCompareResponse {
642
+ ScreenShot: Array<string>;
434
643
  /**
435
- * 验证通过后的视频最佳截图照片,照片为BASE64编码后的值,jpg格式。
644
+ * 和答案匹配结果列表
645
+ 0:成功,-1:不匹配
436
646
  注意:此字段可能返回 null,表示取不到有效值。
437
647
  */
438
- BestFrameBase64: string;
648
+ ResultCode: Array<string>;
439
649
  /**
440
- * 相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)。
650
+ * 回答问题语音识别结果列表
651
+ 注意:此字段可能返回 null,表示取不到有效值。
441
652
  */
442
- Sim: number;
653
+ AsrResult: Array<string>;
443
654
  /**
444
- * 业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
655
+ * 答案录音音频
656
+ 注意:此字段可能返回 null,表示取不到有效值。
445
657
  */
446
- Result: string;
658
+ Audios: Array<string>;
659
+ }
660
+ /**
661
+ * GetWeChatBillDetails返回参数结构体
662
+ */
663
+ export interface GetWeChatBillDetailsResponse {
447
664
  /**
448
- * 业务结果描述。
665
+ * 是否还有下一页。该字段为true时,需要将NextCursor的值作为入参Cursor继续调用本接口。
449
666
  */
450
- Description: string;
667
+ HasNextPage: boolean;
451
668
  /**
452
- * 最佳截图列表,仅在配置了返回多张最佳截图时返回。
453
- 注意:此字段可能返回 null,表示取不到有效值。
669
+ * 下一页的游标。用于分页。
454
670
  */
455
- BestFrameList: Array<string>;
671
+ NextCursor: number;
672
+ /**
673
+ * 数据
674
+ */
675
+ WeChatBillDetails: Array<WeChatBillDetail>;
456
676
  /**
457
677
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
458
678
  */
459
679
  RequestId?: string;
460
680
  }
461
681
  /**
462
- * BankCard2EVerification返回参数结构体
682
+ * CheckPhoneAndName返回参数结构体
463
683
  */
464
- export interface BankCard2EVerificationResponse {
684
+ export interface CheckPhoneAndNameResponse {
465
685
  /**
466
- * 认证结果码
467
- 计费结果码:
468
- '0': '认证通过'
469
- '-1': '认证未通过'
470
- '-4': '持卡人信息有误'
471
- '-5': '未开通无卡支付'
472
- '-6': '此卡被没收'
473
- '-7': '无效卡号'
474
- '-8': '此卡无对应发卡行'
475
- '-9': '该卡未初始化或睡眠卡'
476
- '-10': '作弊卡、吞卡'
477
- '-11': '此卡已挂失'
478
- '-12': '该卡已过期'
479
- '-13': '受限制的卡'
480
- '-14': '密码错误次数超限'
481
- '-15': '发卡行不支持此交易'
482
- 不计费结果码:
483
- '-2': '姓名校验不通过'
484
- '-3': '银行卡号码有误'
485
- '-16': '验证中心服务繁忙'
686
+ * 认证结果码,收费情况如下。
687
+ 收费结果码:
688
+ 0: 验证结果一致
689
+ 1: 验证结果不一致
690
+ 不收费结果码:
691
+ -1:查无记录
692
+ -2:引擎未知错误
693
+ -3:引擎服务异常
486
694
  */
487
695
  Result: string;
488
696
  /**
489
- * 业务结果描述。
697
+ * 业务结果描述
490
698
  */
491
699
  Description: string;
492
700
  /**
@@ -495,1879 +703,859 @@ export interface BankCard2EVerificationResponse {
495
703
  RequestId?: string;
496
704
  }
497
705
  /**
498
- * MobileStatus返回参数结构体
706
+ * BankCard4EVerification返回参数结构体
499
707
  */
500
- export interface MobileStatusResponse {
708
+ export interface BankCard4EVerificationResponse {
501
709
  /**
502
- * 认证结果码,收费情况如下。
710
+ * 认证结果码
503
711
  收费结果码:
504
- 0:成功
712
+ '0': '认证通过'
713
+ '-1': '认证未通过'
714
+ '-6': '持卡人信息有误'
715
+ '-7': '未开通无卡支付'
716
+ '-8': '此卡被没收'
717
+ '-9': '无效卡号'
718
+ '-10': '此卡无对应发卡行'
719
+ '-11': '该卡未初始化或睡眠卡'
720
+ '-12': '作弊卡、吞卡'
721
+ '-13': '此卡已挂失'
722
+ '-14': '该卡已过期'
723
+ '-15': '受限制的卡'
724
+ '-16': '密码错误次数超限'
725
+ '-17': '发卡行不支持此交易'
505
726
  不收费结果码:
506
- -1:未查询到结果
507
- -2:手机号格式不正确
508
- -3:验证中心服务繁忙
727
+ '-2': '姓名校验不通过'
728
+ '-3': '身份证号码有误'
729
+ '-4': '银行卡号码有误'
730
+ '-5': '手机号码不合法'
731
+ '-18': '验证中心服务繁忙'
509
732
  */
510
733
  Result: string;
511
734
  /**
512
735
  * 业务结果描述。
513
736
  */
514
737
  Description: string;
515
- /**
516
- * 状态码:
517
- 0:正常
518
- 1:停机
519
- 2:销号
520
- 3:空号
521
- 4:不在网
522
- 99:未知状态
523
- */
524
- StatusCode: number;
525
738
  /**
526
739
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
527
740
  */
528
741
  RequestId?: string;
529
742
  }
530
743
  /**
531
- * Liveness返回参数结构体
744
+ * MobileStatus请求参数结构体
532
745
  */
533
- export interface LivenessResponse {
746
+ export interface MobileStatusRequest {
534
747
  /**
535
- * 验证通过后的视频最佳截图照片,照片为BASE64编码后的值,jpg格式。
536
- 注意:此字段可能返回 null,表示取不到有效值。
748
+ * 手机号码
537
749
  */
538
- BestFrameBase64?: string;
750
+ Mobile: string;
539
751
  /**
540
- * 业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
752
+ * 敏感数据加密信息。对传入信息(手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
541
753
  */
542
- Result?: string;
754
+ Encryption?: Encryption;
755
+ }
756
+ /**
757
+ * IdCardOCRVerification请求参数结构体
758
+ */
759
+ export interface IdCardOCRVerificationRequest {
543
760
  /**
544
- * 业务结果描述。
761
+ * 身份证号
762
+ 姓名和身份证号、ImageBase64、ImageUrl三者必须提供其中之一。若都提供了,则按照姓名和身份证号>ImageBase64>ImageUrl的优先级使用参数。
545
763
  */
546
- Description?: string;
764
+ IdCard?: string;
547
765
  /**
548
- * 最佳最佳截图列表,仅在配置了返回多张最佳截图时有效。
549
- 注意:此字段可能返回 null,表示取不到有效值。
766
+ * 姓名
550
767
  */
551
- BestFrameList?: Array<string>;
768
+ Name?: string;
552
769
  /**
553
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
770
+ * 身份证人像面的 Base64
771
+ 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
772
+ 支持的图片大小:所下载图片经Base64编码后不超过 3M。请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
554
773
  */
555
- RequestId?: string;
774
+ ImageBase64?: string;
775
+ /**
776
+ * 身份证人像面的 Url 地址
777
+ 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
778
+ 支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。
779
+ 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
780
+ 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
781
+ */
782
+ ImageUrl?: string;
783
+ /**
784
+ * 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
785
+ */
786
+ Encryption?: Encryption;
556
787
  }
557
788
  /**
558
- * EncryptedPhoneVerification请求参数结构体
789
+ * GetRealNameAuthToken请求参数结构体
559
790
  */
560
- export interface EncryptedPhoneVerificationRequest {
561
- /**
562
- * 身份证号,加密方式以EncryptionMode为准
563
- */
564
- IdCard: string;
791
+ export interface GetRealNameAuthTokenRequest {
565
792
  /**
566
- * 姓名,加密方式以EncryptionMode为准
793
+ * 姓名
567
794
  */
568
795
  Name: string;
569
796
  /**
570
- * 手机号,加密方式以EncryptionMode为准
797
+ * 身份证号
571
798
  */
572
- Phone: string;
799
+ IDCard: string;
573
800
  /**
574
- * 敏感信息的加密方式,目前支持明文、MD5和SHA256加密传输,参数取值:
575
-
576
- 0:明文,不加密
577
- 1: 使用MD5加密
578
- 2: 使用SHA256
801
+ * 回调地址。实名认证完成后,将会重定向到这个地址通知认证发起方。仅支持http或https协议。
579
802
  */
580
- EncryptionMode: string;
803
+ CallbackURL: string;
581
804
  }
582
805
  /**
583
- * EncryptedPhoneVerification返回参数结构体
806
+ * ParseNfcData返回参数结构体
584
807
  */
585
- export interface EncryptedPhoneVerificationResponse {
808
+ export interface ParseNfcDataResponse {
586
809
  /**
587
- * 认证结果码:
588
- 【收费结果码】
589
- 0: 三要素信息一致
590
- -4: 三要素信息不一致
591
-
592
- 【不收费结果码】
593
- -7: 身份证号码有误
594
- -8: 参数错误
595
- -9: 没有记录
596
- -11: 验证中心服务繁忙
810
+ * 0为首次查询成功,-1为查询失败。
811
+ 注意:此字段可能返回 null,表示取不到有效值。
597
812
  */
598
- Result: string;
813
+ ResultCode: string;
599
814
  /**
600
- * 业务结果描述。
815
+ * 身份证号
816
+ 注意:此字段可能返回 null,表示取不到有效值。
601
817
  */
602
- Description: string;
818
+ IdNum: string;
603
819
  /**
604
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
820
+ * 姓名
821
+ 注意:此字段可能返回 null,表示取不到有效值。
605
822
  */
606
- RequestId?: string;
607
- }
608
- /**
609
- * 核身视频信息
610
- */
611
- export interface DetectInfoVideoData {
823
+ Name: string;
612
824
  /**
613
- * 活体视频的base64编码
825
+ * 照片
614
826
  注意:此字段可能返回 null,表示取不到有效值。
615
827
  */
616
- LivenessVideo: string;
617
- }
618
- /**
619
- * Liveness请求参数结构体
620
- */
621
- export interface LivenessRequest {
828
+ Picture: string;
622
829
  /**
623
- * 用于活体检测的视频,视频的BASE64值;
624
- BASE64编码后的大小不超过8M,支持mp4、avi、flv格式。
830
+ * 出生日期
831
+ 注意:此字段可能返回 null,表示取不到有效值。
625
832
  */
626
- VideoBase64: string;
833
+ BirthDate: string;
627
834
  /**
628
- * 活体检测类型,取值:LIP/ACTION/SILENT。
629
- LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。
835
+ * 有效期起始时间
836
+ 注意:此字段可能返回 null,表示取不到有效值。
630
837
  */
631
- LivenessType: string;
838
+ BeginTime: string;
632
839
  /**
633
- * 数字模式传参:数字验证码(1234),需先调用接口获取数字验证码;
634
- 动作模式传参:传动作顺序(2,1 or 1,2),需先调用接口获取动作顺序;
635
- 静默模式传参:不需要传递此参数。
840
+ * 有效期结束时间
841
+ 注意:此字段可能返回 null,表示取不到有效值。
636
842
  */
637
- ValidateData?: string;
843
+ EndTime: string;
638
844
  /**
639
- * 额外配置,传入JSON字符串。
640
- {
641
- "BestFrameNum": 2 //需要返回多张最佳截图,取值范围1-10
642
- }
845
+ * 住址
846
+ 注意:此字段可能返回 null,表示取不到有效值。
643
847
  */
644
- Optional?: string;
645
- }
646
- /**
647
- * GetSdkVerificationResult返回参数结构体
648
- */
649
- export interface GetSdkVerificationResultResponse {
848
+ Address: string;
650
849
  /**
651
- * 整个核验结果
850
+ * 民族
851
+ 注意:此字段可能返回 null,表示取不到有效值。
652
852
  */
653
- Result: string;
853
+ Nation: string;
654
854
  /**
655
- * 结果描述
855
+ * 性别
856
+ 注意:此字段可能返回 null,表示取不到有效值。
656
857
  */
657
- Description: string;
858
+ Sex: string;
658
859
  /**
659
- * 计费次数
860
+ * 身份证 01 中国护照 03 军官证 04 武警证 05 港澳通行证 06 台胞证 07 外国护照 08 士兵证 09 临时身份证 10 户口本 11 警官证 12 外国人永久居留证 13 港澳台居民居住证 14 回乡证 15 大陆居民来往台湾通行证 16 其他证件 99
861
+ 注意:此字段可能返回 null,表示取不到有效值。
660
862
  */
661
- ChargeCount: number;
863
+ IdType: string;
662
864
  /**
663
- * 多次证照识别的结果(有序),取最终一次结果为有效结果
865
+ * 英文姓名
866
+ 注意:此字段可能返回 null,表示取不到有效值。
664
867
  */
665
- CardVerifyResults: Array<CardVerifyResult>;
868
+ EnName: string;
666
869
  /**
667
- * 多次活体认证的结果信息(有序),取最终一次结果为有效结果
870
+ * 签发机关
871
+ 注意:此字段可能返回 null,表示取不到有效值。
668
872
  */
669
- CompareResults: Array<CompareResult>;
873
+ SigningOrganization: string;
670
874
  /**
671
- * 获取token时传入的
875
+ * 港澳台居民居住证,通行证号码
876
+ 注意:此字段可能返回 null,表示取不到有效值。
672
877
  */
673
- Extra: string;
878
+ OtherIdNum: string;
674
879
  /**
675
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
880
+ * 旅行证件国籍
881
+ 注意:此字段可能返回 null,表示取不到有效值。
676
882
  */
677
- RequestId?: string;
678
- }
679
- /**
680
- * 敏感数据加密
681
- */
682
- export interface Encryption {
883
+ Nationality: string;
683
884
  /**
684
- * 在使用加密服务时,填入要被加密的字段。本接口中可填入加密后的一个或多个字段
885
+ * 旅行证件机读区第二行 29~42 位
886
+ 注意:此字段可能返回 null,表示取不到有效值。
685
887
  */
686
- EncryptList: Array<string>;
888
+ PersonalNumber: string;
687
889
  /**
688
- * 有加密需求的用户,接入传入kms的CiphertextBlob,关于数据加密可查阅<a href="https://cloud.tencent.com/document/product/1007/47180">数据加密</a> 文档。
890
+ * 旅行证件类的核验结果。JSON格式如下:
891
+ {"result_issuer ":"签发者证书合法性验证结果 ","result_pape r":"证件安全对象合法性验证 结果 ","result_data" :"防数据篡改验证结果 ","result_chip" :"防证书件芯片被复制验证结果"}
892
+ 0:验证通过,1: 验证不通过,2: 未验证,3:部分通过,当4项核验结果都为0时,表示证件为真
893
+ 注意:此字段可能返回 null,表示取不到有效值。
689
894
  */
690
- CiphertextBlob: string;
895
+ CheckMRTD: string;
691
896
  /**
692
- * 有加密需求的用户,传入CBC加密的初始向量(客户自定义字符串,长度16字符)。
897
+ * 身份证照片面合成图片
898
+ 注意:此字段可能返回 null,表示取不到有效值。
693
899
  */
694
- Iv: string;
900
+ ImageA: string;
695
901
  /**
696
- * 加密使用的算法(支持'AES-256-CBC'、'SM4-GCM'),不传默认为'AES-256-CBC'
902
+ * 身份证国徽面合成图片
903
+ 注意:此字段可能返回 null,表示取不到有效值。
697
904
  */
698
- Algorithm?: string;
905
+ ImageB: string;
699
906
  /**
700
- * SM4-GCM算法生成的消息摘要(校验消息完整性时使用)
907
+ * 对result code的结果描述
908
+ 注意:此字段可能返回 null,表示取不到有效值。
701
909
  */
702
- TagList?: Array<string>;
910
+ ResultDescription: string;
911
+ /**
912
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
913
+ */
914
+ RequestId?: string;
703
915
  }
704
916
  /**
705
- * DetectReflectLivenessAndCompare请求参数结构体
917
+ * CheckIdNameDate请求参数结构体
706
918
  */
707
- export interface DetectReflectLivenessAndCompareRequest {
919
+ export interface CheckIdNameDateRequest {
920
+ /**
921
+ * 姓名
922
+ */
923
+ Name: string;
708
924
  /**
709
- * SDK生成的活体检测数据包的资源地址。
925
+ * 身份证号
710
926
  */
711
- LiveDataUrl: string;
927
+ IdCard: string;
712
928
  /**
713
- * SDK生成的活体检测数据包的资源内容MD5(32位,用于校验LiveData的一致性)。
929
+ * 身份证有效期开始时间,格式:YYYYMMDD。如:20210701
714
930
  */
715
- LiveDataMd5: string;
931
+ ValidityBegin: string;
716
932
  /**
717
- * 用于比对的目标图片的资源地址。
933
+ * 身份证有效期到期时间,格式:YYYYMMDD,长期用“00000000”代替;如:20210701
718
934
  */
719
- ImageUrl: string;
935
+ ValidityEnd: string;
720
936
  /**
721
- * 用于比对的目标图片的资源MD5(32位,用于校验Image的一致性)。
937
+ * 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
722
938
  */
723
- ImageMd5: string;
939
+ Encryption?: Encryption;
724
940
  }
725
941
  /**
726
- * VideoLivenessCompare请求参数结构体
942
+ * BankCard2EVerification请求参数结构体
727
943
  */
728
- export interface VideoLivenessCompareRequest {
944
+ export interface BankCard2EVerificationRequest {
729
945
  /**
730
- * 用于人脸比对照片的URL地址;图片下载后经Base64编码后的数据大小不超过3M,仅支持jpg、png格式。
731
-
732
- 图片仅支持腾讯云同region的Cos地址,可保障更高的下载速度和稳定性,可使用CreateUploadUrl生成或自行购买Cos。
946
+ * 姓名
733
947
  */
734
- ImageUrl: string;
948
+ Name: string;
735
949
  /**
736
- * 比对图片的32位Md5值。
950
+ * 银行卡
737
951
  */
738
- ImageMd5: string;
952
+ BankCard: string;
739
953
  /**
740
- * 用于活体检测的视频Url 地址。视频下载后经Base64编码后不超过 8M,视频下载耗时不超过4S,支持mp4、avi、flv格式。
741
-
742
- 视频仅支持腾讯云同region的Cos地址,可保障更高的下载速度和稳定性,可使用CreateUploadUrl生成或自行购买Cos。
954
+ * 敏感数据加密信息。对传入信息(姓名、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
955
+ */
956
+ Encryption?: Encryption;
957
+ }
958
+ /**
959
+ * LivenessRecognition请求参数结构体
960
+ */
961
+ export interface LivenessRecognitionRequest {
962
+ /**
963
+ * 身份证号
743
964
  */
744
- VideoUrl: string;
965
+ IdCard: string;
745
966
  /**
746
- * 视频的32位Md5值。
967
+ * 姓名。中文请使用UTF-8编码。
747
968
  */
748
- VideoMd5: string;
969
+ Name: string;
749
970
  /**
750
971
  * 活体检测类型,取值:LIP/ACTION/SILENT。
751
972
  LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。
752
973
  */
753
974
  LivenessType: string;
754
975
  /**
755
- * 数字模式传参:传数字验证码,需自定义四位数字验证码;
756
- 动作模式传参:传动作顺序,需自定义动作顺序(2,1 or 1,2);
976
+ * 用于活体检测的视频,视频的BASE64值;
977
+ BASE64编码后的大小不超过8M,支持mp4、avi、flv格式。
978
+ */
979
+ VideoBase64?: string;
980
+ /**
981
+ * 用于活体检测的视频Url 地址。视频下载后经Base64编码不超过 8M,视频下载耗时不超过4S,支持mp4、avi、flv格式。
982
+
983
+ 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
984
+
985
+ 建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议视频存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
986
+ */
987
+ VideoUrl?: string;
988
+ /**
989
+ * 数字模式传参:传数字验证码,验证码需先调用<a href="https://cloud.tencent.com/document/product/1007/31821">获取数字验证码接口</a>得到;
990
+ 动作模式传参:传动作顺序,动作顺序需先调用<a href="https://cloud.tencent.com/document/product/1007/31822">获取动作顺序接口</a>得到;
757
991
  静默模式传参:空。
758
992
  */
759
993
  ValidateData?: string;
994
+ /**
995
+ * 额外配置,传入JSON字符串。
996
+ {
997
+ "BestFrameNum": 2 //需要返回多张最佳截图,取值范围2-10
760
998
  }
761
- /**
762
- * CheckBankCardInformation返回参数结构体
763
- */
764
- export interface CheckBankCardInformationResponse {
999
+ */
1000
+ Optional?: string;
765
1001
  /**
766
- * 认证结果码,收费情况如下。
767
- 收费结果码:
768
- 0: 查询成功
769
- -1: 未查到信息
770
- 不收费结果码
771
- -2:验证中心服务繁忙
772
- -3:银行卡不存在
1002
+ * 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
773
1003
  */
774
- Result: string;
1004
+ Encryption?: Encryption;
1005
+ }
1006
+ /**
1007
+ * Eid出参,包括商户方用户的标识和加密的用户姓名身份证信息。
1008
+ */
1009
+ export interface EidInfo {
775
1010
  /**
776
- * 业务结果描述
1011
+ * 商户方 appeIDcode 的数字证书
777
1012
  */
778
- Description: string;
1013
+ EidCode: string;
779
1014
  /**
780
- * 开户行
1015
+ * Eid中心针对商户方EidCode的电子签名
781
1016
  */
782
- AccountBank: string;
1017
+ EidSign: string;
783
1018
  /**
784
- * 卡性质:1. 借记卡;2. 贷记卡;3. 预付费卡;4. 准贷记卡
1019
+ * 商户方公钥加密的会话密钥的base64字符串,[指引详见](https://cloud.tencent.com/document/product/1007/63370)
785
1020
  */
786
- AccountType: number;
1021
+ DesKey: string;
787
1022
  /**
788
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1023
+ * 会话密钥sm2加密后的base64字符串,[指引详见](https://cloud.tencent.com/document/product/1007/63370)
789
1024
  */
790
- RequestId?: string;
1025
+ UserInfo: string;
791
1026
  }
792
1027
  /**
793
- * GetWebVerificationResult请求参数结构体
1028
+ * GetFaceIdToken返回参数结构体
794
1029
  */
795
- export interface GetWebVerificationResultRequest {
1030
+ export interface GetFaceIdTokenResponse {
796
1031
  /**
797
- * Web核验令牌,由ApplyWebVerificationToken接口生成。
1032
+ * 有效期 10分钟。只能完成1次核身。
798
1033
  */
799
- BizToken: string;
1034
+ FaceIdToken: string;
1035
+ /**
1036
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1037
+ */
1038
+ RequestId?: string;
800
1039
  }
801
1040
  /**
802
- * GetEidToken请求参数结构体
1041
+ * GetRealNameAuthToken返回参数结构体
803
1042
  */
804
- export interface GetEidTokenRequest {
1043
+ export interface GetRealNameAuthTokenResponse {
805
1044
  /**
806
- * EID商户id,字段长度最长50位。
1045
+ * 查询实名认证结果的唯一凭证
807
1046
  */
808
- MerchantId: string;
1047
+ AuthToken?: string;
809
1048
  /**
810
- * 身份标识(未使用OCR服务时,必须传入)。
811
- 规则:a-zA-Z0-9组合。最长长度32位。
812
- */
813
- IdCard?: string;
814
- /**
815
- * 姓名。(未使用OCR服务时,必须传入)最长长度32位。中文请使用UTF-8编码。
816
- */
817
- Name?: string;
818
- /**
819
- * 透传字段,在获取验证结果时返回。最长长度1024位。
820
- */
821
- Extra?: string;
822
- /**
823
- * 小程序模式配置,包括如何传入姓名身份证的配置,以及是否使用意愿核身。
824
- */
825
- Config?: GetEidTokenConfig;
826
- /**
827
- * 最长长度1024位。用户从Url中进入核身认证结束后重定向的回调链接地址。EidToken会在该链接的query参数中。
1049
+ * 实名认证授权地址,认证发起方需要重定向到这个地址获取认证用户的授权,仅能在微信环境下打开。
828
1050
  */
829
- RedirectUrl?: string;
1051
+ RedirectURL?: string;
830
1052
  /**
831
- * 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1053
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
832
1054
  */
833
- Encryption?: Encryption;
1055
+ RequestId?: string;
834
1056
  }
835
1057
  /**
836
- * ApplySdkVerificationToken请求参数结构体
1058
+ * PhoneVerificationCMCC返回参数结构体
837
1059
  */
838
- export interface ApplySdkVerificationTokenRequest {
839
- /**
840
- * 是否需要身份证鉴伪,如果不需要,则仅做证件OCR。当前仅IdCardType为HK支持鉴伪。
841
- */
842
- NeedVerifyIdCard: boolean;
1060
+ export interface PhoneVerificationCMCCResponse {
843
1061
  /**
844
- * 卡证类型,当前仅支持HK(香港身份证),ML(马来西亚身份证),PhilippinesVoteID(菲律宾选民卡),PhilippinesDrivingLicense(菲律宾驾驶证)。默认为HK。
1062
+ * 认证结果码,收费情况如下。
1063
+ 收费结果码:
1064
+ 0: 认证通过
1065
+ -4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)
1066
+ 不收费结果码:
1067
+ -6: 手机号码不合法
1068
+ -7: 身份证号码有误
1069
+ -8: 姓名校验不通过
1070
+ -9: 没有记录
1071
+ -10: 认证未通过
1072
+ -11: 验证中心服务繁忙
845
1073
  */
846
- IdCardType?: string;
1074
+ Result: string;
847
1075
  /**
848
- * 是否允许用户修改ocr结果,默认false,允许。
1076
+ * 运营商名称。
1077
+ 取值范围为["移动","联通","电信",""]
849
1078
  */
850
- DisableChangeOcrResult?: boolean;
1079
+ Isp: string;
851
1080
  /**
852
- * 是否关闭OCR告警,默认false,不关闭。如果为false开启OCR告警,我们会根据Ocr的告警信息进行拦截,当NeedVerifyIdCard为true时该字段将为true。
1081
+ * 业务结果描述。
853
1082
  */
854
- DisableCheckOcrWarnings?: boolean;
1083
+ Description: string;
855
1084
  /**
856
- * 透传字段,在获取验证结果时返回,最长1024位。
1085
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
857
1086
  */
858
- Extra?: string;
1087
+ RequestId?: string;
859
1088
  }
860
1089
  /**
861
- * 核身过程中,鉴伪或OCR单次结果。
1090
+ * CheckEidTokenStatus返回参数结构体
862
1091
  */
863
- export interface CardVerifyResult {
864
- /**
865
- * 鉴伪或OCR是否成功
866
- */
867
- IsPass: boolean;
868
- /**
869
- * 身份证鉴伪视频,仅开启证件视频鉴伪功能时返回,url链接有效期10分钟。
870
- 注意:此字段可能返回 null,表示取不到有效值。
871
- */
872
- CardVideo: FileInfo;
873
- /**
874
- * 证件照图片,url链接有效期10分钟。
875
- 注意:此字段可能返回 null,表示取不到有效值。
876
- */
877
- CardImage: FileInfo;
1092
+ export interface CheckEidTokenStatusResponse {
878
1093
  /**
879
- * 证件照的文字识别结果,如果鉴伪失败或者ocr失败则该参数为空。url链接有效期10分钟。格式为json文本信息。
880
- IdCardType为HK时:
881
- - CnName string 中文姓名
882
- - EnName string 英文姓名
883
- - TelexCode string 中文姓名对应电码
884
- - Sex string 性别 :“男M”或“女F”
885
- - Birthday string 出生日期
886
- - Permanent int 永久性居民身份证。0:非永久; 1:永久; -1:未知。
887
- - IdNum string 身份证号码
888
- - Symbol string 证件符号,出生日期下的符号,例如"***AZ"
889
- - FirstIssueDate string 首次签发日期
890
- - CurrentIssueDate string 最近领用日期
891
-
892
- IdCardType为ML时:
893
- - Sex string 男:LELAKI 女:PEREMPUAN
894
- - Birthday string 生日
895
- - ID string 证号
896
- - Name string 名字
897
- - Address string 地址
898
- - Type string 证件类型
899
-
900
- IdCardType为PhilippinesVoteID时:
901
- - Birthday string 生日
902
- - Address string 地址
903
- - LastName string 姓氏
904
- - FirstName string 姓名
905
- - VIN string VIN号
906
- - CivilStatus string 婚姻状况
907
- - Citizenship string 国籍
908
- - PrecinctNo string 地区
909
-
910
- IdCardType为PhilippinesDrivingLicense时:
911
- - Sex string 性别
912
- - Birthday string 生日
913
- - Name string 姓名
914
- - Address string 地址
915
- - LastName string 姓氏
916
- - FirstName string 首姓名
917
- - MiddleName string 中间姓名
918
- - Nationality string 国籍
919
- - LicenseNo string 证号
920
- - ExpiresDate string 有效期
921
- - AgencyCode string 机构代码
922
- 注意:此字段可能返回 null,表示取不到有效值。
1094
+ * 枚举:
1095
+ init:token未验证
1096
+ doing: 验证中
1097
+ finished: 验证完成
1098
+ timeout: token已超时
923
1099
  */
924
- CardInfoOcrJson: FileInfo;
1100
+ Status: string;
925
1101
  /**
926
- * 单次流程请求标示。
1102
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
927
1103
  */
928
- RequestId: string;
1104
+ RequestId?: string;
929
1105
  }
930
1106
  /**
931
- * CheckIdNameDate请求参数结构体
1107
+ * PhoneVerificationCTCC返回参数结构体
932
1108
  */
933
- export interface CheckIdNameDateRequest {
934
- /**
935
- * 姓名
936
- */
937
- Name: string;
938
- /**
939
- * 身份证号
940
- */
941
- IdCard: string;
942
- /**
943
- * 身份证有效期开始时间,格式:YYYYMMDD。如:20210701
944
- */
945
- ValidityBegin: string;
1109
+ export interface PhoneVerificationCTCCResponse {
946
1110
  /**
947
- * 身份证有效期到期时间,格式:YYYYMMDD,长期用“00000000”代替;如:20210701
1111
+ * 认证结果码,收费情况如下。
1112
+ 收费结果码:
1113
+ 0: 认证通过
1114
+ -4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)
1115
+ 不收费结果码:
1116
+ -6: 手机号码不合法
1117
+ -7: 身份证号码有误
1118
+ -8: 姓名校验不通过
1119
+ -9: 没有记录
1120
+ -10: 认证未通过
1121
+ -11: 验证中心服务繁忙
948
1122
  */
949
- ValidityEnd: string;
1123
+ Result: string;
950
1124
  /**
951
- * 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1125
+ * 运营商名称。
1126
+ 取值范围为["移动","联通","电信",""]
952
1127
  */
953
- Encryption?: Encryption;
954
- }
955
- /**
956
- * GetFaceIdToken返回参数结构体
957
- */
958
- export interface GetFaceIdTokenResponse {
1128
+ Isp: string;
959
1129
  /**
960
- * 有效期 10分钟。只能完成1次核身。
1130
+ * 业务结果描述。
961
1131
  */
962
- FaceIdToken: string;
1132
+ Description: string;
963
1133
  /**
964
1134
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
965
1135
  */
966
1136
  RequestId?: string;
967
1137
  }
968
1138
  /**
969
- * ApplyLivenessToken返回参数结构体
1139
+ * MobileStatus返回参数结构体
970
1140
  */
971
- export interface ApplyLivenessTokenResponse {
1141
+ export interface MobileStatusResponse {
972
1142
  /**
973
- * 标识一次SDK核验流程的令牌,有效时间为10分钟。流程结束后可用该令牌获取核验结果信息。
1143
+ * 认证结果码,收费情况如下。
1144
+ 收费结果码:
1145
+ 0:成功
1146
+ 不收费结果码:
1147
+ -1:未查询到结果
1148
+ -2:手机号格式不正确
1149
+ -3:验证中心服务繁忙
974
1150
  */
975
- SdkToken: string;
1151
+ Result: string;
976
1152
  /**
977
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1153
+ * 业务结果描述。
978
1154
  */
979
- RequestId?: string;
980
- }
981
- /**
982
- * ApplySdkVerificationToken返回参数结构体
983
- */
984
- export interface ApplySdkVerificationTokenResponse {
1155
+ Description: string;
985
1156
  /**
986
- * 标识一次SDK核验流程的令牌,有效时间为7,200秒。流程结束后可用该令牌获取核验结果信息。
1157
+ * 状态码:
1158
+ 0:正常
1159
+ 1:停机
1160
+ 2:销号
1161
+ 3:空号
1162
+ 4:不在网
1163
+ 99:未知状态
987
1164
  */
988
- SdkToken: string;
1165
+ StatusCode: number;
989
1166
  /**
990
1167
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
991
1168
  */
992
1169
  RequestId?: string;
993
1170
  }
994
1171
  /**
995
- * MinorsVerification请求参数结构体
1172
+ * PhoneVerificationCTCC请求参数结构体
996
1173
  */
997
- export interface MinorsVerificationRequest {
998
- /**
999
- * 参与校验的参数类型。
1000
- 0:使用手机号进行校验;
1001
- 1:使用姓名与身份证号进行校验。
1002
- */
1003
- Type: string;
1174
+ export interface PhoneVerificationCTCCRequest {
1004
1175
  /**
1005
- * 手机号,11位数字,
1006
- 特别提示:
1007
- 手机号验证只限制在腾讯健康守护可信模型覆盖的数据范围内,与手机号本身在运营商是否实名无关联,不在范围会提示“手机号未实名”,建议客户与传入姓名和身份证号信息组合使用。
1176
+ * 身份证号
1008
1177
  */
1009
- Mobile?: string;
1178
+ IdCard: string;
1010
1179
  /**
1011
- * 身份证号码。
1180
+ * 姓名
1012
1181
  */
1013
- IdCard?: string;
1182
+ Name: string;
1014
1183
  /**
1015
- * 姓名。
1184
+ * 手机号
1016
1185
  */
1017
- Name?: string;
1186
+ Phone: string;
1018
1187
  /**
1019
1188
  * 敏感数据加密信息。对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1020
1189
  */
1021
1190
  Encryption?: Encryption;
1022
1191
  }
1023
1192
  /**
1024
- * GetFaceIdResult返回参数结构体
1193
+ * IdCardOCRVerification返回参数结构体
1025
1194
  */
1026
- export interface GetFaceIdResultResponse {
1027
- /**
1028
- * 身份证
1029
- */
1030
- IdCard: string;
1031
- /**
1032
- * 姓名
1033
- */
1034
- Name: string;
1195
+ export interface IdCardOCRVerificationResponse {
1035
1196
  /**
1036
- * 业务核验结果,参考https://cloud.tencent.com/document/product/1007/47912
1197
+ * 认证结果码,收费情况如下。
1198
+ 收费结果码:
1199
+ 0: 姓名和身份证号一致
1200
+ -1: 姓名和身份证号不一致
1201
+ 不收费结果码:
1202
+ -2: 非法身份证号(长度、校验位等不正确)
1203
+ -3: 非法姓名(长度、格式等不正确)
1204
+ -4: 证件库服务异常
1205
+ -5: 证件库中无此身份证记录
1206
+ -6: 权威比对系统升级中,请稍后再试
1207
+ -7: 认证次数超过当日限制
1037
1208
  */
1038
1209
  Result: string;
1039
1210
  /**
1040
- * 业务核验描述
1211
+ * 业务结果描述。
1041
1212
  */
1042
1213
  Description: string;
1043
1214
  /**
1044
- * 相似度,0-100,数值越大相似度越高
1215
+ * 用于验证的姓名
1045
1216
  */
1046
- Similarity: number;
1217
+ Name: string;
1047
1218
  /**
1048
- * 用户核验的视频base64,如果选择了使用cos,返回完整cos地址如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey
1049
- 注意:此字段可能返回 null,表示取不到有效值。
1219
+ * 用于验证的身份证号
1050
1220
  */
1051
- VideoBase64: string;
1221
+ IdCard: string;
1052
1222
  /**
1053
- * 用户核验视频的截帧base64,如果选择了使用cos,返回完整cos地址如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey
1223
+ * OCR得到的性别
1054
1224
  注意:此字段可能返回 null,表示取不到有效值。
1055
1225
  */
1056
- BestFrameBase64: string;
1226
+ Sex: string;
1057
1227
  /**
1058
- * 获取token时透传的信息
1228
+ * OCR得到的民族
1059
1229
  注意:此字段可能返回 null,表示取不到有效值。
1060
1230
  */
1061
- Extra: string;
1231
+ Nation: string;
1062
1232
  /**
1063
- * 设备风险标签,仅错误码返回1007(设备疑似被劫持)时返回风险标签。标签说明:
1064
- 202、5001:设备疑似被Root
1065
- 203、5004:设备疑似被注入
1066
- 205:设备疑似被Hook
1067
- 206:设备疑似虚拟运行环境
1068
- 5007、1005:设备疑似摄像头被劫持
1069
- 8000:设备疑似存在异常篡改行为
1233
+ * OCR得到的生日
1070
1234
  注意:此字段可能返回 null,表示取不到有效值。
1071
1235
  */
1072
- DeviceInfoTag: string;
1236
+ Birth: string;
1073
1237
  /**
1074
- * 行为风险标签,仅错误码返回1007(设备疑似被劫持)时返回风险标签。标签说明:
1075
- 02:攻击风险
1238
+ * OCR得到的地址
1076
1239
  注意:此字段可能返回 null,表示取不到有效值。
1077
1240
  */
1078
- RiskInfoTag: string;
1241
+ Address: string;
1079
1242
  /**
1080
1243
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1081
1244
  */
1082
1245
  RequestId?: string;
1083
1246
  }
1084
1247
  /**
1085
- * 意愿核身相关结果
1248
+ * 计费详情
1086
1249
  */
1087
- export interface IntentionVerifyData {
1250
+ export interface ChargeDetail {
1088
1251
  /**
1089
- * 意愿确认环节中录制的视频(base64)。若不存在则为空字符串。
1090
- 注意:此字段可能返回 null,表示取不到有效值。
1252
+ * 一比一时间时间戳,13位。
1091
1253
  */
1092
- IntentionVerifyVideo: string;
1254
+ ReqTime: string;
1093
1255
  /**
1094
- * 意愿确认环节中用户语音转文字的识别结果。若不存在则为空字符串。
1095
- 注意:此字段可能返回 null,表示取不到有效值。
1256
+ * 一比一请求的唯一标记。
1096
1257
  */
1097
- AsrResult: string;
1258
+ Seq: string;
1098
1259
  /**
1099
- * 意愿确认环节的结果码。当该结果码为0时,语音朗读的视频与语音识别结果才会返回。
1100
- 注意:此字段可能返回 null,表示取不到有效值。
1260
+ * 一比一时使用的、脱敏后的身份证号。
1101
1261
  */
1102
- ErrorCode: number;
1262
+ Idcard: string;
1103
1263
  /**
1104
- * 意愿确认环节的结果信息。
1105
- 注意:此字段可能返回 null,表示取不到有效值。
1264
+ * 一比一时使用的、脱敏后的姓名。
1106
1265
  */
1107
- ErrorMessage: string;
1266
+ Name: string;
1108
1267
  /**
1109
- * 意愿确认环节中录制视频的最佳帧(base64)。若不存在则为空字符串。
1110
- 注意:此字段可能返回 null,表示取不到有效值。
1268
+ * 一比一的相似度。0-100,保留2位小数。
1111
1269
  */
1112
- IntentionVerifyBestFrame: string;
1270
+ Sim: string;
1113
1271
  /**
1114
- * 本次流程用户语音与传入文本比对的相似度分值,取值范围 [0.00, 100.00]。只有配置了相似度阈值后才进行语音校验并返回相似度分值。
1115
- 注意:此字段可能返回 null,表示取不到有效值。
1272
+ * 本次详情是否收费。
1116
1273
  */
1117
- AsrResultSimilarity: string;
1118
- }
1119
- /**
1120
- * LivenessCompare请求参数结构体
1121
- */
1122
- export interface LivenessCompareRequest {
1123
- /**
1124
- * 活体检测类型,取值:LIP/ACTION/SILENT。
1125
- LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。
1126
- */
1127
- LivenessType: string;
1274
+ IsNeedCharge: boolean;
1128
1275
  /**
1129
- * 用于人脸比对的照片的Base64值;
1130
- Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。
1131
- 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
1132
-
1133
- 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageBase64。
1276
+ * 收费类型,比对、核身、混合部署。
1134
1277
  */
1135
- ImageBase64?: string;
1278
+ ChargeType: string;
1136
1279
  /**
1137
- * 用于人脸比对照片的URL地址;图片下载后经Base64编码后的数据大小不超过3M,仅支持jpg、png格式。
1138
-
1139
- 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageBase64。
1140
-
1141
- 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
1280
+ * 本次活体一比一最终结果。
1142
1281
  */
1143
- ImageUrl?: string;
1282
+ ErrorCode: string;
1144
1283
  /**
1145
- * 数字模式传参:传数字验证码,验证码需先调用<a href="https://cloud.tencent.com/document/product/1007/31821">获取数字验证码接口</a>得到;
1146
- 动作模式传参:传动作顺序,动作顺序需先调用<a href="https://cloud.tencent.com/document/product/1007/31822">获取动作顺序接口</a>得到;
1147
- 静默模式传参:空。
1284
+ * 本次活体一比一最终结果描述。
1148
1285
  */
1149
- ValidateData?: string;
1150
- /**
1151
- * 额外配置,传入JSON字符串。
1152
- {
1153
- "BestFrameNum": 2 //需要返回多张最佳截图,取值范围2-10
1286
+ ErrorMessage: string;
1154
1287
  }
1155
- */
1156
- Optional?: string;
1157
- /**
1158
- * 用于活体检测的视频,视频的Base64值;
1159
- Base64编码后的大小不超过8M,支持mp4、avi、flv格式。
1160
- 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
1161
-
1162
- 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
1163
- */
1164
- VideoBase64?: string;
1288
+ /**
1289
+ * ParseNfcData请求参数结构体
1290
+ */
1291
+ export interface ParseNfcDataRequest {
1165
1292
  /**
1166
- * 用于活体检测的视频Url 地址。视频下载后经Base64编码后不超过 8M,视频下载耗时不超过4S,支持mp4、avi、flv格式。
1167
-
1168
- 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
1169
-
1170
- 建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议视频存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
1293
+ * 前端SDK返回
1171
1294
  */
1172
- VideoUrl?: string;
1295
+ ReqId: string;
1173
1296
  }
1174
1297
  /**
1175
- * 活体一比一详情
1298
+ * Liveness返回参数结构体
1176
1299
  */
1177
- export interface DetectDetail {
1178
- /**
1179
- * 请求时间戳。
1180
- 注意:此字段可能返回 null,表示取不到有效值。
1181
- */
1182
- ReqTime: string;
1183
- /**
1184
- * 本次活体一比一请求的唯一标记。
1185
- 注意:此字段可能返回 null,表示取不到有效值。
1186
- */
1187
- Seq: string;
1188
- /**
1189
- * 参与本次活体一比一的身份证号。
1190
- 注意:此字段可能返回 null,表示取不到有效值。
1191
- */
1192
- Idcard: string;
1193
- /**
1194
- * 参与本次活体一比一的姓名。
1195
- 注意:此字段可能返回 null,表示取不到有效值。
1196
- */
1197
- Name: string;
1198
- /**
1199
- * 本次活体一比一的相似度。
1200
- 注意:此字段可能返回 null,表示取不到有效值。
1201
- */
1202
- Sim: string;
1203
- /**
1204
- * 本次活体一比一是否收费
1205
- 注意:此字段可能返回 null,表示取不到有效值。
1206
- */
1207
- IsNeedCharge: boolean;
1208
- /**
1209
- * 本次活体一比一最终结果。0为成功
1210
- 注意:此字段可能返回 null,表示取不到有效值。
1211
- */
1212
- Errcode: number;
1213
- /**
1214
- * 本次活体一比一最终结果描述。(仅描述用,文案更新时不会通知。)
1215
- 注意:此字段可能返回 null,表示取不到有效值。
1216
- */
1217
- Errmsg: string;
1218
- /**
1219
- * 本次活体结果。0为成功
1220
- 注意:此字段可能返回 null,表示取不到有效值。
1221
- */
1222
- Livestatus: number;
1223
- /**
1224
- * 本次活体结果描述。(仅描述用,文案更新时不会通知。)
1225
- 注意:此字段可能返回 null,表示取不到有效值。
1226
- */
1227
- Livemsg: string;
1300
+ export interface LivenessResponse {
1228
1301
  /**
1229
- * 本次一比一结果。0为成功
1302
+ * 验证通过后的视频最佳截图照片,照片为BASE64编码后的值,jpg格式。
1230
1303
  注意:此字段可能返回 null,表示取不到有效值。
1231
1304
  */
1232
- Comparestatus: number;
1305
+ BestFrameBase64?: string;
1233
1306
  /**
1234
- * 本次一比一结果描述。(仅描述用,文案更新时不会通知。)
1235
- 注意:此字段可能返回 null,表示取不到有效值。
1307
+ * 业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
1236
1308
  */
1237
- Comparemsg: string;
1309
+ Result?: string;
1238
1310
  /**
1239
- * 比对库源类型。包括:
1240
- 公安商业库;
1241
- 业务方自有库(用户上传照片、客户的混合库、混合部署库);
1242
- 二次验证库;
1243
- 人工审核库;
1244
- 注意:此字段可能返回 null,表示取不到有效值。
1311
+ * 业务结果描述。
1245
1312
  */
1246
- CompareLibType: string;
1313
+ Description?: string;
1247
1314
  /**
1248
- * 枚举活体检测类型:
1249
- 0:未知
1250
- 1:数字活体
1251
- 2:动作活体
1252
- 3:静默活体
1253
- 4:一闪活体(动作+光线)
1315
+ * 最佳最佳截图列表,仅在配置了返回多张最佳截图时有效。
1254
1316
  注意:此字段可能返回 null,表示取不到有效值。
1255
1317
  */
1256
- LivenessMode: number;
1257
- }
1258
- /**
1259
- * GetRealNameAuthResult返回参数结构体
1260
- */
1261
- export interface GetRealNameAuthResultResponse {
1262
- /**
1263
- * 认证结果码,收费情况如下:
1264
-
1265
- 收费码:
1266
- 0: 姓名和身份证号一致
1267
- -1: 姓名和身份证号不一致
1268
- -2: 姓名和微信实名姓名不一致
1269
-
1270
- 不收费码:
1271
- -3: 微信号未实名
1272
- */
1273
- ResultType?: string;
1318
+ BestFrameList?: Array<string>;
1274
1319
  /**
1275
1320
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1276
1321
  */
1277
1322
  RequestId?: string;
1278
1323
  }
1279
1324
  /**
1280
- * CheckBankCardInformation请求参数结构体
1281
- */
1282
- export interface CheckBankCardInformationRequest {
1283
- /**
1284
- * 银行卡号。
1285
- */
1286
- BankCard: string;
1287
- /**
1288
- * 敏感数据加密信息。对传入信息(银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1289
- */
1290
- Encryption?: Encryption;
1291
- }
1292
- /**
1293
- * BankCardVerification请求参数结构体
1325
+ * CheckIdCardInformation请求参数结构体
1294
1326
  */
1295
- export interface BankCardVerificationRequest {
1296
- /**
1297
- * 开户证件号,与CertType参数的证件类型一致,如:身份证,则传入身份证号。
1298
- */
1299
- IdCard: string;
1327
+ export interface CheckIdCardInformationRequest {
1300
1328
  /**
1301
- * 姓名
1329
+ * 身份证人像面的 Base64 值
1330
+ 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
1331
+ 支持的图片大小:所下载图片经Base64编码后不超过 7M。
1332
+ 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
1333
+ ImageBase64、ImageUrl二者必须提供其中之一。若都提供了,则按照ImageUrl>ImageBase64的优先级使用参数。
1302
1334
  */
1303
- Name: string;
1335
+ ImageBase64?: string;
1304
1336
  /**
1305
- * 银行卡
1337
+ * 身份证人像面的 Url 地址
1338
+ 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
1339
+ 支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。
1340
+ 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
1341
+ 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
1306
1342
  */
1307
- BankCard: string;
1343
+ ImageUrl?: string;
1308
1344
  /**
1309
- * 证件类型,请确认该证件为开户时使用的证件类型,未用于开户的证件信息不支持验证。
1310
- 目前默认:0 身份证,其他证件类型需求可以添加[腾讯云人脸核身小助手](https://cloud.tencent.com/document/product/1007/56130)进行确认。
1345
+ * 以下可选字段均为bool 类型,默认false:
1346
+ CopyWarn,复印件告警
1347
+ BorderCheckWarn,边框和框内遮挡告警
1348
+ ReshootWarn,翻拍告警
1349
+ DetectPsWarn,PS检测告警
1350
+ TempIdWarn,临时身份证告警
1351
+ Quality,图片质量告警(评价图片模糊程度)
1352
+
1353
+ SDK 设置方式参考:
1354
+ Config = Json.stringify({"CopyWarn":true,"ReshootWarn":true})
1355
+ API 3.0 Explorer 设置方式参考:
1356
+ Config = {"CopyWarn":true,"ReshootWarn":true}
1311
1357
  */
1312
- CertType?: number;
1358
+ Config?: string;
1313
1359
  /**
1314
- * 敏感数据加密信息。对传入信息(姓名、身份证号、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1360
+ * 是否需要对返回中的敏感信息进行加密。默认false。
1361
+ 其中敏感信息包括:Response.IdNum、Response.Name
1315
1362
  */
1316
- Encryption?: Encryption;
1363
+ IsEncrypt?: boolean;
1317
1364
  }
1318
1365
  /**
1319
- * 核身最佳帧信息
1366
+ * 核身文本信息
1320
1367
  */
1321
- export interface DetectInfoBestFrame {
1368
+ export interface DetectInfoText {
1322
1369
  /**
1323
- * 活体比对最佳帧Base64编码。
1370
+ * 本次流程最终验证结果。0为成功
1324
1371
  注意:此字段可能返回 null,表示取不到有效值。
1325
1372
  */
1326
- BestFrame: string;
1373
+ ErrCode: number;
1327
1374
  /**
1328
- * 自截帧Base64编码数组。
1375
+ * 本次流程最终验证结果描述。(仅描述用,文案更新时不会通知。)
1329
1376
  注意:此字段可能返回 null,表示取不到有效值。
1330
1377
  */
1331
- BestFrames: Array<string>;
1332
- }
1333
- /**
1334
- * GetWeChatBillDetails返回参数结构体
1335
- */
1336
- export interface GetWeChatBillDetailsResponse {
1337
- /**
1338
- * 是否还有下一页。该字段为true时,需要将NextCursor的值作为入参Cursor继续调用本接口。
1339
- */
1340
- HasNextPage: boolean;
1341
- /**
1342
- * 下一页的游标。用于分页。
1343
- */
1344
- NextCursor: number;
1345
- /**
1346
- * 数据
1347
- */
1348
- WeChatBillDetails: Array<WeChatBillDetail>;
1378
+ ErrMsg: string;
1349
1379
  /**
1350
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1380
+ * 本次验证使用的身份证号。
1381
+ 注意:此字段可能返回 null,表示取不到有效值。
1351
1382
  */
1352
- RequestId?: string;
1353
- }
1354
- /**
1355
- * CheckIdCardInformation返回参数结构体
1356
- */
1357
- export interface CheckIdCardInformationResponse {
1358
- /**
1359
- * 相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
1360
- */
1361
- Sim: number;
1362
- /**
1363
- * 业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
1364
- */
1365
- Result: string;
1366
- /**
1367
- * 业务结果描述。
1368
- */
1369
- Description: string;
1370
- /**
1371
- * 姓名
1372
- */
1373
- Name: string;
1374
- /**
1375
- * 性别
1376
- */
1377
- Sex: string;
1378
- /**
1379
- * 民族
1380
- */
1381
- Nation: string;
1382
- /**
1383
- * 出生日期
1384
- */
1385
- Birth: string;
1386
- /**
1387
- * 地址
1388
- */
1389
- Address: string;
1390
- /**
1391
- * 身份证号
1392
- */
1393
- IdNum: string;
1394
- /**
1395
- * 身份证头像照片的base64编码,如果抠图失败会拿整张身份证做比对并返回空。
1396
- */
1397
- Portrait: string;
1398
- /**
1399
- * 告警信息,当在Config中配置了告警信息会停止人像比对,Result返回错误(FailedOperation.OcrWarningOccurred)并有此告警信息,Code 告警码列表和释义:
1400
-
1401
- -9101 身份证边框不完整告警,
1402
- -9102 身份证复印件告警,
1403
- -9103 身份证翻拍告警,
1404
- -9105 身份证框内遮挡告警,
1405
- -9104 临时身份证告警,
1406
- -9106 身份证 PS 告警。
1407
- -8001 图片模糊告警
1408
- 多个会 | 隔开如 "-9101|-9106|-9104"
1409
- */
1410
- Warnings: string;
1411
- /**
1412
- * 图片质量分数,当请求Config中配置图片模糊告警该参数才有意义,取值范围(0~100),目前默认阈值是50分,低于50分会触发模糊告警。
1413
- */
1414
- Quality: number;
1415
- /**
1416
- * 敏感数据加密信息。
1417
- 注意:此字段可能返回 null,表示取不到有效值。
1418
- */
1419
- Encryption: Encryption;
1420
- /**
1421
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1422
- */
1423
- RequestId?: string;
1424
- }
1425
- /**
1426
- * GetEidResult请求参数结构体
1427
- */
1428
- export interface GetEidResultRequest {
1429
- /**
1430
- * E证通流程的唯一标识,调用GetEidToken接口时生成。
1431
- */
1432
- EidToken: string;
1433
- /**
1434
- * 指定拉取的结果信息,取值(0:全部;1:文本类;2:身份证信息;3:最佳截图信息;5:意愿核身朗读模式相关结果;6:意愿核身问答模式相关结果)。
1435
- 如 13表示拉取文本类、最佳截图信息。
1436
- 默认值:0
1437
- */
1438
- InfoType?: string;
1439
- /**
1440
- * 从活体视频中截取一定张数的最佳帧。默认为0,最大为3,超出3的最多只给3张。(InfoType需要包含3)
1441
- */
1442
- BestFramesCount?: number;
1443
- }
1444
- /**
1445
- * DetectAuth返回参数结构体
1446
- */
1447
- export interface DetectAuthResponse {
1448
- /**
1449
- * 用于发起核身流程的URL,仅微信H5场景使用。
1450
- */
1451
- Url: string;
1452
- /**
1453
- * 一次核身流程的标识,有效时间为7,200秒;
1454
- 完成核身后,可用该标识获取验证结果信息。
1455
- */
1456
- BizToken: string;
1457
- /**
1458
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1459
- */
1460
- RequestId?: string;
1461
- }
1462
- /**
1463
- * PhoneVerification返回参数结构体
1464
- */
1465
- export interface PhoneVerificationResponse {
1466
- /**
1467
- * 认证结果码:
1468
- 收费结果码
1469
- 0: 三要素信息一致
1470
- -4: 三要素信息不一致
1471
- 不收费结果码
1472
- -6: 手机号码不合法
1473
- -7: 身份证号码有误
1474
- -8: 姓名校验不通过
1475
- -9: 没有记录
1476
- -11: 验证中心服务繁忙
1477
- */
1478
- Result: string;
1479
- /**
1480
- * 业务结果描述。
1481
- */
1482
- Description: string;
1483
- /**
1484
- * 运营商名称。
1485
- 取值范围为["","移动","电信","联通"]
1486
- */
1487
- Isp: string;
1488
- /**
1489
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1490
- */
1491
- RequestId?: string;
1492
- }
1493
- /**
1494
- * IdCardOCRVerification请求参数结构体
1495
- */
1496
- export interface IdCardOCRVerificationRequest {
1497
- /**
1498
- * 身份证号
1499
- 姓名和身份证号、ImageBase64、ImageUrl三者必须提供其中之一。若都提供了,则按照姓名和身份证号>ImageBase64>ImageUrl的优先级使用参数。
1500
- */
1501
- IdCard?: string;
1502
- /**
1503
- * 姓名
1504
- */
1505
- Name?: string;
1506
- /**
1507
- * 身份证人像面的 Base64 值
1508
- 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
1509
- 支持的图片大小:所下载图片经Base64编码后不超过 3M。请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
1510
- */
1511
- ImageBase64?: string;
1512
- /**
1513
- * 身份证人像面的 Url 地址
1514
- 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
1515
- 支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。
1516
- 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
1517
- 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
1518
- */
1519
- ImageUrl?: string;
1520
- /**
1521
- * 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1522
- */
1523
- Encryption?: Encryption;
1524
- }
1525
- /**
1526
- * BankCard4EVerification返回参数结构体
1527
- */
1528
- export interface BankCard4EVerificationResponse {
1529
- /**
1530
- * 认证结果码
1531
- 收费结果码:
1532
- '0': '认证通过'
1533
- '-1': '认证未通过'
1534
- '-6': '持卡人信息有误'
1535
- '-7': '未开通无卡支付'
1536
- '-8': '此卡被没收'
1537
- '-9': '无效卡号'
1538
- '-10': '此卡无对应发卡行'
1539
- '-11': '该卡未初始化或睡眠卡'
1540
- '-12': '作弊卡、吞卡'
1541
- '-13': '此卡已挂失'
1542
- '-14': '该卡已过期'
1543
- '-15': '受限制的卡'
1544
- '-16': '密码错误次数超限'
1545
- '-17': '发卡行不支持此交易'
1546
- 不收费结果码:
1547
- '-2': '姓名校验不通过'
1548
- '-3': '身份证号码有误'
1549
- '-4': '银行卡号码有误'
1550
- '-5': '手机号码不合法'
1551
- '-18': '验证中心服务繁忙'
1552
- */
1553
- Result: string;
1554
- /**
1555
- * 业务结果描述。
1556
- */
1557
- Description: string;
1558
- /**
1559
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1560
- */
1561
- RequestId?: string;
1562
- }
1563
- /**
1564
- * GenerateReflectSequence请求参数结构体
1565
- */
1566
- export interface GenerateReflectSequenceRequest {
1567
- /**
1568
- * SDK生成的打包数据的资源链接。
1569
- */
1570
- DeviceDataUrl: string;
1571
- /**
1572
- * SDK生成的打包数据的MD5值。
1573
- */
1574
- DeviceDataMd5: string;
1575
- /**
1576
- * 1-静默
1577
- 2-眨眼
1578
- 3-光线
1579
- 4-眨眼+光线 (默认)
1580
- */
1581
- SecurityLevel?: string;
1582
- }
1583
- /**
1584
- * GetRealNameAuthToken请求参数结构体
1585
- */
1586
- export interface GetRealNameAuthTokenRequest {
1587
- /**
1588
- * 姓名
1589
- */
1590
- Name: string;
1591
- /**
1592
- * 身份证号
1593
- */
1594
- IDCard: string;
1595
- /**
1596
- * 回调地址。实名认证完成后,将会重定向到这个地址通知认证发起方。仅支持http或https协议。
1597
- */
1598
- CallbackURL: string;
1599
- }
1600
- /**
1601
- * MobileNetworkTimeVerification请求参数结构体
1602
- */
1603
- export interface MobileNetworkTimeVerificationRequest {
1604
- /**
1605
- * 手机号码
1606
- */
1607
- Mobile: string;
1608
- /**
1609
- * 敏感数据加密信息。对传入信息(手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1610
- */
1611
- Encryption?: Encryption;
1612
- }
1613
- /**
1614
- * PhoneVerificationCMCC返回参数结构体
1615
- */
1616
- export interface PhoneVerificationCMCCResponse {
1617
- /**
1618
- * 认证结果码,收费情况如下。
1619
- 收费结果码:
1620
- 0: 认证通过
1621
- -4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)
1622
- 不收费结果码:
1623
- -6: 手机号码不合法
1624
- -7: 身份证号码有误
1625
- -8: 姓名校验不通过
1626
- -9: 没有记录
1627
- -10: 认证未通过
1628
- -11: 验证中心服务繁忙
1629
- */
1630
- Result: string;
1631
- /**
1632
- * 运营商名称。
1633
- 取值范围为["移动","联通","电信",""]
1634
- */
1635
- Isp: string;
1636
- /**
1637
- * 业务结果描述。
1638
- */
1639
- Description: string;
1640
- /**
1641
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1642
- */
1643
- RequestId?: string;
1644
- }
1645
- /**
1646
- * MobileNetworkTimeVerification返回参数结构体
1647
- */
1648
- export interface MobileNetworkTimeVerificationResponse {
1649
- /**
1650
- * 认证结果码,收费情况如下。
1651
- 收费结果码:
1652
- 0: 成功
1653
- -2: 手机号不存在
1654
- -3: 手机号存在,但无法查询到在网时长
1655
- 不收费结果码:
1656
- -1: 手机号格式不正确
1657
- -4: 验证中心服务繁忙
1658
- */
1659
- Result: string;
1660
- /**
1661
- * 业务结果描述。
1662
- */
1663
- Description: string;
1664
- /**
1665
- * 在网时长区间。
1666
- 格式为(a,b],表示在网时长在a个月以上,b个月以下。若b为+时表示没有上限。
1667
- */
1668
- Range: string;
1669
- /**
1670
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1671
- */
1672
- RequestId?: string;
1673
- }
1674
- /**
1675
- * ApplyWebVerificationToken请求参数结构体
1676
- */
1677
- export interface ApplyWebVerificationTokenRequest {
1678
- /**
1679
- * 核验结束后重定向的Web回跳地址。
1680
- */
1681
- RedirectUrl: string;
1682
- /**
1683
- * 人脸比对照片的腾讯云对象存储地址,可以使用以下两种方式:
1684
- 1. 调用CreateUploadUrl接口生成,确保成功上传照片后再调用此接口。
1685
- 2. 使用已有的腾讯云对象存储地址,如果是私有读写桶,请使用预签名URL授予下载权限,对象存储地域需要和入参Region保持一致。
1686
- */
1687
- CompareImageUrl: string;
1688
- /**
1689
- * 人脸比对照片(CompareImageUrl)内容的MD5散列值。
1690
- */
1691
- CompareImageMd5: string;
1692
- }
1693
- /**
1694
- * PhoneVerificationCUCC返回参数结构体
1695
- */
1696
- export interface PhoneVerificationCUCCResponse {
1697
- /**
1698
- * 认证结果码,收费情况如下。
1699
- 收费结果码:
1700
- 0: 认证通过
1701
- -4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)
1702
- 不收费结果码:
1703
- -6: 手机号码不合法
1704
- -7: 身份证号码有误
1705
- -8: 姓名校验不通过
1706
- -9: 没有记录
1707
- -10: 认证未通过
1708
- -11: 验证中心服务繁忙
1709
- */
1710
- Result: string;
1711
- /**
1712
- * 运营商名称。
1713
- 取值范围为["移动","联通","电信",""]
1714
- */
1715
- Isp: string;
1716
- /**
1717
- * 业务结果描述。
1718
- */
1719
- Description: string;
1720
- /**
1721
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1722
- */
1723
- RequestId?: string;
1724
- }
1725
- /**
1726
- * CheckIdCardInformation请求参数结构体
1727
- */
1728
- export interface CheckIdCardInformationRequest {
1729
- /**
1730
- * 身份证人像面的 Base64 值
1731
- 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
1732
- 支持的图片大小:所下载图片经Base64编码后不超过 7M。
1733
- 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
1734
- ImageBase64、ImageUrl二者必须提供其中之一。若都提供了,则按照ImageUrl>ImageBase64的优先级使用参数。
1735
- */
1736
- ImageBase64?: string;
1737
- /**
1738
- * 身份证人像面的 Url 地址
1739
- 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
1740
- 支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。
1741
- 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
1742
- 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
1743
- */
1744
- ImageUrl?: string;
1745
- /**
1746
- * 以下可选字段均为bool 类型,默认false:
1747
- CopyWarn,复印件告警
1748
- BorderCheckWarn,边框和框内遮挡告警
1749
- ReshootWarn,翻拍告警
1750
- DetectPsWarn,PS检测告警
1751
- TempIdWarn,临时身份证告警
1752
- Quality,图片质量告警(评价图片模糊程度)
1753
-
1754
- SDK 设置方式参考:
1755
- Config = Json.stringify({"CopyWarn":true,"ReshootWarn":true})
1756
- API 3.0 Explorer 设置方式参考:
1757
- Config = {"CopyWarn":true,"ReshootWarn":true}
1758
- */
1759
- Config?: string;
1760
- /**
1761
- * 是否需要对返回中的敏感信息进行加密。默认false。
1762
- 其中敏感信息包括:Response.IdNum、Response.Name
1763
- */
1764
- IsEncrypt?: boolean;
1765
- }
1766
- /**
1767
- * 获取token时的的配置
1768
- */
1769
- export interface GetEidTokenConfig {
1770
- /**
1771
- * 姓名身份证输入方式。
1772
- 1:传身份证正反面OCR
1773
- 2:传身份证正面OCR
1774
- 3:用户手动输入
1775
- 4:客户后台传入
1776
- 默认1
1777
- 注:使用OCR时仅支持用户修改结果中的姓名
1778
- */
1779
- InputType?: string;
1780
- /**
1781
- * 是否使用意愿核身,默认不使用。注意:如开启使用,则计费标签按【意愿核身】计费标签计价;如不开启,则计费标签按【E证通】计费标签计价,价格详见:[价格说明](https://cloud.tencent.com/document/product/1007/56804)。
1782
- */
1783
- UseIntentionVerify?: boolean;
1784
- /**
1785
- * 意愿核身模式。枚举值:1( 朗读模式),2(问答模式) 。默认值1
1786
- */
1787
- IntentionMode?: string;
1788
- /**
1789
- * 意愿核身朗读模式使用的文案,若未使用意愿核身朗读功能,该字段无需传入。默认为空,最长可接受120的字符串长度。
1790
- */
1791
- IntentionVerifyText?: string;
1792
- /**
1793
- * 意愿核身问答模式的配置列表。当前仅支持一个问答。
1794
- */
1795
- IntentionQuestions?: Array<IntentionQuestion>;
1796
- /**
1797
- * 意愿核身过程中识别用户的回答意图,开启后除了IntentionQuestions的Answers列表中的标准回答会通过,近似意图的回答也会通过,默认不开启。
1798
- */
1799
- IntentionRecognition?: boolean;
1800
- }
1801
- /**
1802
- * GetRealNameAuthToken返回参数结构体
1803
- */
1804
- export interface GetRealNameAuthTokenResponse {
1805
- /**
1806
- * 查询实名认证结果的唯一凭证
1807
- */
1808
- AuthToken?: string;
1809
- /**
1810
- * 实名认证授权地址,认证发起方需要重定向到这个地址获取认证用户的授权,仅能在微信环境下打开。
1811
- */
1812
- RedirectURL?: string;
1813
- /**
1814
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1815
- */
1816
- RequestId?: string;
1817
- }
1818
- /**
1819
- * MinorsVerification返回参数结构体
1820
- */
1821
- export interface MinorsVerificationResponse {
1822
- /**
1823
- * 结果码,收费情况如下。
1824
- 收费结果码:
1825
- 0: 成年
1826
- -1: 未成年
1827
- -3: 姓名和身份证号不一致
1828
-
1829
- 不收费结果码:
1830
- -2: 未查询到手机号信息
1831
- -4: 非法身份证号(长度、校验位等不正确)
1832
- -5: 非法姓名(长度、格式等不正确)
1833
- -6: 权威数据源服务异常
1834
- -7: 未查询到身份信息
1835
- -8: 权威数据源升级中,请稍后再试
1836
- */
1837
- Result: string;
1838
- /**
1839
- * 业务结果描述。
1840
- */
1841
- Description: string;
1842
- /**
1843
- * 该字段的值为年龄区间。格式为[a,b),
1844
- [0,8)表示年龄小于8周岁区间,不包括8岁;
1845
- [8,16)表示年龄8-16周岁区间,不包括16岁;
1846
- [16,18)表示年龄16-18周岁区间,不包括18岁;
1847
- [18,+)表示年龄大于18周岁。
1848
- */
1849
- AgeRange: string;
1850
- /**
1851
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1852
- */
1853
- RequestId?: string;
1854
- }
1855
- /**
1856
- * GetWeChatBillDetails请求参数结构体
1857
- */
1858
- export interface GetWeChatBillDetailsRequest {
1859
- /**
1860
- * 拉取的日期(YYYY-MM-DD)。最大可追溯到365天前。当天6点后才能拉取前一天的数据。
1861
- */
1862
- Date: string;
1863
- /**
1864
- * 游标。用于分页,取第一页时传0,取后续页面时,传入本接口响应中返回的NextCursor字段的值。
1865
- */
1866
- Cursor: number;
1867
- /**
1868
- * 需要拉取账单详情业务对应的RuleId。不传会返回所有RuleId数据。默认为空字符串。
1869
- */
1870
- RuleId?: string;
1871
- }
1872
- /**
1873
- * BankCardVerification返回参数结构体
1874
- */
1875
- export interface BankCardVerificationResponse {
1876
- /**
1877
- * 认证结果码
1878
- 收费结果码:
1879
- '0': '认证通过'
1880
- '-1': '认证未通过'
1881
- '-5': '持卡人信息有误'
1882
- '-6': '未开通无卡支付'
1883
- '-7': '此卡被没收'
1884
- '-8': '无效卡号'
1885
- '-9': '此卡无对应发卡行'
1886
- '-10': '该卡未初始化或睡眠卡'
1887
- '-11': '作弊卡、吞卡'
1888
- '-12': '此卡已挂失'
1889
- '-13': '该卡已过期'
1890
- '-14': '受限制的卡'
1891
- '-15': '密码错误次数超限'
1892
- '-16': '发卡行不支持此交易'
1893
- 不收费结果码:
1894
- '-2': '姓名校验不通过'
1895
- '-3': '身份证号码有误'
1896
- '-4': '银行卡号码有误'
1897
- '-17': '验证中心服务繁忙'
1898
- */
1899
- Result: string;
1900
- /**
1901
- * 业务结果描述。
1902
- */
1903
- Description: string;
1904
- /**
1905
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1906
- */
1907
- RequestId?: string;
1908
- }
1909
- /**
1910
- * PhoneVerificationCUCC请求参数结构体
1911
- */
1912
- export interface PhoneVerificationCUCCRequest {
1913
- /**
1914
- * 身份证号
1915
- */
1916
- IdCard: string;
1917
- /**
1918
- * 姓名
1919
- */
1920
- Name: string;
1921
- /**
1922
- * 手机号
1923
- */
1924
- Phone: string;
1925
- /**
1926
- * 敏感数据加密信息。对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1927
- */
1928
- Encryption?: Encryption;
1929
- }
1930
- /**
1931
- * PhoneVerificationCMCC请求参数结构体
1932
- */
1933
- export interface PhoneVerificationCMCCRequest {
1934
- /**
1935
- * 身份证号
1936
- */
1937
- IdCard: string;
1938
- /**
1939
- * 姓名
1940
- */
1941
- Name: string;
1942
- /**
1943
- * 手机号
1944
- */
1945
- Phone: string;
1946
- /**
1947
- * 敏感数据加密信息。对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1948
- */
1949
- Encryption?: Encryption;
1950
- }
1951
- /**
1952
- * 用于描述一个文件内容,包括一个下载链接和与文件内容对应的MD5和大小。
1953
- */
1954
- export interface FileInfo {
1955
- /**
1956
- * 用于下载文件的URL
1957
- */
1958
- Url: string;
1959
- /**
1960
- * 文件的32位MD5
1961
- */
1962
- MD5: string;
1963
- /**
1964
- * 文件字节数
1965
- */
1966
- Size: number;
1967
- }
1968
- /**
1969
- * 核身文本信息
1970
- */
1971
- export interface DetectInfoText {
1972
- /**
1973
- * 本次流程最终验证结果。0为成功
1974
- 注意:此字段可能返回 null,表示取不到有效值。
1975
- */
1976
- ErrCode: number;
1977
- /**
1978
- * 本次流程最终验证结果描述。(仅描述用,文案更新时不会通知。)
1979
- 注意:此字段可能返回 null,表示取不到有效值。
1980
- */
1981
- ErrMsg: string;
1982
- /**
1983
- * 本次验证使用的身份证号。
1984
- 注意:此字段可能返回 null,表示取不到有效值。
1985
- */
1986
- IdCard: string;
1383
+ IdCard: string;
1987
1384
  /**
1988
1385
  * 本次验证使用的姓名。
1989
1386
  注意:此字段可能返回 null,表示取不到有效值。
1990
1387
  */
1991
- Name: string;
1992
- /**
1993
- * Ocr识别结果。民族。
1994
- 注意:此字段可能返回 null,表示取不到有效值。
1995
- */
1996
- OcrNation: string;
1997
- /**
1998
- * Ocr识别结果。家庭住址。
1999
- 注意:此字段可能返回 null,表示取不到有效值。
2000
- */
2001
- OcrAddress: string;
2002
- /**
2003
- * Ocr识别结果。生日。
2004
- 注意:此字段可能返回 null,表示取不到有效值。
2005
- */
2006
- OcrBirth: string;
2007
- /**
2008
- * Ocr识别结果。签发机关。
2009
- 注意:此字段可能返回 null,表示取不到有效值。
2010
- */
2011
- OcrAuthority: string;
2012
- /**
2013
- * Ocr识别结果。有效日期。
2014
- 注意:此字段可能返回 null,表示取不到有效值。
2015
- */
2016
- OcrValidDate: string;
2017
- /**
2018
- * Ocr识别结果。姓名。
2019
- 注意:此字段可能返回 null,表示取不到有效值。
2020
- */
2021
- OcrName: string;
2022
- /**
2023
- * Ocr识别结果。身份证号。
2024
- 注意:此字段可能返回 null,表示取不到有效值。
2025
- */
2026
- OcrIdCard: string;
2027
- /**
2028
- * Ocr识别结果。性别。
2029
- 注意:此字段可能返回 null,表示取不到有效值。
2030
- */
2031
- OcrGender: string;
2032
- /**
2033
- * 本次流程最终活体结果。0为成功
2034
- 注意:此字段可能返回 null,表示取不到有效值。
2035
- */
2036
- LiveStatus: number;
2037
- /**
2038
- * 本次流程最终活体结果描述。(仅描述用,文案更新时不会通知。)
2039
- 注意:此字段可能返回 null,表示取不到有效值。
2040
- */
2041
- LiveMsg: string;
2042
- /**
2043
- * 本次流程最终一比一结果。0为成功
2044
- 注意:此字段可能返回 null,表示取不到有效值。
2045
- */
2046
- Comparestatus: number;
2047
- /**
2048
- * 本次流程最终一比一结果描述。(仅描述用,文案更新时不会通知。)
2049
- 注意:此字段可能返回 null,表示取不到有效值。
2050
- */
2051
- Comparemsg: string;
2052
- /**
2053
- * 本次流程活体一比一的分数,取值范围 [0.00, 100.00]。相似度大于等于70时才判断为同一人,也可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
2054
- 注意:此字段可能返回 null,表示取不到有效值。
2055
- */
2056
- Sim: string;
2057
- /**
2058
- * 地理位置经纬度。
2059
- 注意:此字段可能返回 null,表示取不到有效值。
2060
- */
2061
- Location: string;
2062
- /**
2063
- * Auth接口带入额外信息。
2064
- 注意:此字段可能返回 null,表示取不到有效值。
2065
- */
2066
- Extra: string;
2067
- /**
2068
- * 本次流程进行的活体一比一流水。
2069
- 注意:此字段可能返回 null,表示取不到有效值。
2070
- */
2071
- LivenessDetail: Array<DetectDetail>;
2072
- /**
2073
- * 手机号码。
2074
- 注意:此字段可能返回 null,表示取不到有效值。
2075
- */
2076
- Mobile: string;
2077
- /**
2078
- * 本次流程最终比对库源类型。包括:
2079
- 权威库;
2080
- 业务方自有库(用户上传照片、客户的混合库、混合部署库);
2081
- 二次验证库;
2082
- 人工审核库;
2083
- 注意:此字段可能返回 null,表示取不到有效值。
2084
- */
2085
- CompareLibType: string;
2086
- /**
2087
- * 本次流程最终活体类型。包括:
2088
- 0:未知
2089
- 1:数字活体
2090
- 2:动作活体
2091
- 3:静默活体
2092
- 4:一闪活体(动作+光线)
2093
- 注意:此字段可能返回 null,表示取不到有效值。
2094
- */
2095
- LivenessMode: number;
2096
- }
2097
- /**
2098
- * GenerateReflectSequence返回参数结构体
2099
- */
2100
- export interface GenerateReflectSequenceResponse {
2101
- /**
2102
- * 光线序列的资源链接,下载后透传给SDK即可开始核身。
2103
- */
2104
- ReflectSequenceUrl: string;
2105
- /**
2106
- * 光线序列的资源MD5值,用于校验改序列是否被篡改。
2107
- */
2108
- ReflectSequenceMd5: string;
2109
- /**
2110
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2111
- */
2112
- RequestId?: string;
2113
- }
2114
- /**
2115
- * ImageRecognition返回参数结构体
2116
- */
2117
- export interface ImageRecognitionResponse {
2118
- /**
2119
- * 相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
2120
- */
2121
- Sim: number;
2122
- /**
2123
- * 业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
2124
- */
2125
- Result: string;
2126
- /**
2127
- * 业务结果描述。
2128
- */
2129
- Description: string;
2130
- /**
2131
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2132
- */
2133
- RequestId?: string;
2134
- }
2135
- /**
2136
- * GetDetectInfo返回参数结构体
2137
- */
2138
- export interface GetDetectInfoResponse {
2139
- /**
2140
- * JSON字符串。
2141
- {
2142
- // 文本类信息
2143
- "Text": {
2144
- "ErrCode": null, // 本次核身最终结果。0为成功
2145
- "ErrMsg": null, // 本次核身最终结果信息描述。
2146
- "IdCard": "", // 本次核身最终获得的身份证号。
2147
- "Name": "", // 本次核身最终获得的姓名。
2148
- "OcrNation": null, // ocr阶段获取的民族
2149
- "OcrAddress": null, // ocr阶段获取的地址
2150
- "OcrBirth": null, // ocr阶段获取的出生信息
2151
- "OcrAuthority": null, // ocr阶段获取的证件签发机关
2152
- "OcrValidDate": null, // ocr阶段获取的证件有效期
2153
- "OcrName": null, // ocr阶段获取的姓名
2154
- "OcrIdCard": null, // ocr阶段获取的身份证号
2155
- "OcrGender": null, // ocr阶段获取的性别
2156
- "LiveStatus": null, // 活体检测阶段的错误码。0为成功
2157
- "LiveMsg": null, // 活体检测阶段的错误信息
2158
- "Comparestatus": null,// 一比一阶段的错误码。0为成功
2159
- "Comparemsg": null, // 一比一阶段的错误信息
2160
- "Sim": null, // 比对相似度
2161
- "Location": null, // 地理位置信息
2162
- "Extra": "", // DetectAuth结果传进来的Extra信息
2163
- "Detail": { // 活体一比一信息详情
2164
- "LivenessData": [
2165
- {
2166
- ErrCode: null, // 活体比对验证错误码
2167
- ErrMsg: null, // 活体比对验证错误描述
2168
- ReqTime: null, // 活体验证时间戳
2169
- IdCard: null, // 验证身份证号
2170
- Name: null // 验证姓名
2171
- }
2172
- ]
2173
- }
2174
- },
2175
- // 身份证正反面照片Base64
2176
- "IdCardData": {
2177
- "OcrFront": null,
2178
- "OcrBack": null
2179
- },
2180
- // 视频最佳帧截图Base64
2181
- "BestFrame": {
2182
- "BestFrame": null
2183
- },
2184
- // 活体视频Base64
2185
- "VideoData": {
2186
- "LivenessVideo": null
2187
- }
2188
- }
2189
- */
2190
- DetectInfo: string;
2191
- /**
2192
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2193
- */
2194
- RequestId?: string;
2195
- }
2196
- /**
2197
- * IdCardVerification返回参数结构体
2198
- */
2199
- export interface IdCardVerificationResponse {
2200
- /**
2201
- * 认证结果码,收费情况如下。
2202
- 收费结果码:
2203
- 0: 姓名和身份证号一致
2204
- -1: 姓名和身份证号不一致
2205
- 不收费结果码:
2206
- -2: 非法身份证号(长度、校验位等不正确)
2207
- -3: 非法姓名(长度、格式等不正确)
2208
- -4: 证件库服务异常
2209
- -5: 证件库中无此身份证记录
2210
- -6: 权威比对系统升级中,请稍后再试
2211
- -7: 认证次数超过当日限制
2212
- */
2213
- Result: string;
1388
+ Name: string;
2214
1389
  /**
2215
- * 业务结果描述。
1390
+ * Ocr识别结果。民族。
1391
+ 注意:此字段可能返回 null,表示取不到有效值。
2216
1392
  */
2217
- Description: string;
1393
+ OcrNation: string;
2218
1394
  /**
2219
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1395
+ * Ocr识别结果。家庭住址。
1396
+ 注意:此字段可能返回 null,表示取不到有效值。
2220
1397
  */
2221
- RequestId?: string;
2222
- }
2223
- /**
2224
- * GetLivenessResult请求参数结构体
2225
- */
2226
- export interface GetLivenessResultRequest {
1398
+ OcrAddress: string;
1399
+ /**
1400
+ * Ocr识别结果。生日。
1401
+ 注意:此字段可能返回 null,表示取不到有效值。
1402
+ */
1403
+ OcrBirth: string;
2227
1404
  /**
2228
- * 标识一次Sdk核验流程的令牌。
1405
+ * Ocr识别结果。签发机关。
1406
+ 注意:此字段可能返回 null,表示取不到有效值。
2229
1407
  */
2230
- SdkToken: string;
2231
- }
2232
- /**
2233
- * 单次比对结果描述
2234
- */
2235
- export interface CompareResult {
1408
+ OcrAuthority: string;
2236
1409
  /**
2237
- * 最终比对结果
1410
+ * Ocr识别结果。有效日期。
1411
+ 注意:此字段可能返回 null,表示取不到有效值。
2238
1412
  */
2239
- ErrorCode: string;
1413
+ OcrValidDate: string;
2240
1414
  /**
2241
- * 最终比对结果描述
1415
+ * Ocr识别结果。姓名。
1416
+ 注意:此字段可能返回 null,表示取不到有效值。
2242
1417
  */
2243
- ErrorMsg: string;
1418
+ OcrName: string;
2244
1419
  /**
2245
- * 本次活体SDK生成的活体算法数据包
1420
+ * Ocr识别结果。身份证号。
1421
+ 注意:此字段可能返回 null,表示取不到有效值。
2246
1422
  */
2247
- LiveData: FileInfo;
1423
+ OcrIdCard: string;
2248
1424
  /**
2249
- * 本次用户活体验证过程的视频,url链接有效期10分钟。
1425
+ * Ocr识别结果。性别。
1426
+ 注意:此字段可能返回 null,表示取不到有效值。
2250
1427
  */
2251
- LiveVideo: FileInfo;
1428
+ OcrGender: string;
2252
1429
  /**
2253
- * 活体认证结果码
1430
+ * 本次流程最终活体结果。0为成功
1431
+ 注意:此字段可能返回 null,表示取不到有效值。
2254
1432
  */
2255
- LiveErrorCode: string;
1433
+ LiveStatus: number;
2256
1434
  /**
2257
- * 活体认证结果描述
1435
+ * 本次流程最终活体结果描述。(仅描述用,文案更新时不会通知。)
1436
+ 注意:此字段可能返回 null,表示取不到有效值。
2258
1437
  */
2259
- LiveErrorMsg: string;
1438
+ LiveMsg: string;
2260
1439
  /**
2261
- * 本次活体的最佳人像截图,url链接有效期10分钟。
1440
+ * 本次流程最终一比一结果。0为成功
2262
1441
  注意:此字段可能返回 null,表示取不到有效值。
2263
1442
  */
2264
- BestFrame: FileInfo;
1443
+ Comparestatus: number;
2265
1444
  /**
2266
- * 证件照头像截图,url链接有效期10分钟。
1445
+ * 本次流程最终一比一结果描述。(仅描述用,文案更新时不会通知。)
1446
+ 注意:此字段可能返回 null,表示取不到有效值。
2267
1447
  */
2268
- ProfileImage: FileInfo;
1448
+ Comparemsg: string;
2269
1449
  /**
2270
- * 人脸比对结果码
1450
+ * 本次流程活体一比一的分数,取值范围 [0.00, 100.00]。相似度大于等于70时才判断为同一人,也可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
2271
1451
  注意:此字段可能返回 null,表示取不到有效值。
2272
1452
  */
2273
- CompareErrorCode: string;
1453
+ Sim: string;
2274
1454
  /**
2275
- * 人脸比对结果描述
1455
+ * 地理位置经纬度。
2276
1456
  注意:此字段可能返回 null,表示取不到有效值。
2277
1457
  */
2278
- CompareErrorMsg: string;
1458
+ Location: string;
2279
1459
  /**
2280
- * 相似度
1460
+ * Auth接口带入额外信息。
2281
1461
  注意:此字段可能返回 null,表示取不到有效值。
2282
1462
  */
2283
- Sim: number;
1463
+ Extra: string;
2284
1464
  /**
2285
- * 该字段废弃
1465
+ * 本次流程进行的活体一比一流水。
1466
+ 注意:此字段可能返回 null,表示取不到有效值。
2286
1467
  */
2287
- IsNeedCharge: boolean;
1468
+ LivenessDetail: Array<DetectDetail>;
2288
1469
  /**
2289
- * 用户编辑后的证件照信息,如果DisableChangeOcrResult为true禁用编辑无该值。url链接有效期10分钟。格式为json文本信息。
2290
- IdCardType为HK时:
2291
- - CnName string 中文姓名
2292
- - EnName string 英文姓名
2293
- - TelexCode string 中文姓名对应电码
2294
- - Sex string 性别 :“男M”或“女F”
2295
- - Birthday string 出生日期
2296
- - Permanent int 永久性居民身份证。0:非永久; 1:永久; -1:未知。
2297
- - IdNum string 身份证号码
2298
- - Symbol string 证件符号,出生日期下的符号,例如"***AZ"
2299
- - FirstIssueDate string 首次签发日期
2300
- - CurrentIssueDate string 最近领用日期
2301
-
2302
- IdCardType为ML时:
2303
- - Sex string 男:LELAKI 女:PEREMPUAN
2304
- - Birthday string
2305
- - ID string
2306
- - Name string
2307
- - Address string
2308
- - Type string 证件类型
1470
+ * 手机号码。
1471
+ 注意:此字段可能返回 null,表示取不到有效值。
1472
+ */
1473
+ Mobile: string;
1474
+ /**
1475
+ * 本次流程最终比对库源类型。包括:
1476
+ 权威库;
1477
+ 业务方自有库(用户上传照片、客户的混合库、混合部署库);
1478
+ 二次验证库;
1479
+ 人工审核库;
2309
1480
  注意:此字段可能返回 null,表示取不到有效值。
2310
1481
  */
2311
- CardInfoInputJson: FileInfo;
1482
+ CompareLibType: string;
2312
1483
  /**
2313
- * 本次认证的请求标识。
1484
+ * 本次流程最终活体类型。包括:
1485
+ 0:未知
1486
+ 1:数字活体
1487
+ 2:动作活体
1488
+ 3:静默活体
1489
+ 4:一闪活体(动作+光线)
1490
+ 注意:此字段可能返回 null,表示取不到有效值。
2314
1491
  */
2315
- RequestId: string;
1492
+ LivenessMode: number;
2316
1493
  }
2317
1494
  /**
2318
- * GetDetectInfoEnhanced请求参数结构体
1495
+ * DetectAuth请求参数结构体
2319
1496
  */
2320
- export interface GetDetectInfoEnhancedRequest {
1497
+ export interface DetectAuthRequest {
2321
1498
  /**
2322
- * 人脸核身流程的标识,调用DetectAuth接口时生成。
1499
+ * 用于细分客户使用场景,申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。如有疑问,请添加[腾讯云人脸核身小助手](https://cloud.tencent.com/document/product/1007/56130)进行咨询。
2323
1500
  */
2324
- BizToken: string;
1501
+ RuleId: string;
2325
1502
  /**
2326
- * 用于细分客户使用场景,由腾讯侧在线下对接时分配。
1503
+ * 本接口不需要传递此参数。
2327
1504
  */
2328
- RuleId: string;
1505
+ TerminalType?: string;
2329
1506
  /**
2330
- * 指定拉取的结果信息,取值(0:全部;1:文本类;2:身份证信息;3:视频最佳截图信息)。
2331
- 如 13表示拉取文本类、视频最佳截图信息。
2332
- 默认值:0
1507
+ * 身份标识(未使用OCR服务时,必须传入)。
1508
+ 规则:a-zA-Z0-9组合。最长长度32位。
2333
1509
  */
2334
- InfoType?: string;
1510
+ IdCard?: string;
2335
1511
  /**
2336
- * 从活体视频中截取一定张数的最佳帧(仅部分服务支持,若需使用请与慧眼小助手沟通)。默认为0,最大为10,超出10的最多只给10张。(InfoType需要包含3)
1512
+ * 姓名。(未使用OCR服务时,必须传入)最长长度32位。中文请使用UTF-8编码。
2337
1513
  */
2338
- BestFramesCount?: number;
1514
+ Name?: string;
2339
1515
  /**
2340
- * 是否对身份证照片进行裁边。默认为false。(InfoType需要包含2)
1516
+ * 认证结束后重定向的回调链接地址。最长长度1024位。
2341
1517
  */
2342
- IsCutIdCardImage?: boolean;
1518
+ RedirectUrl?: string;
2343
1519
  /**
2344
- * 是否需要从身份证中抠出头像。默认为false。(InfoType需要包含2)
1520
+ * 透传字段,在获取验证结果时返回。
2345
1521
  */
2346
- IsNeedIdCardAvatar?: boolean;
1522
+ Extra?: string;
2347
1523
  /**
2348
- * 已弃用。
1524
+ * 用于人脸比对的照片,图片的Base64值;
1525
+ Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
2349
1526
  */
2350
- IsEncrypt?: boolean;
1527
+ ImageBase64?: string;
2351
1528
  /**
2352
- * 是否需要对返回中的敏感信息进行加密。仅指定加密算法Algorithm即可,其余字段传入默认值。其中敏感信息包括:Response.Text.IdCard、Response.Text.Name、Response.Text.OcrIdCard、Response.Text.OcrName
1529
+ * 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2353
1530
  */
2354
1531
  Encryption?: Encryption;
2355
- }
2356
- /**
2357
- * LivenessRecognition返回参数结构体
2358
- */
2359
- export interface LivenessRecognitionResponse {
2360
1532
  /**
2361
- * 验证通过后的视频最佳截图照片,照片为BASE64编码后的值,jpg格式。
2362
- 注意:此字段可能返回 null,表示取不到有效值。
1533
+ * 意愿核身(朗读模式)使用的文案,若未使用意愿核身(朗读模式),则该字段无需传入。默认为空,最长可接受120的字符串长度。
2363
1534
  */
2364
- BestFrameBase64: string;
1535
+ IntentionVerifyText?: string;
2365
1536
  /**
2366
- * 相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
1537
+ * 意愿核身(问答模式)使用的文案,包括:系统语音播报的文本、需要核验的标准文本。当前仅支持一个播报文本+回答文本。
2367
1538
  */
2368
- Sim: number;
1539
+ IntentionQuestions?: Array<IntentionQuestion>;
1540
+ }
1541
+ /**
1542
+ * MinorsVerification返回参数结构体
1543
+ */
1544
+ export interface MinorsVerificationResponse {
2369
1545
  /**
2370
- * 业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
1546
+ * 结果码,收费情况如下。
1547
+ 收费结果码:
1548
+ 0: 成年
1549
+ -1: 未成年
1550
+ -3: 姓名和身份证号不一致
1551
+
1552
+ 不收费结果码:
1553
+ -2: 未查询到手机号信息
1554
+ -4: 非法身份证号(长度、校验位等不正确)
1555
+ -5: 非法姓名(长度、格式等不正确)
1556
+ -6: 权威数据源服务异常
1557
+ -7: 未查询到身份信息
1558
+ -8: 权威数据源升级中,请稍后再试
2371
1559
  */
2372
1560
  Result: string;
2373
1561
  /**
@@ -2375,40 +1563,44 @@ export interface LivenessRecognitionResponse {
2375
1563
  */
2376
1564
  Description: string;
2377
1565
  /**
2378
- * 最佳截图列表,仅在配置了返回多张最佳截图时返回。
2379
- 注意:此字段可能返回 null,表示取不到有效值。
1566
+ * 该字段的值为年龄区间。格式为[a,b),
1567
+ [0,8)表示年龄小于8周岁区间,不包括8岁;
1568
+ [8,16)表示年龄8-16周岁区间,不包括16岁;
1569
+ [16,18)表示年龄16-18周岁区间,不包括18岁;
1570
+ [18,+)表示年龄大于18周岁。
2380
1571
  */
2381
- BestFrameList: Array<string>;
1572
+ AgeRange: string;
2382
1573
  /**
2383
1574
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2384
1575
  */
2385
1576
  RequestId?: string;
2386
1577
  }
2387
1578
  /**
2388
- * CreateUploadUrl返回参数结构体
1579
+ * GetWeChatBillDetails请求参数结构体
2389
1580
  */
2390
- export interface CreateUploadUrlResponse {
2391
- /**
2392
- * 用于上传内容的链接,使用HTTP PUT方法上传。
2393
- */
2394
- UploadUrl: string;
1581
+ export interface GetWeChatBillDetailsRequest {
2395
1582
  /**
2396
- * 完成上传后将该链接用于后续需要传入资源URL的地方。
1583
+ * 拉取的日期(YYYY-MM-DD)。最大可追溯到365天前。当天6点后才能拉取前一天的数据。
2397
1584
  */
2398
- ResourceUrl: string;
1585
+ Date: string;
2399
1586
  /**
2400
- * 上传和下载链接过期时间点,10位unix时间戳。
1587
+ * 游标。用于分页,取第一页时传0,取后续页面时,传入本接口响应中返回的NextCursor字段的值。
2401
1588
  */
2402
- ExpiredTimestamp: number;
1589
+ Cursor: number;
2403
1590
  /**
2404
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1591
+ * 需要拉取账单详情业务对应的RuleId。不传会返回所有RuleId数据。默认为空字符串。
2405
1592
  */
2406
- RequestId?: string;
1593
+ RuleId?: string;
2407
1594
  }
2408
1595
  /**
2409
- * GetLiveCode请求参数结构体
1596
+ * CheckEidTokenStatus请求参数结构体
2410
1597
  */
2411
- export declare type GetLiveCodeRequest = null;
1598
+ export interface CheckEidTokenStatusRequest {
1599
+ /**
1600
+ * E证通流程的唯一标识,调用GetEidToken接口时生成。
1601
+ */
1602
+ EidToken: string;
1603
+ }
2412
1604
  /**
2413
1605
  * GetEidResult返回参数结构体
2414
1606
  */
@@ -2449,47 +1641,45 @@ export interface GetEidResultResponse {
2449
1641
  RequestId?: string;
2450
1642
  }
2451
1643
  /**
2452
- * ApplyWebVerificationToken返回参数结构体
1644
+ * GetRealNameAuthResult请求参数结构体
2453
1645
  */
2454
- export interface ApplyWebVerificationTokenResponse {
2455
- /**
2456
- * 用户浏览器需要打开此地址开始核验流程。
2457
- */
2458
- VerificationUrl: string;
2459
- /**
2460
- * 标识一次Web核验流程的令牌,有效时间为7,200秒。流程结束后可用该令牌获取核验结果信息。
2461
- */
2462
- BizToken: string;
1646
+ export interface GetRealNameAuthResultRequest {
2463
1647
  /**
2464
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1648
+ * 实名认证凭证
2465
1649
  */
2466
- RequestId?: string;
1650
+ AuthToken: string;
2467
1651
  }
2468
1652
  /**
2469
- * 账单详情
1653
+ * ImageRecognition请求参数结构体
2470
1654
  */
2471
- export interface WeChatBillDetail {
1655
+ export interface ImageRecognitionRequest {
2472
1656
  /**
2473
- * token
1657
+ * 身份证号
2474
1658
  */
2475
- BizToken: string;
1659
+ IdCard: string;
2476
1660
  /**
2477
- * 本token收费次数
1661
+ * 姓名。中文请使用UTF-8编码。
2478
1662
  */
2479
- ChargeCount: number;
1663
+ Name: string;
2480
1664
  /**
2481
- * 本token计费详情
1665
+ * 用于人脸比对的照片,图片的Base64值;
1666
+ Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。
1667
+ 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
2482
1668
  */
2483
- ChargeDetails: Array<ChargeDetail>;
1669
+ ImageBase64: string;
2484
1670
  /**
2485
- * 业务RuleId
1671
+ * 本接口不需要传递此参数。
2486
1672
  */
2487
- RuleId: string;
1673
+ Optional?: string;
1674
+ /**
1675
+ * 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1676
+ */
1677
+ Encryption?: Encryption;
2488
1678
  }
2489
1679
  /**
2490
- * PhoneVerification请求参数结构体
1680
+ * PhoneVerificationCUCC请求参数结构体
2491
1681
  */
2492
- export interface PhoneVerificationRequest {
1682
+ export interface PhoneVerificationCUCCRequest {
2493
1683
  /**
2494
1684
  * 身份证号
2495
1685
  */
@@ -2503,26 +1693,52 @@ export interface PhoneVerificationRequest {
2503
1693
  */
2504
1694
  Phone: string;
2505
1695
  /**
2506
- * 有加密需求的用户,传入kms的CiphertextBlob,关于数据加密可查阅 <a href="https://cloud.tencent.com/document/product/1007/47180">数据加密</a> 文档。
1696
+ * 敏感数据加密信息。对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2507
1697
  */
2508
- CiphertextBlob?: string;
1698
+ Encryption?: Encryption;
1699
+ }
1700
+ /**
1701
+ * BankCard4EVerification请求参数结构体
1702
+ */
1703
+ export interface BankCard4EVerificationRequest {
2509
1704
  /**
2510
- * 在使用加密服务时,填入要被加密的字段。本接口中可填入加密后的IdCard,Name,Phone中的一个或多个。
1705
+ * 姓名
2511
1706
  */
2512
- EncryptList?: Array<string>;
1707
+ Name: string;
2513
1708
  /**
2514
- * 有加密需求的用户,传入CBC加密的初始向量。
1709
+ * 银行卡
2515
1710
  */
2516
- Iv?: string;
1711
+ BankCard: string;
1712
+ /**
1713
+ * 手机号码
1714
+ */
1715
+ Phone: string;
1716
+ /**
1717
+ * 开户证件号,与CertType参数的证件类型一致,如:身份证,则传入身份证号。
1718
+ */
1719
+ IdCard: string;
1720
+ /**
1721
+ * 证件类型,请确认该证件为开户时使用的证件类型,未用于开户的证件信息不支持验证。
1722
+ 目前默认为0:身份证,其他证件类型暂不支持。
1723
+ */
1724
+ CertType?: number;
1725
+ /**
1726
+ * 敏感数据加密信息。对传入信息(姓名、身份证号、手机号、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1727
+ */
1728
+ Encryption?: Encryption;
2517
1729
  }
2518
1730
  /**
2519
- * GetRealNameAuthResult请求参数结构体
1731
+ * MobileNetworkTimeVerification请求参数结构体
2520
1732
  */
2521
- export interface GetRealNameAuthResultRequest {
1733
+ export interface MobileNetworkTimeVerificationRequest {
2522
1734
  /**
2523
- * 实名认证凭证
1735
+ * 手机号码
2524
1736
  */
2525
- AuthToken: string;
1737
+ Mobile: string;
1738
+ /**
1739
+ * 敏感数据加密信息。对传入信息(手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1740
+ */
1741
+ Encryption?: Encryption;
2526
1742
  }
2527
1743
  /**
2528
1744
  * GetFaceIdResult请求参数结构体
@@ -2542,22 +1758,30 @@ export interface GetFaceIdResultRequest {
2542
1758
  IsNeedBestFrame?: boolean;
2543
1759
  }
2544
1760
  /**
2545
- * CheckPhoneAndName返回参数结构体
1761
+ * PhoneVerificationCUCC返回参数结构体
2546
1762
  */
2547
- export interface CheckPhoneAndNameResponse {
1763
+ export interface PhoneVerificationCUCCResponse {
2548
1764
  /**
2549
1765
  * 认证结果码,收费情况如下。
2550
1766
  收费结果码:
2551
- 0: 验证结果一致
2552
- 1: 验证结果不一致
1767
+ 0: 认证通过
1768
+ -4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)
2553
1769
  不收费结果码:
2554
- -1:查无记录
2555
- -2:引擎未知错误
2556
- -3:引擎服务异常
1770
+ -6: 手机号码不合法
1771
+ -7: 身份证号码有误
1772
+ -8: 姓名校验不通过
1773
+ -9: 没有记录
1774
+ -10: 认证未通过
1775
+ -11: 验证中心服务繁忙
2557
1776
  */
2558
1777
  Result: string;
2559
1778
  /**
2560
- * 业务结果描述
1779
+ * 运营商名称。
1780
+ 取值范围为["移动","联通","电信",""]
1781
+ */
1782
+ Isp: string;
1783
+ /**
1784
+ * 业务结果描述。
2561
1785
  */
2562
1786
  Description: string;
2563
1787
  /**
@@ -2566,104 +1790,125 @@ export interface CheckPhoneAndNameResponse {
2566
1790
  RequestId?: string;
2567
1791
  }
2568
1792
  /**
2569
- * GetFaceIdToken请求参数结构体
1793
+ * GetActionSequence返回参数结构体
2570
1794
  */
2571
- export interface GetFaceIdTokenRequest {
1795
+ export interface GetActionSequenceResponse {
2572
1796
  /**
2573
- * 本地上传照片(LOCAL)、商业库(BUSINESS)
1797
+ * 动作顺序(2,1 or 1,2) 。1代表张嘴,2代表闭眼。
2574
1798
  */
2575
- CompareLib: string;
1799
+ ActionSequence?: string;
2576
1800
  /**
2577
- * CompareLib为商业库时必传。
1801
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2578
1802
  */
2579
- IdCard?: string;
1803
+ RequestId?: string;
1804
+ }
1805
+ /**
1806
+ * LivenessRecognition返回参数结构体
1807
+ */
1808
+ export interface LivenessRecognitionResponse {
2580
1809
  /**
2581
- * CompareLib为商业库库时必传。
1810
+ * 验证通过后的视频最佳截图照片,照片为BASE64编码后的值,jpg格式。
1811
+ 注意:此字段可能返回 null,表示取不到有效值。
2582
1812
  */
2583
- Name?: string;
1813
+ BestFrameBase64: string;
2584
1814
  /**
2585
- * CompareLib为上传照片比对时必传,Base64后图片最大8MB。
2586
- 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
1815
+ * 相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
2587
1816
  */
2588
- ImageBase64?: string;
1817
+ Sim: number;
2589
1818
  /**
2590
- * SDK中生成的Meta字符串
1819
+ * 业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
2591
1820
  */
2592
- Meta?: string;
1821
+ Result: string;
2593
1822
  /**
2594
- * 透传参数 1000长度字符串
1823
+ * 业务结果描述。
2595
1824
  */
2596
- Extra?: string;
1825
+ Description: string;
2597
1826
  /**
2598
- * 默认为false,设置该参数为true后,核身过程中的视频图片将会存储在人脸核身控制台授权cos的bucket中,拉取结果时会返回对应资源完整cos地址。开通地址见https://console.cloud.tencent.com/faceid/cos
2599
- 【注意】选择该参数为true后将不返回base64数据,请根据接入情况谨慎修改。
1827
+ * 最佳截图列表,仅在配置了返回多张最佳截图时返回。
1828
+ 注意:此字段可能返回 null,表示取不到有效值。
2600
1829
  */
2601
- UseCos?: boolean;
1830
+ BestFrameList: Array<string>;
1831
+ /**
1832
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1833
+ */
1834
+ RequestId?: string;
2602
1835
  }
2603
1836
  /**
2604
- * 核验流程详细信息
1837
+ * BankCardVerification返回参数结构体
2605
1838
  */
2606
- export interface VerificationDetail {
2607
- /**
2608
- * 本次核验最终结果。0为核验通过,是同一人。
2609
- 注意:此字段可能返回 null,表示取不到有效值。
2610
- */
2611
- ErrorCode: number;
1839
+ export interface BankCardVerificationResponse {
2612
1840
  /**
2613
- * 本次核验最终结果描述。
2614
- 注意:此字段可能返回 null,表示取不到有效值。
1841
+ * 认证结果码
1842
+ 收费结果码:
1843
+ '0': '认证通过'
1844
+ '-1': '认证未通过'
1845
+ '-5': '持卡人信息有误'
1846
+ '-6': '未开通无卡支付'
1847
+ '-7': '此卡被没收'
1848
+ '-8': '无效卡号'
1849
+ '-9': '此卡无对应发卡行'
1850
+ '-10': '该卡未初始化或睡眠卡'
1851
+ '-11': '作弊卡、吞卡'
1852
+ '-12': '此卡已挂失'
1853
+ '-13': '该卡已过期'
1854
+ '-14': '受限制的卡'
1855
+ '-15': '密码错误次数超限'
1856
+ '-16': '发卡行不支持此交易'
1857
+ 不收费结果码:
1858
+ '-2': '姓名校验不通过'
1859
+ '-3': '身份证号码有误'
1860
+ '-4': '银行卡号码有误'
1861
+ '-17': '验证中心服务繁忙'
2615
1862
  */
2616
- ErrorMsg: string;
1863
+ Result: string;
2617
1864
  /**
2618
- * 本次核验活体结果。0为成功
2619
- 注意:此字段可能返回 null,表示取不到有效值。
1865
+ * 业务结果描述。
2620
1866
  */
2621
- LivenessErrorCode: number;
1867
+ Description: string;
2622
1868
  /**
2623
- * 本次核验活体结果描述
2624
- 注意:此字段可能返回 null,表示取不到有效值。
1869
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2625
1870
  */
2626
- LivenessErrorMsg: string;
1871
+ RequestId?: string;
1872
+ }
1873
+ /**
1874
+ * MinorsVerification请求参数结构体
1875
+ */
1876
+ export interface MinorsVerificationRequest {
2627
1877
  /**
2628
- * 本次核验比对结果。0为视频流中采集的最佳人脸照片和上传的比对照片是同一人。
2629
- 注意:此字段可能返回 null,表示取不到有效值。
1878
+ * 参与校验的参数类型。
1879
+ 0:使用手机号进行校验;
1880
+ 1:使用姓名与身份证号进行校验。
2630
1881
  */
2631
- CompareErrorCode: number;
1882
+ Type: string;
2632
1883
  /**
2633
- * 本次核验比对结果描述。
2634
- 注意:此字段可能返回 null,表示取不到有效值。
1884
+ * 手机号,11位数字,
1885
+ 特别提示:
1886
+ 手机号验证只限制在腾讯健康守护可信模型覆盖的数据范围内,与手机号本身在运营商是否实名无关联,不在范围会提示“手机号未实名”,建议客户与传入姓名和身份证号信息组合使用。
2635
1887
  */
2636
- CompareErrorMsg: string;
1888
+ Mobile?: string;
2637
1889
  /**
2638
- * 本次核验时间戳(毫秒)
2639
- 注意:此字段可能返回 null,表示取不到有效值。
1890
+ * 身份证号码。
2640
1891
  */
2641
- ReqTimestamp: number;
1892
+ IdCard?: string;
2642
1893
  /**
2643
- * 本次核验视频流中采集的最佳人脸照片和上传的比对照片的相似度, 范围[0.00, 100.00],默认大于等于70时判断为同一人。
2644
- 注意:此字段可能返回 null,表示取不到有效值。
1894
+ * 姓名。
2645
1895
  */
2646
- Similarity: number;
1896
+ Name?: string;
2647
1897
  /**
2648
- * 本次核验的唯一标识
2649
- 注意:此字段可能返回 null,表示取不到有效值。
1898
+ * 敏感数据加密信息。对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2650
1899
  */
2651
- Seq: string;
1900
+ Encryption?: Encryption;
2652
1901
  }
2653
1902
  /**
2654
- * DetectReflectLivenessAndCompare返回参数结构体
1903
+ * ImageRecognition返回参数结构体
2655
1904
  */
2656
- export interface DetectReflectLivenessAndCompareResponse {
2657
- /**
2658
- * 验证通过后的视频最佳截图资源临时地址,jpg格式,资源和链接有效期2小时,务必在有效期内下载。
2659
- */
2660
- BestFrameUrl: string;
1905
+ export interface ImageRecognitionResponse {
2661
1906
  /**
2662
- * 验证通过后的视频最佳截图资源MD5(32位,用于校验BestFrame的一致性)。
1907
+ * 相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
2663
1908
  */
2664
- BestFrameMd5: string;
1909
+ Sim: number;
2665
1910
  /**
2666
- * 业务错误码,成功情况返回Success,错误情况请参考下方错误码 列表中FailedOperation部分。
1911
+ * 业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
2667
1912
  */
2668
1913
  Result: string;
2669
1914
  /**
@@ -2671,18 +1916,89 @@ export interface DetectReflectLivenessAndCompareResponse {
2671
1916
  */
2672
1917
  Description: string;
2673
1918
  /**
2674
- * 相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)。
1919
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2675
1920
  */
2676
- Sim: number;
1921
+ RequestId?: string;
1922
+ }
1923
+ /**
1924
+ * GetActionSequence请求参数结构体
1925
+ */
1926
+ export interface GetActionSequenceRequest {
1927
+ /**
1928
+ * 默认不需要使用
1929
+ */
1930
+ ActionType?: string;
1931
+ }
1932
+ /**
1933
+ * GetDetectInfo返回参数结构体
1934
+ */
1935
+ export interface GetDetectInfoResponse {
1936
+ /**
1937
+ * JSON字符串。
1938
+ {
1939
+ // 文本类信息
1940
+ "Text": {
1941
+ "ErrCode": null, // 本次核身最终结果。0为成功
1942
+ "ErrMsg": null, // 本次核身最终结果信息描述。
1943
+ "IdCard": "", // 本次核身最终获得的身份证号。
1944
+ "Name": "", // 本次核身最终获得的姓名。
1945
+ "OcrNation": null, // ocr阶段获取的民族
1946
+ "OcrAddress": null, // ocr阶段获取的地址
1947
+ "OcrBirth": null, // ocr阶段获取的出生信息
1948
+ "OcrAuthority": null, // ocr阶段获取的证件签发机关
1949
+ "OcrValidDate": null, // ocr阶段获取的证件有效期
1950
+ "OcrName": null, // ocr阶段获取的姓名
1951
+ "OcrIdCard": null, // ocr阶段获取的身份证号
1952
+ "OcrGender": null, // ocr阶段获取的性别
1953
+ "LiveStatus": null, // 活体检测阶段的错误码。0为成功
1954
+ "LiveMsg": null, // 活体检测阶段的错误信息
1955
+ "Comparestatus": null,// 一比一阶段的错误码。0为成功
1956
+ "Comparemsg": null, // 一比一阶段的错误信息
1957
+ "Sim": null, // 比对相似度
1958
+ "Location": null, // 地理位置信息
1959
+ "Extra": "", // DetectAuth结果传进来的Extra信息
1960
+ "Detail": { // 活体一比一信息详情
1961
+ "LivenessData": [
1962
+ {
1963
+ ErrCode: null, // 活体比对验证错误码
1964
+ ErrMsg: null, // 活体比对验证错误描述
1965
+ ReqTime: null, // 活体验证时间戳
1966
+ IdCard: null, // 验证身份证号
1967
+ Name: null // 验证姓名
1968
+ }
1969
+ ]
1970
+ }
1971
+ },
1972
+ // 身份证正反面照片Base64
1973
+ "IdCardData": {
1974
+ "OcrFront": null,
1975
+ "OcrBack": null
1976
+ },
1977
+ // 视频最佳帧截图Base64
1978
+ "BestFrame": {
1979
+ "BestFrame": null
1980
+ },
1981
+ // 活体视频Base64
1982
+ "VideoData": {
1983
+ "LivenessVideo": null
1984
+ }
1985
+ }
1986
+ */
1987
+ DetectInfo: string;
2677
1988
  /**
2678
1989
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2679
1990
  */
2680
1991
  RequestId?: string;
2681
1992
  }
2682
1993
  /**
2683
- * VideoLivenessCompare返回参数结构体
1994
+ * LivenessCompare返回参数结构体
2684
1995
  */
2685
- export interface VideoLivenessCompareResponse {
1996
+ export interface LivenessCompareResponse {
1997
+ /**
1998
+ * 验证通过后的视频最佳截图照片,照片为BASE64编码后的值,jpg格式。
1999
+ 注意:此字段可能返回 null,表示取不到有效值。
2000
+ */
2001
+ BestFrameBase64: string;
2686
2002
  /**
2687
2003
  * 相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)。
2688
2004
  */
@@ -2696,36 +2012,87 @@ export interface VideoLivenessCompareResponse {
2696
2012
  */
2697
2013
  Description: string;
2698
2014
  /**
2699
- * 验证通过后的视频最佳截图照片。
2700
- 注意:此字段可能返回 null,表示取不到有效值。
2015
+ * 最佳截图列表,仅在配置了返回多张最佳截图时返回。
2016
+ 注意:此字段可能返回 null,表示取不到有效值。
2017
+ */
2018
+ BestFrameList: Array<string>;
2019
+ /**
2020
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2021
+ */
2022
+ RequestId?: string;
2023
+ }
2024
+ /**
2025
+ * GetLiveCode返回参数结构体
2026
+ */
2027
+ export interface GetLiveCodeResponse {
2028
+ /**
2029
+ * 数字验证码,如:1234
2030
+ */
2031
+ LiveCode?: string;
2032
+ /**
2033
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2034
+ */
2035
+ RequestId?: string;
2036
+ }
2037
+ /**
2038
+ * GetDetectInfo请求参数结构体
2039
+ */
2040
+ export interface GetDetectInfoRequest {
2041
+ /**
2042
+ * 人脸核身流程的标识,调用DetectAuth接口时生成。
2043
+ */
2044
+ BizToken: string;
2045
+ /**
2046
+ * 用于细分客户使用场景,申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。如有疑问,请加慧眼小助手微信(faceid001)进行咨询。
2701
2047
  */
2702
- BestFrame: FileInfo;
2048
+ RuleId: string;
2703
2049
  /**
2704
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2050
+ * 指定拉取的结果信息,取值(0:全部;1:文本类;2:身份证正反面;3:视频最佳截图照片;4:视频)。
2051
+ 如 134表示拉取文本类、视频最佳截图照片、视频。
2052
+ 默认值:0
2705
2053
  */
2706
- RequestId?: string;
2054
+ InfoType?: string;
2707
2055
  }
2708
2056
  /**
2709
- * BankCard2EVerification请求参数结构体
2057
+ * BankCard2EVerification返回参数结构体
2710
2058
  */
2711
- export interface BankCard2EVerificationRequest {
2059
+ export interface BankCard2EVerificationResponse {
2712
2060
  /**
2713
- * 姓名
2061
+ * 认证结果码
2062
+ 计费结果码:
2063
+ '0': '认证通过'
2064
+ '-1': '认证未通过'
2065
+ '-4': '持卡人信息有误'
2066
+ '-5': '未开通无卡支付'
2067
+ '-6': '此卡被没收'
2068
+ '-7': '无效卡号'
2069
+ '-8': '此卡无对应发卡行'
2070
+ '-9': '该卡未初始化或睡眠卡'
2071
+ '-10': '作弊卡、吞卡'
2072
+ '-11': '此卡已挂失'
2073
+ '-12': '该卡已过期'
2074
+ '-13': '受限制的卡'
2075
+ '-14': '密码错误次数超限'
2076
+ '-15': '发卡行不支持此交易'
2077
+ 不计费结果码:
2078
+ '-2': '姓名校验不通过'
2079
+ '-3': '银行卡号码有误'
2080
+ '-16': '验证中心服务繁忙'
2714
2081
  */
2715
- Name: string;
2082
+ Result: string;
2716
2083
  /**
2717
- * 银行卡
2084
+ * 业务结果描述。
2718
2085
  */
2719
- BankCard: string;
2086
+ Description: string;
2720
2087
  /**
2721
- * 敏感数据加密信息。对传入信息(姓名、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2088
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2722
2089
  */
2723
- Encryption?: Encryption;
2090
+ RequestId?: string;
2724
2091
  }
2725
2092
  /**
2726
- * IdCardOCRVerification返回参数结构体
2093
+ * IdCardVerification返回参数结构体
2727
2094
  */
2728
- export interface IdCardOCRVerificationResponse {
2095
+ export interface IdCardVerificationResponse {
2729
2096
  /**
2730
2097
  * 认证结果码,收费情况如下。
2731
2098
  收费结果码:
@@ -2745,401 +2112,377 @@ export interface IdCardOCRVerificationResponse {
2745
2112
  */
2746
2113
  Description: string;
2747
2114
  /**
2748
- * 用于验证的姓名
2749
- */
2750
- Name: string;
2751
- /**
2752
- * 用于验证的身份证号
2115
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2753
2116
  */
2754
- IdCard: string;
2117
+ RequestId?: string;
2118
+ }
2119
+ /**
2120
+ * 核身身份证图片信息
2121
+ */
2122
+ export interface DetectInfoIdCardData {
2755
2123
  /**
2756
- * OCR得到的性别
2124
+ * OCR正面照片的base64编码。
2757
2125
  注意:此字段可能返回 null,表示取不到有效值。
2758
2126
  */
2759
- Sex: string;
2127
+ OcrFront: string;
2760
2128
  /**
2761
- * OCR得到的民族
2129
+ * OCR反面照片的base64编码
2762
2130
  注意:此字段可能返回 null,表示取不到有效值。
2763
2131
  */
2764
- Nation: string;
2132
+ OcrBack: string;
2765
2133
  /**
2766
- * OCR得到的生日
2134
+ * 旋转裁边后的正面照片base64编码。
2767
2135
  注意:此字段可能返回 null,表示取不到有效值。
2768
2136
  */
2769
- Birth: string;
2137
+ ProcessedFrontImage: string;
2770
2138
  /**
2771
- * OCR得到的地址
2139
+ * 旋转裁边后的背面照片base64编码。
2772
2140
  注意:此字段可能返回 null,表示取不到有效值。
2773
2141
  */
2774
- Address: string;
2775
- /**
2776
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2777
- */
2778
- RequestId?: string;
2779
- }
2780
- /**
2781
- * PhoneVerificationCTCC返回参数结构体
2782
- */
2783
- export interface PhoneVerificationCTCCResponse {
2784
- /**
2785
- * 认证结果码,收费情况如下。
2786
- 收费结果码:
2787
- 0: 认证通过
2788
- -4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)
2789
- 不收费结果码:
2790
- -6: 手机号码不合法
2791
- -7: 身份证号码有误
2792
- -8: 姓名校验不通过
2793
- -9: 没有记录
2794
- -10: 认证未通过
2795
- -11: 验证中心服务繁忙
2796
- */
2797
- Result: string;
2142
+ ProcessedBackImage: string;
2798
2143
  /**
2799
- * 运营商名称。
2800
- 取值范围为["移动","联通","电信",""]
2144
+ * 身份证正面人像图base64编码。
2145
+ 注意:此字段可能返回 null,表示取不到有效值。
2801
2146
  */
2802
- Isp: string;
2147
+ Avatar: string;
2803
2148
  /**
2804
- * 业务结果描述。
2149
+ * 身份证人像面告警码,开启身份证告警功能后才会返回,返回数组中可能出现的告警码如下:
2150
+ -9100 身份证有效日期不合法告警,
2151
+ -9101 身份证边框不完整告警,
2152
+ -9102 身份证复印件告警,
2153
+ -9103 身份证翻拍告警,
2154
+ -9105 身份证框内遮挡告警,
2155
+ -9104 临时身份证告警,
2156
+ -9106 身份证 PS 告警,
2157
+ -9107 身份证反光告警。
2158
+ 注意:此字段可能返回 null,表示取不到有效值。
2805
2159
  */
2806
- Description: string;
2160
+ WarnInfos: Array<number>;
2807
2161
  /**
2808
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2162
+ * 身份证国徽面告警码,开启身份证告警功能后才会返回,返回数组中可能出现的告警码如下:
2163
+ -9100 身份证有效日期不合法告警,
2164
+ -9101 身份证边框不完整告警,
2165
+ -9102 身份证复印件告警,
2166
+ -9103 身份证翻拍告警,
2167
+ -9105 身份证框内遮挡告警,
2168
+ -9104 临时身份证告警,
2169
+ -9106 身份证 PS 告警,
2170
+ -9107 身份证反光告警。
2171
+ 注意:此字段可能返回 null,表示取不到有效值。
2809
2172
  */
2810
- RequestId?: string;
2173
+ BackWarnInfos: Array<number>;
2811
2174
  }
2812
2175
  /**
2813
- * 计费详情
2176
+ * CheckPhoneAndName请求参数结构体
2814
2177
  */
2815
- export interface ChargeDetail {
2816
- /**
2817
- * 一比一时间时间戳,13位。
2818
- */
2819
- ReqTime: string;
2820
- /**
2821
- * 一比一请求的唯一标记。
2822
- */
2823
- Seq: string;
2178
+ export interface CheckPhoneAndNameRequest {
2824
2179
  /**
2825
- * 一比一时使用的、脱敏后的身份证号。
2180
+ * ⼿机号
2826
2181
  */
2827
- Idcard: string;
2182
+ Mobile: string;
2828
2183
  /**
2829
- * 一比一时使用的、脱敏后的姓名。
2184
+ * 姓名
2830
2185
  */
2831
2186
  Name: string;
2832
2187
  /**
2833
- * 一比一的相似度。0-100,保留2位小数。
2834
- */
2835
- Sim: string;
2836
- /**
2837
- * 本次详情是否收费。
2188
+ * 敏感数据加密信息。对传入信息(姓名、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2838
2189
  */
2839
- IsNeedCharge: boolean;
2190
+ Encryption?: Encryption;
2191
+ }
2192
+ /**
2193
+ * GetEidToken返回参数结构体
2194
+ */
2195
+ export interface GetEidTokenResponse {
2840
2196
  /**
2841
- * 收费类型,比对、核身、混合部署。
2197
+ * 一次核身流程的标识,有效时间为600秒;
2198
+ 完成核身后,可用该标识获取验证结果信息。
2842
2199
  */
2843
- ChargeType: string;
2200
+ EidToken: string;
2844
2201
  /**
2845
- * 本次活体一比一最终结果。
2202
+ * 发起核身流程的URL,用于H5场景核身。
2846
2203
  */
2847
- ErrorCode: string;
2204
+ Url: string;
2848
2205
  /**
2849
- * 本次活体一比一最终结果描述。
2206
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2850
2207
  */
2851
- ErrorMessage: string;
2208
+ RequestId?: string;
2852
2209
  }
2853
2210
  /**
2854
- * ParseNfcData请求参数结构体
2211
+ * 意愿核身相关结果
2855
2212
  */
2856
- export interface ParseNfcDataRequest {
2213
+ export interface IntentionVerifyData {
2857
2214
  /**
2858
- * 前端SDK返回
2215
+ * 意愿确认环节中录制的视频(base64)。若不存在则为空字符串。
2216
+ 注意:此字段可能返回 null,表示取不到有效值。
2859
2217
  */
2860
- ReqId: string;
2861
- }
2862
- /**
2863
- * PhoneVerificationCTCC请求参数结构体
2864
- */
2865
- export interface PhoneVerificationCTCCRequest {
2218
+ IntentionVerifyVideo: string;
2866
2219
  /**
2867
- * 身份证号
2220
+ * 意愿确认环节中用户语音转文字的识别结果。若不存在则为空字符串。
2221
+ 注意:此字段可能返回 null,表示取不到有效值。
2868
2222
  */
2869
- IdCard: string;
2223
+ AsrResult: string;
2870
2224
  /**
2871
- * 姓名
2225
+ * 意愿确认环节的结果码。当该结果码为0时,语音朗读的视频与语音识别结果才会返回。
2226
+ 注意:此字段可能返回 null,表示取不到有效值。
2872
2227
  */
2873
- Name: string;
2228
+ ErrorCode: number;
2874
2229
  /**
2875
- * 手机号
2230
+ * 意愿确认环节的结果信息。
2231
+ 注意:此字段可能返回 null,表示取不到有效值。
2876
2232
  */
2877
- Phone: string;
2233
+ ErrorMessage: string;
2878
2234
  /**
2879
- * 敏感数据加密信息。对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2235
+ * 意愿确认环节中录制视频的最佳帧(base64)。若不存在则为空字符串。
2236
+ 注意:此字段可能返回 null,表示取不到有效值。
2880
2237
  */
2881
- Encryption?: Encryption;
2238
+ IntentionVerifyBestFrame: string;
2239
+ /**
2240
+ * 本次流程用户语音与传入文本比对的相似度分值,取值范围 [0.00, 100.00]。只有配置了相似度阈值后才进行语音校验并返回相似度分值。
2241
+ 注意:此字段可能返回 null,表示取不到有效值。
2242
+ */
2243
+ AsrResultSimilarity: string;
2882
2244
  }
2883
2245
  /**
2884
- * ImageRecognition请求参数结构体
2246
+ * LivenessCompare请求参数结构体
2885
2247
  */
2886
- export interface ImageRecognitionRequest {
2887
- /**
2888
- * 身份证号
2889
- */
2890
- IdCard: string;
2248
+ export interface LivenessCompareRequest {
2891
2249
  /**
2892
- * 姓名。中文请使用UTF-8编码。
2250
+ * 活体检测类型,取值:LIP/ACTION/SILENT。
2251
+ LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。
2893
2252
  */
2894
- Name: string;
2253
+ LivenessType: string;
2895
2254
  /**
2896
- * 用于人脸比对的照片,图片的Base64值;
2255
+ * 用于人脸比对的照片的Base64值;
2897
2256
  Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。
2898
2257
  请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
2258
+
2259
+ 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageBase64。
2899
2260
  */
2900
- ImageBase64: string;
2901
- /**
2902
- * 本接口不需要传递此参数。
2903
- */
2904
- Optional?: string;
2905
- /**
2906
- * 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2907
- */
2908
- Encryption?: Encryption;
2909
- }
2910
- /**
2911
- * BankCard4EVerification请求参数结构体
2912
- */
2913
- export interface BankCard4EVerificationRequest {
2914
- /**
2915
- * 姓名
2916
- */
2917
- Name: string;
2261
+ ImageBase64?: string;
2918
2262
  /**
2919
- * 银行卡
2263
+ * 用于人脸比对照片的URL地址;图片下载后经Base64编码后的数据大小不超过3M,仅支持jpg、png格式。
2264
+
2265
+ 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageBase64。
2266
+
2267
+ 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
2920
2268
  */
2921
- BankCard: string;
2269
+ ImageUrl?: string;
2922
2270
  /**
2923
- * 手机号码
2271
+ * 数字模式传参:传数字验证码,验证码需先调用<a href="https://cloud.tencent.com/document/product/1007/31821">获取数字验证码接口</a>得到;
2272
+ 动作模式传参:传动作顺序,动作顺序需先调用<a href="https://cloud.tencent.com/document/product/1007/31822">获取动作顺序接口</a>得到;
2273
+ 静默模式传参:空。
2924
2274
  */
2925
- Phone: string;
2275
+ ValidateData?: string;
2926
2276
  /**
2927
- * 开户证件号,与CertType参数的证件类型一致,如:身份证,则传入身份证号。
2277
+ * 额外配置,传入JSON字符串。
2278
+ {
2279
+ "BestFrameNum": 2 //需要返回多张最佳截图,取值范围2-10
2280
+ }
2928
2281
  */
2929
- IdCard: string;
2282
+ Optional?: string;
2930
2283
  /**
2931
- * 证件类型,请确认该证件为开户时使用的证件类型,未用于开户的证件信息不支持验证。
2932
- 目前默认为0:身份证,其他证件类型暂不支持。
2284
+ * 用于活体检测的视频,视频的Base64值;
2285
+ Base64编码后的大小不超过8M,支持mp4、avi、flv格式。
2286
+ 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
2287
+
2288
+ 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
2933
2289
  */
2934
- CertType?: number;
2290
+ VideoBase64?: string;
2935
2291
  /**
2936
- * 敏感数据加密信息。对传入信息(姓名、身份证号、手机号、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2292
+ * 用于活体检测的视频Url 地址。视频下载后经Base64编码后不超过 8M,视频下载耗时不超过4S,支持mp4、avi、flv格式。
2293
+
2294
+ 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
2295
+
2296
+ 建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议视频存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
2937
2297
  */
2938
- Encryption?: Encryption;
2298
+ VideoUrl?: string;
2939
2299
  }
2940
2300
  /**
2941
- * CreateUploadUrl请求参数结构体
2301
+ * 活体一比一详情
2942
2302
  */
2943
- export interface CreateUploadUrlRequest {
2303
+ export interface DetectDetail {
2944
2304
  /**
2945
- * 用于的接口
2305
+ * 请求时间戳。
2306
+ 注意:此字段可能返回 null,表示取不到有效值。
2946
2307
  */
2947
- TargetAction: string;
2948
- }
2949
- /**
2950
- * GetWebVerificationResult返回参数结构体
2951
- */
2952
- export interface GetWebVerificationResultResponse {
2308
+ ReqTime: string;
2953
2309
  /**
2954
- * 本次核验最终结果。0为核验通过,是同一人。
2310
+ * 本次活体一比一请求的唯一标记。
2955
2311
  注意:此字段可能返回 null,表示取不到有效值。
2956
2312
  */
2957
- ErrorCode: number;
2313
+ Seq: string;
2958
2314
  /**
2959
- * 本次核验最终结果描述。
2315
+ * 参与本次活体一比一的身份证号。
2960
2316
  注意:此字段可能返回 null,表示取不到有效值。
2961
2317
  */
2962
- ErrorMsg: string;
2318
+ Idcard: string;
2963
2319
  /**
2964
- * 视频流中采集的最佳人脸照片临时地址,下载有效时间10分钟,如果需要存储请及时下载。
2320
+ * 参与本次活体一比一的姓名。
2965
2321
  注意:此字段可能返回 null,表示取不到有效值。
2966
2322
  */
2967
- VideoBestFrameUrl: string;
2323
+ Name: string;
2968
2324
  /**
2969
- * 视频流中采集的最佳人脸照片内容MD5散列值,可以使用此值校验文件内容是否一致。
2325
+ * 本次活体一比一的相似度。
2970
2326
  注意:此字段可能返回 null,表示取不到有效值。
2971
2327
  */
2972
- VideoBestFrameMd5: string;
2328
+ Sim: string;
2973
2329
  /**
2974
- * 本次核验流程的详细信息列表。
2330
+ * 本次活体一比一是否收费
2975
2331
  注意:此字段可能返回 null,表示取不到有效值。
2976
2332
  */
2977
- VerificationDetailList: Array<VerificationDetail>;
2333
+ IsNeedCharge: boolean;
2978
2334
  /**
2979
- * 视频流中采集的视频临时地址,下载有效时间10分钟,如果需要存储请及时下载。
2335
+ * 本次活体一比一最终结果。0为成功
2980
2336
  注意:此字段可能返回 null,表示取不到有效值。
2981
2337
  */
2982
- VideoUrl: string;
2338
+ Errcode: number;
2983
2339
  /**
2984
- * 视频流中采集的视频内容MD5散列值,可以使用此值校验文件内容是否一致。
2340
+ * 本次活体一比一最终结果描述。(仅描述用,文案更新时不会通知。)
2985
2341
  注意:此字段可能返回 null,表示取不到有效值。
2986
2342
  */
2987
- VideoMd5: string;
2343
+ Errmsg: string;
2988
2344
  /**
2989
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2345
+ * 本次活体结果。0为成功
2346
+ 注意:此字段可能返回 null,表示取不到有效值。
2990
2347
  */
2991
- RequestId?: string;
2992
- }
2993
- /**
2994
- * GetSdkVerificationResult请求参数结构体
2995
- */
2996
- export interface GetSdkVerificationResultRequest {
2348
+ Livestatus: number;
2997
2349
  /**
2998
- * 标识一次Sdk核验流程的令牌。
2350
+ * 本次活体结果描述。(仅描述用,文案更新时不会通知。)
2351
+ 注意:此字段可能返回 null,表示取不到有效值。
2999
2352
  */
3000
- SdkToken: string;
3001
- }
3002
- /**
3003
- * ApplyLivenessToken请求参数结构体
3004
- */
3005
- export interface ApplyLivenessTokenRequest {
2353
+ Livemsg: string;
3006
2354
  /**
3007
- * 枚举值,取值范围:1、2、3、4
3008
- 各个含义如下
3009
- 1-静默
3010
- 2-眨眼
3011
- 3-光线
3012
- 4-眨眼+光线 (默认)
2355
+ * 本次一比一结果。0为成功
2356
+ 注意:此字段可能返回 null,表示取不到有效值。
3013
2357
  */
3014
- SecureLevel?: string;
3015
- }
3016
- /**
3017
- * GetActionSequence请求参数结构体
3018
- */
3019
- export interface GetActionSequenceRequest {
2358
+ Comparestatus: number;
3020
2359
  /**
3021
- * 默认不需要使用
2360
+ * 本次一比一结果描述。(仅描述用,文案更新时不会通知。)
2361
+ 注意:此字段可能返回 null,表示取不到有效值。
3022
2362
  */
3023
- ActionType?: string;
3024
- }
3025
- /**
3026
- * GetLiveCode返回参数结构体
3027
- */
3028
- export interface GetLiveCodeResponse {
2363
+ Comparemsg: string;
3029
2364
  /**
3030
- * 数字验证码,如:1234
2365
+ * 比对库源类型。包括:
2366
+ 公安商业库;
2367
+ 业务方自有库(用户上传照片、客户的混合库、混合部署库);
2368
+ 二次验证库;
2369
+ 人工审核库;
2370
+ 注意:此字段可能返回 null,表示取不到有效值。
3031
2371
  */
3032
- LiveCode?: string;
2372
+ CompareLibType: string;
3033
2373
  /**
3034
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2374
+ * 枚举活体检测类型:
2375
+ 0:未知
2376
+ 1:数字活体
2377
+ 2:动作活体
2378
+ 3:静默活体
2379
+ 4:一闪活体(动作+光线)
2380
+ 注意:此字段可能返回 null,表示取不到有效值。
3035
2381
  */
3036
- RequestId?: string;
2382
+ LivenessMode: number;
3037
2383
  }
3038
2384
  /**
3039
- * GetDetectInfo请求参数结构体
2385
+ * GetFaceIdResult返回参数结构体
3040
2386
  */
3041
- export interface GetDetectInfoRequest {
2387
+ export interface GetFaceIdResultResponse {
3042
2388
  /**
3043
- * 人脸核身流程的标识,调用DetectAuth接口时生成。
2389
+ * 身份证
3044
2390
  */
3045
- BizToken: string;
2391
+ IdCard: string;
3046
2392
  /**
3047
- * 用于细分客户使用场景,申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。如有疑问,请加慧眼小助手微信(faceid001)进行咨询。
2393
+ * 姓名
3048
2394
  */
3049
- RuleId: string;
2395
+ Name: string;
3050
2396
  /**
3051
- * 指定拉取的结果信息,取值(0:全部;1:文本类;2:身份证正反面;3:视频最佳截图照片;4:视频)。
3052
- 如 134表示拉取文本类、视频最佳截图照片、视频。
3053
- 默认值:0
2397
+ * 业务核验结果,参考https://cloud.tencent.com/document/product/1007/47912
3054
2398
  */
3055
- InfoType?: string;
3056
- }
3057
- /**
3058
- * 核身身份证图片信息
3059
- */
3060
- export interface DetectInfoIdCardData {
2399
+ Result: string;
3061
2400
  /**
3062
- * OCR正面照片的base64编码。
3063
- 注意:此字段可能返回 null,表示取不到有效值。
2401
+ * 业务核验描述
3064
2402
  */
3065
- OcrFront: string;
2403
+ Description: string;
3066
2404
  /**
3067
- * OCR反面照片的base64编码
3068
- 注意:此字段可能返回 null,表示取不到有效值。
2405
+ * 相似度,0-100,数值越大相似度越高
3069
2406
  */
3070
- OcrBack: string;
2407
+ Similarity: number;
3071
2408
  /**
3072
- * 旋转裁边后的正面照片base64编码。
2409
+ * 用户核验的视频base64,如果选择了使用cos,返回完整cos地址如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey
3073
2410
  注意:此字段可能返回 null,表示取不到有效值。
3074
2411
  */
3075
- ProcessedFrontImage: string;
2412
+ VideoBase64: string;
3076
2413
  /**
3077
- * 旋转裁边后的背面照片base64编码。
2414
+ * 用户核验视频的截帧base64,如果选择了使用cos,返回完整cos地址如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey
3078
2415
  注意:此字段可能返回 null,表示取不到有效值。
3079
2416
  */
3080
- ProcessedBackImage: string;
2417
+ BestFrameBase64: string;
3081
2418
  /**
3082
- * 身份证正面人像图base64编码。
2419
+ * 获取token时透传的信息
3083
2420
  注意:此字段可能返回 null,表示取不到有效值。
3084
2421
  */
3085
- Avatar: string;
2422
+ Extra: string;
3086
2423
  /**
3087
- * 身份证人像面告警码,开启身份证告警功能后才会返回,返回数组中可能出现的告警码如下:
3088
- -9100 身份证有效日期不合法告警,
3089
- -9101 身份证边框不完整告警,
3090
- -9102 身份证复印件告警,
3091
- -9103 身份证翻拍告警,
3092
- -9105 身份证框内遮挡告警,
3093
- -9104 临时身份证告警,
3094
- -9106 身份证 PS 告警,
3095
- -9107 身份证反光告警。
2424
+ * 设备风险标签,仅错误码返回1007(设备疑似被劫持)时返回风险标签。标签说明:
2425
+ 202、5001:设备疑似被Root
2426
+ 203、5004:设备疑似被注入
2427
+ 205:设备疑似被Hook
2428
+ 206:设备疑似虚拟运行环境
2429
+ 5007、1005:设备疑似摄像头被劫持
2430
+ 8000:设备疑似存在异常篡改行为
3096
2431
  注意:此字段可能返回 null,表示取不到有效值。
3097
2432
  */
3098
- WarnInfos: Array<number>;
2433
+ DeviceInfoTag: string;
3099
2434
  /**
3100
- * 身份证国徽面告警码,开启身份证告警功能后才会返回,返回数组中可能出现的告警码如下:
3101
- -9100 身份证有效日期不合法告警,
3102
- -9101 身份证边框不完整告警,
3103
- -9102 身份证复印件告警,
3104
- -9103 身份证翻拍告警,
3105
- -9105 身份证框内遮挡告警,
3106
- -9104 临时身份证告警,
3107
- -9106 身份证 PS 告警,
3108
- -9107 身份证反光告警。
2435
+ * 行为风险标签,仅错误码返回1007(设备疑似被劫持)时返回风险标签。标签说明:
2436
+ 02:攻击风险
3109
2437
  注意:此字段可能返回 null,表示取不到有效值。
3110
2438
  */
3111
- BackWarnInfos: Array<number>;
2439
+ RiskInfoTag: string;
2440
+ /**
2441
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2442
+ */
2443
+ RequestId?: string;
3112
2444
  }
3113
2445
  /**
3114
- * CheckPhoneAndName请求参数结构体
2446
+ * EncryptedPhoneVerification请求参数结构体
3115
2447
  */
3116
- export interface CheckPhoneAndNameRequest {
2448
+ export interface EncryptedPhoneVerificationRequest {
3117
2449
  /**
3118
- * ⼿机号
2450
+ * 身份证号,加密方式以EncryptionMode为准
3119
2451
  */
3120
- Mobile: string;
2452
+ IdCard: string;
3121
2453
  /**
3122
- * 姓名
2454
+ * 姓名,加密方式以EncryptionMode为准
3123
2455
  */
3124
2456
  Name: string;
3125
2457
  /**
3126
- * 敏感数据加密信息。对传入信息(姓名、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2458
+ * 手机号,加密方式以EncryptionMode为准
3127
2459
  */
3128
- Encryption?: Encryption;
2460
+ Phone: string;
2461
+ /**
2462
+ * 敏感信息的加密方式,目前支持明文、MD5和SHA256加密传输,参数取值:
2463
+
2464
+ 0:明文,不加密
2465
+ 1: 使用MD5加密
2466
+ 2: 使用SHA256
2467
+ */
2468
+ EncryptionMode: string;
3129
2469
  }
3130
2470
  /**
3131
- * GetEidToken返回参数结构体
2471
+ * GetRealNameAuthResult返回参数结构体
3132
2472
  */
3133
- export interface GetEidTokenResponse {
3134
- /**
3135
- * 一次核身流程的标识,有效时间为600秒;
3136
- 完成核身后,可用该标识获取验证结果信息。
3137
- */
3138
- EidToken: string;
2473
+ export interface GetRealNameAuthResultResponse {
3139
2474
  /**
3140
- * 发起核身流程的URL,用于H5场景核身。
2475
+ * 认证结果码,收费情况如下:
2476
+
2477
+ 收费码:
2478
+ 0: 姓名和身份证号一致
2479
+ -1: 姓名和身份证号不一致
2480
+ -2: 姓名和微信实名姓名不一致
2481
+
2482
+ 不收费码:
2483
+ -3: 微信号未实名
3141
2484
  */
3142
- Url: string;
2485
+ ResultType?: string;
3143
2486
  /**
3144
2487
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3145
2488
  */
@@ -3158,3 +2501,29 @@ export interface IntentionQuestion {
3158
2501
  */
3159
2502
  Answers: Array<string>;
3160
2503
  }
2504
+ /**
2505
+ * EncryptedPhoneVerification返回参数结构体
2506
+ */
2507
+ export interface EncryptedPhoneVerificationResponse {
2508
+ /**
2509
+ * 认证结果码:
2510
+ 【收费结果码】
2511
+ 0: 三要素信息一致
2512
+ -4: 三要素信息不一致
2513
+
2514
+ 【不收费结果码】
2515
+ -7: 身份证号码有误
2516
+ -8: 参数错误
2517
+ -9: 没有记录
2518
+ -11: 验证中心服务繁忙
2519
+ */
2520
+ Result: string;
2521
+ /**
2522
+ * 业务结果描述。
2523
+ */
2524
+ Description: string;
2525
+ /**
2526
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2527
+ */
2528
+ RequestId?: string;
2529
+ }