---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Verify a key"
description: "`keys.keys.verify` (POST /v1/{name}:verify): Verifies a signature made by a SIGN key."
type: reference
product: platform
summary: "Verifies a signature made by a SIGN key."
updated: 2026-09-28
nav: false
---

> **This method is not served on the public API.** `api.sylphx.com` does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

Verifies a signature made by a SIGN key.

**Not available yet.** Sylphx Keys is declared in the registry but no backend serves it: every call answers `501` with the problem code `UNIMPLEMENTED`.

- **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](/docs/api/keys)

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | The key to use. Required. |
| `key_version` | `string` | The version to use; default the primary version; the signature names none. |
| `data` | `bytes` | The signed message. Set exactly one of `data` and `digest`. |
| `digest` | `bytes` | The digest of the signed message. |
| `signature` | `bytes` | The signature to check. Required. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `valid` | `bool` | The signature is valid. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`RESOURCE_NOT_FOUND`](/docs/api/errors/RESOURCE_NOT_FOUND) — The named Resource does not exist or is not visible.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.
- [`INVALID_STATE`](/docs/api/errors/INVALID_STATE) — The Resource is in a state that forbids the call.
- [`RATE_LIMITED`](/docs/api/errors/RATE_LIMITED) — The rate limit is reached; see Retry-After.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
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":"…"}'
```

**TypeScript**

```ts
const response = await sylphx.keys.keys.verify({ name: 'orgs/acme/projects/shop/envs/production/keys/key', signature: '…' })
```

**Rust**

```rust
let mut req = sylphx::keys::VerifyRequest::default();
req.name = "orgs/acme/projects/shop/envs/production/keys/key".to_string();
req.signature = "…".to_string();
let response = sx.keys().keys().verify(req).await?;
```

**CLI**

```bash
sylphx keys keys verify orgs/acme/projects/shop/envs/production/keys/key
```

**MCP**

```json
{ "method_id": "keys.keys.verify", "args": {"name":"orgs/acme/projects/shop/envs/production/keys/key","signature":"…"} }
```