All Products
Search

This Product

    ID Verification:Initialize

    Document Center

    ID Verification:Initialize

    Last Updated:Feb 21, 2024

    This topic describes how to use Initialize API to initialize the eKYC process.

    Interface description

    Interface name: Initialize.

    Service address: cloudauth-intl.cn-hongkong.aliyuncs.com.

    Request method: HTTPS POST.

    Interface description: Before each eKYC process, obtain the transactionId through this interface to connect the interfaces in the eKYC process request in series.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    ProductCode

    String

    Yes

    Product code of identity proofing. Set to eKYC in this mode.

    eKYC

    MerchantBizId

    String

    Yes

    A unique business ID for tracing purpose. For example, the sequence ID from the merchant's business-related database.

    Note

    The Alibaba Cloud server does not perform uniqueness check on the value of this field. For better tracking, it is strongly recommended to enable the merchant server to guarantee the uniqueness of the business ID.

    e0c34a77f5ac40a5aa5e6ed20c35****

    MetaInfo

    String

    Yes

    The meta information about the SDK and the user's device.

    When App SDK mode is used, its value comes from the Alibaba Cloud SDK in the JSON string format.

    Note

    Do not modify the returned value as it only needs to be passed through directly.

    {"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

    Yes

    Merchant user ID, or other identifiers that can be used to identify a specific user, for example, mobile phone number, email address and so on. It is strongly recommended to pre-desensitize the value of the userId field, for example, by hashing the value.

    123456789

    IdSpoof

    String

    No

    Whether to enable certificate anti-counterfeiting detection. The following values are supported:

    • Y: Indicates that anti-counterfeiting is turned on.

    • N: Indicates that anti-counterfeiting is turned off.

    By default, the value of N is used.

    Y

    DocType

    String

    Yes

    Certificate type, consisting of 8 digits.

    01000000

    Authorize

    String

    No

    Whether to enable the identity validation using authority databases. The following values are supported:

    • T: Indicates that it is turned on.

    • F: Indicates that it is turned off.

    By default, the value of F is used.

    Note

    Only applicable to China Resident Identity Card.

    F

    SecurityLevel

    String

    No

    Specifies the operation level for spoofing checks and face liveness detection. The following values are supported:

    • 01: Standard mode.

    • 02: Safe mode, relatively strict mode. You can use this operation mode in high-risk scenarios.

    By default, the value of '01' is used.

    01

    DocType List

    DocType

    CertType

    01000000

    Passport for all countries.

    00000006

    HKID 2003 version (Hong Kong Identity Card).

    00000008

    HKID 2018 version (Hong Kong Identity Card).

    00000007

    China Exit-Entry Permit for Travelling to and from Hong Kong and Macao.

    00000009

    China Mainland Travel Permit for Hong Kong and Macao Residents.

    000000011

    Macau Identity Card.

    000000012

    China Mainland Travel Permit for Taiwan Residents.

    00000001

    China Mainland 2nd-generation ID card.

    Response parameters

    Field name

    Data type

    Description

    Example

    HTTP Status Code

    Integer

    The HTTP status code.

    200

    HTTP Body

    RequestId

    String

    The unique ID of the request, which can be used to locate issues.

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

    Code

    String

    Return code. For the full list of codes, see Codes and Messages.

    Success

    Message

    String

    Response detailed message.

    Success

    Result.TransactionId

    String

    A unique transaction ID that is generated by the Alibaba Cloud server for the identity proofing process. This ID will be used as an input parameter for the ID Verification CheckResult API request.

    Note

    When an error occurs during the process, for example, invalid argument, no transaction ID is returned.

    hksb7ba1b28130d24e015d694361bee4

    Codes and Messages

    HTTP Status Code

    Code

    Message

    200

    Success

    The request has succeeded.

    400

    MissingParameter

    The parameter is missing.

    400

    InvalidParameter

    The parameter is invalid.

    403

    Forbidden.RAMUserAccessDenied

    Grant AliyunAntCloudAuthFullAccess permission to the RAM user. For more information, see Authorize a RAM user to access Real ID.

    403

    Forbidden.AccountAccessDenied

    The account is unauthorized, overdue, deactivated, or disabled.

    403

    Throttling.Api

    Request was denied due to api flow control.

    404

    ProcessNotCompleted

    The identity proofing process is not completed.

    500

    InternalError

    The error message returned because a temporary server error occurs. We recommend that you try again. If the error code persists, please submit a ticket for help.