tencentcloud-sdk-faceid 1.0.200

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