Body
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.
-
Array document template UUIDs to be added as adhoc documents of the document signing process. Required without document_pack.
-
Array variable dependant models that are needed for variable replacing across all documents that are provided.
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":["9bed52c7-9b33-4067-b385-f5534bd10164","95f13106-3098-4f70-9e2b-b5ef325e388a"],"document_template_uuids":["622336b5-f035-4216-8917-6a2e71dc7f8c","dbf65115-6e2d-4f8a-98be-dd4384509045"],"document_template_dependants":[{"client-1":"ac7a21e8-bbdb-4ad5-965a-355c49c45171","client-2":"27103c77-e0bd-4737-8b40-e1217eaeaba5"}]}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"participant_uuids": [
"9bed52c7-9b33-4067-b385-f5534bd10164",
"95f13106-3098-4f70-9e2b-b5ef325e388a"
],
"document_template_uuids": [
"622336b5-f035-4216-8917-6a2e71dc7f8c",
"dbf65115-6e2d-4f8a-98be-dd4384509045"
],
"document_template_dependants": [
{
"client-1": "ac7a21e8-bbdb-4ad5-965a-355c49c45171",
"client-2": "27103c77-e0bd-4737-8b40-e1217eaeaba5"
}
]
}
Response examples (200)
{
"name": 1000243230,
"uuid": "d1427f2c-3601-4fbe-9b73-8a2249cdc8a2",
"status": "pending",
"documents": [
{
"name": "Welcome Pack",
"uuid": "fe6ae07c-f0eb-4ff4-9742-4675b346df2f",
"status": "pending",
"created_at": "2025-09-26T13:23:33+01:00",
"updated_at": "2025-09-26T13:23:33+01:00",
"alphatrust_id": 1000455612
}
],
"created_at": "2025-09-26T13:23:33+01:00",
"updated_at": "2025-09-26T13:23:33+01:00",
"launched_by": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "c5c3680a-4cef-4691-9697-1adf15f6e7d2",
"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-09-26T13:23:33+01:00",
"first_name": "Gareth",
"updated_at": "2025-09-26T13:23:33+01:00",
"with_login": true,
"inactive_at": "2025-09-26",
"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-09-26T13:23:33+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-09-26T13:23:33+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-09-26T13:23:33+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-09-26T13:23:33+01:00"
},
"participants": [
{
"name": "Gareth Thompson",
"uuid": "e724eadc-1fa1-4f0e-8992-3a1323706f8d",
"status": "pending",
"created_at": "2025-09-26T13:23:33+01:00",
"updated_at": "2025-09-26T13:23:33+01:00",
"alphatrust_id": 1000145124
}
]
}