tencentcloud-sdk-faceid 3.0.938 → 3.0.939

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/lib/VERSION +1 -1
  3. data/lib/v20180301/models.rb +415 -348
  4. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: e41b54cda2b4ebc8e5991ce88a95c448e79b6bf1
4
- data.tar.gz: 6ec651d0d7e839e7fa9a024ecd942e1e3fe23e07
3
+ metadata.gz: 0883000def216a1a2f5b0fa74184530f07318865
4
+ data.tar.gz: 261564d036a880cd4aa0c48cff8d39d182fc0b4f
5
5
  SHA512:
6
- metadata.gz: af44e3e4fa9d8c227cd29e86436a5f0a44b93ba2941dbe4123fbb01832f319491cb639292a5acdad9e771f6cdec61649044e191f818f175da1cc54f4ec21919e
7
- data.tar.gz: bd026a7fc93c1c605742b117be0080329c01e2814f28f3f4b8d705f46e897f1338fadef225d45c7fbc954662fe26526b70f1bb24516ffd88e1070f4a73430eee
6
+ metadata.gz: edbe1961e6d87673225914426bcb557f96ee99f6cfbe01fdb614bbe219f6b9b08f650963f6c7977b5c471b7773edec1173cac0ae24f0eabf728e8bc085a4b6ef
7
+ data.tar.gz: 91db4dbfacf4278793e69e31972e35ca2dccc757629f51581f5ea8ab08e95dddd101496535f8b250125111cc0cdd36bd9d69fefc11131e04ed2e970610d425fd
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.938
1
+ 3.0.939
@@ -43,11 +43,12 @@ module TencentCloud
43
43
 
44
44
  # BankCard2EVerification请求参数结构体
45
45
  class BankCard2EVerificationRequest < TencentCloud::Common::AbstractModel
46
- # @param Name: 姓名
46
+ # @param Name: 姓名。
47
47
  # @type Name: String
48
- # @param BankCard: 银行卡
48
+ # @param BankCard: 银行卡。
49
49
  # @type BankCard: String
50
- # @param Encryption: 敏感数据加密信息。对传入信息(姓名、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
50
+ # @param Encryption: 敏感数据加密信息。
51
+ # - 对传入信息(姓名、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
51
52
  # @type Encryption: :class:`Tencentcloud::Faceid.v20180301.models.Encryption`
52
53
 
53
54
  attr_accessor :Name, :BankCard, :Encryption
@@ -70,27 +71,28 @@ module TencentCloud
70
71
 
71
72
  # BankCard2EVerification返回参数结构体
72
73
  class BankCard2EVerificationResponse < TencentCloud::Common::AbstractModel
73
- # @param Result: 认证结果码
74
- # 计费结果码:
75
- # '0': '认证通过'
76
- # '-1': '认证未通过'
77
- # '-4': '持卡人信息有误'
78
- # '-5': '未开通无卡支付'
79
- # '-6': '此卡被没收'
80
- # '-7': '无效卡号'
81
- # '-8': '此卡无对应发卡行'
82
- # '-9': '该卡未初始化或睡眠卡'
83
- # '-10': '作弊卡、吞卡'
84
- # '-11': '此卡已挂失'
85
- # '-12': '该卡已过期'
86
- # '-13': '受限制的卡'
87
- # '-14': '密码错误次数超限'
88
- # '-15': '发卡行不支持此交易'
89
- # 不计费结果码:
90
- # '-2': '姓名校验不通过'
91
- # '-3': '银行卡号码有误'
92
- # '-16': '验证中心服务繁忙'
93
- # '-17': '验证次数超限,请次日重试'
74
+ # @param Result: 认证结果码。
75
+ # - 计费结果码:
76
+ # '0': '认证通过'
77
+ # '-1': '认证未通过'
78
+ # '-4': '持卡人信息有误'
79
+ # '-5': '未开通无卡支付'
80
+ # '-6': '此卡被没收'
81
+ # '-7': '无效卡号'
82
+ # '-8': '此卡无对应发卡行'
83
+ # '-9': '该卡未初始化或睡眠卡'
84
+ # '-10': '作弊卡、吞卡'
85
+ # '-11': '此卡已挂失'
86
+ # '-12': '该卡已过期'
87
+ # '-13': '受限制的卡'
88
+ # '-14': '密码错误次数超限'
89
+ # '-15': '发卡行不支持此交易'
90
+
91
+ # - 不计费结果码:
92
+ # '-2': '姓名校验不通过'
93
+ # '-3': '银行卡号码有误'
94
+ # '-16': '验证中心服务繁忙'
95
+ # '-17': '验证次数超限,请次日重试'。
94
96
  # @type Result: String
95
97
  # @param Description: 业务结果描述。
96
98
  # @type Description: String
@@ -114,18 +116,21 @@ module TencentCloud
114
116
 
115
117
  # BankCard4EVerification请求参数结构体
116
118
  class BankCard4EVerificationRequest < TencentCloud::Common::AbstractModel
117
- # @param Name: 姓名
119
+ # @param Name: 姓名。
118
120
  # @type Name: String
119
- # @param BankCard: 银行卡
121
+ # @param BankCard: 银行卡。
120
122
  # @type BankCard: String
121
- # @param Phone: 手机号码
123
+ # @param Phone: 手机号码。
122
124
  # @type Phone: String
123
- # @param IdCard: 开户证件号,与CertType参数的证件类型一致,如:身份证,则传入身份证号。
125
+ # @param IdCard: 开户证件号。
126
+ # - 与CertType参数的证件类型一致,如:身份证,则传入身份证号。
124
127
  # @type IdCard: String
125
- # @param CertType: 证件类型,请确认该证件为开户时使用的证件类型,未用于开户的证件信息不支持验证。
126
- # 目前默认为0:身份证,其他证件类型暂不支持。
128
+ # @param CertType: 证件类型。
129
+ # - 请确认该证件为开户时使用的证件类型,未用于开户的证件信息不支持验证。
130
+ # - 目前默认为0:身份证,其他证件类型暂不支持。
127
131
  # @type CertType: Integer
128
- # @param Encryption: 敏感数据加密信息。对传入信息(姓名、身份证号、手机号、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
132
+ # @param Encryption: 敏感数据加密信息。
133
+ # - 对传入信息(姓名、身份证号、手机号、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
129
134
  # @type Encryption: :class:`Tencentcloud::Faceid.v20180301.models.Encryption`
130
135
 
131
136
  attr_accessor :Name, :BankCard, :Phone, :IdCard, :CertType, :Encryption
@@ -154,30 +159,31 @@ module TencentCloud
154
159
 
155
160
  # BankCard4EVerification返回参数结构体
156
161
  class BankCard4EVerificationResponse < TencentCloud::Common::AbstractModel
157
- # @param Result: 认证结果码
158
- # 收费结果码:
159
- # '0': '认证通过'
160
- # '-1': '认证未通过'
161
- # '-6': '持卡人信息有误'
162
- # '-7': '未开通无卡支付'
163
- # '-8': '此卡被没收'
164
- # '-9': '无效卡号'
165
- # '-10': '此卡无对应发卡行'
166
- # '-11': '该卡未初始化或睡眠卡'
167
- # '-12': '作弊卡、吞卡'
168
- # '-13': '此卡已挂失'
169
- # '-14': '该卡已过期'
170
- # '-15': '受限制的卡'
171
- # '-16': '密码错误次数超限'
172
- # '-17': '发卡行不支持此交易'
173
- # 不收费结果码:
174
- # '-2': '姓名校验不通过'
175
- # '-3': '身份证号码有误'
176
- # '-4': '银行卡号码有误'
177
- # '-5': '手机号码不合法'
178
- # '-18': '验证中心服务繁忙'
179
- # '-19': '验证次数超限,请次日重试'
180
- # '-20': '该证件号暂不支持核验,当前仅支持二代身份证'
162
+ # @param Result: 认证结果码。
163
+ # - 收费结果码:
164
+ # '0': '认证通过'
165
+ # '-1': '认证未通过'
166
+ # '-6': '持卡人信息有误'
167
+ # '-7': '未开通无卡支付'
168
+ # '-8': '此卡被没收'
169
+ # '-9': '无效卡号'
170
+ # '-10': '此卡无对应发卡行'
171
+ # '-11': '该卡未初始化或睡眠卡'
172
+ # '-12': '作弊卡、吞卡'
173
+ # '-13': '此卡已挂失'
174
+ # '-14': '该卡已过期'
175
+ # '-15': '受限制的卡'
176
+ # '-16': '密码错误次数超限'
177
+ # '-17': '发卡行不支持此交易'
178
+
179
+ # - 不收费结果码:
180
+ # '-2': '姓名校验不通过'
181
+ # '-3': '身份证号码有误'
182
+ # '-4': '银行卡号码有误'
183
+ # '-5': '手机号码不合法'
184
+ # '-18': '验证中心服务繁忙'
185
+ # '-19': '验证次数超限,请次日重试'
186
+ # '-20': '该证件号暂不支持核验,当前仅支持二代身份证'。
181
187
  # @type Result: String
