---
title: "Verify encryption key"
method: POST
path: "/v1/account/encryption-key/verify"
tags: ["account"]
---

# Verify encryption key

`POST /v1/account/encryption-key/verify`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/account/encryption-key/verify`
- Auth: HTTP bearer

Performs a dry run against the workspace's own encryption key: it wraps and unwraps a random test value to confirm the key still works. Nothing is stored or changed.

## Request body

- object
  - `tenantId` string, required: Your Microsoft Entra tenant id (a UUID).
  - `keyId` string, required: `https://<vault>.vault.azure.net/keys/<name>/<version>`.

## Response `200`

Success.

- object
  - `data` object, required
    - `ok` true, required

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: You do not hold the permission for the whole workspace (a grant at one location is not enough).
- `409`: `key_check_failed`: the vault refused (`kind` says why).
- `422`: Bad `tenantId` or `keyId`.
- `503`: `not_available` on this platform.
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)
