该页面目前只支持英文，你浏览的语言正在准备中。
关闭
人脸核身
- 接入文档
- 活体人脸比对（纯 API）接入指引
- 活体人脸比对 (移动端H5) 接入指引
- 活体人脸比对 (App SDK) 接入指引
- SDK接口API概述
- SDK自定义能力说明
- Identity verification（移动端 H5）接入指引
- Identity Verification(App SDK) 接入指引
- API 文档
- Making API Requests
- Selfie Verification (App SDK) APIs
- eKYC (Mobile HTML5) APIs
- eKYC (App SDK) APIs
- Selfie Verification (Pure API) APIs
- AI Face Shield (Pure API) APIs
- ID Verification (Pure API) APIs
GetFaceIdResultIntl
最后更新时间：2025-01-14 18:59:08
1. API Description
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 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.
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: 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. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Result | String | The return code of the verification result. 0: Succeeded. 1001: System error. 1004: Selfie verification 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 (selfie verification) 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. |
4. Example
Example1 Getting the verification result
This example shows you how to get the verification result.
Input Example
POST / HTTP/1.1
Host: faceid.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetFaceIdResultIntl
<Common request parameters>
{
"SdkToken": "aeee6d62-b2b2-4634-9662-919a5ac729ab"
}
Output Example
{
"Response": {
"Result": "0",
"Description": "Success",
"BestFrame": "AAAAHGZ0eXBtcDQyAAAAAWlzb2...",
"Video": "/9j/4AAQSkZJRgABAQAASABIAAD/4QBMR...",
"Similarity": 98.8,
"Extra": "abc",
"RequestId": "aea12d62-b2b2-4634-9662-919a5ac729ab"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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. |