Package detail

@docuseal/api

docusealco16.9kMIT1.0.17

JavaScript / TypeScript library for the DocuSeal API

esignature, documents

readme

DocuSeal JavaScript / Typescript

The DocuSeal JavaScript / Typescript library provides seamless integration with the DocuSeal API, allowing developers to interact with DocuSeal's electronic signature and document management features directly within JS/TS applications. This library is designed to simplify API interactions and provide tools for efficient implementation.

Documentation

Detailed documentation is available at DocuSeal API Docs.

Requirements

Node 14 or higher.

Installation

To install the library, run:

npm install @docuseal/api

or:

yarn add @docuseal/api

Usage

Configuration

Set up the library with your DocuSeal API key based on your deployment. Retrieve your API key from the appropriate location:

Global Cloud

API keys for the global cloud can be obtained from your Global DocuSeal Console.

const docuseal = require("@docuseal/api");

docuseal.configure({ key: "your_api_key_here" });

Or initiate a new api client object:

const { DocusealApi } = require("@docuseal/api");

const docuseal = new DocusealApi({ key: "your_api_key_here" });

EU Cloud

API keys for the EU cloud can be obtained from your EU DocuSeal Console.

const docuseal = require("@docuseal/api");

docuseal.configure({
  key: "your_api_key_here",
  url: "https://api.docuseal.eu"
});

On-Premises

For on-premises installations, API keys can be retrieved from the API settings page of your deployed application, e.g., https://yourdocusealapp.com/settings/api.

const docuseal = require("@docuseal/api");

docuseal.configure({
  key: "your_api_key_here",
  url: "https://yourdocusealapp.com/api"
});

API Methods

listSubmissions(params)

Provides the ability to retrieve a list of available submissions.

const { data, pagination } = await docuseal.listSubmissions({ limit: 10 });

getSubmission(id)

Provides the functionality to retrieve information about a submission.

const submission = await docuseal.getSubmission(1001);

getSubmissionDocuments(id)

This endpoint returns a list of partially filled documents for a submission. If the submission has been completed, the final signed documents are returned.

const submission = await docuseal.getSubmissionDocuments(1001);

createSubmission(data)

This API endpoint allows you to create signature requests (submissions) for a document template and send them to the specified submitters (signers).

Related Guides:
Send documents for signature via API Pre-fill PDF document form fields with API

const submission = await docuseal.createSubmission({
  template_id: 1000001,
  send_email: true,
  submitters: [
    {
      role: "First Party",
      email: "john.doe@example.com"
    }
  ]
});

createSubmissionFromPdf(data)

Provides the functionality to create one-off submission request from a PDF file. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See https://www.docuseal.com/examples/fieldtags.pdf for more text tag formats. Or specify the exact pixel coordinates of the document fields using fields param.

Related Guides:
Use embedded text field tags to create a fillable form

const submission = await docuseal.createSubmissionFromPdf({
  name: "Test PDF",
  documents: [
    {
      name: "string",
      file: "base64",
      fields: [
        {
          name: "string",
          areas: [
            {
              x: 0,
              y: 0,
              w: 0,
              h: 0,
              page: 1
            }
          ]
        }
      ]
    }
  ],
  submitters: [
    {
      role: "First Party",
      email: "john.doe@example.com"
    }
  ]
});

createSubmissionFromHtml(data)

This API endpoint allows you to create a one-off submission request document using the provided HTML content, with special field tags rendered as a fillable and signable form.

Related Guides:
Create PDF document fillable form with HTML

const submission = await docuseal.createSubmissionFromHtml({
  name: "Test PDF",
  documents: [
    {
      name: "Test Document",
      html: `<p>Lorem Ipsum is simply dummy text of the
<text-field
  name="Industry"
  role="First Party"
  required="false"
  style="width: 80px; height: 16px; display: inline-block; margin-bottom: -4px">
</text-field>
and typesetting industry</p>
`
    }
  ],
  submitters: [
    {
      role: "First Party",
      email: "john.doe@example.com"
    }
  ]
});

archiveSubmission(id)

Allows you to archive a submission.

await docuseal.archiveSubmission(1001);

listSubmitters(params)

Provides the ability to retrieve a list of submitters.

const { data, pagination } = await docuseal.listSubmitters({ limit: 10 });

getSubmitter(id)

Provides functionality to retrieve information about a submitter, along with the submitter documents and field values.

const submitter = await docuseal.getSubmitter(500001);

updateSubmitter(id, data)

Allows you to update submitter details, pre-fill or update field values and re-send emails.

Related Guides:
Automatically sign documents via API

const submitter = await docuseal.updateSubmitter(500001, {
  email: "john.doe@example.com",
  fields: [
    {
      name: "First Name",
      default_value: "Acme"
    }
  ]
});

listTemplates(params)

Provides the ability to retrieve a list of available document templates.

const { data, pagination } = await docuseal.listTemplates({ limit: 10 });

getTemplate(id)

Provides the functionality to retrieve information about a document template.

const template = await docuseal.getTemplate(1000001);

createTemplateFromPdf(data)

Provides the functionality to create a fillable document template for a PDF file. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See https://www.docuseal.com/examples/fieldtags.pdf for more text tag formats. Or specify the exact pixel coordinates of the document fields using fields param.

Related Guides:
Use embedded text field tags to create a fillable form

const template = await docuseal.createTemplateFromPdf({
  name: "Test PDF",
  documents: [
    {
      name: "string",
      file: "base64",
      fields: [
        {
          name: "string",
          areas: [
            {
              x: 0,
              y: 0,
              w: 0,
              h: 0,
              page: 1
            }
          ]
        }
      ]
    }
  ]
});

createTemplateFromDocx(data)

Provides the functionality to create a fillable document template for existing Microsoft Word document. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See https://www.docuseal.com/examples/fieldtags.docx for more text tag formats. Or specify the exact pixel coordinates of the document fields using fields param.

Related Guides:
Use embedded text field tags to create a fillable form

const template = await docuseal.createTemplateFromDocx({
  name: "Test DOCX",
  documents: [
    {
      name: "string",
      file: "base64"
    }
  ]
});

createTemplateFromHtml(data)

Provides the functionality to seamlessly generate a PDF document template by utilizing the provided HTML content while incorporating pre-defined fields.

Related Guides:
Create PDF document fillable form with HTML

const template = await docuseal.createTemplateFromHtml({
  html: `<p>Lorem Ipsum is simply dummy text of the
<text-field
  name="Industry"
  role="First Party"
  required="false"
  style="width: 80px; height: 16px; display: inline-block; margin-bottom: -4px">
</text-field>
and typesetting industry</p>
`,
  name: "Test Template"
});

cloneTemplate(id, data)

Allows you to clone existing template into a new template.

const template = await docuseal.cloneTemplate(1000001, {
  name: "Cloned Template"
});

mergeTemplates(data)

Allows you to merge multiple templates with documents and fields into a new combined template.

const template = await docuseal.mergeTemplates({
  template_ids: [
    321,
    432
  ],
  name: "Merged Template"
});

updateTemplate(id, data)

Provides the functionality to move a document template to a different folder and update the name of the template.

const template = await docuseal.updateTemplate(1000001, {
  name: "New Document Name",
  folder_name: "New Folder"
});

updateTemplateDocuments(id, data)

Allows you to add, remove or replace documents in the template with provided PDF/DOCX file or HTML content.

const template = await docuseal.updateTemplateDocuments(1000001, {
  documents: [
    {
      file: "string"
    }
  ]
});

archiveTemplate(id)

Allows you to archive a document template.

await docuseal.archiveTemplate(1000001);

updateTemplateDocuments(id, data)

Allows you to add, remove or replace documents in the template with provided PDF/DOCX file or HTML content.

const template = await docuseal.updateTemplateDocuments(1000001, {
  documents: [
    {
      file: "string"
    }
  ]
});

archiveTemplate(id)

Allows you to archive a document template.

await docuseal.archiveTemplate(1000001);

Configuring Timeouts

Set timeouts to avoid hanging requests:

const { DocusealApi } = require('@docuseal/api')

const docuseal = new DocusealApi({
  key: 'your_api_key_here',
  openTimeout: 30000
});

Support

For feature requests or bug reports, visit our GitHub Issues page.

License

The gem is available as open source under the terms of the MIT License.