{"items":[{"type":"group","label":"Docue for Developers","items":[{"type":"link","fsPath":"index.md","metadata":{"type":"markdown"},"label":"Overview","link":"/","routeSlug":"/"}]},{"type":"group","label":"Platform API","items":[{"type":"link","fsPath":"platform-api/index.md","metadata":{"type":"markdown"},"label":"Getting started","link":"/platform-api","routeSlug":"/platform-api"},{"type":"link","label":"API Reference","link":"/platform-api/openapi","routeSlug":"/platform-api/openapi"},{"type":"link","label":"Authentication","link":"/platform-api/openapi/section/authentication","routeSlug":"/platform-api/openapi/section/authentication"},{"type":"group","label":"Workspace","link":"/platform-api/openapi/workspace","routeSlug":"/platform-api/openapi/workspace","items":[{"label":"Get current workspace","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/workspace/getworkspace","routeSlug":"/platform-api/openapi/workspace/getworkspace","metadata":{"seo":{"title":"Get current workspace","description":"Returns details about the workspace associated with the authenticated API key. Use this endpoint to verify that your API authentication is configured correctly."}},"httpPath":"/public/v2/workspace"},{"label":"List workspace users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/workspace/getworkspaceusers","routeSlug":"/platform-api/openapi/workspace/getworkspaceusers","metadata":{"seo":{"title":"List workspace users","description":"Fetch the users belonging to the authenticated workspace. Use a user's id when assigning them as a document owner."}},"httpPath":"/public/v2/workspace/users"}]},{"type":"group","label":"Builder","link":"/platform-api/openapi/builder","routeSlug":"/platform-api/openapi/builder","items":[{"label":"List templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/builder/gettemplates","routeSlug":"/platform-api/openapi/builder/gettemplates","metadata":{"seo":{"title":"List templates","description":"Fetch the templates available to the authenticated workspace."}},"httpPath":"/public/v2/templates"},{"label":"Create document from template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/builder/starttemplate","routeSlug":"/platform-api/openapi/builder/starttemplate","metadata":{"seo":{"title":"Create document from template","description":"Start a new document from the given template. The document is created in the specified folder with the provided title and becomes available in draft stage in your workspace at https://app.docue.com."}},"httpPath":"/public/v2/templates/{id}/start"},{"label":"Get contract builder state","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/builder/getcontractbuilderstate","routeSlug":"/platform-api/openapi/builder/getcontractbuilderstate","metadata":{"seo":{"title":"Get contract builder state","description":"Retrieve a contract's builder state. The builder state contains the document's field values, sections, and appearance settings, and reflects the same data the builder UI works with."}},"httpPath":"/public/v2/contracts/{id}/builder/state"},{"label":"Update contract builder state and appearance","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/builder/patchcontractbuilderstate","routeSlug":"/platform-api/openapi/builder/patchcontractbuilderstate","metadata":{"seo":{"title":"Update contract builder state and appearance","description":"Update a contract's builder state values and appearance using JSON Patch (RFC 6902) operations. Use this to programmatically fill in field values, manage sections, and adjust the document's appearance."}},"httpPath":"/public/v2/contracts/{id}/builder/state"},{"label":"Get contract builder value schema","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/builder/getcontractbuildervalueschema","routeSlug":"/platform-api/openapi/builder/getcontractbuildervalueschema","metadata":{"seo":{"title":"Get contract builder value schema","description":"Experimental. This endpoint is experimental and may change at any time without prior notice. Avoid relying on its exact response shape in production."}},"httpPath":"/public/v2/contracts/{id}/builder/value-schema"},{"label":"Get contract builder sections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/builder/getcontractbuildersections","routeSlug":"/platform-api/openapi/builder/getcontractbuildersections","metadata":{"seo":{"title":"Get contract builder sections","description":"Experimental. This endpoint is experimental and may change at any time without prior notice. Avoid relying on its exact response shape in production."}},"httpPath":"/public/v2/contracts/{id}/builder/sections"},{"label":"Finalize contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/builder/finalizecontractbuilder","routeSlug":"/platform-api/openapi/builder/finalizecontractbuilder","metadata":{"seo":{"title":"Finalize contract","description":"Finalize a contract's builder draft. Finalizing locks the document content and moves the contract out of the editable created stage so it can be signed."}},"httpPath":"/public/v2/contracts/{id}/builder/finalize"}]},{"type":"group","label":"Signing","link":"/platform-api/openapi/signing","routeSlug":"/platform-api/openapi/signing","items":[{"label":"Send PDF for signing","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/signing/createcontractforsigning","routeSlug":"/platform-api/openapi/signing/createcontractforsigning","metadata":{"seo":{"title":"Send PDF for signing","description":"Upload a PDF document and send it out for electronic signing in a single request. The document is created in the specified folder, the signees (parties) are created as signatures, and the contract is finalized so it is ready to be signed."}},"httpPath":"/public/v2/contracts"}]},{"type":"group","label":"Documents","link":"/platform-api/openapi/documents","routeSlug":"/platform-api/openapi/documents","items":[{"label":"List documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/documents/getdocuments","routeSlug":"/platform-api/openapi/documents/getdocuments","metadata":{"seo":{"title":"List documents","description":"Fetch the documents available to the authenticated workspace."}},"httpPath":"/public/v2/documents"},{"label":"Upload documents","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/documents/createdocuments","routeSlug":"/platform-api/openapi/documents/createdocuments","metadata":{"seo":{"title":"Upload documents","description":"Upload one or more files to the workspace archive as new documents. All documents in a request are created in the same folder, and up to 5 documents can be created per request. The documents appear in the archive at https://app.docue.com right away."}},"httpPath":"/public/v2/documents"},{"label":"Get document","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/documents/getdocument","routeSlug":"/platform-api/openapi/documents/getdocument","metadata":{"seo":{"title":"Get document","description":"Fetch a single document by its identifier."}},"httpPath":"/public/v2/documents/{id}"},{"label":"Update document","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/documents/updatedocument","routeSlug":"/platform-api/openapi/documents/updatedocument","metadata":{"seo":{"title":"Update document","description":"Update one or more document properties. Only fields included in the request are changed."}},"httpPath":"/public/v2/documents/{id}"},{"label":"Delete document","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/documents/deletedocument","routeSlug":"/platform-api/openapi/documents/deletedocument","metadata":{"seo":{"title":"Delete document","description":"Delete a document from the workspace archive. If the document has an active signing process or drafting session, it will be cancelled too."}},"httpPath":"/public/v2/documents/{id}"},{"label":"List document tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/documents/getdocumenttags","routeSlug":"/platform-api/openapi/documents/getdocumenttags","metadata":{"seo":{"title":"List document tags","description":"Fetch all tags assigned to a document. A document without tags returns an empty data array."}},"httpPath":"/public/v2/documents/{id}/tags"},{"label":"Set document tags","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/documents/setdocumenttags","routeSlug":"/platform-api/openapi/documents/setdocumenttags","metadata":{"seo":{"title":"Set document tags","description":"Replace all tags assigned to a document with the supplied list. Send the complete desired list on every request; tags that are not included are removed. Send an empty list to remove all tags."}},"httpPath":"/public/v2/documents/{id}/tags"},{"label":"Download document","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/documents/downloaddocument","routeSlug":"/platform-api/openapi/documents/downloaddocument","metadata":{"seo":{"title":"Download document","description":"Download the file content of a document. The response is the document's binary content streamed back with a Content-Disposition header carrying the file name. The content type depends on the document; documents created through the builder are returned as PDF."}},"httpPath":"/public/v2/documents/{id}/download"}]},{"type":"group","label":"Folders","link":"/platform-api/openapi/folders","routeSlug":"/platform-api/openapi/folders","items":[{"label":"List folders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/folders/getfolders","routeSlug":"/platform-api/openapi/folders/getfolders","metadata":{"seo":{"title":"List folders","description":"Fetch the folders available to the authenticated workspace."}},"httpPath":"/public/v2/folders"},{"label":"Create folder","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/folders/createfolder","routeSlug":"/platform-api/openapi/folders/createfolder","metadata":{"seo":{"title":"Create folder","description":"Create a new folder in the workspace archive."}},"httpPath":"/public/v2/folders"},{"label":"Get folder","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/folders/getfolder","routeSlug":"/platform-api/openapi/folders/getfolder","metadata":{"seo":{"title":"Get folder","description":"Fetch a single folder by its identifier."}},"httpPath":"/public/v2/folders/{id}"},{"label":"Update folder","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/folders/updatefolder","routeSlug":"/platform-api/openapi/folders/updatefolder","metadata":{"seo":{"title":"Update folder","description":"Update an existing folder. Currently only the folder name can be updated."}},"httpPath":"/public/v2/folders/{id}"},{"label":"Delete folder","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/folders/deletefolder","routeSlug":"/platform-api/openapi/folders/deletefolder","metadata":{"seo":{"title":"Delete folder","description":"Delete a folder from the workspace archive. All documents stored in the folder, including all subfolders and the documents within them, will be deleted."}},"httpPath":"/public/v2/folders/{id}"}]},{"type":"group","label":"Metadata","link":"/platform-api/openapi/metadata","routeSlug":"/platform-api/openapi/metadata","items":[{"label":"List custom properties","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/metadata/getproperties","routeSlug":"/platform-api/openapi/metadata/getproperties","metadata":{"seo":{"title":"List custom properties","description":"List the custom metadata properties configured for the workspace. Includes both user-defined properties and built-in system properties."}},"httpPath":"/public/v2/metadata/properties"},{"label":"Create custom property","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/metadata/createproperty","routeSlug":"/platform-api/openapi/metadata/createproperty","metadata":{"seo":{"title":"Create custom property","description":"Define a new custom metadata property for the workspace. The property can then be given a value on any document in the workspace."}},"httpPath":"/public/v2/metadata/properties"},{"label":"Get custom property","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/metadata/getproperty","routeSlug":"/platform-api/openapi/metadata/getproperty","metadata":{"seo":{"title":"Get custom property","description":"Get custom property"}},"httpPath":"/public/v2/metadata/properties/{id}"},{"label":"Update custom property","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/metadata/updateproperty","routeSlug":"/platform-api/openapi/metadata/updateproperty","metadata":{"seo":{"title":"Update custom property","description":"Update the title and description of a custom property. The name and data_type cannot be changed. system properties cannot be modified."}},"httpPath":"/public/v2/metadata/properties/{id}"},{"label":"Delete custom property","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/metadata/deleteproperty","routeSlug":"/platform-api/openapi/metadata/deleteproperty","metadata":{"seo":{"title":"Delete custom property","description":"Delete a custom property. This also removes the property's values from every document. system properties cannot be deleted."}},"httpPath":"/public/v2/metadata/properties/{id}"},{"label":"List document property values","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/metadata/getdocumentpropertyvalues","routeSlug":"/platform-api/openapi/metadata/getdocumentpropertyvalues","metadata":{"seo":{"title":"List document property values","description":"List the document's values for a custom property. A document has at most one value per property, so the list is empty or has one item."}},"httpPath":"/public/v2/documents/{id}/properties/{propertyId}/values"},{"label":"Set document property value","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/metadata/createdocumentpropertyvalue","routeSlug":"/platform-api/openapi/metadata/createdocumentpropertyvalue","metadata":{"seo":{"title":"Set document property value","description":"Set the value of a custom property on a document. Returns 409 if the document already has a value for the property; update it with Update document property value instead."}},"httpPath":"/public/v2/documents/{id}/properties/{propertyId}/values"},{"label":"Update document property value","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/metadata/updatedocumentpropertyvalue","routeSlug":"/platform-api/openapi/metadata/updatedocumentpropertyvalue","metadata":{"seo":{"title":"Update document property value","description":"Change the value of a custom property on a document."}},"httpPath":"/public/v2/documents/{id}/properties/{propertyId}/values/{valueId}"},{"label":"Remove document property value","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/metadata/deletedocumentpropertyvalue","routeSlug":"/platform-api/openapi/metadata/deletedocumentpropertyvalue","metadata":{"seo":{"title":"Remove document property value","description":"Remove document property value"}},"httpPath":"/public/v2/documents/{id}/properties/{propertyId}/values/{valueId}"}]},{"type":"group","label":"Webhooks","link":"/platform-api/openapi/webhooks","routeSlug":"/platform-api/openapi/webhooks","items":[{"label":"List webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/webhooks/getwebhooks","routeSlug":"/platform-api/openapi/webhooks/getwebhooks","metadata":{"seo":{"title":"List webhooks","description":"Fetch the webhooks registered to the authenticated workspace."}},"httpPath":"/public/v2/webhooks"},{"label":"Create webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/webhooks/createwebhook","routeSlug":"/platform-api/openapi/webhooks/createwebhook","metadata":{"seo":{"title":"Create webhook","description":"Register a new webhook for the workspace. Provide the events the webhook should listen to in accepted_events, and one or more endpoints that receive the deliveries."}},"httpPath":"/public/v2/webhooks"},{"label":"Update webhook","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/webhooks/updatewebhook","routeSlug":"/platform-api/openapi/webhooks/updatewebhook","metadata":{"seo":{"title":"Update webhook","description":"Update an existing webhook. Only the fields included in the request are changed; omitted fields are left untouched."}},"httpPath":"/public/v2/webhooks/{id}"},{"label":"Delete webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/webhooks/deletewebhook","routeSlug":"/platform-api/openapi/webhooks/deletewebhook","metadata":{"seo":{"title":"Delete webhook","description":"Delete a webhook and all of its endpoints from the workspace. The webhook stops receiving event deliveries immediately."}},"httpPath":"/public/v2/webhooks/{id}"},{"label":"Test webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/platform-api/openapi/webhooks/testwebhook","routeSlug":"/platform-api/openapi/webhooks/testwebhook","metadata":{"seo":{"title":"Test webhook","description":"Send a test delivery to the webhook's endpoints. The given document is used to build a document-updated event, which is then dispatched to the webhook so you can verify that your endpoints receive and process deliveries correctly."}},"httpPath":"/public/v2/webhooks/{id}/test/{documentId}"}]}]},{"type":"group","label":"Embed API","items":[{"type":"link","fsPath":"embed-api/index.md","metadata":{"type":"markdown"},"label":"Getting started","link":"/embed-api","routeSlug":"/embed-api"},{"type":"group","fsPath":"embed-api/legal-engine/index.md","metadata":{"type":"markdown"},"label":"Legal Engine","link":"/embed-api/legal-engine","routeSlug":"/embed-api/legal-engine","items":[{"type":"link","fsPath":"embed-api/legal-engine/integration.md","metadata":{"type":"markdown"},"label":"Integration","link":"/embed-api/legal-engine/integration","routeSlug":"/embed-api/legal-engine/integration"},{"type":"link","fsPath":"embed-api/legal-engine/trial-mode.md","metadata":{"type":"markdown"},"label":"Trial mode","link":"/embed-api/legal-engine/trial-mode","routeSlug":"/embed-api/legal-engine/trial-mode"},{"type":"link","fsPath":"embed-api/legal-engine/finalize-confirmation.md","metadata":{"type":"markdown"},"label":"Finalize confirmation","link":"/embed-api/legal-engine/finalize-confirmation","routeSlug":"/embed-api/legal-engine/finalize-confirmation"},{"type":"link","fsPath":"embed-api/legal-engine/duplication.md","metadata":{"type":"markdown"},"label":"Duplication","link":"/embed-api/legal-engine/duplication","routeSlug":"/embed-api/legal-engine/duplication"},{"type":"link","fsPath":"embed-api/legal-engine/document-state.md","metadata":{"type":"markdown"},"label":"Updating document state","link":"/embed-api/legal-engine/document-state","routeSlug":"/embed-api/legal-engine/document-state"},{"type":"link","fsPath":"embed-api/legal-engine/white-labeling.md","metadata":{"type":"markdown"},"label":"White-labeling","link":"/embed-api/legal-engine/white-labeling","routeSlug":"/embed-api/legal-engine/white-labeling"},{"type":"link","fsPath":"embed-api/legal-engine/pricing.md","metadata":{"type":"markdown"},"label":"Pricing","link":"/embed-api/legal-engine/pricing","routeSlug":"/embed-api/legal-engine/pricing"},{"type":"link","fsPath":"embed-api/legal-engine/architectural-notes.md","metadata":{"type":"markdown"},"label":"Architectural notes","link":"/embed-api/legal-engine/architectural-notes","routeSlug":"/embed-api/legal-engine/architectural-notes"}]},{"type":"group","fsPath":"embed-api/signing/index.md","metadata":{"type":"markdown"},"label":"Sign Engine","link":"/embed-api/signing","routeSlug":"/embed-api/signing","items":[{"type":"link","fsPath":"embed-api/signing/integration.md","metadata":{"type":"markdown"},"label":"Integration","link":"/embed-api/signing/integration","routeSlug":"/embed-api/signing/integration"},{"type":"link","fsPath":"embed-api/signing/invitations.md","metadata":{"type":"markdown"},"label":"Invitations","link":"/embed-api/signing/invitations","routeSlug":"/embed-api/signing/invitations"},{"type":"link","fsPath":"embed-api/signing/webhooks.md","metadata":{"type":"markdown"},"label":"Webhooks","link":"/embed-api/signing/webhooks","routeSlug":"/embed-api/signing/webhooks"},{"type":"link","fsPath":"embed-api/signing/audit-log.md","metadata":{"type":"markdown"},"label":"Audit log","link":"/embed-api/signing/audit-log","routeSlug":"/embed-api/signing/audit-log"},{"type":"link","fsPath":"embed-api/signing/signed-document.md","metadata":{"type":"markdown"},"label":"Retrieving the signed document","link":"/embed-api/signing/signed-document","routeSlug":"/embed-api/signing/signed-document"},{"type":"link","fsPath":"embed-api/signing/custom-domains.md","metadata":{"type":"markdown"},"label":"Custom domains","link":"/embed-api/signing/custom-domains","routeSlug":"/embed-api/signing/custom-domains"}]},{"type":"group","label":"API Reference","items":[{"type":"link","label":"Embed API","link":"/embed-api/openapi","routeSlug":"/embed-api/openapi"},{"type":"link","label":"Authentication","link":"/embed-api/openapi/section/authentication","routeSlug":"/embed-api/openapi/section/authentication"},{"type":"link","label":"Base URLs","link":"/embed-api/openapi/section/base-urls","routeSlug":"/embed-api/openapi/section/base-urls"},{"type":"group","label":"Workspaces","link":"/embed-api/openapi/workspaces","routeSlug":"/embed-api/openapi/workspaces","items":[{"label":"Get current workspace","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/workspaces/getcurrentworkspace","routeSlug":"/embed-api/openapi/workspaces/getcurrentworkspace","metadata":{"seo":{"title":"Get current workspace","description":"Get current workspace"}},"httpPath":"/api/workspaces/current"}]},{"type":"group","label":"Templates","link":"/embed-api/openapi/templates","routeSlug":"/embed-api/openapi/templates","items":[{"label":"List templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/templates/gettemplates","routeSlug":"/embed-api/openapi/templates/gettemplates","metadata":{"seo":{"title":"List templates","description":"Fetch templates available for the authenticated workspace."}},"httpPath":"/api/templates"},{"label":"List template collections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/templates/gettemplatecollections","routeSlug":"/embed-api/openapi/templates/gettemplatecollections","metadata":{"seo":{"title":"List template collections","description":"Fetch the available template collections."}},"httpPath":"/api/template-collections"},{"label":"Get a single template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/templates/gettemplatebyid","routeSlug":"/embed-api/openapi/templates/gettemplatebyid","metadata":{"seo":{"title":"Get a single template","description":"Fetch one template by ID."}},"httpPath":"/api/templates/{template_id}"}]},{"type":"group","label":"Template browser","link":"/embed-api/openapi/template-browser","routeSlug":"/embed-api/openapi/template-browser","items":[{"label":"Create a new browser session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/template-browser/createbrowsersession","routeSlug":"/embed-api/openapi/template-browser/createbrowsersession","metadata":{"seo":{"title":"Create a new browser session","description":"To use our template browser for selecting the correct template, create a new browser session and redirect the end user to our app. Our app will then redirect the user back to your app to the URL defined in the handlers."}},"httpPath":"/api/browser/sessions"},{"label":"Retrieve details of existing browser session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/template-browser/getbrowsersession","routeSlug":"/embed-api/openapi/template-browser/getbrowsersession","metadata":{"seo":{"title":"Retrieve details of existing browser session","description":"Returns details of the existing browser session. This information can serve as the source of truth when the user is redirected to your success handler."}},"httpPath":"/api/browser/sessions/{session_id}"},{"label":"Delete browser session","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/template-browser/deletebrowsersession","routeSlug":"/embed-api/openapi/template-browser/deletebrowsersession","metadata":{"seo":{"title":"Delete browser session","description":"Invalidates the browser session. The session remains accessible through the API for a limited time before it is permanently deleted. If the end user is still viewing the page, they will be redirected to the delete handler URL you specified."}},"httpPath":"/api/browser/sessions/{session_id}"}]},{"type":"group","label":"Builder","link":"/embed-api/openapi/builder","routeSlug":"/embed-api/openapi/builder","items":[{"label":"Create a new builder session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/builder/createbuildersession","routeSlug":"/embed-api/openapi/builder/createbuildersession","metadata":{"seo":{"title":"Create a new builder session","description":"A builder session is required to start drafting a document in the Builder through the Embed API. Each session is isolated and contains all document-related data. Once the session ends, all data is deleted from our servers."}},"httpPath":"/api/builder/sessions"},{"label":"Retrieve details of existing builder session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/builder/getbuildersession","routeSlug":"/embed-api/openapi/builder/getbuildersession","metadata":{"seo":{"title":"Retrieve details of existing builder session","description":"Returns details of the existing builder session."}},"httpPath":"/api/builder/sessions/{session_id}"},{"label":"Update existing builder session","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/builder/updatebuildersession","routeSlug":"/embed-api/openapi/builder/updatebuildersession","metadata":{"seo":{"title":"Update existing builder session","description":"Updates mutable builder session settings."}},"httpPath":"/api/builder/sessions/{session_id}"},{"label":"Delete builder session","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/builder/deletebuildersession","routeSlug":"/embed-api/openapi/builder/deletebuildersession","metadata":{"seo":{"title":"Delete builder session","description":"Invalidates the builder session. The session is no longer accessible via the API after deletion. If the end user is still in the builder, they are redirected to the delete handler URL you provided when creating the session."}},"httpPath":"/api/builder/sessions/{session_id}"},{"label":"Get contract state and signees","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/builder/getbuildersessioncontract","routeSlug":"/embed-api/openapi/builder/getbuildersessioncontract","metadata":{"seo":{"title":"Get contract state and signees","description":"Get contract's state and list of signees."}},"httpPath":"/api/builder/sessions/{session_id}/contract"},{"label":"Update contract state and appearance","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/builder/patchbuildersessioncontract","routeSlug":"/embed-api/openapi/builder/patchbuildersessioncontract","metadata":{"seo":{"title":"Update contract state and appearance","description":"Update the contract's state values and appearance using JSON Patch (RFC 6902) operations.The available operations depend on the path, as does the value. Operations are applied sequentially in the order they appear, so later operations can build on the result of earlier ones."}},"httpPath":"/api/builder/sessions/{session_id}/contract"},{"label":"Finalize contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/builder/finalizebuildersessioncontract","routeSlug":"/embed-api/openapi/builder/finalizebuildersessioncontract","metadata":{"seo":{"title":"Finalize contract","description":"Finalize the current builder session contract. Once finalized, the document becomes read-only and can no longer be patched. The document PDF and HTML can still be downloaded."}},"httpPath":"/api/builder/sessions/{session_id}/contract/finalize"},{"label":"Unfinalize contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/builder/unfinalizebuildersessioncontract","routeSlug":"/embed-api/openapi/builder/unfinalizebuildersessioncontract","metadata":{"seo":{"title":"Unfinalize contract","description":"Revert a finalized builder session contract back to a pending (editable) state. Once unfinalized, the document can be patched again and the end-user can continue drafting."}},"httpPath":"/api/builder/sessions/{session_id}/contract/unfinalize"},{"label":"Get HTML","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/builder/getbuildersessionhtml","routeSlug":"/embed-api/openapi/builder/getbuildersessionhtml","metadata":{"seo":{"title":"Get HTML","description":"Retrieve the rendered HTML of the builder session document. This matches the PDF contents but in HTML format for previewing or custom rendering flows."}},"httpPath":"/api/builder/sessions/{session_id}/html"},{"label":"Get PDF","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/builder/getbuildersessionpdf","routeSlug":"/embed-api/openapi/builder/getbuildersessionpdf","metadata":{"seo":{"title":"Get PDF","description":"Get rendered PDF for the builder session."}},"httpPath":"/api/builder/sessions/{session_id}/pdf"},{"label":"Add new participant to existing session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/builder/addparticipanttobuildersession","routeSlug":"/embed-api/openapi/builder/addparticipanttobuildersession","metadata":{"seo":{"title":"Add new participant to existing session","description":"Add a new participant to an existing Builder session."}},"httpPath":"/api/builder/sessions/{session_id}/participants"},{"label":"Re-authenticate existing participant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/builder/reauthenticateparticipant","routeSlug":"/embed-api/openapi/builder/reauthenticateparticipant","metadata":{"seo":{"title":"Re-authenticate existing participant","description":"If you want to re-authenticate an existing participant in an ongoing Builder session, you can use this endpoint."}},"httpPath":"/api/builder/sessions/{session_id}/participants/{participant_id}/authenticate"},{"label":"Export builder session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/builder/exportbuildersession","routeSlug":"/embed-api/openapi/builder/exportbuildersession","metadata":{"seo":{"title":"Export builder session","description":"Export a builder session as a ZIP file so you can save it and later create a new draftwith import."}},"httpPath":"/api/builder/sessions/{session_id}/export"},{"label":"Import builder session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/builder/importbuildersession","routeSlug":"/embed-api/openapi/builder/importbuildersession","metadata":{"seo":{"title":"Import builder session","description":"Import a previously exported builder session ZIP archive and create a new builder session from it."}},"httpPath":"/api/builder/sessions/import"}]},{"type":"group","label":"Signing","link":"/embed-api/openapi/signing","routeSlug":"/embed-api/openapi/signing","items":[{"label":"Create a signing session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/signing/createsigningsession","routeSlug":"/embed-api/openapi/signing/createsigningsession","metadata":{"seo":{"title":"Create a signing session","description":"Create a signing session by providing files and participants."}},"httpPath":"/sign/sessions"},{"label":"Retrieve details of existing signing session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/signing/getsigningsession","routeSlug":"/embed-api/openapi/signing/getsigningsession","metadata":{"seo":{"title":"Retrieve details of existing signing session","description":"Returns details of the existing signing session."}},"httpPath":"/sign/sessions/{session_id}"},{"label":"End signing session","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/signing/endsigningsession","routeSlug":"/embed-api/openapi/signing/endsigningsession","metadata":{"seo":{"title":"End signing session","description":"End an existing signing session. A pending session is discarded and can no longer be used. A started session is cancelled. Participants who were invited are notified and can still view the document."}},"httpPath":"/sign/sessions/{session_id}"},{"label":"Start signing session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/signing/startsigningsession","routeSlug":"/embed-api/openapi/signing/startsigningsession","metadata":{"seo":{"title":"Start signing session","description":"Start an existing signing session.This moves the session status from pending to started.Starting a session locks its files (no files can be added or removed) and allows participants to access the signing flow via their links.Queued invitations are sent when the session starts.If the session is not in pending state, the endpoint returns 409 Conflict."}},"httpPath":"/sign/sessions/{session_id}/start"},{"label":"Renew expired signing session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/signing/renewsigningsession","routeSlug":"/embed-api/openapi/signing/renewsigningsession","metadata":{"seo":{"title":"Renew expired signing session","description":"Renew an expired signing session with a new due date. A session that expired after it was started returns to started, signatures already collected are kept. A session that expired before it was started returns to pending."}},"httpPath":"/sign/sessions/{session_id}/renew"},{"label":"Get signing session PDF","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/signing/getsigningsessionpdf","routeSlug":"/embed-api/openapi/signing/getsigningsessionpdf","metadata":{"seo":{"title":"Get signing session PDF","description":"Get the PDF for the signing session."}},"httpPath":"/sign/sessions/{session_id}/pdf"},{"label":"List recent webhook delivery attempts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/signing/listsigningsessionwebhookcalls","routeSlug":"/embed-api/openapi/signing/listsigningsessionwebhookcalls","metadata":{"seo":{"title":"List recent webhook delivery attempts","description":"Returns the most recent webhook delivery attempts for the signingsession, newest first. Up to 50 attempts are returned."}},"httpPath":"/sign/sessions/{session_id}/webhooks"},{"label":"List audit records for a signing session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/signing/listsigningsessionauditrecords","routeSlug":"/embed-api/openapi/signing/listsigningsessionauditrecords","metadata":{"seo":{"title":"List audit records for a signing session","description":"Returns the audit records for the signing session, oldest first."}},"httpPath":"/sign/sessions/{session_id}/audit"},{"label":"Add new file to signing session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/signing/createsigningsessionfile","routeSlug":"/embed-api/openapi/signing/createsigningsessionfile","metadata":{"seo":{"title":"Add new file to signing session","description":"Add a new file to an existing signing session.If index is provided, the file is inserted at that zero-based position in the files array.If index is omitted, the file is appended to the end of the files array.If the signing session is in state started, no new files can be added and the endpoint returns 409 Conflict."}},"httpPath":"/sign/sessions/{session_id}/files"},{"label":"Add new participant to signing session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/signing/createsigningsessionparticipant","routeSlug":"/embed-api/openapi/signing/createsigningsessionparticipant","metadata":{"seo":{"title":"Add new participant to signing session","description":"Add a new participant to an existing signing session. The session must be in pending state."}},"httpPath":"/sign/sessions/{session_id}/participants"},{"label":"Remove participant from signing session","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/signing/removesigningsessionparticipant","routeSlug":"/embed-api/openapi/signing/removesigningsessionparticipant","metadata":{"seo":{"title":"Remove participant from signing session","description":"Remove an existing participant from the signing session."}},"httpPath":"/sign/sessions/{session_id}/participants/{participant_id}"},{"label":"Excuse participant from signing on started session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/signing/excusesigningsessionparticipant","routeSlug":"/embed-api/openapi/signing/excusesigningsessionparticipant","metadata":{"seo":{"title":"Excuse participant from signing on started session","description":"Release a participant from the requirement to sign. Their outstanding invitations stop working immediately."}},"httpPath":"/sign/sessions/{session_id}/participants/{participant_id}/excuse"},{"label":"Reinstate a declined participant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/signing/reinstatesigningsessionparticipant","routeSlug":"/embed-api/openapi/signing/reinstatesigningsessionparticipant","metadata":{"seo":{"title":"Reinstate a declined participant","description":"Bring a declined participant back to pending. No invitation is sent."}},"httpPath":"/sign/sessions/{session_id}/participants/{participant_id}/reinstate"},{"label":"Create invitation for participant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/signing/createsigningsessionparticipantinvitation","routeSlug":"/embed-api/openapi/signing/createsigningsessionparticipantinvitation","metadata":{"seo":{"title":"Create invitation for participant","description":"Creates a new invitation for a participant."}},"httpPath":"/sign/sessions/{session_id}/participants/{participant_id}/invitations"},{"label":"Resend an invitation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/signing/resendsigningsessionparticipantinvitation","routeSlug":"/embed-api/openapi/signing/resendsigningsessionparticipantinvitation","metadata":{"seo":{"title":"Resend an invitation","description":"Sends the same email or SMS again for an invitation that was already sent.The signing URL does not change and no new invitation is created."}},"httpPath":"/sign/sessions/{session_id}/participants/{participant_id}/invitations/{invitation_id}/resend"},{"label":"Revoke a previously created invitation","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/signing/deletesigningsessionparticipantinvitation","routeSlug":"/embed-api/openapi/signing/deletesigningsessionparticipantinvitation","metadata":{"seo":{"title":"Revoke a previously created invitation","description":"Revoke a single invitation so its signing URL stops working immediately."}},"httpPath":"/sign/sessions/{session_id}/participants/{participant_id}/invitations/{invitation_id}"},{"label":"Create sender UI for signing session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/signing/createsigningsessionsenderui","routeSlug":"/embed-api/openapi/signing/createsigningsessionsenderui","metadata":{"seo":{"title":"Create sender UI for signing session","description":"Create a new Sender UI resource for an existing signing session."}},"httpPath":"/sign/sessions/{session_id}/sender-uis"},{"label":"List sender interfaces for signing session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/signing/getsigningsessionsenderuis","routeSlug":"/embed-api/openapi/signing/getsigningsessionsenderuis","metadata":{"seo":{"title":"List sender interfaces for signing session","description":"List existing Sender UI resources for the signing session."}},"httpPath":"/sign/sessions/{session_id}/sender-uis"},{"label":"Re-authenticate existing sender UI","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/signing/authenticatesigningsessionsenderui","routeSlug":"/embed-api/openapi/signing/authenticatesigningsessionsenderui","metadata":{"seo":{"title":"Re-authenticate existing sender UI","description":"Create a new one-time authentication URL for an existing Sender UI.Use this when the previous URL has expired or has already been used."}},"httpPath":"/sign/sessions/{session_id}/sender-uis/{sender_ui_id}/authenticate"},{"label":"Remove sender UI from signing session","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/embed-api/openapi/signing/removesigningsessionsenderui","routeSlug":"/embed-api/openapi/signing/removesigningsessionsenderui","metadata":{"seo":{"title":"Remove sender UI from signing session","description":"Remove an existing Sender UI resource from the signing session."}},"httpPath":"/sign/sessions/{session_id}/sender-uis/{sender_ui_id}"}]}]}]},{"type":"group","label":"Forms API","items":[{"type":"link","fsPath":"forms-api/index.md","metadata":{"type":"markdown"},"label":"Getting started","link":"/forms-api","routeSlug":"/forms-api"},{"type":"link","label":"API Reference","link":"/forms-api/openapi","routeSlug":"/forms-api/openapi"},{"type":"link","label":"Authentication","link":"/forms-api/openapi/section/authentication","routeSlug":"/forms-api/openapi/section/authentication"},{"type":"link","label":"Pagination","link":"/forms-api/openapi/section/pagination","routeSlug":"/forms-api/openapi/section/pagination"},{"type":"link","label":"Rate limiting","link":"/forms-api/openapi/section/rate-limiting","routeSlug":"/forms-api/openapi/section/rate-limiting"},{"type":"group","label":"Forms","link":"/forms-api/openapi/forms","routeSlug":"/forms-api/openapi/forms","items":[{"label":"List forms","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/forms-api/openapi/forms/getforms","routeSlug":"/forms-api/openapi/forms/getforms","metadata":{"seo":{"title":"List forms","description":"Fetch the forms of the account tied to the API key, ordered from oldest to newest. Use a form's id in form_ids when creating a form fill."}},"httpPath":"/api/forms"}]},{"type":"group","label":"Form fills","link":"/forms-api/openapi/form-fills","routeSlug":"/forms-api/openapi/form-fills","items":[{"label":"List form fills","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/forms-api/openapi/form-fills/getformfills","routeSlug":"/forms-api/openapi/form-fills/getformfills","metadata":{"seo":{"title":"List form fills","description":"Fetch the form fills of the account tied to the API key, ordered from newest to oldest."}},"httpPath":"/api/form-fills"},{"label":"Create a form fill","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/forms-api/openapi/form-fills/createformfill","routeSlug":"/forms-api/openapi/form-fills/createformfill","metadata":{"seo":{"title":"Create a form fill","description":"Create a form fill and send it to the recipient. The recipient receives an email, in the given language, with a link to the forms and a PIN code for opening them."}},"httpPath":"/api/form-fills"},{"label":"Get a form fill","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/forms-api/openapi/form-fills/getformfill","routeSlug":"/forms-api/openapi/form-fills/getformfill","metadata":{"seo":{"title":"Get a form fill","description":"Fetch a single form fill. Poll this endpoint to find out when the recipient has completed the forms. The forms array shows the progress of each form."}},"httpPath":"/api/form-fills/{id}"}]}]}]}