> ## 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.

# Boxed Text Input Place

> Collect structured data with individual character boxes for codes, SSN digits, or dates

A **boxed text input place** displays a series of individual character boxes. Each box accepts one character, making this place type ideal for structured data such as verification codes, the last four digits of a Social Security Number, or date components.

<img src="https://mintcdn.com/signatureapi-daf4ee54/nTNmbAkpPw5L2NqU/docs/images/boxed-input.png?fit=max&auto=format&n=nTNmbAkpPw5L2NqU&q=85&s=171d225f40ec0e3ed65f35977cb99217" alt="Boxed Text Input" width="384" height="277" data-path="docs/images/boxed-input.png" />

<Note>Boxed text input places are only available in envelopes with sequential signing.</Note>

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

## Box Count

The `box_count` property sets how many individual character boxes appear. Set this value based on the expected input length.

| Use case                     | Recommended `box_count` |
| ---------------------------- | ----------------------- |
| Verification code (6 digits) | 6                       |
| Last 4 of SSN                | 4                       |
| ZIP code                     | 5                       |
| Year (YYYY)                  | 4                       |
| Month or day (MM/DD)         | 2                       |

## Hints and Prompts

Use `hint` and `prompt` to guide recipients while filling in the boxes.

* **`hint`**: A tooltip shown when the recipient hovers over or focuses on the field.
* **`prompt`**: Placeholder text displayed inside the first box.

```json theme={null}
{
  //...
  "hint": "Enter the 6-digit code from your email",
  "prompt": "0"
  //...
}
```

## Capturing Input

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

## Size and Appearance

* **`width`**: The total width of the field in points (1/72 inch). Must be between 30 and 540. Defaults to 30.
* **`height`**: The height of each box in points (1/72 inch). Must be between 6 and 60.
* **`font_size`**: The text size inside each box, in points. Must be between 6 and 12. Defaults to 12.

## Attributes

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

  For a boxed text input place, the value must be `boxed_text_input`.
</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="box_count" type="number">
  The number of individual character boxes to display.

  Must be between 1 and 100. Each box accepts a single character from the recipient.
</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="hint" type="string">
  A tooltip message displayed over the boxed text input field during the signing ceremony.

  Learn more in [Hints and Prompts](/docs/api/resources/places/boxed-text-input#hints-and-prompts).
</ParamField>

<ParamField body="prompt" type="string">
  A placeholder message shown inside the first box during the signing ceremony to guide the recipient.

  Learn more in [Hints and Prompts](/docs/api/resources/places/boxed-text-input#hints-and-prompts).
</ParamField>

<ParamField body="requirement" type="enum">
  Specifies whether the recipient must fill all boxes to complete the signing ceremony.

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

<ParamField body="width" type="number" required={true}>
  The total width of the boxed input field in <Tooltip tip="1/72th of an inch">points</Tooltip>.

  Must be between 30 and 540. The default is 30.
</ParamField>

<ParamField body="height" type="number" required={true}>
  The height of each individual box in <Tooltip tip="1/72th of an inch">points</Tooltip>.
</ParamField>

<ParamField body="font_size" type="number" required={true}>
  The font size in <Tooltip tip="1/72th of an inch">points</Tooltip>.

  Must be between 6 and 12. The default is 12.
</ParamField>

## Examples

<CodeGroup>
  ```json Verification Code theme={null}
  "documents": [
    {
      //...
      "places": [
        {
          "key": "verification_code",
          "type": "boxed_text_input",
          "recipient_key": "signer",
          "font_size": 12,
          "width": 150,
          "height": 20,
          "box_count": 6,
          "capture_as": "verification_code",
          "hint": "Enter the 6-digit code from your email",
          "requirement": "required"
        }
      ]
      //...
    }
  ]
  ```

  ```json Last 4 of SSN theme={null}
  "documents": [
    {
      //...
      "places": [
        {
          "key": "ssn_last_four",
          "type": "boxed_text_input",
          "recipient_key": "applicant",
          "font_size": 12,
          "width": 100,
          "height": 20,
          "box_count": 4,
          "capture_as": "ssn_last_four",
          "hint": "Last 4 digits of your Social Security Number",
          "requirement": "required"
        }
      ]
      //...
    }
  ]
  ```

  ```json Tax ID (EIN) theme={null}
  "documents": [
    {
      //...
      "places": [
        {
          "key": "ein",
          "type": "boxed_text_input",
          "recipient_key": "taxpayer",
          "font_size": 12,
          "width": 225,
          "height": 20,
          "box_count": 9,
          "capture_as": "ein",
          "hint": "Enter your 9-digit Employer Identification Number",
          "requirement": "required"
        }
      ]
      //...
    }
  ]
  ```
</CodeGroup>