Launch document signing | PlannrCRM API documentation

Launch document signing Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

      
          mcp.json

"PlannrCRM MCP server": {
  "url": "https://apidocs.plannrcrm.com/mcp"
}

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
  
  business_unit string
  
  groups string
  
  tags string
  
  owners string
  
  first_contact_date string
  
  next_review_date string
  
  previous_review_date string
  
  anniversary_review_date string
  
  terms_of_business_at string
  
  client_agreement_at 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":["88e23d50-68f8-4cbe-8c1f-c14615c79823","43b2cf0b-ea85-4c0a-9909-a5e83ff02d0f","2db61857-c033-4f64-a484-e48b35d20dd1"],"document_template_uuids":["ca9f8cd3-e1d0-4f1d-ac0e-da3b471253a8","32d15189-c955-40d1-a823-39eb7e9bd869","6328d1c7-e785-4740-851b-1b301b612213"],"document_template_dependants":{"client-1":"350f336b-f19c-45fd-a986-372d9c51b528","client-2":"74b549dc-2e80-4fca-b624-230e54beeb0e"}}'

Request examples

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

# Payload
{
  "participant_uuids": [
    "88e23d50-68f8-4cbe-8c1f-c14615c79823",
    "43b2cf0b-ea85-4c0a-9909-a5e83ff02d0f",
    "2db61857-c033-4f64-a484-e48b35d20dd1"
  ],
  "document_template_uuids": [
    "ca9f8cd3-e1d0-4f1d-ac0e-da3b471253a8",
    "32d15189-c955-40d1-a823-39eb7e9bd869",
    "6328d1c7-e785-4740-851b-1b301b612213"
  ],
  "document_template_dependants": {
    "client-1": "350f336b-f19c-45fd-a986-372d9c51b528",
    "client-2": "74b549dc-2e80-4fca-b624-230e54beeb0e"
  }
}

Response examples (200)

{
  "uuid": "05ca8b05-4201-469d-b8bd-55a5626d39e6",
  "created_at": "2026-06-09T14:10:14+01:00",
  "updated_at": "2026-06-09T14:10:14+01:00",
  "name": 1000243230,
  "status": "pending",
  "participants": [
    {
      "uuid": "c4eb4f29-9aa2-494d-bc75-3a8df1baa472",
      "created_at": "2026-06-09T14:10:14+01:00",
      "updated_at": "2026-06-09T14:10:14+01:00",
      "alphatrust_id": 1000145124,
      "name": "Gareth Thompson",
      "status": "pending"
    }
  ],
  "documents": [
    {
      "uuid": "756a343b-ff6c-47c3-acc0-6007157079bd",
      "created_at": "2026-06-09T14:10:14+01:00",
      "updated_at": "2026-06-09T14:10:14+01:00",
      "alphatrust_id": 1000455612,
      "name": "Welcome Pack",
      "status": "pending"
    }
  ],
  "launched_by": {
    "uuid": "f5d5125a-c604-43c6-8e7b-b7431e667072",
    "created_at": "2026-06-09T14:10:14+01:00",
    "updated_at": "2026-06-09T14:10:14+01:00",
    "type": "client",
    "role": "client",
    "first_name": "Gareth",
    "last_name": "Thompson",
    "name": "Gareth Thompson",
    "email": "gareth@codepotato.co.uk",
    "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
    "firm": "App\\Http\\Resources\\FirmResource",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "business_unit": "App\\Http\\Resources\\BusinessUnitResource",
    "groups": "App\\Http\\Resources\\GroupResource",
    "tags": "App\\Http\\Resources\\TagResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "first_contact_date": "2026-06-09T14:10:14+01:00",
    "next_review_date": "2026-06-09T14:10:14+01:00",
    "previous_review_date": "2026-06-09T14:10:14+01:00",
    "anniversary_review_date": "2026-06-09T14:10:14+01:00",
    "terms_of_business_at": "2026-06-09T14:10:14+01:00",
    "client_agreement_at": "2026-06-09T14:10:14+01:00",
    "with_login": true,
    "has_joint_account": true,
    "can_be_deleted": "false",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "inactive_at": "2026-06-09",
    "last_interaction_at": "2026-06-09 14:10:14",
    "referral_code": "ABC12345",
    "permissions": {
      "firm:read": [
        "firm"
      ],
      "network:read": [
        "network:uuid"
      ]
    },
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  }
}