tencent cloud

APIs

文档APIseKYCData Types

数据结构

聚焦模式
字号
最后更新时间： 2026-04-24 16:17:14

Address

海外证件地址

被如下接口引用：GetSdkVerificationResult, GetWebVerificationResultIntl。

名称 类型 描述
Country String 国家
注意：此字段可能返回 null，表示取不到有效值。
PostalCode String 邮政编码
注意：此字段可能返回 null，表示取不到有效值。
Subdivision String 子地区
注意：此字段可能返回 null，表示取不到有效值。
City String 城市
注意：此字段可能返回 null，表示取不到有效值。
FormattedAddress String 完整地址
注意：此字段可能返回 null，表示取不到有效值。
LineOne String 地址栏第一行
注意：此字段可能返回 null，表示取不到有效值。
LineTwo String 地址栏第二行
注意：此字段可能返回 null，表示取不到有效值。
LineThree String 地址栏第三行
注意：此字段可能返回 null，表示取不到有效值。
LineFour String 地址栏第四行
注意：此字段可能返回 null，表示取不到有效值。
LineFive String 地址栏第五行
注意：此字段可能返回 null，表示取不到有效值。

AttackRiskDetail

疑似攻击风险详情

被如下接口引用：DetectAIFakeFaces。

名称 类型 描述
Type String

疑似的攻击痕迹类型SuspectedSpoofingAttack：翻拍攻击SuspectedSynthesisImage：疑似合成图片SuspectedSynthesisVideo：疑似合成视频SuspectedAnomalyAttack：人脸特征疑似非真人SuspectedAdversarialAttack：疑似对抗样本攻击SuspectedBlackIndustry：疑似黑产批量模板攻击SuspectedWatermark：疑似存在水印


注意：此字段可能返回 null，表示取不到有效值。

CardVerifyResult

eKYC身份认证过程中，用户证件的识别结果。

被如下接口引用：GetSdkVerificationResult。

名称 类型 描述
IsPass Boolean 鉴伪或OCR是否成功
IsEdit Boolean 用户是否自行修改卡证识别结果
注意：此字段可能返回 null，表示取不到有效值。
CardVideo FileInfo 身份证鉴伪视频的下载链接，仅开启证件视频鉴伪功能时返回，url链接有效期为10分钟。
注意：此字段可能返回 null，表示取不到有效值。
CardImage FileInfo 证件照图片的下载地址，url链接有效期为10分钟。
注意：此字段可能返回 null，表示取不到有效值。
CardInfoOcrJson FileInfo 证件照的文字识别结果，如果鉴伪失败或者ocr失败则该参数为空。url链接有效期10分钟。格式为json文本信息。
（1）中国香港证件
IdCardType为HK（香港身份证）时：

- ChineseName string 中文姓名
- FullName string 英文姓名
- RegistrationNumber string 中文姓名对应电码
- Sex string 性别 ：“男M”或“女F”
- Birthday string 出生日期
- Permanent int 永久性居民身份证。0：非永久； 1：永久； -1：未知。
- LicenseNumber string 身份证号码
- Symbol string 证件符号，出生日期下的符号，例如"AZ"
- IssuedDate string 首次签发日期
- CurrentIssueDate string 最近领用日期
- HKIDVersion string 香港身份证版本，HKID-2003：03版身份证，HKID-2018：18版身份证

（2）马来西亚证件
IdCardType为ML（马来西亚身份证）时：
- Sex string 男：LELAKI 女：PEREMPUAN
- Birthday string 生日
- LicenseNumber string 证号
- FullName string 名字
- FormattedAddress string 地址
- Type string 证件类型

（3）菲律宾证件
IdCardType为PhilippinesVoteID时：
- Birthday string 生日
- Address string 地址
- LastName string 姓氏
- FirstName string 姓名
- VIN string VIN号
- CivilStatus string 婚姻状况
- Citizenship string 国籍
- PrecinctNo string 地区

IdCardType为PhilippinesDrivingLicense时：
- Sex string 性别
- Birthday string 生日
- Name string 姓名
- Address string 地址
- LastName string 姓氏
- FirstName string 首姓名
- MiddleName string 中间姓名
- Nationality string 国籍
- LicenseNo string 证号
- ExpiresDate string 有效期
- AgencyCode string 机构代码

IdCardType为PhilippinesTinID时：
- LicenseNumber string 编码
- FullName string 姓名
- Address string 地址
- Birthday string 生日
- IssueDate string 发证日期

IdCardType为PhilippinesSSSID时：
- LicenseNumber string 编码
- FullName string 姓名
- Birthday string 生日

IdCardType为PhilippinesUMID时：
- Surname string 姓
- MiddleName string 中间名
- GivenName string 名
- Sex string 性别
- Birthday string 生日
- Address string 地址
- CRN string CRN码

