产品动态
产品公告
Domain name for API request: faceid.intl.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 72 hours (72*3600s) 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. |
| SdkToken | Yes | String | The ID of the SDK-based selfie verification process, which is generated when the GetFaceIdTokenIntl API is called. |
| Parameter Name | Type | Description |
|---|---|---|
| Result | String | The return code of the verification result. 0: Success. 1001: Failed to call the liveness engine. 1002: Suspected spoofed recording. 1004: Face detection failed. 1005: Liveness detection failed. 1201: Lighting is too dark or overexposed. 2004: The image passed in is too large or too small. 2012: Multiple faces 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. 2017: Facial occlusion detected. -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.Used for verification, contains specific color reflection effects. |
| ActionVideo | String | Records the specific action performed by the user, used for AI Face Shield analysis. |
| 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 (selfie verification) mode.Note: The Similarity metric is exclusively valid for "compare" mode. In "liveness" mode, the returned Similarity value (0.0) is non-significant and should be ignored. |
| Extra | String | The pass-through parameter. Note: This field may return null, indicating that no valid values can be obtained. |
| DeviceInfoLevel | String | Describe the risk level of the device where the current request is located, with a total of 4 levels. The details are as follows: 1 - Secure 2 - Low Risk 3 - Medium Risk 4 - High Risk Empty - Risk level not obtained. Only returned for the Enhance and Plus version, with the default value being empty. |
| LivenessInfoTag | Array of String | Describes the detailed reason for the current liveness detection failure. Output only when SdkVersion is PLUS or PRO. Details are as follows: 01 - User kept eyes closed throughout the process. 02 - User failed to complete the specified action. 03 - Suspected photo replay attack. 04 - Suspected synthetic image. 05 - Suspected synthetic video. 06 - Suspected synthetic action. 07 - Suspected fraud template. 08 - Suspected watermark existence. 09 - Light verification failed. 10 - Face verification failed. 11 - Poor face quality. 12 - Unqualified collection quality. 13 - Suspected adversarial sample attack. |
| 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. |
POST / HTTP/1.1
Host: faceid.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetFaceIdResultIntl
<Common Request Parameters>
{
"SdkToken": "FA05EE15-53114-0143A5-AFCA-24F0338535B2"
}
{
"Response": {
"ActionVideo": "/9j/4AAQSkZJRg.....s97n//2Q==",
"BestFrame": "/9j/4AAQSkZJRg.....s97n//2Q==",
"Description": "Success",
"DeviceInfoLevel": "",
"Extra": "",
"LivenessInfoTag": null,
"RequestId": "7680b762-d1d3-4dd3-90e8-5d1c0030116b",
"Result": "0",
"Similarity": 0,
"Video": "/9j/4AAQSkZJRg.....s97n//2Q=="
}
}
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. |
文档反馈