Text Input Place

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.

You can position Text Input Places inside a document using either fixed positions or placeholders.

​

Hints and Prompts

You can use hint and prompt properties to guide recipients while filling out text fields:

• Hint: A message shown as a tooltip when the user hovers over or focus on the text field. Set it using the hint property.
• Prompt: A placeholder-style message displayed inside the text field. Set it using the prompt property.

For example, a text input place configured with the following properties:

{
  //...
  "hint": "Your 8-digit reference code",
  "prompt": "12345678"
  //...
}

During the signing ceremony, the field will appear like this:

​

Format Validation

The format property allows you to control the type of input users can enter into a field. This property can accept either predefined formats or custom regular expressions.

​

Predefined Formats

You can use one of the following predefined values:

​

Custom Regular Expressions

If the predefined formats don’t meet your needs, you can define a custom format using a regular expression. Enclose the regular expression in forward slashes. For example, to require exactly 8 numeric digits:

{
  // ...
  "format": "/^[0-9]{8}$/"
  // ...
}

​

Adding a Custom Message

To guide users during input, you can include a format_message property. This message is displayed when the input doesn’t match the required format. For example:

{
  // ...
  "format": "/^[0-9]{8}$/",
  "format_message": "Must be exactly 8 numeric digits (0-9)"
  // ...
}

During the signing ceremony, the format_message is displayed to help users understand the input requirements:

​

Example

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

"documents":
[
  {
    ...
    "places": [
      {
        "key": "buyer_email",
        "type": "text_input",
        "recipient_key": "buyer",
        "capture_as": "buyer_email",
        "prompt": "john@example.com",
        "hint": "Please enter your email",
        "format": "email",
        "requirement": "optional"
      }
    ]
    ...
  }
]

​

Parameters