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