Page Comparison

...

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:

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

   Or you can download envelop with documents inside:

   Code Block
   /api/v2/Documents/Envelop{EnvelopeID}

   You can also download all signed envelops:

   Code Block
   /api/v2/Documents/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:

   Code Block
   /api/v1/Documents/HTMLToPDF/

2. EVE: generating QR code for links to EVE
   /wiki/spaces/MAR/pages/2577891341 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:

   Code Block
   /api/v2/EVE/URL/

   To get QR code:

   Code Block
   /api/v2/EVE/URL/QRCodeImageForURL/

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:

      Code Block
      /api/v2/Signing/HTMLCeremonyUrl/

      Signing nonHtml (only in version 2):

      Code Block
      /api/v2/Signing/Templates/CeremonyUrl/

   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:

      Code Block
      /api/v2/Signing/Signing/HTMLEmailRequest/

      Signing non-Html:

      Code Block
      /api/v2/Signing/Signing/EmailRequest/

   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:

      Code Block
      /api/v2/Signing/Templates/

      Signing:

      Code Block
      /api/v2/Signing/TemplateCeremonyUrl/

      Email request:

      Code Block
      /api/v2/Signing/TemplateEmailRequest/

      
      

4. Users: managing DocuSign users (require Admin scope)
   - Create DocuSign user
   
   - Update user information
   - Delete user
   These actions require Admin scope
   

Versioning

There are two version of DS API.

...