---
updatedAt: 2026-04-24T21:14:24.000Z
agentTools:
  projectIndex: https://docs.clover.com/dev/llms.txt
---

# Get a user confirmation response

Retrieves a confirmation response (`true` or `false`) from the specified Clover terminal. This is typically used to ask a customer a yes-no question.

# OpenAPI definition

```json
{
  "components": {
    "parameters": {
      "DeviceId": {
        "description": "The Clover device to route the request to.",
        "in": "header",
        "name": "X-Clover-Device-Id",
        "required": true,
        "schema": {
          "type": "string"
        }
      },
      "IdempotencyKeyOptional": {
        "description": "The idempotency key transmitted during the request, if any.",
        "in": "header",
        "name": "Idempotency-Key",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      "PosId": {
        "description": "An identifier for the POS making the request.",
        "in": "header",
        "name": "X-POS-Id",
        "required": true,
        "schema": {
          "type": "string"
        }
      },
      "Timeout": {
        "description": "The amount of time, in seconds, that this operation will process before timing out. A value of 0 indicates no timeout will be enforced by Remote Pay, although protocol specified timeouts may still apply.",
        "in": "header",
        "name": "X-Clover-Timeout",
        "required": false,
        "schema": {
          "maximum": 300,
          "minimum": 0,
          "type": "integer"
        }
      },
      "UserAgentHeader": {
        "name": "User-Agent",
        "in": "header",
        "description": "Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: `<AppName>/<Version> <Comment>`",
        "required": true,
        "schema": {
          "type": "string"
        },
        "example": "PostmanRuntime/7.44.1"
      }
    },
    "responses": {
      "209": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        },
        "description": "Operation was canceled."
      },
      "400": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        },
        "description": "The request is invalid, and subsequent calls will continue to fail; do not repeat the call."
      },
      "401": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        },
        "description": "An invalid bearer token has been provided. The call may be repeated if the provided bearer token is updated."
      },
      "415": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        },
        "description": "The request is invalid, and contains request data in an unsupported format. This call may be repeated if the content is changed to a supported format."
      },
      "500": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        },
        "description": "The request processing failed with an unknown error, and the processing state of the operation is indeterminate. Do not repeat the call without additional analysis."
      },
      "501": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        },
        "description": "The device does not have the ability to respond to the requested operation; do not repeat the call."
      },
      "503": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        },
        "description": "The device is not available because it is currently servicing another call. This can be repeated at a later time, or cancel may be called to end the current operation."
      },
      "504": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        },
        "description": "The Device did not respond in a timely manner. This can be repeated at a later time."
      }
    },
    "schemas": {
      "BooleanResponse": {
        "description": "A true/false response",
        "example": {
          "response": true
        },
        "properties": {
          "response": {
            "type": "boolean"
          }
        },
        "title": "BooleanResponse",
        "type": "object"
      },
      "ConfirmationRequest": {
        "description": "Used when calling a device endpoint that needs to solicit confirmation from the user.",
        "example": {
          "acceptText": "Yes",
          "rejectText": "No",
          "text": "Would you like to continue?"
        },
        "properties": {
          "acceptText": {
            "description": "Label text displayed on the button for positive confirmation",
            "type": "string"
          },
          "beep": {
            "description": "A true/false flag that indicates if a beep should be played when the screen is initially displayed.",
            "type": "boolean"
          },
          "rejectText": {
            "description": "Label text displayed on the button for negative confirmation",
            "type": "string"
          },
          "text": {
            "type": "string"
          }
        },
        "required": [
          "text"
        ],
        "title": "ConfirmationRequest",
        "type": "object"
      },
      "ErrorResponse": {
        "description": "An error object",
        "properties": {
          "code": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "requestId": {
            "type": "string"
          },
          "requestType": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "message",
          "type"
        ],
        "title": "ErrorResponse",
        "type": "object"
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "info": {
    "title": "Clover Card Present REST API",
    "version": "4.1.0",
    "x-clover-timeout": 120,
    "x-clover-timeout-wait": 5
  },
  "openapi": "3.0.1",
  "paths": {
    "/v1/device/read-confirmation": {
      "post": {
        "description": "Retrieves a confirmation response (`true` or `false`) from the specified Clover terminal. This is typically used to ask a customer a yes-no question.",
        "operationId": "READ_CONFIRMATION",
        "parameters": [
          {
            "$ref": "#/components/parameters/UserAgentHeader"
          },
          {
            "$ref": "#/components/parameters/DeviceId"
          },
          {
            "$ref": "#/components/parameters/PosId"
          },
          {
            "$ref": "#/components/parameters/Timeout"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKeyOptional"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ConfirmationRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BooleanResponse"
                }
              }
            },
            "description": "Returns a true or false response based on user input"
          },
          "209": {
            "$ref": "#/components/responses/209"
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "415": {
            "$ref": "#/components/responses/415"
          },
          "500": {
            "$ref": "#/components/responses/500"
          },
          "501": {
            "$ref": "#/components/responses/501"
          },
          "503": {
            "$ref": "#/components/responses/503"
          },
          "504": {
            "$ref": "#/components/responses/504"
          }
        },
        "summary": "Get a user confirmation response",
        "tags": [
          "DEVICE"
        ],
        "x-clover-operation-type": "FOREGROUND"
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "servers": [
    {
      "description": "Secure URL for requests to REST Pay Display (local network)",
      "url": "https://deviceIpOrHost:12346/connect"
    },
    {
      "description": "Secure URL for requests to Cloud Pay Display (web-based POS systems)",
      "url": "https://apisandbox.dev.clover.com/connect"
    }
  ],
  "tags": [
    {
      "name": "DEVICE"
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```