DocuSign Extended

Introduction

Integrate eSignatures into your application in minutes. DocuSign's secure and award-winning eSignature API makes requesting signatures, automating forms, and tracking documents directly from your app easy.
⚠️
Prerequisites: You must have an account with DocuSign to interact with DocuSign. Create your development account at: https://developers.docusign.com/
💡
This plugin is created for account-d.docusign.com accounts. If you need an account.docusign.com account, please refer to the DocuSign Extended Production plugin.

Integration

1. Go to your DocuSign account and find the icon with your logo. Click it and select the "My Apps & Keys" tab:
Image without caption
  1. Find your application (if there is one) or create a new one and take the App ID:
Image without caption
  1. Paste the Keys into the plugin settings fields:
Image without caption

Get the external account number (int) or account id GUID.

For many calls, you'll need the account number (int) or account id GUID. In the instruction below we'll show you where you can find it.
  1. In your account dashboard open the 'Apps and Keys' tab.
  1. In the top-left corner will be your App name with the account number (int).
  1. A little bit lower in the center will be account id CUID.
Image without caption
PLEASE NOTE! You can use either of the identifiers (account number or account ID), but NOT both in one call!
Now you can use all plugin options!

Plugin content

Data calls

  1. Get Login Info & Base URL - Retrieves account information for the authenticated user. Since the API is sessionless, this method does not actually log you in. Instead, the method returns information about the account or accounts that the authenticated user has access to. Fields:
    1. Title
      Description
      Type
      server
      is the data center location of your production account (for example, NA1, NA2, or EU). For DEV mode use {demo}. For a full list of sites, see DocuSign eSignature public certificates. To access production API endpoints, you'll need to enable your integration key in the production environment.
      string
  1. Get Account Info (data) - Retrieves the account information for the specified account. Fields:
    1. Title
      Description
      Type
      server
      is the data center location of your production account (for example, NA1, NA2, or EU). For DEV mode use {demo}. For a full list of sites, see DocuSign eSignature public certificates. To access production API endpoints, you'll need to enable your integration key in the production environment.
      string
      account_id
      the external account number (int) or account id GUID (see the instructions above).
      string
  1. List Envelopes - Retrieves a list of envelopes that match your request. A large set of optional filters let you filter by date, by envelope ID, or by status codes. Fields:
    1. Title
      Description
      Type
      server
      is the data center location of your production account (for example, NA1, NA2, or EU). For DEV mode use {demo}. For a full list of sites, see DocuSign eSignature public certificates. To access production API endpoints, you'll need to enable your integration key in the production environment.
      string
      account_id
      the external account number (int) or account id GUID (see the instructions above).
      string
      from_date
      This filter parameter will show you all envelopes from the specified date. (e.g. - Thu Dec 14 2017)
      string
  1. List Templates - Retrieves the list of templates for the specified account. Fields:
    1. Title
      Description
      Type
      server
      is the data center location of your production account (for example, NA1, NA2, or EU). For DEV mode use {demo}. For a full list of sites, see DocuSign eSignature public certificates. To access production API endpoints, you'll need to enable your integration key in the production environment.
      string
      account_id
      the external account number (int) or account id GUID (see the instructions above).
      string
  1. Get Envelope (Data) - Retrieves the overall status for the specified envelope. Fields:
    1. Title
      Description
      Type
      server
      is the data center location of your production account (for example, NA1, NA2, or EU). For DEV mode use {demo}. For a full list of sites, see DocuSign eSignature public certificates. To access production API endpoints, you'll need to enable your integration key in the production environment.
      string
      account_id
      the external account number (int) or account id GUID (see the instructions above).
      string
      envelopeID
      The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
      string
  1. Get Template (Data) - Retrieves the definition of the specified template. Fields:
    1. Title
      Description
      Type
      server
      is the data center location of your production account (for example, NA1, NA2, or EU). For DEV mode use {demo}. For a full list of sites, see DocuSign eSignature public certificates. To access production API endpoints, you'll need to enable your integration key in the production environment.
      string
      account_id
      the external account number (int) or account id GUID (see the instructions above).
      string
      templateID
      The ID of the template being accessed.
      string
  1. List Documents in envelope - Retrieves a list of documents associated with the specified envelope. Fields:
    1. Title
      Description
      Type
      server
      is the data center location of your production account (for example, NA1, NA2, or EU). For DEV mode use {demo}. For a full list of sites, see DocuSign eSignature public certificates. To access production API endpoints, you'll need to enable your integration key in the production environment.
      string
      account_id
      the external account number (int) or account id GUID (see the instructions above).
      string
      envelopeID
      The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
      string
  1. Download Document To Bubble - Retrieves the specified document from the envelope. Fields:
    1. Title
      Description
      Type
      server
      is the data center location of your production account (for example, NA1, NA2, or EU). For DEV mode use {demo}. For a full list of sites, see DocuSign eSignature public certificates. To access production API endpoints, you'll need to enable your integration key in the production environment.
      string
      account_id
      the external account number (int) or account id GUID (see the instructions above).
      string
      envelopeID
      The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
      string
      documentID
      The ID of the document being accessed.
      string

Actions

  1. Get Login Info & Base URL(Action) - Retrieves account information for the authenticated user. Since the API is sessionless, this method does not actually log you in. Instead, the method returns information about the account or accounts that the authenticated user has access to.
    1. Image without caption
      Fields:
      Title
      Description
      Type
      server
      is the data center location of your production account (for example, NA1, NA2, or EU). For DEV mode use {demo}. For a full list of sites, see DocuSign eSignature public certificates. To access production API endpoints, you'll need to enable your integration key in the production environment.
      string
  1. Create & Send Envelope - Creates and sends an envelope or creates a draft envelope. Envelopes are fundamental resources in the DocuSign platform.
Image without caption
Fields:
Title
Description
Type
server
is the data center location of your production account (for example, NA1, NA2, or EU). For DEV mode use {demo}. For a full list of sites, see DocuSign eSignature public certificates. To access production API endpoints, you'll need to enable your integration key in the production environment.
string
account_id
The external account number (int) or account id GUID (see the instructions above).
string
  1. Get Account Info (action) - Retrieves the account information for the specified account.
    1. Image without caption
      Fields:
      Title
      Description
      Type
      server
      is the data center location of your production account (for example, NA1, NA2, or EU). For DEV mode use {demo}. For a full list of sites, see DocuSign eSignature public certificates. To access production API endpoints, you'll need to enable your integration key in the production environment.
      string
      account_id
      The external account number (int) or account id GUID (see the instructions above).
      string
  1. Get Envelope (Action) - Retrieves the overall status for the specified envelope.
Image without caption
Fileds:
Title
Description
Type
server
is the data center location of your production account (for example, NA1, NA2, or EU). For DEV mode use {demo}. For a full list of sites, see DocuSign eSignature public certificates. To access production API endpoints, you'll need to enable your integration key in the production environment.
string
account_id
The external account number (int) or account id GUID (see the instructions above).
string
envelopeID
The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
string
  1. Get Template (Action) - Retrieves the definition of the specified template.
    1. Image without caption
      Fields:
      Title
      Description
      Type
      server
      is the data center location of your production account (for example, NA1, NA2, or EU). For DEV mode use {demo}. For a full list of sites, see DocuSign eSignature public certificates. To access production API endpoints, you'll need to enable your integration key in the production environment.
      string
      account_id
      The external account number (int) or account id GUID (see the instructions above).
      string
      templateID
      The ID of the template being accessed.
      string
  1. Update Template - Updates an existing template.
Image without caption
Fields:
Title
Description
Type
server
is the data center location of your production account (for example, NA1, NA2, or EU). For DEV mode use {demo}. For a full list of sites, see DocuSign eSignature public certificates. To access production API endpoints, you'll need to enable your integration key in the production environment.
string
account_id
The external account number (int) or account id GUID (see the instructions above).
string
templateID
The ID of the template being accessed.
string
JSON_Body
A JSON object in which you can pass which fields you want to change. The object must contain data in the format "key": "value". E.g. { "brandLock": "false", "emailBlurb": "test blurb2" }
string
  1. Download Document To Bubble - Retrieves the specified document from the envelope.
    1. Image without caption
      Fields:
      Title
      Description
      Type
      server
      is the data center location of your production account (for example, NA1, NA2, or EU). For DEV mode use {demo}. For a full list of sites, see DocuSign eSignature public certificates. To access production API endpoints, you'll need to enable your integration key in the production environment.
      string
      account_id
      The external account number (int) or account id GUID (see the instructions above).
      string
      envelopeID
      The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
      string
      documentID
      The ID of the document being accessed.
      string
  1. Create View Link (deprecated) - Create view link. (deprecated)
    1. Image without caption
      Fields:
      Title
      Description
      Type
      server
      is the data center location of your production account (for example, NA1, NA2, or EU). For DEV mode use {demo}. For a full list of sites, see DocuSign eSignature public certificates. To access production API endpoints, you'll need to enable your integration key in the production environment.
      string
      account_id
      The external account number (int) or account id GUID (see the instructions above).
      string
      envelopeID
      The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
      string
      return_url
      The URL to be redirected to after the console view session has ended.
      string
  1. Create Console View Link - Returns a URL that allows you to embed the authentication view of the DocuSign UI in your applications.
    1. Image without caption
      Fields:
      Title
      Description
      Type
      server
      is the data center location of your production account (for example, NA1, NA2, or EU). For DEV mode use {demo}. For a full list of sites, see DocuSign eSignature public certificates. To access production API endpoints, you'll need to enable your integration key in the production environment.
      string
      account_id
      The external account number (int) or account id GUID (see the instructions above).
      string
      envelopeID
      The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
      string
      return_url
      The URL to be redirected to after the console view session has ended.
      number
  1. Delete View Link (deprecated) - Delete View Link (deprecated)
  1. DocuSign send without auth - Create the envelope and sender view and open it in the new tab
    1. Image without caption
      Fields:
      Title
      Description
      Type
      signerEmail
      Email address where the signer will receive a notification of the signing request.
      string
      signerName
      Full name of the signer.
      string
      docPdf
      File (pdf) in base64
      file
      xPos
      offset of the prepared signature along the x-axis
      number (optional)
      yPos
      offset of the prepared signature along the y-axis
      number (optional)
      numberPage
      page number where the signature will be located
      number (optional)
      returnURL
      A URL to which the user will be forwarded after signing is complete.
      string
      subject
      The subject of the document used to send the envelope.
      string
      JWT_token
      To authenticate in the JWT Grant flow, you will need to create a JWT containing data on the authentication request
      string
      anchorString
      the place where the prepared signature will be located
      string (optional)
      name document
      name of the document that is going to be signed
      string

Use cases

Add multiple recipients
To add multiple entities as recipients, please change accordingly the JSON body within the plugin action "Create & Send Envelope". (screenshot here) The part of JSON body responsible for multiple recipients should look like this (example): { "recipients":{ "signers":[ { "email":"email@mail.com", "name":"name", "recipientId":1, "tabs":{ "signHereTabs":[ { "xPosition":".........." } ] } }, { "email":"email2@mail.com", "name":"name2", "recipientId":2, "tabs":{ "signHereTabs":[ { "xPosition":".........." } ] } } ] } }
To be sure that everything has been written right, please use the JSON validator services (for example: https://jsonformatter.curiousconcept.com)
Image without caption

Request a signature through your app

To request a signature through your app, please call “DocuSign send without auth” action
Image without caption
and open an external website “result of step 2”.
Image without caption
we need to create a JWT token and push into action

How to create JWT token?

  1. Go to https://jwt.io/
  1. Сollect the necessary data
    1. Header:{ "alg": "RS256", "typ": "JWT" } Body:{ "iss": "<your_integration_key>", "sub": "<your_user_ID>", "aud": "account-d.docusign.com", "iat": 1558736992, "exp": 1858745992, "scope": "signature impersonation" } Signature:RSASHA256( base64UrlEncode(header) + "." + base64UrlEncode(body), "<your_public_RSA_key>", "<your_private_RSA_key>" )
  1. In the https://admindemo.docusign.com/apps-and-keys find <your_integration_key> and <your_user_id>
    1. Image without caption
  1. Go to your DocuSign - > settings. Click “actions” → Edit and and create <your_public_RSA_key> and <your_private_RSA_key>
    1. Image without caption
      Generate RSA keys
      Image without caption
  1. Insert all data in jwt.io
    1. Image without caption
  1. Paste your JWT token in the field action
    1. Image without caption

Changelogs

Update 11.11.2021 - Version 1.6.0
  • Minor updates
Update 26.12.2021 - Version 1.7.0
  • Changed the authorization system to type oAuth 2.0
Update 3.08.2022 - Version: 1.10.0
  • Added the ability to sign the documents in the app without user authentication
Update 14.11.2022 - Version: 1.11.0
  • Fixed "DocuSign send without auth" action

Demo to preview the settings: