ApplyWebVerificationBizTokenIntl

下载PDF

最后更新时间：2025-12-02 20:57:02

ApplyWebVerificationBizTokenIntl

最后更新时间： 2025-12-02 20:57:02

下载PDF

1. API Description

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

This API is used to obtain a BizToken before each call to the Web verification service. Save the BizToken to initiate the verification process and retrieve the result upon completion. The BizToken is valid for 10 minutes.

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: ApplyWebVerificationBizTokenIntl.
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-bangkok, ap-hongkong, ap-jakarta, ap-singapore, sa-saopaulo.
RedirectURL	Yes	String	The web callback URL to redirect to after the verification is completed, including the protocol, hostname, and path. After the verification process is completed, the BizToken of this process will be spliced to the callback URL in the format of https://www.tencentcloud.com/products/faceid?token={BizToken} before redirect. Example: https://www.tencentcloud.com/products/faceid.
CompareImageBase64	No	String	The Base64-encoded string (max 8 MB in size) of the photo to be compared.The Data URI scheme header needs to be removed from the encoded string Example: xhBQAAACBjSFJNAAB6****AAAASUVORK5CYII=
Extra	No	String	The passthrough parameter of the business, max 1,000 characters, which will be returned in GetWebVerificationResultIntl.
RuleId	No	String	The business process ID generated by the console.
Config	No	WebVerificationConfigIntl	The parameter control the page configuration. Example: {"AutoSkip": true,"CheckMode": 1,"IdCardType": "HKIDCard"}

3. Output Parameters

Parameter Name	Type	Description
BizToken	String	A token that identifies a Web verification process, with a validity time of 10 minutes. after the process is complete, the token can be used to obtain the verification result.
VerificationURL	String	The verification URL to be opened with a browser to start the verification process. Example: https://intl.faceid.qq.com/reflect/?token=81EEF678-28EE-4759-A82E-6CBBBE6BC442
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 Apply Web Verification BizToken

Apply Web Verification BizToken

Input Example

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

{
    "CompareImageBase64": "xhBQAAACBjSFJNAAB6****AAAASUVORK5CYII=",
    "RedirectURL": "https://www.tencentcloud.com/products/faceid",
    "Extra": "ExtraString"
}

Output Example

{
    "Response": {
        "VerificationURL": "https://intl.faceid.qq.com/reflect/?token=81EEF678-28EE-4759-A82E-6CBBBE6BC442",
        "BizToken": "81EEF678-28EE-4759-A82E-6CBBBE6BC442",
        "RequestId": "b16194cd-8f52-4e66-882a-eb6bf15c016d"
    }
}

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

Tencent Cloud CLI 3.0

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	Incorrect parameter value.
UnauthorizedOperation.ActivateError	Service activation exception.
UnauthorizedOperation.Activating	Activating the service.
UnauthorizedOperation.Arrears	The account is in arrears.
UnauthorizedOperation.Nonactivated	The service has not been activated.

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

是

否

文档反馈

tencent cloud