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

Headers

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

Body

  • participant_uuids array[string(uuid)] 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(uuid)] Required

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

  • document_template_dependants object

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

    Additional properties are allowed.

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
      • last_interaction_at string
      • referral_code string
      • permissions object
        Hide permissions attributes Show permissions attributes object
        • firm:read array[string]
        • network:read array[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":["fbe0ea6a-5032-4302-8b79-003ad08c050c","ef84339c-b1ef-4e42-a6df-19647f06f74b","3ed25a66-8bf0-471a-9f2d-462cec65cd78"],"document_template_uuids":["aaac2b0c-2112-498f-bcb9-eb8a03c18993","d2da2cdf-bd6b-4eb9-8f43-e1c6709e5de8","fd9a358f-306f-40ed-b9b4-a050281ce0a1"],"document_template_dependants":{"client-1":"b4eb844a-9cdc-49c7-95dc-2112b430e12c","client-2":"c5c79967-7103-41e7-9dd8-edf454d6c515"}}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "participant_uuids": [
    "fbe0ea6a-5032-4302-8b79-003ad08c050c",
    "ef84339c-b1ef-4e42-a6df-19647f06f74b",
    "3ed25a66-8bf0-471a-9f2d-462cec65cd78"
  ],
  "document_template_uuids": [
    "aaac2b0c-2112-498f-bcb9-eb8a03c18993",
    "d2da2cdf-bd6b-4eb9-8f43-e1c6709e5de8",
    "fd9a358f-306f-40ed-b9b4-a050281ce0a1"
  ],
  "document_template_dependants": {
    "client-1": "b4eb844a-9cdc-49c7-95dc-2112b430e12c",
    "client-2": "c5c79967-7103-41e7-9dd8-edf454d6c515"
  }
}
Response examples (200) 
{
  "name": 1000243230,
  "uuid": "129bf087-0109-4676-a9c3-89a44369367a",
  "status": "pending",
  "documents": [
    {
      "name": "Welcome Pack",
      "uuid": "43cf1e87-9650-41f8-8d79-edcfe907ad94",
      "status": "pending",
      "created_at": "2026-04-09T17:35:06+01:00",
      "updated_at": "2026-04-09T17:35:06+01:00",
      "alphatrust_id": 1000455612
    }
  ],
  "created_at": "2026-04-09T17:35:06+01:00",
  "updated_at": "2026-04-09T17:35:06+01:00",
  "launched_by": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "85556cba-a7d7-4a99-8d9f-55b46cbbbc32",
    "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": "2026-04-09T17:35:06+01:00",
    "first_name": "Gareth",
    "updated_at": "2026-04-09T17:35:06+01:00",
    "with_login": true,
    "inactive_at": "2026-04-09",
    "permissions": {
      "firm:read": [
        "firm"
      ],
      "network:read": [
        "network:uuid"
      ]
    },
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "referral_code": "ABC12345",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2026-04-09T17:35:06+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2026-04-09T17:35:06+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "last_interaction_at": "2026-04-09 17:35:06",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2026-04-09T17:35:06+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2026-04-09T17:35:06+01:00"
  },
  "participants": [
    {
      "name": "Gareth Thompson",
      "uuid": "a83d2726-1afc-4917-8f42-fb3e69ad1e96",
      "status": "pending",
      "created_at": "2026-04-09T17:35:06+01:00",
      "updated_at": "2026-04-09T17:35:06+01:00",
      "alphatrust_id": 1000145124
    }
  ]
}