182
188
  # @param Description: 业务结果描述。
183
189
  # @type Description: String
@@ -201,16 +207,19 @@ module TencentCloud
201
207
 
202
208
  # BankCardVerification请求参数结构体
203
209
  class BankCardVerificationRequest < TencentCloud::Common::AbstractModel
204
- # @param IdCard: 开户证件号,与CertType参数的证件类型一致,如:身份证,则传入身份证号。
210
+ # @param IdCard: 开户证件号。
211
+ # - 与CertType参数的证件类型一致,如:身份证,则传入身份证号。
205
212
  # @type IdCard: String
206
- # @param Name: 姓名
213
+ # @param Name: 姓名。
207
214
  # @type Name: String
208
- # @param BankCard: 银行卡
215
+ # @param BankCard: 银行卡。
209
216
  # @type BankCard: String
210
- # @param CertType: 证件类型,请确认该证件为开户时使用的证件类型,未用于开户的证件信息不支持验证。
211
- # 目前默认:0 身份证,其他证件类型暂不支持。
217
+ # @param CertType: 证件类型。
218
+ # - 请确认该证件为开户时使用的证件类型,未用于开户的证件信息不支持验证。
219
+ # - 目前默认:0 身份证,其他证件类型暂不支持。
212
220
  # @type CertType: Integer
213
- # @param Encryption: 敏感数据加密信息。对传入信息(姓名、身份证号、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
221
+ # @param Encryption: 敏感数据加密信息。
222
+ # - 对传入信息(姓名、身份证号、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
214
223
  # @type Encryption: :class:`Tencentcloud::Faceid.v20180301.models.Encryption`
215
224
 
216
225
  attr_accessor :IdCard, :Name, :BankCard, :CertType, :Encryption
@@ -237,29 +246,30 @@ module TencentCloud
237
246
 
238
247
  # BankCardVerification返回参数结构体
239
248
  class BankCardVerificationResponse < TencentCloud::Common::AbstractModel
240
- # @param Result: 认证结果码
241
- # 收费结果码:
242
- # '0': '认证通过'
243
- # '-1': '认证未通过'
244
- # '-5': '持卡人信息有误'
245
- # '-6': '未开通无卡支付'
246
- # '-7': '此卡被没收'
247
- # '-8': '无效卡号'
248
- # '-9': '此卡无对应发卡行'
249
- # '-10': '该卡未初始化或睡眠卡'
250
- # '-11': '作弊卡、吞卡'
251
- # '-12': '此卡已挂失'
252
- # '-13': '该卡已过期'
253
- # '-14': '受限制的卡'
254
- # '-15': '密码错误次数超限'
255
- # '-16': '发卡行不支持此交易'
256
- # 不收费结果码:
257
- # '-2': '姓名校验不通过'
258
- # '-3': '身份证号码有误'
259
- # '-4': '银行卡号码有误'
260
- # '-17': '验证中心服务繁忙'
261
- # '-18': '验证次数超限,请次日重试'
262
- # '-19': '该证件号暂不支持核验,当前仅支持二代身份证'
249
+ # @param Result: 认证结果码。
250
+ # - 收费结果码:
251
+ # '0': '认证通过'
252
+ # '-1': '认证未通过'
253
+ # '-5': '持卡人信息有误'
254
+ # '-6': '未开通无卡支付'
255
+ # '-7': '此卡被没收'
256
+ # '-8': '无效卡号'
257
+ # '-9': '此卡无对应发卡行'
258
+ # '-10': '该卡未初始化或睡眠卡'
259
+ # '-11': '作弊卡、吞卡'
260
+ # '-12': '此卡已挂失'
261
+ # '-13': '该卡已过期'
262
+ # '-14': '受限制的卡'
263
+ # '-15': '密码错误次数超限'
264
+ # '-16': '发卡行不支持此交易'
265
+
266
+ # - 不收费结果码:
267
+ # '-2': '姓名校验不通过'
268
+ # '-3': '身份证号码有误'
269
+ # '-4': '银行卡号码有误'
270
+ # '-17': '验证中心服务繁忙'
271
+ # '-18': '验证次数超限,请次日重试'
272
+ # '-19': '该证件号暂不支持核验,当前仅支持二代身份证'。
263
273
  # @type Result: String
264
274
  # @param Description: 业务结果描述。
265
275
  # @type Description: String
@@ -338,7 +348,8 @@ module TencentCloud
338
348
  class CheckBankCardInformationRequest < TencentCloud::Common::AbstractModel
339
349
  # @param BankCard: 银行卡号。
340
350
  # @type BankCard: String
341
- # @param Encryption: 敏感数据加密信息。对传入信息(银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
351
+ # @param Encryption: 敏感数据加密信息。
352
+ # - 对传入信息(银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。
342
353
  # @type Encryption: :class:`Tencentcloud::Faceid.v20180301.models.Encryption`
343
354
 
344
355
  attr_accessor :BankCard, :Encryption
@@ -360,19 +371,25 @@ module TencentCloud
360
371
  # CheckBankCardInformation返回参数结构体
361
372
  class CheckBankCardInformationResponse < TencentCloud::Common::AbstractModel
362
373
  # @param Result: 认证结果码,收费情况如下。
363
- # 收费结果码:
374
+ # - 收费结果码:
364
375
  # 0: 查询成功
365
376
  # -1: 未查到信息
366
- # 不收费结果码:
377
+
378
+ # - 不收费结果码:
367
379
  # -2:验证中心服务繁忙
368
380
  # -3:银行卡不存在
369
381
  # -4:认证次数超过当日限制,请次日重试
370
382
  # @type Result: String
371
- # @param Description: 业务结果描述
383
+ # @param Description: 业务结果描述。
372
384
  # @type Description: String
373
- # @param AccountBank: 开户行
385
+ # @param AccountBank: 开户行。
374
386
  # @type AccountBank: String
375
- # @param AccountType: 卡性质:1. 借记卡;2. 贷记卡;3. 预付费卡;4. 准贷记卡
387
+ # @param AccountType: 卡性质。
388
+ # - 取值范围:
389
+ # 1:借记卡。
390
+ # 2:贷记卡。
391
+ # 3:预付费卡。
392
+ # 4:准贷记卡
376
393
  # @type AccountType: Integer
377
394
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
378
395
  # @type RequestId: String
@@ -414,11 +431,11 @@ module TencentCloud
414
431
 
415
432
  # CheckEidTokenStatus返回参数结构体
416
433
  class CheckEidTokenStatusResponse < TencentCloud::Common::AbstractModel
417
- # @param Status: 枚举:
418
- # init:token未验证
419
- # doing: 验证中
420
- # finished: 验证完成
421
- # timeout: token已超时
434
+ # @param Status: 状态。
435
+ # - init:EidToken未验证。
436
+ # - doing: EidToken验证中。
437
+ # - finished: EidToken验证完成。
438
+ # - timeout: EidToken已超时。
422
439
  # @type Status: String
