Launch document signing Run in API Explorer
Ask AI
Body
-
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.
Additional properties are allowed.
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":["1aecf35e-0e29-4014-8e34-f0904152fd4e","afdc47b1-871e-4cc2-aa50-0772782d8ec8","77f57f3d-8bf2-4cba-854e-bdfdba00aa0c"],"document_template_uuids":["57cec6df-d57b-4d06-a138-668a6a516bcb","5637c003-64e8-4d1b-a3a0-732f45ac8197","8a66a64b-6005-4655-a40d-9a07b1494a16"],"document_template_dependants":{"client-1":"2735cc86-0cc7-4c7c-a219-923b6d82be16","client-2":"5d216d44-8de0-49f4-9bc4-500fdbc0b153"}}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"participant_uuids": [
"1aecf35e-0e29-4014-8e34-f0904152fd4e",
"afdc47b1-871e-4cc2-aa50-0772782d8ec8",
"77f57f3d-8bf2-4cba-854e-bdfdba00aa0c"
],
"document_template_uuids": [
"57cec6df-d57b-4d06-a138-668a6a516bcb",
"5637c003-64e8-4d1b-a3a0-732f45ac8197",
"8a66a64b-6005-4655-a40d-9a07b1494a16"
],
"document_template_dependants": {
"client-1": "2735cc86-0cc7-4c7c-a219-923b6d82be16",
"client-2": "5d216d44-8de0-49f4-9bc4-500fdbc0b153"
}
}
Response examples (200)
{
"uuid": "ad687c90-99bc-4122-94a8-6c8ab1602fd5",
"created_at": "2026-06-29T13:21:56+01:00",
"updated_at": "2026-06-29T13:21:56+01:00",
"name": 1000243230,
"status": "pending",
"participants": [
{
"uuid": "b1eef7eb-6eb2-41bc-9735-7d191fe37c67",
"created_at": "2026-06-29T13:21:56+01:00",
"updated_at": "2026-06-29T13:21:56+01:00",
"alphatrust_id": 1000145124,
"name": "Gareth Thompson",
"status": "pending"
}
],
"documents": [
{
"uuid": "a265f626-6521-4ae2-9b99-ff456f61e738",
"created_at": "2026-06-29T13:21:56+01:00",
"updated_at": "2026-06-29T13:21:56+01:00",
"alphatrust_id": 1000455612,
"name": "Welcome Pack",
"status": "pending"
}
],
"launched_by": {
"uuid": "f763a327-9070-4b3f-95a6-175e339ff30c",
"created_at": "2026-06-29T13:21:56+01:00",
"updated_at": "2026-06-29T13:21:56+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"firm": "App\\Http\\Resources\\FirmResource",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"business_unit": "App\\Http\\Resources\\BusinessUnitResource",
"groups": "App\\Http\\Resources\\GroupResource",
"tags": "App\\Http\\Resources\\TagResource",
"owners": "App\\Http\\Resources\\AccountResource",
"first_contact_date": "2026-06-29T13:21:56+01:00",
"next_review_date": "2026-06-29T13:21:56+01:00",
"previous_review_date": "2026-06-29T13:21:56+01:00",
"anniversary_review_date": "2026-06-29T13:21:56+01:00",
"terms_of_business_at": "2026-06-29T13:21:56+01:00",
"client_agreement_at": "2026-06-29T13:21:56+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"circles": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"inactive_at": "2026-06-29",
"last_interaction_at": "2026-06-29 13:21:56",
"referral_code": "ABC12345",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
}
}