Launch document signing

POST /api/v1/document-signing

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.

      Additional properties are allowed.

    • documents array[object]

      Documents of the document signing process.

      Additional properties are allowed.

    • launched_by object

      Account that launched the document signing process.

      Additional properties are allowed.
POST /api/v1/document-signing 
curl \
 -X POST https://api.plannrcrm.com/api/v1/document-signing \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 -d '{"participant_uuids":["fed8c28b-3f64-42b4-920f-e7f78a73a6f3","8d306022-bcc3-4651-af67-1b3654e0adc2"],"document_template_uuids":["8fe2db13-9ab3-4f84-b2a9-ef9982394973","b23b6e0e-e710-4bc7-9131-b3a3dd4f695e"],"document_template_dependants":[{"client-1":"5da1b55f-a38d-4cdc-bc99-504b82e2e1e1","client-2":"e9a9d278-11f9-4512-b0ab-c429fbfa0320"}]}'
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": [
    "fed8c28b-3f64-42b4-920f-e7f78a73a6f3",
    "8d306022-bcc3-4651-af67-1b3654e0adc2"
  ],
  "document_template_uuids": [
    "8fe2db13-9ab3-4f84-b2a9-ef9982394973",
    "b23b6e0e-e710-4bc7-9131-b3a3dd4f695e"
  ],
  "document_template_dependants": [
    {
      "client-1": "5da1b55f-a38d-4cdc-bc99-504b82e2e1e1",
      "client-2": "e9a9d278-11f9-4512-b0ab-c429fbfa0320"
    }
  ]
}
Response examples (200) 
{
  "name": 1000243230,
  "uuid": "77662b99-50e8-487f-82a7-6532f6496d16",
  "status": "pending",
  "documents": [
    {
      "name": "Welcome Pack",
      "uuid": "cfed5f2b-9c0d-4ec1-bf43-fc299765df47",
      "status": "pending",
      "created_at": "2025-01-12T12:55:59+00:00",
      "updated_at": "2025-01-12T12:55:59+00:00",
      "alphatrust_id": 1000455612
    }
  ],
  "created_at": "2025-01-12T12:55:59+00:00",
  "updated_at": "2025-01-12T12:55:59+00:00",
  "launched_by": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "c8516560-6255-433c-96dc-ed3dbb625219",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-01-12T12:55:59+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-01-12T12:55:59+00:00",
    "with_login": true,
    "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-01-12T12:55:59+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-01-12T12:55:59+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2025-01-12T12:55:59+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-01-12T12:55:59+00:00"
  },
  "participants": [
    {
      "name": "Gareth Thompson",
      "uuid": "1b054959-9f6b-46f7-833a-bc10248b62b6",
      "status": "pending",
      "created_at": "2025-01-12T12:55:59+00:00",
      "updated_at": "2025-01-12T12:55:59+00:00",
      "alphatrust_id": 1000145124
    }
  ]
}