This add-on is operated by

API Platform for Signing Documents


Last Updated: 07 May 2015

The Signature add-on is currently in beta.

Table of Contents

Signature is an add-on for adding document signing to your application.

Signature handles everything, converting documents to pixel perfect html, building the signing interface, and storing signed copies. It works on all modern devices - phones, tablets, and computers. Signers don’t have to download anything or learn new software.

Signature is accessible via an API and has supported client libraries for Ruby and Node.js.

Provisioning the add-on

Signature can be attached to a Heroku application via the CLI:

A list of all plans available can be found here.

$ heroku addons:create signature
-----> Adding signature to sharp-mountain-4005... done, v18 (free)

Once Signature has been added a SIGNATURE_SECRET_API_KEY setting will be available in the app configuration and will contain the secret token used to access the newly provisioned Signature service instance. This can be confirmed using the heroku config:get command.

$ heroku config:get SIGNATURE_SECRET_API_KEY

After installing Signature the application should be configured to fully integrate with the add-on.

Using with Rails 3.x

Ruby on Rails applications will need to add the following entry into their Gemfile specifying the Signature client library.

gem 'signatureio'

Update application dependencies with bundler.

$ bundle install

Push your code up to heroku.

$ git push heroku master

Try it out in Rails console.

$ bundle exec heroku run console
$ Signatureio::Document.create(:url => "")
$ Signatureio::Document.retrieve("id_of_document")
$ Signatureio::Document.all

See the signatureio gem for more details. Also, be sure to take a look at the example app Personal.

Using with Node.js

Edit your package.json, add signatureio to the dependencies section. For example:

  "name": "node-example",
  "version": "0.0.1",
  "dependencies": {
    "express": "3.1.x",
    "signatureio": ""
  "engines": {
    "node": "0.8.x"

Run npm install to install the Signatureio npm in your local environment:

$ npm install

Finally, initialize the module in your node app:

var signatureio = require('signatureio');

Signatureio npm will be automatically installed and available for your application on Heroku when you push a new version (git push heroku master).

See the signatureio npm for more details.

Using with Python/Django/Java/etc

There are not libraries available for Python, or Java at this time. Please see the for instructions on building your own HTTP requests to use and consume the API.


For all troubleshooting, contact

Migrating between plans

Application owners should carefully manage the migration timing to ensure proper application function during the migration process.

Use the heroku addons:upgrade command to migrate to a new plan.

$ heroku addons:upgrade signature:newplan
-----> Upgrading signature:newplan to sharp-mountain-4005... done, v18 ($49/mo)
       Your plan has been updated to: signature:newplan

Removing the add-on

Signature can be removed via the CLI.

This will destroy all associated data - documents and signatures - and cannot be undone!

$ heroku addons:destroy signature
-----> Removing signature from sharp-mountain-4005... done, v20 (free)

Before removing Signature a data export can be performed by contacting


All Signature support and runtime issues should be submitted via one of the Heroku Support channels. Any non-support related issues or product feedback is welcome at