Improved

Scope Electronic Seals to Workspaces

You can now create Electronic Seals in any Workspace of your Organization, including with a workspace-scoped API key.

Set the new optional workspace_id field when you create an Electronic Seal Document or upload an Electronic Seal Image. An Electronic Seal is always created in the Workspace of its Electronic Seal Document, so Create an Electronic Seal does not take a workspace_id.

📘

Available on the Pro and Scale plans, in production and Sandbox.

Electronic Seal Documents

  • Without workspace_id, a new Document is created in your default Workspace. If your workspace-scoped API key does not have access to the default Workspace, send a workspace_id.
  • A Document created from another Electronic Seal Document or from a Signature Request document is created in the Workspace of its source, unless you set a workspace_id.

Electronic Seal Images

  • Without workspace_id, or with null, the Image is shared across your whole Organization and can be used in any Workspace.
  • With a workspace_id, the Image can only be used by Electronic Seals created in that Workspace.
  • The workspace_id returned for an Image can now be null, for organization-wide Images.
  • To change the Workspace of an Image, delete it and upload it again, then update the image_id in your integration.
  • The Image quota is unchanged. Organization-wide and workspace-scoped Images both count toward it.

Access rules

  • A workspace-scoped API key only sees the Electronic Seals, Documents and Images of its Workspaces, plus organization-wide Images. This applies to every get, list, download, delete, audit trail and preview endpoint, and to Electronic Seal consumption records.
  • Generate an Electronic Seal Image Preview is now available to workspace-scoped API keys. It remains Sandbox only.
  • A workspace_id outside the scope of your API key returns a 403. An unknown workspace_id returns a 404.
  • Creating an Electronic Seal with an Image scoped to another Workspace than its Document returns a 400 with the error type electronic_seal_image.workspace_not_identical.

Webhooks

The workspace_id sent in electronic_seal.done and electronic_seal.error events is now the real Workspace of the Electronic Seal. A webhook scoped to a Workspace only receives the events of that Workspace. Read the webhook guide

⚠️

Existing Images stored outside your default Workspace are now organization-wide. Images stored in your default Workspace stay scoped to it. To use one of them from another Workspace, upload it again without workspace_id and use its new image_id.

Read the Workspaces guide