Release Notes
Product Announcements
Domain name for API request: faceid.intl.tencentcloudapi.com.
This API is used to apply for an SDK token before calling the selfie verification SDK each time. The SDK token is used throughout the eKYC process and to get the verification result after the verification is completed. A token is valid for one eKYC process only.
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: GetFaceIdTokenIntl. |
| 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. |
| CheckMode | No | String | The detection mode. Valid values:liveness: Liveness detection only.compare: Selfie Verification(liveness detection and face comparison).Default value: liveness. |
| SecureLevel | No | String | The verification security level. Valid values:1: Video-based liveness detection.2: Motion-based liveness detection.3: Reflection-based liveness detection.4: Motion- and reflection-based liveness detection.Default value: 4. |
| Image | No | String | The photo (in Base64) to compare. This parameter is required when the value of CheckMode is compare. |
| Extra | No | String | The pass-through parameter, which can be omitted if there are no special requirements. |
| ActionList | No | String | This interface is used to control th action sequences. Action types are as follows: "blink" "mouth" "nod" "shake" You can choose 1-2 actions out of the four. Single action example: "blink" Multiple action example: "blink,mouth" The default value is blink. The different action types passed in this parameter take effect only when the SecurityLevel is 2 or 4; otherwise, the interface reports an error. |
| SdkVersion | No | String | BASIC: Basic version (Default). ENHANCE: Enhance version, enable additional output of device risk level field. PRO: Pro version, enable additional output of attack type fields. PLUS: Plus version, enable additional output of device risk level and attack type fields. Please contact us to access enhance version & plus version. |
| Parameter Name | Type | Description |
|---|---|---|
| SdkToken | String | The SDK token, which is used throughout the verification process and to get the verification result. |
| 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 apply for an SDK-based verification token.
POST / HTTP/1.1
Host: faceid.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetFaceIdTokenIntl
<Common request parameters>
{
"CheckMode": "liveness",
"SecureLevel": "4",
"Extra": "idxxxx"
}
{
"Response": {
"RequestId": "c27f8a53-1766-4d62-84fc-c400843e9e21",
"SdkToken": "91BF5AD0-C5C9-41CC-9562-DB35BBA2712D"
}
}
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 |
|---|---|
| FailedOperation.ImageSizeTooLarge | The image is too large. |
| InternalError | Internal error. |
| InvalidParameter | Invalid parameter. |
피드백