Place Object

Define signature fields, input areas, and auto-filled values at specific locations in documents

A place is a location on a document where a recipient performs an action or where information is displayed automatically. Places define where signatures go, where recipients type text, and where dates or names are inserted.

Places are defined in the places array on a document. Each element in the array represents one place within the document. The properties available on a place depend on its type.

A place belongs to a document.

To generate a document from a template with dynamic data before any recipient signs, use Document Templates instead.

Place Types

There are three categories of place: signature places for capturing signatures and initials, interactive places that require other input from a recipient, and informational places that insert values automatically.

Signature places

Type	Description
signature	The recipient draws or types their signature
initials	The recipient enters their initials

Interactive places

Interactive places require sequential routing.

Type	Description
text_input	The recipient types free-form text
boxed_text_input	The recipient enters text into individual character boxes
multiline_text_input	The recipient types text across multiple lines
dropdown	The recipient selects from a list of options
checkbox	The recipient checks or unchecks a box

Informational places

Type	Description
text	A static text value inserted on the document
recipient_completed_date	The date the recipient completed their action
envelope_completed_date	The date the envelope was completed by all recipients
recipient_name	The recipient’s name
recipient_email	The recipient’s email address

Positioning

Every place must be positioned on the document. There are two ways to do this:

• Placeholder: Embed [[place_key]] in the document text. The place appears where the placeholder is found.
• Fixed position: Specify exact coordinates using page number, top, and left values measured in points (1 point = 1/72 inch).

See Place Positioning for details.

Signature

{
  "key": "employer_first_signature",
  "type": "signature",
  "recipient_key": "employer",
  "height": 60
}

{
  "key": "employer_initials",
  "type": "initials",
  "recipient_key": "employer",
  "height": 60
}

{
  "key": "buyer_email",
  "type": "text_input",
  "recipient_key": "buyer",
  "capture_as": "buyer_email",
  "prompt": "[e-mail]",
  "hint": "Please enter your email",
  "format": "email",
  "requirement": "optional",
  "width": 200,
  "font_size": 8
}

{
  "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"
}

{
  "key": "customer_comments",
  "type": "multiline_text_input",
  "recipient_key": "customer",
  "capture_as": "comments",
  "prompt": "Enter your comments here...",
  "hint": "Please provide detailed feedback",
  "requirement": "optional",
  "width": 400,
  "line_count": 5,
  "line_height": 14,
  "font_size": 10
}

{
  "key": "employment_type",
  "type": "dropdown",
  "recipient_key": "employee",
  "options": [
    { "label": "Full-time", "value": "full_time" },
    { "label": "Part-time", "value": "part_time" },
    { "label": "Contract", "value": "contract" },
    { "label": "Internship", "value": "internship" }
  ],
  "default": "Full-time",
  "capture_as": "employment_type",
  "prompt": "Select employment type",
  "hint": "Choose the type of employment",
  "requirement": "required",
  "width": 150,
  "font_size": 10
}

{
  "key": "receive_marketing_emails",
  "type": "checkbox",
  "recipient_key": "employee",
  "symbol": "check",
  "height": 10
}

{
  "key": "company_name",
  "type": "text",
  "value": "Lorem Ipsum Ltd",
  "font_size": 12,
  "font_color": "#000000"
}

{
  "key": "employer_signed_at",
  "type": "recipient_completed_date",
  "recipient_key": "employer",
  "date_format": "YYYY-MM-DD"
}

{
  "key": "signed_by_all_at",
  "type": "envelope_completed_date",
  "date_format": "MM/DD/YYYY HH:mm"
}

{
  "key": "client_name",
  "type": "recipient_name",
  "recipient_key": "client"
}

{
  "key": "client_email",
  "type": "recipient_email",
  "recipient_key": "client"
}