Anchor Tags

API Home >> Anchor Tags >> Anchor Tags >> Anchor Tags

An eSign Anchor Tag is a specially formatted text embedded into Word/Excel/PDF documents, that defines signing locations for eSign to render on a document during the signing ceremony. In version 1 of Anchor Tags, we’ll support the following types of locations (Signature, Initial, Date Time, Free Text), and we’ll add the support for the remaining locations in later releases.

Two things need to be done for clients to get this feature.

  • Need to subscribe to eSign Anchor Tag service, so it gets enabled for you.
  • If using eSign APIs, set the new Document object property HasAnchorTags to true, to notify the service to scan the document for anchor tags. Refer to the API Reference for Create/Update Session.

NOTE: Do NOT just set all documents HasAnchorTags to true, as your sessions will take longer to process.

By subscribing to this feature it also makes it available in eSign UI on step 3 of uploading documents. Where you can select the document(s) that has/have tags and click on the “Read Tags” button.

The text that defines the tag must start and end with a single special character that doesn’t appear in the uploaded document, and the client has the freedom to define what the opening and closing characters should be. e.g. the default opening character is ‘<‘ and the default closing is ‘>’, but the administrator can change them for you as desired, e.g. ‘#’ and ‘#’.

NOTE: Know that if these characters exist in the document then any text between them will be treated as a tag and it will get removed from the document, but no actual location will appear on your final document. So, be careful about this.

Now, let’s explain the tag syntax, assuming the opening/closing characters are the default.

As of v1 of this feature, we support only 4 types of eSign locations:

– DateTime (or only Date or Time) location
– Signature location
– Initial location
– Text location

syntax format: <[Location Type]_[Location Option]_[Role Name]_[Location Width in pixels]>

Definitions:

  1. Locations Types:
  • DateTime:
    There are 3 possible values for this (dt = datetime, d = date only, t = time only)

    • Location Options:
      req for Required
      opt for Optional
      aut for Auto-Fill
  • Signature:
    Specified as, sig

    • Location Options:
      req for Required
      opt for Optional
  • Initial:
    Specified as, ini

    • Location Options:
      req for Required
      opt for Optional
  • Text:
    Specified as, txt

    • Location Options:
      req for Required
      opt for Optional
  1. Role Name
    • This can be any name you want that matches your roles in eSign. If you mistype a role then it will not get mapped to the corresponding eSign role and your document will need to be mapped manually through eSign UI.
  2. Location Width
    • This is in pixels, if not provided or value is below the minimum zone value, then the zone will be set to its default value.
      • Signature’s minimum width is: 80px, and default: 175px
      • Initial’s minimum width is: 35px, and default: 45px
      • Date/Time minimum width is: 50px, and default: 100px
      • Text’s minimum width: 20px, and default: 175px

Examples 1:
Location of datetime, required, for role buyer. Will default to the default width.

<dt_req_buyer>

Location of date only, required, for role buyer, with 150px width.

<dt_req_buyer_150>

Example 2:
Location of time only, optional, for role seller, will default to default size since 10px is under minimum size.

<t_opt_seller_10>

Example 3:
Location of signature, required, for role seller, a width of 100px.

<sig_req_seller_100>