Digital Signature API

General Description

Digital Signature (DS) API purpose to facilitate using DocuSign API for signing and delivering PDF documents.

Authentication and authorization

Only authorized users or applications can use this API.

There are two scopes of authorization:

1. DigitalSignature.Sign

2. DigitalSignature.Admin

User in first scope can perform all actions, except managing DocuSign users.

You should have Admin scope otherwise.

First you need to get bearer token:

Where ClientId and ClientSecret you can get in application Azure registration. (In this case your application should be added to application list, which have access to DS).

Or you can use DS ClientId and ClientSecret instead, which we can provide for you.

After getting the token, we add it to HttpClient header:

After this HttpClient can perform Http request to DS endpoints.

Actions

DS API has the following controllers:

1. Documents: managing and processing documents (certificates and envelops) in DocuSign.
   
   - We can download PDF documents and envelops from DocuSign.
   Each document should be wrapped to envelope. Envelope can contain one or several documents.
   You need provide EnvelopeId and DocumentId for getting document:

   /api/v2/Documents/Document/{EnvelopeID}/{DocumentID}

   Or you can download envelop with documents inside:

   Example:

   You can also download all signed envelops:

   
   - Convert Html document to PDF
   DocuSign sign only PDF documents. But you can send Html, Jpeg or MS Office document to DocuSign and DocuSign will convert it to pdf for you. Unfortunately, resulting PDF is not completely accessible.
   But if you want to have more control you can convert Html to PDF yourself. We use for this Telerik document processing library.
   You can use the following POST endpoint to convert Html to PDF:

   Example:

   We can get portrait or landscape PDF, it depends on LandscapePageOrientation property of SignInfoHtml class. But default it’s false, so resulting PDF is in portrait mode.
   
   

2. EVE: generating QR code for links to EVE
   Electronic Validation Électronique (EVE) is a website designed for the purpose of allowing users to check the validity of digital documents issued by Transport Canada. 
   Using DS API, you can generate search result links to EVE or generate QR instead links.
   To get link:

   Example:

   
   To get QR code:

   Example:

    

3. Signing: signing documents (Html. PDF, JPG and MS Office docs) in DocuSign
   
   We can sign one or several documents by one request.
   You can specify signature position two ways:
   - absolution position (X, Y) or
   - anchor, marking some text as place where signature should be
   
   There are 3 ways to sign document:

   1. Embedded
      In this case you provide required information and get back url for signing ceremony.
      You need to provide the following information:
      - sender and signer names and emails
      - names of the documents
      - html content or base64 content (only in version 2) for each document
      - signature position (absolute or anchor) for each document
      Signing Html (POST):

      Example:

      Where info is the instance of the following class:

      Depending on LandscapePageOrientation property we can sign portrait or landscape document. By default it’s portrait, because LandscapePageOrientation is false by default.
      
      Signing non-Html (only in version 2) (POST):

      Difference with HTML signing, that it used other info class:

      
      
      

   2. Email Request
      In this case you provide the same information, but get not url, but email to signer email address with request to signer certificate.
      Signing Html (POST):

      Example:

      Where info is information, required for singing (see above).
      
      Signing non-Html (only in version 2) (POST):

       

   3. Template
      In this case we don’t send document to DocuSign, but use template, uploaded to DocuSign.
      We can get templates using the following endpoint (GET):

      Signing (POST):

      Email request (POST):

       

4. Users: managing DocuSign users (require Admin scope)
   - Get list of all signers (GET)

   
   - Create DocuSign user (POST)

   
   - Update user information (PUT)

   
   - Delete user (DELETE)

    

Versioning

There are two version of DS API.

Current version is 2.

References

1. DocuSign

2. DS API (NCD Environment)

3. DS API (NCA Environment)