Place Object – SignatureAPI Docs

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.