---
title: "Get Menu Prompt Status"
method: GET
path: "/v5/devices/{device_id}/prompt/menu/{reference}"
tags: ["Devices"]
---

# Get Menu Prompt Status

`GET /v5/devices/{device_id}/prompt/menu/{reference}`

Retrieve the status of a menu selection prompt request initiated on a cloud device. The reference is obtained from the initial prompt request response (e.g., from POST /api/v5/devices/{deviceId}/prompt/menu).

## Path parameters

- `device_id` string, required
- `reference` string, required

## Response `200`

Prompt request status retrieved successfully

- PromptRequestStatusResponse — Prompt request status response matching the structure returned by GET /api/v5/devices/{deviceId}/prompt/{type}/{reference}
  - `object` 'request', required — Resource type identifier
  - `id` string, required — Prompt request ID (reference)
  - `status` 'in_progress' | 'completed' | 'cancelled' | 'cancelledAtTerminal' | 'cancelledByApi' | 'cancelledByTimeout' | 'poiDeviceInUse' | 'poiDeviceDisconnected' | 'terminatedBadCardRead', required — Status of the prompt request
  - `result` string — The result of the prompt (e.g., 'yes', 'no', or selected menu option). Only present when status is 'completed'.
  - `signature` string — Base64-encoded signature image. Only present for sign prompts when status is 'completed'.
  - `signature_format` string — Format of the signature image (e.g., 'png'). Only present for sign prompts when status is 'completed'.

## Other responses

- `400` — Bad Request - The request was malformed or contained invalid parameters
- `401` — Unauthorized - Authentication credentials were missing or invalid
- `404` — Not Found - The requested resource could not be found
- `500` — Internal Server Error - An unexpected error occurred on the server

---

[API](https://skmtc.net/nmi/apis/embedded-components-api.md) · [All operations](https://skmtc.net/nmi/apis/embedded-components-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nmi/embedded-components-api/versions/45c2ecda3685/schema)