（4）印度尼西亚证件
IdCardType为IndonesiaIDCard时：
- LicenseNumber string 证件号码
- FullName string 姓名
- Birthday string 出生地/出生时间
- Sex string 性别
- BloodType string 血型
- FormattedAddress string 地址
- Street string 街道
- Village string 村
- Area string 地区
- Religion string 宗教信仰
- MaritalStatus string 婚姻状况
- Occupation string 职业
- Nationality string 国籍
- DueDate string 身份证有效期限
- IssuedDate string 发证日期

（5）通用证件
IdCardType为MLIDPassport时：
- FullName string 姓名
- Surname string 姓
- GivenName string 名
- Birthday string 出生日期
- Sex string 性别（F女，M男）
- DateOfExpiration string 有效期
- IssuingCountry string 发行国
- NationalityCode string 国籍所属地区代码
注意：此字段可能返回 null，表示取不到有效值。
RequestId String 单次流程请求标示。
NormalCardInfo NormalCardInfo 证件照的文字识别结果
注意：此字段可能返回 null，表示取不到有效值。
WarnCardInfos Array of Integer 告警码
-9101 证件边框不完整告警
-9102 证件复印件告警
-9103 证件翻拍告警
-9107 证件反光告警
-9108 证件模糊告警
-9109 告警能力未开通
注意：此字段可能返回 null，表示取不到有效值。
EditDetails Array of EditDetail 本次EKYC卡证OCR的修改详情，当用户自行修改卡证识别结果后（IsEdit=true），EditDetails会返回被修改的字段。当IsEdit=false，EditDetails为空。
注意：此字段可能返回 null，表示取不到有效值。

CompareResult

单次比对结果描述

被如下接口引用：GetSdkVerificationResult。

名称 类型 描述
ErrorCode String 最终认证结果码：
0: 成功
1001: 调用活体引擎失败
1004: 人脸检测失败
2004: 上传人脸图片过大或者过小
2012: 人脸未完整露出
2013: 未检测到人脸
2014: 上传的图片分辨率太低，请重新上传
2015: 比对失败
2016: 比对相似度未达到通过标准
ErrorMsg String 最终认证结果描述。
LiveData FileInfo 本次活体SDK生成的活体算法数据包。
LiveVideo FileInfo 本次用户认证视频文件的下载地址，下载链接有效期为10分钟。
ActionVideo FileInfo 记录用户执行的特定动作文件的下载地址，用于AI人脸防护盾分析，下载链接有效期为10分钟。
LiveErrorCode String 活体认证结果码：
0: 成功
1001: 调用活体引擎失败
1004: 人脸检测失败
LiveErrorMsg String 活体认证结果描述。
BestFrame FileInfo 用户认证过程中人像照片截图的下载地址，下载链接有效期为10分钟。
注意：此字段可能返回 null，表示取不到有效值。
ProfileImage FileInfo 证件照头像截图的下载地址，下载地址链接有效期为10分钟。
CompareErrorCode String 人脸比对结果码：
0: 成功
2004: 上传人脸图片过大或者过小
2012: 未检测到完整人脸
2013: 未检测到人脸
2014: 上传的图片分辨率太低，请重新上传
2015: 比对失败
2016: 比对相似度未达到通过标准
注意：此字段可能返回 null，表示取不到有效值。
CompareErrorMsg String 人脸比对结果描述。
注意：此字段可能返回 null，表示取不到有效值。
Sim Float 人脸比对的相似度分数。
注意：此字段可能返回 null，表示取不到有效值。
IsNeedCharge Boolean 该字段废弃。
CardInfoInputJson FileInfo 用户编辑后的证件照信息。该参数暂不启用。
注意：此字段可能返回 null，表示取不到有效值。
RequestId String 本次认证的请求标识。
LivenessInfoTag Array of String plus版：描述当前请求活体阶段被拒绝的详细原因。 详情如下： 01-用户全程闭眼。 02-用户未完成指定动作。 03-疑似翻拍攻击。 04-疑似合成图片。 05-疑似合成视频。 06-疑似合成动作。 07-疑似黑产模板。 08-疑似存在水印。 09-反光校验未通过。 10-最佳帧校验未通过。 11-人脸质量过差。 12-人脸距离不匹配。 13-疑似对抗样本攻击。 null-无。 增强版：此字段不生效，默认为null。
注意：此字段可能返回 null，表示取不到有效值。

EditDetail

EKYC卡证OCR结果修改详情

被如下接口引用：GetSdkVerificationResult。

名称 类型 描述
FieldName String 修改的字段名称
注意：此字段可能返回 null，表示取不到有效值。
OriginalFieldValue String 字段修改前的值，即OCR的原始结果
注意：此字段可能返回 null，表示取不到有效值。
RevisedFieldValue String 字段修改后的值，即用户手动输入的结果
注意：此字段可能返回 null，表示取不到有效值。

Encryption

敏感数据加密

被如下接口引用：BankCard2EVerification, BankCard4EVerification, BankCardVerification, CheckBankCardInformation, CheckIdCardInformation, CheckIdNameDate, DetectAIFakeFaces, IdCardOCRVerification, IdCardVerification, ImageRecognition, ImageRecognitionV2, MobileNetworkTimeVerification, MobileStatus。

名称 类型 必选 描述
EncryptList Array of String 是

在使用加密服务时，填入要被加密的字段。本接口中可填入加密后的一个或多个字段


注意：此字段可能返回 null，表示取不到有效值。
CiphertextBlob String 是

加密后的对称密钥，关于密钥的生成和使用请查阅数据加密 文档。


注意：此字段可能返回 null，表示取不到有效值。
Iv String 是

有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。


注意：此字段可能返回 null，表示取不到有效值。
Algorithm String 否

加密使用的算法（支持'AES-256-CBC'、'SM4-GCM'），不传默认为'AES-256-CBC'


注意：此字段可能返回 null，表示取不到有效值。
TagList Array of String 否

SM4-GCM算法生成的消息摘要（校验消息完整性时使用）


注意：此字段可能返回 null，表示取不到有效值。

ExtraInfo

额外的详细信息

被如下接口引用：DetectAIFakeFaces。

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

FileInfo

用于描述一个文件内容，包括一个下载链接和与文件内容对应的MD5和大小。

被如下接口引用：GetLivenessResult, GetSdkVerificationResult, VideoLivenessCompare。

名称 类型 必选 描述
Url String 是 用于下载文件的URL
MD5 String 是 文件的32位MD5
Size Integer 是 文件字节数

GeneralCard

通用卡证信息

被如下接口引用：GetSdkVerificationResult, GetWebVerificationResultIntl。

名称 类型 描述
LicenseNumber String 证件号码
PersonalNumber String 个人号码，卡证类型为护照时返回
PassportCodeFirst String 护照机读码第一行
PassportCodeSecond String 护照机读码第二行
ExpirationDate String 到期日期，按照YYYY-MM-DD格式
DueDate String 有效日期，按照YYYY-MM-DD格式
IssuedDate String 签发日期，按照YYYY-MM-DD格式
IssuedAuthority String 签发机构
IssuedCountry String 签发国家，遵循ISO 3166 国家编码规范返回
FullName String 姓名
FirstName String 名
LastName String 姓
Sex String 证件性别
- M：男性
- F：女性
- X：其他性别认同
Age String 年龄，为0表示未取到有效信息
Birthday String 出生日期
BirthPlace String 出生地点
Nationality String 证件国籍，遵循ISO 3166 国家编码规范返回
RegistrationNumber String 注册号
Address Address 证件地址信息
注意：此字段可能返回 null，表示取不到有效值。
FullNameLocal String 本地化的姓名
FirstNameLocal String 本地化的名
LastNameLocal String 本地化的姓

HMTPermit

港澳台通行证

被如下接口引用：GetSdkVerificationResult, GetWebVerificationResultIntl。

名称 类型 描述
Name String 姓名
注意：此字段可能返回 null，表示取不到有效值。
EnglishName String 英文姓名
注意：此字段可能返回 null，表示取不到有效值。
Number String 证件号
注意：此字段可能返回 null，表示取不到有效值。
Sex String 性别
注意：此字段可能返回 null，表示取不到有效值。
ValidDate String 有效期限
注意：此字段可能返回 null，表示取不到有效值。
IssueAuthority String 签发机关
注意：此字段可能返回 null，表示取不到有效值。
IssueAddress String 签发地点
注意：此字段可能返回 null，表示取不到有效值。
Birthday String 出生日期
注意：此字段可能返回 null，表示取不到有效值。

IndonesiaDrivingLicense

印度尼西亚驾驶证

被如下接口引用：GetSdkVerificationResult, GetWebVerificationResultIntl。

名称 类型 描述
LastName String 姓氏
注意：此字段可能返回 null，表示取不到有效值。
FirstName String 首姓名
注意：此字段可能返回 null，表示取不到有效值。
LicenseNumber String 编号
注意：此字段可能返回 null，表示取不到有效值。
Birthday String 出生日期
注意：此字段可能返回 null，表示取不到有效值。
Address String 地址
注意：此字段可能返回 null，表示取不到有效值。
ExpirationDate String 到期日期
注意：此字段可能返回 null，表示取不到有效值。
IssuedDate String 签发日期
注意：此字段可能返回 null，表示取不到有效值。
IssuedCountry String 签发国家
注意：此字段可能返回 null，表示取不到有效值。

InternationalIDPassport

港澳台地区以及境外护照

被如下接口引用：GetSdkVerificationResult, GetWebVerificationResultIntl。

