{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Integration"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"integration","__idx":0},"children":["Integration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Signing sessions let you collect legally binding digital signatures on PDF documents through the Embed API. The signing flow is built around two hosted UIs and a flexible session model that supports different levels of automation."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"key-concepts","__idx":1},"children":["Key concepts"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sender UI"]}," — A hosted interface for the person who is ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["requesting"]}," signatures. In the Sender UI the end-user can manage files, add or edit participants, configure invitations, and start the signing session. You create a Sender UI via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /sign/sessions/{session_id}/sender-uis"]}," and redirect the end-user to the returned one-time URL."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sign UI"]}," — A hosted interface for the person who is ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["signing"]}," the document. For manual delivery, each invitation includes a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["signing_url"]},". Opening this URL takes them directly to the Sign UI where they can review the document and sign using one of the allowed signature methods."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"integration-approaches","__idx":2},"children":["Integration approaches"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["There are three main approaches to integrating the signing flow, depending on how much control you want to give your end-users through the hosted Sender UI."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"approach-1-fully-automated-api-only","__idx":3},"children":["Approach 1: Fully automated (API-only)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The most straightforward approach. You prepare everything on your side and create a complete signing session in a single API call. Invitations are sent automatically and you track progress through webhooks."]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"sequenceDiagram\n participant App as Integrator backend\n participant API as Docue API\n participant Signer as Signer (email/SMS)\n\n App ->> API: POST /sign/sessions (files, participants, invitations, webhooks, start: true)\n API -->> App: Session created & started\n API ->> Signer: Invitations sent automatically\n Signer ->> API: Opens signing_url → signs in Sign UI\n API ->> App: Webhook: participant signed\n Note over App,API: Repeat for each participant\n API ->> App: Webhook: session completed\n App ->> API: GET /sign/sessions/{id}/pdf\n API -->> App: Signed PDF\n","diagramHtml":"Signer (email/SMS)Docue APIIntegrator backendSigner (email/SMS)Docue APIIntegrator backendRepeat for each participantPOST /sign/sessions (files, participants, invitations, webhooks, start: true)Session created & startedInvitations sent automaticallyOpens signing_url → signs in Sign UIWebhook: participant signedWebhook: session completedGET /sign/sessions/{id}/pdfSigned PDF","diagramHtmlDark":"Signer (email/SMS)Docue APIIntegrator backendSigner (email/SMS)Docue APIIntegrator backendRepeat for each participantPOST /sign/sessions (files, participants, invitations, webhooks, start: true)Session created & startedInvitations sent automaticallyOpens signing_url → signs in Sign UIWebhook: participant signedWebhook: session completedGET /sign/sessions/{id}/pdfSigned PDF"},"children":["sequenceDiagram\n participant App as Integrator backend\n participant API as Docue API\n participant Signer as Signer (email/SMS)\n\n App ->> API: POST /sign/sessions (files, participants, invitations, webhooks, start: true)\n API -->> App: Session created & started\n API ->> Signer: Invitations sent automatically\n Signer ->> API: Opens signing_url → signs in Sign UI\n API ->> App: Webhook: participant signed\n Note over App,API: Repeat for each participant\n API ->> App: Webhook: session completed\n App ->> API: GET /sign/sessions/{id}/pdf\n API -->> App: Signed PDF\n"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This approach works best when your system already has all the required information (files, participant names, emails, and preferred signing methods)."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"approach-2-prepare-and-let-the-end-user-finalize-sender-ui","__idx":4},"children":["Approach 2: Prepare and let the end-user finalize (Sender UI)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You prepare the file and an initial set of participants via the API, then let the end-user review, adjust, and send invitations through the Sender UI."]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"sequenceDiagram\n participant User as End-user (sender)\n participant App as Integrator backend\n participant API as Docue API\n participant Signer as Signer\n\n App ->> API: POST /sign/sessions (files, participants)\n API -->> App: Session created (pending)\n App ->> API: POST /sign/sessions/{id}/sender-uis\n API -->> App: Sender UI URL\n App ->> User: Redirect to Sender UI\n User ->> User: Reviews participants, configures invitations, starts session\n User ->> App: Redirected back via return_handler\n API ->> Signer: Invitations sent\n Signer ->> API: Signs in Sign UI\n API ->> App: Webhooks: status updates\n","diagramHtml":"SignerDocue APIIntegrator backendEnd-user (sender)SignerDocue APIIntegrator backendEnd-user (sender)POST /sign/sessions (files, participants)Session created (pending)POST /sign/sessions/{id}/sender-uisSender UI URLRedirect to Sender UIReviews participants, configures invitations, starts sessionRedirected back via return_handlerInvitations sentSigns in Sign UIWebhooks: status updates","diagramHtmlDark":"SignerDocue APIIntegrator backendEnd-user (sender)SignerDocue APIIntegrator backendEnd-user (sender)POST /sign/sessions (files, participants)Session created (pending)POST /sign/sessions/{id}/sender-uisSender UI URLRedirect to Sender UIReviews participants, configures invitations, starts sessionRedirected back via return_handlerInvitations sentSigns in Sign UIWebhooks: status updates"},"children":["sequenceDiagram\n participant User as End-user (sender)\n participant App as Integrator backend\n participant API as Docue API\n participant Signer as Signer\n\n App ->> API: POST /sign/sessions (files, participants)\n API -->> App: Session created (pending)\n App ->> API: POST /sign/sessions/{id}/sender-uis\n API -->> App: Sender UI URL\n App ->> User: Redirect to Sender UI\n User ->> User: Reviews participants, configures invitations, starts session\n User ->> App: Redirected back via return_handler\n API ->> Signer: Invitations sent\n Signer ->> API: Signs in Sign UI\n API ->> App: Webhooks: status updates\n"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["configuration.editable_parts"]}," option when creating the Sender UI to control which parts the end-user can modify (e.g. only ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["participants"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["invitations"]},", but not ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["files"]},")."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"approach-3-end-user-drives-everything-sender-ui","__idx":5},"children":["Approach 3: End-user drives everything (Sender UI)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You create an empty signing session and let the end-user upload files, add participants, and manage the entire process through the Sender UI."]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"sequenceDiagram\n participant User as End-user (sender)\n participant App as Integrator backend\n participant API as Docue API\n participant Signer as Signer\n\n App ->> API: POST /sign/sessions (empty or minimal)\n API -->> App: Session created (pending)\n App ->> API: POST /sign/sessions/{id}/sender-uis\n API -->> App: Sender UI URL\n App ->> User: Redirect to Sender UI\n User ->> User: Uploads files, adds participants, configures invitations, starts session\n User ->> App: Redirected back via return_handler\n API ->> Signer: Invitations sent\n Signer ->> API: Signs in Sign UI\n API ->> App: Webhooks: status updates\n","diagramHtml":"SignerDocue APIIntegrator backendEnd-user (sender)SignerDocue APIIntegrator backendEnd-user (sender)POST /sign/sessions (empty or minimal)Session created (pending)POST /sign/sessions/{id}/sender-uisSender UI URLRedirect to Sender UIUploads files, adds participants, configures invitations, starts sessionRedirected back via return_handlerInvitations sentSigns in Sign UIWebhooks: status updates","diagramHtmlDark":"SignerDocue APIIntegrator backendEnd-user (sender)SignerDocue APIIntegrator backendEnd-user (sender)POST /sign/sessions (empty or minimal)Session created (pending)POST /sign/sessions/{id}/sender-uisSender UI URLRedirect to Sender UIUploads files, adds participants, configures invitations, starts sessionRedirected back via return_handlerInvitations sentSigns in Sign UIWebhooks: status updates"},"children":["sequenceDiagram\n participant User as End-user (sender)\n participant App as Integrator backend\n participant API as Docue API\n participant Signer as Signer\n\n App ->> API: POST /sign/sessions (empty or minimal)\n API -->> App: Session created (pending)\n App ->> API: POST /sign/sessions/{id}/sender-uis\n API -->> App: Sender UI URL\n App ->> User: Redirect to Sender UI\n User ->> User: Uploads files, adds participants, configures invitations, starts session\n User ->> App: Redirected back via return_handler\n API ->> Signer: Invitations sent\n Signer ->> API: Signs in Sign UI\n API ->> App: Webhooks: status updates\n"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"session-lifecycle","__idx":6},"children":["Session lifecycle"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A signing session moves through the following states:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pending"]}]}," — The session has been created. Files and participants can still be added or removed. Participants cannot access the Sign UI yet."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["started"]}]}," — The session is locked. No files or new participants can be added. Participants can now access their ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["signing_url"]}," and sign the document. Invitations can be sent."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["completed"]}]}," — All participants have signed. The audit log and signing evidence are packaged into the PDF at this point. ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/embed-api/signing/signed-document"},"children":["Download the final document"]}," once, after the status changes."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cancelled"]}]}," — Signing was cancelled after the session started. Participants still can access the document, but can not add new signatures."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expired"]}]}," — The session expired before it was completed."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["discarded"]}]}," — The session was discarded before it started."]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Important:"]}," Because the document is digitally signed in sequence, no new participants can be added once the session has been started. The cryptographic signature chain is established when the session starts, so the participant list must be finalized before that point."]}]}]},"headings":[{"value":"Integration","id":"integration","depth":1},{"value":"Key concepts","id":"key-concepts","depth":2},{"value":"Integration approaches","id":"integration-approaches","depth":2},{"value":"Approach 1: Fully automated (API-only)","id":"approach-1-fully-automated-api-only","depth":3},{"value":"Approach 2: Prepare and let the end-user finalize (Sender UI)","id":"approach-2-prepare-and-let-the-end-user-finalize-sender-ui","depth":3},{"value":"Approach 3: End-user drives everything (Sender UI)","id":"approach-3-end-user-drives-everything-sender-ui","depth":3},{"value":"Session lifecycle","id":"session-lifecycle","depth":2}],"frontmatter":{"seo":{"title":"Integration"}},"lastModified":"2026-09-24T11:24:13.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/embed-api/signing/integration","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}