DocuSeal

DocuSeal

This connector works with DocuSeal, the open-source document signing platform, through its REST API: on DocuSeal Cloud (https://api.docuseal.com, EU https://api.docuseal.eu) or on your own server (https://<your host>/api). It lists and reads templates, submissions (signature requests) and submitters (signers), gets signed documents and completion events, sends templates or one-off PDFs for signature, updates signers and submissions, and creates, clones, updates and archives templates.

Setup (2 minutes)

1. Copy your API key: on DocuSeal Cloud at https://console.docuseal.com/api (EU accounts: https://console.docuseal.eu/api); on a self-hosted DocuSeal under Settings → API (https://<your host>/settings/api).
2. Paste it into DOCUSEAL_API_KEY. It is sent in the X-Auth-Token header and acts as the user it belongs to.
3. Set DOCUSEAL_API_URL: https://api.docuseal.com (Cloud, US), https://api.docuseal.eu (Cloud, EU) or https://<your host>/api for a self-hosted instance (the same address you open DocuSeal at, plus /api). No trailing slash.
4. Run docuseal_list_templates to check.

Test mode: DocuSeal Cloud has a test mode with its own API key (switch it in the console); test submissions are not legally binding and are free. Use the test key while you try the connector.

Workflow

• Templates: docuseal_list_templates (search by name with q, by folder or external_id), docuseal_get_template for roles and field names.
• Send for signature: docuseal_create_submission with the template id and one submitter per role (role must match the template's role names, e.g. "First Party"); pre-fill fields with values keyed by field name. docuseal_create_submissions_from_emails is the quick way for single-signer templates. docuseal_create_submission_from_pdf sends a one-off PDF without a template.
• Track: docuseal_list_submissions (filter by status, template_id, signer q), docuseal_get_submission (each submitter's status and timestamps, event history), docuseal_list_submitters, docuseal_get_submitter.
• Signed documents: docuseal_get_submission_documents (PDF links, merge for one file); combined_document_url and audit_log_url in the submission.
• What was signed lately: docuseal_list_form_completed_events (each signer who finished) and docuseal_list_submission_completed_events (fully signed submissions).
• Follow up: docuseal_update_submitter (fix an email, re-send the invitation with send_email, pre-fill values), docuseal_update_submission (rename, change expiry, archive or restore), docuseal_archive_submission.
• Build templates: docuseal_create_template_from_pdf, docuseal_create_template_from_docx, docuseal_create_template_from_html, docuseal_clone_template, docuseal_update_template, docuseal_archive_template.

Sending is real: confirm first. Creating a submission emails the signers (unless send_email is false), completed: true signs on someone's behalf, and archiving stops signing links. Show the user the template or document, the signers with their roles and the message, and send only after a clear yes.

Files: documents[].file takes a public URL (DocuSeal downloads it) or Base64 content. Fields come from text tags in the document, e.g. {{Full Name;role=Signer;type=text}}, {{Sign here;role=Signer;type=signature}}, {{Date;role=Signer;type=date}} (types: heading, text, signature, initials, date, number, image, checkbox, multiple, file, radio, select, cells, stamp, payment, phone, verification, kba, strikethrough), or from fields with exact areas (page, x, y, w, h as fractions of the page). HTML templates use tags such as <text-field name="Name" role="Signer"></text-field>.

Reading the answers: ids are integers. Times are ISO 8601 with time zone (2026-10-30T14:05:00.000Z). Submission status: pending, completed, declined, expired. Submitter status: awaiting (not yet invited, signing order), sent, opened, completed, declined. embed_src is the signer's personal signing link. Document URLs are temporary.

Paging: lists return {"data": [...], "pagination": {"count", "next", "prev"}}, newest first, 10 items by default (limit up to 100). Pass pagination.next as after for the next, older page; stop when next is null. The completed-event tools page the same way by completion time (Unix seconds).

Errors: 401 "Not authenticated" for a wrong or missing API key (or a Cloud key on the EU host and vice versa); 403 when the key's user may not see the item; 404 unknown id; 422 with an error message for invalid input (unknown role name, missing email, archived template, template without fields, unreadable file); 429 "Too many requests" when the rate limit is reached. Self-hosted instances answer 404 for every call when /api is missing from DOCUSEAL_API_URL.