名称 类型 描述
LicenseNumber String 护照ID
注意：此字段可能返回 null，表示取不到有效值。
FullName String 姓名
注意：此字段可能返回 null，表示取不到有效值。
Surname String 姓
注意：此字段可能返回 null，表示取不到有效值。
GivenName String 名
注意：此字段可能返回 null，表示取不到有效值。
Birthday String 出生日期
注意：此字段可能返回 null，表示取不到有效值。
Sex String 性别（F女，M男）
注意：此字段可能返回 null，表示取不到有效值。
DateOfExpiration String 有效期
注意：此字段可能返回 null，表示取不到有效值。
IssuingCountry String 发行国
注意：此字段可能返回 null，表示取不到有效值。
NationalityCode String 国家地区代码
注意：此字段可能返回 null，表示取不到有效值。
PassportCodeFirst String 最下方第一行 MRZ Code 序列
注意：此字段可能返回 null，表示取不到有效值。
PassportCodeSecond String 最下方第二行 MRZ Code 序列
注意：此字段可能返回 null，表示取不到有效值。

JapanIDCard

日本身份证

被如下接口引用：GetSdkVerificationResult, GetWebVerificationResultIntl。

名称 类型 描述
FullName String 名字
注意：此字段可能返回 null，表示取不到有效值。
LicenseNumber String 身份证
注意：此字段可能返回 null，表示取不到有效值。
Age String 年龄
注意：此字段可能返回 null，表示取不到有效值。
Birthday String 生日
注意：此字段可能返回 null，表示取不到有效值。
ExpirationDate String 到期时间
注意：此字段可能返回 null，表示取不到有效值。
FormattedAddress String 地址
注意：此字段可能返回 null，表示取不到有效值。

MacaoIDCard

澳门身份证

被如下接口引用：GetSdkVerificationResult, GetWebVerificationResultIntl。

名称 类型 描述
FirstName String 首姓名
注意：此字段可能返回 null，表示取不到有效值。
LastName String 姓氏
注意：此字段可能返回 null，表示取不到有效值。
Birthday String 生日
注意：此字段可能返回 null，表示取不到有效值。
ExpirationDate String 到期日期
注意：此字段可能返回 null，表示取不到有效值。
LicenseNumber String 身份证号码
注意：此字段可能返回 null，表示取不到有效值。
Sex String 性别
注意：此字段可能返回 null，表示取不到有效值。
Age String 年龄
注意：此字段可能返回 null，表示取不到有效值。
IssuedCountry String 发行国家
注意：此字段可能返回 null，表示取不到有效值。
Field1 String mrz字段1
注意：此字段可能返回 null，表示取不到有效值。
Field2 String mrz字段2
注意：此字段可能返回 null，表示取不到有效值。

MainlandIDCard

大陆身份证识别结果

被如下接口引用：GetSdkVerificationResult, GetWebVerificationResultIntl。

名称 类型 必选 描述
FullName String 否 姓名
注意：此字段可能返回 null，表示取不到有效值。
Sex String 否 性别
注意：此字段可能返回 null，表示取不到有效值。
Nation String 否 民族
注意：此字段可能返回 null，表示取不到有效值。
Birthday String 否 生日
注意：此字段可能返回 null，表示取不到有效值。
LicenseNumber String 否 身份证号
注意：此字段可能返回 null，表示取不到有效值。
FormattedAddress String 否 地址
注意：此字段可能返回 null，表示取不到有效值。

NormalCardInfo

证件识别结果（映射字段结果）

被如下接口引用：GetSdkVerificationResult, GetWebVerificationResultIntl。

名称 类型 描述
HKIDCard NormalHKIDCard 香港身份证
注意：此字段可能返回 null，表示取不到有效值。
MLIDCard NormalMLIDCard 马来西亚身份证
注意：此字段可能返回 null，表示取不到有效值。
PhilippinesVoteID PhilippinesVoteID 菲律宾选民卡
注意：此字段可能返回 null，表示取不到有效值。
IndonesiaIDCard NormalIndonesiaIDCard 印度尼西亚身份证
注意：此字段可能返回 null，表示取不到有效值。
PhilippinesDrivingLicense PhilippinesDrivingLicense 菲律宾驾驶证
注意：此字段可能返回 null，表示取不到有效值。
PhilippinesTinID PhilippinesTinID 菲律宾TinID
注意：此字段可能返回 null，表示取不到有效值。
PhilippinesSSSID PhilippinesSSSID 菲律宾SSSID
注意：此字段可能返回 null，表示取不到有效值。
PhilippinesUMID PhilippinesUMID 菲律宾UMID
注意：此字段可能返回 null，表示取不到有效值。
InternationalIDPassport InternationalIDPassport 港澳台地区以及境外护照
注意：此字段可能返回 null，表示取不到有效值。
GeneralCard GeneralCard 通用卡证信息
注意：此字段可能返回 null，表示取不到有效值。
IndonesiaDrivingLicense IndonesiaDrivingLicense 印度尼西亚驾驶证
注意：此字段可能返回 null，表示取不到有效值。
ThailandIDCard NormalThailandIDCard 泰国身份证
注意：此字段可能返回 null，表示取不到有效值。
SingaporeIDCard SingaporeIDCard 新加坡身份证
注意：此字段可能返回 null，表示取不到有效值。
MacaoIDCard MacaoIDCard 澳门身份证
注意：此字段可能返回 null，表示取不到有效值。
MainlandIDCard MainlandIDCard 大陆身份证
注意：此字段可能返回 null，表示取不到有效值。
JapanIDCard JapanIDCard 日本身份证
注意：此字段可能返回 null，表示取不到有效值。
TaiWanIDCard TaiWanIDCard 台湾身份证
注意：此字段可能返回 null，表示取不到有效值。
HMTPermitCard HMTPermit 港澳台通行证
注意：此字段可能返回 null，表示取不到有效值。

