NMnmi
Devices

Get Signature Prompt Status

Retrieve the status of a signature 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/sign).

get/v5/devices/{device_id}/prompt/sign/{reference}

Request

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

Path parameters

device_idstring required

The unique identifier of the cloud device

referencestring required

The unique identifier of the prompt request, obtained from the initial prompt request response

Response

Prompt request status retrieved successfully

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.