Place Object

Places are designated areas within a document where a recipient either provides input, such as a signature, or where a constant or calculated value is added, like a completion date.

To define a place, you need to specify both a place object and a position, either by using a placeholder within the document or by setting fixed positions with coordinates.

Places are defined in the places array within the document object. Each element in the array represents a place within the document. The properties of each place depend on its type. For example, a signature place will include information about the recipient expected to sign, while a date place, such as envelope completed date, can specify the format for the date-time string.

"documents":
[
  {
    ...
    "places": [
      {
        "key": "employee_signs_here",
        "type": "signature",
        "recipient_key": "employee",
        "height": 60
      },
      {
        "key": "manager_signs_here",
        "type": "signature",
        "recipient_key": "manager",
        "height": 60
      },
      {
        "key": "completed_at",
        "type": "envelope_completed_at",
        "date_format": "DD MMMM YYYY, HH:mm"
      }
    ]
    ...
  }
]

​

Place Types

There are several types of places that can be defined within a document:

• Signature
• Text
• Recipient Completed Date
• Envelope Completed Date