NormalHKIDCard

香港身份证（映射字段结果）

被如下接口引用：GetSdkVerificationResult, GetWebVerificationResultIntl。

名称 类型 描述
ChineseName String 中文姓名
注意：此字段可能返回 null，表示取不到有效值。
FullName String 英文姓名
注意：此字段可能返回 null，表示取不到有效值。
RegistrationNumber String 中文姓名对应电码
注意：此字段可能返回 null，表示取不到有效值。
Sex String 性别 ：“男M”或“女F”
注意：此字段可能返回 null，表示取不到有效值。
Birthday String 出生日期
注意：此字段可能返回 null，表示取不到有效值。
Permanent String 永久性居民身份证:0-非永久；1-永久；-1-未知
注意：此字段可能返回 null，表示取不到有效值。
LicenseNumber String 身份证号码
注意：此字段可能返回 null，表示取不到有效值。
Symbol String 证件符号，出生日期下的符号，例如"***AZ"
注意：此字段可能返回 null，表示取不到有效值。
IssuedDate String 首次签发日期
注意：此字段可能返回 null，表示取不到有效值。
CurrentIssueDate String 最近领用日期
注意：此字段可能返回 null，表示取不到有效值。
HKIDVersion String 香港身份证版本，HKID-2003：03版身份证，HKID-2018：18版身份证
注意：此字段可能返回 null，表示取不到有效值。

NormalIndonesiaIDCard

印度尼西亚身份证（映射字段结果）

被如下接口引用：GetSdkVerificationResult, GetWebVerificationResultIntl。

名称 类型 描述
LicenseNumber String 证件号码
注意：此字段可能返回 null，表示取不到有效值。
FullName String 姓名
注意：此字段可能返回 null，表示取不到有效值。
Birthday String 出生地/出生时间
注意：此字段可能返回 null，表示取不到有效值。
Sex String 性别
注意：此字段可能返回 null，表示取不到有效值。
BloodType String 血型
注意：此字段可能返回 null，表示取不到有效值。
FormattedAddress String 地址
注意：此字段可能返回 null，表示取不到有效值。
Street String 街道
注意：此字段可能返回 null，表示取不到有效值。
Village String 村
注意：此字段可能返回 null，表示取不到有效值。
Area String 地区
注意：此字段可能返回 null，表示取不到有效值。
Religion String 宗教信仰
注意：此字段可能返回 null，表示取不到有效值。
MaritalStatus String 婚姻状况
注意：此字段可能返回 null，表示取不到有效值。
Occupation String 职业
注意：此字段可能返回 null，表示取不到有效值。
Nationality String 国籍
注意：此字段可能返回 null，表示取不到有效值。
DueDate String 身份证有效期限
注意：此字段可能返回 null，表示取不到有效值。
IssuedDate String 发证日期
注意：此字段可能返回 null，表示取不到有效值。
Province String 省份
注意：此字段可能返回 null，表示取不到有效值。
City String 城市
注意：此字段可能返回 null，表示取不到有效值。

NormalMLIDCard

马来西亚身份证（映射字段结果）

被如下接口引用：GetSdkVerificationResult, GetWebVerificationResultIntl。

名称 类型 描述
FullName String 姓名
注意：此字段可能返回 null，表示取不到有效值。
LicenseNumber String 身份证号
注意：此字段可能返回 null，表示取不到有效值。
Sex String 性别
注意：此字段可能返回 null，表示取不到有效值。
FormattedAddress String 地址
注意：此字段可能返回 null，表示取不到有效值。
Type String 证件类型
MyKad 身份证
MyPR 永居证
MyTentera 军官证
MyKAS 临时身份证
POLIS 警察证
IKAD 劳工证
MyKid 儿童卡
注意：此字段可能返回 null，表示取不到有效值。
Birthday String 出生日期（目前该字段仅支持IKAD劳工证、MyKad 身份证）
注意：此字段可能返回 null，表示取不到有效值。

NormalThailandIDCard

泰国身份证（映射字段结果）

被如下接口引用：GetSdkVerificationResult, GetWebVerificationResultIntl。

