The Official Docusign eSignature Node Client SDK
The Docusign SDK makes integrating Docusign into your apps and websites a seamless experience.
Table of Contents
Introduction
Integrate eSignatures into your application in minutes. The secure and award-winning Docusign eSignature API makes requesting signatures, automating forms, and tracking documents directly from your app easy.
Installation
This client SDK is provided as open source, which enables you to customize its functionality to suit your particular use case. To do so, download or clone the repository. If the SDK’s given functionality meets your integration needs, or if you’re working through our code examples from the Docusign Developer Center, you merely need to install it by following the instructions below.
Version Information
- API version: v2.1
- Latest SDK version: 8.0.0-rc1
Requirements
Compatibility
NPM:
- Open your preferred command-line console, then navigate to your project.
- In the console, type the following commands:
npm install docusign-esign -save
SDK Dependencies
This client has the following external dependencies:
Minimum:
- docusign-esign
- Axios v1.6.8+
- @devhigley/parse-proxy v1.0.3+
- Csv-stringify v1.0.0+
- Jsonwebtoken v9.0.0+
- Passport-oauth2 v1.6.1+
- Safe-buffer v5.1.2+
API Reference
You can refer to the API reference here.
Code examples
Explore our GitHub repository for the Launcher, a self-executing package housing code examples for the eSignature Node SDK. This package showcases several common use cases and their respective source files. Additionally, you can download a version preconfigured for your Docusign developer account from Quickstart. These examples support both the Authorization Code Grant and JSON Web Token (JWT) authentication workflows.
OAuth implementations
For details regarding which type of OAuth grant will work best for your Docusign integration, see Choose OAuth Type in the Docusign Developer Center.
For security purposes, Docusign recommends using the Authorization Code Grant flow.
Changelog
You can refer to the complete changelog here.
Support
Log issues against this client SDK through GitHub. You can also reach out to us through Docusign Community and Stack Overflow.
License
The Docusign eSignature Node Client SDK is licensed under the MIT License.
Additional resources
[v8.0.0-rc1] - eSignature API v2.1-24.2.00.00 - 2024-07-02
Breaking Changes
<details>
<summary>API Changes (Click to expand)</summary>
<div style="margin-left: 20px;">
<br/>
Added support for version v2.1-24.2.00.00 of the Docusign ESignature API.
Endpoint-Specific Changes
Added new optional query parameter named include_anchor_tab_locations
of type string.
Added new optional query parameter named recycle_on_void
of type string.
Request body object correctViewRequest
has been changed to envelopeViewRequest
.
Model Changes
Updated existing models
accountInformation
- Added fields:
freeEnvelopeSendsRemainingForAdvancedDocGen
accountSettingsInformation
-
Added fields:
defaultSigningResponsiveView
defaultSigningResponsiveViewMetadata
dss_SCOREFDN_196_Rebrand_DocuSignIsNotAVerb
enableAdditionalAdvancedWebFormsFeatures
enableAdditionalAdvancedWebFormsFeaturesMetadata
-
Removed fields:
enableSaveAsEnvelopeCustomFieldInWebForms
enableSaveAsEnvelopeCustomFieldInWebFormsMetadata
bulksendingCopyDocGenFormField
notaryRecipient
tabAccountSettings
- Added field:
enableTabAgreementDetails
enableTabAgreementDetailsMetadata
Newly added Models
bulkSendingCopyDocGenFormFieldRowValue
</div>
</details>
Other Changes
- Updated the SDK release version.