API 中心

文档中心 API 中心人脸核身数据结构

数据结构

最近更新时间：2024-04-12 01:15:53

我的收藏

本页目录：

AttackRiskDetail

疑似攻击风险详情

被如下接口引用：DetectAIFakeFaces。

名称	类型	描述
Type	String	疑似的攻击痕迹类型 SuspectedSpoofingAttack：翻拍攻击 SuspectedSynthesisImage：疑似合成图片 SuspectedSynthesisVideo：疑似合成视频 SuspectedeAnomalyAttack：人脸特征疑似非真人 SuspectedAdversarialAttack：疑似对抗样本攻击 SuspectedBlackIndustry：疑似黑产攻击 SuspectedWatermark：疑似存在水印注意：此字段可能返回 null，表示取不到有效值。示例值：SuspectedWatermark

ChargeDetail

计费详情

被如下接口引用：GetWeChatBillDetails。

名称	类型	描述
ReqTime	String	一比一时间时间戳，13位。
Seq	String	一比一请求的唯一标记。
IdCard	String	一比一时使用的、脱敏后的身份证号。
Name	String	一比一时使用的、脱敏后的姓名。
Sim	String	一比一的相似度。0-100，保留2位小数。
IsNeedCharge	Boolean	本次详情是否收费。
ChargeType	String	收费类型，比对、核身、混合部署。
ErrorCode	String	本次活体一比一最终结果。
ErrorMessage	String	本次活体一比一最终结果描述。

DetectDetail

活体一比一详情

被如下接口引用：GetDetectInfoEnhanced, GetEidResult。

名称	类型	描述
ReqTime	String	请求时间戳。注意：此字段可能返回 null，表示取不到有效值。
Seq	String	本次活体一比一请求的唯一标记。注意：此字段可能返回 null，表示取不到有效值。
Idcard	String	参与本次活体一比一的身份证号。注意：此字段可能返回 null，表示取不到有效值。
Name	String	参与本次活体一比一的姓名。注意：此字段可能返回 null，表示取不到有效值。
Sim	String	本次活体一比一的相似度。注意：此字段可能返回 null，表示取不到有效值。
IsNeedCharge	Boolean	本次活体一比一是否收费注意：此字段可能返回 null，表示取不到有效值。示例值：false
Errcode	Integer	本次活体一比一最终结果。0为成功注意：此字段可能返回 null，表示取不到有效值。示例值：0
Errmsg	String	本次活体一比一最终结果描述。（仅描述用，文案更新时不会通知。）注意：此字段可能返回 null，表示取不到有效值。
Livestatus	Integer	本次活体结果。0为成功注意：此字段可能返回 null，表示取不到有效值。示例值：0
Livemsg	String	本次活体结果描述。（仅描述用，文案更新时不会通知。）注意：此字段可能返回 null，表示取不到有效值。
Comparestatus	Integer	本次一比一结果。0为成功注意：此字段可能返回 null，表示取不到有效值。示例值：0
Comparemsg	String	本次一比一结果描述。（仅描述用，文案更新时不会通知。）注意：此字段可能返回 null，表示取不到有效值。
CompareLibType	String	比对库源类型。包括：公安商业库；业务方自有库（用户上传照片、客户的混合库、混合部署库）；二次验证库；人工审核库；注意：此字段可能返回 null，表示取不到有效值。
LivenessMode	Integer	枚举活体检测类型： 0：未知 1：数字活体 2：动作活体 3：静默活体 4：一闪活体（动作+光线）注意：此字段可能返回 null，表示取不到有效值。示例值：0

DetectInfoBestFrame

核身最佳帧信息

被如下接口引用：GetDetectInfoEnhanced, GetEidResult。

名称	类型	描述
BestFrame	String	活体比对最佳帧Base64编码。注意：此字段可能返回 null，表示取不到有效值。
BestFrames	Array of String	自截帧Base64编码数组。注意：此字段可能返回 null，表示取不到有效值。

DetectInfoIdCardData

核身身份证图片信息

被如下接口引用：GetDetectInfoEnhanced, GetEidResult。