名称 类型 描述
LicenseNumber String 身份证号码
注意：此字段可能返回 null，表示取不到有效值。
FullName String 泰文姓名
注意：此字段可能返回 null，表示取不到有效值。
LastName String 英文姓名
注意：此字段可能返回 null，表示取不到有效值。
FirstName String 英文姓名
注意：此字段可能返回 null，表示取不到有效值。
Birthday String 英文出生日期
注意：此字段可能返回 null，表示取不到有效值。
FormattedAddress String 地址
注意：此字段可能返回 null，表示取不到有效值。
ExpirationDate String 英文到期日期
注意：此字段可能返回 null，表示取不到有效值。
IssuedDate String 英文出生日期
注意：此字段可能返回 null，表示取不到有效值。
RegistrationNumber String 序列号
注意：此字段可能返回 null，表示取不到有效值。
Religion String 宗教信仰
注意：此字段可能返回 null，表示取不到有效值。
ThaiBirthday String 泰文出生日期
注意：此字段可能返回 null，表示取不到有效值。
ThaiExpirationDate String 泰文到期日期
注意：此字段可能返回 null，表示取不到有效值。
ThaiIssueDate String 泰文签发日期
注意：此字段可能返回 null，表示取不到有效值。

OCRResult

证件信息中单张证件的内容

被如下接口引用：GetWebVerificationResultIntl。

名称 类型 描述
IsPass Boolean 身份验证或 OCR 过程是否成功。
注意：此字段可能返回 null，表示取不到有效值。
CardImageBase64 String 身份证件图像的Base64
注意：此字段可能返回 null，表示取不到有效值。
NormalCardInfo NormalCardInfo 身份证件识别结果
注意：此字段可能返回 null，表示取不到有效值。
RequestId String 请求id
注意：此字段可能返回 null，表示取不到有效值。
CardCutImageBase64 String 身份证件切边裁剪图像的Base64
注意：此字段可能返回 null，表示取不到有效值。
CardBackCutImageBase64 String 身份证件反面切边裁剪图像的Base64
注意：此字段可能返回 null，表示取不到有效值。
WarnCardInfos Array of Integer 告警码如下：
-9101：证件边框不完整告警
-9102：证件复印件告警
-9103：证件翻拍告警
-9107：证件反光告警
-9108：证件模糊告警
-9109：告警能力未开通
注意：此字段可能返回 null，表示取不到有效值。
OriginalCardInfo String 原始证件识别信息
注意：此字段可能返回 null，表示取不到有效值。

PhilippinesDrivingLicense

菲律宾驾驶证

被如下接口引用：GetSdkVerificationResult, GetWebVerificationResultIntl。

名称 类型 描述
Name String 姓名
注意：此字段可能返回 null，表示取不到有效值。
LastName String 姓氏

注意：此字段可能返回 null，表示取不到有效值。
FirstName String 首姓名
注意：此字段可能返回 null，表示取不到有效值。
MiddleName String 中间姓名
注意：此字段可能返回 null，表示取不到有效值。
Nationality String 国籍
注意：此字段可能返回 null，表示取不到有效值。
Sex String 性别
注意：此字段可能返回 null，表示取不到有效值。
Address String 地址
注意：此字段可能返回 null，表示取不到有效值。
LicenseNo String 证号
注意：此字段可能返回 null，表示取不到有效值。
ExpiresDate String 有效期
注意：此字段可能返回 null，表示取不到有效值。
AgencyCode String 机构代码
注意：此字段可能返回 null，表示取不到有效值。
Birthday String 出生日期
注意：此字段可能返回 null，表示取不到有效值。

PhilippinesSSSID

菲律宾SSSID

被如下接口引用：GetSdkVerificationResult, GetWebVerificationResultIntl。

名称 类型 描述
LicenseNumber String 编号
注意：此字段可能返回 null，表示取不到有效值。
FullName String 姓名
注意：此字段可能返回 null，表示取不到有效值。
Birthday String 生日
注意：此字段可能返回 null，表示取不到有效值。

PhilippinesTinID

菲律宾TinID

被如下接口引用：GetSdkVerificationResult, GetWebVerificationResultIntl。

名称 类型 描述
LicenseNumber String 编码
注意：此字段可能返回 null，表示取不到有效值。
FullName String 姓名
注意：此字段可能返回 null，表示取不到有效值。
Address String 地址
注意：此字段可能返回 null，表示取不到有效值。
Birthday String 生日
注意：此字段可能返回 null，表示取不到有效值。
IssueDate String 发证日期
注意：此字段可能返回 null，表示取不到有效值。

PhilippinesUMID

菲律宾UMID

被如下接口引用：GetSdkVerificationResult, GetWebVerificationResultIntl。

名称 类型 描述
Surname String 姓
注意：此字段可能返回 null，表示取不到有效值。
MiddleName String 中间名
注意：此字段可能返回 null，表示取不到有效值。
GivenName String 名
注意：此字段可能返回 null，表示取不到有效值。
Sex String 地址
注意：此字段可能返回 null，表示取不到有效值。
Birthday String 生日
注意：此字段可能返回 null，表示取不到有效值。
Address String 地址
注意：此字段可能返回 null，表示取不到有效值。
CRN String crn码
注意：此字段可能返回 null，表示取不到有效值。

