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
      • 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":["6f372b48-6a62-495f-bfae-154bf8cdae9f","7eb8fdec-2647-441a-a87c-7846bea95d98","a6f36a9c-2c72-481a-9b4a-a839ecd98a43"],"document_template_uuids":["63449687-945d-4e65-b426-74b54f0c77eb","7cc4dd85-5df2-461a-86dd-b34587aa648e","03432d85-e072-46e4-9e03-db6585146d24"],"document_template_dependants":{"client-1":"14ed3483-2ca7-4f45-bc37-9a4da0ca6ec1","client-2":"30edfc70-2c87-439f-9a76-60fb746a993f"}}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "participant_uuids": [
    "6f372b48-6a62-495f-bfae-154bf8cdae9f",
    "7eb8fdec-2647-441a-a87c-7846bea95d98",
    "a6f36a9c-2c72-481a-9b4a-a839ecd98a43"
  ],
  "document_template_uuids": [
    "63449687-945d-4e65-b426-74b54f0c77eb",
    "7cc4dd85-5df2-461a-86dd-b34587aa648e",
    "03432d85-e072-46e4-9e03-db6585146d24"
  ],
  "document_template_dependants": {
    "client-1": "14ed3483-2ca7-4f45-bc37-9a4da0ca6ec1",
    "client-2": "30edfc70-2c87-439f-9a76-60fb746a993f"
  }
}
Response examples (200) 
{
  "name": 1000243230,
  "uuid": "809b8a96-58a5-4c85-9198-034f2a11df76",
  "status": "pending",
  "documents": [
    {
      "name": "Welcome Pack",
      "uuid": "6dd12ada-b034-4a5a-93c1-08c1f92f05fa",
      "status": "pending",
      "created_at": "2025-12-24T11:02:59+00:00",
      "updated_at": "2025-12-24T11:02:59+00:00",
      "alphatrust_id": 1000455612
    }
  ],
  "created_at": "2025-12-24T11:02:59+00:00",
  "updated_at": "2025-12-24T11:02:59+00:00",
  "launched_by": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "242628d2-7b30-4a31-80f6-83234d1421cd",
    "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-24T11:02:59+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-12-24T11:02:59+00:00",
    "with_login": true,
    "inactive_at": "2025-12-24",
    "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-24T11:02:59+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-12-24T11:02:59+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "last_interaction_at": "2025-12-24 11:02:59",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2025-12-24T11:02:59+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-12-24T11:02:59+00:00"
  },
  "participants": [
    {
      "name": "Gareth Thompson",
      "uuid": "8481bd6d-3132-45df-b9ab-f20d624c3fbe",
      "status": "pending",
      "created_at": "2025-12-24T11:02:59+00:00",
      "updated_at": "2025-12-24T11:02:59+00:00",
      "alphatrust_id": 1000145124
    }
  ]
}