tencentcloud-sdk-nodejs-faceid 4.0.617 → 4.0.619
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +556 -0
- package/SERVICE_CHANGELOG.md +677 -22
- package/package.json +1 -1
- package/products.md +33 -33
- package/src/services/faceid/v20180301/faceid_models.ts +366 -692
- package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +366 -366
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export interface DetectInfoVideoData {
|
|
5
5
|
/**
|
|
6
|
-
|
|
6
|
+
* 活体视频的base64编码
|
|
7
7
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
8
|
-
|
|
8
|
+
*/
|
|
9
9
|
LivenessVideo: string;
|
|
10
10
|
}
|
|
11
11
|
/**
|
|
@@ -21,10 +21,10 @@ export interface GetDetectInfoEnhancedRequest {
|
|
|
21
21
|
*/
|
|
22
22
|
RuleId: string;
|
|
23
23
|
/**
|
|
24
|
-
|
|
24
|
+
* 指定拉取的结果信息,取值(0:全部;1:文本类;2:身份证信息;3:视频最佳截图信息)。
|
|
25
25
|
如 13表示拉取文本类、视频最佳截图信息。
|
|
26
26
|
默认值:0
|
|
27
|
-
|
|
27
|
+
*/
|
|
28
28
|
InfoType?: string;
|
|
29
29
|
/**
|
|
30
30
|
* 从活体视频中截取一定张数的最佳帧(仅部分服务支持,若需使用请与慧眼小助手沟通)。默认为0,最大为10,超出10的最多只给10张。(InfoType需要包含3)
|
|
@@ -64,9 +64,9 @@ export interface GetFaceIdTokenRequest {
|
|
|
64
64
|
*/
|
|
65
65
|
Name?: string;
|
|
66
66
|
/**
|
|
67
|
-
|
|
67
|
+
* CompareLib为上传照片比对时必传,Base64后图片最大8MB。
|
|
68
68
|
请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
|
|
69
|
-
|
|
69
|
+
*/
|
|
70
70
|
ImageBase64?: string;
|
|
71
71
|
/**
|
|
72
72
|
* SDK中生成的Meta字符串
|
|
@@ -77,9 +77,9 @@ export interface GetFaceIdTokenRequest {
|
|
|
77
77
|
*/
|
|
78
78
|
Extra?: string;
|
|
79
79
|
/**
|
|
80
|
-
|
|
80
|
+
* 默认为false,设置该参数为true后,核身过程中的视频图片将会存储在人脸核身控制台授权cos的bucket中,拉取结果时会返回对应资源完整cos地址。开通地址见https://console.cloud.tencent.com/faceid/cos
|
|
81
81
|
【注意】选择该参数为true后将不返回base64数据,请根据接入情况谨慎修改。
|
|
82
|
-
|
|
82
|
+
*/
|
|
83
83
|
UseCos?: boolean;
|
|
84
84
|
/**
|
|
85
85
|
* 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
|
|
@@ -91,27 +91,27 @@ export interface GetFaceIdTokenRequest {
|
|
|
91
91
|
*/
|
|
92
92
|
export interface LivenessRequest {
|
|
93
93
|
/**
|
|
94
|
-
|
|
94
|
+
* 用于活体检测的视频,视频的BASE64值;
|
|
95
95
|
BASE64编码后的大小不超过8M,支持mp4、avi、flv格式。
|
|
96
|
-
|
|
96
|
+
*/
|
|
97
97
|
VideoBase64: string;
|
|
98
98
|
/**
|
|
99
|
-
|
|
99
|
+
* 活体检测类型,取值:LIP/ACTION/SILENT。
|
|
100
100
|
LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。
|
|
101
|
-
|
|
101
|
+
*/
|
|
102
102
|
LivenessType: string;
|
|
103
103
|
/**
|
|
104
|
-
|
|
104
|
+
* 数字模式传参:数字验证码(1234),需先调用接口获取数字验证码;
|
|
105
105
|
动作模式传参:传动作顺序(2,1 or 1,2),需先调用接口获取动作顺序;
|
|
106
106
|
静默模式传参:不需要传递此参数。
|
|
107
|
-
|
|
107
|
+
*/
|
|
108
108
|
ValidateData?: string;
|
|
109
109
|
/**
|
|
110
|
-
|
|
110
|
+
* 额外配置,传入JSON字符串。
|
|
111
111
|
{
|
|
112
112
|
"BestFrameNum": 2 //需要返回多张最佳截图,取值范围1-10
|
|
113
113
|
}
|
|
114
|
-
|
|
114
|
+
*/
|
|
115
115
|
Optional?: string;
|
|
116
116
|
}
|
|
117
117
|
/**
|
|
@@ -166,7 +166,7 @@ export interface CheckBankCardInformationRequest {
|
|
|
166
166
|
*/
|
|
167
167
|
export interface MobileNetworkTimeVerificationResponse {
|
|
168
168
|
/**
|
|
169
|
-
|
|
169
|
+
* 认证结果码,收费情况如下。
|
|
170
170
|
收费结果码:
|
|
171
171
|
0: 成功
|
|
172
172
|
-2: 手机号不存在
|
|
@@ -174,16 +174,16 @@ export interface MobileNetworkTimeVerificationResponse {
|
|
|
174
174
|
不收费结果码:
|
|
175
175
|
-1: 手机号格式不正确
|
|
176
176
|
-4: 验证中心服务繁忙
|
|
177
|
-
|
|
177
|
+
*/
|
|
178
178
|
Result: string;
|
|
179
179
|
/**
|
|
180
180
|
* 业务结果描述。
|
|
181
181
|
*/
|
|
182
182
|
Description: string;
|
|
183
183
|
/**
|
|
184
|
-
|
|
184
|
+
* 在网时长区间。
|
|
185
185
|
格式为(a,b],表示在网时长在a个月以上,b个月以下。若b为+时表示没有上限。
|
|
186
|
-
|
|
186
|
+
*/
|
|
187
187
|
Range: string;
|
|
188
188
|
/**
|
|
189
189
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -199,7 +199,7 @@ export declare type GetLiveCodeRequest = null;
|
|
|
199
199
|
*/
|
|
200
200
|
export interface CheckIdNameDateResponse {
|
|
201
201
|
/**
|
|
202
|
-
|
|
202
|
+
* 认证结果码,收费情况如下。
|
|
203
203
|
收费结果码:
|
|
204
204
|
0: 一致
|
|
205
205
|
-1: 不一致
|
|
@@ -210,7 +210,7 @@ export interface CheckIdNameDateResponse {
|
|
|
210
210
|
-5: 身份信息无效
|
|
211
211
|
-6: 证件库服务异常
|
|
212
212
|
-7: 证件库中无此身份证记录
|
|
213
|
-
|
|
213
|
+
*/
|
|
214
214
|
Result: string;
|
|
215
215
|
/**
|
|
216
216
|
* 业务结果描述。
|
|
@@ -255,9 +255,9 @@ export interface BankCardVerificationRequest {
|
|
|
255
255
|
*/
|
|
256
256
|
BankCard: string;
|
|
257
257
|
/**
|
|
258
|
-
|
|
258
|
+
* 证件类型,请确认该证件为开户时使用的证件类型,未用于开户的证件信息不支持验证。
|
|
259
259
|
目前默认:0 身份证,其他证件类型需求可以添加[腾讯云人脸核身小助手](https://cloud.tencent.com/document/product/1007/56130)进行确认。
|
|
260
|
-
|
|
260
|
+
*/
|
|
261
261
|
CertType?: number;
|
|
262
262
|
/**
|
|
263
263
|
* 敏感数据加密信息。对传入信息(姓名、身份证号、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
|
|
@@ -269,14 +269,14 @@ export interface BankCardVerificationRequest {
|
|
|
269
269
|
*/
|
|
270
270
|
export interface CheckBankCardInformationResponse {
|
|
271
271
|
/**
|
|
272
|
-
|
|
272
|
+
* 认证结果码,收费情况如下。
|
|
273
273
|
收费结果码:
|
|
274
274
|
0: 查询成功
|
|
275
275
|
-1: 未查到信息
|
|
276
276
|
不收费结果码:
|
|
277
277
|
-2:验证中心服务繁忙
|
|
278
278
|
-3:银行卡不存在
|
|
279
|
-
|
|
279
|
+
*/
|
|
280
280
|
Result?: string;
|
|
281
281
|
/**
|
|
282
282
|
* 业务结果描述
|
|
@@ -300,14 +300,14 @@ export interface CheckBankCardInformationResponse {
|
|
|
300
300
|
*/
|
|
301
301
|
export interface DetectInfoBestFrame {
|
|
302
302
|
/**
|
|
303
|
-
|
|
303
|
+
* 活体比对最佳帧Base64编码。
|
|
304
304
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
305
|
-
|
|
305
|
+
*/
|
|
306
306
|
BestFrame: string;
|
|
307
307
|
/**
|
|
308
|
-
|
|
308
|
+
* 自截帧Base64编码数组。
|
|
309
309
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
310
|
-
|
|
310
|
+
*/
|
|
311
311
|
BestFrames: Array<string>;
|
|
312
312
|
}
|
|
313
313
|
/**
|
|
@@ -336,14 +336,14 @@ export interface WeChatBillDetail {
|
|
|
336
336
|
*/
|
|
337
337
|
export interface GetEidTokenConfig {
|
|
338
338
|
/**
|
|
339
|
-
|
|
339
|
+
* 姓名身份证输入方式。
|
|
340
340
|
1:传身份证正反面OCR
|
|
341
341
|
2:传身份证正面OCR
|
|
342
342
|
3:用户手动输入
|
|
343
343
|
4:客户后台传入
|
|
344
344
|
默认1
|
|
345
345
|
注:使用OCR时仅支持用户修改结果中的姓名
|
|
346
|
-
|
|
346
|
+
*/
|
|
347
347
|
InputType?: string;
|
|
348
348
|
/**
|
|
349
349
|
* 是否使用意愿核身,默认不使用。注意:如开启使用,则计费标签按【意愿核身】计费标签计价;如不开启,则计费标签按【E证通】计费标签计价,价格详见:[价格说明](https://cloud.tencent.com/document/product/1007/56804)。
|
|
@@ -415,7 +415,7 @@ export interface CheckIdCardInformationResponse {
|
|
|
415
415
|
*/
|
|
416
416
|
Portrait: string;
|
|
417
417
|
/**
|
|
418
|
-
|
|
418
|
+
* 告警信息,当在Config中配置了告警信息会停止人像比对,Result返回错误(FailedOperation.OcrWarningOccurred)并有此告警信息,Code 告警码列表和释义:
|
|
419
419
|
|
|
420
420
|
-9101 身份证边框不完整告警,
|
|
421
421
|
-9102 身份证复印件告警,
|
|
@@ -425,16 +425,16 @@ export interface CheckIdCardInformationResponse {
|
|
|
425
425
|
-9106 身份证 PS 告警。
|
|
426
426
|
-8001 图片模糊告警
|
|
427
427
|
多个会 | 隔开如 "-9101|-9106|-9104"
|
|
428
|
-
|
|
428
|
+
*/
|
|
429
429
|
Warnings: string;
|
|
430
430
|
/**
|
|
431
431
|
* 图片质量分数,当请求Config中配置图片模糊告警该参数才有意义,取值范围(0~100),目前默认阈值是50分,低于50分会触发模糊告警。
|
|
432
432
|
*/
|
|
433
433
|
Quality: number;
|
|
434
434
|
/**
|
|
435
|
-
|
|
435
|
+
* 敏感数据加密信息。
|
|
436
436
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
437
|
-
|
|
437
|
+
*/
|
|
438
438
|
Encryption: Encryption;
|
|
439
439
|
/**
|
|
440
440
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -446,39 +446,39 @@ export interface CheckIdCardInformationResponse {
|
|
|
446
446
|
*/
|
|
447
447
|
export interface GetDetectInfoEnhancedResponse {
|
|
448
448
|
/**
|
|
449
|
-
|
|
449
|
+
* 文本类信息。
|
|
450
450
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
451
|
-
|
|
451
|
+
*/
|
|
452
452
|
Text: DetectInfoText;
|
|
453
453
|
/**
|
|
454
|
-
|
|
454
|
+
* 身份证照片信息。
|
|
455
455
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
456
|
-
|
|
456
|
+
*/
|
|
457
457
|
IdCardData: DetectInfoIdCardData;
|
|
458
458
|
/**
|
|
459
|
-
|
|
459
|
+
* 最佳帧信息。
|
|
460
460
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
461
|
-
|
|
461
|
+
*/
|
|
462
462
|
BestFrame: DetectInfoBestFrame;
|
|
463
463
|
/**
|
|
464
|
-
|
|
464
|
+
* 视频信息。
|
|
465
465
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
466
|
-
|
|
466
|
+
*/
|
|
467
467
|
VideoData: DetectInfoVideoData;
|
|
468
468
|
/**
|
|
469
|
-
|
|
469
|
+
* 敏感数据加密信息。
|
|
470
470
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
471
|
-
|
|
471
|
+
*/
|
|
472
472
|
Encryption: Encryption;
|
|
473
473
|
/**
|
|
474
|
-
|
|
474
|
+
* 意愿核身相关信息。若未使用意愿核身功能,该字段返回值可以不处理。
|
|
475
475
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
476
|
-
|
|
476
|
+
*/
|
|
477
477
|
IntentionVerifyData: IntentionVerifyData;
|
|
478
478
|
/**
|
|
479
|
-
|
|
479
|
+
* 意愿核身问答模式结果。若未使用该意愿核身功能,该字段返回值可以不处理。
|
|
480
480
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
481
|
-
|
|
481
|
+
*/
|
|
482
482
|
IntentionQuestionResult: IntentionQuestionResult;
|
|
483
483
|
/**
|
|
484
484
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -544,10 +544,10 @@ export interface GetEidResultRequest {
|
|
|
544
544
|
*/
|
|
545
545
|
EidToken: string;
|
|
546
546
|
/**
|
|
547
|
-
|
|
547
|
+
* 指定拉取的结果信息,取值(0:全部;1:文本类;2:身份证信息;3:最佳截图信息;5:意愿核身朗读模式相关结果;6:意愿核身问答模式相关结果)。
|
|
548
548
|
如 13表示拉取文本类、最佳截图信息。
|
|
549
549
|
默认值:0
|
|
550
|
-
|
|
550
|
+
*/
|
|
551
551
|
InfoType?: string;
|
|
552
552
|
/**
|
|
553
553
|
* 从活体视频中截取一定张数的最佳帧。默认为0,最大为3,超出3的最多只给3张。(InfoType需要包含3)
|
|
@@ -563,9 +563,9 @@ export interface DetectAuthResponse {
|
|
|
563
563
|
*/
|
|
564
564
|
Url: string;
|
|
565
565
|
/**
|
|
566
|
-
|
|
566
|
+
* 一次核身流程的标识,有效时间为7,200秒;
|
|
567
567
|
完成核身后,可用该标识获取验证结果信息。
|
|
568
|
-
|
|
568
|
+
*/
|
|
569
569
|
BizToken: string;
|
|
570
570
|
/**
|
|
571
571
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -577,7 +577,7 @@ export interface DetectAuthResponse {
|
|
|
577
577
|
*/
|
|
578
578
|
export interface PhoneVerificationResponse {
|
|
579
579
|
/**
|
|
580
|
-
|
|
580
|
+
* 认证结果码:
|
|
581
581
|
收费结果码
|
|
582
582
|
0: 三要素信息一致
|
|
583
583
|
-4: 三要素信息不一致
|
|
@@ -587,16 +587,16 @@ export interface PhoneVerificationResponse {
|
|
|
587
587
|
-8: 姓名校验不通过
|
|
588
588
|
-9: 没有记录
|
|
589
589
|
-11: 验证中心服务繁忙
|
|
590
|
-
|
|
590
|
+
*/
|
|
591
591
|
Result: string;
|
|
592
592
|
/**
|
|
593
593
|
* 业务结果描述。
|
|
594
594
|
*/
|
|
595
595
|
Description: string;
|
|
596
596
|
/**
|
|
597
|
-
|
|
597
|
+
* 运营商名称。
|
|
598
598
|
取值范围为["","移动","电信","联通"]
|
|
599
|
-
|
|
599
|
+
*/
|
|
600
600
|
Isp: string;
|
|
601
601
|
/**
|
|
602
602
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -612,9 +612,9 @@ export interface GetEidTokenRequest {
|
|
|
612
612
|
*/
|
|
613
613
|
MerchantId: string;
|
|
614
614
|
/**
|
|
615
|
-
|
|
615
|
+
* 身份标识(未使用OCR服务时,必须传入)。
|
|
616
616
|
规则:a-zA-Z0-9组合。最长长度32位。
|
|
617
|
-
|
|
617
|
+
*/
|
|
618
618
|
IdCard?: string;
|
|
619
619
|
/**
|
|
620
620
|
* 姓名。(未使用OCR服务时,必须传入)最长长度32位。中文请使用UTF-8编码。
|
|
@@ -642,7 +642,7 @@ export interface GetEidTokenRequest {
|
|
|
642
642
|
*/
|
|
643
643
|
export interface IntentionQuestionResult {
|
|
644
644
|
/**
|
|
645
|
-
|
|
645
|
+
* 意愿核身错误码:
|
|
646
646
|
0: "成功"
|
|
647
647
|
-1: "参数错误"
|
|
648
648
|
-2: "系统异常"
|
|
@@ -663,44 +663,44 @@ export interface IntentionQuestionResult {
|
|
|
663
663
|
-998: "系统数据异常"
|
|
664
664
|
-999: "系统未知错误,请联系人工核实"
|
|
665
665
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
666
|
-
|
|
666
|
+
*/
|
|
667
667
|
FinalResultDetailCode?: number;
|
|
668
668
|
/**
|
|
669
|
-
|
|
669
|
+
* 意愿核身错误信息
|
|
670
670
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
671
|
-
|
|
671
|
+
*/
|
|
672
672
|
FinalResultMessage?: string;
|
|
673
673
|
/**
|
|
674
|
-
|
|
674
|
+
* 视频base64(其中包含全程问题和回答音频,mp4格式)
|
|
675
675
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
676
|
-
|
|
676
|
+
*/
|
|
677
677
|
Video: string;
|
|
678
678
|
/**
|
|
679
|
-
|
|
679
|
+
* 屏幕截图base64列表
|
|
680
680
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
681
|
-
|
|
681
|
+
*/
|
|
682
682
|
ScreenShot: Array<string>;
|
|
683
683
|
/**
|
|
684
|
-
|
|
684
|
+
* 和答案匹配结果列表
|
|
685
685
|
0:成功,-1:不匹配
|
|
686
686
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
687
|
-
|
|
687
|
+
*/
|
|
688
688
|
ResultCode: Array<string>;
|
|
689
689
|
/**
|
|
690
|
-
|
|
690
|
+
* 回答问题语音识别结果列表
|
|
691
691
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
692
|
-
|
|
692
|
+
*/
|
|
693
693
|
AsrResult: Array<string>;
|
|
694
694
|
/**
|
|
695
|
-
|
|
695
|
+
* 答案录音音频
|
|
696
696
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
697
|
-
|
|
697
|
+
*/
|
|
698
698
|
Audios: Array<string>;
|
|
699
699
|
/**
|
|
700
|
-
|
|
700
|
+
* 意愿核身最终结果:
|
|
701
701
|
0:认证通过,-1:认证未通过,-2:浏览器内核不兼容,无法进行意愿校验。建议使用“FinalResultDetailCode”参数获取详细的错误码信息。
|
|
702
702
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
703
|
-
|
|
703
|
+
*/
|
|
704
704
|
FinalResultCode: string;
|
|
705
705
|
}
|
|
706
706
|
/**
|
|
@@ -729,7 +729,7 @@ export interface GetWeChatBillDetailsResponse {
|
|
|
729
729
|
*/
|
|
730
730
|
export interface CheckPhoneAndNameResponse {
|
|
731
731
|
/**
|
|
732
|
-
|
|
732
|
+
* 认证结果码,收费情况如下。
|
|
733
733
|
收费结果码:
|
|
734
734
|
0: 验证结果一致
|
|
735
735
|
1: 验证结果不一致
|
|
@@ -737,7 +737,7 @@ export interface CheckPhoneAndNameResponse {
|
|
|
737
737
|
-1:查无记录
|
|
738
738
|
-2:引擎未知错误
|
|
739
739
|
-3:引擎服务异常
|
|
740
|
-
|
|
740
|
+
*/
|
|
741
741
|
Result: string;
|
|
742
742
|
/**
|
|
743
743
|
* 业务结果描述
|
|
@@ -753,7 +753,7 @@ export interface CheckPhoneAndNameResponse {
|
|
|
753
753
|
*/
|
|
754
754
|
export interface BankCard4EVerificationResponse {
|
|
755
755
|
/**
|
|
756
|
-
|
|
756
|
+
* 认证结果码
|
|
757
757
|
收费结果码:
|
|
758
758
|
'0': '认证通过'
|
|
759
759
|
'-1': '认证未通过'
|
|
@@ -775,7 +775,7 @@ export interface BankCard4EVerificationResponse {
|
|
|
775
775
|
'-4': '银行卡号码有误'
|
|
776
776
|
'-5': '手机号码不合法'
|
|
777
777
|
'-18': '验证中心服务繁忙'
|
|
778
|
-
|
|
778
|
+
*/
|
|
779
779
|
Result: string;
|
|
780
780
|
/**
|
|
781
781
|
* 业务结果描述。
|
|
@@ -804,27 +804,27 @@ export interface MobileStatusRequest {
|
|
|
804
804
|
*/
|
|
805
805
|
export interface IdCardOCRVerificationRequest {
|
|
806
806
|
/**
|
|
807
|
-
|
|
807
|
+
* 身份证号
|
|
808
808
|
姓名和身份证号、ImageBase64、ImageUrl三者必须提供其中之一。若都提供了,则按照姓名和身份证号>ImageBase64>ImageUrl的优先级使用参数。
|
|
809
|
-
|
|
809
|
+
*/
|
|
810
810
|
IdCard?: string;
|
|
811
811
|
/**
|
|
812
812
|
* 姓名
|
|
813
813
|
*/
|
|
814
814
|
Name?: string;
|
|
815
815
|
/**
|
|
816
|
-
|
|
816
|
+
* 身份证人像面的 Base64 值
|
|
817
817
|
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
|
|
818
818
|
支持的图片大小:所下载图片经Base64编码后不超过 3M。请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
|
|
819
|
-
|
|
819
|
+
*/
|
|
820
820
|
ImageBase64?: string;
|
|
821
821
|
/**
|
|
822
|
-
|
|
822
|
+
* 身份证人像面的 Url 地址
|
|
823
823
|
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
|
|
824
824
|
支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。
|
|
825
825
|
图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
|
|
826
826
|
非腾讯云存储的 Url 速度和稳定性可能受一定影响。
|
|
827
|
-
|
|
827
|
+
*/
|
|
828
828
|
ImageUrl?: string;
|
|
829
829
|
/**
|
|
830
830
|
* 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
|
|
@@ -836,9 +836,9 @@ export interface IdCardOCRVerificationRequest {
|
|
|
836
836
|
*/
|
|
837
837
|
export interface LivenessRecognitionResponse {
|
|
838
838
|
/**
|
|
839
|
-
|
|
839
|
+
* 验证通过后的视频最佳截图照片,照片为BASE64编码后的值,jpg格式。
|
|
840
840
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
841
|
-
|
|
841
|
+
*/
|
|
842
842
|
BestFrameBase64: string;
|
|
843
843
|
/**
|
|
844
844
|
* 相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
|
|
@@ -853,9 +853,9 @@ export interface LivenessRecognitionResponse {
|
|
|
853
853
|
*/
|
|
854
854
|
Description: string;
|
|
855
855
|
/**
|
|
856
|
-
|
|
856
|
+
* 最佳截图列表,仅在配置了返回多张最佳截图时返回。
|
|
857
857
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
858
|
-
|
|
858
|
+
*/
|
|
859
859
|
BestFrameList: Array<string>;
|
|
860
860
|
/**
|
|
861
861
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -867,106 +867,106 @@ export interface LivenessRecognitionResponse {
|
|
|
867
867
|
*/
|
|
868
868
|
export interface ParseNfcDataResponse {
|
|
869
869
|
/**
|
|
870
|
-
|
|
870
|
+
* 0为首次查询成功,-1为查询失败。
|
|
871
871
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
872
|
-
|
|
872
|
+
*/
|
|
873
873
|
ResultCode: string;
|
|
874
874
|
/**
|
|
875
|
-
|
|
875
|
+
* 身份证号
|
|
876
876
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
877
|
-
|
|
877
|
+
*/
|
|
878
878
|
IdNum: string;
|
|
879
879
|
/**
|
|
880
|
-
|
|
880
|
+
* 姓名
|
|
881
881
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
882
|
-
|
|
882
|
+
*/
|
|
883
883
|
Name: string;
|
|
884
884
|
/**
|
|
885
|
-
|
|
885
|
+
* 照片
|
|
886
886
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
887
|
-
|
|
887
|
+
*/
|
|
888
888
|
Picture: string;
|
|
889
889
|
/**
|
|
890
|
-
|
|
890
|
+
* 出生日期
|
|
891
891
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
892
|
-
|
|
892
|
+
*/
|
|
893
893
|
BirthDate: string;
|
|
894
894
|
/**
|
|
895
|
-
|
|
895
|
+
* 有效期起始时间
|
|
896
896
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
897
|
-
|
|
897
|
+
*/
|
|
898
898
|
BeginTime: string;
|
|
899
899
|
/**
|
|
900
|
-
|
|
900
|
+
* 有效期结束时间
|
|
901
901
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
902
|
-
|
|
902
|
+
*/
|
|
903
903
|
EndTime: string;
|
|
904
904
|
/**
|
|
905
|
-
|
|
905
|
+
* 住址
|
|
906
906
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
907
|
-
|
|
907
|
+
*/
|
|
908
908
|
Address: string;
|
|
909
909
|
/**
|
|
910
|
-
|
|
910
|
+
* 民族
|
|
911
911
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
912
|
-
|
|
912
|
+
*/
|
|
913
913
|
Nation: string;
|
|
914
914
|
/**
|
|
915
|
-
|
|
915
|
+
* 性别
|
|
916
916
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
917
|
-
|
|
917
|
+
*/
|
|
918
918
|
Sex: string;
|
|
919
919
|
/**
|
|
920
|
-
|
|
920
|
+
* 身份证 01 中国护照 03 军官证 04 武警证 05 港澳通行证 06 台胞证 07 外国护照 08 士兵证 09 临时身份证 10 户口本 11 警官证 12 外国人永久居留证 13 港澳台居民居住证 14 回乡证 15 大陆居民来往台湾通行证 16 其他证件 99
|
|
921
921
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
922
|
-
|
|
922
|
+
*/
|
|
923
923
|
IdType: string;
|
|
924
924
|
/**
|
|
925
|
-
|
|
925
|
+
* 英文姓名
|
|
926
926
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
927
|
-
|
|
927
|
+
*/
|
|
928
928
|
EnName: string;
|
|
929
929
|
/**
|
|
930
|
-
|
|
930
|
+
* 签发机关
|
|
931
931
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
932
|
-
|
|
932
|
+
*/
|
|
933
933
|
SigningOrganization: string;
|
|
934
934
|
/**
|
|
935
|
-
|
|
935
|
+
* 港澳台居民居住证,通行证号码
|
|
936
936
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
937
|
-
|
|
937
|
+
*/
|
|
938
938
|
OtherIdNum: string;
|
|
939
939
|
/**
|
|
940
|
-
|
|
940
|
+
* 旅行证件国籍
|
|
941
941
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
942
|
-
|
|
942
|
+
*/
|
|
943
943
|
Nationality: string;
|
|
944
944
|
/**
|
|
945
|
-
|
|
945
|
+
* 旅行证件机读区第二行 29~42 位
|
|
946
946
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
947
|
-
|
|
947
|
+
*/
|
|
948
948
|
PersonalNumber: string;
|
|
949
949
|
/**
|
|
950
|
-
|
|
950
|
+
* 旅行证件类的核验结果。JSON格式如下:
|
|
951
951
|
{"result_issuer ":"签发者证书合法性验证结果 ","result_pape r":"证件安全对象合法性验证 结果 ","result_data" :"防数据篡改验证结果 ","result_chip" :"防证书件芯片被复制验证结果"}
|
|
952
952
|
0:验证通过,1: 验证不通过,2: 未验证,3:部分通过,当4项核验结果都为0时,表示证件为真
|
|
953
953
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
954
|
-
|
|
954
|
+
*/
|
|
955
955
|
CheckMRTD: string;
|
|
956
956
|
/**
|
|
957
|
-
|
|
957
|
+
* 身份证照片面合成图片
|
|
958
958
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
959
|
-
|
|
959
|
+
*/
|
|
960
960
|
ImageA: string;
|
|
961
961
|
/**
|
|
962
|
-
|
|
962
|
+
* 身份证国徽面合成图片
|
|
963
963
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
964
|
-
|
|
964
|
+
*/
|
|
965
965
|
ImageB: string;
|
|
966
966
|
/**
|
|
967
|
-
|
|
967
|
+
* 对result code的结果描述
|
|
968
968
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
969
|
-
|
|
969
|
+
*/
|
|
970
970
|
ResultDescription: string;
|
|
971
971
|
/**
|
|
972
972
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -1028,35 +1028,35 @@ export interface LivenessRecognitionRequest {
|
|
|
1028
1028
|
*/
|
|
1029
1029
|
Name: string;
|
|
1030
1030
|
/**
|
|
1031
|
-
|
|
1031
|
+
* 活体检测类型,取值:LIP/ACTION/SILENT。
|
|
1032
1032
|
LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。
|
|
1033
|
-
|
|
1033
|
+
*/
|
|
1034
1034
|
LivenessType: string;
|
|
1035
1035
|
/**
|
|
1036
|
-
|
|
1036
|
+
* 用于活体检测的视频,视频的BASE64值;
|
|
1037
1037
|
BASE64编码后的大小不超过8M,支持mp4、avi、flv格式。
|
|
1038
|
-
|
|
1038
|
+
*/
|
|
1039
1039
|
VideoBase64?: string;
|
|
1040
1040
|
/**
|
|
1041
|
-
|
|
1041
|
+
* 用于活体检测的视频Url 地址。视频下载后经Base64编码不超过 8M,视频下载耗时不超过4S,支持mp4、avi、flv格式。
|
|
1042
1042
|
|
|
1043
1043
|
视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
|
|
1044
1044
|
|
|
1045
1045
|
建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议视频存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
|
|
1046
|
-
|
|
1046
|
+
*/
|
|
1047
1047
|
VideoUrl?: string;
|
|
1048
1048
|
/**
|
|
1049
|
-
|
|
1049
|
+
* 数字模式传参:传数字验证码,验证码需先调用<a href="https://cloud.tencent.com/document/product/1007/31821">获取数字验证码接口</a>得到;
|
|
1050
1050
|
动作模式传参:传动作顺序,动作顺序需先调用<a href="https://cloud.tencent.com/document/product/1007/31822">获取动作顺序接口</a>得到;
|
|
1051
1051
|
静默模式传参:空。
|
|
1052
|
-
|
|
1052
|
+
*/
|
|
1053
1053
|
ValidateData?: string;
|
|
1054
1054
|
/**
|
|
1055
|
-
|
|
1055
|
+
* 额外配置,传入JSON字符串。
|
|
1056
1056
|
{
|
|
1057
1057
|
"BestFrameNum": 2 //需要返回多张最佳截图,取值范围2-10
|
|
1058
1058
|
}
|
|
1059
|
-
|
|
1059
|
+
*/
|
|
1060
1060
|
Optional?: string;
|
|
1061
1061
|
/**
|
|
1062
1062
|
* 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
|
|
@@ -1102,7 +1102,7 @@ export interface GetFaceIdTokenResponse {
|
|
|
1102
1102
|
*/
|
|
1103
1103
|
export interface PhoneVerificationCMCCResponse {
|
|
1104
1104
|
/**
|
|
1105
|
-
|
|
1105
|
+
* 认证结果码,收费情况如下。
|
|
1106
1106
|
收费结果码:
|
|
1107
1107
|
0: 认证通过
|
|
1108
1108
|
-4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)
|
|
@@ -1113,12 +1113,12 @@ export interface PhoneVerificationCMCCResponse {
|
|
|
1113
1113
|
-9: 没有记录
|
|
1114
1114
|
-10: 认证未通过
|
|
1115
1115
|
-11: 验证中心服务繁忙
|
|
1116
|
-
|
|
1116
|
+
*/
|
|
1117
1117
|
Result: string;
|
|
1118
1118
|
/**
|
|
1119
|
-
|
|
1119
|
+
* 运营商名称。
|
|
1120
1120
|
取值范围为["移动","联通","电信",""]
|
|
1121
|
-
|
|
1121
|
+
*/
|
|
1122
1122
|
Isp: string;
|
|
1123
1123
|
/**
|
|
1124
1124
|
* 业务结果描述。
|
|
@@ -1134,12 +1134,12 @@ export interface PhoneVerificationCMCCResponse {
|
|
|
1134
1134
|
*/
|
|
1135
1135
|
export interface CheckEidTokenStatusResponse {
|
|
1136
1136
|
/**
|
|
1137
|
-
|
|
1137
|
+
* 枚举:
|
|
1138
1138
|
init:token未验证
|
|
1139
1139
|
doing: 验证中
|
|
1140
1140
|
finished: 验证完成
|
|
1141
1141
|
timeout: token已超时
|
|
1142
|
-
|
|
1142
|
+
*/
|
|
1143
1143
|
Status: string;
|
|
1144
1144
|
/**
|
|
1145
1145
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -1151,7 +1151,7 @@ export interface CheckEidTokenStatusResponse {
|
|
|
1151
1151
|
*/
|
|
1152
1152
|
export interface PhoneVerificationCTCCResponse {
|
|
1153
1153
|
/**
|
|
1154
|
-
|
|
1154
|
+
* 认证结果码,收费情况如下。
|
|
1155
1155
|
收费结果码:
|
|
1156
1156
|
0: 认证通过
|
|
1157
1157
|
-4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)
|
|
@@ -1162,12 +1162,12 @@ export interface PhoneVerificationCTCCResponse {
|
|
|
1162
1162
|
-9: 没有记录
|
|
1163
1163
|
-10: 认证未通过
|
|
1164
1164
|
-11: 验证中心服务繁忙
|
|
1165
|
-
|
|
1165
|
+
*/
|
|
1166
1166
|
Result: string;
|
|
1167
1167
|
/**
|
|
1168
|
-
|
|
1168
|
+
* 运营商名称。
|
|
1169
1169
|
取值范围为["移动","联通","电信",""]
|
|
1170
|
-
|
|
1170
|
+
*/
|
|
1171
1171
|
Isp: string;
|
|
1172
1172
|
/**
|
|
1173
1173
|
* 业务结果描述。
|
|
@@ -1183,28 +1183,28 @@ export interface PhoneVerificationCTCCResponse {
|
|
|
1183
1183
|
*/
|
|
1184
1184
|
export interface MobileStatusResponse {
|
|
1185
1185
|
/**
|
|
1186
|
-
|
|
1186
|
+
* 认证结果码,收费情况如下。
|
|
1187
1187
|
收费结果码:
|
|
1188
1188
|
0:成功
|
|
1189
1189
|
不收费结果码:
|
|
1190
1190
|
-1:未查询到结果
|
|
1191
1191
|
-2:手机号格式不正确
|
|
1192
1192
|
-3:验证中心服务繁忙
|
|
1193
|
-
|
|
1193
|
+
*/
|
|
1194
1194
|
Result: string;
|
|
1195
1195
|
/**
|
|
1196
1196
|
* 业务结果描述。
|
|
1197
1197
|
*/
|
|
1198
1198
|
Description: string;
|
|
1199
1199
|
/**
|
|
1200
|
-
|
|
1200
|
+
* 状态码:
|
|
1201
1201
|
0:正常
|
|
1202
1202
|
1:停机
|
|
1203
1203
|
2:销号
|
|
1204
1204
|
3:空号
|
|
1205
1205
|
4:不在网
|
|
1206
1206
|
99:未知状态
|
|
1207
|
-
|
|
1207
|
+
*/
|
|
1208
1208
|
StatusCode: number;
|
|
1209
1209
|
/**
|
|
1210
1210
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -1237,7 +1237,7 @@ export interface PhoneVerificationCTCCRequest {
|
|
|
1237
1237
|
*/
|
|
1238
1238
|
export interface IdCardOCRVerificationResponse {
|
|
1239
1239
|
/**
|
|
1240
|
-
|
|
1240
|
+
* 认证结果码,收费情况如下。
|
|
1241
1241
|
收费结果码:
|
|
1242
1242
|
0: 姓名和身份证号一致
|
|
1243
1243
|
-1: 姓名和身份证号不一致
|
|
@@ -1248,7 +1248,7 @@ export interface IdCardOCRVerificationResponse {
|
|
|
1248
1248
|
-5: 证件库中无此身份证记录
|
|
1249
1249
|
-6: 权威比对系统升级中,请稍后再试
|
|
1250
1250
|
-7: 认证次数超过当日限制
|
|
1251
|
-
|
|
1251
|
+
*/
|
|
1252
1252
|
Result: string;
|
|
1253
1253
|
/**
|
|
1254
1254
|
* 业务结果描述。
|
|
@@ -1263,24 +1263,24 @@ export interface IdCardOCRVerificationResponse {
|
|
|
1263
1263
|
*/
|
|
1264
1264
|
IdCard: string;
|
|
1265
1265
|
/**
|
|
1266
|
-
|
|
1266
|
+
* OCR得到的性别
|
|
1267
1267
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1268
|
-
|
|
1268
|
+
*/
|
|
1269
1269
|
Sex: string;
|
|
1270
1270
|
/**
|
|
1271
|
-
|
|
1271
|
+
* OCR得到的民族
|
|
1272
1272
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1273
|
-
|
|
1273
|
+
*/
|
|
1274
1274
|
Nation: string;
|
|
1275
1275
|
/**
|
|
1276
|
-
|
|
1276
|
+
* OCR得到的生日
|
|
1277
1277
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1278
|
-
|
|
1278
|
+
*/
|
|
1279
1279
|
Birth: string;
|
|
1280
1280
|
/**
|
|
1281
|
-
|
|
1281
|
+
* OCR得到的地址
|
|
1282
1282
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1283
|
-
|
|
1283
|
+
*/
|
|
1284
1284
|
Address: string;
|
|
1285
1285
|
/**
|
|
1286
1286
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -1342,9 +1342,9 @@ export interface ParseNfcDataRequest {
|
|
|
1342
1342
|
*/
|
|
1343
1343
|
export interface LivenessResponse {
|
|
1344
1344
|
/**
|
|
1345
|
-
|
|
1345
|
+
* 验证通过后的视频最佳截图照片,照片为BASE64编码后的值,jpg格式。
|
|
1346
1346
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1347
|
-
|
|
1347
|
+
*/
|
|
1348
1348
|
BestFrameBase64?: string;
|
|
1349
1349
|
/**
|
|
1350
1350
|
* 业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
|
|
@@ -1355,9 +1355,9 @@ export interface LivenessResponse {
|
|
|
1355
1355
|
*/
|
|
1356
1356
|
Description?: string;
|
|
1357
1357
|
/**
|
|
1358
|
-
|
|
1358
|
+
* 最佳最佳截图列表,仅在配置了返回多张最佳截图时有效。
|
|
1359
1359
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1360
|
-
|
|
1360
|
+
*/
|
|
1361
1361
|
BestFrameList?: Array<string>;
|
|
1362
1362
|
/**
|
|
1363
1363
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -1369,23 +1369,23 @@ export interface LivenessResponse {
|
|
|
1369
1369
|
*/
|
|
1370
1370
|
export interface CheckIdCardInformationRequest {
|
|
1371
1371
|
/**
|
|
1372
|
-
|
|
1372
|
+
* 身份证人像面的 Base64 值
|
|
1373
1373
|
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
|
|
1374
1374
|
支持的图片大小:所下载图片经Base64编码后不超过 7M。
|
|
1375
1375
|
请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
|
|
1376
1376
|
ImageBase64、ImageUrl二者必须提供其中之一。若都提供了,则按照ImageUrl>ImageBase64的优先级使用参数。
|
|
1377
|
-
|
|
1377
|
+
*/
|
|
1378
1378
|
ImageBase64?: string;
|
|
1379
1379
|
/**
|
|
1380
|
-
|
|
1380
|
+
* 身份证人像面的 Url 地址
|
|
1381
1381
|
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
|
|
1382
1382
|
支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。
|
|
1383
1383
|
图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
|
|
1384
1384
|
非腾讯云存储的 Url 速度和稳定性可能受一定影响。
|
|
1385
|
-
|
|
1385
|
+
*/
|
|
1386
1386
|
ImageUrl?: string;
|
|
1387
1387
|
/**
|
|
1388
|
-
|
|
1388
|
+
* 以下可选字段均为bool 类型,默认false:
|
|
1389
1389
|
CopyWarn,复印件告警
|
|
1390
1390
|
BorderCheckWarn,边框和框内遮挡告警
|
|
1391
1391
|
ReshootWarn,翻拍告警
|
|
@@ -1397,12 +1397,12 @@ export interface CheckIdCardInformationRequest {
|
|
|
1397
1397
|
Config = Json.stringify({"CopyWarn":true,"ReshootWarn":true})
|
|
1398
1398
|
API 3.0 Explorer 设置方式参考:
|
|
1399
1399
|
Config = {"CopyWarn":true,"ReshootWarn":true}
|
|
1400
|
-
|
|
1400
|
+
*/
|
|
1401
1401
|
Config?: string;
|
|
1402
1402
|
/**
|
|
1403
|
-
|
|
1403
|
+
* 是否需要对返回中的敏感信息进行加密。默认false。
|
|
1404
1404
|
其中敏感信息包括:Response.IdNum、Response.Name
|
|
1405
|
-
|
|
1405
|
+
*/
|
|
1406
1406
|
IsEncrypt?: boolean;
|
|
1407
1407
|
}
|
|
1408
1408
|
/**
|
|
@@ -1410,162 +1410,162 @@ export interface CheckIdCardInformationRequest {
|
|
|
1410
1410
|
*/
|
|
1411
1411
|
export interface DetectInfoText {
|
|
1412
1412
|
/**
|
|
1413
|
-
|
|
1413
|
+
* 本次流程最终验证结果。0为成功
|
|
1414
1414
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1415
|
-
|
|
1415
|
+
*/
|
|
1416
1416
|
ErrCode: number;
|
|
1417
1417
|
/**
|
|
1418
|
-
|
|
1418
|
+
* 本次流程最终验证结果描述。(仅描述用,文案更新时不会通知。)
|
|
1419
1419
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1420
|
-
|
|
1420
|
+
*/
|
|
1421
1421
|
ErrMsg: string;
|
|
1422
1422
|
/**
|
|
1423
|
-
|
|
1423
|
+
* 本次验证使用的身份证号。
|
|
1424
1424
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1425
|
-
|
|
1425
|
+
*/
|
|
1426
1426
|
IdCard: string;
|
|
1427
1427
|
/**
|
|
1428
|
-
|
|
1428
|
+
* 用户认证时使用的证件号码类型:
|
|
1429
1429
|
0:二代身份证的证件号码
|
|
1430
1430
|
1:港澳台居住证的证件号码
|
|
1431
1431
|
2:其他(核验使用的证件号码非合法身份号码)
|
|
1432
1432
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1433
|
-
|
|
1433
|
+
*/
|
|
1434
1434
|
UseIDType: number;
|
|
1435
1435
|
/**
|
|
1436
|
-
|
|
1436
|
+
* 本次验证使用的姓名。
|
|
1437
1437
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1438
|
-
|
|
1438
|
+
*/
|
|
1439
1439
|
Name: string;
|
|
1440
1440
|
/**
|
|
1441
|
-
|
|
1441
|
+
* 身份校验环节识别结果:民族。
|
|
1442
1442
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1443
|
-
|
|
1443
|
+
*/
|
|
1444
1444
|
OcrNation: string;
|
|
1445
1445
|
/**
|
|
1446
|
-
|
|
1446
|
+
* 身份校验环节识别结果:家庭住址。
|
|
1447
1447
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1448
|
-
|
|
1448
|
+
*/
|
|
1449
1449
|
OcrAddress: string;
|
|
1450
1450
|
/**
|
|
1451
|
-
|
|
1451
|
+
* 身份校验环节识别结果:生日。格式为:YYYY/M/D
|
|
1452
1452
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1453
|
-
|
|
1453
|
+
*/
|
|
1454
1454
|
OcrBirth: string;
|
|
1455
1455
|
/**
|
|
1456
|
-
|
|
1456
|
+
* 身份校验环节识别结果:签发机关。
|
|
1457
1457
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1458
|
-
|
|
1458
|
+
*/
|
|
1459
1459
|
OcrAuthority: string;
|
|
1460
1460
|
/**
|
|
1461
|
-
|
|
1461
|
+
* 身份校验环节识别结果:有效日期。格式为:YYYY.MM.DD-YYYY.MM.DD
|
|
1462
1462
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1463
|
-
|
|
1463
|
+
*/
|
|
1464
1464
|
OcrValidDate: string;
|
|
1465
1465
|
/**
|
|
1466
|
-
|
|
1466
|
+
* 身份校验环节识别结果:姓名。
|
|
1467
1467
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1468
|
-
|
|
1468
|
+
*/
|
|
1469
1469
|
OcrName: string;
|
|
1470
1470
|
/**
|
|
1471
|
-
|
|
1471
|
+
* 身份校验环节识别结果:身份证号。
|
|
1472
1472
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1473
|
-
|
|
1473
|
+
*/
|
|
1474
1474
|
OcrIdCard: string;
|
|
1475
1475
|
/**
|
|
1476
|
-
|
|
1476
|
+
* 身份校验环节识别结果:性别。
|
|
1477
1477
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1478
|
-
|
|
1478
|
+
*/
|
|
1479
1479
|
OcrGender: string;
|
|
1480
1480
|
/**
|
|
1481
|
-
|
|
1481
|
+
* 身份校验环节采用的信息上传方式。
|
|
1482
1482
|
取值有"NFC"、"OCR"、"手动输入"、"其他"
|
|
1483
1483
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1484
|
-
|
|
1484
|
+
*/
|
|
1485
1485
|
IdInfoFrom?: string;
|
|
1486
1486
|
/**
|
|
1487
|
-
|
|
1487
|
+
* 本次流程最终活体结果。0为成功
|
|
1488
1488
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1489
|
-
|
|
1489
|
+
*/
|
|
1490
1490
|
LiveStatus: number;
|
|
1491
1491
|
/**
|
|
1492
|
-
|
|
1492
|
+
* 本次流程最终活体结果描述。(仅描述用,文案更新时不会通知。)
|
|
1493
1493
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1494
|
-
|
|
1494
|
+
*/
|
|
1495
1495
|
LiveMsg: string;
|
|
1496
1496
|
/**
|
|
1497
|
-
|
|
1497
|
+
* 本次流程最终一比一结果。0为成功
|
|
1498
1498
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1499
|
-
|
|
1499
|
+
*/
|
|
1500
1500
|
Comparestatus: number;
|
|
1501
1501
|
/**
|
|
1502
|
-
|
|
1502
|
+
* 本次流程最终一比一结果描述。(仅描述用,文案更新时不会通知。)
|
|
1503
1503
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1504
|
-
|
|
1504
|
+
*/
|
|
1505
1505
|
Comparemsg: string;
|
|
1506
1506
|
/**
|
|
1507
|
-
|
|
1507
|
+
* 本次流程活体一比一的分数,取值范围 [0.00, 100.00]。相似度大于等于70时才判断为同一人,也可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
|
|
1508
1508
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1509
|
-
|
|
1509
|
+
*/
|
|
1510
1510
|
Sim: string;
|
|
1511
1511
|
/**
|
|
1512
|
-
|
|
1512
|
+
* 地理位置经纬度。
|
|
1513
1513
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1514
|
-
|
|
1514
|
+
*/
|
|
1515
1515
|
Location: string;
|
|
1516
1516
|
/**
|
|
1517
|
-
|
|
1517
|
+
* Auth接口带入额外信息。
|
|
1518
1518
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1519
|
-
|
|
1519
|
+
*/
|
|
1520
1520
|
Extra: string;
|
|
1521
1521
|
/**
|
|
1522
|
-
|
|
1522
|
+
* 本次流程进行的活体一比一流水。
|
|
1523
1523
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1524
|
-
|
|
1524
|
+
*/
|
|
1525
1525
|
LivenessDetail: Array<DetectDetail>;
|
|
1526
1526
|
/**
|
|
1527
|
-
|
|
1527
|
+
* 手机号码。
|
|
1528
1528
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1529
|
-
|
|
1529
|
+
*/
|
|
1530
1530
|
Mobile: string;
|
|
1531
1531
|
/**
|
|
1532
|
-
|
|
1532
|
+
* 本次流程最终比对库源类型。包括:
|
|
1533
1533
|
权威库;
|
|
1534
1534
|
业务方自有库(用户上传照片、客户的混合库、混合部署库);
|
|
1535
1535
|
二次验证库;
|
|
1536
1536
|
人工审核库;
|
|
1537
1537
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1538
|
-
|
|
1538
|
+
*/
|
|
1539
1539
|
CompareLibType: string;
|
|
1540
1540
|
/**
|
|
1541
|
-
|
|
1541
|
+
* 本次流程最终活体类型。包括:
|
|
1542
1542
|
0:未知
|
|
1543
1543
|
1:数字活体
|
|
1544
1544
|
2:动作活体
|
|
1545
1545
|
3:静默活体
|
|
1546
1546
|
4:一闪活体(动作+光线)
|
|
1547
1547
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1548
|
-
|
|
1548
|
+
*/
|
|
1549
1549
|
LivenessMode: number;
|
|
1550
1550
|
/**
|
|
1551
|
-
|
|
1551
|
+
* nfc重复计费requestId列表
|
|
1552
1552
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1553
|
-
|
|
1553
|
+
*/
|
|
1554
1554
|
NFCRequestIds?: Array<string>;
|
|
1555
1555
|
/**
|
|
1556
|
-
|
|
1556
|
+
* nfc重复计费计数
|
|
1557
1557
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1558
|
-
|
|
1558
|
+
*/
|
|
1559
1559
|
NFCBillingCounts?: number;
|
|
1560
1560
|
/**
|
|
1561
|
-
|
|
1561
|
+
* 港澳台居住证通行证号码
|
|
1562
1562
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1563
|
-
|
|
1563
|
+
*/
|
|
1564
1564
|
PassNo?: string;
|
|
1565
1565
|
/**
|
|
1566
|
-
|
|
1566
|
+
* 港澳台居住证签发次数
|
|
1567
1567
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1568
|
-
|
|
1568
|
+
*/
|
|
1569
1569
|
VisaNum?: string;
|
|
1570
1570
|
}
|
|
1571
1571
|
/**
|
|
@@ -1581,9 +1581,9 @@ export interface DetectAuthRequest {
|
|
|
1581
1581
|
*/
|
|
1582
1582
|
TerminalType?: string;
|
|
1583
1583
|
/**
|
|
1584
|
-
|
|
1584
|
+
* 身份标识(未使用OCR服务时,必须传入)。
|
|
1585
1585
|
规则:a-zA-Z0-9组合。最长长度32位。
|
|
1586
|
-
|
|
1586
|
+
*/
|
|
1587
1587
|
IdCard?: string;
|
|
1588
1588
|
/**
|
|
1589
1589
|
* 姓名。(未使用OCR服务时,必须传入)最长长度32位。中文请使用UTF-8编码。
|
|
@@ -1598,9 +1598,9 @@ export interface DetectAuthRequest {
|
|
|
1598
1598
|
*/
|
|
1599
1599
|
Extra?: string;
|
|
1600
1600
|
/**
|
|
1601
|
-
|
|
1601
|
+
* 用于人脸比对的照片,图片的Base64值;
|
|
1602
1602
|
Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
|
|
1603
|
-
|
|
1603
|
+
*/
|
|
1604
1604
|
ImageBase64?: string;
|
|
1605
1605
|
/**
|
|
1606
1606
|
* 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
|
|
@@ -1624,7 +1624,7 @@ export interface DetectAuthRequest {
|
|
|
1624
1624
|
*/
|
|
1625
1625
|
export interface MinorsVerificationResponse {
|
|
1626
1626
|
/**
|
|
1627
|
-
|
|
1627
|
+
* 结果码,收费情况如下。
|
|
1628
1628
|
收费结果码:
|
|
1629
1629
|
0: 成年
|
|
1630
1630
|
-1: 未成年
|
|
@@ -1637,19 +1637,19 @@ export interface MinorsVerificationResponse {
|
|
|
1637
1637
|
-6: 权威数据源服务异常
|
|
1638
1638
|
-7: 未查询到身份信息
|
|
1639
1639
|
-8: 权威数据源升级中,请稍后再试
|
|
1640
|
-
|
|
1640
|
+
*/
|
|
1641
1641
|
Result: string;
|
|
1642
1642
|
/**
|
|
1643
1643
|
* 业务结果描述。
|
|
1644
1644
|
*/
|
|
1645
1645
|
Description: string;
|
|
1646
1646
|
/**
|
|
1647
|
-
|
|
1647
|
+
* 该字段的值为年龄区间。格式为[a,b),
|
|
1648
1648
|
[0,8)表示年龄小于8周岁区间,不包括8岁;
|
|
1649
1649
|
[8,16)表示年龄8-16周岁区间,不包括16岁;
|
|
1650
1650
|
[16,18)表示年龄16-18周岁区间,不包括18岁;
|
|
1651
1651
|
[18,+)表示年龄大于18周岁。
|
|
1652
|
-
|
|
1652
|
+
*/
|
|
1653
1653
|
AgeRange: string;
|
|
1654
1654
|
/**
|
|
1655
1655
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -1687,34 +1687,34 @@ export interface CheckEidTokenStatusRequest {
|
|
|
1687
1687
|
*/
|
|
1688
1688
|
export interface GetEidResultResponse {
|
|
1689
1689
|
/**
|
|
1690
|
-
|
|
1690
|
+
* 文本类信息。(基于对敏感信息的保护,验证使用的姓名和身份证号统一通过加密后从Eidinfo参数中返回,如需获取请在控制台申请返回身份信息,详见[E证通获取实名信息指引](https://cloud.tencent.com/document/product/1007/63370))
|
|
1691
1691
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1692
|
-
|
|
1692
|
+
*/
|
|
1693
1693
|
Text: DetectInfoText;
|
|
1694
1694
|
/**
|
|
1695
|
-
|
|
1695
|
+
* 身份证照片信息。
|
|
1696
1696
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1697
|
-
|
|
1697
|
+
*/
|
|
1698
1698
|
IdCardData: DetectInfoIdCardData;
|
|
1699
1699
|
/**
|
|
1700
|
-
|
|
1700
|
+
* 最佳帧信息。
|
|
1701
1701
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1702
|
-
|
|
1702
|
+
*/
|
|
1703
1703
|
BestFrame: DetectInfoBestFrame;
|
|
1704
1704
|
/**
|
|
1705
|
-
|
|
1705
|
+
* Eid信息。(包括商户下用户唯一标识以及加密后的姓名、身份证号信息。解密方式详见[E证通获取实名信息指引](https://cloud.tencent.com/document/product/1007/63370))
|
|
1706
1706
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1707
|
-
|
|
1707
|
+
*/
|
|
1708
1708
|
EidInfo: EidInfo;
|
|
1709
1709
|
/**
|
|
1710
|
-
|
|
1710
|
+
* 意愿核身朗读模式相关信息。若未使用意愿核身朗读功能,该字段返回值可以不处理。
|
|
1711
1711
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1712
|
-
|
|
1712
|
+
*/
|
|
1713
1713
|
IntentionVerifyData: IntentionVerifyData;
|
|
1714
1714
|
/**
|
|
1715
|
-
|
|
1715
|
+
* 意愿核身问答模式相关信息。若未使用意愿核身问答模式功能,该字段返回值可以不处理。
|
|
1716
1716
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1717
|
-
|
|
1717
|
+
*/
|
|
1718
1718
|
IntentionQuestionResult: IntentionQuestionResult;
|
|
1719
1719
|
/**
|
|
1720
1720
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -1734,10 +1734,10 @@ export interface ImageRecognitionRequest {
|
|
|
1734
1734
|
*/
|
|
1735
1735
|
Name: string;
|
|
1736
1736
|
/**
|
|
1737
|
-
|
|
1737
|
+
* 用于人脸比对的照片,图片的Base64值;
|
|
1738
1738
|
Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。
|
|
1739
1739
|
请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
|
|
1740
|
-
|
|
1740
|
+
*/
|
|
1741
1741
|
ImageBase64: string;
|
|
1742
1742
|
/**
|
|
1743
1743
|
* 本接口不需要传递此参数。
|
|
@@ -1790,9 +1790,9 @@ export interface BankCard4EVerificationRequest {
|
|
|
1790
1790
|
*/
|
|
1791
1791
|
IdCard: string;
|
|
1792
1792
|
/**
|
|
1793
|
-
|
|
1793
|
+
* 证件类型,请确认该证件为开户时使用的证件类型,未用于开户的证件信息不支持验证。
|
|
1794
1794
|
目前默认为0:身份证,其他证件类型暂不支持。
|
|
1795
|
-
|
|
1795
|
+
*/
|
|
1796
1796
|
CertType?: number;
|
|
1797
1797
|
/**
|
|
1798
1798
|
* 敏感数据加密信息。对传入信息(姓名、身份证号、手机号、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
|
|
@@ -1834,7 +1834,7 @@ export interface GetFaceIdResultRequest {
|
|
|
1834
1834
|
*/
|
|
1835
1835
|
export interface PhoneVerificationCUCCResponse {
|
|
1836
1836
|
/**
|
|
1837
|
-
|
|
1837
|
+
* 认证结果码,收费情况如下。
|
|
1838
1838
|
收费结果码:
|
|
1839
1839
|
0: 认证通过
|
|
1840
1840
|
-4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)
|
|
@@ -1845,12 +1845,12 @@ export interface PhoneVerificationCUCCResponse {
|
|
|
1845
1845
|
-9: 没有记录
|
|
1846
1846
|
-10: 认证未通过
|
|
1847
1847
|
-11: 验证中心服务繁忙
|
|
1848
|
-
|
|
1848
|
+
*/
|
|
1849
1849
|
Result: string;
|
|
1850
1850
|
/**
|
|
1851
|
-
|
|
1851
|
+
* 运营商名称。
|
|
1852
1852
|
取值范围为["移动","联通","电信",""]
|
|
1853
|
-
|
|
1853
|
+
*/
|
|
1854
1854
|
Isp: string;
|
|
1855
1855
|
/**
|
|
1856
1856
|
* 业务结果描述。
|
|
@@ -1879,7 +1879,7 @@ export interface GetActionSequenceResponse {
|
|
|
1879
1879
|
*/
|
|
1880
1880
|
export interface BankCardVerificationResponse {
|
|
1881
1881
|
/**
|
|
1882
|
-
|
|
1882
|
+
* 认证结果码
|
|
1883
1883
|
收费结果码:
|
|
1884
1884
|
'0': '认证通过'
|
|
1885
1885
|
'-1': '认证未通过'
|
|
@@ -1900,7 +1900,7 @@ export interface BankCardVerificationResponse {
|
|
|
1900
1900
|
'-3': '身份证号码有误'
|
|
1901
1901
|
'-4': '银行卡号码有误'
|
|
1902
1902
|
'-17': '验证中心服务繁忙'
|
|
1903
|
-
|
|
1903
|
+
*/
|
|
1904
1904
|
Result: string;
|
|
1905
1905
|
/**
|
|
1906
1906
|
* 业务结果描述。
|
|
@@ -1916,16 +1916,16 @@ export interface BankCardVerificationResponse {
|
|
|
1916
1916
|
*/
|
|
1917
1917
|
export interface MinorsVerificationRequest {
|
|
1918
1918
|
/**
|
|
1919
|
-
|
|
1919
|
+
* 参与校验的参数类型。
|
|
1920
1920
|
0:使用手机号进行校验;
|
|
1921
1921
|
1:使用姓名与身份证号进行校验。
|
|
1922
|
-
|
|
1922
|
+
*/
|
|
1923
1923
|
Type: string;
|
|
1924
1924
|
/**
|
|
1925
|
-
|
|
1925
|
+
* 手机号,11位数字,
|
|
1926
1926
|
特别提示:
|
|
1927
1927
|
手机号验证只限制在腾讯健康守护可信模型覆盖的数据范围内,与手机号本身在运营商是否实名无关联,不在范围会提示“手机号未实名”,建议客户与传入姓名和身份证号信息组合使用。
|
|
1928
|
-
|
|
1928
|
+
*/
|
|
1929
1929
|
Mobile?: string;
|
|
1930
1930
|
/**
|
|
1931
1931
|
* 身份证号码。
|
|
@@ -1975,7 +1975,7 @@ export interface GetActionSequenceRequest {
|
|
|
1975
1975
|
*/
|
|
1976
1976
|
export interface GetDetectInfoResponse {
|
|
1977
1977
|
/**
|
|
1978
|
-
|
|
1978
|
+
* JSON字符串。
|
|
1979
1979
|
{
|
|
1980
1980
|
// 文本类信息
|
|
1981
1981
|
"Text": {
|
|
@@ -2024,7 +2024,7 @@ export interface GetDetectInfoResponse {
|
|
|
2024
2024
|
"LivenessVideo": null
|
|
2025
2025
|
}
|
|
2026
2026
|
}
|
|
2027
|
-
|
|
2027
|
+
*/
|
|
2028
2028
|
DetectInfo: string;
|
|
2029
2029
|
/**
|
|
2030
2030
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -2036,9 +2036,9 @@ export interface GetDetectInfoResponse {
|
|
|
2036
2036
|
*/
|
|
2037
2037
|
export interface LivenessCompareResponse {
|
|
2038
2038
|
/**
|
|
2039
|
-
|
|
2039
|
+
* 验证通过后的视频最佳截图照片,照片为BASE64编码后的值,jpg格式。
|
|
2040
2040
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2041
|
-
|
|
2041
|
+
*/
|
|
2042
2042
|
BestFrameBase64: string;
|
|
2043
2043
|
/**
|
|
2044
2044
|
* 相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)。
|
|
@@ -2053,9 +2053,9 @@ export interface LivenessCompareResponse {
|
|
|
2053
2053
|
*/
|
|
2054
2054
|
Description: string;
|
|
2055
2055
|
/**
|
|
2056
|
-
|
|
2056
|
+
* 最佳截图列表,仅在配置了返回多张最佳截图时返回。
|
|
2057
2057
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2058
|
-
|
|
2058
|
+
*/
|
|
2059
2059
|
BestFrameList: Array<string>;
|
|
2060
2060
|
/**
|
|
2061
2061
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -2088,10 +2088,10 @@ export interface GetDetectInfoRequest {
|
|
|
2088
2088
|
*/
|
|
2089
2089
|
RuleId: string;
|
|
2090
2090
|
/**
|
|
2091
|
-
|
|
2091
|
+
* 指定拉取的结果信息,取值(0:全部;1:文本类;2:身份证正反面;3:视频最佳截图照片;4:视频)。
|
|
2092
2092
|
如 134表示拉取文本类、视频最佳截图照片、视频。
|
|
2093
2093
|
默认值:0
|
|
2094
|
-
|
|
2094
|
+
*/
|
|
2095
2095
|
InfoType?: string;
|
|
2096
2096
|
}
|
|
2097
2097
|
/**
|
|
@@ -2099,7 +2099,7 @@ export interface GetDetectInfoRequest {
|
|
|
2099
2099
|
*/
|
|
2100
2100
|
export interface BankCard2EVerificationResponse {
|
|
2101
2101
|
/**
|
|
2102
|
-
|
|
2102
|
+
* 认证结果码
|
|
2103
2103
|
计费结果码:
|
|
2104
2104
|
'0': '认证通过'
|
|
2105
2105
|
'-1': '认证未通过'
|
|
@@ -2119,7 +2119,7 @@ export interface BankCard2EVerificationResponse {
|
|
|
2119
2119
|
'-2': '姓名校验不通过'
|
|
2120
2120
|
'-3': '银行卡号码有误'
|
|
2121
2121
|
'-16': '验证中心服务繁忙'
|
|
2122
|
-
|
|
2122
|
+
*/
|
|
2123
2123
|
Result: string;
|
|
2124
2124
|
/**
|
|
2125
2125
|
* 业务结果描述。
|
|
@@ -2135,7 +2135,7 @@ export interface BankCard2EVerificationResponse {
|
|
|
2135
2135
|
*/
|
|
2136
2136
|
export interface IdCardVerificationResponse {
|
|
2137
2137
|
/**
|
|
2138
|
-
|
|
2138
|
+
* 认证结果码,收费情况如下。
|
|
2139
2139
|
收费结果码:
|
|
2140
2140
|
0: 姓名和身份证号一致
|
|
2141
2141
|
-1: 姓名和身份证号不一致
|
|
@@ -2146,7 +2146,7 @@ export interface IdCardVerificationResponse {
|
|
|
2146
2146
|
-5: 证件库中无此身份证记录
|
|
2147
2147
|
-6: 权威比对系统升级中,请稍后再试
|
|
2148
2148
|
-7: 认证次数超过当日限制
|
|
2149
|
-
|
|
2149
|
+
*/
|
|
2150
2150
|
Result: string;
|
|
2151
2151
|
/**
|
|
2152
2152
|
* 业务结果描述。
|
|
@@ -2162,32 +2162,32 @@ export interface IdCardVerificationResponse {
|
|
|
2162
2162
|
*/
|
|
2163
2163
|
export interface DetectInfoIdCardData {
|
|
2164
2164
|
/**
|
|
2165
|
-
|
|
2165
|
+
* OCR正面照片的base64编码。
|
|
2166
2166
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2167
|
-
|
|
2167
|
+
*/
|
|
2168
2168
|
OcrFront: string;
|
|
2169
2169
|
/**
|
|
2170
|
-
|
|
2170
|
+
* OCR反面照片的base64编码
|
|
2171
2171
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2172
|
-
|
|
2172
|
+
*/
|
|
2173
2173
|
OcrBack: string;
|
|
2174
2174
|
/**
|
|
2175
|
-
|
|
2175
|
+
* 旋转裁边后的正面照片base64编码。
|
|
2176
2176
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2177
|
-
|
|
2177
|
+
*/
|
|
2178
2178
|
ProcessedFrontImage: string;
|
|
2179
2179
|
/**
|
|
2180
|
-
|
|
2180
|
+
* 旋转裁边后的背面照片base64编码。
|
|
2181
2181
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2182
|
-
|
|
2182
|
+
*/
|
|
2183
2183
|
ProcessedBackImage: string;
|
|
2184
2184
|
/**
|
|
2185
|
-
|
|
2185
|
+
* 身份证正面人像图base64编码。
|
|
2186
2186
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2187
|
-
|
|
2187
|
+
*/
|
|
2188
2188
|
Avatar: string;
|
|
2189
2189
|
/**
|
|
2190
|
-
|
|
2190
|
+
* 身份证人像面告警码,开启身份证告警功能后才会返回,返回数组中可能出现的告警码如下:
|
|
2191
2191
|
-9100 身份证有效日期不合法告警,
|
|
2192
2192
|
-9101 身份证边框不完整告警,
|
|
2193
2193
|
-9102 身份证复印件告警,
|
|
@@ -2197,10 +2197,10 @@ export interface DetectInfoIdCardData {
|
|
|
2197
2197
|
-9106 身份证 PS 告警,
|
|
2198
2198
|
-9107 身份证反光告警。
|
|
2199
2199
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2200
|
-
|
|
2200
|
+
*/
|
|
2201
2201
|
WarnInfos: Array<number>;
|
|
2202
2202
|
/**
|
|
2203
|
-
|
|
2203
|
+
* 身份证国徽面告警码,开启身份证告警功能后才会返回,返回数组中可能出现的告警码如下:
|
|
2204
2204
|
-9100 身份证有效日期不合法告警,
|
|
2205
2205
|
-9101 身份证边框不完整告警,
|
|
2206
2206
|
-9102 身份证复印件告警,
|
|
@@ -2210,7 +2210,7 @@ export interface DetectInfoIdCardData {
|
|
|
2210
2210
|
-9106 身份证 PS 告警,
|
|
2211
2211
|
-9107 身份证反光告警。
|
|
2212
2212
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2213
|
-
|
|
2213
|
+
*/
|
|
2214
2214
|
BackWarnInfos: Array<number>;
|
|
2215
2215
|
}
|
|
2216
2216
|
/**
|
|
@@ -2235,9 +2235,9 @@ export interface CheckPhoneAndNameRequest {
|
|
|
2235
2235
|
*/
|
|
2236
2236
|
export interface GetEidTokenResponse {
|
|
2237
2237
|
/**
|
|
2238
|
-
|
|
2238
|
+
* 一次核身流程的标识,有效时间为600秒;
|
|
2239
2239
|
完成核身后,可用该标识获取验证结果信息。
|
|
2240
|
-
|
|
2240
|
+
*/
|
|
2241
2241
|
EidToken: string;
|
|
2242
2242
|
/**
|
|
2243
2243
|
* 发起核身流程的URL,用于H5场景核身。
|
|
@@ -2253,34 +2253,34 @@ export interface GetEidTokenResponse {
|
|
|
2253
2253
|
*/
|
|
2254
2254
|
export interface IntentionVerifyData {
|
|
2255
2255
|
/**
|
|
2256
|
-
|
|
2256
|
+
* 意愿确认环节中录制的视频(base64)。若不存在则为空字符串。
|
|
2257
2257
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2258
|
-
|
|
2258
|
+
*/
|
|
2259
2259
|
IntentionVerifyVideo: string;
|
|
2260
2260
|
/**
|
|
2261
|
-
|
|
2261
|
+
* 意愿确认环节中用户语音转文字的识别结果。若不存在则为空字符串。
|
|
2262
2262
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2263
|
-
|
|
2263
|
+
*/
|
|
2264
2264
|
AsrResult: string;
|
|
2265
2265
|
/**
|
|
2266
|
-
|
|
2266
|
+
* 意愿确认环节的结果码。当该结果码为0时,语音朗读的视频与语音识别结果才会返回。
|
|
2267
2267
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2268
|
-
|
|
2268
|
+
*/
|
|
2269
2269
|
ErrorCode: number;
|
|
2270
2270
|
/**
|
|
2271
|
-
|
|
2271
|
+
* 意愿确认环节的结果信息。
|
|
2272
2272
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2273
|
-
|
|
2273
|
+
*/
|
|
2274
2274
|
ErrorMessage: string;
|
|
2275
2275
|
/**
|
|
2276
|
-
|
|
2276
|
+
* 意愿确认环节中录制视频的最佳帧(base64)。若不存在则为空字符串。
|
|
2277
2277
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2278
|
-
|
|
2278
|
+
*/
|
|
2279
2279
|
IntentionVerifyBestFrame: string;
|
|
2280
2280
|
/**
|
|
2281
|
-
|
|
2281
|
+
* 本次流程用户语音与传入文本比对的相似度分值,取值范围 [0.00, 100.00]。只有配置了相似度阈值后才进行语音校验并返回相似度分值。
|
|
2282
2282
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2283
|
-
|
|
2283
|
+
*/
|
|
2284
2284
|
AsrResultSimilarity: string;
|
|
2285
2285
|
}
|
|
2286
2286
|
/**
|
|
@@ -2288,54 +2288,54 @@ export interface IntentionVerifyData {
|
|
|
2288
2288
|
*/
|
|
2289
2289
|
export interface LivenessCompareRequest {
|
|
2290
2290
|
/**
|
|
2291
|
-
|
|
2291
|
+
* 活体检测类型,取值:LIP/ACTION/SILENT。
|
|
2292
2292
|
LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。
|
|
2293
|
-
|
|
2293
|
+
*/
|
|
2294
2294
|
LivenessType: string;
|
|
2295
2295
|
/**
|
|
2296
|
-
|
|
2296
|
+
* 用于人脸比对的照片的Base64值;
|
|
2297
2297
|
Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。
|
|
2298
2298
|
请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
|
|
2299
2299
|
|
|
2300
2300
|
图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageBase64。
|
|
2301
|
-
|
|
2301
|
+
*/
|
|
2302
2302
|
ImageBase64?: string;
|
|
2303
2303
|
/**
|
|
2304
|
-
|
|
2304
|
+
* 用于人脸比对照片的URL地址;图片下载后经Base64编码后的数据大小不超过3M,仅支持jpg、png格式。
|
|
2305
2305
|
|
|
2306
2306
|
图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageBase64。
|
|
2307
2307
|
|
|
2308
2308
|
图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
|
|
2309
|
-
|
|
2309
|
+
*/
|
|
2310
2310
|
ImageUrl?: string;
|
|
2311
2311
|
/**
|
|
2312
|
-
|
|
2312
|
+
* 数字模式传参:传数字验证码,验证码需先调用<a href="https://cloud.tencent.com/document/product/1007/31821">获取数字验证码接口</a>得到;
|
|
2313
2313
|
动作模式传参:传动作顺序,动作顺序需先调用<a href="https://cloud.tencent.com/document/product/1007/31822">获取动作顺序接口</a>得到;
|
|
2314
2314
|
静默模式传参:空。
|
|
2315
|
-
|
|
2315
|
+
*/
|
|
2316
2316
|
ValidateData?: string;
|
|
2317
2317
|
/**
|
|
2318
|
-
|
|
2318
|
+
* 额外配置,传入JSON字符串。
|
|
2319
2319
|
{
|
|
2320
2320
|
"BestFrameNum": 2 //需要返回多张最佳截图,取值范围2-10
|
|
2321
2321
|
}
|
|
2322
|
-
|
|
2322
|
+
*/
|
|
2323
2323
|
Optional?: string;
|
|
2324
2324
|
/**
|
|
2325
|
-
|
|
2325
|
+
* 用于活体检测的视频,视频的Base64值;
|
|
2326
2326
|
Base64编码后的大小不超过8M,支持mp4、avi、flv格式。
|
|
2327
2327
|
请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
|
|
2328
2328
|
|
|
2329
2329
|
视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
|
|
2330
|
-
|
|
2330
|
+
*/
|
|
2331
2331
|
VideoBase64?: string;
|
|
2332
2332
|
/**
|
|
2333
|
-
|
|
2333
|
+
* 用于活体检测的视频Url 地址。视频下载后经Base64编码后不超过 8M,视频下载耗时不超过4S,支持mp4、avi、flv格式。
|
|
2334
2334
|
|
|
2335
2335
|
视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
|
|
2336
2336
|
|
|
2337
2337
|
建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议视频存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
|
|
2338
|
-
|
|
2338
|
+
*/
|
|
2339
2339
|
VideoUrl?: string;
|
|
2340
2340
|
}
|
|
2341
2341
|
/**
|
|
@@ -2343,83 +2343,83 @@ export interface LivenessCompareRequest {
|
|
|
2343
2343
|
*/
|
|
2344
2344
|
export interface DetectDetail {
|
|
2345
2345
|
/**
|
|
2346
|
-
|
|
2346
|
+
* 请求时间戳。
|
|
2347
2347
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2348
|
-
|
|
2348
|
+
*/
|
|
2349
2349
|
ReqTime: string;
|
|
2350
2350
|
/**
|
|
2351
|
-
|
|
2351
|
+
* 本次活体一比一请求的唯一标记。
|
|
2352
2352
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2353
|
-
|
|
2353
|
+
*/
|
|
2354
2354
|
Seq: string;
|
|
2355
2355
|
/**
|
|
2356
|
-
|
|
2356
|
+
* 参与本次活体一比一的身份证号。
|
|
2357
2357
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2358
|
-
|
|
2358
|
+
*/
|
|
2359
2359
|
Idcard: string;
|
|
2360
2360
|
/**
|
|
2361
|
-
|
|
2361
|
+
* 参与本次活体一比一的姓名。
|
|
2362
2362
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2363
|
-
|
|
2363
|
+
*/
|
|
2364
2364
|
Name: string;
|
|
2365
2365
|
/**
|
|
2366
|
-
|
|
2366
|
+
* 本次活体一比一的相似度。
|
|
2367
2367
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2368
|
-
|
|
2368
|
+
*/
|
|
2369
2369
|
Sim: string;
|
|
2370
2370
|
/**
|
|
2371
|
-
|
|
2371
|
+
* 本次活体一比一是否收费
|
|
2372
2372
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2373
|
-
|
|
2373
|
+
*/
|
|
2374
2374
|
IsNeedCharge: boolean;
|
|
2375
2375
|
/**
|
|
2376
|
-
|
|
2376
|
+
* 本次活体一比一最终结果。0为成功
|
|
2377
2377
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2378
|
-
|
|
2378
|
+
*/
|
|
2379
2379
|
Errcode: number;
|
|
2380
2380
|
/**
|
|
2381
|
-
|
|
2381
|
+
* 本次活体一比一最终结果描述。(仅描述用,文案更新时不会通知。)
|
|
2382
2382
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2383
|
-
|
|
2383
|
+
*/
|
|
2384
2384
|
Errmsg: string;
|
|
2385
2385
|
/**
|
|
2386
|
-
|
|
2386
|
+
* 本次活体结果。0为成功
|
|
2387
2387
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2388
|
-
|
|
2388
|
+
*/
|
|
2389
2389
|
Livestatus: number;
|
|
2390
2390
|
/**
|
|
2391
|
-
|
|
2391
|
+
* 本次活体结果描述。(仅描述用,文案更新时不会通知。)
|
|
2392
2392
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2393
|
-
|
|
2393
|
+
*/
|
|
2394
2394
|
Livemsg: string;
|
|
2395
2395
|
/**
|
|
2396
|
-
|
|
2396
|
+
* 本次一比一结果。0为成功
|
|
2397
2397
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2398
|
-
|
|
2398
|
+
*/
|
|
2399
2399
|
Comparestatus: number;
|
|
2400
2400
|
/**
|
|
2401
|
-
|
|
2401
|
+
* 本次一比一结果描述。(仅描述用,文案更新时不会通知。)
|
|
2402
2402
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2403
|
-
|
|
2403
|
+
*/
|
|
2404
2404
|
Comparemsg: string;
|
|
2405
2405
|
/**
|
|
2406
|
-
|
|
2406
|
+
* 比对库源类型。包括:
|
|
2407
2407
|
公安商业库;
|
|
2408
2408
|
业务方自有库(用户上传照片、客户的混合库、混合部署库);
|
|
2409
2409
|
二次验证库;
|
|
2410
2410
|
人工审核库;
|
|
2411
2411
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2412
|
-
|
|
2412
|
+
*/
|
|
2413
2413
|
CompareLibType: string;
|
|
2414
2414
|
/**
|
|
2415
|
-
|
|
2415
|
+
* 枚举活体检测类型:
|
|
2416
2416
|
0:未知
|
|
2417
2417
|
1:数字活体
|
|
2418
2418
|
2:动作活体
|
|
2419
2419
|
3:静默活体
|
|
2420
2420
|
4:一闪活体(动作+光线)
|
|
2421
2421
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2422
|
-
|
|
2422
|
+
*/
|
|
2423
2423
|
LivenessMode: number;
|
|
2424
2424
|
}
|
|
2425
2425
|
/**
|
|
@@ -2447,22 +2447,22 @@ export interface GetFaceIdResultResponse {
|
|
|
2447
2447
|
*/
|
|
2448
2448
|
Similarity: number;
|
|
2449
2449
|
/**
|
|
2450
|
-
|
|
2450
|
+
* 用户核验的视频base64,如果选择了使用cos,返回完整cos地址如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey
|
|
2451
2451
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2452
|
-
|
|
2452
|
+
*/
|
|
2453
2453
|
VideoBase64: string;
|
|
2454
2454
|
/**
|
|
2455
|
-
|
|
2455
|
+
* 用户核验视频的截帧base64,如果选择了使用cos,返回完整cos地址如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey
|
|
2456
2456
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2457
|
-
|
|
2457
|
+
*/
|
|
2458
2458
|
BestFrameBase64: string;
|
|
2459
2459
|
/**
|
|
2460
|
-
|
|
2460
|
+
* 获取token时透传的信息
|
|
2461
2461
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2462
|
-
|
|
2462
|
+
*/
|
|
2463
2463
|
Extra: string;
|
|
2464
2464
|
/**
|
|
2465
|
-
|
|
2465
|
+
* 设备风险标签,仅错误码返回1007(设备疑似被劫持)时返回风险标签。标签说明:
|
|
2466
2466
|
202、5001:设备疑似被Root
|
|
2467
2467
|
203、5004:设备疑似被注入
|
|
2468
2468
|
205:设备疑似被Hook
|
|
@@ -2470,13 +2470,13 @@ export interface GetFaceIdResultResponse {
|
|
|
2470
2470
|
5007、1005:设备疑似摄像头被劫持
|
|
2471
2471
|
8000:设备疑似存在异常篡改行为
|
|
2472
2472
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2473
|
-
|
|
2473
|
+
*/
|
|
2474
2474
|
DeviceInfoTag: string;
|
|
2475
2475
|
/**
|
|
2476
|
-
|
|
2476
|
+
* 行为风险标签,仅错误码返回1007(设备疑似被劫持)时返回风险标签。标签说明:
|
|
2477
2477
|
02:攻击风险
|
|
2478
2478
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2479
|
-
|
|
2479
|
+
*/
|
|
2480
2480
|
RiskInfoTag: string;
|
|
2481
2481
|
/**
|
|
2482
2482
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -2500,12 +2500,12 @@ export interface EncryptedPhoneVerificationRequest {
|
|
|
2500
2500
|
*/
|
|
2501
2501
|
Phone: string;
|
|
2502
2502
|
/**
|
|
2503
|
-
|
|
2503
|
+
* 敏感信息的加密方式,目前支持明文、MD5和SHA256加密传输,参数取值:
|
|
2504
2504
|
|
|
2505
2505
|
0:明文,不加密
|
|
2506
2506
|
1: 使用MD5加密
|
|
2507
2507
|
2: 使用SHA256
|
|
2508
|
-
|
|
2508
|
+
*/
|
|
2509
2509
|
EncryptionMode: string;
|
|
2510
2510
|
}
|
|
2511
2511
|
/**
|
|
@@ -2526,7 +2526,7 @@ export interface IntentionQuestion {
|
|
|
2526
2526
|
*/
|
|
2527
2527
|
export interface EncryptedPhoneVerificationResponse {
|
|
2528
2528
|
/**
|
|
2529
|
-
|
|
2529
|
+
* 认证结果码:
|
|
2530
2530
|
【收费结果码】
|
|
2531
2531
|
0: 三要素信息一致
|
|
2532
2532
|
-4: 三要素信息不一致
|
|
@@ -2536,16 +2536,16 @@ export interface EncryptedPhoneVerificationResponse {
|
|
|
2536
2536
|
-8: 参数错误
|
|
2537
2537
|
-9: 没有记录
|
|
2538
2538
|
-11: 验证中心服务繁忙
|
|
2539
|
-
|
|
2539
|
+
*/
|
|
2540
2540
|
Result: string;
|
|
2541
2541
|
/**
|
|
2542
2542
|
* 业务结果描述。
|
|
2543
2543
|
*/
|
|
2544
2544
|
Description: string;
|
|
2545
2545
|
/**
|
|
2546
|
-
|
|
2546
|
+
* 运营商名称。
|
|
2547
2547
|
取值范围为["移动","联通","电信",""]
|
|
2548
|
-
|
|
2548
|
+
*/
|
|
2549
2549
|
ISP: string;
|
|
2550
2550
|
/**
|
|
2551
2551
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|