423
440
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
424
441
  # @type RequestId: String
@@ -438,35 +455,38 @@ module TencentCloud
438
455
 
439
456
  # CheckIdCardInformation请求参数结构体
440
457
  class CheckIdCardInformationRequest < TencentCloud::Common::AbstractModel
441
- # @param ImageBase64: 身份证人像面的 Base64
442
- # 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
443
- # 支持的图片大小:所下载图片经Base64编码后不超过 7M。
444
- # 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
445
- # ImageBase64、ImageUrl二者必须提供其中之一。若都提供了,则按照ImageUrl>ImageBase64的优先级使用参数。
458
+ # @param ImageBase64: 身份证人像面的 Base64 值。
459
+ # - 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
460
+ # - 支持的图片大小:所下载图片经Base64编码后不超过 7M。
461
+ # - 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
462
+ # - ImageBase64、ImageUrl二者必须提供其中之一。若都提供了,则按照ImageUrl>ImageBase64的优先级使用参数。
446
463
  # @type ImageBase64: String
447
464
  # @param ImageUrl: 身份证人像面的 Url 地址
448
- # 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
449
- # 支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。
450
- # 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
451
- # 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
465
+ # - 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
466
+ # - 支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。
467
+ # - 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
468
+ # - 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
452
469
  # @type ImageUrl: String
453
- # @param Config: 以下可选字段均为bool 类型,默认false:
454
- # CopyWarn,复印件告警
455
- # BorderCheckWarn,边框和框内遮挡告警
456
- # ReshootWarn,翻拍告警
457
- # DetectPsWarn,PS检测告警(疑似存在PS痕迹)
458
- # TempIdWarn,临时身份证告警
459
- # Quality,图片质量告警(评价图片模糊程度)
460
-
461
- # SDK 设置方式参考:
462
- # Config = Json.stringify({"CopyWarn":true,"ReshootWarn":true})
463
- # API 3.0 Explorer 设置方式参考:
464
- # Config = {"CopyWarn":true,"ReshootWarn":true}
470
+ # @param Config: 配置。
471
+ # - 以下可选字段均为bool 类型,默认false。
472
+ # CopyWarn,复印件告警。
473
+ # BorderCheckWarn,边框和框内遮挡告警。
474
+ # ReshootWarn,翻拍告警。
475
+ # DetectPsWarn,PS检测告警(疑似存在PS痕迹)。
476
+ # TempIdWarn,临时身份证告警。
477
+ # Quality,图片质量告警(评价图片模糊程度)。
478
+
479
+ # - SDK 设置方式参考:
480
+ # Config = Json.stringify({"CopyWarn":true,"ReshootWarn":true})。
481
+
482
+ # - API 3.0 Explorer 设置方式参考:
483
+ # Config = {"CopyWarn":true,"ReshootWarn":true}。
465
484
  # @type Config: String
466
- # @param IsEncrypt: 是否需要对返回中的敏感信息进行加密。默认false。
467
- # 其中敏感信息包括:Response.IdNum、Response.Name
485
+ # @param IsEncrypt: 是否需要对返回中的敏感信息进行加密。
486
+ # - 默认false。
487
+ # - 敏感信息包括:Response.IdNum、Response.Name。
468
488
  # @type IsEncrypt: Boolean
469
- # @param IsEncryptResponse: 是否需要对响应体加密
489
+ # @param IsEncryptResponse: 是否需要对响应体加密。
470
490
  # @type IsEncryptResponse: Boolean
471
491
  # @param Encryption: 是否需要对返回中的敏感信息进行加密,需指定加密算法Algorithm、CBC加密的初始向量、加密后的对称密钥。
472
492
  # @type Encryption: :class:`Tencentcloud::Faceid.v20180301.models.Encryption`
@@ -497,43 +517,51 @@ module TencentCloud
497
517
 
498
518
  # CheckIdCardInformation返回参数结构体
499
519
  class CheckIdCardInformationResponse < TencentCloud::Common::AbstractModel
500
- # @param Sim: 相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
520
+ # @param Sim: 相似度。
521
+ # - 取值范围 [0.00, 100.00]。
522
+ # - 推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)。
501
523
  # @type Sim: Float
502
- # @param Result: 业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
524
+ # @param Result: 业务错误码。
525
+ # - 成功情况返回Success,。
526
+ # - 错误情况请参考下方错误码 列表中FailedOperation部分
503
527
  # @type Result: String
504
528
  # @param Description: 业务结果描述。
505
529
  # @type Description: String
506
- # @param Name: 姓名
530
+ # @param Name: 姓名。
507
531
  # @type Name: String
508
- # @param Sex: 性别
532
+ # @param Sex: 性别。
509
533
  # @type Sex: String
510
- # @param Nation: 民族
534
+ # @param Nation: 民族。
511
535
  # @type Nation: String
512
- # @param Birth: 出生日期
536
+ # @param Birth: 出生日期。
513
537
  # @type Birth: String
514
- # @param Address: 地址
538
+ # @param Address: 地址。
515
539
  # @type Address: String
516
- # @param IdNum: 身份证号
540
+ # @param IdNum: 身份证号。
517
541
  # @type IdNum: String
518
542
  # @param Portrait: 身份证头像照片的base64编码,如果抠图失败会拿整张身份证做比对并返回空。
519
543
  # @type Portrait: String
520
- # @param Warnings: 告警信息,当在Config中配置了告警信息会停止人像比对,Result返回错误(FailedOperation.OcrWarningOccurred)并有此告警信息,Code 告警码列表和释义:
521
-
522
- # -9101 身份证边框不完整告警,
523
- # -9102 身份证复印件告警,
524
- # -9103 身份证翻拍告警,
525
- # -9105 身份证框内遮挡告警,
526
- # -9104 临时身份证告警,
527
- # -9106 身份证 PS 告警(疑似存在PS痕迹)。
528
- # -8001 图片模糊告警
529
- # 多个会 | 隔开如 "-9101|-9106|-9104"
544
+ # @param Warnings: 告警信息。
545
+ # - 当在Config中配置了告警信息会停止人像比对,Result返回错误(FailedOperation.OcrWarningOccurred)并有此告警信息。
546
+ # - Code 告警码列表和释义:
547
+ # '-9101':身份证边框不完整告警。
548
+ # '-9102':身份证复印件告警。
549
+ # '-9103':身份证翻拍告警。
550
+ # '-9105':身份证框内遮挡告警。
551
+ # '-9104':临时身份证告警。
552
+ # '-9106':身份证 PS 告警(疑似存在PS痕迹)。
553
+ # '-8001':图片模糊告警。
554
+
555
+ # - 多个会用“|” 隔开,如 "-9101|-9106|-9104"。
530
556
  # @type Warnings: String
531
- # @param Quality: 图片质量分数,当请求Config中配置图片模糊告警该参数才有意义,取值范围(0~100),目前默认阈值是50分,低于50分会触发模糊告警。
557
+ # @param Quality: 图片质量分数。
558
+ # - 当请求Config中配置图片模糊告警该参数才有意义。
559
+ # - 取值范围(0~100),目前默认阈值是50分,低于50分会触发模糊告警。
532
560
  # @type Quality: Float
533
561
  # @param Encryption: 敏感数据加密信息。
534
562
  # 注意:此字段可能返回 null,表示取不到有效值。
535
563
  # @type Encryption: :class:`Tencentcloud::Faceid.v20180301.models.Encryption`
536
- # @param EncryptedBody: 加密后的数据
564
+ # @param EncryptedBody: 加密后的数据。
537
565
  # @type EncryptedBody: String
538
566
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
539
567
  # @type RequestId: String
@@ -582,15 +610,18 @@ module TencentCloud
582
610
 
583
611
  # CheckIdNameDate请求参数结构体
584
612
  class CheckIdNameDateRequest < TencentCloud::Common::AbstractModel
585
- # @param Name: 姓名
613
+ # @param Name: 姓名。
586
614
  # @type Name: String
587
- # @param IdCard: 身份证号
615
+ # @param IdCard: 身份证号。
588
616
  # @type IdCard: String
589
- # @param ValidityBegin: 身份证有效期开始时间,格式:YYYYMMDD。如:20210701
617
+ # @param ValidityBegin: 身份证有效期开始时间。
618
+ # - 格式:YYYYMMDD,如:20210701。
590
619
  # @type ValidityBegin: String
591
- # @param ValidityEnd: 身份证有效期到期时间,格式:YYYYMMDD,长期用“00000000”代替;如:20210701
620
+ # @param ValidityEnd: 身份证有效期到期时间。
621
+ # 格式:YYYYMMDD,长期用“00000000”代替,如:20210701。
592
622
  # @type ValidityEnd: String
593
- # @param Encryption: 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
623
+ # @param Encryption: 敏感数据加密信息。
624
+ # - 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
594
625
  # @type Encryption: :class:`Tencentcloud::Faceid.v20180301.models.Encryption`
595
626
 
596
627
  attr_accessor :Name, :IdCard, :ValidityBegin, :ValidityEnd, :Encryption
@@ -618,17 +649,19 @@ module TencentCloud
618
649
  # CheckIdNameDate返回参数结构体
619
650
  class CheckIdNameDateResponse < TencentCloud::Common::AbstractModel
620
651
  # @param Result: 认证结果码,收费情况如下。
621
- # 收费结果码:
622
- # 0: 一致
623
- # -1: 不一致
624
- # 不收费结果码:
625
- # -2: 非法身份证号(长度、校验位等不正确)
626
- # -3: 非法姓名(长度、格式等不正确)
627
- # -4: 非法有效期(长度、格式等不正确)
628
- # -5: 身份信息无效
629
- # -6: 证件库服务异常
630
- # -7: 证件库中无此身份证记录
631
- # -8: 认证次数超过当日限制,请次日重试
652
+
653
+ # - 收费结果码:
654
+ # 0: 一致。
655
+ # -1: 不一致。
656
+
657
+ # - 不收费结果码:
658
+ # -2: 非法身份证号(长度、校验位等不正确)。
659
+ # -3: 非法姓名(长度、格式等不正确)。
660
+ # -4: 非法有效期(长度、格式等不正确)。
661
+ # -5: 身份信息无效。
662
+ # -6: 证件库服务异常。
663
+ # -7: 证件库中无此身份证记录。
664
+ # -8: 认证次数超过当日限制,请次日重试。
632
665
  # @type Result: String
633
666
  # @param Description: 业务结果描述。
634
667
  # @type Description: String
@@ -652,11 +685,12 @@ module TencentCloud
652
685
 
653
686
  # CheckPhoneAndName请求参数结构体
654
687
  class CheckPhoneAndNameRequest < TencentCloud::Common::AbstractModel
655
- # @param Mobile: ⼿机号
688
+ # @param Mobile: ⼿机号。
656
689
  # @type Mobile: String
657
- # @param Name: 姓名
690
+ # @param Name: 姓名。
658
691
  # @type Name: String
659
- # @param Encryption: 敏感数据加密信息。对传入信息(姓名、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
692
+ # @param Encryption: 敏感数据加密信息。
693
+ # - 对传入信息(姓名、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
660
694
  # @type Encryption: :class:`Tencentcloud::Faceid.v20180301.models.Encryption`
661
695
 
662
696
  attr_accessor :Mobile, :Name, :Encryption
@@ -680,18 +714,19 @@ module TencentCloud
680
714
  # CheckPhoneAndName返回参数结构体
681
715
  class CheckPhoneAndNameResponse < TencentCloud::Common::AbstractModel
682
716
  # @param Result: 认证结果码,收费情况如下。
683
- # 收费结果码:
684
- # 0: 验证结果一致
685
- # 1: 验证结果不一致
686
- # 不收费结果码:
687
- # -1:查无记录
688
- # -2:引擎未知错误
689
- # -3:引擎服务异常
690
- # -4:姓名校验不通过
691
- # -5:手机号码不合法
692
- # -6: 认证次数超过当日限制,请次日重试
717
+ # - 收费结果码:
718
+ # 0: 验证结果一致。
719
+ # 1: 验证结果不一致。
720
+
721
+ # - 不收费结果码:
722
+ # -1:查无记录。
723
+ # -2:引擎未知错误。
724
+ # -3:引擎服务异常。
725
+ # -4:姓名校验不通过。
726
+ # -5:手机号码不合法。
727
+ # -6: 认证次数超过当日限制,请次日重试。
693
728
  # @type Result: String
694
- # @param Description: 业务结果描述
729
+ # @param Description: 业务结果描述。
695
730
  # @type Description: String
696
731
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
697
732
  # @type RequestId: String
@@ -714,25 +749,29 @@ module TencentCloud
714
749
  # DetectAIFakeFaces请求参数结构体
715
750
  class DetectAIFakeFacesRequest < TencentCloud::Common::AbstractModel
716
751
  # @param FaceInput: 传入需要进行检测的带有人脸的图片或视频,使用base64编码的形式。
752
+ # - 图片的Base64值:
753
+ # 建议整体图像480x640的分辨率,脸部 大小 100X100 以上。
754
+ # Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。
755
+ # 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
717
756
 
718
- # 图片的Base64值:
719
- # 建议整体图像480x640的分辨率,脸部 大小 100X100 以上;
720
- # Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
721
-
722
- # 视频的Base64值:
757
+ # - 视频的Base64值:
723
758
  # Base64编码后的大小不超过8M,支持mp4、avi、flv格式。
724
759
  # 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
725
760
  # 视频时长最大支持20s,建议时长2~5s。
726
761
  # 建议视频分辨率为480x640,帧率在25fps~30fps之间。
727
762
  # @type FaceInput: String
728
- # @param FaceInputType: 传入的类型
729
- # 1- 传入的是图片类型
730
- # 2- 传入的是视频类型
731
- # 其他 - 返回错误码InvalidParameter
763
+ # @param FaceInputType: 传入的类型。
764
+ # - 取值范围:
765
+ # 1:传入的是图片类型。
766
+ # 2:传入的是视频类型。
767
+ # 其他:返回错误码InvalidParameter。
732
768
  # @type FaceInputType: Integer
733
- # @param Encryption: 是否需要对请求信息进行全包体加密; 支持的加密算法:AES-256-CBC、SM4-GCM; 有加密需求的用户可使用此参数,详情请点击左侧链接。
769
+ # @param Encryption: 是否需要对请求信息进行全包体加密。
770
+ # - 支持的加密算法:AES-256-CBC、SM4-GCM。
771
+ # - 有加密需求的用户可使用此参数,详情请点击左侧链接。
734
772
  # @type Encryption: :class:`Tencentcloud::Faceid.v20180301.models.Encryption`
735
- # @param EncryptedBody: 加密后的密文; 加密前的数据格式如下:{"FaceInput":"AAAAA","FaceInputType":1}
773
+ # @param EncryptedBody: 加密后的密文。
774
+ # - 加密前的数据格式如下:{"FaceInput":"AAAAA","FaceInputType":1}。
736
775
  # @type EncryptedBody: String
737
776
 
738
777
  attr_accessor :FaceInput, :FaceInputType, :Encryption, :EncryptedBody
@@ -757,16 +796,16 @@ module TencentCloud
757
796
 
758
797
  # DetectAIFakeFaces返回参数结构体
759
798
  class DetectAIFakeFacesResponse < TencentCloud::Common::AbstractModel
760
- # @param AttackRiskLevel: 检测到的图片是否存在攻击:
761
- # Low:无攻击风险
762
- # Mid:中度疑似攻击
763
- # High:高度疑似攻击
799
+ # @param AttackRiskLevel: 检测到的图片是否存在攻击。
800
+ # - Low:无攻击风险。
801
+ # - Mid:中度疑似攻击。
802
+ # - High:高度疑似攻击。
764
803
  # @type AttackRiskLevel: String
765
- # @param AttackRiskDetailList: 检测到疑似的攻击痕迹列表
766
- # 说明:未检测到攻击痕迹时,返回空数组
767
- # 此出参仅作为结果判断的参考,实际应用仍建议使用AttackRiskLevel的结果。
804
+ # @param AttackRiskDetailList: 检测到疑似的攻击痕迹列表。
805
+ # - 说明:未检测到攻击痕迹时,返回空数组。
806
+ # - 此出参仅作为结果判断的参考,实际应用仍建议使用AttackRiskLevel的结果。
768
807
  # @type AttackRiskDetailList: Array
769
- # @param ExtraInfo: 额外信息
808
+ # @param ExtraInfo: 额外信息。
770
809
  # @type ExtraInfo: :class:`Tencentcloud::Faceid.v20180301.models.ExtraInfo`
771
810
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
772
811
  # @type RequestId: String
@@ -1457,7 +1496,7 @@ module TencentCloud
1457
1496
 
1458
1497
  # GetActionSequence请求参数结构体
1459
1498
  class GetActionSequenceRequest < TencentCloud::Common::AbstractModel
1460
- # @param ActionType: 默认不需要使用
1499
+ # @param ActionType: 默认不需要使用。
1461
1500
  # @type ActionType: String
1462
1501
 
1463
1502
  attr_accessor :ActionType
@@ -1473,7 +1512,8 @@ module TencentCloud
1473
1512
 
1474
1513
  # GetActionSequence返回参数结构体
1475
1514
  class GetActionSequenceResponse < TencentCloud::Common::AbstractModel
1476
- # @param ActionSequence: 动作顺序(2,1 or 1,2) 1代表张嘴,2代表闭眼。
1515
+ # @param ActionSequence: 动作顺序,例如:2,1 or 1,2。
1516
+ # - 1代表张嘴,2代表闭眼。
1477
1517
  # @type ActionSequence: String
1478
1518
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1479
1519
  # @type RequestId: String
@@ -2272,7 +2312,7 @@ module TencentCloud
2272
2312
 
2273
2313
  # GetLiveCode返回参数结构体
2274
2314
  class GetLiveCodeResponse < TencentCloud::Common::AbstractModel
2275
- # @param LiveCode: 数字验证码,如:1234
2315
+ # @param LiveCode: 数字验证码。
2276
2316
  # @type LiveCode: String
2277
2317
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2278
2318
  # @type RequestId: String
@@ -2351,22 +2391,24 @@ module TencentCloud
2351
2391
 
2352
2392
  # IdCardOCRVerification请求参数结构体
2353
2393
  class IdCardOCRVerificationRequest < TencentCloud::Common::AbstractModel
2354
- # @param IdCard: 身份证号
2355
- # 姓名和身份证号、ImageBase64、ImageUrl三者必须提供其中之一。若都提供了,则按照姓名和身份证号>ImageBase64>ImageUrl的优先级使用参数。
2394
+ # @param IdCard: 身份证号。
2395
+ # - 姓名和身份证号、ImageBase64、ImageUrl三者必须提供其中之一。
2396
+ # - 若都提供了,则按照姓名和身份证号>ImageBase64>ImageUrl的优先级使用参数。
2356
2397
  # @type IdCard: String
2357
- # @param Name: 姓名
2398
+ # @param Name: 姓名。
2358
2399
  # @type Name: String
2359
- # @param ImageBase64: 身份证人像面的 Base64
2360
- # 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
2361
- # 支持的图片大小:所下载图片经Base64编码后不超过 3M。请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
2400
+ # @param ImageBase64: 身份证人像面的 Base64 值。
2401
+ # - 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
2402
+ # - 支持的图片大小:所下载图片经Base64编码后不超过 3M。请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
2362
2403
  # @type ImageBase64: String
2363
- # @param ImageUrl: 身份证人像面的 Url 地址
2364
- # 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
2365
- # 支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。
2366
- # 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
2367
- # 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
2404
+ # @param ImageUrl: 身份证人像面的 Url 地址。
2405
+ # - 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
2406
+ # - 支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。
2407
+ # - 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
2408
+ # - 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
2368
2409
  # @type ImageUrl: String
2369
- # @param Encryption: 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2410
+ # @param Encryption: 敏感数据加密信息。
2411
+ # - 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2370
2412
  # @type Encryption: :class:`Tencentcloud::Faceid.v20180301.models.Encryption`
2371
2413
 
2372
2414
  attr_accessor :IdCard, :Name, :ImageBase64, :ImageUrl, :Encryption
@@ -2394,33 +2436,33 @@ module TencentCloud
2394
2436
  # IdCardOCRVerification返回参数结构体
2395
2437
  class IdCardOCRVerificationResponse < TencentCloud::Common::AbstractModel
2396
2438
  # @param Result: 认证结果码,收费情况如下。
2397
- # 收费结果码:
2398
- # 0: 姓名和身份证号一致
2399
- # -1: 姓名和身份证号不一致
2400
- # 不收费结果码:
2401
- # -2: 非法身份证号(长度、校验位等不正确)
2402
- # -3: 非法姓名(长度、格式等不正确)
2403
- # -4: 证件库服务异常
2404
- # -5: 证件库中无此身份证记录
2405
- # -6: 权威比对系统升级中,请稍后再试
2406
- # -7: 认证次数超过当日限制
2439
+ # - 收费结果码:
2440
+ # 0: 姓名和身份证号一致。
2441
+ # -1: 姓名和身份证号不一致。
2442
+ # - 不收费结果码:
2443
+ # -2: 非法身份证号(长度、校验位等不正确)。
2444
+ # -3: 非法姓名(长度、格式等不正确)。
2445
+ # -4: 证件库服务异常。
2446
+ # -5: 证件库中无此身份证记录。
2447
+ # -6: 权威比对系统升级中,请稍后再试。
2448
+ # -7: 认证次数超过当日限制。
2407
2449
  # @type Result: String
2408
2450
  # @param Description: 业务结果描述。
2409
2451
  # @type Description: String
2410
- # @param Name: 用于验证的姓名
2452
+ # @param Name: 用于验证的姓名。
2411
2453
  # @type Name: String
2412
- # @param IdCard: 用于验证的身份证号
2454
+ # @param IdCard: 用于验证的身份证号。
2413
2455
  # @type IdCard: String
2414
- # @param Sex: OCR得到的性别
2456
+ # @param Sex: OCR得到的性别。
2415
2457
  # 注意:此字段可能返回 null,表示取不到有效值。
2416
2458
  # @type Sex: String
2417
- # @param Nation: OCR得到的民族
2459
+ # @param Nation: OCR得到的民族。
2418
2460
  # 注意:此字段可能返回 null,表示取不到有效值。
2419
2461
  # @type Nation: String
2420
- # @param Birth: OCR得到的生日
2462
+ # @param Birth: OCR得到的生日。
2421
2463
  # 注意:此字段可能返回 null,表示取不到有效值。
2422
2464
  # @type Birth: String
2423
- # @param Address: OCR得到的地址
2465
+ # @param Address: OCR得到的地址。
2424
2466
  # 注意:此字段可能返回 null,表示取不到有效值。
2425
2467
  # @type Address: String
2426
2468
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
@@ -2455,11 +2497,12 @@ module TencentCloud
2455
2497
 
2456
2498
  # IdCardVerification请求参数结构体
2457
2499
  class IdCardVerificationRequest < TencentCloud::Common::AbstractModel
2458
- # @param IdCard: 身份证号
2500
+ # @param IdCard: 身份证号。
2459
2501
  # @type IdCard: String
2460
- # @param Name: 姓名
2502
+ # @param Name: 姓名。
2461
2503
  # @type Name: String
