How to call DocuSign REST API in SSIS / ODBC - Using OAuth or JWT (RSA Private Key)

[nayan]

In this guide, we’ll walk through how to configure application credentials to call the DocuSign REST API using a connector such as SSIS JSON Source.

---

Overview

To register your DocuSign app and connect successfully, follow these high-level steps:

1. Create a DocuSign Developer Account (if not done already)
2. Create an App and obtain the following information (used to configure your connection):
   • For OAuth 2.0 (3-Legged User Credentials):
     • Integration Key (Client ID)
     • Client Secret
   • For JWT Authentication (RSA Keys):
     • Integration Key (Client ID)
     • Client Secret
     • User ID
     • RSA Private Key file (.pem format)
3. Set up the connection for the demo (sandbox) environment
4. Submit your app for live data access
5. Update the connection to the production (live) environment

Now, let’s go through each step in detail.

---

Create a DocuSign Developer (Demo) Account

Step 1: Go to the Developer Center

Visit https://developers.docusign.com/

Step 2: Click “Start Building” or “Create Free Account”

You’ll be redirected to the demo account signup page.

Step 3: Fill Out the Signup Form

Provide your:

• Name
• Email address
• Password
• Accept the terms and conditions, then click Sign Up

Step 4: Verify Your Email

DocuSign will send a verification email. Click the link inside it to activate your account.

---

Create a DocuSign App (OAuth 2.0)

Once you’ve logged into your developer account, follow these steps to create an app and obtain credentials for API access.

1. Visit the Apps and Keys section of your Admin Console.
   

   

2. Click Add App and Integration Key.
   

   

3. Enter a descriptive name (e.g., HR Automation App) and click Create App.
   

   

4. Copy the Integration Key shown.

5. Set the integration type to Private custom integration (if you’ll access your own data).

6. Click Add Secret, copy it immediately (it’s only shown once).
   

   

7. Add a redirect URL — we recommend:
   https://zappysys.com/oauth
   

   

8. Click Save.
   

   

9. Save both your Integration Key and Client Secret for later use.
   

   

---

Create DocuSign App (JWT Auth – RSA Private Key)

If you want to use JWT authentication with RSA keys, perform the previous steps and then do the following:

1. In Apps and Keys, click Actions → Edit next to your app.
   

   

2. Click Generate RSA.
   

   

3. Save both keys (PEM format) as files:

   • docusign_private_key.pem
   • docusign_public_key.pem
     You’ll use only the private key in your connection setup. Keep both keys secure.
     
     

---

Setup Connection (JWT Auth / RSA Private Key)

Obtain the User ID

1. Go to Apps and Keys
2. Copy your User ID (needed for JWT Auth)
   
   

Configure OAuth Connection (ZappySys SSIS PowerPack)

1. Open SSIS and drag the REST API Task from the toolbox.

2. Double-click to edit the task.

3. Set URL Mode to URL from Connection.
   

   

4. Create or edit the OAuth Connection and configure it as follows.

General Tab

• Client ID and Client Secret
• Token URL:
  • Sandbox: https://account-d.docusign.com/oauth/token
  • Live: https://account.docusign.com/oauth/token
• Scopes: signature and impersonation (add more as required).
  
  

Advanced Tab

Enter the redirect URL (same as the app registration) and the following extra attributes.
Replace sub=xxxxx with your actual User ID.

aud=account-d.docusign.com&sub=a01a9-your-user-id-d01e&jwt_user_grant=1&jwt_pkcs_version=1&jwt_alog=RS256

For production, use aud=account.docusign.com.

Certificate Tab

Upload your .pem private key file.

Click OK to save the connection, then test it.

Testing Endpoints:

• Sandbox: https://account-d.docusign.com/oauth/userinfo
• Live: https://account.docusign.com/oauth/userinfo
  
  

---

Setup Connection for OAuth 2.0 (Standard Flow)

If you prefer using regular OAuth (no RSA key):

1. Set Provider = Custom.

2. Enter Client ID and Client Secret.

3. Use the following URLs:

   Sandbox:

   Auth URL:  https://account-d.docusign.com/oauth/auth
   Token URL: https://account-d.docusign.com/oauth/token
   

   Production:

   Auth URL:  https://account.docusign.com/oauth/auth
   Token URL: https://account.docusign.com/oauth/token
   

4. Enter the required Scopes (one per line).

5. Add the Redirect URL (https://zappysys.com/oauth).
   

   

6. Click Generate Token on the General tab, complete the authorization in your browser, and confirm success.
   

   

---

Submit App for Live Data Access

After successfully testing in the sandbox (https://account-d.docusign.com/...):

1. Go to App Settings.
2. Click Submit for Review / Go Live.
3. Approval usually takes a few days (faster for private apps).
   
   

---

Switch to Live Environment

Once approved, simply update your connection URLs to production endpoints.

---

Common Errors

Error: (400) Bad Request – consent_required)

This means your app hasn’t been authorized yet.

Fix:
Click Generate Token button on the connection UI and follow the screens to approve the App. Or manually authorize your app by visiting this URL (replace placeholders):

https://account-d.docusign.com/oauth/auth?
response_type=code&
scope=signature%20impersonation&
client_id=YOUR_INTEGRATION_KEY&
redirect_uri=https://www.docusign.com

After approving the prompt, retry your connection in SSIS or your client application.

---

You’re all set!
You can now connect to the DocuSign REST API using OAuth 2.0 or JWT authentication.