All Products
Search

This Product

    ID Verification:eKYC_Date_MIN

    Document Center

    ID Verification:eKYC_Date_MIN

    Last Updated:Sep 09, 2025

    This topic describes how to integrate with the Id2MetaPeriodVerifyIntl API operation of ID Verification using a server-side approach.

    API description

    • API operation: Id2MetaPeriodVerifyIntl

    • Request method: HTTPS POST

    • Description: This operation verifies the authenticity and consistency of a name, ID card number, and the start and end dates of the ID card's validity period against an authoritative source.

      Important

      Only second-generation resident ID cards from the Chinese mainland are supported.

    • QPS limit: The API has a dedicated queries per second (QPS) limit. For more information, see QPS limits for ID Verification server-side API operations.

    • Endpoint:

      Note

      The internal network is used for communication between Alibaba Cloud products in the same region. If your server is deployed in an Alibaba Cloud region, you can use the internal endpoint to access the ID Verification service. This provides more secure and stable network communication.

      China (Hong Kong)

      • Internet: cloudauth-intl.cn-hongkong.aliyuncs.com

      • Internal: cloudauth-intl-vpc.cn-hongkong.aliyuncs.com

    Online debugging and integration

    Note

    Before you start debugging and integration, ensure that you read the Use OpenAPI Explorer to debug and integrate server-side APIs document to understand how to call APIs in OpenAPI Explorer and obtain SDKs and their code.

    You can use OpenAPI Explorer to run and debug this API operation, and generate an SDK code sample.

    Request parameters

    Name

    Type

    Required

    Description

    Example

    ProductCode

    String

    Yes

    The product solution to integrate. Set the value to eKYC_Date_MIN.

    eKYC_Date_MIN

    SceneCode

    String

    No

    A custom authentication scenario ID. You can use this ID to query related records in the console. The ID can be up to 10 characters in length and can contain letters, digits, and underscores (_).

    1234567890

    MerchantBizId

    String

    Yes

    A unique business identifier that you can customize. Use this identifier to locate and troubleshoot issues. The identifier can be up to 32 characters in length and can contain letters and digits. Make sure that the identifier is unique.

    e0c34a77f5ac40a5aa5e6ed20c35****

    MerchantUserId

    String

    No

    A custom user ID or another identifier for a specific user, such as a mobile number or email address. Desensitize the value of this field in advance, for example, by hashing the value.

    a1b2c3d4e5f64g7h8i9j0k1l2m3n4****

    DocType

    String

    Yes

    The certificate type, which is uniquely identified by an 8-digit number.

    Currently, only second-generation resident ID cards from the Chinese mainland are supported. Set the value to the static field: 00000001.

    For more information, see Certificate types.

    00000001

    DocName

    String

    Yes

    The user's name.

    John Doe

    DocNo

    String

    Yes

    The user's certificate number.

    411xxxxxxxxxxx0001

    ValidityStartDate

    String

    Yes

    The start date of the validity period. The format is YYYYMMDD.

    20201001

    ValidityEndDate

    String

    Yes

    The expiration date of the ID card's validity period. The format is YYYYMMDD.

    Note

    If the ID card is valid for a long term, enter long-term for this parameter.

    20301001

    Response data

    Name

    Type

    Description

    Example

    HTTP Status Code

    Integer

    The HTTP status code.

    200

    HTTP Body

    RequestId

    String

    The request ID.

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

    Code

    String

    Return to Code.

    success

    Message

    String

    A detailed description of the response code.

    success

    Result.Passed

    String

    The final authentication result. Valid values:

    • Yes, via

    • N: The authentication is not passed.

    Y

    Result.SubCode

    String

    A description of the authentication result. For more information, see ResultObject.SubCode error codes.

    200

    Status codes

    HTTP status code

    Code

    Message description

    200

    Success

    Request successful.

    400

    MissingParameter

    Parameter cannot be empty.

    InvalidParameter

    Invalid parameter.

    403

    Forbidden.RAMUserAccessDenied

    You need to grant the RAM user the AliyunAntCloudAuthFullAccess permission. For more information, see Authorize RAM users to access the service.

    Forbidden.AccountAccessDenied

    Ensure that you have activated ID verification and your account has no overdue payment.

    Throttling.Api

    API request is blocked due to throttling.

    500

    InternalError

    Internal system error. Provide feedback to engineers for troubleshooting.

    ResultObject.SubCode error codes

    Error code

    Billed

    Description and suggestion

    200

    Yes

    The information is consistent. The authentication is passed.

    202

    Yes

    The identity information cannot be found in the official database.

    The user's information may be incorrect or fraudulent. Ask the user to confirm the information and try again.

    If the user's information is confirmed to be correct, provide an entry for manual review.

    223

    Yes

    The name and ID card number do not match, or the start and end dates of the ID card's validity period do not match the information in the official database.

    The user's information may be incorrect or fraudulent. Ask the user to confirm the information and try again.