A Signature Place is a type of Place that marks a specific area in the document where the recipient, as identified by the recipient_key, can place their signature.

For example, this is a definition of a signature place for the recipient with key employer:

​
Example

"documents":
[
  {
    ...
    "places": [
      {
        "key": "employer_first_signature",
        "type": "signature",
        "recipient_key": "employer",
        "height": 60
      }
    ]
    ...
  }
]

​
Parameters

​
type
enum
required

Specifies the type of place.

For a signature place, the value must be signature.

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

​
height
number

The height of the place within the document in . The width is calculated based on a 5:2 ratio.

The default height is 60 points.

Was this page helpful?

Place PositioningText Input Place