名称	类型	描述
OcrFront	String	OCR正面照片的base64编码。注意：此字段可能返回 null，表示取不到有效值。示例值：xxx
OcrBack	String	OCR反面照片的base64编码注意：此字段可能返回 null，表示取不到有效值。示例值：xxx
ProcessedFrontImage	String	旋转裁边后的正面照片base64编码。注意：此字段可能返回 null，表示取不到有效值。示例值：xxx
ProcessedBackImage	String	旋转裁边后的背面照片base64编码。注意：此字段可能返回 null，表示取不到有效值。示例值：xxx
Avatar	String	身份证正面人像图base64编码。注意：此字段可能返回 null，表示取不到有效值。示例值：xxx
WarnInfos	Array of Integer	身份证人像面告警码，开启身份证告警功能后才会返回，返回数组中可能出现的告警码如下： -9100 身份证有效日期不合法告警， -9101 身份证边框不完整告警， -9102 身份证复印件告警， -9103 身份证翻拍告警， -9105 身份证框内遮挡告警， -9104 临时身份证告警， -9106 身份证 PS 告警（疑似存在PS痕迹）， -9107 身份证反光告警。注意：此字段可能返回 null，表示取不到有效值。示例值：[]
BackWarnInfos	Array of Integer	身份证国徽面告警码，开启身份证告警功能后才会返回，返回数组中可能出现的告警码如下： -9100 身份证有效日期不合法告警， -9101 身份证边框不完整告警， -9102 身份证复印件告警， -9103 身份证翻拍告警， -9105 身份证框内遮挡告警， -9104 临时身份证告警， -9106 身份证 PS 告警（疑似存在PS痕迹）， -9107 身份证反光告警。注意：此字段可能返回 null，表示取不到有效值。示例值：[]

DetectInfoText

核身文本信息

被如下接口引用：GetDetectInfoEnhanced, GetEidResult。

名称	类型	描述
ErrCode	Integer	本次流程最终验证结果。0为成功（仅包含活体人脸核身结果，不包含意愿核身结果）注意：此字段可能返回 null，表示取不到有效值。示例值：0
ErrMsg	String	本次流程最终验证结果描述。（仅描述用，文案更新时不会通知。）注意：此字段可能返回 null，表示取不到有效值。示例值：成功
IdCard	String	本次验证使用的身份证号。注意：此字段可能返回 null，表示取不到有效值。示例值：440111111111111111
UseIDType	Integer	用户认证时使用的证件号码类型： 0：二代身份证的证件号码 1：港澳台居住证的证件号码 2：其他（核验使用的证件号码非合法身份号码）注意：此字段可能返回 null，表示取不到有效值。示例值：0
Name	String	本次验证使用的姓名。注意：此字段可能返回 null，表示取不到有效值。示例值：爱新觉罗永琪
OcrNation	String	身份校验环节识别结果：民族。注意：此字段可能返回 null，表示取不到有效值。示例值：汉族
OcrAddress	String	身份校验环节识别结果：家庭住址。注意：此字段可能返回 null，表示取不到有效值。示例值：广东省
OcrBirth	String	身份校验环节识别结果：生日。格式为：YYYY/M/D 注意：此字段可能返回 null，表示取不到有效值。示例值：1999/1/12
OcrAuthority	String	身份校验环节识别结果：签发机关。注意：此字段可能返回 null，表示取不到有效值。示例值：广东省
OcrValidDate	String	身份校验环节识别结果：有效日期。格式为：YYYY.MM.DD-YYYY.MM.DD 注意：此字段可能返回 null，表示取不到有效值。示例值：1999.01.01-2009.01.01
OcrName	String	身份校验环节识别结果：姓名。注意：此字段可能返回 null，表示取不到有效值。示例值：爱新觉罗永琪
OcrIdCard	String	身份校验环节识别结果：身份证号。注意：此字段可能返回 null，表示取不到有效值。示例值：440111111111111111
OcrGender	String	身份校验环节识别结果：性别。注意：此字段可能返回 null，表示取不到有效值。示例值：女
IdInfoFrom	String	身份校验环节采用的信息上传方式。取值有"NFC"、"OCR"、"手动输入"、"其他" 注意：此字段可能返回 null，表示取不到有效值。示例值：NFC
LiveStatus	Integer	本次流程最终活体结果。0为成功注意：此字段可能返回 null，表示取不到有效值。示例值：0
LiveMsg	String	本次流程最终活体结果描述。（仅描述用，文案更新时不会通知。）注意：此字段可能返回 null，表示取不到有效值。示例值：成功
Comparestatus	Integer	本次流程最终一比一结果。0为成功注意：此字段可能返回 null，表示取不到有效值。示例值：0
Comparemsg	String	本次流程最终一比一结果描述。（仅描述用，文案更新时不会通知。）注意：此字段可能返回 null，表示取不到有效值。示例值：成功
Sim	String	本次流程活体一比一的分数，取值范围 [0.00, 100.00]。相似度大于等于70时才判断为同一人，也可根据具体场景自行调整阈值（阈值70的误通过率为千分之一，阈值80的误通过率是万分之一）注意：此字段可能返回 null，表示取不到有效值。示例值：88.3
Location	String	地理位置经纬度。注意：此字段可能返回 null，表示取不到有效值。示例值：2
Extra	String	Auth接口带入额外信息。注意：此字段可能返回 null，表示取不到有效值。示例值：2
LivenessDetail	Array of DetectDetail	本次流程进行的活体一比一流水。注意：此字段可能返回 null，表示取不到有效值。示例值：{}
Mobile	String	手机号码。注意：此字段可能返回 null，表示取不到有效值。示例值：1
CompareLibType	String	本次流程最终比对库源类型。包括：权威库；业务方自有库（用户上传照片、客户的混合库、混合部署库）；二次验证库；人工审核库；注意：此字段可能返回 null，表示取不到有效值。示例值：权威库
LivenessMode	Integer	本次流程最终活体类型。包括： 0：未知 1：数字活体 2：动作活体 3：静默活体 4：一闪活体（动作+光线）注意：此字段可能返回 null，表示取不到有效值。示例值：0
NFCRequestIds	Array of String	nfc重复计费requestId列表注意：此字段可能返回 null，表示取不到有效值。示例值：[""]
NFCBillingCounts	Integer	nfc重复计费计数注意：此字段可能返回 null，表示取不到有效值。示例值：1
PassNo	String	港澳台居住证通行证号码注意：此字段可能返回 null，表示取不到有效值。示例值：1
VisaNum	String	港澳台居住证签发次数注意：此字段可能返回 null，表示取不到有效值。示例值：1

