Text input places allow you to request specific information from recipients during the signing ceremony. These are similar to fields in other electronic signature platforms.

This feature is in Public Preview
Input fields are only available in envelopes with sequential signing. Currently, only the first recipient can fill them in.

For example, a text input field can be used to place a text box at the placeholder [[buyer_occupation]]. This allows the recipient with the key “buyer” to provide their occupation. This field is set to optional.

​
Example

"documents":
[
  {
    ...
    "places": [
      {
        "key": "buyer_occupation",
        "type": "text_input",
        "recipient_key": "buyer",
        "capture_as": "buyer_occupation",
        "hint": "Engineer",
        "prompt": "Please enter your occupation",
        "requirement": "optional",
      }
    ]
    ...
  }
]

​
Parameters

​
type
enum
required

Specifies the type of place.

For a text place, the value must be 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 to one of the keys in the envelope’s recipient list.

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

​
hint
string

A tooltip message displayed over the input text field during the signing ceremony.

​
prompt
string

A placeholder message shown inside the input text field during the signing ceremony.

​
requirement
enum

Specifies whether the recipient must fill this field to complete the signing ceremony.

Possible values are required or optional. The default is required.

Was this page helpful?

Signature PlaceText Place