tencentcloud-sdk-nodejs-faceid 4.0.731 → 4.0.733

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