---
title: "Reveal a screen's recovery code"
method: POST
path: "/v1/screens/{id}/kiosk-recovery/reveal"
tags: ["screens"]
---

# Reveal a screen's recovery code

`POST /v1/screens/{id}/kiosk-recovery/reveal`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/screens/{id}/kiosk-recovery/reveal`
- Auth: HTTP bearer

Reveal the offline recovery code for a screen with Screen Lock enabled. This action is recorded in the activity log.

## Path parameters

- `id` string, required

## Response `200`

Success.

- object
  - `data` object, required
    - `code` string, required: The Screen Lock recovery code. Each reveal is recorded in the audit log.

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `404`: No screen with this id, or it has no recovery code.
- `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)