tencentcloud-sdk-nodejs-faceid 4.0.730 → 4.0.732

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