DetectInfoVideoData

核身视频信息

被如下接口引用：GetDetectInfoEnhanced。

名称	类型	描述
LivenessVideo	String	活体视频的base64编码注意：此字段可能返回 null，表示取不到有效值。

EidInfo

Eid出参，包括商户方用户的标识和加密的用户姓名身份证信息。

被如下接口引用：GetEidResult。

名称	类型	描述
EidCode	String	商户方 appeIDcode 的数字证书示例值：1
EidSign	String	Eid中心针对商户方EidCode的电子签名示例值：1
DesKey	String	商户方公钥加密的会话密钥的base64字符串，指引详见示例值：saus+9hdsdks=
UserInfo	String	会话密钥sm2加密后的base64字符串，指引详见示例值：ug7gdwsg7898shs9=

Encryption

敏感数据加密

被如下接口引用：BankCard2EVerification, BankCard4EVerification, BankCardVerification, CheckBankCardInformation, CheckIdCardInformation, CheckIdNameDate, CheckPhoneAndName, DetectAuth, GetDetectInfoEnhanced, GetEidToken, GetFaceIdToken, IdCardOCRVerification, IdCardVerification, ImageRecognition, ImageRecognitionV2, LivenessRecognition, MinorsVerification, MobileNetworkTimeVerification, MobileStatus, PhoneVerificationCMCC, PhoneVerificationCTCC, PhoneVerificationCUCC。

名称	类型	必选	描述
EncryptList	Array of String	是	在使用加密服务时，填入要被加密的字段。本接口中可填入加密后的一个或多个字段注意：此字段可能返回 null，表示取不到有效值。示例值：null
CiphertextBlob	String	是	有加密需求的用户，接入传入kms的CiphertextBlob，关于数据加密可查阅数据加密文档。注意：此字段可能返回 null，表示取不到有效值。示例值：null
Iv	String	是	有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。注意：此字段可能返回 null，表示取不到有效值。示例值：null
Algorithm	String	否	加密使用的算法（支持'AES-256-CBC'、'SM4-GCM'），不传默认为'AES-256-CBC' 注意：此字段可能返回 null，表示取不到有效值。示例值：SM4-GCM
TagList	Array of String	否	SM4-GCM算法生成的消息摘要（校验消息完整性时使用）注意：此字段可能返回 null，表示取不到有效值。示例值：null

ExtraInfo

额外的详细信息

被如下接口引用：DetectAIFakeFaces。

名称	类型	描述
RetrievalLivenessExtraInfo	Array of RetrievalLivenessExtraInfo	命中模板的详细信息，仅返回命中的相似度最高的模板信息注意：此字段可能返回 null，表示取不到有效值。

GetEidTokenConfig

获取token时的配置

被如下接口引用：GetEidToken。

