tencent cloud

All product documents
eKYC
DocumentationeKYCAPI DocumentationOther APIsGetLivenessResult
GetLivenessResult
Download PDF
Last updated: 2024-04-03 11:45:33
GetLivenessResult
Last updated: 2024-04-03 11:45:33
Download PDF

1. API Description

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

This API is used to get the verification result with the corresponding token (SdkToken) after the liveness detection is completed. The token is valid for two hours after issuance and can be called multiple times.

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: GetLivenessResult.
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.
SdkToken Yes String The token used to identify an SDK-based verification process.

3. Output Parameters

Parameter Name Type Description
Result String The final verification result.
Description String The description of the final verification result.
BestFrame FileInfo The face screenshot.
Video FileInfo The video for the detection.
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 Getting the verification result

Input Example

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

{
    "SdkToken": "D2B55F0C-FB5D-4FB6-8765-3E931EBBFC79"
}

Output Example

{
    "Response": {
        "Video": {
            "Url": "https://intl-reflect-h5-1257237511.cos.ap-guangzhou.myqcloud.com",
            "MD5": "682e24b207acf1825286c1fceef5631c",
            "Size": 9430792
        },
        "BestFrame": {
            "Url": "https://intl-reflect-h5-1257237511.cos.ap-guangzhou.myqcloud.com",
            "MD5": "667c2448b10b09ee9ec14ab2b0d36608",
            "Size": 232267
        },
        "Description": "Failed to call the liveness engine",
        "RequestId": "b8cb2269-08b2-426c-8be8-c7142c7e64e4",
        "Result": "1001"
    }
}

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
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue.BizTokenExpired BizToken expired.
InvalidParameterValue.BizTokenIllegal Invalid BizToken.
OperationDenied Operation denied.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon