v1

latestOpenAPI 3.1.02026-08-066378446.6 KB

Document Operations

Add party

<small>Requires an API token with the Document Manager role.</small>

Adds a party to a document.

Adding an internal party

To add one of your account's internal parties to the document, send the account_party_uuid and reference fields. The rest of the party data will be copied from the respective "account party".

Adding an external party

To add an external party to the document, send these fields:

reference
entity_name
address
scope

Note: When adding a party that is linked to an account party, only reference can be provided. Attempting to set the other fields will cause the request to be rejected with a validation error.

post/documents/{document}/parties

Path parameters

documentstring required

The document UUID

Request body

referencestring required

A generic reference for the party

account_party_uuidstring uuid

UUID of a party from Settings > My Parties. When this is provided, reference is the only other field that can be sent.

entity_namestring

The actual name of the party. i.e. name of the company or person. Must be non-null in order for the document to proceed to the signing stage

addressstring nullable

The party's address

scope'internal' | 'internal_and_external'

Example request

{
  "reference": "Employer",
  "entity_name": "Demo Inc.",
  "address": "1 Oxford Road\nHenley Bridge\nHB1 1PQ"
}

Response

DocumentPartyResource

Example response

{
  "data": {
    "uuid": "595703a2-b7f6-4772-a4b7-ab2f9fac3a9f",
    "ref_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "reference": "Employer",
    "entity_name": "Demo Inc.",
    "address": "1 Oxford Road\nHenley Bridge\nHB1 1PQ",
    "signatories": [
      {
        "uuid": "76b8e0ad-e9cd-4c21-98b1-cd0003423ec2",
        "first_name": "Emily",
        "last_name": "Miller",
        "email": "miller@example.com",
        "mobile_phone": "+447951123456",
        "title": "Sales Manager",
        "profile_photo_url": "https://ui-avatars.com/api/?name=EM"
      }
    ]
  }
}