InitCardVerify-发起认证请求

重要

本文中含有需要您注意的重要提示信息,忽略该信息可能对您的业务造成影响,请务必仔细阅读。

本文介绍如何通过调用InitCardVerify接口发起认证请求。

接口信息

重要

在使用本接口前,请确保已完整阅读接入流程,并开通服务。

接口名:InitCardVerify

全局接入地址:cloudauth.aliyuncs.com(IPv4)或cloudauth-dualstack.aliyuncs.com(IPv6)

请求方法:POSTGET

传输协议:HTTPS

接口说明:每次开始认证前通过本接口获取CertifyId,用来串联认证请求中的各个接口。

QPS限量:API独享QPS限量,详情请参见信息核验接口QPS限量说明

请求参数

名称

类型

是否必选

描述

示例值

MerchantBizId

String

您自定义的业务唯一标识,用于后续定位排查问题使用。

支持长度为32位的字母和数字的组合,请确保唯一。

e0c34a77f5ac40a5aa5e6ed2********

MetaInfo

String

MetaInfo环境参数,需要通过客户端SDK获取

{
  "zimVer": "3.0.0",
  "appVersion": "1",
  "bioMetaInfo": "4.1.0:1150****,0",
  "appName": "com.aliyun.antcloudauth",
  "deviceType": "ios",
  "osVersion": "iOS 10.3.2",
  "apdidToken": "",
  "deviceModel": "iPhone9,1"
}

CardType

String

证件类型,取值:IDENTITY_CARD。

IDENTITY_CARD

Model

String

核验方式,取值:

OCR_VERIFY:OCR识别且认证模式。

OCR_VERIFY

VerifyMeta

String

核验类型,取值:

身份二要素(姓名+身份证号):ID_2_META

ID_2_META

CardPageNumber

String

SDK采集卡证页数:

  • 1”:采集正面

  • 2”:采集正反两面

2

PictureSave

String

是否临时存储app采集图片信息:

  • Y:是

  • N:否

说明

如果此处选择是,在查询接口支持返回卡证图片信息。

Y

CallbackUrl

String

认证结果的回调通知地址仅支持HTTPS协议。

平台在完成认证后会回调该地址,并自动添加certifyIdpassedsubcode字段,示例:https://www.aliyun.com?certifyId=xxxx&passed=T&subcode=200

警告

仅当认证完成时才会触发回调,若认证中放弃、异常中断或未进行认证均不会通知。建议您收到回调通知时,若有需要可通过查询接口获取认证详情资料信息。

https://www.aliyun.com

CallbackToken

String

安全Token,用于防重复、防篡改校验。如果传入该参数会在回调地址显示CallbackToken字段。

NMjvQanQgplBSaEI0sL86Wn****

DocScanMode

String

拍照方式枚举(手动/ 自动拍照):

  • shoot:拍照

  • scan:扫描

  • auto:自动切换

shoot

响应结果

名称

类型

描述

示例值

RequestId

String

请求ID。

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

Message

String

返回信息。

success

Code

String

返回码:200为成功,其他为失败。

重要
  • 此参数代表是否正确调用了接口,详细的返回码说明请参见服务端错误码

  • 业务核验结果请通过ResultObject中的字段查看。

200

ResultObject

CertifyId

String

核验请求ID,核验服务认证请求的唯一标识。

查询认证结果时,必须传入认证请求ID。

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

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

91707dc296d469ad38e4c5ef********

SDK调用示例

重要

集成前请确保您已完整阅读接入流程开通了服务获取AccessKey且正确配置环境变量

关于SDK示例和安装包获取:

  • 您可以在OpenAPI的在线接口调试页面的右侧找到对应的SDK调用示例,并在代码示例的右上角点击SDK安装信息查看SDK的安装信息。

    说明

    注意选择所需的编程语言。

    image

  • 如果您有离线安装的需求,可以进入SDK安装页面选择需要语言SDK,并转到发布地址获取。

    image

  • OpenAPI平台可对接口进行在线调试,并获取SDK示例。

  • 代码示例工程各编程语言调用SDK的示例工程,可作为接入参考。