Signatures

Signature entities describe the Users or Invitees involved in the entity requiring signatures. It describes the Users whose signatures are required, as well as other roles, including witnesses, intermediaries, and those who will sign in person.

Signature

{
  "recordId": "{recordId}",
  "signers": [
    {
      "signerOpenId": "auth0|12345abcde",
      "signerEmail": "[email protected]",
      "signerName": "Jane Smith",
      "signerRole": ""
    }
  ],
  "agents": [
    {
      "signerOpenId": "",
      "signerEmail": "",
      "signerName": "",
      "signerRole": ""
    }
  ],
  "carbonCopies": [
    {
      "signerOpenId": "",
      "signerEmail": "",
      "signerName": "",
      "signerRole": ""
    }
  ],
  "editors": [
    {
      "signerOpenId": "",
      "signerEmail": "",
      "signerName": "",
      "signerRole": ""
    }
  ],
  "inPersonSigners": [
    {
      "signerOpenId": "",
      "signerEmail": "",
      "signerName": "",
      "signerRole": ""
    }
  ],
  "intermediaries": [
    {
      "signerOpenId": "",
      "signerEmail": "",
      "signerName": "",
      "signerRole": ""
    }
  ],
  "witnesses": [
    {
      "signerOpenId": "auth0|11111aaaaa",
      "signerEmail": "[email protected]",
      "signerName": "John Smith",
      "signerRole": ""
    }
  ]
}

Signature entity

recordId string required
Unique Folder (record) identifier.

---

signers array of Recipient entities required

---

agents array of Recipient entities

---

carbonCopies array of Recipient entities

---

editors array of Recipient entities

---

inPersonSigners array of Recipient entities

---

intermediaries array of Recipient entities

---

witnesses array of Recipient entities

---

Recipient entity

signerOpenId string
Recipient's OpenID. Can use signerEmail field instead.

---

signerEmail string
Recipient's email address. Can use signerOpenId field instead.

---

signerName string
Recipient's name. Required if you do not give a value for the signerOpenId.

---

signerRole string required
Recipient's role.