Skip to main content
Boxed text input places display a series of individual character boxes for structured data entry. Each box accepts a single character, making them ideal for collecting formatted information like verification codes, the last 4 digits of a Social Security Number, or date components. Boxed Text Input
Boxed text input places are only available in envelopes with sequential signing.
You can position Boxed Text Input Places inside a document using either fixed positions or placeholders.

​
Box Count

The box_count property determines how many individual character boxes appear. Each box accepts exactly one character from the recipient. Set this value based on the expected input length:
Use CaseRecommended box_count
Verification code (6 digits)6
Last 4 of SSN4
ZIP code5
Year (YYYY)4
Month or Day (MM/DD)2

​
Hints and Prompts

You can use hint and prompt properties to guide recipients while filling out the boxes:
  • Hint: A message shown as a tooltip when the user hovers over or focuses on the field. Set it using the hint property.
  • Prompt: A placeholder-style message displayed inside the first box to indicate the expected input. Set it using the prompt property.
For example, a boxed text input place configured with the following properties: 
{
  //...
  "hint": "Enter the 6-digit code from your email",
  "prompt": "0"
  //...
}

​
Size and Appearance

You can customize the size and appearance of boxed text input places to better fit your document layout:

​
Width

The width property sets the width of each individual box in points (1/72 of an inch).

​
Height

The height property sets the height of each individual box in points (1/72 of an inch).

​
Font Size

The font_size property controls the size of the text displayed within each box, measured in points. The default font size is 12 points.

​
Examples

The following examples show different ways to configure boxed text input places. 
"documents":
[
  {
    //...
    "places": [
      {
        "key": "verification_code",
        "type": "boxed_text_input",
        "recipient_key": "signer",
        "box_count": 6,
        "capture_as": "verification_code",
        "hint": "Enter the 6-digit code from your email",
        "requirement": "required"
      }
    ]
    //...
  }
]

​
Parameters

​
type
enum
required
Specifies the type of place.For a boxed text input place, the value must be boxed_text_input.
​
key
string
required
A user-provided key that identifies a place within a document.It must be up to 32 characters long, using only lowercase letters, numbers, or underscores, and it must begin with a letter.
​
recipient_key
string
required
A user-provided key that identifies a recipient within an envelope.It must match one of the recipient.key values in the envelope’s recipient list.
​
box_count
number
required
The number of individual character boxes to display.Must be between 1 and 100. Each box accepts a single character from the recipient.
​
capture_as
string
A user-defined identifier used to store the value entered by the recipient. This value will be included in the captures object of the Envelope.Must start with a lowercase letter and contain only lowercase letters, numbers, or underscores. Maximum length is 32.
​
hint
string
A tooltip message displayed over the boxed text input field during the signing ceremony.Learn more in Hints and Prompts.
​
prompt
string
A placeholder message shown inside the first box during the signing ceremony to guide the recipient.Learn more in Hints and Prompts.
​
requirement
enum
Specifies whether the recipient must fill all boxes to complete the signing ceremony.Possible values are required or optional. The default is required.
​
width
number
The width of each individual box in .Must be between 30 and 540. The default is 30.
​
height
number
The height of each individual box in .
​
font_size
number
The font size in .Must be between 6 and 12. The default is 12.