---
title: "Prompt Device for Signature"
method: POST
path: "/v5/devices/{device_id}/prompt/sign"
tags: ["Devices"]
---

# Prompt Device for Signature

`POST /v5/devices/{device_id}/prompt/sign`

## Request

- Base URL: `https://sandbox.nmi.com/api`
- URL: `https://sandbox.nmi.com/api/v5/devices/{device_id}/prompt/sign`
- Auth: API key in header `Authorization`

Prompt a cloud device to request a signature from the user.

## Path parameters

- `device_id` string, required

## Request body

- object
  - `header` string, required: Header message to display on the device

## Response `200`

Success

- 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
- `401`: Unauthorized
- `404`: Device not found

---

[API](https://skmtc.dev/nmi/apis/payments-api.md) - [All operations](https://skmtc.dev/nmi/apis/payments-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nmi/apis/payments-api/revisions/c03727f27e27?raw)