Launch document signing

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

Headers

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.

    • documents array[object]

      Documents of the document signing process.

    • launched_by object

      Account that launched the document signing process.
POST /api/v1/document-signing 
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/document-signing' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"participant_uuids":["2697a9fd-5e90-4743-8814-e56b9e3b552a","0585f3e6-171b-4bfc-9c07-0a9e184261ec"],"document_template_uuids":["477f6e73-06c9-4f93-8aef-c89a5a02f960","5b74048e-b08c-4b42-b53f-a6c5026e989d"],"document_template_dependants":[{"client-1":"8059c1c4-1ac0-41c7-bc0a-7972d3ed89e1","client-2":"84616ede-2ebd-4795-8faf-ab653c925c16"}]}'
Request examples 
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "participant_uuids": [
    "2697a9fd-5e90-4743-8814-e56b9e3b552a",
    "0585f3e6-171b-4bfc-9c07-0a9e184261ec"
  ],
  "document_template_uuids": [
    "477f6e73-06c9-4f93-8aef-c89a5a02f960",
    "5b74048e-b08c-4b42-b53f-a6c5026e989d"
  ],
  "document_template_dependants": [
    {
      "client-1": "8059c1c4-1ac0-41c7-bc0a-7972d3ed89e1",
      "client-2": "84616ede-2ebd-4795-8faf-ab653c925c16"
    }
  ]
}
Response examples (200) 
{
  "name": 1000243230,
  "uuid": "299c4896-6fe0-4495-a9a3-26b3004ff755",
  "status": "pending",
  "documents": [
    {
      "name": "Welcome Pack",
      "uuid": "1a5994a9-a105-4f09-aea9-1539c6cdef1f",
      "status": "pending",
      "created_at": "2025-06-17T14:20:20+01:00",
      "updated_at": "2025-06-17T14:20:20+01:00",
      "alphatrust_id": 1000455612
    }
  ],
  "created_at": "2025-06-17T14:20:20+01:00",
  "updated_at": "2025-06-17T14:20:20+01:00",
  "launched_by": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "9e7067bc-042d-4929-9f3f-36480718db87",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-06-17T14:20:20+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-06-17T14:20:20+01:00",
    "with_login": true,
    "inactive_at": "2025-06-17",
    "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-06-17T14:20:20+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-06-17T14:20:20+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-06-17T14:20:20+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-06-17T14:20:20+01:00"
  },
  "participants": [
    {
      "name": "Gareth Thompson",
      "uuid": "e0977f43-5fee-414c-9ee0-17886681f43a",
      "status": "pending",
      "created_at": "2025-06-17T14:20:20+01:00",
      "updated_at": "2025-06-17T14:20:20+01:00",
      "alphatrust_id": 1000145124
    }
  ]
}