> ## Documentation Index
> Fetch the complete documentation index at: https://signatureapi-daf4ee54.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Checkbox Place

> Add checkbox fields to documents for recipients to check during signing ceremonies

A **checkbox place** marks a specific location in a document where a recipient checks or unchecks a box during the signing ceremony.

<Note>Checkbox places are only available in envelopes with sequential signing.</Note>

You can position checkbox places using either [placeholders](/docs/api/resources/places/positioning/#placeholders) or [fixed positions](/docs/api/resources/places/positioning/#fixed-positions).

## Symbol

The `symbol` property controls what mark is shown when the box is checked. Use `check` for a checkmark (default) or `xmark` for an X.

## Requirement

Set `requirement` to `required` to force the recipient to check the box before completing their action. Set it to `optional` to allow the recipient to skip it.

## Capturing Input

Set `capture_as` to store whether the box was checked in the envelope's `captures` object. After the envelope is completed, retrieve the value using the key you specified.

## Size

The `height` property sets the height of the checkbox in points (1/72 inch). The width equals the height. Must be between 8 and 40. Defaults to 20.

## Attributes

<ParamField body="type" type="enum" required={true}>
  Specifies the type of place.

  For a checkbox place, the value must be `checkbox`.
</ParamField>

<ParamField body="key" type="string" required={true}>
  A unique identifier for this place within the document. Use this key to match the place to its position, either through a `[[place_key]]` placeholder in the document or an entry in `fixed_positions`.

  Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters.
</ParamField>

<ParamField body="recipient_key" type="string" required={true}>
  The key of the recipient assigned to this place. Must match one of the `key` values in the envelope's `recipients` array.
</ParamField>

<ParamField body="capture_as" type="string">
  A key that stores the recipient's input in the envelope's `captures` object. When set, the value entered or selected by the recipient is saved under this key after the envelope is completed.

  Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters. Set to `null` to disable capture.
</ParamField>

<ParamField body="symbol" type="enum">
  The symbol to display in the checkbox when it is checked.

  Available options are `check` and `xmark`. The default is `check`.
</ParamField>

<ParamField body="requirement" type="enum">
  Specifies whether the recipient must check this box to complete the signing ceremony.

  Possible values are `required` or `optional`. The default is `optional`.
</ParamField>

<ParamField body="height" type="number">
  The height of the checkbox in <Tooltip tip="1/72 of an inch">points</Tooltip>. The width equals the height.

  Must be between 8 and 40. Defaults to 20.
</ParamField>

## Examples

<CodeGroup>
  ```json Basic (Optional) theme={null}
  "documents": [
    {
      //...
      "places": [
        {
          "key": "receive_marketing_emails",
          "type": "checkbox",
          "recipient_key": "employee",
          "symbol": "check",
          "height": 10
        }
      ]
      //...
    }
  ]
  ```

  ```json Required Checkbox theme={null}
  "documents": [
    {
      //...
      "places": [
        {
          "key": "accept_terms",
          "type": "checkbox",
          "recipient_key": "customer",
          "symbol": "check",
          "requirement": "required",
          "height": 12
        }
      ]
      //...
    }
  ]
  ```

  ```json X Symbol theme={null}
  "documents": [
    {
      //...
      "places": [
        {
          "key": "decline_arbitration",
          "type": "checkbox",
          "recipient_key": "customer",
          "symbol": "xmark",
          "height": 10
        }
      ]
      //...
    }
  ]
  ```

  ```json With Capture theme={null}
  "documents": [
    {
      //...
      "places": [
        {
          "key": "agreed_to_terms",
          "type": "checkbox",
          "recipient_key": "borrower",
          "symbol": "check",
          "requirement": "required",
          "capture_as": "terms_accepted",
          "height": 12
        }
      ]
      //...
    }
  ]
  ```
</CodeGroup>