全部产品
Search
文档中心

ID Verification:CheckResult

更新时间:Oct 25, 2024

本文介绍如何通过CheckResult接口查询eKYC方案的认证结果。

接口说明

接口名:CheckResult。

服务地址:cloudauth-intl.cn-hongkong.aliyuncs.com

请求方法:HTTPS POST。

接口说明:当您收到回调通知之后,可以在服务端通过该接口获取相应的认证状态和认证资料。

QPS限量:API独享QPS限量,详情请参见ID Verification - KYC 服务端API QPS限量说明

请求参数

名称

类型

是否必选

描述

示例值

MerchantBizId

String

Yes

您自定义的业务唯一标识,用于后续定位排查问题使用。支持长度为32位的字母和数字的组合,请确保唯一。

说明

阿里云服务器不会对该字段的值进行唯一性检查。为了更好地跟踪,强烈建议保证字段唯一性。

e0c34a77f5ac40a5aa5e6ed20c35****

TransactionId

String

Yes

整个认证流程的唯一标识。该值需要调用Initialize获取。

hksb7ba1b28130d24e015d694361bee4

IsReturnImage

String

No

是否需要返回认证图片资料:

  • Y:需要。

  • N:不需要(默认)。

Y

返回数据

名称

类型

描述

示例值

HTTP Status Code

Integer

HTTP状态码。

200

HTTP Body

RequestId

String

请求ID。

130A2C10-B9EE-4D84-88E3-5384FF039795

Code

String

返回码。关于返回码的具体信息,请参见返回Code和Message说明

Success

Message

String

请求消息的响应信息。

success

Result.Passed

String

认证最终结果。取值。

  • Y:通过。

  • N:不通过。

Y

Result.SubCode

String

认证结果描述。更多信息,请参见ResultObject.SubCode错误码说明

200

Result.ExtFaceInfo

String

活体人脸验证相关结果信息。关于JSON格式,请参见右侧示例。更多信息,请参见ExtFaceInfo

{

"faceAttack": "N",

"faceComparisonScore": 99.99,

"faceImg": base64格式,

"facePassed": "Y",

"faceQuality": 95.45,

"faceOcclusion": "N"

"docVideoUrl": "https://aliyun-cloudauth.oss-aliyuncs.com/******.webm"

}

Result.ExtIdInfo

String

证件识别相关结果信息。

关于JSON格式,请参见右侧示例。更多信息,请参见ExtIdInfo

{

"ocrIdInfo": {

"expiryDate": "",

"originOfIssue": "公安部出入境管理局",

"englishName": "LI SI",

"sex": "男",

"name": "李四",

"idNumber": "H11111112",

"issueDate": "2013-01-02",

"birthDate": "1990-02-21"

},

"ocrIdPassed": "N",

"spoofInfo": {

"spoofResult": "Y",

"spoofType": [

"SCREEN_REMARK"

]

}

}

ExtFaceInfo

名称

类型

描述

示例值

facePassed

String

扫脸阶段的活体人脸验证最终结果:

  • Y:通过。

  • N:不通过。

Y

faceComparisonScore

Double

采集人脸和证件人像比对分。比对分取值范围0~100。

99.99

faceImg

String

采集人脸图片,Base64格式。如在发起接口请求时,参数isReturnImage=Y且扫脸流程顺利完成,则返回此字段。

base64格式

faceAttack

String

采集人脸是否涉及活体攻击,攻击为Y,否则为N

N

faceQuality

Double

活体人脸质量分数。取值范围0~100。

99.99

faceOcclusion

String

是否有脸部遮挡,有脸部遮挡为Y,否则为N

N

docVideoUrl

String

存证OSS下载地址。

说明
  • 存证视频URL有效期15分钟。

  • 在认证完成后30分钟内,可重复查询获取。超过30分钟,系统将自动删除存证视频文件且无法恢复,请及时下载保存。

https://aliyun-cloudauth.oss-aliyuncs.com/******.webm

faceAge

String

人脸预测的参考年龄,可能存在预测失败无法返回的情况。

30

faceGender

String

人脸图片预测的性别,可能存在预测失败无法返回的情况。

  • M:男

  • F:女

M

ExtIdInfo

名称

类型

描述

示例值

ocrIdPassed

String

证件OCR识别阶段的最终结果:

  • Y:通过。

  • N:不通过。

N

idImage

String

证件OCR照片,base64格式。如在发起接口请求时,参数isReturnImage=Y且证件OCR流程顺利完成,则返回此字段。

base64格式

ocrIdInfo

String

证件OCR字段信息。

说明

如果证件OCR流程失败,则该字段值为空。

{

"expiryDate": "",

"originOfIssue": "公安部出入境管理局",

"englishName": "LI SI",

"sex": "男",

"name": "李四",

"idNumber": "H11111112",

"issueDate": "2013-01-02",

"birthDate": "1990-02-21"

}

spoofInfo

