Skip to main content

Authorization

Follow this guide to create a new Docuseal credential that will allow Nexla to authenticate to and exchange data with your Docuseal account.
docuseal_api_auth.png

Docuseal

Prerequisites​

To connect Nexla to DocuSeal, you need an active DocuSeal account and an API key. DocuSeal supports cloud-hosted deployments in the Global region (https://api.docuseal.com) and the EU region (https://api.docuseal.eu), as well as self-hosted on-premises installations at a custom URL.

DocuSeal Account and Plan Requirements​

The DocuSeal API is available as part of the Pro Plan. A Pro seat (starting at $20/month) is required to enable API access. For self-hosted (on-premises) installations, API access is available according to your license.

Obtain Your DocuSeal API Key​

DocuSeal API keys are available from your account's API settings. The location of the settings page depends on your deployment type:

For DocuSeal Cloud (Global or EU):

  1. Sign in to your DocuSeal account at https://console.docuseal.com (Global) or the EU console.

  2. Navigate to Settings in the left navigation menu.

  3. Select the API or API Keys section within Settings.

  4. Click Generate API Key (or Create API Key) to create a new key.

  5. Copy the generated API key and store it securely. The key will be used as the API Key Value when creating your Nexla credential.

For Self-Hosted (On-Premises) Installations:

  1. Sign in to your self-hosted DocuSeal instance (e.g., https://yourdocuseal.example.com).

  2. Navigate to Settings > API (accessible at https://yourdocuseal.example.com/settings/api).

  3. Generate or copy your API key from this page.

Important

DocuSeal API keys provide full access to your account's document submissions, templates, and submitter data. Store your API key securely and avoid sharing it in publicly accessible locations.

Determine Your Base URL​

The Base URL used in the Nexla credential depends on your DocuSeal deployment:

  • DocuSeal Cloud (Global): https://api.docuseal.com
  • DocuSeal Cloud (EU): https://api.docuseal.eu
  • Self-Hosted: Your custom instance URL followed by /api (e.g., https://yourdocuseal.example.com/api)

For complete API documentation and additional reference information, visit the DocuSeal API Reference.

Create a Docuseal Credential​

  • To create a new Docuseal credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used to provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

API Key Configuration​

DocuSeal uses API key authentication. All API requests are authenticated by passing your API key in the X-Auth-Token request header. Nexla handles this automatically once the credential is configured.

  1. Select or confirm the Base URL for your DocuSeal deployment from the Base URL field. The following pre-configured options are available:

    • DocuSeal Cloud (Global) — https://api.docuseal.com: Use this option for the standard DocuSeal cloud service available globally.

    • DocuSeal Cloud (EU) — https://api.docuseal.eu: Use this option if your DocuSeal account is hosted in the EU region for data residency compliance.

    For self-hosted deployments, enter your custom instance API URL directly in the Base URL field (e.g., https://yourdocuseal.example.com/api).

    The Base URL must match the region or instance where your DocuSeal account is hosted. Using the wrong Base URL will result in authentication failures. For self-hosted installations, ensure the URL points to the API endpoint of your deployed instance, not the web UI.

  2. Enter your DocuSeal API key in the API Key Value field. This is the key you generated from your DocuSeal account's Settings > API section. The key will be sent as the X-Auth-Token header with every request Nexla makes to the DocuSeal API.

    The API Key Value field is a secured (password-type) field. The key will be masked after entry to protect its value. Ensure you paste the complete key without any leading or trailing spaces.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.