Key Management Service
- Product Introduction
- Purchase Guide
- Console Guide
- Key Management
- TCCLI Management Guide
- Practical Tutorial
- Symmetrical Encryption and Decryption
- Encrypting/Decrypting Sensitive Data
- Envelope Encryption/Decryption
- Asymmetric Encryption and Decryption
- Asymmetric Signature Verification
- Importing External Key
- API documentation
- Making API Requests
- Key APIs
- Asymmetric Key APIs
VerifyByAsymmetricKey
Last updated: 2025-04-23 14:30:22
1. API Description
Domain name for API request: kms.intl.tencentcloudapi.com.
This API is used to verify a signature with an asymmetric key.
A maximum of 100 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: VerifyByAsymmetricKey. |
| Version | Yes | String | Common Params. The value used for this API: 2019-01-18. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| KeyId | Yes | String | Unique ID of a key |
| SignatureValue | Yes | String | Signature value, which is generated by calling the KMS signature API. |
| Message | Yes | String | Full message or message abstract. Before Base64 encoding, an original message can contain up to 4,096 bytes while a message abstract must be 32 bytes. |
| Algorithm | Yes | String | Signature algorithm. The valid values include SM2DSA, ECC_P256_R1, RSA_PSS_SHA_256, and RSA_PKCS1_SHA_256, etc. You can get a full list of supported algorithms using the ListAlgorithms API. |
| MessageType | No | String | Message type. Valid values: RAW (indicating an original message; used by default if the parameter is not passed in) and DIGEST. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| SignatureValid | Boolean | Whether the signature is valid. true: the signature is valid; false: the signature is invalid. |
| 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 Verifying a signature with an asymmetric key
Input Example
https://kms.intl.tencentcloudapi.com/?Action=VerifyByAsymmetricKey
&Algorithm=SM2DSA
&Message=Zsfw9GLu7dnR8tRr3BDk4kFnxIdc8veiKX2gK49LqOA%3D
&KeyId=6cdf26d1-44ff-11eb-841c-5254006d0810
&MessageType=DIGEST
&SignatureValue=MEUCIQDeO1wB%2F5dEfprulvh9Zw06UJylDt9R8MQY5qRMjzhXJgIgPKO2kKicFKemwOft8SgniUA692ORrqVEabS3kcbPL8U%3D
&<Common request parameters>
Output Example
{
"Response": {
"RequestId": "3e634985-c311-4790-953a-44990f7bec6b",
"SignatureValid": true
}
}
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 | Incorrect parameter value. |
| InvalidParameterValue.InvalidKeyId | Invalid KeyId. |
| ResourceUnavailable.CmkNotFound | The CMK does not exist. |
| ResourceUnavailable.CmkStateNotSupport | This operation cannot be performed under the current CMK status. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No