POST /api/v1/document-signing
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string
application/json

Body

  • participant_uuids array

    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

    Array document template UUIDs to be added as adhoc documents of the document signing process. Required without document_pack.

  • document_template_dependants array

    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":["3de332b0-7307-4be5-a580-9e0f1e3d0308","ce02efb5-ce93-4f43-ab7d-9d2630c3d452"],"document_template_uuids":["3318a70f-3229-496f-a74f-e480658d50f0","4895d985-eff0-499c-8d9e-8c50c56622df"],"document_template_dependants":[{"client-1":"540aa895-6c9b-4a18-b02c-201b5030c3fb","client-2":"9243d85a-342c-47d6-a84a-70a68adf77ea"}]}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "participant_uuids": [
    "3de332b0-7307-4be5-a580-9e0f1e3d0308",
    "ce02efb5-ce93-4f43-ab7d-9d2630c3d452"
  ],
  "document_template_uuids": [
    "3318a70f-3229-496f-a74f-e480658d50f0",
    "4895d985-eff0-499c-8d9e-8c50c56622df"
  ],
  "document_template_dependants": [
    {
      "client-1": "540aa895-6c9b-4a18-b02c-201b5030c3fb",
      "client-2": "9243d85a-342c-47d6-a84a-70a68adf77ea"
    }
  ]
}
Response examples (200) 
{
  "name": 1000243230,
  "uuid": "ba4531a4-3e02-4ca8-a1d1-5fe5b7e319ef",
  "status": "pending",
  "documents": [
    {
      "name": "Welcome Pack",
      "uuid": "79e9fda2-7868-40b3-908e-ea88513ad48e",
      "status": "pending",
      "created_at": "2025-12-08T16:11:23+00:00",
      "updated_at": "2025-12-08T16:11:23+00:00",
      "alphatrust_id": 1000455612
    }
  ],
  "created_at": "2025-12-08T16:11:23+00:00",
  "updated_at": "2025-12-08T16:11:23+00:00",
  "launched_by": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "b6bfe7a2-bd8d-40d6-8069-f3eb606565b4",
    "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-12-08T16:11:23+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-12-08T16:11:23+00:00",
    "with_login": true,
    "inactive_at": "2025-12-08",
    "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-12-08T16:11:23+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-12-08T16:11:23+00: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-12-08T16:11:23+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-12-08T16:11:23+00:00"
  },
  "participants": [
    {
      "name": "Gareth Thompson",
      "uuid": "280758fb-5591-49a6-9af7-2734f6deb612",
      "status": "pending",
      "created_at": "2025-12-08T16:11:23+00:00",
      "updated_at": "2025-12-08T16:11:23+00:00",
      "alphatrust_id": 1000145124
    }
  ]
}