An Initials 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 initials.

You can position initial places inside a document using either fixed positions or placeholders.

This feature is in public preview

​
Example

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

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

​
Parameters

​
type
enum
required

Specifies the type of place.

For a signature place, the value must be initials.

​
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 the same as the height (it’s a square).

The default height is 60 points.

Was this page helpful?