名称	类型	必选	描述
InputType	String	否	姓名身份证输入方式。 1：传身份证正反面OCR 2：传身份证正面OCR 3：用户手动输入 4：客户后台传入默认1 注：使用OCR时仅支持用户修改结果中的姓名示例值：1
UseIntentionVerify	Boolean	否	是否使用意愿核身，默认不使用。注意：如开启使用，则计费标签按【意愿核身】计费标签计价；如不开启，则计费标签按【E证通】计费标签计价，价格详见：价格说明。示例值：true
IntentionMode	String	否	意愿核身模式。枚举值：1( 语音朗读模式)，2（语音问答模式），3（点头确认模式）。默认值为1。示例值：1
IntentionVerifyText	String	否	意愿核身朗读模式使用的文案，若未使用意愿核身朗读功能，该字段无需传入。默认为空，最长可接受120的字符串长度。
IntentionQuestions	Array of IntentionQuestion	否	意愿核身问答模式的配置列表。当前仅支持一个问答。
IntentionActions	Array of IntentionActionConfig	否	意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。默认为空，最长可接受150的字符串长度。
IntentionRecognition	Boolean	否	意愿核身过程中识别用户的回答意图，开启后除了IntentionQuestions的Answers列表中的标准回答会通过，近似意图的回答也会通过，默认不开启。示例值：true
IsSupportHMTResidentPermitOCR	Boolean	否	是否支持港澳台居住证识别示例值：false
MouthOpenRecognition	Boolean	否	用户语音回答过程中是否开启张嘴识别检测，默认不开启，仅在意愿核身问答模式中使用。示例值：false

IntentionActionConfig

意愿核身（点头确认模式）配置

被如下接口引用：DetectAuth, GetEidToken。

名称	类型	必选	描述
Text	String	是	点头确认模式下，系统语音播报使用的问题文本，问题最大长度为150个字符。示例值：请问您本次业务是本人自愿办理吗？如是，请点头确认。

IntentionActionResult

意愿核身点头确认模式结果

被如下接口引用：GetDetectInfoEnhanced, GetEidResult。

名称	类型	描述
FinalResultDetailCode	Integer	意愿核身错误码： 0: "成功" -1: "参数错误" -2: "系统异常" -101: "请保持人脸在框内" -102: "检测到多张人脸" -103: "人脸检测失败" -104: "人脸检测不完整" -105: "请勿遮挡眼睛" -106: "请勿遮挡嘴巴" -107: "请勿遮挡鼻子" -201: "人脸比对相似度低" -202: "人脸比对失败" -301: "意愿核验不通过" -800: "前端不兼容错误" -801: "用户未授权摄像头和麦克风权限" -802: "核验流程异常中断，请勿切屏或进行其他操作" -803: "用户主动关闭链接/异常断开链接" -998: "系统数据异常" -999: "系统未知错误，请联系人工核实" 若在人脸核身过程失败、未进入意愿确认过程，则该参数返回为空，请参考人脸核身错误码结果（DetectInfoText.ErrCode) 注意：此字段可能返回 null，表示取不到有效值。示例值：0
FinalResultMessage	String	意愿核身错误信息注意：此字段可能返回 null，表示取不到有效值。示例值：成功
Details	Array of IntentionActionResultDetail	意愿核身结果详细数据，与每段点头确认过程一一对应注意：此字段可能返回 null，表示取不到有效值。

IntentionActionResultDetail

意愿核身点头确认模式结果详细数据

被如下接口引用：GetDetectInfoEnhanced, GetEidResult。

名称	类型	描述
Video	String	视频base64编码（其中包含全程提示文本和点头音频，mp4格式）注意：此字段可能返回 null，表示取不到有效值。示例值：VideoBase64String
ScreenShot	Array of String	屏幕截图base64编码列表注意：此字段可能返回 null，表示取不到有效值。示例值：ScreenShotBase64String

IntentionQuestion

意愿核身过程中播报的问题文本、用户回答的标准文本。

被如下接口引用：DetectAuth, GetEidToken。

名称	类型	必选	描述
Question	String	是	当选择语音问答模式时，系统自动播报的问题文本，最大长度为150个字符。示例值：请问您本次业务是本人自愿办理吗？如是，请回复“我同意”。
Answers	Array of String	是	当选择语音问答模式时，用于判断用户回答是否通过的标准答案列表，传入后可自动判断用户回答文本是否在标准文本列表中。列表长度最大为50，单个答案长度限制10个字符。示例值：“同意”，“我同意”，“确认”，“我确认”

IntentionQuestionResult

意愿核身问答模式结果

被如下接口引用：GetDetectInfoEnhanced, GetEidResult。

