Domain name for API request: faceid.tencentcloudapi.com.
This API is used to get the verification result with the corresponding SDK token after the identity verification process is completed. The SDK token is valid for two hours (2*3,600s) after generation and can be called multiple times.
A maximum of 20 requests can be initiated per second for this API.
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: GetFaceIdResultIntl. |
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 ID of the SDK-based liveness detection and face comparison process, which is generated when the GetFaceIdTokenIntl API is called. |
Parameter Name | Type | Description |
---|---|---|
Result | String | The return code of the verification result. 0: Succeeded. 1001: System error. 1004: Liveness detection and face comparison failed. 2004: The image passed in is too large or too small. 2012: Several faces were detected. 2013: No face was detected, or the face detected was incomplete. 2014: The image resolution is too low or the quality does not meet the requirements. 2015: Face comparison failed. 2016: The similarity did not reach the standard passing threshold. -999: The verification process wasn't finished. |
Description | String | The description of the verification result. |
BestFrame | String | The best frame screenshot (in Base64) obtained during the verification. |
Video | String | The video file (Base64) for verification. |
Similarity | Float | The similarity, with a value range of 0-100. A greater value indicates higher similarity. This parameter is returned only in the compare (liveness detection and face comparison) mode.Note: This field may return null , indicating that no valid values can be obtained. |
Extra | String | The pass-through parameter. Note: This field may return null, indicating that no valid values can be obtained. |
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. |
This example shows you how to get the verification result.
POST / HTTP/1.1
Host: faceid.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetFaceIdResultIntl
<Common request parameters>
{
"SdkToken": "aeee6d62-b2b2-4634-9662-919a5ac729ab"
}
{
"Response": {
"Result": "0",
"Description": "Success",
"BestFrame": "AAAAHGZ0eXBtcDQyAAAAAWlzb2...",
"Video": "/9j/4AAQSkZJRgABAQAASABIAAD/4QBMR...",
"Similarity": 98.8,
"Extra": "abc",
"RequestId": "aea12d62-b2b2-4634-9662-919a5ac729ab"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
本页内容是否解决了您的问题?