2462
- # @param Encryption: 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2504
+ # @param Encryption: 敏感数据加密信息。
2505
+ # - 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2463
2506
  # @type Encryption: :class:`Tencentcloud::Faceid.v20180301.models.Encryption`
2464
2507
 
2465
2508
  attr_accessor :IdCard, :Name, :Encryption
@@ -2483,7 +2526,7 @@ module TencentCloud
2483
2526
  # IdCardVerification返回参数结构体
2484
2527
  class IdCardVerificationResponse < TencentCloud::Common::AbstractModel
2485
2528
  # @param Result: 认证结果码,收费情况如下。
2486
- # 收费结果码:
2529
+ # - 收费结果码:
2487
2530
  # 0: 姓名和身份证号一致
2488
2531
  # -1: 姓名和身份证号不一致
2489
2532
  # 不收费结果码:
@@ -2878,41 +2921,43 @@ module TencentCloud
2878
2921
 
2879
2922
  # LivenessCompare请求参数结构体
2880
2923
  class LivenessCompareRequest < TencentCloud::Common::AbstractModel
2881
- # @param LivenessType: 活体检测类型,取值:LIP/ACTION/SILENT。
2882
- # LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。
2924
+ # @param LivenessType: 活体检测类型。
2925
+ # - 取值:LIP/ACTION/SILENT
2926
+ # - LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。
2883
2927
  # @type LivenessType: String
2884
- # @param ImageBase64: 用于人脸比对的照片的Base64值;
2885
- # Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。
2886
- # 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
2887
-
2888
- # 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageBase64。
2928
+ # @param ImageBase64: 用于人脸比对的照片的Base64值。
2929
+ # - Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。
2930
+ # - 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
2931
+ # - 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageBase64。
2889
2932
  # @type ImageBase64: String
2890
- # @param ImageUrl: 用于人脸比对照片的URL地址;图片下载后经Base64编码后的数据大小不超过3M,仅支持jpg、png格式。
2891
-
2892
- # 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageBase64。
2893
-
2894
- # 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
2933
+ # @param ImageUrl: 用于人脸比对照片的URL地址。
2934
+ # - 图片下载后经Base64编码后的数据大小不超过3M,仅支持jpg、png格式。
2935
+ # - 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageBase64。
2936
+ # - 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
2937
+ # - 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
2895
2938
  # @type ImageUrl: String
2896
- # @param ValidateData: 数字模式传参:传数字验证码,验证码需先调用<a href="https://cloud.tencent.com/document/product/1007/31821">获取数字验证码接口</a>得到;
2897
- # 动作模式传参:传动作顺序,动作顺序需先调用<a href="https://cloud.tencent.com/document/product/1007/31822">获取动作顺序接口</a>得到;
2898
- # 静默模式传参:空。
2939
+ # @param ValidateData: 验证数据。
2940
+ # - 数字模式传参:传数字验证码,验证码需先调用<a href="https://cloud.tencent.com/document/product/1007/31821">获取数字验证码接口</a>得到;
2941
+ # - 动作模式传参:传动作顺序,动作顺序需先调用<a href="https://cloud.tencent.com/document/product/1007/31822">获取动作顺序接口</a>得到;
2942
+ # - 静默模式传参:空。
2899
2943
  # @type ValidateData: String
2900
2944
  # @param Optional: 额外配置,传入JSON字符串。
2945
+
2946
+ # - 格式如下:
2901
2947
  # {
2902
2948
  # "BestFrameNum": 2 //需要返回多张最佳截图,取值范围2-10
2903
2949
  # }
2904
2950
  # @type Optional: String
2905
- # @param VideoBase64: 用于活体检测的视频,视频的Base64值;
2906
- # Base64编码后的大小不超过8M,支持mp4、avi、flv格式。
2907
- # 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
2908
-
2909
- # 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
2951
+ # @param VideoBase64: 用于活体检测的视频,视频的Base64值。
2952
+ # - Base64编码后的大小不超过8M,支持mp4、avi、flv格式。
2953
+ # - 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
2954
+ # - 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
2910
2955
  # @type VideoBase64: String
2911
- # @param VideoUrl: 用于活体检测的视频Url 地址。视频下载后经Base64编码后不超过 8M,视频下载耗时不超过4S,支持mp4、avi、flv格式。
2912
-
2913
- # 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
2914
-
2915
- # 建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议视频存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
2956
+ # @param VideoUrl: 用于活体检测的视频Url 地址。
2957
+ # - 视频下载后经Base64编码后不超过 8M,视频下载耗时不超过4S,支持mp4、avi、flv格式。
2958
+ # - 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
2959
+ # - 建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议视频存储于腾讯云。
2960
+ # - 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
2916
2961
  # @type VideoUrl: String
2917
2962
 
2918
2963
  attr_accessor :LivenessType, :ImageBase64, :ImageUrl, :ValidateData, :Optional, :VideoBase64, :VideoUrl
@@ -2940,16 +2985,22 @@ module TencentCloud
2940
2985
 
2941
2986
  # LivenessCompare返回参数结构体
2942
2987
  class LivenessCompareResponse < TencentCloud::Common::AbstractModel
2943
- # @param BestFrameBase64: 验证通过后的视频最佳截图照片,照片为BASE64编码后的值,jpg格式。
2988
+ # @param BestFrameBase64: 验证通过后的视频最佳截图照片。
2989
+ # - 照片为BASE64编码后的值,jpg格式。
2944
2990
  # 注意:此字段可能返回 null,表示取不到有效值。
2945
2991
  # @type BestFrameBase64: String
2946
- # @param Sim: 相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)。
2992
+ # @param Sim: 相似度。
2993
+ # - 取值范围 [0.00, 100.00]。
2994
+ # - 推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)。
2947
2995
  # @type Sim: Float
2948
- # @param Result: 业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
2996
+ # @param Result: 业务错误码。
2997
+ # - 成功情况返回Success。
2998
+ # - 错误情况请参考下方错误码,列表中FailedOperation部分。
2949
2999
  # @type Result: String
2950
3000
  # @param Description: 业务结果描述。
2951
3001
  # @type Description: String
2952
- # @param BestFrameList: 最佳截图列表,仅在配置了返回多张最佳截图时返回。
3002
+ # @param BestFrameList: 最佳截图列表。
3003
+ # - 仅在配置了返回多张最佳截图时返回。
2953
3004
  # 注意:此字段可能返回 null,表示取不到有效值。
2954
3005
  # @type BestFrameList: Array
2955
3006
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
@@ -3226,9 +3277,10 @@ module TencentCloud
3226
3277
 
3227
3278
  # MobileNetworkTimeVerification请求参数结构体
3228
3279
  class MobileNetworkTimeVerificationRequest < TencentCloud::Common::AbstractModel
3229
- # @param Mobile: 手机号码
3280
+ # @param Mobile: 手机号码。
3230
3281
  # @type Mobile: String
3231
- # @param Encryption: 敏感数据加密信息。对传入信息(手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
3282
+ # @param Encryption: 敏感数据加密信息。
3283
+ # - 对传入信息(手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
3232
3284
  # @type Encryption: :class:`Tencentcloud::Faceid.v20180301.models.Encryption`
3233
3285
 
3234
3286
  attr_accessor :Mobile, :Encryption
@@ -3250,19 +3302,21 @@ module TencentCloud
3250
3302
  # MobileNetworkTimeVerification返回参数结构体
3251
3303
  class MobileNetworkTimeVerificationResponse < TencentCloud::Common::AbstractModel
3252
3304
  # @param Result: 认证结果码,收费情况如下。