名称	类型	描述
FinalResultDetailCode	Integer	意愿核身错误码： 0: "成功" -1: "参数错误" -2: "系统异常" -101: "请保持人脸在框内" -102: "检测到多张人脸" -103: "人脸检测失败" -104: "人脸检测不完整" -105: "请勿遮挡眼睛" -106: "请勿遮挡嘴巴" -107: "请勿遮挡鼻子" -201: "人脸比对相似度低" -202: "人脸比对失败" -301: "意愿核验不通过" -302: "用户回答阶段未检测到张嘴动作" -800: "前端不兼容错误" -801: "用户未授权摄像头和麦克风权限" -802: "核验流程异常中断，请勿切屏或进行其他操作" -803: "用户主动关闭链接/异常断开链接" -998: "系统数据异常" -999: "系统未知错误，请联系人工核实" 若在人脸核身过程失败、未进入意愿确认过程，则该参数返回为空，请参考人脸核身错误码结果（DetectInfoText.ErrCode) 注意：此字段可能返回 null，表示取不到有效值。
FinalResultMessage	String	意愿核身错误信息注意：此字段可能返回 null，表示取不到有效值。
Video	String	视频base64（其中包含全程问题和回答音频，mp4格式）注意：此字段可能返回 null，表示取不到有效值。
ScreenShot	Array of String	屏幕截图base64列表注意：此字段可能返回 null，表示取不到有效值。
ResultCode	Array of String	和答案匹配结果列表 0：成功，-1：不匹配注意：此字段可能返回 null，表示取不到有效值。示例值：0
AsrResult	Array of String	回答问题语音识别结果列表注意：此字段可能返回 null，表示取不到有效值。
Audios	Array of String	答案录音音频注意：此字段可能返回 null，表示取不到有效值。
FinalResultCode	String	意愿核身最终结果： 0：认证通过，-1：认证未通过，-2：浏览器内核不兼容，无法进行意愿校验。建议使用“FinalResultDetailCode”参数获取详细的错误码信息。注意：此字段可能返回 null，表示取不到有效值。示例值：0

IntentionVerifyData

意愿核身相关结果

被如下接口引用：GetDetectInfoEnhanced, GetEidResult。

名称	类型	描述
IntentionVerifyVideo	String	意愿确认环节中录制的视频（base64）。若不存在则为空字符串。注意：此字段可能返回 null，表示取不到有效值。
AsrResult	String	意愿确认环节中用户语音转文字的识别结果。若不存在则为空字符串。注意：此字段可能返回 null，表示取不到有效值。
ErrorCode	Integer	意愿确认环节的结果码。当该结果码为0时，语音朗读的视频与语音识别结果才会返回。注意：此字段可能返回 null，表示取不到有效值。示例值：0
ErrorMessage	String	意愿确认环节的结果信息。注意：此字段可能返回 null，表示取不到有效值。
IntentionVerifyBestFrame	String	意愿确认环节中录制视频的最佳帧（base64）。若不存在则为空字符串。注意：此字段可能返回 null，表示取不到有效值。

RetrievalLivenessExtraInfo

模版检索详细信息

被如下接口引用：DetectAIFakeFaces。

名称	类型	描述
HitGroup	String	命中的模版类型，其中Common-公共库；Auto-自动聚类库；Owner-自建模版库注意：此字段可能返回 null，表示取不到有效值。示例值：Common
SimilarityScore	Float	命中的相似度注意：此字段可能返回 null，表示取不到有效值。示例值：0.98
HitTemplate	String	命中的模板id 注意：此字段可能返回 null，表示取不到有效值。示例值：45

RuleIdConfig

RuleId相关配置

被如下接口引用：DetectAuth。

名称	类型	必选	描述
IntentionRecognition	Boolean	否	意愿核身过程中识别用户的回答意图，开启后除了IntentionQuestions的Answers列表中的标准回答会通过，近似意图的回答也会通过，默认不开启。示例值：true
IntentionType	Integer	否	意愿核身类型，默认为0： 0：问答模式，DetectAuth接口需要传入IntentionQuestions字段； 1：点头模式，DetectAuth接口需要传入IntentionActions字段；示例值：0
MouthOpenRecognition	Boolean	否	用户语音回答过程中是否开启张嘴识别检测，默认不开启，仅在意愿核身问答模式中使用。示例值：false

WeChatBillDetail

账单详情

被如下接口引用：GetWeChatBillDetails。

名称	类型	描述
BizToken	String	token
ChargeCount	Integer	本token收费次数示例值：0
ChargeDetails	Array of ChargeDetail	本token计费详情
RuleId	String	业务RuleId

上一篇: 获取风险信息Token 下一篇: 错误码