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":["d5e67689-737d-4789-ab99-7300c4e413d6","eb856312-6e5b-4234-b61c-e14cb76b6a65"],"document_template_uuids":["e927418e-e947-4326-9423-0504f1c35cf9","4440133f-853c-4cb3-96c0-183a926a7276"],"document_template_dependants":[{"client-1":"791c9642-f9d5-4eee-87e3-ec092519e3c5","client-2":"0d753331-853e-4418-8b7e-62c35639a113"}]}'
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": [
    "d5e67689-737d-4789-ab99-7300c4e413d6",
    "eb856312-6e5b-4234-b61c-e14cb76b6a65"
  ],
  "document_template_uuids": [
    "e927418e-e947-4326-9423-0504f1c35cf9",
    "4440133f-853c-4cb3-96c0-183a926a7276"
  ],
  "document_template_dependants": [
    {
      "client-1": "791c9642-f9d5-4eee-87e3-ec092519e3c5",
      "client-2": "0d753331-853e-4418-8b7e-62c35639a113"
    }
  ]
}
Response examples (200) 
{
  "name": 1000243230,
  "uuid": "81f703f5-7e82-4aa1-9a58-96089eec7fce",
  "status": "pending",
  "documents": [
    {
      "name": "Welcome Pack",
      "uuid": "534d9e79-cef6-4ed1-93f4-c6552edf1dcb",
      "status": "pending",
      "created_at": "2025-05-09T16:15:58+01:00",
      "updated_at": "2025-05-09T16:15:58+01:00",
      "alphatrust_id": 1000455612
    }
  ],
  "created_at": "2025-05-09T16:15:58+01:00",
  "updated_at": "2025-05-09T16:15:58+01:00",
  "launched_by": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "4ae1079b-a1f4-42a6-beee-fb928810a949",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-05-09T16:15:58+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-05-09T16:15:58+01:00",
    "with_login": true,
    "inactive_at": "2025-05-09",
    "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-05-09T16:15:58+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-05-09T16:15:58+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-05-09T16:15:58+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-05-09T16:15:58+01:00"
  },
  "participants": [
    {
      "name": "Gareth Thompson",
      "uuid": "c3bb0d69-c85d-414b-8a99-08161229c91a",
      "status": "pending",
      "created_at": "2025-05-09T16:15:58+01:00",
      "updated_at": "2025-05-09T16:15:58+01:00",
      "alphatrust_id": 1000145124
    }
  ]
}