Skip to content
qibdo qibdo
v1
API version
  • v1
Theme
Book a demo

Verify With Crypto Key

POST
/vault/v1/workspaces/{workspace}/engines/qibdo/cryptoKeys/{id}:verify
 
curl --request POST \
  --url https://example.com/vault/v1/workspaces/example/engines/qibdo/cryptoKeys/example:verify \
  --header 'Content-Type: application/json' \
  --data '{ "workspace": "example", "id": "example", "message": "example", "signature": "example", "signature_algorithm": "example", "prehashed": true }'

AIP-136 custom method. Verifies a signature against a message under a SIGN_VERIFY key. Returns valid=true iff the signature matches.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspace
required
string

The workspace the crypto key belongs to.

id
required
string

The unique identifier of the SIGN_VERIFY crypto key.

Request Body required

Section titled “Request Body required ”
Media type application/json

Request payload for Verify With Qibdo Crypto Key

Carries the input fields required to verify with qibdo crypto key.

object
workspace
required

The workspace the crypto key belongs to.

string
id
required

The unique identifier of the SIGN_VERIFY crypto key.

string
message
required

The message bytes that were signed (or its digest if prehashed=true).

string format: bytes
signature
required

The signature bytes to verify.

string format: bytes
signature_algorithm

Optional signature algorithm hint for RSA keys (e.g. “pss”, “pkcs1v15”).

string
prehashed

When true, treat message as a pre-computed digest.

boolean
Example generated
{
  "workspace": "example",
  "id": "example",
  "message": "example",
  "signature": "example",
  "signature_algorithm": "example",
  "prehashed": true
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

Response payload from Verify With Qibdo Crypto Key

Carries the output produced by verify with qibdo crypto key.

object
valid

True iff the signature is valid for the given message under the named key.

boolean
Example generated
{
  "valid": true
}

default

Section titled “default ”

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object
@type

The type of the serialized message.

string
key
additional properties
any
Example generated
{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}