When defining a document resource within an envelope, you have two options: using documents or templates.

If you want to add signature places or dynamic data, such as the time a recipient signed, see Places.

​
Documents vs Templates

​
Documents

If you have a PDF document ready you can simply specify the url field in a Document resource to point to that file (or a temporal file)

​
Templates

SignatureAPI can generate documents programmatically from a static template combined with dynamic data.

We accept templates in the , which is widely supported by software such as Microsoft Word, Google Docs, and open-source productivity suites like LibreOffice.

DOCX files created with software other than Microsoft Word (like Google Docs or LibreOffice) may not be processed correctly. If you get a cannot-parse-document error, try opening the file in Microsoft Word and saving it again. If you don’t have Microsoft Word, contact support for help.

Within the template, you can add fields and conditionals. These will be populated with the data provided in the data field in a Document resource.

​
Example

Consider a template like this:

This Dummy Agreement is entered into by {{person.name}}, currently residing at {{person.address}}. The terms and conditions outlined in this agreement shall be governed by the laws of {{jurisdiction}}.

{{if mediation}}
Any dispute shall be resolved by mediation, with each party bearing its own costs.
{{else}}
Any dispute shall be settled by arbitration, and the arbitrator’s decision is final.
{{endif}}

When data is inserted:

{
  "url": "https://...",
  "data": {
   "person": {
    "name": "Sherlock Holmes",
    "address": "221b Baker Street, London"
   },
   "jurisdiction": "The United Kingdom",
   "mediation": false
  }
}

You get this document:

This Dummy Agreement is entered into by Sherlock Holmes, currently residing at 221b Baker Street, London. The terms and conditions outlined in this agreement shall be governed by the laws of The United Kingdom.

Any dispute shall be settled by arbitration, and the arbitrator’s decision is final.

​
Fields

Fields are markers within a template that indicate where specific information should be inserted. They are defined within your template with double curly braces, for example: {{name}}.

For example, a template:

This Dummy Agreement is entered into by {{name}}.

With data:

{
  "name": "Sherlock Holmes"
}

Will return the document:

This Dummy Agreement is entered into by Sherlock Holmes.

​
Nested objects

You can use nested objects in the data value. For example, a template:

This Dummy Agreement is entered into by {{person.name}}, currently residing at {{person.address.houseNumber}} {{person.address.streetName}}, {{person.address.city}}.

With a data value:

{
  "person": {
    "name": "Sherlock Holmes",
    "address": {
      "houseNumber": "221b",
      "streetName": "Baker Street",
      "city": "London"
    }
  }
}

Will return the document:

This Dummy Agreement is entered into by Sherlock Holmes, currently residing at 221b Baker Street, London.

​
Conditionals

Conditionals in templates allow for the inclusion or exclusion of content based on certain conditions.

​
If

You can use {{if Condition}} and {{endif}} to show or hide the content in between, depending on whether Condition is true or not.

For example, a template:

Please read before proceeding.

{{if showDisclaimer}}
Information provided is for educational purposes only and should not be considered as professional advice.
{{endif}}

Use at your own discretion.

With the data value:

{
  "showDisclaimer": true
}

Will return the document:

Please read before proceeding.

Information provided is for educational purposes only and should not be considered as professional advice.

Use at your own discretion.

But with the data value:

{
  "showDisclaimer": false
}

Will return the document:

Please read before proceeding.

Use at your own discretion.

​
If-Else

You can use {{if Condition}}, {{else}}, and {{endif}} to conditionally display content based on whether Condition is true or false.”

For example, a template:

{{if mediation}}
Any dispute shall be resolved by mediation, with each party bearing its own costs.
{{else}}
Any dispute shall be settled by arbitration, and the arbitrator’s decision is final.
{{endif}}

With data:

{
  "mediation": true
}

Will return the document:

Any dispute shall be resolved by mediation, with each party bearing its own costs.

But with data:

{
  "mediation": false
}

Will return the document:

Any dispute shall be settled by arbitration, and the arbitrator’s decision is final.