Skip to navigation
Platform 101

Build a Docusign integration

View as Markdown

You can now manage API integrations directly from the Developer Console.

Now in open beta, the new and improved Developer Console is your all-in-one tool for managing every aspect of your integration developer experience. No more switching between accounts or juggling multiple environments.

Learn How to create an IK and manage guest developers in the Developer Console.

This overview of how to incorporate Docusign functionality into your product (known as an integration) outlines the broad requirements for using the Docusign platform and connects you to resources for choosing and implementing the best OAuth process for your product.

1. Create a free developer account

A Docusign developer account (sometimes referred to as a demo account) enables you to develop and test your app in the developer environment (sometimes referred to as the demo environment), which is isolated from the production environment. Documents sent from this environment are not legally binding and are watermarked.

Depending on the Docusign APIs you plan to work with, you may need to take additional steps to gain access to your desired functionality.

2. Add an app

Next, you add an app to your developer account. On the Docusign platform, an app is a set of parameters that are used to identify and configure an integration.

  • You can add an app manually, setting configuration values and choosing your authentication type in the UI through the Apps and Keys page.
  • You can use Quickstart to add an app that is preconfigured to work with an example project that you can download and use as a basis for your own development.

Select an OAuth authentication type

After you create an app, you choose an OAuth authentication type for your app. Docusign supports three OAuth 2.0 grant types for obtaining access tokens, each designed for use with a specific type of integration.

If you used Quickstart, the downloaded example project implements your OAuth selection for you. If you created your own app, selecting an OAuth type enables you to configure authentication in the account, but you will implement OAuth yourself.

3. Configure your app

After you choose an OAuth type, you may configure the following settings for your app.

  • integration key: Identifies your app and is used to authenticate your API calls. Docusign automatically generates an integration key for your app. You can also find your integration key GUID on the Apps and Keys page under Apps and Integration Keys.
  • secret key: Depending on the OAuth type you choose, you might need to generate a secret key.

Note: You are only able to view your secret key immediately after creating it, so be sure to save it or record it to a safe place. To ensure its security, there is no way to go back and view it again after you close the window.

The app configuration screen displays other information that you should save for future reference.

  • User ID: A GUID value that uniquely identifies a Docusign user. This is the ID of the user who just created the app.
  • API Account ID: A GUID that identifies your account. You must include this ID in your API calls.

See Configure your app for details on each configuration value and how to set it.

4. Develop your integration

Once you’ve created and configured your app in your account, you’re ready to continue developing. If you used Quickstart, you can download your pre-provisioned app and customize it.

When you build an integration with Docusign, you are connecting your application or workflow to the Docusign platform so it can send, manage, and track agreements on behalf of your users. At a high level, every integration goes through the same lifecycle:

  • Plan: Identify which Docusign APIs and features you need (for example, Workflow Builder, Agreement Manager, eSignature REST API, Web Forms API, or others) and what types of agreements you will work with.

  • Prototype: Use your developer (demo) account to experiment, set up one or more apps, and validate your OAuth authentication flow end-to-end.

  • Build: Implement your integration logic in your codebase using your chosen Docusign SDKs or direct REST API calls.

  • Test: Verify all key scenarios (sending, signing, status updates, error handling) in the developer environment before you request Go-Live.

    See Docusign APIs to learn about supported features and scenarios, or peruse our library of eSignature How-to guides to see how to implement common scenarios.

5. Go-Live

After you’ve completed these steps and tested your integration, you’re ready to Go-Live. See the Go-Live pages for the specific Docusign APIs that your app calls.

Frequently asked questions

Who should I contact for questions about plans and pricing?

For questions about specific Docusign plans, entitlements, or pricing for your integration, contact Docusign Sales or your account representative.

Do I need a Docusign account before I start building?

Yes, start by creating a free Docusign developer account. This account is separate from any production accounts your organization may already use, and it exists specifically to support development and testing.

What is the difference between the developer (demo) environment and production?

The developer environment is where you build and test your integration. It uses a separate set of accounts and data from production, and documents sent from this environment are visibly watermarked and not legally binding. Once your integration is ready and passes testing, you can Go-Live to start using your app in production.

Which APIs can I use with a developer account?

A developer account can use every Docusign API that is not in beta or early access. These APIs may require additional steps to request and be granted access.

What is an app and an integration key?

An app is a configuration that represents your integration on the Docusign platform. When you create an app, Docusign assigns it a GUID integration key which uniquely identifies it and is used to authenticate API calls on behalf of your integration.

You should treat your integration key and any associated secret keys as sensitive credentials and follow your organization’s security practices when storing them.

Which OAuth grant type should I choose?

This depends on how your integration will be used:

See Choose an OAuth type for details.

What configuration values do I need to save?

From the app configuration experience, ensure you capture and securely store:

  • Integration key
  • Any secret keys you generate
  • Redirect URIs used for your OAuth flows
  • API Account ID
  • The user ID associated with the app

You will reference these values repeatedly when configuring SDKs, making direct REST API calls, and when promoting your integration to production.

What does Go-Live mean for Docusign integrations?

Go-Live is the process of promoting your tested app and integration key from the developer environment to production so that real agreements can be sent and signed. See Go-Live for details.

How do I give other developers access to work on the integration?

You can invite guest developers to your developer account from the Developer Console so they can collaborate on app configuration and integration development. Guest developers can help manage app settings, keys, and environments without needing direct access to your production accounts.

Next steps