PhilippinesVoteID

菲律宾选民卡

被如下接口引用：GetSdkVerificationResult, GetWebVerificationResultIntl。

名称 类型 描述
VIN String 菲律宾VoteID的VIN
注意：此字段可能返回 null，表示取不到有效值。
FirstName String 姓名
注意：此字段可能返回 null，表示取不到有效值。
LastName String 姓氏
注意：此字段可能返回 null，表示取不到有效值。
Birthday String 出生日期
注意：此字段可能返回 null，表示取不到有效值。
CivilStatus String 婚姻状况
注意：此字段可能返回 null，表示取不到有效值。
Citizenship String 国籍
注意：此字段可能返回 null，表示取不到有效值。
Address String 地址
注意：此字段可能返回 null，表示取不到有效值。
PrecinctNo String 地区
注意：此字段可能返回 null，表示取不到有效值。

RetrievalLivenessExtraInfo

模板检索详细信息

被如下接口引用：DetectAIFakeFaces。

名称 类型 描述
HitGroup String

命中的模板类型，其中Common-公共库；Auto-自动聚类库；Owner-自建模板库


注意：此字段可能返回 null，表示取不到有效值。
SimilarityScore Float

请求图像与命中攻击模板的相似度，相似度取值范围[0,2]，取值越小表示命中攻击模板的概率越高。默认阈值为0.6，当SimilarityScore≥0.6时判断为正常，SimilarityScore<0.6是判断为攻击。


注意：此字段可能返回 null，表示取不到有效值。
HitTemplate String

命中的模板id


注意：此字段可能返回 null，表示取不到有效值。

SingaporeIDCard

新加坡身份证

被如下接口引用：GetSdkVerificationResult, GetWebVerificationResultIntl。

名称 类型 描述
ChineseName String 中文名
注意：此字段可能返回 null，表示取不到有效值。
FullName String 英文名
注意：此字段可能返回 null，表示取不到有效值。
LicenseNumber String 身份证号码
注意：此字段可能返回 null，表示取不到有效值。
Sex String 性别
注意：此字段可能返回 null，表示取不到有效值。
Nationality String 出生国家
注意：此字段可能返回 null，表示取不到有效值。
Birthday String 生日
注意：此字段可能返回 null，表示取不到有效值。
Address String 地址（背面字段）
注意：此字段可能返回 null，表示取不到有效值。
Race String 国籍（背面字段）
注意：此字段可能返回 null，表示取不到有效值。
NRICCode String Nric号码（背面字段）
注意：此字段可能返回 null，表示取不到有效值。
PostCode String Post号码（背面字段）
注意：此字段可能返回 null，表示取不到有效值。
DateOfExpiration String 有效期至（背面字段）
注意：此字段可能返回 null，表示取不到有效值。
DateOfIssue String 签发日期（背面字段）
注意：此字段可能返回 null，表示取不到有效值。

TaiWanIDCard

中国台湾身份证

被如下接口引用：GetSdkVerificationResult, GetWebVerificationResultIntl。

名称 类型 描述
FullName String 名字
注意：此字段可能返回 null，表示取不到有效值。
LicenseNumber String 身份证
注意：此字段可能返回 null，表示取不到有效值。
Sex String 性别
注意：此字段可能返回 null，表示取不到有效值。
IssuedCountry String 发证城市
注意：此字段可能返回 null，表示取不到有效值。
RegistrationNumber String 注册号
注意：此字段可能返回 null，表示取不到有效值。

VerificationDetail

核验流程详细信息

被如下接口引用：GetWebVerificationResultIntl。

名称 类型 描述
ErrorCode Integer 本次核验最终结果，0为核验通过，是同一人
注意：此字段可能返回 null，表示取不到有效值。
ErrorMsg String 本次核验最终结果描述
注意：此字段可能返回 null，表示取不到有效值。
LivenessErrorCode Integer 本次核验活体结果，0为成功
注意：此字段可能返回 null，表示取不到有效值。
LivenessErrorMsg String 本次核验活体结果描述
注意：此字段可能返回 null，表示取不到有效值。
CompareErrorCode Integer 本次核验比对结果，0为视频流中采集的最佳人脸照片和上传的比对照片是同一人
注意：此字段可能返回 null，表示取不到有效值。
CompareErrorMsg String 本次核验比对结果描述
注意：此字段可能返回 null，表示取不到有效值。
ReqTimestamp Integer 本次核验时间戳(毫秒)
注意：此字段可能返回 null，表示取不到有效值。
Similarity Float 本次核验视频流中采集的最佳人脸照片和上传的比对照片的相似度， 范围[0.00, 100.00]，默认大于等于70时判断为同一人
注意：此字段可能返回 null，表示取不到有效值。
Seq String 本次核验的唯一标识
注意：此字段可能返回 null，表示取不到有效值。
LivenessInfoTag Array of String 描述当前请求活体阶段被拒绝的详细原因，该参数仅限PLUS版本核身服务返回。
- 详情如下：
01-用户全程闭眼
02-用户未完成指定动作
03-疑似翻拍攻击
04-疑似合成攻击
05-疑似黑产模版
06-疑似存在水印
07-反光校验未通过
08-疑似中途换人
09-人脸质量过差
10-距离校验不通过
11-疑似对抗样本攻击
12-嘴巴区域疑似存在攻击痕迹
13-眼睛区域疑似存在攻击痕迹
14-眼睛或嘴巴被遮挡
注意：此字段可能返回 null，表示取不到有效值。
示例值：["01"]
注意：此字段可能返回 null，表示取不到有效值。

