全部产品
Search

搜索本产品

    ID Verification：Initialize

    文档中心

    ID Verification：Initialize

    更新时间：Jan 22, 2024

    本文介绍如何通过调用Initialize接口发起eKYC请求。

    发起认证请求

    • 接口名：Initialize。

    • 服务地址：cloudauth-intl.cn-hongkong.aliyuncs.com。

    • 请求方法：HTTPS POST。

    • 接口说明：每次开始eKYC认证流程前, 通过本接口获取transactionId，用来串联认证请求中的各个接口。

    请求参数

    名称

    类型

    是否必选

    描述

    Example

    ProductCode

    String

    是

    要接入的产品方案。取值为KYC_GLOBAL：使用eKYC产品方案，您的用户需要完成证件识别和活体认证整个流程。

    KYC_GLOBAL

    MerchantBizId

    String

    是

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

    说明

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

    e0c34a77f5ac40a5aa5e6ed20c35****

    MetaInfo

    String

    是

    MetaInfo环境参数，需要通过客户端SDK获取，详情请参见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"}

    MerchantUserId

    String

    是

    您自定义的用户ID，或者其他可以识别特定用户的标识，例如手机号码、邮箱地址等。强烈建议对该字段的值进行预先脱敏，例如对值进行哈希处理。

    123456789

    DocType

    String

    是

    证件类型，以8位数字组合作为唯一标识，详见下表。

    ​01560000

    DocScanMode

    String

    否

    证件采集拍照模式。

    manual：手动拍照。

    manual

    ProductFlow

    String

    否

    支持卡证和人脸顺序编排：

    • DOC_FACE（默认）

    • FACE_DOC

    DOC_FACE

    CallbackUrl

    String

    否

    认证结果的回调通知地址，回调请求方式默认为GET，回调地址必须以https开头。平台在完成认证后会回调该地址，并自动添加transactionId、passed

    和subcode字段。

    https://www.aliyun.com?callbackToken=1000004826&transactionId=shaxxxx&passed=Y&subCode=200

    CallbackToken

    String

    否

    安全Token，由您自行生成，用于防重复、防篡改校验。

    如果设置了该值，将会在回调地址显示CallbackToken字段。

    NMjvQanQgplBSaEI0sL86WnQplB

    证件类型列表

    详情请单击热门国家和证件列表和其他国家和证件列表下载查看。

    返回数据

    名称

    类型

    描述

    示例值

    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.TransactionId

    String

    整个认证流程的唯一标识。该字段为计费统计字段，并用于发起CheckResult接口请求。

    说明

    当请求过程中出现错误时（例如参数无效），则不会返回transactionId。

    hksb7ba1b28130d24e015d694361bee4

    返回Code和Message说明

    Code

    Message

    描述

    200

    Success

    请求成功。

    400

    MissingParameter

    参数不能为空。

    400

    InvalidParameter

    非法参数。

    401

    OcrFail

    文本解析失败。

    403

    Forbidden.RAMUserAccessDenied

    需要给RAM用户授予AliyunAntCloudAuthFullAccess的操作权限。

    403

    Forbidden.AccountAccessDenied

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

    403

    Throttling.Api

    API限流拦截。

    404

    ProcessNotCompleted

    整个认证流程未完成。

    500

    InternalError

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