全部產品
Search

搜尋本產品

    ID Verification：Initialize

    文件中心

    ID Verification：Initialize

    更新時間：Jul 06, 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

    系統內部錯誤，請反饋工程師排查。