String

证件防伪检测结果,包括风险判定结果和风险类型:

  • spoofResult

    • Y存在风险。

    • N正常。

  • spoofType

    • SCREEN_REMARK:翻拍。

    • PHOTO_COPY复印件。

    • TAMPER:篡改。

{

"spoofResult": "Y",

"spoofType": [

"SCREEN_REMARK"

]

}

ocrIdEditInfo

String

用户在OCR结果页二次编辑后,提交的证件OCR字段信息。该功能支持配置关闭,具体请联系客户经理。

{

"expiryDate": "2026-01-02",

"originOfIssue": "公安部出入境管理局",

"englishName": "ZHANG SAN",

"sex": "男",

"name": "张三",

"idNumber": "H11111115",

"issueDate": "2013-01-02",

"birthDate": "1990-02-21"

}

返回Code和Message说明

HTTP状态码

Code

Message说明

200

Success

请求成功。

400

MissingParameter

参数不能为空。

400

InvalidParameter

非法参数。

400

TransactionIdInvalid

无效Transaction id。

403

Forbidden.RAMUserAccessDenied

需要给RAM用户授予AliyunAntCloudAuthFullAccess的操作权限。更多信息,请参见授权RAM用户访问服务

403

Forbidden.AccountAccessDenied

账户存在欠费,请充值后再进行操作。

403

Throttling.Api

API限流拦截。

404

ProcessNotCompleted

整个认证流程未完成。

500

InternalError

系统内部错误,请反馈工程师排查。

ResultObject.SubCode错误码说明

错误码

是否计费

描述和原因建议

200

Yes

认证通过。

201

Yes

官方数据库中姓名和身份证不一致。可能是用户的信息有误或用户的信息为假信息,建议用户确认后重新操作。

202

Yes

官方数据库查询不到身份信息。建议预留人工审核入口,进行人工审核。

204

Yes

活体人脸和证脸比对不一致。可能人证不符或活体照片质量较低。

205

Yes

活体检测存在风险

206

Yes

业务策略限制。开启安全模式下,会对认证的设备等环境进行安全检测,若检测到可能存在风险会判定认证结果不通过。您可以按照如下方法排查处理:

  • 提醒用户卸载掉设备上可能安装的各种多开、分身、虚拟环境等软件或插件,恢复设备系统初始安全环境后重试。

207

Yes

官方数据库中人脸核验失败。可能不是同一人或活体照片质量较低。

209

Yes

权威比对源异常。

212

Yes

证件防伪检测存在风险。可能存在翻拍、篡改、复印等高风险操作。

OCR识别返回字段

中国香港居民身份证

说明

智能身份证2003和2018版本均支持。

字段

类型

描述

name

String

姓名

englishName

String

姓名(英文)

nameCode

String

中文姓名电码

sex

String

性别。取值:

  • M(男)

  • F(女)

birthDate

String

出生日期

idNumber

String

身份证号码

currentIssueDate

String

登记日期

firstIssueDate

String

首次登记的月份和年份

isPermanent

String

是否属于永久性居民身份证。取值:

  • Y(是)

  • N(不是)

symbols

String

符号标记。例如:"***AZ"。

往来港澳通行证

字段

类型

描述

name

String

姓名

englishName

String

姓名(拼音)

sex

String

性别

birthDate

String

出生日期

idNumber

String

证件号码

issueDate

String

签发日期

expiryDate

String

失效日期

placeOfIssue

String

签发地点

originOfIssue

String

签发机关

港澳居民来往内地通行证

字段

类型

描述

name

String

姓名

englishName

String

姓名(英文)

sex

String

性别

birthDate

String

出生日期

idNumber

String

证件号码

issueDate

String

签发日期

expiryDate

String

失效日期

originOfIssue

String

签发机关

全球护照

字段

类型

描述

surname

String

givenname

String

sex

String

性别

birthDate

String

出生日期

passportNo

String

护照号

nationality

String

国籍

expiryDate

String

失效日期

countryCode

String

国家代码

澳门居民身份证

字段

类型

描述

surnameCN

String

姓(中文)

givennameCN

String

名(中文)

surname

String

姓(英文)

givenname

String

名(英文)

sex

String

性别

birthDate

String

出生日期

idNumber

String

证件号码

expiryDate

String

失效日期

placeOfBirth

String

出生地代码。例如:"AS"。

台湾居民来往大陆通行证

字段

类型

描述

name

String

姓名

englishName

String

姓名(拼音)

sex

String

性别

birthDate

String

出生日期

idNumber

String

证件号码

issueDate

String

签发日期

expiryDate

String

失效日期

originOfIssue

String

签发机关

placeOfIssue

String

签发地点

中华人民共和国居民身份证

字段

类型

描述

name

String

姓名

sex

String

性别

ethnicity

String

民族

birthDate

String

出生日期

idNumber

String

身份证号

address

String

地址

province

String

city

String