NMnmi
Devices

Prompt Device for Signature

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

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

Path parameters

device_idstring required

The device ID to prompt.

Request body

headerstring required

Header message to display on the device

Response

Success

object'request' required

Resource type identifier

idstring required

Prompt request ID (reference)

status'in_progress' | 'completed' | 'cancelled' | 'cancelledAtTerminal' | 'cancelledByApi' | 'cancelledByTimeout' | 'poiDeviceInUse' | 'poiDeviceDisconnected' | 'terminatedBadCardRead' required

Status of the prompt request

resultstring

The result of the prompt (e.g., 'yes', 'no', or selected menu option). Only present when status is 'completed'.

signaturestring

Base64-encoded signature image. Only present for sign prompts when status is 'completed'.

signature_formatstring

Format of the signature image (e.g., 'png'). Only present for sign prompts when status is 'completed'.

Changes

No recorded changes to this operation across all 1 revision of this API.