Page tree

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.



This tutorial shows you how to define hyperlinks on your document with the API.

Use Case Description Image Added

In case you want to send a document with one to many URLs to other websites it could be better for the recipient to just click on the links and another tab in the browser opens with the correct website instead of continuously copy paste the links to open them.


To define hyperlinks on the document you have to do the following steps:

  • Upload a document (PDF)
  • Configure the hyperlink(s) in the workstep configuration
  • Send the envelope

After uploading the document you now have to configure the hyperlink(s) in the workstep configuration.

Generally you can define the following settings for links:

  • Id
  • DocRefNumber
  • PositionPage
  • Uri (target link)
  • Position (x and y)
  • Size (height and width)

You can find a sample configuration of two hyperlinks in the following section: