VerifyByAsymmetricKey

Last updated: 2021-01-28 20:02:02

1. API Description

Domain name for API request: kms.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 parameter. The value used for this API: VerifyByAsymmetricKey.
Version Yes String Common parameter. The value used for this API: 2019-01-18.
Region Yes String Common parameter. 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 The original message or message abstract. For an original message, the length before Base64 encoding can contain up to 4,096 bytes. For a message abstract, the SM2 signature algorithm only supports 32-byte (before Base64 encoding) message abstracts.
Algorithm Yes String Signature algorithm. Supported algorithm: SM2DSA.
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.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Verifying a signature with an asymmetric key

Input Example

https://kms.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.

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.