Skip to main content

​
Integration Specifications

​
Prerequisites

Issuing an API key for the LIVE environment requires the BoldSign Enterprise API plan. For details, see Enterprise API (external site).

​
How to obtain the API key

  1. Log in to BoldSign and select API Key under API in the left menu. The BoldSign left menu with API Key under API
  2. Click Generate API Key. The BoldSign API Key page with the Generate API Key button
  3. On the Generate API key screen, switch the environment to LIVE. Enter any name in API Key Name and leave Token Validity off. Then click Generate Token. The BoldSign Generate API key screen with the environment switch and the Generate Token button
  4. Copy the API key that appears and save it.

​
Setting up the integration

  1. In the integration screen, search for BoldSign.
  2. In Workspace key, enter any string that identifies this integration, such as the organization name. If your organization integrates more than one BoldSign account, use a different value for each. Enter the API key in API Key. Workspace Name is optional. You can enter a name to tell this integration apart.
  3. If your BoldSign account is in a region outside the United States, enter EU, CA, or AU in Region. Leave it blank for a United States account.
  4. Click Integrate. The BoldSign integration screen with the workspace name, workspace key, API key, and region fields
  5. When the integration with BoldSign succeeds, registered user information appears in the account list. If it does not complete successfully, first try the steps in Troubleshoot SaaS integration errors. If the issue persists, check Information to provide and contact Support.
Last modified on October 7, 2026