tencentcloud-sdk-nodejs 4.0.479 → 4.0.481

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