3253
- # 收费结果码:
3254
- # 0: 成功
3255
- # -2: 手机号不存在
3256
- # -3: 手机号存在,但无法查询到在网时长
3257
- # 不收费结果码:
3258
- # -1: 手机号格式不正确
3259
- # -4: 验证中心服务繁忙
3260
- # -5:认证次数超过当日限制,请次日重试
3305
+ # - 收费结果码:
3306
+ # 0: 成功。
3307
+ # -2: 手机号不存在。
3308
+ # -3: 手机号存在,但无法查询到在网时长。
3309
+
3310
+ # - 不收费结果码:
3311
+ # -1: 手机号格式不正确。
3312
+ # -4: 验证中心服务繁忙。
3313
+ # -5:认证次数超过当日限制,请次日重试。
3261
3314
  # @type Result: String
3262
3315
  # @param Description: 业务结果描述。
3263
3316
  # @type Description: String
3264
3317
  # @param Range: 在网时长区间。
3265
- # 格式为(a,b],表示在网时长在a个月以上,b个月以下。若b为+时表示没有上限。
3318
+ # - 格式为(a,b],表示在网时长在a个月以上,b个月以下。
3319
+ # - 若b为+时表示没有上限。
3266
3320
  # @type Range: String
3267
3321
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3268
3322
  # @type RequestId: String
@@ -3286,9 +3340,10 @@ module TencentCloud
3286
3340
 
3287
3341
  # MobileStatus请求参数结构体
3288
3342
  class MobileStatusRequest < TencentCloud::Common::AbstractModel
3289
- # @param Mobile: 手机号码
3343
+ # @param Mobile: 手机号码。
3290
3344
  # @type Mobile: String
3291
- # @param Encryption: 敏感数据加密信息。对传入信息(手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
3345
+ # @param Encryption: 敏感数据加密信息。
3346
+ # - 对传入信息(手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
3292
3347
  # @type Encryption: :class:`Tencentcloud::Faceid.v20180301.models.Encryption`
3293
3348
 
3294
3349
  attr_accessor :Mobile, :Encryption
@@ -3310,23 +3365,25 @@ module TencentCloud
3310
3365
  # MobileStatus返回参数结构体
3311
3366
  class MobileStatusResponse < TencentCloud::Common::AbstractModel
3312
3367
  # @param Result: 认证结果码,收费情况如下。
3313
- # 收费结果码:
3314
- # 0:成功
3315
- # 不收费结果码:
3316
- # -1:未查询到结果
3317
- # -2:手机号格式不正确
3318
- # -3:验证中心服务繁忙
3319
- # -4:认证次数超过当日限制,请次日重试
3368
+ # - 收费结果码:
3369
+ # 0:成功。
3370
+
3371
+ # - 不收费结果码:
3372
+ # -1:未查询到结果。
3373
+ # -2:手机号格式不正确。
3374
+ # -3:验证中心服务繁忙。
3375
+ # -4:认证次数超过当日限制,请次日重试。
3320
3376
  # @type Result: String
3321
3377
  # @param Description: 业务结果描述。
3322
3378
  # @type Description: String
3323
- # @param StatusCode: 状态码:
3324
- # 0:正常
3325
- # 1:停机
3326
- # 2:销号
3327
- # 3:空号
3328
- # 4:不在网
3329
- # 99:未知状态
3379
+ # @param StatusCode: 状态码。
3380
+ # - 取值范围:
3381
+ # 0:正常。
3382
+ # 1:停机。
3383
+ # 2:销号。
3384
+ # 3:空号。
3385
+ # 4:不在网。
3386
+ # 99:未知状态。
3330
3387
  # @type StatusCode: Integer
3331
3388
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3332
3389
  # @type RequestId: String
@@ -3484,13 +3541,14 @@ module TencentCloud
3484
3541
 
3485
3542
  # PhoneVerificationCMCC请求参数结构体
3486
3543
  class PhoneVerificationCMCCRequest < TencentCloud::Common::AbstractModel
3487
- # @param IdCard: 身份证号
3544
+ # @param IdCard: 身份证号。
3488
3545
  # @type IdCard: String
3489
- # @param Name: 姓名
3546
+ # @param Name: 姓名。
3490
3547
  # @type Name: String
3491
- # @param Phone: 手机号
3548
+ # @param Phone: 手机号。
3492
3549
  # @type Phone: String
3493
- # @param Encryption: 敏感数据加密信息。对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
3550
+ # @param Encryption: 敏感数据加密信息。
3551
+ # - 对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
3494
3552
  # @type Encryption: :class:`Tencentcloud::Faceid.v20180301.models.Encryption`
3495
3553
 
3496
3554
  attr_accessor :IdCard, :Name, :Phone, :Encryption
@@ -3516,18 +3574,19 @@ module TencentCloud
3516
3574
  # PhoneVerificationCMCC返回参数结构体
3517
3575
  class PhoneVerificationCMCCResponse < TencentCloud::Common::AbstractModel
3518
3576
  # @param Result: 认证结果码,收费情况如下。
3519
- # 收费结果码:
3520
- # 0: 认证通过
3521
- # -4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)
3522
- # 不收费结果码:
3523
- # -6: 手机号码不合法
3524
- # -7: 身份证号码有误
3525
- # -8: 姓名校验不通过
3526
- # -9: 没有记录
3527
- # -11: 验证中心服务繁忙
3577
+ # - 收费结果码:
3578
+ # 0: 认证通过。
3579
+ # -4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)。
3580
+
3581
+ # - 不收费结果码:
3582
+ # -6: 手机号码不合法。
3583
+ # -7: 身份证号码有误。
3584
+ # -8: 姓名校验不通过。
3585
+ # -9: 没有记录。
3586
+ # -11: 验证中心服务繁忙。
3528
3587
  # @type Result: String
3529
3588
  # @param Isp: 运营商名称。
3530
- # 取值范围为["移动","联通","电信",""]
3589
+ # - 取值范围为["移动","联通","电信",""]
3531
3590
  # @type Isp: String
3532
3591
  # @param Description: 业务结果描述。
3533
3592
  # @type Description: String
@@ -3553,13 +3612,14 @@ module TencentCloud
3553
3612
 
3554
3613
  # PhoneVerificationCTCC请求参数结构体
3555
3614
  class PhoneVerificationCTCCRequest < TencentCloud::Common::AbstractModel
3556
- # @param IdCard: 身份证号
3615
+ # @param IdCard: 身份证号。
3557
3616
  # @type IdCard: String
3558
- # @param Name: 姓名
3617
+ # @param Name: 姓名。
3559
3618
  # @type Name: String
3560
- # @param Phone: 手机号
3619
+ # @param Phone: 手机号。
3561
3620
  # @type Phone: String
3562
- # @param Encryption: 敏感数据加密信息。对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
3621
+ # @param Encryption: 敏感数据加密信息。
3622
+ # - 对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
3563
3623
  # @type Encryption: :class:`Tencentcloud::Faceid.v20180301.models.Encryption`
3564
3624
 
3565
3625
  attr_accessor :IdCard, :Name, :Phone, :Encryption
@@ -3585,18 +3645,19 @@ module TencentCloud
3585
3645
  # PhoneVerificationCTCC返回参数结构体
3586
3646
  class PhoneVerificationCTCCResponse < TencentCloud::Common::AbstractModel
3587
3647
  # @param Result: 认证结果码,收费情况如下。
3588
- # 收费结果码:
3589
- # 0: 认证通过
3590
- # -4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)
3591
- # 不收费结果码:
3592
- # -6: 手机号码不合法
3593
- # -7: 身份证号码有误
3594
- # -8: 姓名校验不通过
3595
- # -9: 没有记录
3596
- # -11: 验证中心服务繁忙
3648
+ # - 收费结果码:
3649
+ # 0: 认证通过。
3650
+ # -4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)。
3651
+
3652
+ # - 不收费结果码:
3653
+ # -6: 手机号码不合法。
3654
+ # -7: 身份证号码有误。
3655
+ # -8: 姓名校验不通过。
3656
+ # -9: 没有记录。
3657
+ # -11: 验证中心服务繁忙。
3597
3658
  # @type Result: String
3598
3659
  # @param Isp: 运营商名称。
