tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

GetFaceIdTokenIntl

Last updated: 2024-04-03 11:45:38

    1. API Description

    Domain name for API request: faceid.tencentcloudapi.com.

    This API is used to apply for an SDK token before calling the liveness detection and face comparison SDK each time. The SDK token is used throughout the identity verification process and to get the verification result after the verification is completed. A token is valid for one identity verification process only.

    A maximum of 20 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common Params. The value used for this API: GetFaceIdTokenIntl.
    Version Yes String Common Params. The value used for this API: 2018-03-01.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-hongkong, ap-jakarta, ap-singapore.
    CheckMode No String The detection mode. Valid values:
    liveness: Liveness detection only.
    compare: Liveness detection and face comparison.
    Default value: liveness.
    SecureLevel No String The verification security level. Valid values:
    1: Video-based liveness detection.
    2: Motion-based liveness detection.
    3: Reflection-based liveness detection.
    4: Motion- and reflection-based liveness detection.
    Default value: 4.
    Image No String The photo (in Base64) to compare. This parameter is required when the value of CheckMode is compare.
    Extra No String The pass-through parameter, which can be omitted if there are no special requirements.

    3. Output Parameters

    Parameter Name Type Description
    SdkToken String The SDK token, which is used throughout the verification process and to get the verification result.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Applying for a token

    This example shows you how to apply for an SDK-based verification token.

    Input Example

    POST / HTTP/1.1
Host: faceid.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetFaceIdTokenIntl
<Common request parameters>

{
    "CheckMode": "liveness",
    "SecureLevel": "4",
    "Extra": "idxxxx"
}

    Output Example

    {
    "Response": {
        "RequestId": "c27f8a53-1766-4d62-84fc-c400843e9e21",
        "SdkToken": "91BF5AD0-C5C9-41CC-9562-DB35BBA2712D"
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation.ImageSizeTooLarge The image is too large.
    InternalError Internal error.
    InvalidParameter Invalid parameter.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy