tencent cloud

APIs

GetWebVerificationResultIntl

Unduh
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-09-18 10:21:56

1. API Description

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

After completing the Web verification process, call this API with the verification token (BizToken) to query the verification result info. The BizToken is valid within three days (259,200 seconds) after application 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: GetWebVerificationResultIntl.
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.
BizToken Yes String

Web authentication token, generated by the ApplyWebVerificationBizTokenIntl API.

3. Output Parameters

Parameter Name Type Description
ErrorCode Integer

Final result of this process. 0 indicates successful verification, determined to be the same person.
For other error codes, see: Liveness Detection and Face Comparison (Mobile HTML5) Error Codes

ErrorMsg String

Final result description of this process.

VerificationDetailList Array of VerificationDetail

List of detailed verification results for this process. Since it is retryable, this process may contain multiple verification information.

VideoBase64 String

base64-encoded string of the video content collected from the video stream. Since it is retryable, this field returns the data collected in the last verification. If no video is collected, it returns null.

BestFrameBase64 String

base64 encoded string of the best face photo collected from the video stream. Since it is retryable, this field returns the data collected in the last verification. If no best face photo is collected, null is returned.

OCRResult Array of OCRResult

License recognition result

Extra String

Service pass-through parameter.

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 Obtaining Web verification service result information

Input Example

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

{
    "BizToken": "4A7E7CE1-834C-4016-84DB-23823024233F"
}

Output Example

{
    "Response": {
        "BestFrameBase64": "/9j/4AAQSkZJRgABAQAAA**",
        "ErrorCode": 0,
        "ErrorMsg": "Success, tap next to continue",
        "Extra": null,
        "OCRResult": null,
        "RequestId": "e7ad0f19-0c3e-402f-9fb0-720dd7ed0d99",
        "VerificationDetailList": [
            {
                "CompareErrorCode": null,
                "CompareErrorMsg": null,
                "ErrorCode": 0,
                "ErrorMsg": "Success, tap next to continue",
                "LivenessErrorCode": 0,
                "LivenessErrorMsg": "Success, tap next to continue",
                "LivenessInfoTag": null,
                "ReqTimestamp": 1789473304325,
                "Seq": "11a370d4-9a16-49c8-b1bb-74ad89ac6965",
                "Similarity": 0
            }
        ],
        "VideoBase64": "AAAAIGZ0eXBpc29tAAACAG**"
    }
}

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 Parameter error.
InvalidParameterValue Parameter value error.
InvalidParameterValue.BizTokenExpired BizToken expired.
InvalidParameterValue.BizTokenIllegal BizToken is invalid.
OperationDenied Operation denied.

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan