调用InitSmartVerify发起身份证核验请求。

接口说明

接口名:InitSmartVerify

服务地址:cloudauth.aliyuncs.com

请求方法:POST和GET。

传输协议:HTTPS。

接口描述:每次开始认证前调用本接口获取CertifyId,用来串联认证请求中的各个接口。

请求参数

名称类型是否必选示例值描述
SceneIdLong100000****认证场景ID。

您必须先在增强版实人认证控制台创建认证场景,才能获得认证场景ID。更多信息,请参见添加认证场景

OuterOrderNoStringe0c34a77f5ac40a5aa5e6ed20c35****商户请求的唯一标识,由32位字母、数字组合而成。
CertTypeStringIDENTITY_CARD证件类型。取值:IDENTITY_CARD:身份证。
ModeStringOCR卡证核身的模式。取值:
  • OCR:识别模式。
  • OCR_VERIFY:识别且认证模式。
MetaInfoString{"zimVer":"3.0.0","appVersion": "1","bioMetaInfo": "4.1.0:11501568,0","appName": "com.aliyun.antcloudauth","deviceType": "ios","osVersion": "iOS 10.3.2","apdidToken": "","deviceModel": "iPhone9,1"}MetaInfo环境参数,需要通过客户端SDK获取。

更多信息,请参见Android客户端接入iOS客户端接入

MobileString1390000****用户手机号码。
IpString114.100.XX.XX用户网络IP。
UserIdString148562088256****您业务中自定义的用户ID,请保持唯一。
callbackUrlStringhttps://www.aliyun.com认证结果的回调通知地址,必须以https开头。
平台在完成认证后会回调该地址,并自动添加certifyIdpassedsubcode字段,示例:https://www.aliyun.com?certifyId=xxxx&passed=T&subcode=200
警告 仅当认证完成(包含认证通过和认证未通过)时才会触发回调,若认证中放弃、异常中断或未进行认证均不会通知。建议您收到回调通知时,若有需要可通过查询接口获取认证详情资料信息。
CallbackTokenStringNMjvQanQgplBSaEI0sL86WnQplB安全Token,用于防重复、防篡改校验。如果传入该参数会在回调地址显示CallbackToken字段。

返回数据

名称类型是否必选示例值描述
RequestIdString130A2C10-B9EE-4D84-88E3-5384FF039795请求ID。
MessageStringsuccess错误信息。
CodeString200返回码。取值:
  • 200:成功。
  • 其他值:失败,详见错误码
ResultObject.CertifyIdString91707dc296d469ad38e4c5efa6a0****认证请求ID,增强版实人认证服务认证请求的唯一标识。
查询认证结果时,必须传入认证请求ID。
警告

CertifyId字段为计费统计字段,为了方便后续核对账单,请您在本地留存该字段信息。

初始化接口返回的认证CertifyId在30分钟有效仅能认证提交一次,请您在有效期内应用,避免重复使用。

代码示例

请参见身份证核验Java SDK调用示例
说明 如果您需要其他语言的SDK代码示例,您可以通过OpenAPI开发者门户在线调试工具调试API接口。运行成功后,OpenAPI开发者门户可以自动生成SDK代码示例。

错误码

CodeMessage描述
200success接口响应成功。
400参数不能为空参数不能为空。
401参数非法非法参数。传入的姓名、身份证号码长度必须符合国家标准且不得包含英文字母等特殊字符。
404认证场景配置不存在认证场景配置不存在,请先在控制台上创建认证场景。

更多信息,请参见添加认证场景

410未开通服务未开通OSS产品或未完成OSS读写授权,请登录控制台完成授权。具体操作,请参见授权增强版实人认证访问OSS空间
411RAM无权限需要给RAM用户授予AliyunYundunCloudAuthFullAccess的操作权限。
412欠费中增强版实人认证或OSS存在欠费,请充值后再进行操作。
428格式校验错误参数格式校验错误,请调整参数格式。
500系统错误系统内部错误,请通过智能在线联系阿里云工程师协助排查。