/** * 疑似攻击风险详情 */ export interface AttackRiskDetail { /** *
疑似的攻击痕迹类型,具体类型如下:
SuspectedSpoofingAttack:翻拍攻击
SuspectedSynthesisImage:疑似合成图片
SuspectedSynthesisVideo:疑似合成视频
SuspectedAnomalyAttack:人脸特征疑似非真人
SuspectedAdversarialAttack:疑似对抗样本攻击
SuspectedBlackIndustry:疑似黑产批量模板攻击
SuspectedWatermark:疑似存在水印
相似度。- 取值范围 [0.00, 100.00]。- 推荐相似度大于等于70时可判断为同一人(采用固定阈值70,误通过率为万分之一,不支持调整阈值)
*/ Sim?: number; /** *业务错误码。
业务结果描述。
*/ Description?: string; /** *调用接口中自定义的描述字段。
*/ Extra?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GetDetectInfoEnhanced返回参数结构体 */ export interface GetDetectInfoEnhancedResponse { /** * 人脸核身识别结果及文本类信息。 注意:此字段可能返回 null,表示取不到有效值。 */ Text?: DetectInfoText; /** * 身份证照片信息。 注意:此字段可能返回 null,表示取不到有效值。 */ IdCardData?: DetectInfoIdCardData; /** * 最佳帧信息。 注意:此字段可能返回 null,表示取不到有效值。 */ BestFrame?: DetectInfoBestFrame; /** * 视频信息。 注意:此字段可能返回 null,表示取不到有效值。 */ VideoData?: DetectInfoVideoData; /** * 敏感数据加密信息。 注意:此字段可能返回 null,表示取不到有效值。 */ Encryption?: Encryption; /** * 意愿核身朗读模式结果信息。 - 若未使用意愿核身功能,该字段返回值可以不处理。 注意:此字段可能返回 null,表示取不到有效值。 */ IntentionVerifyData?: IntentionVerifyData; /** * 意愿核身问答模式结果。 - 若未使用该意愿核身功能,该字段返回值可以不处理。 注意:此字段可能返回 null,表示取不到有效值。 */ IntentionQuestionResult?: IntentionQuestionResult; /** * 意愿核身点头确认模式的结果信息。 - 若未使用该意愿核身功能,该字段返回值可以不处理。 注意:此字段可能返回 null,表示取不到有效值。 */ IntentionActionResult?: IntentionActionResult; /** * 加密后的数据。 注意:此字段可能返回 null,表示取不到有效值。 */ EncryptedBody?: string; /** * 本次请求是否配置开启意愿核身校验。 false:未开启意愿核身校验 true:已开启意愿核身校验 说明:若请求开启了意愿核身校验,可结合IntentionVerifyType中具体使用的校验模式从对应的出参Result中获取最终的核验结果;若请求没有开启意愿核身校验,则可在出参Text中获取最终的核验结果。 */ IsVerifyIntention?: boolean; /** * 本次请求意愿核身校验使用的具体模式。 0:问答模式 1:点头确认模式 2:朗读模式 若未使用意愿核身功能,该字段返回值可以不处理。 注意:此字段可能返回 null,表示取不到有效值 */ IntentionVerifyType?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 意愿核身问答模式结果。 */ export interface IntentionQuestionResult { /** * 意愿核身错误码。 - 取值范围: 0: "成功" -1: "参数错误" -2: "系统异常" -101: "请保持人脸在框内" -102: "检测到多张人脸" -103: "人脸检测失败" -104: "人脸检测不完整" -105: "请勿遮挡眼睛" -106: "请勿遮挡嘴巴" -107: "请勿遮挡鼻子" -201: "人脸比对相似度低" -202: "人脸比对失败" -301: "意愿核验不通过" -302: "用户回答阶段未检测到张嘴动作" -800: "前端不兼容错误" -801: "用户未授权摄像头和麦克风权限" -802: "核验流程异常中断,请勿切屏或进行其他操作" -803: "用户主动关闭链接/异常断开链接" -804: "用户当前网络不稳定,请重试" -998: "系统数据异常" -999: "系统未知错误,请联系人工核实" - 若在人脸核身过程失败、未进入意愿确认过程,则该参数返回为空,请参考人脸核身错误码结果(DetectInfoText.ErrCode) 注意:此字段可能返回 null,表示取不到有效值。 */ FinalResultDetailCode?: number; /** * 意愿核身错误信息。 注意:此字段可能返回 null,表示取不到有效值。 */ FinalResultMessage?: string; /** * 视频base64。 - 其中包含全程问题和回答音频,mp4格式。 注意:此字段可能返回 null,表示取不到有效值。 */ Video?: string; /** * 屏幕截图base64列表。 注意:此字段可能返回 null,表示取不到有效值。 */ ScreenShot?: Array手机号码。
*/ Mobile: string; /** *敏感数据加密信息。
身份证号。
*/ IdCard: string; /** *姓名。
活体检测类型。
用于活体检测的视频,视频的BASE64值;
BASE64编码后的大小不超过8M,支持mp4、avi、flv格式。
用于活体检测的视频Url 地址。
验证数据。
*/ ValidateData?: string; /** *额外配置,传入JSON字符串。
敏感数据加密信息。
业务流程ID。
本接口不需要传递此参数。
*/ TerminalType?: string; /** *验证人的身份证号码。
验证人的姓名。
认证结束后重定向的回调链接地址,仅微信H5场景使用。
透传字段,在获取验证结果时返回。
用于人脸比对的图像数据,使用base64编码。
敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
*/ Encryption?: Encryption; /** *意愿核身(朗读模式)使用的文案。
意愿核身(语音播报+语音回答模式)使用的文案。
意愿核身(点头确认模式)使用的文案。
意愿核身流程配置。
*/ Config?: RuleIdConfig; } /** * CheckEidTokenStatus请求参数结构体 */ export interface CheckEidTokenStatusRequest { /** * E证通流程的唯一标识,调用[GetEidToken](https://cloud.tencent.com/document/product/1007/54089)接口时生成。 */ EidToken: string; } /** * GetFaceIdRiskInfo返回参数结构体 */ export interface GetFaceIdRiskInfoResponse { /** * 描述当前请求所在设备的风险标签 - 详情如下: 01-设备疑似被Root/设备疑似越狱。 02-设备疑似被注入。 03-设备疑似为模拟器。 04-设备疑似存在风险操作。 05-摄像头疑似被劫持。 06-疑似黑产设备。 注意:此字段可能返回 null,表示取不到有效值。 */ DeviceInfoTag?: string; /** * 描述当前请求所在设备的风险等级,共4级。 - 详情如下: 1 - 低风险。 2 - 中风险。 3 - 高风险。 4 - 攻击。 -1表示未获取到风险等级。 注意:此字段可能返回 null,表示取不到有效值。 */ DeviceInfoLevel?: number; /** * 设备id标识。 注意:此字段可能返回 null,表示取不到有效值。 */ OpenId?: string; /** * 描述当前请求所在设备的相机指纹风险等级,共4级。 - 详情如下: 1 - 低风险。 2 - 中风险。 3 - 高风险。 4 - 攻击。 -1表示未获取到风险等级。 注意:此字段可能返回 null,表示取不到有效值。 */ CameraInfoLevel?: number; /** * 描述当前请求所在设备的相机指纹风险标签。 - 详情如下: 01-设备疑似被Root/设备疑似越狱。 02-设备疑似被注入。 03-设备疑似为模拟器。 04-设备疑似存在风险操作。 05-摄像头疑似被劫持。 06-疑似黑产设备。 空表示没有相机指纹风险。 注意:此字段可能返回 null,表示取不到有效值。 */ CameraInfoTag?: string; /** * 获取token时透传的信息。 注意:此字段可能返回 null,表示取不到有效值。 */ Extra?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * LivenessCompare返回参数结构体 */ export interface LivenessCompareResponse { /** *验证通过后的视频最佳截图照片。
相似度。- 取值范围 [0.00, 100.00]。- 推荐相似度大于等于70时可判断为同一人(采用固定阈值70,误通过率为万分之一,不支持调整阈值)。
*/ Sim?: number; /** *业务错误码。
业务结果描述。
*/ Description?: string; /** *最佳截图列表。
认证结果码,收费情况如下。
业务结果描述。
*/ Description?: string; /** *状态码。- 取值范围:0:正常。1:停机。2:销号。4:不在网。5:在网但不可用 。99:未知状态。
*/ StatusCode?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * EncryptedPhoneVerification请求参数结构体 */ export interface EncryptedPhoneVerificationRequest { /** * 身份证号,加密方式以EncryptionMode为准 */ IdCard: string; /** * 姓名,加密方式以EncryptionMode为准 */ Name: string; /** * 手机号,加密方式以EncryptionMode为准 */ Phone: string; /** * 敏感信息的加密方式,目前支持明文、MD5和SHA256加密传输,参数取值: 0:明文,不加密 1:使用MD5加密 2:使用SHA256 3:使用SM3加密 */ EncryptionMode: string; } /** * EncryptedPhoneVerification返回参数结构体 */ export interface EncryptedPhoneVerificationResponse { /** * 认证结果码: 【收费结果码】 0: 三要素信息一致 -4: 三要素信息不一致 【不收费结果码】 -7: 身份证号码有误 -8: 参数错误 -9: 没有记录 -11: 验证中心服务繁忙 */ Result?: string; /** * 业务结果描述。 */ Description?: string; /** * 运营商名称。 取值范围为["移动","联通","电信",""] */ ISP?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 核身视频信息。 */ export interface DetectInfoVideoData { /** * 活体视频的base64编码。 注意:此字段可能返回 null,表示取不到有效值。 */ LivenessVideo?: string; /** * 当次token中所有用户活体视频的COS存储路径,仅当您开启数据存储服务且“IsReturnAllVideo”入参取值为true 时返回。 注意:此字段可能返回 null,表示取不到有效值。 */ LivenessVideos?: Array传入需要检测的人脸图片或人脸视频(当前仅支持单人脸检测),使用base64编码的形式,如您的场景视频和图片都有,我们更建议您使用视频进行检测,为了提供更好的检测效果,请您注意以下输入数据的限制与建议:
图片的Base64值:
建议整体图像480x640的分辨率,脸部大小在 100X100 以上,由手机前置摄像头拍摄。
Base64编码后的图片数据大小建议不超过3M、最大不可超过10M,仅支持jpg、png格式。
请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
视频的Base64值:
Base64编码后的大小建议在8M以内、最大不可超过10M,支持mp4、avi、flv格式,由手机前置摄像头拍摄。
视频建议时长为2~5s,最大不可超过20s。
视频分辨率建议为480x640(最大支持720p),帧率在25fps~30fps之间。
请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
若您未使用Encryption进行加密传输,则本字段为必填参数。
*/ FaceInput?: string; /** *传入的类型。
若您未使用Encryption进行加密传输,则本字段为必填参数。
*/ FaceInputType?: number; /** *是否需要对请求信息进行全包体加密。
加密后的密文。
EID商户ID。
身份标识。
姓名。
透传字段,在获取验证结果时返回。
小程序模式配置,包括如何传入姓名身份证的配置,以及是否使用意愿核身。
*/ Config?: GetEidTokenConfig; /** *用户从Url中进入核身认证结束后重定向的回调链接地址。
敏感数据加密信息。
token值。- 有效期 10分钟。- 只能完成1次核身。
*/ FaceIdToken?: string; /** *客户端配置信息,SDK将使用该配置进行后续操作。请将返回值原样传递给客户端SDK。
*/ ClientConfig?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 意愿核身点头确认模式结果详细数据 */ export interface IntentionActionResultDetail { /** * 视频base64编码(其中包含全程提示文本和点头音频,mp4格式) 注意:此字段可能返回 null,表示取不到有效值。 */ Video?: string; /** * 屏幕截图base64编码列表 注意:此字段可能返回 null,表示取不到有效值。 */ ScreenShot?: ArrayNFC计费结果码,NFC识读成功一次则计费一次(同一个NFC请求重复拉取结果不会重复计费)。计费结果码取值范围:
0:识读成功,计费
-1:识读失败,不计费
身份证号
注意:此字段可能返回 null,表示取不到有效值。 */ IdNum?: string; /** *姓名
注意:此字段可能返回 null,表示取不到有效值。 */ Name?: string; /** *证件中的人像照片
注意:此字段可能返回 null,表示取不到有效值。 */ Picture?: string; /** *身份类证件正面照片(人像面)
注意:此字段可能返回 null,表示取不到有效值。 */ IdCardFrontImg?: string; /** *身份类证件背面照片(国徽面)
注意:此字段可能返回 null,表示取不到有效值。 */ IdCardBackImg?: string; /** *出生日期
注意:此字段可能返回 null,表示取不到有效值。 */ BirthDate?: string; /** *有效期起始时间
注意:此字段可能返回 null,表示取不到有效值。 */ BeginTime?: string; /** *有效期结束时间
注意:此字段可能返回 null,表示取不到有效值。 */ EndTime?: string; /** *住址
注意:此字段可能返回 null,表示取不到有效值。 */ Address?: string; /** *民族
注意:此字段可能返回 null,表示取不到有效值。 */ Nation?: string; /** *性别
注意:此字段可能返回 null,表示取不到有效值。 */ Sex?: string; /** *证件类型
枚举值:
英文姓名
注意:此字段可能返回 null,表示取不到有效值。 */ EnName?: string; /** *签发机关
注意:此字段可能返回 null,表示取不到有效值。 */ SigningOrganization?: string; /** *港澳台居民居住证,通行证号码
注意:此字段可能返回 null,表示取不到有效值。 */ OtherIdNum?: string; /** *旅行证件国籍
注意:此字段可能返回 null,表示取不到有效值。 */ Nationality?: string; /** *旅行证件机读区第二行 29~42 位
注意:此字段可能返回 null,表示取不到有效值。 */ PersonalNumber?: string; /** *证件的验真结果
身份证。
*/ IdCard?: string; /** *姓名。
*/ Name?: string; /** *业务核验结果。
业务核验描述。
*/ Description?: string; /** *相似度。
用户核验的视频base64。
用户核验视频的截帧base64。
获取token时透传的信息。
注意:此字段可能返回 null,表示取不到有效值。 */ Extra?: string; /** *plus版:描述当前请求所在设备的风险标签。
行为风险标签。
plus版:描述当前请求活体阶段被拒绝的详细原因。
plus版:描述当前请求所在设备的风险等级,共4级。
敏感数据加密信息。
注意:此字段可能返回 null,表示取不到有效值。 */ Encryption?: Encryption; /** *加密后的数据。
注意:此字段可能返回 null,表示取不到有效值。 */ EncryptedBody?: string; /** *用户核验的身份证人像页base64
*/ IdCardFrontBase64?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DetectAIFakeFaces返回参数结构体 */ export interface DetectAIFakeFacesResponse { /** *对于输入图片/视频的检测结果,检测是否存在人脸攻击。
建议返回值为High时判断为拦截,Mid和Low判断为通过,以更好平衡安全性和通过率。
*/ AttackRiskLevel?: string; /** *检测到的疑似攻击痕迹列表,仅当AttackRiskLevel为High或Mid时返回。
返回额外信息(包括命中模板的详细信息)。
*/ ExtraInfo?: ExtraInfo; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 意愿核身朗读模式相关结果。 */ export interface IntentionVerifyData { /** *意愿确认环节中录制的视频(base64)。
意愿确认环节中用户语音转文字的识别结果。
意愿确认环节(朗读模式)的结果码。取值范围:
0: "成功"
-1: "系统异常"
-2: "参数错误"
-3:"业务繁忙,请重试"
-4:"后端服务异常,请重试"
-5:"后端服务进房异常,请重试"
-6:"后端服务录制异常,请重试"
-7:"文件存储异常,请重试"
-8:"后端服务重复进房,请重试"
-9:"实时视频流异常,请重试"
-10:"语音识别失败,请重试"
-11:"流程已中断,请重试"
-12:"流程未完成,请重试"
-13:"token校验不通过,请重试"
-14:"流程已结束"
-15:"超过预设重试次数"
-16:"系统未知错误,请联系人工核实"
-17:"未检测到用户声音"
3001:"请保持人脸在框内"
3002:"检测到多张人脸"
3003:"人脸检测失败"
3011:"人脸比对相似度低"
3012:"人脸比对失败"
-800: "前端不兼容错误"
-801: "用户未授权摄像头和麦克风权限"
-802: "核验流程异常中断,请勿切屏或进行其他操作"
-803: "用户主动关闭链接/异常断开链接"
说明:若在人脸核身过程失败、未进入意愿确认过程,则该参数返回为空,请参考人脸核身错误码结果(DetectInfoText.ErrCode)注意:此字段可能返回 null,表示取不到有效值。
示例值:0
意愿确认环节的结果信息。
注意:此字段可能返回 null,表示取不到有效值。 */ ErrorMessage?: string; /** *意愿确认环节中录制视频的最佳帧(base64)。
本次流程用户语音与传入文本比对的相似度分值,取值范围 [0.00, 100.00]。只有配置了相似度阈值后才进行语音校验并返回相似度分值。
注意:此字段可能返回 null,表示取不到有效值。 * @deprecated */ AsrResultSimilarity?: string; /** *意愿确认环节中录制的音频(base64)。
活体检测类型。
用于人脸比对的照片的Base64值。
用于人脸比对照片的URL地址。
验证数据。
*/ ValidateData?: string; /** *额外配置,传入JSON字符串。
用于活体检测的视频,视频的Base64值。
用于活体检测的视频Url 地址。
请求时间戳。
注意:此字段可能返回 null,表示取不到有效值。 */ ReqTime?: string; /** *本次活体一比一请求的唯一标记。
注意:此字段可能返回 null,表示取不到有效值。 */ Seq?: string; /** *参与本次活体一比一的身份证号。
注意:此字段可能返回 null,表示取不到有效值。 */ Idcard?: string; /** *参与本次活体一比一的姓名。
注意:此字段可能返回 null,表示取不到有效值。 */ Name?: string; /** *本次活体一比一的相似度。
注意:此字段可能返回 null,表示取不到有效值。 */ Sim?: string; /** *本次活体一比一是否收费
注意:此字段可能返回 null,表示取不到有效值。 */ IsNeedCharge?: boolean; /** *本次活体一比一最终结果。0为成功
注意:此字段可能返回 null,表示取不到有效值。 */ Errcode?: number; /** *本次活体一比一最终结果描述。(仅描述用,文案更新时不会通知。)
注意:此字段可能返回 null,表示取不到有效值。 */ Errmsg?: string; /** *本次活体结果。0为成功
注意:此字段可能返回 null,表示取不到有效值。 */ Livestatus?: number; /** *本次活体结果描述。(仅描述用,文案更新时不会通知。)
注意:此字段可能返回 null,表示取不到有效值。 */ Livemsg?: string; /** *本次一比一结果。0为成功
注意:此字段可能返回 null,表示取不到有效值。 */ Comparestatus?: number; /** *本次一比一结果描述。(仅描述用,文案更新时不会通知。)
注意:此字段可能返回 null,表示取不到有效值。 */ Comparemsg?: string; /** *比对库源类型。包括:商业库;业务方自有库(用户上传照片、客户的混合库、混合部署库);二次验证库;人工审核库;
注意:此字段可能返回 null,表示取不到有效值。 */ CompareLibType?: string; /** *枚举活体检测类型:
0:未知
1:数字活体
2:动作活体
3:静默活体
4:一闪活体(动作+光线)
5: 远近活体
枚举值:
命中的模板类型,其中Common-公共库;Auto-自动聚类库;Owner-自建模板库
注意:此字段可能返回 null,表示取不到有效值。 */ HitGroup?: string; /** *请求图像与命中攻击模板的相似度,相似度取值范围[0,2],取值越小表示命中攻击模板的概率越高。默认阈值为0.6,当SimilarityScore≥0.6时判断为正常,SimilarityScore<0.6是判断为攻击。
注意:此字段可能返回 null,表示取不到有效值。 */ SimilarityScore?: number; /** *命中的模板id
注意:此字段可能返回 null,表示取不到有效值。 */ HitTemplate?: string; } /** * 意愿核身(点头确认模式)配置 */ export interface IntentionActionConfig { /** * 点头确认模式下,系统语音播报使用的问题文本,问题最大长度为250个字符。 */ Text: string; } /** * CheckBankCardInformation请求参数结构体 */ export interface CheckBankCardInformationRequest { /** * 银行卡号。 */ BankCard: string; /** * 敏感数据加密信息。 - 对传入信息(银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。 */ Encryption?: Encryption; } /** * BankCardVerification请求参数结构体 */ export interface BankCardVerificationRequest { /** * 开户证件号。 - 与CertType参数的证件类型一致,如:身份证,则传入身份证号。 */ IdCard: string; /** * 姓名。 */ Name: string; /** * 银行卡。 */ BankCard: string; /** * 证件类型。 - 请确认该证件为开户时使用的证件类型,未用于开户的证件信息不支持验证。 - 目前默认:0 身份证,其他证件类型暂不支持。 */ CertType?: number; /** * 敏感数据加密信息。 - 对传入信息(姓名、身份证号、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。 */ Encryption?: Encryption; } /** * GetWxNFCResult请求参数结构体 */ export interface GetWxNFCResultRequest { /** *前端 NFC SDK返回的唯一标识ID
*/ NFCToken: string; } /** * 核身最佳帧信息。 */ export interface DetectInfoBestFrame { /** * 活体比对最佳帧Base64编码。 注意:此字段可能返回 null,表示取不到有效值。 */ BestFrame?: string; /** * 自截帧Base64编码数组。 注意:此字段可能返回 null,表示取不到有效值。 */ BestFrames?: Array相似度。- 取值范围 [0.00, 100.00]。- 推荐相似度大于等于70时可判断为同一人(采用固定阈值70,误通过率为万分之一,不支持调整阈值)。
*/ Sim?: number; /** *业务错误码。- 成功情况返回Success。- 错误情况请参考下方错误码 列表中FailedOperation部分
*/ Result?: string; /** *业务结果描述。
*/ Description?: string; /** *姓名。
*/ Name?: string; /** *性别。
*/ Sex?: string; /** *民族。
*/ Nation?: string; /** *出生日期。
*/ Birth?: string; /** *地址。
*/ Address?: string; /** *身份证号。
*/ IdNum?: string; /** *身份证头像照片的base64编码,如果抠图失败会拿整张身份证做比对并返回空。
*/ Portrait?: string; /** *告警信息。
当在Config中配置了告警信息会停止人像比对,Result返回错误(FailedOperation.OcrWarningOccurred)并有此告警信息。
Code 告警码列表和释义:
'-9101':身份证边框不完整告警。
'-9102':身份证复印件告警。
'-9103':身份证翻拍告警。
'-9105':身份证框内遮挡告警。
'-9104':临时身份证告警。
'-9106':身份证 PS 告警(疑似存在PS痕迹)。
'-8001':图片模糊告警。
多个会用“|” 隔开,如 "-9101|-9106|-9104"。
图片质量分数。
敏感数据加密信息。
注意:此字段可能返回 null,表示取不到有效值。 */ Encryption?: Encryption; /** *加密后的数据。
*/ EncryptedBody?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GetEidResult请求参数结构体 */ export interface GetEidResultRequest { /** * E证通流程的唯一标识,调用[GetEidToken](https://cloud.tencent.com/document/product/1007/54089)接口时生成。 */ EidToken: string; /** * 指定需要拉取的结果信息。 - 取值范围: 0:全部。 1:文本类。 2:身份证信息。 3:最佳截图信息。 5:意愿核身朗读模式相关结果。 6:意愿核身问答/点头模式相关结果。 - 例如 13表示拉取文本类、最佳截图信息。 - 默认值:0 */ InfoType?: string; /** * 从活体视频中截取一定张数的最佳帧。 - 默认为0,最大为3,超出3的最多只给3张。 - InfoType需要包含3。 */ BestFramesCount?: number; /** * 是否对身份证照片进行裁边。 - 默认为false。 - InfoType需要包含2。 */ IsCutIdCardImage?: boolean; /** * 是否需要从身份证中抠出头像。 - 默认为false。 - InfoType需要包含2。 */ IsNeedIdCardAvatar?: boolean; } /** * DetectAuth返回参数结构体 */ export interface DetectAuthResponse { /** *用于发起核身流程的URL,仅微信H5场景使用。
*/ Url?: string; /** *一次核验流程的唯一标识。
身份证号。
姓名。
*/ Name?: string; /** *身份证人像面的 Base64 值。
身份证人像面的 Url 地址。
敏感数据加密信息。
告警配置。
在使用加密服务时,填入要被加密的字段。本接口中可填入加密后的一个或多个字段
注意:此字段可能返回 null,表示取不到有效值。 */ EncryptList: Array加密后的对称密钥,关于密钥的生成和使用请查阅数据加密 文档。
注意:此字段可能返回 null,表示取不到有效值。 */ CiphertextBlob: string; /** *有加密需求的用户,传入CBC加密的初始向量(客户自定义字符串,长度16字符)。
注意:此字段可能返回 null,表示取不到有效值。 */ Iv: string; /** *加密使用的算法(支持'AES-256-CBC'、'SM4-GCM'),不传默认为'AES-256-CBC'
注意:此字段可能返回 null,表示取不到有效值。 */ Algorithm?: string; /** *SM4-GCM算法生成的消息摘要(校验消息完整性时使用)
注意:此字段可能返回 null,表示取不到有效值。 */ TagList?: Array手机号码。
*/ Mobile: string; /** *敏感数据加密信息。
认证结果码,收费情况如下。
运营商名称。
业务结果描述。
*/ Description?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * MobileNetworkTimeVerification返回参数结构体 */ export interface MobileNetworkTimeVerificationResponse { /** *认证结果码,收费情况如下。
收费结果码:
-0: 成功。
-2: 手机号不存在
-3: 手机号存在,但无法查询到在网时长。
不收费结果码:
-1: 手机号格式不正确。
-4: 验证中心服务繁忙。
-5:认证次数超过当日限制,请次日重试。
-13:该号段不支持验证
业务结果描述。
*/ Description?: string; /** *在网时长区间。
认证结果码,收费情况如下。
运营商名称。
业务结果描述。
*/ Description?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CheckIdCardInformation请求参数结构体 */ export interface CheckIdCardInformationRequest { /** *身份证人像面的 Base64 值。
身份证人像面的 Url 地址
配置。
以下可选字段均为bool 类型,默认false。
CopyWarn,复印件告警。
BorderCheckWarn,边框和框内遮挡告警。
ReshootWarn,翻拍告警。
DetectPsWarn,PS检测告警(疑似存在PS痕迹)。
TempIdWarn,临时身份证告警。
Quality,图片质量告警(评价图片模糊程度)。
SDK 设置方式参考:
Config = Json.stringify({"CopyWarn":true,"ReshootWarn":true})。
API 3.0 Explorer 设置方式参考:
Config = {"CopyWarn":true,"ReshootWarn":true}。
是否需要对返回中的敏感信息进行加密。
是否需要对响应体加密。
*/ IsEncryptResponse?: boolean; /** *是否需要对返回中的敏感信息进行加密,需指定加密算法Algorithm、CBC加密的初始向量、加密后的对称密钥。
*/ Encryption?: Encryption; } /** * 获取token时的配置 */ export interface GetEidTokenConfig { /** * 姓名身份证输入方式。 - 取值范围: 1:传身份证正反面OCR。 2:传身份证正面OCR。 3:用户手动输入。 4:客户后台传入。 - 默认值:1。 - 注意:使用OCR时仅支持用户修改结果中的姓名。 */ InputType?: string; /** * 是否使用意愿核身。 - 默认不使用。 - 注意:如开启使用,则计费标签按【意愿核身】计费标签计价;如不开启,则计费标签按【E证通】计费标签计价,价格详见:[价格说明](https://cloud.tencent.com/document/product/1007/56804)。 */ UseIntentionVerify?: boolean; /** * 意愿核身模式。 - 取值范围: 1:语音朗读模式。 2:语音问答模式。 3:点头确认模式。 - 默认值为1。 */ IntentionMode?: string; /** * 意愿核身朗读模式使用的文案。 - 若未使用意愿核身朗读功能,该字段无需传入。 - 默认为空,最长可接受120的字符串长度。 */ IntentionVerifyText?: string; /** * 意愿核身问答模式的配置列表。 - 问答模式支持1-10轮(不超过10轮)的意愿确认。 */ IntentionQuestions?: Array身份证号。
*/ IdCard: string; /** *姓名。
*/ Name: string; /** *手机号。
*/ Phone: string; /** *敏感数据加密信息。
身份证号。
*/ IdCard: string; /** *姓名。
*/ Name: string; /** *手机号。
*/ Phone: string; /** *敏感数据加密信息。
本次流程最终验证结果。
本次流程最终验证结果描述。
本次验证使用的身份证号。
注意:此字段可能返回 null,表示取不到有效值。 */ IdCard?: string; /** *用户认证时使用的证件号码类型。
本次验证使用的姓名。
注意:此字段可能返回 null,表示取不到有效值。 */ Name?: string; /** *身份校验环节识别结果:民族。
注意:此字段可能返回 null,表示取不到有效值。 */ OcrNation?: string; /** *身份校验环节识别结果:家庭住址。
注意:此字段可能返回 null,表示取不到有效值。 */ OcrAddress?: string; /** *身份校验环节识别结果:生日。
身份校验环节识别结果:签发机关。
注意:此字段可能返回 null,表示取不到有效值。 */ OcrAuthority?: string; /** *身份校验环节识别结果:有效日期。
身份校验环节识别结果:姓名。
注意:此字段可能返回 null,表示取不到有效值。 */ OcrName?: string; /** *身份校验环节识别结果:身份证号。
注意:此字段可能返回 null,表示取不到有效值。 */ OcrIdCard?: string; /** *身份校验环节识别结果:性别。
注意:此字段可能返回 null,表示取不到有效值。 */ OcrGender?: string; /** *身份校验环节采用的信息上传方式。
本次流程最终活体结果。
本次流程最终活体结果描述。
本次流程最终一比一结果。
本次流程最终一比一结果描述。
本次流程活体一比一的分数。- 取值范围 [0.00, 100.00]。- 相似度大于等于70时才判断为同一人,阈值不支持自定义。- 阈值70的误通过率为万分之一。
注意:此字段可能返回 null,表示取不到有效值。 */ Sim?: string; /** *地理位置经纬度。
注意:此字段可能返回 null,表示取不到有效值。 */ Location?: string; /** *Auth接口带入额外信息。
注意:此字段可能返回 null,表示取不到有效值。 */ Extra?: string; /** *本次流程进行的活体一比一流水。
注意:此字段可能返回 null,表示取不到有效值。 */ LivenessDetail?: Array描述当前请求活体阶段被拒绝的详细原因,该参数仅限PLUS版本核身服务返回。- 详情如下:
01-用户全程闭眼
02-用户未完成指定动作
03-疑似翻拍攻击
04-疑似合成攻击
05-疑似黑产模板
06-疑似存在水印
07-反光校验未通过
08-疑似中途换人
09-人脸质量过差
10-距离校验不通过
11-疑似对抗样本攻击
12-嘴巴区域疑似存在攻击痕迹
13-眼睛区域疑似存在攻击痕迹
14-眼睛或嘴巴被遮挡
手机号码。
注意:此字段可能返回 null,表示取不到有效值。 */ Mobile?: string; /** *本次流程最终比对库源类型。
本次流程最终活体类型。
nfc重复计费requestId列表。
注意:此字段可能返回 null,表示取不到有效值。 */ NFCRequestIds?: Arraynfc重复计费计数。
注意:此字段可能返回 null,表示取不到有效值。 */ NFCBillingCounts?: number; /** *港澳台居住证通行证号码。
注意:此字段可能返回 null,表示取不到有效值。 */ PassNo?: string; /** *港澳台居住证签发次数。
注意:此字段可能返回 null,表示取不到有效值。 */ VisaNum?: string; /** *活体检测的动作顺序,多动作以“,”分隔。
输出格式如:“1,2”表示“张嘴+眨眼”。
相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
*/ Sim?: number; /** *业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
*/ Result?: string; /** *业务结果描述。
*/ Description?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GetDetectInfo返回参数结构体 */ export interface GetDetectInfoResponse { /** * JSON字符串。 { // 文本类信息 "Text": { "ErrCode": null, // 本次核身最终结果。0为成功 "ErrMsg": null, // 本次核身最终结果信息描述。 "IdCard": "", // 本次核身最终获得的身份证号。 "Name": "", // 本次核身最终获得的姓名。 "OcrNation": null, // ocr阶段获取的民族 "OcrAddress": null, // ocr阶段获取的地址 "OcrBirth": null, // ocr阶段获取的出生信息 "OcrAuthority": null, // ocr阶段获取的证件签发机关 "OcrValidDate": null, // ocr阶段获取的证件有效期 "OcrName": null, // ocr阶段获取的姓名 "OcrIdCard": null, // ocr阶段获取的身份证号 "OcrGender": null, // ocr阶段获取的性别 "LiveStatus": null, // 活体检测阶段的错误码。0为成功 "LiveMsg": null, // 活体检测阶段的错误信息 "Comparestatus": null,// 一比一阶段的错误码。0为成功 "Comparemsg": null, // 一比一阶段的错误信息 "Sim": null, // 比对相似度 "Location": null, // 地理位置信息 "Extra": "", // DetectAuth结果传进来的Extra信息 "Detail": { // 活体一比一信息详情 "LivenessData": [ { ErrCode: null, // 活体比对验证错误码 ErrMsg: null, // 活体比对验证错误描述 ReqTime: null, // 活体验证时间戳 IdCard: null, // 验证身份证号 Name: null // 验证姓名 } ] } }, // 身份证正反面照片Base64 "IdCardData": { "OcrFront": null, "OcrBack": null }, // 视频最佳帧截图Base64 "BestFrame": { "BestFrame": null }, // 活体视频Base64 "VideoData": { "LivenessVideo": null } } */ DetectInfo: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * IdCardOCRVerification返回参数结构体 */ export interface IdCardOCRVerificationResponse { /** *认证结果码,收费情况如下。
业务结果描述。
*/ Description?: string; /** *用于验证的姓名。
*/ Name?: string; /** *用于验证的身份证号。
*/ IdCard?: string; /** *OCR得到的性别。
注意:此字段可能返回 null,表示取不到有效值。 */ Sex?: string; /** *OCR得到的民族。
注意:此字段可能返回 null,表示取不到有效值。 */ Nation?: string; /** *OCR得到的生日。
注意:此字段可能返回 null,表示取不到有效值。 */ Birth?: string; /** *OCR得到的地址。
注意:此字段可能返回 null,表示取不到有效值。 */ Address?: string; /** *身份证头像照片的base64编码
*/ Portrait?: string; /** *告警信息。
图片质量分数。
验证通过后的视频最佳截图照片。
相似度。- 取值范围 [0.00, 100.00]。- 推荐相似度大于等于70时可判断为同一人,(采用固定阈值70,误通过率为万分之一,不支持调整阈值)
*/ Sim?: number; /** *业务错误码。
业务结果描述。
*/ Description?: string; /** *最佳截图列表,仅在配置了返回多张最佳截图时返回。
注意:此字段可能返回 null,表示取不到有效值。 */ BestFrameList?: ArraySDK人脸核身流程的标识。
是否需要拉取视频。
是否需要拉取截帧。
是否对回包整体进行加密。
*/ IsEncryptResponse?: boolean; /** *是否需要对返回中的敏感信息进行加密。
只需指定加密算法Algorithm即可,其余字段传入默认值。
认证结果码,收费情况如下。
收费结果码:
0: 验证结果一致。
1: 验证结果不一致。
不收费结果码:
-1:查无记录。
-2:引擎未知错误。
-3:引擎服务异常。
-4:姓名校验不通过。
-5:手机号码不合法。
-6: 认证次数超过当日限制,请次日重试。
-13:该号段不支持验证
业务结果描述。
*/ Description?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GetFaceIdToken请求参数结构体 */ export interface GetFaceIdTokenRequest { /** *比对库。
身份证。
姓名。
图片的Base64。
SDK中生成的Meta字符串。
*/ Meta?: string; /** *透传参数。
是否使用cos桶。
敏感数据加密信息。对传入信息(姓名、身份证号、自传照片)有加密需求的用户可使用此参数,详情请点击左侧链接。
*/ Encryption?: Encryption; /** *用于细分客户使用场景。
SDK和用户设备的元信息。该字段的值由HuiYan SDK以JSON字符串格式返回。 说明:不要修改返回值,直接传递即可。
*/ MetaData?: string; } /** * 意愿核身点头确认模式结果 */ export interface IntentionActionResult { /** * 意愿核身错误码: 0: "成功" -1: "参数错误" -2: "系统异常" -101: "请保持人脸在框内" -102: "检测到多张人脸" -103: "人脸检测失败" -104: "人脸检测不完整" -105: "请勿遮挡眼睛" -106: "请勿遮挡嘴巴" -107: "请勿遮挡鼻子" -201: "人脸比对相似度低" -202: "人脸比对失败" -301: "意愿核验不通过" -800: "前端不兼容错误" -801: "用户未授权摄像头和麦克风权限" -802: "核验流程异常中断,请勿切屏或进行其他操作" -803: "用户主动关闭链接/异常断开链接" -804: "用户当前网络不稳定,请重试" -998: "系统数据异常" -999: "系统未知错误,请联系人工核实" 若在人脸核身过程失败、未进入意愿确认过程,则该参数返回为空,请参考人脸核身错误码结果(DetectInfoText.ErrCode) 注意:此字段可能返回 null,表示取不到有效值。 */ FinalResultDetailCode?: number; /** * 意愿核身错误信息 注意:此字段可能返回 null,表示取不到有效值。 */ FinalResultMessage?: string; /** * 意愿核身结果详细数据,与每段点头确认过程一一对应 注意:此字段可能返回 null,表示取不到有效值。 */ Details?: Array身份证号。
*/ IdCard: string; /** *姓名。
用于人脸比对的照片,图片的Base64值;
Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。
请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
本接口不需要传递此参数。
*/ Optional?: string; /** *敏感数据加密信息。
自定义描述字段。
认证结果码,收费情况如下。
运营商名称。
业务结果描述。
*/ Description?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 计费详情 */ export interface ChargeDetail { /** * 一比一时间时间戳,13位。 */ ReqTime?: string; /** * 一比一请求的唯一标记。 */ Seq?: string; /** * 一比一时使用的、脱敏后的身份证号。 */ IdCard?: string; /** * 已废弃。请使用“IdCard”字段 * @deprecated */ Idcard?: string; /** * 一比一时使用的、脱敏后的姓名。 */ Name?: string; /** * 一比一的相似度。0-100,保留2位小数。 */ Sim?: string; /** * 本次详情是否收费。 */ IsNeedCharge?: boolean; /** * 收费类型,比对、核身、混合部署。 */ ChargeType?: string; /** * 本次活体一比一最终结果。 */ ErrorCode?: string; /** * 本次活体一比一最终结果描述。 */ ErrorMessage?: string; } /** * ParseNfcData请求参数结构体 */ export interface ParseNfcDataRequest { /** * 前端SDK返回。 */ ReqId: string; } /** * PhoneVerificationCTCC请求参数结构体 */ export interface PhoneVerificationCTCCRequest { /** *身份证号。
*/ IdCard: string; /** *姓名。
*/ Name: string; /** *手机号。
*/ Phone: string; /** *敏感数据加密信息。
身份证号
*/ IdCard: string; /** *姓名。中文请使用UTF-8编码。
*/ Name: string; /** *用于人脸比对的照片,图片的Base64值;
Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。
请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
本接口不需要传递此参数。
*/ Optional?: string; /** *敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
*/ Encryption?: Encryption; } /** * BankCard4EVerification请求参数结构体 */ export interface BankCard4EVerificationRequest { /** * 姓名。 */ Name: string; /** * 银行卡。 */ BankCard: string; /** * 手机号码。 */ Phone: string; /** * 开户证件号。 - 与CertType参数的证件类型一致,如:身份证,则传入身份证号。 */ IdCard: string; /** * 证件类型。 - 请确认该证件为开户时使用的证件类型,未用于开户的证件信息不支持验证。 - 目前默认为0:身份证,其他证件类型暂不支持。 */ CertType?: number; /** * 敏感数据加密信息。 - 对传入信息(姓名、身份证号、手机号、银行卡号)有加密需求的用户可使用此参数,详情请点击左侧链接。 */ Encryption?: Encryption; } /** * GetNFCToken返回参数结构体 */ export interface GetNFCTokenResponse { /** * NFCToken */ Token?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GetActionSequence返回参数结构体 */ export interface GetActionSequenceResponse { /** * 动作顺序,例如:2,1 or 1,2。 - 1代表张嘴,2代表闭眼。 */ ActionSequence?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GetNFCToken请求参数结构体 */ export type GetNFCTokenRequest = null; /** * GetFaceIdRiskInfo请求参数结构体 */ export interface GetFaceIdRiskInfoRequest { /** * SDK人脸核身流程的标识,调用[GetFaceidRiskInfoToken](https://cloud.tencent.com/document/product/1007/104581)接口时生成。 */ FaceIdToken: string; } /** * GetLiveCode返回参数结构体 */ export interface GetLiveCodeResponse { /** * 数字验证码。 */ LiveCode?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GetDetectInfo请求参数结构体 */ export interface GetDetectInfoRequest { /** * 人脸核身流程的标识,调用DetectAuth接口时生成。 */ BizToken: string; /** * 用于细分客户使用场景,申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。如有疑问,请加慧眼小助手微信(faceid001)进行咨询。 */ RuleId: string; /** * 指定拉取的结果信息,取值(0:全部;1:文本类;2:身份证正反面;3:视频最佳截图照片;4:视频)。 如 134表示拉取文本类、视频最佳截图照片、视频。 默认值:0 */ InfoType?: string; } /** * 核身身份证图片信息。 */ export interface DetectInfoIdCardData { /** * OCR正面照片的base64编码。 注意:此字段可能返回 null,表示取不到有效值。 */ OcrFront?: string; /** * OCR反面照片的base64编码。 注意:此字段可能返回 null,表示取不到有效值。 */ OcrBack?: string; /** * 旋转裁边后的正面照片base64编码。 注意:此字段可能返回 null,表示取不到有效值。 */ ProcessedFrontImage?: string; /** * 旋转裁边后的背面照片base64编码。 注意:此字段可能返回 null,表示取不到有效值。 */ ProcessedBackImage?: string; /** * 身份证正面人像图base64编码。 注意:此字段可能返回 null,表示取不到有效值。 */ Avatar?: string; /** * 身份证人像面告警码。 - 开启身份证告警功能后才会返回。 - 返回数组中可能出现的告警码如下: - -9100 身份证有效日期不合法告警。 - -9101 身份证边框不完整告警。 - -9102 身份证复印件告警。 - -9103 身份证翻拍告警。 - -9105 身份证框内遮挡告警。 - -9104 临时身份证告警。 - -9106 身份证 PS 告警(疑似存在PS痕迹)。 - -9107 身份证反光告警。 注意:此字段可能返回 null,表示取不到有效值。 */ WarnInfos?: Array⼿机号。
*/ Mobile: string; /** *姓名。
*/ Name: string; /** *敏感数据加密信息。
一次核身流程的标识。
发起核身流程的URL。