Document Operations

Add party

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

POST

/documents/{document}/parties

Add party

curl --request POST \
  --url https://app.fynk.com/v1/api/documents/{document}/parties \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_party_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "address": "1 Oxford Road\nHenley Bridge\nHB1 1PQ",
  "entity_name": "Demo Inc.",
  "reference": "Employer",
  "scope": "internal"
}
'

{
  "data": {
    "address": "1 Oxford Road\nHenley Bridge\nHB1 1PQ",
    "created_at": "2023-11-07T05:31:56Z",
    "entity_name": "Demo Inc.",
    "is_internal_party": true,
    "is_ready_for_signing": true,
    "ready_for_signing_at": "2023-11-07T05:31:56Z",
    "ref_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "reference": "Employer",
    "scope": "internal",
    "signatories": [
      {
        "email": "miller@example.com",
        "first_name": "Emily",
        "has_account_user": true,
        "last_name": "Miller",
        "mobile_phone": "+447951123456",
        "profile_photo_url": "https://ui-avatars.com/api/?name=EM",
        "signing_order": 123,
        "title": "Sales Manager",
        "uuid": "76b8e0ad-e9cd-4c21-98b1-cd0003423ec2"
      }
    ],
    "updated_at": "2023-11-07T05:31:56Z",
    "uuid": "595703a2-b7f6-4772-a4b7-ab2f9fac3a9f"
  }
}

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.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

documentstringrequired

The document UUID

Body

account_party_uuidstring

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

addressstring | null

The party's address

Maximum string length: 255

Example:

1 Oxford Road
Henley Bridge
HB1 1PQ

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

Maximum string length: 255

Example: Demo Inc.

referencestringrequired

A generic reference for the party

Maximum string length: 255

Example: Employer

scopeenum<string>

When this is internal_and_external, collaborators from this party may change the party's information. Required when account_party_uuid is not sent

Available options: internal, internal_and_external

Response

DocumentPartyResource

dataobjectrequired

Show child attributes

Still need help? Share an idea