VerifyByAsymmetricKey

Last updated: 2025-12-04 15:44:24

VerifyByAsymmetricKey

Last updated: 2025-12-04 15:44:24

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 Use Asymmetric Key for Signature Verification

Input Example

POST / HTTP/1.1
Host: kms.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: VerifyByAsymmetricKey
<Common request parameters>

{
    "KeyId": "d79e97e5-69d1-11ef-bc87-02ac442a5a1f",
    "SignatureValue": "MEUCIQDunw5PZuSVI6IPX2xxdce6ohrm9Rt8KBqpMr6yogDbdgIgVyqCOiOs9OVb/frwglpg+43QXMMRnFKmBd5VNpS4A/o=",
    "Message": "dGVzdAo=",
    "MessageType": "RAW",
    "Algorithm": "SM2DSA"
}

Output Example

{
    "Response": {
        "RequestId": "020b75ba-22f8-4f53-ab16-46ae5120711a",
        "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

Tencent Cloud CLI 3.0

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

Feedback

tencent cloud