tencentcloud-sdk-faceid 3.0.941 → 3.0.942
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/VERSION +1 -1
- data/lib/v20180301/models.rb +494 -273
- metadata +2 -2
data/lib/v20180301/models.rb
CHANGED
@@ -839,37 +839,50 @@ module TencentCloud
|
|
839
839
|
|
840
840
|
# DetectAuth请求参数结构体
|
841
841
|
class DetectAuthRequest < TencentCloud::Common::AbstractModel
|
842
|
-
# @param RuleId:
|
842
|
+
# @param RuleId: 业务流程ID。
|
843
|
+
# - 用于细分客户使用场景, 可为业务配置不同的业务流程。
|
844
|
+
# - 申请开通服务后,登录腾讯云[慧眼人脸核身控制](https://console.cloud.tencent.com/faceid)进行创建,审核通过后即可调用。
|
845
|
+
# - 如有疑问,请添加[腾讯云人脸核身小助手](https://cloud.tencent.com/document/product/1007/56130)进行咨询。
|
843
846
|
# @type RuleId: String
|
844
847
|
# @param TerminalType: 本接口不需要传递此参数。
|
845
848
|
# @type TerminalType: String
|
846
|
-
# @param IdCard:
|
847
|
-
#
|
849
|
+
# @param IdCard: 验证人的身份证号码。
|
850
|
+
# - 是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示。
|
848
851
|
# @type IdCard: String
|
849
|
-
# @param Name:
|
850
|
-
#
|
852
|
+
# @param Name: 验证人的姓名。
|
853
|
+
# - 是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示。
|
854
|
+
# - 最长长度32位。中文请使用UTF-8编码。
|
851
855
|
# @type Name: String
|
852
|
-
# @param RedirectUrl:
|
856
|
+
# @param RedirectUrl: 认证结束后重定向的回调链接地址。
|
857
|
+
# - 最长长度1024位。
|
853
858
|
# @type RedirectUrl: String
|
854
859
|
# @param Extra: 透传字段,在获取验证结果时返回。
|
855
860
|
# @type Extra: String
|
856
|
-
# @param ImageBase64:
|
857
|
-
# Base64编码后的图片数据大小不超过3M
|
861
|
+
# @param ImageBase64: 用于人脸比对的图像数据,使用base64编码。
|
862
|
+
# - Base64编码后的图片数据大小不超过3M。
|
863
|
+
# - 仅支持jpg、png格式。
|
864
|
+
# - 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
|
858
865
|
# @type ImageBase64: String
|
859
866
|
# @param Encryption: 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
|
860
867
|
# @type Encryption: :class:`Tencentcloud::Faceid.v20180301.models.Encryption`
|
861
|
-
# @param IntentionVerifyText:
|
868
|
+
# @param IntentionVerifyText: 意愿核身(朗读模式)使用的文案。
|
869
|
+
# - 若未使用意愿核身(朗读模式),则该字段无需传入。
|
870
|
+
# - 最长可接受120的字符串长度。
|
862
871
|
# @type IntentionVerifyText: String
|
863
|
-
# @param IntentionQuestions:
|
872
|
+
# @param IntentionQuestions: 意愿核身(语音播报+语音回答模式)使用的文案。
|
873
|
+
# - 包括:系统语音播报的文本、需要核验的标准文本。
|
874
|
+
# - 当前仅支持1轮问答。
|
864
875
|
# @type IntentionQuestions: Array
|
865
|
-
# @param
|
866
|
-
#
|
867
|
-
#
|
876
|
+
# @param IntentionActions: 意愿核身(点头确认模式)使用的文案。
|
877
|
+
# - 若未使用意愿核身(点头确认模式),则该字段无需传入。
|
878
|
+
# - 当前仅支持一个提示文本。
|
868
879
|
# @type IntentionActions: Array
|
880
|
+
# @param Config: 意愿核身流程配置。
|
881
|
+
# @type Config: :class:`Tencentcloud::Faceid.v20180301.models.RuleIdConfig`
|
869
882
|
|
870
|
-
attr_accessor :RuleId, :TerminalType, :IdCard, :Name, :RedirectUrl, :Extra, :ImageBase64, :Encryption, :IntentionVerifyText, :IntentionQuestions, :
|
883
|
+
attr_accessor :RuleId, :TerminalType, :IdCard, :Name, :RedirectUrl, :Extra, :ImageBase64, :Encryption, :IntentionVerifyText, :IntentionQuestions, :IntentionActions, :Config
|
871
884
|
|
872
|
-
def initialize(ruleid=nil, terminaltype=nil, idcard=nil, name=nil, redirecturl=nil, extra=nil, imagebase64=nil, encryption=nil, intentionverifytext=nil, intentionquestions=nil,
|
885
|
+
def initialize(ruleid=nil, terminaltype=nil, idcard=nil, name=nil, redirecturl=nil, extra=nil, imagebase64=nil, encryption=nil, intentionverifytext=nil, intentionquestions=nil, intentionactions=nil, config=nil)
|
873
886
|
@RuleId = ruleid
|
874
887
|
@TerminalType = terminaltype
|
875
888
|
@IdCard = idcard
|
@@ -880,8 +893,8 @@ module TencentCloud
|
|
880
893
|
@Encryption = encryption
|
881
894
|
@IntentionVerifyText = intentionverifytext
|
882
895
|
@IntentionQuestions = intentionquestions
|
883
|
-
@Config = config
|
884
896
|
@IntentionActions = intentionactions
|
897
|
+
@Config = config
|
885
898
|
end
|
886
899
|
|
887
900
|
def deserialize(params)
|
@@ -905,10 +918,6 @@ module TencentCloud
|
|
905
918
|
@IntentionQuestions << intentionquestion_tmp
|
906
919
|
end
|
907
920
|
end
|
908
|
-
unless params['Config'].nil?
|
909
|
-
@Config = RuleIdConfig.new
|
910
|
-
@Config.deserialize(params['Config'])
|
911
|
-
end
|
912
921
|
unless params['IntentionActions'].nil?
|
913
922
|
@IntentionActions = []
|
914
923
|
params['IntentionActions'].each do |i|
|
@@ -917,6 +926,10 @@ module TencentCloud
|
|
917
926
|
@IntentionActions << intentionactionconfig_tmp
|
918
927
|
end
|
919
928
|
end
|
929
|
+
unless params['Config'].nil?
|
930
|
+
@Config = RuleIdConfig.new
|
931
|
+
@Config.deserialize(params['Config'])
|
932
|
+
end
|
920
933
|
end
|
921
934
|
end
|
922
935
|
|
@@ -924,8 +937,9 @@ module TencentCloud
|
|
924
937
|
class DetectAuthResponse < TencentCloud::Common::AbstractModel
|
925
938
|
# @param Url: 用于发起核身流程的URL,仅微信H5场景使用。
|
926
939
|
# @type Url: String
|
927
|
-
# @param BizToken:
|
928
|
-
#
|
940
|
+
# @param BizToken: 一次核验流程的唯一标识。
|
941
|
+
# - 有效时间为7,200秒,超过有效期再进行人脸核验会报错,请在有效期内进行核验。
|
942
|
+
# - 完成人脸核验后,需根据此标识调用[获取实名核身结果信息增强版](https://cloud.tencent.com/document/api/1007/41957)获取用户最终验证结果信息。
|
929
943
|
# @type BizToken: String
|
930
944
|
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
931
945
|
# @type RequestId: String
|
@@ -1036,7 +1050,7 @@ module TencentCloud
|
|
1036
1050
|
end
|
1037
1051
|
end
|
1038
1052
|
|
1039
|
-
#
|
1053
|
+
# 核身最佳帧信息。
|
1040
1054
|
class DetectInfoBestFrame < TencentCloud::Common::AbstractModel
|
1041
1055
|
# @param BestFrame: 活体比对最佳帧Base64编码。
|
1042
1056
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
@@ -1058,12 +1072,12 @@ module TencentCloud
|
|
1058
1072
|
end
|
1059
1073
|
end
|
1060
1074
|
|
1061
|
-
#
|
1075
|
+
# 核身身份证图片信息。
|
1062
1076
|
class DetectInfoIdCardData < TencentCloud::Common::AbstractModel
|
1063
1077
|
# @param OcrFront: OCR正面照片的base64编码。
|
1064
1078
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1065
1079
|
# @type OcrFront: String
|
1066
|
-
# @param OcrBack: OCR反面照片的base64
|
1080
|
+
# @param OcrBack: OCR反面照片的base64编码。
|
1067
1081
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1068
1082
|
# @type OcrBack: String
|
1069
1083
|
# @param ProcessedFrontImage: 旋转裁边后的正面照片base64编码。
|
@@ -1075,26 +1089,30 @@ module TencentCloud
|
|
1075
1089
|
# @param Avatar: 身份证正面人像图base64编码。
|
1076
1090
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1077
1091
|
# @type Avatar: String
|
1078
|
-
# @param WarnInfos:
|
1079
|
-
# -
|
1080
|
-
# -
|
1081
|
-
# -
|
1082
|
-
# -
|
1083
|
-
# -
|
1084
|
-
# -
|
1085
|
-
# -
|
1086
|
-
# -
|
1092
|
+
# @param WarnInfos: 身份证人像面告警码。
|
1093
|
+
# - 开启身份证告警功能后才会返回。
|
1094
|
+
# - 返回数组中可能出现的告警码如下:
|
1095
|
+
# - -9100 身份证有效日期不合法告警。
|
1096
|
+
# - -9101 身份证边框不完整告警。
|
1097
|
+
# - -9102 身份证复印件告警。
|
1098
|
+
# - -9103 身份证翻拍告警。
|
1099
|
+
# - -9105 身份证框内遮挡告警。
|
1100
|
+
# - -9104 临时身份证告警。
|
1101
|
+
# - -9106 身份证 PS 告警(疑似存在PS痕迹)。
|
1102
|
+
# - -9107 身份证反光告警。
|
1087
1103
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1088
1104
|
# @type WarnInfos: Array
|
1089
|
-
# @param BackWarnInfos:
|
1090
|
-
# -
|
1091
|
-
# -
|
1092
|
-
#
|
1093
|
-
#
|
1094
|
-
#
|
1095
|
-
#
|
1096
|
-
#
|
1097
|
-
#
|
1105
|
+
# @param BackWarnInfos: 身份证国徽面告警码。
|
1106
|
+
# - 开启身份证告警功能后才会返回。
|
1107
|
+
# - 返回数组中可能出现的告警码如下:
|
1108
|
+
# - -9100 身份证有效日期不合法告警,
|
1109
|
+
# - -9101 身份证边框不完整告警,
|
1110
|
+
# - -9102 身份证复印件告警,
|
1111
|
+
# - -9103 身份证翻拍告警,
|
1112
|
+
# - -9105 身份证框内遮挡告警,
|
1113
|
+
# - -9104 临时身份证告警,
|
1114
|
+
# - -9106 身份证 PS 告警(疑似存在PS痕迹),
|
1115
|
+
# - -9107 身份证反光告警。
|
1098
1116
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1099
1117
|
# @type BackWarnInfos: Array
|
1100
1118
|
|
@@ -1121,21 +1139,25 @@ module TencentCloud
|
|
1121
1139
|
end
|
1122
1140
|
end
|
1123
1141
|
|
1124
|
-
#
|
1142
|
+
# 核身文本信息。
|
1125
1143
|
class DetectInfoText < TencentCloud::Common::AbstractModel
|
1126
|
-
# @param ErrCode: 本次流程最终验证结果。
|
1144
|
+
# @param ErrCode: 本次流程最终验证结果。
|
1145
|
+
# - 取值范围:0为成功。
|
1146
|
+
# - 仅包含活体人脸核身结果,不包含意愿核身结果。
|
1127
1147
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1128
1148
|
# @type ErrCode: Integer
|
1129
|
-
# @param ErrMsg:
|
1149
|
+
# @param ErrMsg: 本次流程最终验证结果描述。
|
1150
|
+
# - 仅描述用,文案更新时不会通知。
|
1130
1151
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1131
1152
|
# @type ErrMsg: String
|
1132
1153
|
# @param IdCard: 本次验证使用的身份证号。
|
1133
1154
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1134
1155
|
# @type IdCard: String
|
1135
|
-
# @param UseIDType:
|
1136
|
-
#
|
1137
|
-
#
|
1138
|
-
#
|
1156
|
+
# @param UseIDType: 用户认证时使用的证件号码类型。
|
1157
|
+
# - 取值范围:
|
1158
|
+
# 0:二代身份证的证件号码。
|
1159
|
+
# 1:港澳台居住证的证件号码。
|
1160
|
+
# 2:其他(核验使用的证件号码非合法身份号码)。
|
1139
1161
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1140
1162
|
# @type UseIDType: Integer
|
1141
1163
|
# @param Name: 本次验证使用的姓名。
|
@@ -1147,13 +1169,15 @@ module TencentCloud
|
|
1147
1169
|
# @param OcrAddress: 身份校验环节识别结果:家庭住址。
|
1148
1170
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1149
1171
|
# @type OcrAddress: String
|
1150
|
-
# @param OcrBirth:
|
1172
|
+
# @param OcrBirth: 身份校验环节识别结果:生日。
|
1173
|
+
# - 格式为:YYYY/M/D
|
1151
1174
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1152
1175
|
# @type OcrBirth: String
|
1153
1176
|
# @param OcrAuthority: 身份校验环节识别结果:签发机关。
|
1154
1177
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1155
1178
|
# @type OcrAuthority: String
|
1156
|
-
# @param OcrValidDate:
|
1179
|
+
# @param OcrValidDate: 身份校验环节识别结果:有效日期。
|
1180
|
+
# - 格式为:YYYY.MM.DD-YYYY.MM.DD。
|
1157
1181
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1158
1182
|
# @type OcrValidDate: String
|
1159
1183
|
# @param OcrName: 身份校验环节识别结果:姓名。
|
@@ -1166,22 +1190,29 @@ module TencentCloud
|
|
1166
1190
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1167
1191
|
# @type OcrGender: String
|
1168
1192
|
# @param IdInfoFrom: 身份校验环节采用的信息上传方式。
|
1169
|
-
# 取值有"NFC"、"OCR"、"手动输入"、"其他"
|
1193
|
+
# - 取值有"NFC"、"OCR"、"手动输入"、"其他"
|
1170
1194
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1171
1195
|
# @type IdInfoFrom: String
|
1172
|
-
# @param LiveStatus: 本次流程最终活体结果。
|
1196
|
+
# @param LiveStatus: 本次流程最终活体结果。
|
1197
|
+
# - 0为成功
|
1173
1198
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1174
1199
|
# @type LiveStatus: Integer
|
1175
|
-
# @param LiveMsg:
|
1200
|
+
# @param LiveMsg: 本次流程最终活体结果描述。
|
1201
|
+
# - 仅描述用,文案更新时不会通知。
|
1176
1202
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1177
1203
|
# @type LiveMsg: String
|
1178
|
-
# @param Comparestatus: 本次流程最终一比一结果。
|
1204
|
+
# @param Comparestatus: 本次流程最终一比一结果。
|
1205
|
+
# - 0为成功
|
1179
1206
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1180
1207
|
# @type Comparestatus: Integer
|
1181
|
-
# @param Comparemsg:
|
1208
|
+
# @param Comparemsg: 本次流程最终一比一结果描述。
|
1209
|
+
# - 仅描述用,文案更新时不会通知。
|
1182
1210
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1183
1211
|
# @type Comparemsg: String
|
1184
|
-
# @param Sim:
|
1212
|
+
# @param Sim: 本次流程活体一比一的分数。
|
1213
|
+
# - 取值范围 [0.00, 100.00]。
|
1214
|
+
# - 相似度大于等于70时才判断为同一人,也可根据具体场景自行调整阈值。
|
1215
|
+
# - 阈值70的误通过率为千分之一,阈值80的误通过率是万分之一。
|
1185
1216
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1186
1217
|
# @type Sim: String
|
1187
1218
|
# @param Location: 地理位置经纬度。
|
@@ -1193,51 +1224,54 @@ module TencentCloud
|
|
1193
1224
|
# @param LivenessDetail: 本次流程进行的活体一比一流水。
|
1194
1225
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1195
1226
|
# @type LivenessDetail: Array
|
1196
|
-
# @param LivenessInfoTag:
|
1197
|
-
#
|
1198
|
-
#
|
1199
|
-
#
|
1200
|
-
#
|
1201
|
-
#
|
1202
|
-
#
|
1203
|
-
#
|
1204
|
-
#
|
1205
|
-
#
|
1206
|
-
#
|
1207
|
-
#
|
1208
|
-
#
|
1209
|
-
#
|
1210
|
-
#
|
1227
|
+
# @param LivenessInfoTag: 描述当前请求活体阶段被拒绝的详细原因,该参数仅限PLUS版本核身服务返回。
|
1228
|
+
# - 详情如下:
|
1229
|
+
# 01-用户全程闭眼
|
1230
|
+
# 02-用户未完成指定动作
|
1231
|
+
# 03-疑似翻拍攻击
|
1232
|
+
# 04-疑似合成攻击
|
1233
|
+
# 05-疑似黑产模版
|
1234
|
+
# 06-疑似存在水印
|
1235
|
+
# 07-反光校验未通过
|
1236
|
+
# 08-疑似中途换人
|
1237
|
+
# 09-人脸质量过差
|
1238
|
+
# 10-距离校验不通过
|
1239
|
+
# 11-疑似对抗样本攻击
|
1240
|
+
# 12-嘴巴区域疑似存在攻击痕迹
|
1241
|
+
# 13-眼睛区域疑似存在攻击痕迹
|
1242
|
+
# 14-眼睛或嘴巴被遮挡
|
1211
1243
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1212
1244
|
# @type LivenessInfoTag: Array
|
1213
1245
|
# @param Mobile: 手机号码。
|
1214
1246
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1215
1247
|
# @type Mobile: String
|
1216
|
-
# @param CompareLibType:
|
1217
|
-
#
|
1218
|
-
#
|
1219
|
-
#
|
1220
|
-
#
|
1248
|
+
# @param CompareLibType: 本次流程最终比对库源类型。
|
1249
|
+
# - 取值范围:
|
1250
|
+
# 权威库。
|
1251
|
+
# 业务方自有库(用户上传照片、客户的混合库、混合部署库)。
|
1252
|
+
# 二次验证库。
|
1253
|
+
# 人工审核库。
|
1221
1254
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1222
1255
|
# @type CompareLibType: String
|
1223
|
-
# @param LivenessMode:
|
1224
|
-
#
|
1225
|
-
#
|
1226
|
-
#
|
1227
|
-
#
|
1228
|
-
#
|
1256
|
+
# @param LivenessMode: 本次流程最终活体类型。
|
1257
|
+
# - 取值范围:
|
1258
|
+
# 0:未知
|
1259
|
+
# 1:数字活体
|
1260
|
+
# 2:动作活体
|
1261
|
+
# 3:静默活体
|
1262
|
+
# 4:一闪活体(动作+光线)
|
1229
1263
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1230
1264
|
# @type LivenessMode: Integer
|
1231
|
-
# @param NFCRequestIds: nfc重复计费requestId
|
1265
|
+
# @param NFCRequestIds: nfc重复计费requestId列表。
|
1232
1266
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1233
1267
|
# @type NFCRequestIds: Array
|
1234
|
-
# @param NFCBillingCounts: nfc
|
1268
|
+
# @param NFCBillingCounts: nfc重复计费计数。
|
1235
1269
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1236
1270
|
# @type NFCBillingCounts: Integer
|
1237
|
-
# @param PassNo:
|
1271
|
+
# @param PassNo: 港澳台居住证通行证号码。
|
1238
1272
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1239
1273
|
# @type PassNo: String
|
1240
|
-
# @param VisaNum:
|
1274
|
+
# @param VisaNum: 港澳台居住证签发次数。
|
1241
1275
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1242
1276
|
# @type VisaNum: String
|
1243
1277
|
|
@@ -1317,9 +1351,9 @@ module TencentCloud
|
|
1317
1351
|
end
|
1318
1352
|
end
|
1319
1353
|
|
1320
|
-
#
|
1354
|
+
# 核身视频信息。
|
1321
1355
|
class DetectInfoVideoData < TencentCloud::Common::AbstractModel
|
1322
|
-
# @param LivenessVideo: 活体视频的base64
|
1356
|
+
# @param LivenessVideo: 活体视频的base64编码。
|
1323
1357
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1324
1358
|
# @type LivenessVideo: String
|
1325
1359
|
|
@@ -1336,13 +1370,13 @@ module TencentCloud
|
|
1336
1370
|
|
1337
1371
|
# Eid出参,包括商户方用户的标识和加密的用户姓名身份证信息。
|
1338
1372
|
class EidInfo < TencentCloud::Common::AbstractModel
|
1339
|
-
# @param EidCode: 商户方 appeIDcode
|
1373
|
+
# @param EidCode: 商户方 appeIDcode 的数字证书。
|
1340
1374
|
# @type EidCode: String
|
1341
|
-
# @param EidSign: Eid中心针对商户方EidCode
|
1375
|
+
# @param EidSign: Eid中心针对商户方EidCode的电子签名。
|
1342
1376
|
# @type EidSign: String
|
1343
|
-
# @param DesKey: 商户方公钥加密的会话密钥的base64字符串,[指引详见](https://cloud.tencent.com/document/product/1007/63370)
|
1377
|
+
# @param DesKey: 商户方公钥加密的会话密钥的base64字符串,[指引详见](https://cloud.tencent.com/document/product/1007/63370)。
|
1344
1378
|
# @type DesKey: String
|
1345
|
-
# @param UserInfo: 会话密钥sm2加密后的base64字符串,[指引详见](https://cloud.tencent.com/document/product/1007/63370)
|
1379
|
+
# @param UserInfo: 会话密钥sm2加密后的base64字符串,[指引详见](https://cloud.tencent.com/document/product/1007/63370)。
|
1346
1380
|
# @type UserInfo: String
|
1347
1381
|
|
1348
1382
|
attr_accessor :EidCode, :EidSign, :DesKey, :UserInfo
|
@@ -1537,21 +1571,31 @@ module TencentCloud
|
|
1537
1571
|
# @type BizToken: String
|
1538
1572
|
# @param RuleId: 用于细分客户使用场景,由腾讯侧在线下对接时分配。
|
1539
1573
|
# @type RuleId: String
|
1540
|
-
# @param InfoType:
|
1541
|
-
#
|
1542
|
-
#
|
1574
|
+
# @param InfoType: 指定拉取的结果信息。
|
1575
|
+
# - 取值(0:全部;1:文本类;2:身份证信息;3:视频最佳截图信息)。
|
1576
|
+
# - 例如 13 表示拉取文本类、视频最佳截图信息。
|
1577
|
+
# - 默认值:0
|
1543
1578
|
# @type InfoType: String
|
1544
|
-
# @param BestFramesCount:
|
1579
|
+
# @param BestFramesCount: 从活体视频中截取一定张数的最佳帧。
|
1580
|
+
# - 仅部分服务支持,若需使用请与慧眼小助手沟通。
|
1581
|
+
# - 默认值为0,最大值为10,超出10的最多只给10张。
|
1582
|
+
# - InfoType需要包含3。
|
1545
1583
|
# @type BestFramesCount: Integer
|
1546
|
-
# @param IsCutIdCardImage:
|
1584
|
+
# @param IsCutIdCardImage: 是否对身份证照片进行裁边。
|
1585
|
+
# - 默认为false。
|
1586
|
+
# - InfoType需要包含2。
|
1547
1587
|
# @type IsCutIdCardImage: Boolean
|
1548
|
-
# @param IsNeedIdCardAvatar:
|
1588
|
+
# @param IsNeedIdCardAvatar: 是否需要从身份证中抠出头像。
|
1589
|
+
# - 默认为false。
|
1590
|
+
# - InfoType需要包含2。
|
1549
1591
|
# @type IsNeedIdCardAvatar: Boolean
|
1550
1592
|
# @param IsEncrypt: 已弃用。
|
1551
1593
|
# @type IsEncrypt: Boolean
|
1552
|
-
# @param Encryption:
|
1594
|
+
# @param Encryption: 是否需要对返回中的敏感信息进行加密。
|
1595
|
+
# - 只需指定加密算法Algorithm即可,其余字段传入默认值。
|
1596
|
+
# - 敏感信息包括:Response.Text.IdCard、Response.Text.Name、Response.Text.OcrIdCard、Response.Text.OcrName。
|
1553
1597
|
# @type Encryption: :class:`Tencentcloud::Faceid.v20180301.models.Encryption`
|
1554
|
-
# @param IsEncryptResponse:
|
1598
|
+
# @param IsEncryptResponse: 是否对回包整体进行加密。
|
1555
1599
|
# @type IsEncryptResponse: Boolean
|
1556
1600
|
|
1557
1601
|
attr_accessor :BizToken, :RuleId, :InfoType, :BestFramesCount, :IsCutIdCardImage, :IsNeedIdCardAvatar, :IsEncrypt, :Encryption, :IsEncryptResponse
|
@@ -1601,16 +1645,20 @@ module TencentCloud
|
|
1601
1645
|
# @param Encryption: 敏感数据加密信息。
|
1602
1646
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1603
1647
|
# @type Encryption: :class:`Tencentcloud::Faceid.v20180301.models.Encryption`
|
1604
|
-
# @param IntentionVerifyData:
|
1648
|
+
# @param IntentionVerifyData: 意愿核身朗读模式结果信息。
|
1649
|
+
# - 若未使用意愿核身功能,该字段返回值可以不处理。
|
1605
1650
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1606
1651
|
# @type IntentionVerifyData: :class:`Tencentcloud::Faceid.v20180301.models.IntentionVerifyData`
|
1607
|
-
# @param IntentionQuestionResult:
|
1652
|
+
# @param IntentionQuestionResult: 意愿核身问答模式结果。
|
1653
|
+
|
1654
|
+
# - 若未使用该意愿核身功能,该字段返回值可以不处理。
|
1608
1655
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1609
1656
|
# @type IntentionQuestionResult: :class:`Tencentcloud::Faceid.v20180301.models.IntentionQuestionResult`
|
1610
|
-
# @param IntentionActionResult:
|
1657
|
+
# @param IntentionActionResult: 意愿核身点头确认模式的结果信息。
|
1658
|
+
# - 若未使用该意愿核身功能,该字段返回值可以不处理。
|
1611
1659
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1612
1660
|
# @type IntentionActionResult: :class:`Tencentcloud::Faceid.v20180301.models.IntentionActionResult`
|
1613
|
-
# @param EncryptedBody:
|
1661
|
+
# @param EncryptedBody: 加密后的数据。
|
1614
1662
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1615
1663
|
# @type EncryptedBody: String
|
1616
1664
|
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
@@ -1767,15 +1815,28 @@ module TencentCloud
|
|
1767
1815
|
class GetEidResultRequest < TencentCloud::Common::AbstractModel
|
1768
1816
|
# @param EidToken: E证通流程的唯一标识,调用GetEidToken接口时生成。
|
1769
1817
|
# @type EidToken: String
|
1770
|
-
# @param InfoType:
|
1771
|
-
#
|
1772
|
-
#
|
1818
|
+
# @param InfoType: 指定拉取的结果信息。
|
1819
|
+
# - 取值范围:
|
1820
|
+
# 0:全部。
|
1821
|
+
# 1:文本类。
|
1822
|
+
# 2:身份证信息。
|
1823
|
+
# 3:最佳截图信息。
|
1824
|
+
# 5:意愿核身朗读模式相关结果。
|
1825
|
+
# 6:意愿核身问答模式相关结果。
|
1826
|
+
# - 例如 13表示拉取文本类、最佳截图信息。
|
1827
|
+
# - 默认值:0
|
1773
1828
|
# @type InfoType: String
|
1774
|
-
# @param BestFramesCount:
|
1829
|
+
# @param BestFramesCount: 从活体视频中截取一定张数的最佳帧。
|
1830
|
+
# - 默认为0,最大为3,超出3的最多只给3张。
|
1831
|
+
# - InfoType需要包含3。
|
1775
1832
|
# @type BestFramesCount: Integer
|
1776
|
-
# @param IsCutIdCardImage:
|
1833
|
+
# @param IsCutIdCardImage: 是否对身份证照片进行裁边。
|
1834
|
+
# - 默认为false。
|
1835
|
+
# - InfoType需要包含2。
|
1777
1836
|
# @type IsCutIdCardImage: Boolean
|
1778
|
-
# @param IsNeedIdCardAvatar:
|
1837
|
+
# @param IsNeedIdCardAvatar: 是否需要从身份证中抠出头像。
|
1838
|
+
# - 默认为false。
|
1839
|
+
# - InfoType需要包含2。
|
1779
1840
|
# @type IsNeedIdCardAvatar: Boolean
|
1780
1841
|
|
1781
1842
|
attr_accessor :EidToken, :InfoType, :BestFramesCount, :IsCutIdCardImage, :IsNeedIdCardAvatar
|
@@ -1799,7 +1860,9 @@ module TencentCloud
|
|
1799
1860
|
|
1800
1861
|
# GetEidResult返回参数结构体
|
1801
1862
|
class GetEidResultResponse < TencentCloud::Common::AbstractModel
|
1802
|
-
# @param Text:
|
1863
|
+
# @param Text: 文本类信息。
|
1864
|
+
# - 基于对敏感信息的保护,验证使用的姓名和身份证号统一通过加密后从EidInfo参数中返回。
|
1865
|
+
# - 如需获取请在控制台申请返回身份信息,详见[E证通获取实名信息指引](https://cloud.tencent.com/document/product/1007/63370)。
|
1803
1866
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1804
1867
|
# @type Text: :class:`Tencentcloud::Faceid.v20180301.models.DetectInfoText`
|
1805
1868
|
# @param IdCardData: 身份证照片信息。
|
@@ -1808,16 +1871,21 @@ module TencentCloud
|
|
1808
1871
|
# @param BestFrame: 最佳帧信息。
|
1809
1872
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1810
1873
|
# @type BestFrame: :class:`Tencentcloud::Faceid.v20180301.models.DetectInfoBestFrame`
|
1811
|
-
# @param EidInfo: Eid
|
1874
|
+
# @param EidInfo: Eid信息。
|
1875
|
+
# - 包括商户下用户唯一标识以及加密后的姓名、身份证号信息。
|
1876
|
+
# - 解密方式详见[E证通获取实名信息指引](https://cloud.tencent.com/document/product/1007/63370)
|
1812
1877
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1813
1878
|
# @type EidInfo: :class:`Tencentcloud::Faceid.v20180301.models.EidInfo`
|
1814
|
-
# @param IntentionVerifyData:
|
1879
|
+
# @param IntentionVerifyData: 意愿核身朗读模式相关信息。
|
1880
|
+
# - 若未使用意愿核身朗读功能,该字段返回值可以不处理。
|
1815
1881
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1816
1882
|
# @type IntentionVerifyData: :class:`Tencentcloud::Faceid.v20180301.models.IntentionVerifyData`
|
1817
|
-
# @param IntentionQuestionResult:
|
1883
|
+
# @param IntentionQuestionResult: 意愿核身问答模式相关信息。
|
1884
|
+
# - 若未使用意愿核身问答模式功能,该字段返回值可以不处理。
|
1818
1885
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1819
1886
|
# @type IntentionQuestionResult: :class:`Tencentcloud::Faceid.v20180301.models.IntentionQuestionResult`
|
1820
|
-
# @param IntentionActionResult:
|
1887
|
+
# @param IntentionActionResult: 意愿核身点头确认模式的结果信息。
|
1888
|
+
# - 若未使用该意愿核身功能,该字段返回值可以不处理。
|
1821
1889
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1822
1890
|
# @type IntentionActionResult: :class:`Tencentcloud::Faceid.v20180301.models.IntentionActionResult`
|
1823
1891
|
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
@@ -1872,30 +1940,55 @@ module TencentCloud
|
|
1872
1940
|
# 获取token时的配置
|
1873
1941
|
class GetEidTokenConfig < TencentCloud::Common::AbstractModel
|
1874
1942
|
# @param InputType: 姓名身份证输入方式。
|
1875
|
-
#
|
1876
|
-
#
|
1877
|
-
#
|
1878
|
-
#
|
1879
|
-
#
|
1880
|
-
#
|
1943
|
+
# - 取值范围:
|
1944
|
+
# 1:传身份证正反面OCR。
|
1945
|
+
# 2:传身份证正面OCR。
|
1946
|
+
# 3:用户手动输入。
|
1947
|
+
# 4:客户后台传入。
|
1948
|
+
# - 默认值:1。
|
1949
|
+
# - 注意:使用OCR时仅支持用户修改结果中的姓名。
|
1881
1950
|
# @type InputType: String
|
1882
|
-
# @param UseIntentionVerify:
|
1951
|
+
# @param UseIntentionVerify: 是否使用意愿核身。
|
1952
|
+
|
1953
|
+
# - 默认不使用。
|
1954
|
+
# - 注意:如开启使用,则计费标签按【意愿核身】计费标签计价;如不开启,则计费标签按【E证通】计费标签计价,价格详见:[价格说明](https://cloud.tencent.com/document/product/1007/56804)。
|
1883
1955
|
# @type UseIntentionVerify: Boolean
|
1884
|
-
# @param IntentionMode:
|
1956
|
+
# @param IntentionMode: 意愿核身模式。
|
1957
|
+
# - 取值范围:
|
1958
|
+
# 1:语音朗读模式。
|
1959
|
+
# 2:语音问答模式。
|
1960
|
+
# 3:点头确认模式。
|
1961
|
+
# - 默认值为1。
|
1885
1962
|
# @type IntentionMode: String
|
1886
|
-
# @param IntentionVerifyText:
|
1963
|
+
# @param IntentionVerifyText: 意愿核身朗读模式使用的文案。
|
1964
|
+
# - 若未使用意愿核身朗读功能,该字段无需传入。
|
1965
|
+
# - 默认为空,最长可接受120的字符串长度。
|
1887
1966
|
# @type IntentionVerifyText: String
|
1888
|
-
# @param IntentionQuestions:
|
1967
|
+
# @param IntentionQuestions: 意愿核身问答模式的配置列表。
|
1968
|
+
# - 当前仅支持一个问答。
|
1889
1969
|
# @type IntentionQuestions: Array
|
1890
|
-
# @param IntentionActions:
|
1970
|
+
# @param IntentionActions: 意愿核身(点头确认模式)使用的文案。
|
1971
|
+
# - 若未使用意愿核身(点头确认模式),则该字段无需传入。
|
1972
|
+
# - 默认为空,最长可接受150的字符串长度。
|
1891
1973
|
# @type IntentionActions: Array
|
1892
|
-
# @param IntentionRecognition:
|
1974
|
+
# @param IntentionRecognition: 意愿核身过程中识别用户的回答意图。
|
1975
|
+
# - 开启后除了IntentionQuestions的Answers列表中的标准回答会通过,近似意图的回答也会通过。
|
1976
|
+
# - 默认开启。
|
1893
1977
|
# @type IntentionRecognition: Boolean
|
1894
|
-
# @param IsSupportHMTResidentPermitOCR:
|
1978
|
+
# @param IsSupportHMTResidentPermitOCR: 是否支持港澳台居住证识别。
|
1895
1979
|
# @type IsSupportHMTResidentPermitOCR: Boolean
|
1896
|
-
# @param MouthOpenRecognition:
|
1980
|
+
# @param MouthOpenRecognition: 用户语音回答过程中是否开启张嘴识别检测。
|
1981
|
+
# - 默认不开启。
|
1982
|
+
# - 仅在意愿核身问答模式中使用。
|
1897
1983
|
# @type MouthOpenRecognition: Boolean
|
1898
|
-
# @param Speed:
|
1984
|
+
# @param Speed: 意愿核身语音播报速度。
|
1985
|
+
# - 配置后问答模式和点头模式的语音播报环节都会生效。
|
1986
|
+
# - 默认值为0。
|
1987
|
+
# - 取值范围:
|
1988
|
+
# 0:智能语速(根据播报文案的长度自动调整语音播报速度)。
|
1989
|
+
# 1:固定1倍速。
|
1990
|
+
# 2:固定1.2倍速。
|
1991
|
+
# 3:固定1.5倍速。
|
1899
1992
|
# @type Speed: Integer
|
1900
1993
|
|
1901
1994
|
attr_accessor :InputType, :UseIntentionVerify, :IntentionMode, :IntentionVerifyText, :IntentionQuestions, :IntentionActions, :IntentionRecognition, :IsSupportHMTResidentPermitOCR, :MouthOpenRecognition, :Speed
|
@@ -1943,20 +2036,30 @@ module TencentCloud
|
|
1943
2036
|
|
1944
2037
|
# GetEidToken请求参数结构体
|
1945
2038
|
class GetEidTokenRequest < TencentCloud::Common::AbstractModel
|
1946
|
-
# @param MerchantId: EID商户id
|
2039
|
+
# @param MerchantId: EID商户id。
|
2040
|
+
# - 字段长度最长50位。
|
1947
2041
|
# @type MerchantId: String
|
1948
|
-
# @param IdCard:
|
1949
|
-
#
|
2042
|
+
# @param IdCard: 身份标识。
|
2043
|
+
# - 未使用OCR服务时,必须传入。
|
2044
|
+
# - 规则:a-z,A-Z,0-9组合。
|
2045
|
+
# - 最长长度32位。
|
1950
2046
|
# @type IdCard: String
|
1951
|
-
# @param Name:
|
2047
|
+
# @param Name: 姓名。
|
2048
|
+
# - 未使用OCR服务时,必须传入。
|
2049
|
+
# - 最长长度32位。
|
2050
|
+
# - 中文请使用UTF-8编码。
|
1952
2051
|
# @type Name: String
|
1953
|
-
# @param Extra:
|
2052
|
+
# @param Extra: 透传字段,在获取验证结果时返回。
|
2053
|
+
# - 最长长度1024位。
|
1954
2054
|
# @type Extra: String
|
1955
2055
|
# @param Config: 小程序模式配置,包括如何传入姓名身份证的配置,以及是否使用意愿核身。
|
1956
2056
|
# @type Config: :class:`Tencentcloud::Faceid.v20180301.models.GetEidTokenConfig`
|
1957
|
-
# @param RedirectUrl:
|
2057
|
+
# @param RedirectUrl: 用户从Url中进入核身认证结束后重定向的回调链接地址。
|
2058
|
+
# - 最长长度1024位。
|
2059
|
+
# - EidToken会在该链接的query参数中。
|
1958
2060
|
# @type RedirectUrl: String
|
1959
|
-
# @param Encryption:
|
2061
|
+
# @param Encryption: 敏感数据加密信息。
|
2062
|
+
# - 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
|
1960
2063
|
# @type Encryption: :class:`Tencentcloud::Faceid.v20180301.models.Encryption`
|
1961
2064
|
|
1962
2065
|
attr_accessor :MerchantId, :IdCard, :Name, :Extra, :Config, :RedirectUrl, :Encryption
|
@@ -1990,10 +2093,12 @@ module TencentCloud
|
|
1990
2093
|
|
1991
2094
|
# GetEidToken返回参数结构体
|
1992
2095
|
class GetEidTokenResponse < TencentCloud::Common::AbstractModel
|
1993
|
-
# @param EidToken:
|
1994
|
-
#
|
2096
|
+
# @param EidToken: 一次核身流程的标识。
|
2097
|
+
# - 有效时间为600秒。
|
2098
|
+
# - 完成核身后,可用该标识获取验证结果信息。
|
1995
2099
|
# @type EidToken: String
|
1996
|
-
# @param Url: 发起核身流程的URL
|
2100
|
+
# @param Url: 发起核身流程的URL。
|
2101
|
+
# - 用于H5场景核身。
|
1997
2102
|
# @type Url: String
|
1998
2103
|
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
1999
2104
|
# @type RequestId: String
|
@@ -2015,11 +2120,14 @@ module TencentCloud
|
|
2015
2120
|
|
2016
2121
|
# GetFaceIdResult请求参数结构体
|
2017
2122
|
class GetFaceIdResultRequest < TencentCloud::Common::AbstractModel
|
2018
|
-
# @param FaceIdToken: SDK
|
2123
|
+
# @param FaceIdToken: SDK人脸核身流程的标识。
|
2124
|
+
# - 调用GetFaceIdToken接口时生成。
|
2019
2125
|
# @type FaceIdToken: String
|
2020
|
-
# @param IsNeedVideo:
|
2126
|
+
# @param IsNeedVideo: 是否需要拉取视频。
|
2127
|
+
# - 默认false:不需要。
|
2021
2128
|
# @type IsNeedVideo: Boolean
|
2022
|
-
# @param IsNeedBestFrame:
|
2129
|
+
# @param IsNeedBestFrame: 是否需要拉取截帧。
|
2130
|
+
# - 默认false:不需要。
|
2023
2131
|
# @type IsNeedBestFrame: Boolean
|
2024
2132
|
|
2025
2133
|
attr_accessor :FaceIdToken, :IsNeedVideo, :IsNeedBestFrame
|
@@ -2039,50 +2147,75 @@ module TencentCloud
|
|
2039
2147
|
|
2040
2148
|
# GetFaceIdResult返回参数结构体
|
2041
2149
|
class GetFaceIdResultResponse < TencentCloud::Common::AbstractModel
|
2042
|
-
# @param IdCard:
|
2150
|
+
# @param IdCard: 身份证。
|
2043
2151
|
# @type IdCard: String
|
2044
|
-
# @param Name:
|
2152
|
+
# @param Name: 姓名。
|
2045
2153
|
# @type Name: String
|
2046
|
-
# @param Result:
|
2154
|
+
# @param Result: 业务核验结果。
|
2155
|
+
# - 参考:https://cloud.tencent.com/document/product/1007/47912。
|
2047
2156
|
# @type Result: String
|
2048
|
-
# @param Description:
|
2157
|
+
# @param Description: 业务核验描述。
|
2049
2158
|
# @type Description: String
|
2050
|
-
# @param Similarity:
|
2159
|
+
# @param Similarity: 相似度。
|
2160
|
+
# - 取值:0-100。
|
2161
|
+
# - 数值越大相似度越高。
|
2051
2162
|
# @type Similarity: Float
|
2052
|
-
# @param VideoBase64: 用户核验的视频base64
|
2163
|
+
# @param VideoBase64: 用户核验的视频base64。
|
2164
|
+
# - 如果选择了使用cos,返回完整cos地址,如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey。
|
2053
2165
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
2054
2166
|
# @type VideoBase64: String
|
2055
|
-
# @param BestFrameBase64: 用户核验视频的截帧base64
|
2167
|
+
# @param BestFrameBase64: 用户核验视频的截帧base64。
|
2168
|
+
# - 如果选择了使用cos,返回完整cos地址如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey。
|
2056
2169
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
2057
2170
|
# @type BestFrameBase64: String
|
2058
|
-
# @param Extra: 获取token
|
2171
|
+
# @param Extra: 获取token时透传的信息。
|
2059
2172
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
2060
2173
|
# @type Extra: String
|
2061
|
-
# @param DeviceInfoTag: plus
|
2062
|
-
#
|
2063
|
-
#
|
2064
|
-
#
|
2065
|
-
#
|
2066
|
-
#
|
2067
|
-
#
|
2068
|
-
#
|
2069
|
-
#
|
2174
|
+
# @param DeviceInfoTag: plus版:描述当前请求所在设备的风险标签。
|
2175
|
+
# - 详情如下:
|
2176
|
+
# 01-设备疑似被Root/设备疑似越狱。
|
2177
|
+
# 02-设备疑似被注入。
|
2178
|
+
# 03-设备疑似为模拟器。
|
2179
|
+
# 04-设备疑似存在风险操作。
|
2180
|
+
# 05-摄像头疑似被劫持。
|
2181
|
+
# 06-疑似黑产设备。
|
2182
|
+
# null-无设备风险。
|
2183
|
+
# - 增强版:此字段不生效,默认为null。
|
2070
2184
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
2071
2185
|
# @type DeviceInfoTag: String
|
2072
|
-
# @param RiskInfoTag:
|
2186
|
+
# @param RiskInfoTag: 行为风险标签。
|
2187
|
+
# - 仅错误码返回1007(设备疑似被劫持)时返回风险标签。
|
2188
|
+
# - 标签说明:
|
2073
2189
|
# 02:攻击风险
|
2074
2190
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
2075
2191
|
# @type RiskInfoTag: String
|
2076
|
-
# @param LivenessInfoTag: plus
|
2192
|
+
# @param LivenessInfoTag: plus版:描述当前请求活体阶段被拒绝的详细原因。
|
2193
|
+
# - 详情如下:
|
2194
|
+
# 01-用户全程闭眼。
|
2195
|
+
# 02-用户未完成指定动作。
|
2196
|
+
# 03-疑似翻拍攻击。
|
2197
|
+
# 04-疑似合成图片。
|
2198
|
+
# 05-疑似合成视频。
|
2199
|
+
# 06-疑似合成动作。
|
2200
|
+
# 07-疑似黑产模板。
|
2201
|
+
# 08-疑似存在水印。
|
2202
|
+
# 09-反光校验未通过。
|
2203
|
+
# 10-最佳帧校验未通过。
|
2204
|
+
# 11-人脸质量过差。
|
2205
|
+
# 12-人脸距离不匹配。
|
2206
|
+
# 13-疑似对抗样本攻击。
|
2207
|
+
# null-无。
|
2208
|
+
# - 增强版:此字段不生效,默认为null。
|
2077
2209
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
2078
2210
|
# @type LivenessInfoTag: String
|
2079
|
-
# @param DeviceInfoLevel: plus版:描述当前请求所在设备的风险等级,共4
|
2080
|
-
#
|
2081
|
-
#
|
2082
|
-
#
|
2083
|
-
#
|
2084
|
-
#
|
2085
|
-
#
|
2211
|
+
# @param DeviceInfoLevel: plus版:描述当前请求所在设备的风险等级,共4级。
|
2212
|
+
# - 详情如下:
|
2213
|
+
# 1 - 安全。
|
2214
|
+
# 2 - 低风险。
|
2215
|
+
# 3 - 中风险。
|
2216
|
+
# 4 - 高危。
|
2217
|
+
# null - 未获取到风险等级。
|
2218
|
+
# - 增强版:此字段不生效,默认为null。
|
2086
2219
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
2087
2220
|
# @type DeviceInfoLevel: String
|
2088
2221
|
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
@@ -2141,22 +2274,50 @@ module TencentCloud
|
|
2141
2274
|
|
2142
2275
|
# GetFaceIdRiskInfo返回参数结构体
|
2143
2276
|
class GetFaceIdRiskInfoResponse < TencentCloud::Common::AbstractModel
|
2144
|
-
# @param DeviceInfoTag:
|
2277
|
+
# @param DeviceInfoTag: 描述当前请求所在设备的风险标签
|
2278
|
+
# - 详情如下:
|
2279
|
+
# 01-设备疑似被Root/设备疑似越狱。
|
2280
|
+
# 02-设备疑似被注入。
|
2281
|
+
# 03-设备疑似为模拟器。
|
2282
|
+
# 04-设备疑似存在风险操作。
|
2283
|
+
# 05-摄像头疑似被劫持。
|
2284
|
+
# 06-疑似黑产设备。
|
2145
2285
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
2146
2286
|
# @type DeviceInfoTag: String
|
2147
|
-
# @param DeviceInfoLevel: 描述当前请求所在设备的风险等级,共4
|
2287
|
+
# @param DeviceInfoLevel: 描述当前请求所在设备的风险等级,共4级。
|
2288
|
+
# - 详情如下:
|
2289
|
+
# 1 - 低风险。
|
2290
|
+
# 2 - 中风险。
|
2291
|
+
# 3 - 高风险。
|
2292
|
+
# 4 - 攻击。
|
2293
|
+
# -1表示未获取到风险等级。
|
2148
2294
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
2149
2295
|
# @type DeviceInfoLevel: Integer
|
2150
|
-
# @param OpenId: 设备id
|
2296
|
+
# @param OpenId: 设备id标识。
|
2151
2297
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
2152
2298
|
# @type OpenId: String
|
2153
|
-
# @param CameraInfoLevel: 描述当前请求所在设备的相机指纹风险等级,共4
|
2299
|
+
# @param CameraInfoLevel: 描述当前请求所在设备的相机指纹风险等级,共4级。
|
2300
|
+
# - 详情如下:
|
2301
|
+
# 1 - 低风险。
|
2302
|
+
# 2 - 中风险。
|
2303
|
+
# 3 - 高风险。
|
2304
|
+
# 4 - 攻击。
|
2305
|
+
# -1表示未获取到风险等级。
|
2154
2306
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
2155
2307
|
# @type CameraInfoLevel: Integer
|
2156
|
-
# @param CameraInfoTag:
|
2308
|
+
# @param CameraInfoTag: 描述当前请求所在设备的相机指纹风险标签。
|
2309
|
+
|
2310
|
+
# - 详情如下:
|
2311
|
+
# 01-设备疑似被Root/设备疑似越狱。
|
2312
|
+
# 02-设备疑似被注入。
|
2313
|
+
# 03-设备疑似为模拟器。
|
2314
|
+
# 04-设备疑似存在风险操作。
|
2315
|
+
# 05-摄像头疑似被劫持。
|
2316
|
+
# 06-疑似黑产设备。
|
2317
|
+
# 空表示没有相机指纹风险。
|
2157
2318
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
2158
2319
|
# @type CameraInfoTag: String
|
2159
|
-
# @param Extra: 获取token
|
2320
|
+
# @param Extra: 获取token时透传的信息。
|
2160
2321
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
2161
2322
|
# @type Extra: String
|
2162
2323
|
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
@@ -2187,26 +2348,38 @@ module TencentCloud
|
|
2187
2348
|
|
2188
2349
|
# GetFaceIdToken请求参数结构体
|
2189
2350
|
class GetFaceIdTokenRequest < TencentCloud::Common::AbstractModel
|
2190
|
-
# @param CompareLib:
|
2351
|
+
# @param CompareLib: 比对库。
|
2352
|
+
# - 取值范围:
|
2353
|
+
# LOCAL:本地上传照片。
|
2354
|
+
# BUSINESS:商业库。
|
2191
2355
|
# @type CompareLib: String
|
2192
|
-
# @param IdCard:
|
2356
|
+
# @param IdCard: 身份证。
|
2357
|
+
# - CompareLib为商业库时必传。
|
2193
2358
|
# @type IdCard: String
|
2194
|
-
# @param Name:
|
2359
|
+
# @param Name: 姓名。
|
2360
|
+
# - CompareLib为商业库时必传。
|
2195
2361
|
# @type Name: String
|
2196
|
-
# @param ImageBase64:
|
2197
|
-
#
|
2362
|
+
# @param ImageBase64: 图片的Base64。
|
2363
|
+
# - CompareLib为上传照片比对时必传。
|
2364
|
+
# - Base64后图片最大8MB。
|
2365
|
+
# - 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
|
2198
2366
|
# @type ImageBase64: String
|
2199
|
-
# @param Meta: SDK中生成的Meta
|
2367
|
+
# @param Meta: SDK中生成的Meta字符串。
|
2200
2368
|
# @type Meta: String
|
2201
|
-
# @param Extra:
|
2369
|
+
# @param Extra: 透传参数。
|
2370
|
+
# - 1000长度字符串
|
2202
2371
|
# @type Extra: String
|
2203
|
-
# @param UseCos:
|
2204
|
-
#
|
2372
|
+
# @param UseCos: 是否使用cos桶。
|
2373
|
+
# - 默认为false。
|
2374
|
+
# - 设置该参数为true后,核身过程中的视频图片将会存储在人脸核身控制台授权cos的bucket中,拉取结果时会返回对应资源完整cos地址。
|
2375
|
+
# - 开通地址见https://console.cloud.tencent.com/faceid/cos
|
2376
|
+
# - 【注意】选择该参数为true后将不返回base64数据,请根据接入情况谨慎修改。
|
2205
2377
|
# @type UseCos: Boolean
|
2206
2378
|
# @param Encryption: 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
|
2207
2379
|
# @type Encryption: :class:`Tencentcloud::Faceid.v20180301.models.Encryption`
|
2208
|
-
# @param RuleId:
|
2209
|
-
#
|
2380
|
+
# @param RuleId: 用于细分客户使用场景。
|
2381
|
+
# - 申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。
|
2382
|
+
# - 如有疑问,请添加腾讯云人脸核身小助手进行咨询。
|
2210
2383
|
# @type RuleId: String
|
2211
2384
|
|
2212
2385
|
attr_accessor :CompareLib, :IdCard, :Name, :ImageBase64, :Meta, :Extra, :UseCos, :Encryption, :RuleId
|
@@ -2241,7 +2414,7 @@ module TencentCloud
|
|
2241
2414
|
|
2242
2415
|
# GetFaceIdToken返回参数结构体
|
2243
2416
|
class GetFaceIdTokenResponse < TencentCloud::Common::AbstractModel
|
2244
|
-
# @param FaceIdToken: 有效期 10
|
2417
|
+
# @param FaceIdToken: token值。- 有效期 10分钟。- 只能完成1次核身。
|
2245
2418
|
# @type FaceIdToken: String
|
2246
2419
|
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
2247
2420
|
# @type RequestId: String
|
@@ -2261,9 +2434,9 @@ module TencentCloud
|
|
2261
2434
|
|
2262
2435
|
# GetFaceidRiskInfoToken请求参数结构体
|
2263
2436
|
class GetFaceidRiskInfoTokenRequest < TencentCloud::Common::AbstractModel
|
2264
|
-
# @param Meta: SDK中生成的Meta
|
2437
|
+
# @param Meta: SDK中生成的Meta字符串。
|
2265
2438
|
# @type Meta: String
|
2266
|
-
# @param Extra: 透传参数 1000
|
2439
|
+
# @param Extra: 透传参数 1000长度字符串。
|
2267
2440
|
# @type Extra: String
|
2268
2441
|
|
2269
2442
|
attr_accessor :Meta, :Extra
|
@@ -2624,9 +2797,10 @@ module TencentCloud
|
|
2624
2797
|
|
2625
2798
|
# ImageRecognitionV2请求参数结构体
|
2626
2799
|
class ImageRecognitionV2Request < TencentCloud::Common::AbstractModel
|
2627
|
-
# @param IdCard:
|
2800
|
+
# @param IdCard: 身份证号。
|
2628
2801
|
# @type IdCard: String
|
2629
|
-
# @param Name:
|
2802
|
+
# @param Name: 姓名。
|
2803
|
+
# - 中文请使用UTF-8编码。
|
2630
2804
|
# @type Name: String
|
2631
2805
|
# @param ImageBase64: 用于人脸比对的照片,图片的Base64值;
|
2632
2806
|
# Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。
|
@@ -2634,7 +2808,8 @@ module TencentCloud
|
|
2634
2808
|
# @type ImageBase64: String
|
2635
2809
|
# @param Optional: 本接口不需要传递此参数。
|
2636
2810
|
# @type Optional: String
|
2637
|
-
# @param Encryption:
|
2811
|
+
# @param Encryption: 敏感数据加密信息。
|
2812
|
+
# - 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
|
2638
2813
|
# @type Encryption: :class:`Tencentcloud::Faceid.v20180301.models.Encryption`
|
2639
2814
|
|
2640
2815
|
attr_accessor :IdCard, :Name, :ImageBase64, :Optional, :Encryption
|
@@ -2661,9 +2836,13 @@ module TencentCloud
|
|
2661
2836
|
|
2662
2837
|
# ImageRecognitionV2返回参数结构体
|
2663
2838
|
class ImageRecognitionV2Response < TencentCloud::Common::AbstractModel
|
2664
|
-
# @param Sim:
|
2839
|
+
# @param Sim: 相似度。
|
2840
|
+
# - 取值范围 [0.00, 100.00]。
|
2841
|
+
# - 推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
|
2665
2842
|
# @type Sim: Float
|
2666
|
-
# @param Result:
|
2843
|
+
# @param Result: 业务错误码。
|
2844
|
+
# - 成功情况返回Success。
|
2845
|
+
# - 错误情况请参考下方错误码 列表中FailedOperation部分
|
2667
2846
|
# @type Result: String
|
2668
2847
|
# @param Description: 业务结果描述。
|
2669
2848
|
# @type Description: String
|
@@ -2781,9 +2960,12 @@ module TencentCloud
|
|
2781
2960
|
|
2782
2961
|
# 意愿核身过程中播报的问题文本、用户回答的标准文本。
|
2783
2962
|
class IntentionQuestion < TencentCloud::Common::AbstractModel
|
2784
|
-
# @param Question:
|
2963
|
+
# @param Question: 当选择语音问答模式时,系统自动播报的问题文本。
|
2964
|
+
# - 最大长度为150个字符。
|
2785
2965
|
# @type Question: String
|
2786
|
-
# @param Answers:
|
2966
|
+
# @param Answers: 当选择语音问答模式时,用于判断用户回答是否通过的标准答案列表。
|
2967
|
+
# - 传入后可自动判断用户回答文本是否在标准文本列表中。
|
2968
|
+
# - 列表长度最大为50,单个答案长度限制10个字符。
|
2787
2969
|
# @type Answers: Array
|
2788
2970
|
|
2789
2971
|
attr_accessor :Question, :Answers
|
@@ -2799,53 +2981,59 @@ module TencentCloud
|
|
2799
2981
|
end
|
2800
2982
|
end
|
2801
2983
|
|
2802
|
-
#
|
2984
|
+
# 意愿核身问答模式结果。
|
2803
2985
|
class IntentionQuestionResult < TencentCloud::Common::AbstractModel
|
2804
|
-
# @param FinalResultDetailCode:
|
2805
|
-
#
|
2806
|
-
#
|
2807
|
-
#
|
2808
|
-
#
|
2809
|
-
#
|
2810
|
-
#
|
2811
|
-
#
|
2812
|
-
#
|
2813
|
-
#
|
2814
|
-
#
|
2815
|
-
#
|
2816
|
-
#
|
2817
|
-
#
|
2818
|
-
#
|
2819
|
-
#
|
2820
|
-
#
|
2821
|
-
#
|
2822
|
-
#
|
2823
|
-
#
|
2824
|
-
#
|
2825
|
-
#
|
2986
|
+
# @param FinalResultDetailCode: 意愿核身错误码。
|
2987
|
+
# - 取值范围:
|
2988
|
+
# 0: "成功"
|
2989
|
+
# -1: "参数错误"
|
2990
|
+
# -2: "系统异常"
|
2991
|
+
# -101: "请保持人脸在框内"
|
2992
|
+
# -102: "检测到多张人脸"
|
2993
|
+
# -103: "人脸检测失败"
|
2994
|
+
# -104: "人脸检测不完整"
|
2995
|
+
# -105: "请勿遮挡眼睛"
|
2996
|
+
# -106: "请勿遮挡嘴巴"
|
2997
|
+
# -107: "请勿遮挡鼻子"
|
2998
|
+
# -201: "人脸比对相似度低"
|
2999
|
+
# -202: "人脸比对失败"
|
3000
|
+
# -301: "意愿核验不通过"
|
3001
|
+
# -302: "用户回答阶段未检测到张嘴动作"
|
3002
|
+
# -800: "前端不兼容错误"
|
3003
|
+
# -801: "用户未授权摄像头和麦克风权限"
|
3004
|
+
# -802: "核验流程异常中断,请勿切屏或进行其他操作"
|
3005
|
+
# -803: "用户主动关闭链接/异常断开链接"
|
3006
|
+
# -998: "系统数据异常"
|
3007
|
+
# -999: "系统未知错误,请联系人工核实"
|
3008
|
+
# - 若在人脸核身过程失败、未进入意愿确认过程,则该参数返回为空,请参考人脸核身错误码结果(DetectInfoText.ErrCode)
|
2826
3009
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
2827
3010
|
# @type FinalResultDetailCode: Integer
|
2828
|
-
# @param FinalResultMessage:
|
3011
|
+
# @param FinalResultMessage: 意愿核身错误信息。
|
2829
3012
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
2830
3013
|
# @type FinalResultMessage: String
|
2831
|
-
# @param Video: 视频base64
|
3014
|
+
# @param Video: 视频base64。
|
3015
|
+
# - 其中包含全程问题和回答音频,mp4格式。
|
2832
3016
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
2833
3017
|
# @type Video: String
|
2834
|
-
# @param ScreenShot: 屏幕截图base64
|
3018
|
+
# @param ScreenShot: 屏幕截图base64列表。
|
2835
3019
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
2836
3020
|
# @type ScreenShot: Array
|
2837
|
-
# @param ResultCode:
|
2838
|
-
# 0
|
3021
|
+
# @param ResultCode: 和答案匹配结果列表。
|
3022
|
+
# - 取值范围(0:成功;-1:不匹配)
|
2839
3023
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
2840
3024
|
# @type ResultCode: Array
|
2841
|
-
# @param AsrResult:
|
3025
|
+
# @param AsrResult: 回答问题语音识别结果列表。
|
2842
3026
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
2843
3027
|
# @type AsrResult: Array
|
2844
|
-
# @param Audios:
|
3028
|
+
# @param Audios: 答案录音音频。
|
2845
3029
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
2846
3030
|
# @type Audios: Array
|
2847
|
-
# @param FinalResultCode:
|
2848
|
-
#
|
3031
|
+
# @param FinalResultCode: 意愿核身最终结果。
|
3032
|
+
# - 取值范围:
|
3033
|
+
# 0:认证通过。
|
3034
|
+
# -1:认证未通过。
|
3035
|
+
# -2:浏览器内核不兼容,无法进行意愿校验。
|
3036
|
+
# - 建议使用“FinalResultDetailCode”参数获取详细的错误码信息。
|
2849
3037
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
2850
3038
|
# @type FinalResultCode: String
|
2851
3039
|
|
@@ -2874,21 +3062,25 @@ module TencentCloud
|
|
2874
3062
|
end
|
2875
3063
|
end
|
2876
3064
|
|
2877
|
-
#
|
3065
|
+
# 意愿核身相关结果。
|
2878
3066
|
class IntentionVerifyData < TencentCloud::Common::AbstractModel
|
2879
|
-
# @param IntentionVerifyVideo: 意愿确认环节中录制的视频(base64
|
3067
|
+
# @param IntentionVerifyVideo: 意愿确认环节中录制的视频(base64)。
|
3068
|
+
# - 若不存在则为空字符串。
|
2880
3069
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
2881
3070
|
# @type IntentionVerifyVideo: String
|
2882
|
-
# @param AsrResult:
|
3071
|
+
# @param AsrResult: 意愿确认环节中用户语音转文字的识别结果。
|
3072
|
+
# - 若不存在则为空字符串。
|
2883
3073
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
2884
3074
|
# @type AsrResult: String
|
2885
|
-
# @param ErrorCode:
|
3075
|
+
# @param ErrorCode: 意愿确认环节的结果码。
|
3076
|
+
# - 当该结果码为0时,语音朗读的视频与语音识别结果才会返回。
|
2886
3077
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
2887
3078
|
# @type ErrorCode: Integer
|
2888
3079
|
# @param ErrorMessage: 意愿确认环节的结果信息。
|
2889
3080
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
2890
3081
|
# @type ErrorMessage: String
|
2891
|
-
# @param IntentionVerifyBestFrame: 意愿确认环节中录制视频的最佳帧(base64
|
3082
|
+
# @param IntentionVerifyBestFrame: 意愿确认环节中录制视频的最佳帧(base64)。
|
3083
|
+
# - 若不存在则为空字符串。
|
2892
3084
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
2893
3085
|
# @type IntentionVerifyBestFrame: String
|
2894
3086
|
# @param AsrResultSimilarity: 本次流程用户语音与传入文本比对的相似度分值,取值范围 [0.00, 100.00]。只有配置了相似度阈值后才进行语音校验并返回相似度分值。
|
@@ -3029,32 +3221,37 @@ module TencentCloud
|
|
3029
3221
|
|
3030
3222
|
# LivenessRecognition请求参数结构体
|
3031
3223
|
class LivenessRecognitionRequest < TencentCloud::Common::AbstractModel
|
3032
|
-
# @param IdCard:
|
3224
|
+
# @param IdCard: 身份证号。
|
3033
3225
|
# @type IdCard: String
|
3034
|
-
# @param Name:
|
3226
|
+
# @param Name: 姓名。
|
3227
|
+
# - 中文请使用UTF-8编码。
|
3035
3228
|
# @type Name: String
|
3036
|
-
# @param LivenessType:
|
3037
|
-
# LIP
|
3229
|
+
# @param LivenessType: 活体检测类型。
|
3230
|
+
# - 取值:LIP/ACTION/SILENT。
|
3231
|
+
# - LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。
|
3038
3232
|
# @type LivenessType: String
|
3039
3233
|
# @param VideoBase64: 用于活体检测的视频,视频的BASE64值;
|
3040
3234
|
# BASE64编码后的大小不超过8M,支持mp4、avi、flv格式。
|
3041
3235
|
# @type VideoBase64: String
|
3042
|
-
# @param VideoUrl: 用于活体检测的视频Url
|
3043
|
-
|
3044
|
-
# 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
|
3045
|
-
|
3046
|
-
#
|
3236
|
+
# @param VideoUrl: 用于活体检测的视频Url 地址。
|
3237
|
+
# - 视频下载后经Base64编码不超过 8M,视频下载耗时不超过4S,支持mp4、avi、flv格式。
|
3238
|
+
# - 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
|
3239
|
+
# - 建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议视频存储于腾讯云。
|
3240
|
+
# - 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
|
3047
3241
|
# @type VideoUrl: String
|
3048
|
-
# @param ValidateData:
|
3049
|
-
#
|
3050
|
-
#
|
3242
|
+
# @param ValidateData: 验证数据。
|
3243
|
+
# - 数字模式传参:传数字验证码,验证码需先调用<a href="https://cloud.tencent.com/document/product/1007/31821">获取数字验证码接口</a>得到;
|
3244
|
+
# - 动作模式传参:传动作顺序,动作顺序需先调用<a href="https://cloud.tencent.com/document/product/1007/31822">获取动作顺序接口</a>得到;
|
3245
|
+
# - 静默模式传参:空。
|
3051
3246
|
# @type ValidateData: String
|
3052
3247
|
# @param Optional: 额外配置,传入JSON字符串。
|
3248
|
+
# - 格式如下:
|
3053
3249
|
# {
|
3054
3250
|
# "BestFrameNum": 2 //需要返回多张最佳截图,取值范围2-10
|
3055
3251
|
# }
|
3056
3252
|
# @type Optional: String
|
3057
|
-
# @param Encryption:
|
3253
|
+
# @param Encryption: 敏感数据加密信息。
|
3254
|
+
# - 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
|
3058
3255
|
# @type Encryption: :class:`Tencentcloud::Faceid.v20180301.models.Encryption`
|
3059
3256
|
|
3060
3257
|
attr_accessor :IdCard, :Name, :LivenessType, :VideoBase64, :VideoUrl, :ValidateData, :Optional, :Encryption
|
@@ -3087,12 +3284,17 @@ module TencentCloud
|
|
3087
3284
|
|
3088
3285
|
# LivenessRecognition返回参数结构体
|
3089
3286
|
class LivenessRecognitionResponse < TencentCloud::Common::AbstractModel
|
3090
|
-
# @param BestFrameBase64:
|
3287
|
+
# @param BestFrameBase64: 验证通过后的视频最佳截图照片。
|
3288
|
+
# - 照片为BASE64编码后的值,jpg格式。
|
3091
3289
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
3092
3290
|
# @type BestFrameBase64: String
|
3093
|
-
# @param Sim:
|
3291
|
+
# @param Sim: 相似度。
|
3292
|
+
# - 取值范围 [0.00, 100.00]。
|
3293
|
+
# - 推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
|
3094
3294
|
# @type Sim: Float
|
3095
|
-
# @param Result:
|
3295
|
+
# @param Result: 业务错误码。
|
3296
|
+
# - 成功情况返回Success。
|
3297
|
+
# - 错误情况请参考下方错误码 列表中FailedOperation部分
|
3096
3298
|
# @type Result: String
|
3097
3299
|
# @param Description: 业务结果描述。
|
3098
3300
|
# @type Description: String
|
@@ -3407,7 +3609,7 @@ module TencentCloud
|
|
3407
3609
|
|
3408
3610
|
# ParseNfcData请求参数结构体
|
3409
3611
|
class ParseNfcDataRequest < TencentCloud::Common::AbstractModel
|
3410
|
-
# @param ReqId: 前端SDK
|
3612
|
+
# @param ReqId: 前端SDK返回。
|
3411
3613
|
# @type ReqId: String
|
3412
3614
|
|
3413
3615
|
attr_accessor :ReqId
|
@@ -3423,66 +3625,85 @@ module TencentCloud
|
|
3423
3625
|
|
3424
3626
|
# ParseNfcData返回参数结构体
|
3425
3627
|
class ParseNfcDataResponse < TencentCloud::Common::AbstractModel
|
3426
|
-
# @param ResultCode:
|
3628
|
+
# @param ResultCode: 结果码。
|
3629
|
+
# - 取值范围:0为首次查询成功,-1为查询失败。
|
3427
3630
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
3428
3631
|
# @type ResultCode: String
|
3429
|
-
# @param IdNum:
|
3632
|
+
# @param IdNum: 身份证号。
|
3430
3633
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
3431
3634
|
# @type IdNum: String
|
3432
|
-
# @param Name:
|
3635
|
+
# @param Name: 姓名。
|
3433
3636
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
3434
3637
|
# @type Name: String
|
3435
|
-
# @param Picture:
|
3638
|
+
# @param Picture: 照片。
|
3436
3639
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
3437
3640
|
# @type Picture: String
|
3438
|
-
# @param BirthDate:
|
3641
|
+
# @param BirthDate: 出生日期。
|
3439
3642
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
3440
3643
|
# @type BirthDate: String
|
3441
|
-
# @param BeginTime:
|
3644
|
+
# @param BeginTime: 有效期起始时间。
|
3442
3645
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
3443
3646
|
# @type BeginTime: String
|
3444
|
-
# @param EndTime:
|
3647
|
+
# @param EndTime: 有效期结束时间。
|
3445
3648
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
3446
3649
|
# @type EndTime: String
|
3447
|
-
# @param Address:
|
3650
|
+
# @param Address: 住址。
|
3448
3651
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
3449
3652
|
# @type Address: String
|
3450
|
-
# @param Nation:
|
3653
|
+
# @param Nation: 民族。
|
3451
3654
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
3452
3655
|
# @type Nation: String
|
3453
|
-
# @param Sex:
|
3656
|
+
# @param Sex: 性别。
|
3454
3657
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
3455
3658
|
# @type Sex: String
|
3456
|
-
# @param IdType:
|
3659
|
+
# @param IdType: 类型。
|
3660
|
+
# - 取值范围:
|
3661
|
+
# 01:身份证。
|
3662
|
+
# 03 :中国护照。
|
3663
|
+
# 04 :军官证。
|
3664
|
+
# 05 :武警证。
|
3665
|
+
# 06:港澳通行证 。
|
3666
|
+
# 07 :台胞证 。
|
3667
|
+
# 08:外国护照 。
|
3668
|
+
# 09 :士兵证。
|
3669
|
+
# 09 :临时身份证。
|
3670
|
+
# 11:户口本 。
|
3671
|
+
# 12 :警官证 。
|
3672
|
+
# 13:外国人永久居留证。
|
3673
|
+
# 14:港澳台居民居住证。
|
3674
|
+
# 15:回乡证。
|
3675
|
+
# 16:大陆居民来往台湾通行证。
|
3676
|
+
# 99:其他证件。
|
3457
3677
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
3458
3678
|
# @type IdType: String
|
3459
|
-
# @param EnName:
|
3679
|
+
# @param EnName: 英文姓名。
|
3460
3680
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
3461
3681
|
# @type EnName: String
|
3462
3682
|
# @param SigningOrganization: 签发机关
|
3463
3683
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
3464
3684
|
# @type SigningOrganization: String
|
3465
|
-
# @param OtherIdNum:
|
3685
|
+
# @param OtherIdNum: 港澳台居民居住证,通行证号码。
|
3466
3686
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
3467
3687
|
# @type OtherIdNum: String
|
3468
|
-
# @param Nationality:
|
3688
|
+
# @param Nationality: 旅行证件国籍。
|
3469
3689
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
3470
3690
|
# @type Nationality: String
|
3471
|
-
# @param PersonalNumber: 旅行证件机读区第二行 29~42
|
3691
|
+
# @param PersonalNumber: 旅行证件机读区第二行 29~42 位。
|
3472
3692
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
3473
3693
|
# @type PersonalNumber: String
|
3474
|
-
# @param CheckMRTD: 旅行证件类的核验结果。
|
3475
|
-
#
|
3476
|
-
#
|
3694
|
+
# @param CheckMRTD: 旅行证件类的核验结果。
|
3695
|
+
# - JSON格式如下:
|
3696
|
+
# {"result_issuer ":"签发者证书合法性验证结果 ","result_pape r":"证件安全对象合法性验证 结果 ","result_data" :"防数据篡改验证结果 ","result_chip" :"防证书件芯片被复制验证结果"} 。
|
3697
|
+
# - 取值范围: 0:验证通过,1: 验证不通过,2: 未验证,3:部分通过,当4项核验结果都为0时,表示证件为真。
|
3477
3698
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
3478
3699
|
# @type CheckMRTD: String
|
3479
|
-
# @param ImageA:
|
3700
|
+
# @param ImageA: 身份证照片面合成图片。
|
3480
3701
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
3481
3702
|
# @type ImageA: String
|
3482
|
-
# @param ImageB:
|
3703
|
+
# @param ImageB: 身份证国徽面合成图片。
|
3483
3704
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
3484
3705
|
# @type ImageB: String
|
3485
|
-
# @param ResultDescription: 对result code
|
3706
|
+
# @param ResultDescription: 对result code的结果描述。
|
3486
3707
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
3487
3708
|
# @type ResultDescription: String
|
3488
3709
|
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|