WebVerificationConfigIntl

eKYC Web页面相关配置

被如下接口引用：ApplyWebVerificationBizTokenIntl。

名称 类型 必选 描述
AutoSkipStartPage Boolean 否

开始验证时，是否跳过开始验证页面，如果为true直接进入验证流程，默认false。如果触发降级策略，此配置将不会生效。
AutoSkip Boolean 否

验证成功时，是否跳过结果展示页面，自动跳转到RedirectURL，默认false。
CheckMode Integer 否

检测模式，参数取值如下：
1：OCR+活体检测+人脸比对；
2：活体检测+人脸比对；
3：活体检测；
4：OCR;
默认值为2。
IDCardType String 否

认证使用的卡证类型，当前支持:
1.HKIDCard：中国香港身份证
2.MLIDCard：马来西亚身份证
3.IndonesiaIDCard：印度尼西亚身份证
4.PhilippinesVoteID：菲律宾选民卡
5.PhilippinesDrivingLicense：菲律宾驾驶证
6.PhilippinesTinID：菲律宾TinID
7.PhilippinesSSSID：菲律宾SSSID
8.PhilippinesUMID：菲律宾UMID
9.InternationalIDPassport：港澳台地区以及境外护照
10.ThailandIDCard：泰国身份证
11.SingaporeIDCard：新加坡身份证
12.MainlandIDCard：大陆身份证
DisableCheckOcrWarnings Boolean 否

是否关闭证件告警，默认为false（开启告警检测功能）。当开启时，身份认证流程将会根据证件的告警情况进行拦截。若您需要使用证件鉴伪功能，请联系我们。
SecurityLevel Integer 否

认证的安全等级：
1：静默活体；
2：动作活体；
3：光线活体；
4：动作+光线活体；
5：动作+光线活体（高安全）；
默认值为3。
SkipPrivacyPolicy Boolean 否

是否跳过协议页面，默认false。当SkipPrivacyPolicy为false时，将展示协议页面，需要勾选隐私协议；当SkipPrivacyPolicy为true时，将跳过协议页面，直接进入活体流程，无需勾选隐私协议页面。
IdCardCutReturn Boolean 否

默认为false，为false时展示证件原图，为true时展示切割后的证件图片。
ThemeColor String 否

前端主题颜色，格式为RGB16进制颜色码。默认为“#2d72f1”，填写格式错误时使用默认值颜色。
Language String 否

国际化语言，默认为en（英语）。当前支持：
th：泰语；
en：英语；
zh-cn：简体中文；
zh-tc：繁体中文；
id：印尼；
AutoDowngrade Integer 否

自动降级模式，参数取值如下：
1：降级为静默活体模式；
2：禁用降级模式。
默认值为1。
ActionList String 否

控制动作序列，动作类型如下
“blink”
“mouth”
“nod”
“shake”
可以选择四个中的1-2个动作。
单动作示例：“blink”
多动作示例：“blink,mouth”.
默认值为blink
仅当SecurityLevel为2、4、5时传入此参数不同动作类型生效；否则接口报错。
LivenessRetryLimit Integer 否

活体最多可验证次数。取值范围1-99。默认值为99
LivenessTimeout Integer 否

控制活体检测超时时间秒数，取值范围(0,600]。默认45秒
SelectedWarningCodes String 否

选择需要关注的OCR告警，当出现关注的OCR告警时身份认证流程会被中断，默认值为空，表示全部告警都关注。这功能需要参数 DisableCheckOcrWarnings=false，若关闭告警，本参数将不生效。

告警码列表和释义：
-9101 边框不完整告警
-9102 复印件告警
-9103 翻拍告警
-9104 ps告警
-9107 反光告警
-9108 模糊告警
-9109 告警未开通
AllowExpiredDocument Boolean 否

是否允许过期身份证件进入活体检测流程。此参数仅在证件类型为香港身份证（HKID）时生效。
true（默认值）：允许过期香港身份证进入活体检测流程。
false：拒绝过期香港身份证，不可进入活体检测流程。
Version String 否

服务版本，包括基础版（BASIC）和PLUS版（PLUS）

枚举值：

  • BASIC： 基础版
  • PLUS： PLUS版

默认值：BASIC
上一篇: DetectReflectLivenessAndCompare下一篇: Error Codes

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