Launch document signing

POST /api/v1/document-signing

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

application/json

Body Required

participant_uuids array[string] Required

Participants who will be viewing and signing the documents. Must be given in the order you would like the participants to view the documents.
document_template_uuids array[string] Required

Array document template UUIDs to be added as adhoc documents of the document signing process. Required without document_pack.
document_template_dependants array[string]

Array variable dependant models that are needed for variable replacing across all documents that are provided.

Responses

200 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- name integer
  
  Transaction ID on Alphatrust
- status string
  
  Current status of the document signing process.
- participants array[object]
  
  Participants of the document signing process.
  
  Hide participants attributes Show participants attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  alphatrust_id integer
  
  name string
  
  status string
- documents array[object]
  
  Documents of the document signing process.
  
  Hide documents attributes Show documents attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  alphatrust_id integer
  
  name string
  
  status string
- launched_by object
  
  Account that launched the document signing process.
  
  Hide launched_by attributes Show launched_by attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  firm string
  
  primary_phone_number string
  
  primary_email string
  
  current_time_entry string
  
  assigned_adviser string
  
  assigned_administrator string
  
  assigned_paraplanner string
  
  introduced_by string
  
  groups string
  
  tags string
  
  owners string
  
  first_contact_date string
  
  next_review_date string
  
  previous_review_date string
  
  anniversary_review_date string
  
  with_login boolean
  
  has_joint_account boolean
  
  can_be_deleted string
  
  joint_account_circle string
  
  circles string
  
  ownership_percentage integer
  
  inactive_at string
  
  custom_fields string
  
  external_references string

POST /api/v1/document-signing

curl \
 --request POST 'https://api.plannrcrm.com/api/v1/document-signing' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"participant_uuids":["0cad10ac-5db1-4b08-8ca5-879dd9a74f52","1e410bb4-2f17-43d1-b4da-14ee4f7eae1e"],"document_template_uuids":["f0dea6e2-de0c-42ac-b111-98dd78643b59","5b9ebde8-8786-4ddb-a3aa-ef66d133000b"],"document_template_dependants":[{"client-1":"e7bd09ea-28c7-4731-8868-41b080075ad6","client-2":"dea063be-9961-4ac0-97fc-e3c50f51d194"}]}'

Request examples

# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "participant_uuids": [
    "0cad10ac-5db1-4b08-8ca5-879dd9a74f52",
    "1e410bb4-2f17-43d1-b4da-14ee4f7eae1e"
  ],
  "document_template_uuids": [
    "f0dea6e2-de0c-42ac-b111-98dd78643b59",
    "5b9ebde8-8786-4ddb-a3aa-ef66d133000b"
  ],
  "document_template_dependants": [
    {
      "client-1": "e7bd09ea-28c7-4731-8868-41b080075ad6",
      "client-2": "dea063be-9961-4ac0-97fc-e3c50f51d194"
    }
  ]
}

Response examples (200)

{
  "name": 1000243230,
  "uuid": "b75aee63-da04-4bd1-932c-03b2ded5bd12",
  "status": "pending",
  "documents": [
    {
      "name": "Welcome Pack",
      "uuid": "53e8f277-092f-4066-a83f-ca939b9280d9",
      "status": "pending",
      "created_at": "2025-09-05T20:52:47+01:00",
      "updated_at": "2025-09-05T20:52:47+01:00",
      "alphatrust_id": 1000455612
    }
  ],
  "created_at": "2025-09-05T20:52:47+01:00",
  "updated_at": "2025-09-05T20:52:47+01:00",
  "launched_by": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "f353d968-ec1c-4390-a5ef-4baabf7cdad0",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
    "created_at": "2025-09-05T20:52:47+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-09-05T20:52:47+01:00",
    "with_login": true,
    "inactive_at": "2025-09-05",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2025-09-05T20:52:47+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-09-05T20:52:47+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2025-09-05T20:52:47+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-09-05T20:52:47+01:00"
  },
  "participants": [
    {
      "name": "Gareth Thompson",
      "uuid": "3916ec09-589d-4c0b-a280-f029ccd84fcd",
      "status": "pending",
      "created_at": "2025-09-05T20:52:47+01:00",
      "updated_at": "2025-09-05T20:52:47+01:00",
      "alphatrust_id": 1000145124
    }
  ]
}