Skip to content
Console
On this page

Verify a key

Verifies a signature made by a SIGN key.

Verifies a signature made by a SIGN key.

  • Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/keys/key:verify
  • Scope keys:verify
  • Effect read — nothing is written.
  • Collection keys

Request

FieldTypeWhat it is
namestringThe key to use. Required.
key_versionstringThe version to use; default the primary version; the signature names none.
databytesThe signed message. Set exactly one of data and digest.
digestbytesThe digest of the signed message.
signaturebytesThe signature to check. Required.

Response

FieldTypeWhat it is
validboolThe signature is valid.

Errors

Every error arrives in the body Errors describes.

Examples

curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/keys/key:verify" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"signature":"…"}'