Recipient Name Place let you insert the name of the recipient, as identified by the recipient_key, at a location in the document.

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

​
Example

For example, this is a definition of a recipient name place for the recipient with key client, linked to the placeholder client_name inside the document:

"documents":
[
  {
    "places": [
      {
        "key": "client_name",
        "type": "recipient_name",
        "recipient_key": "client"
      },
      //...
    ]
    //...
  }
]

​
Parameters

​
type
enum
required

Specifies the type of place.

For this kind of place, the value must be recipient_name.

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