This designates an area within the document to record the date where a single recipient or all recipients completed a document.

​
Recipient Completed Date

This designates an area within the document to record the date when the recipient, identified by recipient_key, completed their action (for example, signing) within the envelope.

For example, this is how to define a recipient completed date place for the recipient with the key employer and the date format YYYY-MM-DD:

​
Example

"documents":
[
  {
    ...
    "places": [
      {
        "key": "employer_signed_at",
        "type": "recipient_completed_date",
        "recipient_key": "employer",
        "date_format": "YYYY-MM-DD"
      }
    ]
    ...
  }
]

​
Parameters

​
type
enum
required

Specifies the type of place.

For a signature place, the value must be recipient_completed_date.

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

​
date_format
string

Defines the format of the date, using MomentJS date format definitions.

The default format is D MMM YYYY, which outputs as 31 Dec 2025.

​
Envelope Completed Date

This indicates a location within the document to capture the date when the entire envelope was completed, meaning all recipients have completed their actions (for example, signing).

For example, this is how to define a place for the envelope completed date with the key employer and the date format MM/DD/YYYY, HH:MM:SS:

​
Example

"documents":
[
  {
    ...
    "places": [
      {
        "key": "signed_by_all_at",
        "type": "envelope_completed_date",
        "date_format": "MM/DD/YYYY, HH:MM:SS"
      }
    ]
    ...
  }
]

​
Parameters

​
type
enum
required

Specifies the type of place.

For a signature place, the value must be envelope_completed_date.

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

​
date_format
string

Defines the format of the date, using MomentJS date format definitions.

The default format is D MMM YYYY, which outputs as 31 Dec 2025.

Was this page helpful?

Text PlaceDeliverable object