调用 ElementSmartVerify 接口发起卡证核身请求,进行身份证照片 OCR、姓名和身份证二要素验证。
传入图片格式要求
-
图片大小:图片大小建议不超过 2 MB。图片过大可能会影响接口响应速度,甚至可能导致读取图片超时失败。
-
图片格式:PNG、JPG、JPEG。
-
图片分辨率:图片长宽需要大于 64 像素且小于 8192 像素。
-
图片质量要求:图片模糊、内容遮挡、光线或图片角度异常都可能会对识别结果产生影响;在识别身份证人像面时,需要确保人脸呈现正向。
接口说明
接口名: ElementSmartVerify 。
服务地址:
cloudauth.aliyuncs.com
。
请求方法:POST 和 GET。
传输协议:HTTPS。
接口描述:纯服务端调用此接口,进行身份证照片 OCR、姓名和身份证二要素验证。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
SceneId |
Long |
是 |
100000xxxx |
认证场景 ID。 您必须先在 增强版实人认证控制台 创建认证场景,才能获得认证场景 ID。更多信息,请参见 添加认证场景 。 |
OuterOrderNo |
String |
是 |
e0c34a77f5ac40a5aa5e6ed20c35xxxx |
商户服务端自定义的业务请求唯一标识,用于后续定位排查问题使用,由 32 位字母、数字组合而成。 |
Mode |
String |
是 |
OCR_ID |
卡证核身的模式。取值:
|
CertType |
String |
是 |
IDENTITY_CARD |
证件类型。唯一取值: IDENTITY_CARD ,表示身份证。 |
CertName |
String |
否 |
张三 |
用户的真实姓名。 当 Mode 取值为 VERIFY_ID_NAME 时, CertName 为必选字段。 |
CertNo |
String |
否 |
330103xxxxxxxxxxxx |
用户的证件号码。 当 Mode 取值为 VERIFY_ID_NAME 时, CertNo 为必选字段。 |
CertUrl |
String |
否 |
https://www.aliyun.com/cert.jpeg |
证件地址,公网可访问的 HTTP、HTTPS 链接。 CertUrl 和 CertFileObject 二选一。 |
CertFileObject |
InputStream |
否 |
无 |
本地证件文件。 CertUrl 和 CertFileObject 二选一。 |
CertNationalEmblemUrl |
String |
否 |
https://www.aliyun.com/cert.jpeg |
身份证国徽面证件地址,公网可访问的 HTTP、HTTPS 链接。 |
返回数据
名称 |
类型 |
是否必选 |
示例值 |
描述 |
RequestId |
String |
是 |
130A2C10-B9EE-4D84-88E3-5384FF039795 |
请求 ID。 |
Message |
String |
否 |
success |
返回信息。 |
Code |
String |
是 |
200 |
返回码。取值:
|
ResultObject.Passed |
String |
否 |
T |
认证是否通过,取值:
说明
如果接口异常或接口是未认证状态,则不返回该参数。 |
ResultObject.SubCode |
String |
否 |
200 |
认证结果码,请参见 ResultObject.SubCode 补充说明。 |
ResultObject.CertifyId |
String |
否 |
08573be80f944d95ac812e019e3655a8 |
认证请求 ID, 增强版实人认证 服务认证请求的唯一标识。 |
ResultObject.MaterialInfo.ocrIdCardInfo |
String |
否 |
{"ocrIdCardInfo":{"address":"浙江省杭州市余杭区文一西路 969 号","birthDate":"19901226","certName":"张三","certNo":"1234561990122*****","nationality":"汉","authority":"xxx 公安局","startDate":"20201130","endDate":"20301130"}} |
认证主体的卡证信息识别结果,请参见 ResultObject.MaterialInfo.ocrIdCardInfo 补充说明 。 |
名称 |
类型 |
示例值 |
描述 |
address |
String |
xx 省 xx 市 xx 区 xx969 号 |
身份证上的住址。 |
birthDate |
String |
19901xxx |
身份证上的出生日期。 |
certName |
String |
张三 |
身份证上的姓名。 |
certNo |
String |
1234561990122***** |
身份证号。 |
nationality |
String |
汉 |
民族。 |
authority |
String |
xxx 公安局 |
签发机关。 |
startDate |
String |
20201130 |
有效期限开始时间。 |
endDate |
String |
20301130 |
有效期限结束时间。 |
错误码 |
认证描述文案 |
是否计费 |
说明 |
200 |
认证通过。 |
是 |
认证通过。 |
201 |
实名校验不通过。 |
是 |
认证不通过,可能原因:用户的身份信息不匹配、信息有误或查询不到身份信息。 |
202 |
查询不到身份信息。 |
是 |
认证不通过,可能用户户口迁移等特殊状态导致,建议预留人工审核入口,用于人工审核。 |
错误码
Code |
Message |
描述 |
200 |
success |
接口响应成功。 |
400 |
参数不能为空 |
参数不能为空。 |
401 |
参数非法 |
传入的字段不符合取值范围或长度不符合要求。 |
410 |
未开通服务 |
未开通 OSS 产品或未完成 OSS 读写授权,请登录 增强版实人认证控制台 完成授权。 |
411 |
RAM 无权限 |
需要为 RAM 用户授予 AliyunYundunCloudAuthFullAccess 的操作权限。 |
412 |
欠费中 |
增强版实人认证 或 OSS 存在欠费,请充值后再进行操作。 |
428 |
格式校验错误 |
传入的姓名、身份证号码长度必须符合国家标准且不得包含英文字母等特殊字符。 |
440 |
OCR 识别失败 |
OCR 识别失败。请检查输入图片内容,保证照片清晰、曝光正常,完整无遮挡,角度无太大偏差。 |
500 |
系统错误 |
系统内部错误, 请通过 智能在线 联系阿里云工程师协助排查。 |