Docusign eSignature Node Client SDK

Docusign supports multiple OAuth grant types. For security purposes, Docusign recommends using the Authorization Code Grant flow.

To determine which grant type is best for your specific integration (e.g., Authorization Code Grant vs. JWT), consult the Choose OAuth Type guide in the Docusign Developer Center.

To integrate Docusign into your Node.js project, install the docusign-esign package using npm. Ensure you are in your project's root directory before running the command.

Requirements

• Node.js: Version 12 or higher
• Docusign Account: A free developer account is required to use the API.

Version Information

• Latest SDK version: 10.0.0
• API version: v2.1

npm install docusign-esign -save

You can find practical implementations and common use cases in the following resources:

1. Launcher: A self-executing package in the Docusign Launcher repository that showcases various use cases.
2. Quickstart: Preconfigured versions for your Docusign developer account available via the Docusign Quickstart guide.

These examples support both Authorization Code Grant and JSON Web Token (JWT) authentication workflows.

The Docusign eSignature Node Client SDK exports a wide range of model constructors used to represent various entities within the eSignature API. These models are used to structure request payloads and parse response data.

Commonly used models include:

• Envelope: Represents an envelope (a collection of documents and recipients).
• Recipient: Represents a person participating in an envelope.
• EnvelopeDocument: Represents a document within an envelope.
• Email: Represents email-related data.
• SignHere: Represents a signature field/tab.
• PowerForm: Represents a PowerForm entity.
• Notary: Represents notary-related information.

Each model is available as a constructor on the main SDK entrypoint.

The Docusign eSignature Node Client is initialized by importing the main module. The SDK follows a factory pattern that exports several core components: Configuration for setting up environment and credentials, ApiClient for handling HTTP requests, a vast collection of model classes for data structures, and various Api classes for interacting with specific Docusign resources.

To use the SDK, you typically instantiate an ApiClient, configure it with your credentials, and then use the specific API classes (e.g., EnvelopesApi) to perform actions.

const Docusign = require('docusign-esign');

// The SDK exports Configuration, ApiClient, models, and API classes
// Example usage pattern:
const apiClient = new Docusign.ApiClient();
const envelopesApi = new Docusign.EnvelopesApi(apiClient);

The CustomFieldV2 class is a data model used to define version 2 custom fields in DocuSign. You can instantiate it using the new keyword or populate an existing instance from a plain JavaScript object using CustomFieldV2.constructFromObject(data, obj). This is useful when receiving field data from the API or preparing custom field definitions for a request.

const CustomFieldV2 = require('docusign-esign').model.CustomFieldV2;

const fieldData = {
  fieldId: '12345',
  name: 'My Custom Field',
  value: 'Custom Value',
  required: 'true'
};

const customField = CustomFieldV2.constructFromObject(fieldData);

The constructFromObject method allows you to create or populate an AddressInformationV2 instance using a plain JavaScript object. This is useful when receiving address data from an external source or API.

Parameters:

• data (Object): The plain JavaScript object containing the address properties.
• obj (AddressInformationV2, optional): An existing instance to populate. If not provided, a new instance is created.

Returns:

• The populated AddressInformationV2 instance.

const address = AddressInformationV2.constructFromObject({
  address1: '123 Main St',
  city: 'San Francisco'
});