3599
- # 取值范围为["移动","联通","电信",""]
3660
+ # - 取值范围为["移动","联通","电信",""]
3600
3661
  # @type Isp: String
3601
3662
  # @param Description: 业务结果描述。
3602
3663
  # @type Description: String
@@ -3622,13 +3683,14 @@ module TencentCloud
3622
3683
 
3623
3684
  # PhoneVerificationCUCC请求参数结构体
3624
3685
  class PhoneVerificationCUCCRequest < TencentCloud::Common::AbstractModel
3625
- # @param IdCard: 身份证号
3686
+ # @param IdCard: 身份证号。
3626
3687
  # @type IdCard: String
3627
- # @param Name: 姓名
3688
+ # @param Name: 姓名。
3628
3689
  # @type Name: String
3629
- # @param Phone: 手机号
3690
+ # @param Phone: 手机号。
3630
3691
  # @type Phone: String
3631
- # @param Encryption: 敏感数据加密信息。对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
3692
+ # @param Encryption: 敏感数据加密信息。
3693
+ # - 对传入信息(姓名、身份证号、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
3632
3694
  # @type Encryption: :class:`Tencentcloud::Faceid.v20180301.models.Encryption`
3633
3695
 
3634
3696
  attr_accessor :IdCard, :Name, :Phone, :Encryption
@@ -3654,18 +3716,19 @@ module TencentCloud
3654
3716
  # PhoneVerificationCUCC返回参数结构体
3655
3717
  class PhoneVerificationCUCCResponse < TencentCloud::Common::AbstractModel
3656
3718
  # @param Result: 认证结果码,收费情况如下。
3657
- # 收费结果码:
3658
- # 0: 认证通过
3659
- # -4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)
3660
- # 不收费结果码:
3661
- # -6: 手机号码不合法
3662
- # -7: 身份证号码有误
3663
- # -8: 姓名校验不通过
3664
- # -9: 没有记录
3665
- # -11: 验证中心服务繁忙
3719
+ # - 收费结果码:
3720
+ # 0: 认证通过。
3721
+ # -4: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)。
3722
+
3723
+ # - 不收费结果码:
3724
+ # -6: 手机号码不合法。
3725
+ # -7: 身份证号码有误。
3726
+ # -8: 姓名校验不通过。
3727
+ # -9: 没有记录。
3728
+ # -11: 验证中心服务繁忙。
3666
3729
  # @type Result: String
3667
3730
  # @param Isp: 运营商名称。
3668
- # 取值范围为["移动","联通","电信",""]
3731
+ # - 取值范围为["移动","联通","电信",""]
3669
3732
  # @type Isp: String
3670
3733
  # @param Description: 业务结果描述。
3671
3734
  # @type Description: String
@@ -3691,19 +3754,21 @@ module TencentCloud
3691
3754
 
3692
3755
  # PhoneVerification请求参数结构体
3693
3756
  class PhoneVerificationRequest < TencentCloud::Common::AbstractModel
3694
- # @param IdCard: 身份证号
3757
+ # @param IdCard: 身份证号。
3695
3758
  # @type IdCard: String
3696
- # @param Name: 姓名
3759
+ # @param Name: 姓名。
3697
3760
  # @type Name: String
3698
- # @param Phone: 手机号
3761
+ # @param Phone: 手机号。
3699
3762
  # @type Phone: String
3700
- # @param VerifyMode: 验证模式(详版/简版)。简版与详版价格不一致,详见[价格说明](https://cloud.tencent.com/document/product/1007/84321)。
3701
-
3702
- # 枚举值:0(简版),1(详版)。默认值为0。
3763
+ # @param VerifyMode: 验证模式(详版/简版)。
3764
+ # - 简版与详版价格不一致,详见[价格说明](https://cloud.tencent.com/document/product/1007/84321)。
3765
+ # - 枚举值:0(简版);1(详版)。
3766
+ # - 默认值为0。
3703
3767
  # @type VerifyMode: String
3704
- # @param CiphertextBlob: 有加密需求的用户,传入kms的CiphertextBlob,关于数据加密可查阅 <a href="https://cloud.tencent.com/document/product/1007/47180">数据加密</a> 文档。
3768
+ # @param CiphertextBlob: 有加密需求的用户,传入kms的CiphertextBlob。关于数据加密可查阅 <a href="https://cloud.tencent.com/document/product/1007/47180">数据加密</a> 文档。
3705
3769
  # @type CiphertextBlob: String
3706
- # @param EncryptList: 在使用加密服务时,填入要被加密的字段。本接口中可填入加密后的IdCard,Name,Phone中的一个或多个。
3770
+ # @param EncryptList: 在使用加密服务时,填入要被加密的字段。
3771
+ # - 本接口中可填入加密后的IdCard,Name,Phone中的一个或多个。
3707
3772
  # @type EncryptList: Array
3708
3773
  # @param Iv: 有加密需求的用户,传入CBC加密的初始向量。
3709
3774
  # @type Iv: String
@@ -3733,30 +3798,32 @@ module TencentCloud
3733
3798
 
3734
3799
  # PhoneVerification返回参数结构体
3735
3800
  class PhoneVerificationResponse < TencentCloud::Common::AbstractModel
3736
- # @param Result: 认证结果码:
3737
- # 收费结果码
3738
- # 0: 三要素信息一致
3739
- # -4: 三要素信息不一致
3740
- # 不收费结果码
3741
- # -6: 手机号码不合法
3742
- # -7: 身份证号码有误
3743
- # -8: 姓名校验不通过
3744
- # -9: 没有记录
3745
- # -11: 验证中心服务繁忙
3746
- # -12: 认证次数超过当日限制,请次日重试
3801
+ # @param Result: 认证结果码。
3802
+ # - 收费结果码
3803
+ # 0: 三要素信息一致。
3804
+ # -4: 三要素信息不一致。
3805
+
3806
+ # - 不收费结果码
3807
+ # -6: 手机号码不合法。
3808
+ # -7: 身份证号码有误。
3809
+ # -8: 姓名校验不通过。
3810
+ # -9: 没有记录。
3811
+ # -11: 验证中心服务繁忙。
3812
+ # -12: 认证次数超过当日限制,请次日重试。
3747
3813
  # @type Result: String
3748
3814
  # @param Description: 业务结果描述。
3749
3815
  # @type Description: String
3750
3816
  # @param Isp: 运营商名称。
3751
- # 取值范围为["","移动","电信","联通"]
3817
+ # - 取值范围为["","移动","电信","联通"]
3752
3818
  # @type Isp: String
3753
- # @param ResultDetail: 业务结果详细信息。(当VerifyMode配置"详版",且Result为"-4: 三要素信息不一致"时返回)
3754
- # 枚举值:
3755
- # PhoneIdCardMismatch:手机号码与姓名一致,与身份证号不一致;
3756
- # PhoneNameMismatch:手机号码身份证号一致,与姓名不一致;
3757
- # PhoneNameIdCardMismatch:手机号码与姓名和身份证号均不一致;
3758
- # NameIdCardMismatch:姓名和身份证号不一致;
3759
- # OtherMismatch:其他不一致;
3819
+ # @param ResultDetail: 业务结果详细信息。
3820
+ # - 当VerifyMode配置"详版",且Result为"-4: 三要素信息不一致"时返回。
3821
+ # - 枚举值:
3822
+ # PhoneIdCardMismatch:手机号码与姓名一致,与身份证号不一致。
3823
+ # PhoneNameMismatch:手机号码身份证号一致,与姓名不一致。
3824
+ # PhoneNameIdCardMismatch:手机号码与姓名和身份证号均不一致。
3825
+ # NameIdCardMismatch:姓名和身份证号不一致。
3826
+ # OtherMismatch:其他不一致。
3760
3827
  # @type ResultDetail: String
3761
3828
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3762
3829
  # @type RequestId: String
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-faceid
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.938
4
+ version: 3.0.939
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tencent Cloud
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-11-07 00:00:00.000000000 Z
11
+ date: 2024-11-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common