Signaturit for Developers.

Signaturit is a scalable and affordable digital signature service. Our development team will help you in your integration efforts and answering your questions.

1

Register

Register now on our Sandbox servers to start building your integration.

2

Authenticate

Go to your user panel to get the access token you will need to attach to every request.

3

Start signing

Create a signature request and start signing your documents with Signaturit.

Sandbox

In order to test the API thoroughly, we offer you a sandbox servers. In this server, you can try all the methods for free and see how the API works.

You can register here and then, pick up your access token from your dashboard and begin to try.

Remember that all the data in sandbox is not real, and it will be cleared every month.

Every API call in sandbox is done with the URL: http://api.sandbox.signaturit.com/v2

When you complete your integration, you will need to register on our production servers in order to get your production access token.

Every API call in production is done with the URL: https://api.signaturit.com/v2

0Auth2

Signaturit uses OAuth2 in order to authenticate users to the server, so you need to request an access token to the servers. To do that, you have to register for Signaturit service and then log in to your dashboard to request an access token. You can request an access token anytime.

access_token = 'ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0'

API Calls

Now you have an access token and you want to make some calls. There's only one thing left to do, you need to add this token to the header of your petitions.

For instance, to use the token from the previous example in your headers:

Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0

If you are using cURL to test the API you can set a custom header with the -H flag.

$ curl
-X GET
-H 'Content-Type: application/json'
-H 'Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0'
api.sandbox.signaturit.com/v2/documents.json

Support

In case you need any help with your integration, please drop an email to support@signatur.it. We will be pleased to help you with any problem.

Libraries

The Signaturit cURL API is built to be simple and usable. But we want to deliver nicely written wrappers to the developers in order to make the experience with our platform even better.

Account

One account represents the list of features that user has in Signaturit. These features are associated to the purchased license. An account has the following attributes:

Id
Account identifier.
Users limit
The number of users that one account can have.
Max allowed requests
Number of signature requests that one account can make.
Month allowed requests
Number of signature requests that one account can make per month.
Day allowed requests
Number of signature requests that one account can make per day.
Multi-sign
Lets the recipients sign in sequential order.
Multi-page
Sign in multiple pages.
Alerts
Get an email every time the signer opens or signs the document.
Default branding
Account default branding (see branding section).
In-person sign
Sign your documents immediately without sending an email.
Picture
A photo of the signer can be required in the signature process.
Voice
A voice record can be required in the signature process.
{
    "id": "3d1bf4f8-bcfe-11e3-8d1e-0a063b2144ed",
    "users_limit": 2147483647,
    "max_allowed_requests": 2147483647,
    "month_allowed_requests": 2147483647,
    "day_allowed_requests": 2147483647,
    "multi_sign": true,
    "multi_page": true,
    "alerts": true,
    "default_branding": {
        "id": "3e5f836a-db3a-11e3-8d1e-0a063b2144ed",
        "shared": true,
        "subject_tag": "signaturit",
        "application_texts": [],
        "reminders": [1800, 50400],
        "expire_time": 64800,
        "hide_contact_section": false,
        "hide_info_section": false,
        "hide_legal_section": false,
        "created_at": "2014-04-05T20:09:47+0000"
    },
    "api": true,
    "in_person_sign": true,
    "picture": true,
    "voice": true,
    "created_at": "2014-04-05T20:09:48+0000"
}

GET /account.(json | xml)

Description

Get your account information.

Status Codes
  • 200 Success
  • 400 Wrong params
  • 403 Permission denied
Response

User account in JSON or XML format.

Example request
$ curl
-X GET
-H 'Content-Type: application/json'
-H 'Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0'
api.sandbox.signaturit.com/v2/account.json

{
    "id":"3d1bf4f8-bcfe-11e3-8d1e-0a063b2144ed",
    "users_limit":2147483647,
    "max_allowed_requests":2147483647,
    "total_used": 10,
    "month_allowed_requests":2147483647,
    "month_used": 5,
    "day_allowed_requests":2147483647,
    "day_used": 1,
    "multi_sign":true,
    "multi_page":true,
    "alerts":true,
    "default_branding":{
        "id":"3e5f836a-db3a-11e3-8d1e-0a063b2144ed",
        "shared"=>true,
        "subject_tag"=>"signaturit",
        "application_texts":[],
        "reminders":[1800, 50400],
        "expire_time":64800,
        "hide_contact_section":false,
        "hide_info_section":false,
        "hide_legal_section":false,
        "created_at":"2014-04-05T20:09:47+0000"
    },
    "api":true,
    "in_person_sign":true,
    "picture":true,
    "created_at":"2014-04-05T20:09:48+0000"
}
client = SignaturitClient.new('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.get_account

{
    "id":"3d1bf4f8-bcfe-11e3-8d1e-0a063b2144ed",
    "users_limit":2147483647,
    "max_allowed_requests":2147483647,
    "total_used": 10,
    "month_allowed_requests":2147483647,
    "month_used": 5,
    "day_allowed_requests":2147483647,
    "day_used": 1,
    "multi_sign":true,
    "multi_page":true,
    "alerts":true,
    "default_branding":{
        "id":"3e5f836a-db3a-11e3-8d1e-0a063b2144ed",
        "shared"=>true,
        "subject_tag"=>"signaturit",
        "application_texts":[],
        "reminders":[1800, 50400],
        "expire_time":64800,
        "hide_contact_section":false,
        "hide_info_section":false,
        "hide_legal_section":false,
        "created_at":"2014-04-05T20:09:47+0000"
    },
    "api":true,
    "in_person_sign":true,
    "picture":true,
    "created_at":"2014-04-05T20:09:48+0000"
}
client = SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.get_account()

{
    "id":"3d1bf4f8-bcfe-11e3-8d1e-0a063b2144ed",
    "users_limit":2147483647,
    "max_allowed_requests":2147483647,
    "total_used": 10,
    "month_allowed_requests":2147483647,
    "month_used": 5,
    "day_allowed_requests":2147483647,
    "day_used": 1,
    "multi_sign":true,
    "multi_page":true,
    "alerts":true,
    "default_branding":{
        "id":"3e5f836a-db3a-11e3-8d1e-0a063b2144ed",
        "shared"=>true,
        "subject_tag"=>"signaturit",
        "application_texts":[],
        "reminders":[1800, 50400],
        "expire_time":64800,
        "hide_contact_section":false,
        "hide_info_section":false,
        "hide_legal_section":false,
        "created_at":"2014-04-05T20:09:47+0000"
    },
    "api":true,
    "in_person_sign":true,
    "picture":true,
    "created_at":"2014-04-05T20:09:48+0000"
}
$client = new Signaturit\Client('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
$client->getAccount();

{
    "id":"3d1bf4f8-bcfe-11e3-8d1e-0a063b2144ed",
    "users_limit":2147483647,
    "max_allowed_requests":2147483647,
    "total_used": 10,
    "month_allowed_requests":2147483647,
    "month_used": 5,
    "day_allowed_requests":2147483647,
    "day_used": 1,
    "multi_sign":true,
    "multi_page":true,
    "alerts":true,
    "default_branding":{
        "id":"3e5f836a-db3a-11e3-8d1e-0a063b2144ed",
        "shared"=>true,
        "subject_tag"=>"signaturit",
        "application_texts":[],
        "reminders":[1800, 50400],
        "expire_time":64800,
        "hide_contact_section":false,
        "hide_info_section":false,
        "hide_legal_section":false,
        "created_at":"2014-04-05T20:09:47+0000"
    },
    "api":true,
    "in_person_sign":true,
    "picture":true,
    "created_at":"2014-04-05T20:09:48+0000"
}
client = new SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
client.getAccount();

{
    "id":"3d1bf4f8-bcfe-11e3-8d1e-0a063b2144ed",
    "users_limit":2147483647,
    "max_allowed_requests":2147483647,
    "total_used": 10,
    "month_allowed_requests":2147483647,
    "month_used": 5,
    "day_allowed_requests":2147483647,
    "day_used": 1,
    "multi_sign":true,
    "multi_page":true,
    "alerts":true,
    "default_branding":{
        "id":"3e5f836a-db3a-11e3-8d1e-0a063b2144ed",
        "shared"=>true,
        "subject_tag"=>"signaturit",
        "application_texts":[],
        "reminders":[1800, 50400],
        "expire_time":64800,
        "hide_contact_section":false,
        "hide_info_section":false,
        "hide_legal_section":false,
        "created_at":"2014-04-05T20:09:47+0000"
    },
    "api":true,
    "in_person_sign":true,
    "picture":true,
    "created_at":"2014-04-05T20:09:48+0000"
}

POST /account/storage.(json | xml)

Description

Set your account's document storage.

Every document is stored in our system. But if you want, you can change your account credentials in order to store a copy of the data in your server.

Signaturit documents can be stored in:

  • Sftp server
  • S3
Status Codes
  • 200 Success
  • 400 Wrong params
  • 403 Permission denied
Sftp parameters
type
Value must be sftp, in order to tell the system that you'll be storing the documents in a sftp server.
auth_method
This method can be KEY or PASS, in order to choose key or password authentication.
host
Server host name. KEY, PASS auth_method
port
SSH port. KEY, PASS auth_method
dir
The folder where you want to store the documents. KEY, PASS auth_method
user
Server username. KEY, PASS auth_method
password
Username password. PASS auth_method
private
Private key. KEY auth_method
public
Public key. KEY auth_method
passphrase
Key passphrase. KEY auth_method
Example request
$ curl
-X POST
-H 'Content-Type: application/json'
-H 'Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0'
-d '{"type": "sftp", "auth_method": "PASS", "dir": "/data/signaturit", "host": "storage.company.com" , "port": "2222", "user": "YOUR_UNIX_USER", "password": "YOUR_USER_PASSWORD"}'
api.sandbox.signaturit.com/v2/account.json

{
    "id": "3d1bf4f8-bcfe-11e3-8d1e-0a063b2144ed",
    "users_limit": 2147483647,
    "max_allowed_requests": 2147483647,
    "month_allowed_requests": 2147483647,
    "day_allowed_requests": 2147483647,
    "multi_sign": true,
    "multi_page": true,
    "alerts": true,
    "default_branding": {
        "id": "3e5f836a-db3a-11e3-8d1e-0a063b2144ed",
        "shared": true,
        "subject_tag": "signaturit",
        "application_texts": [],
        "reminders": [1800, 50400],
        "expire_time": 64800,
        "hide_contact_section": false,
        "hide_info_section": false,
        "hide_legal_section": false,
        "created_at": "2014-04-05T20:09:47+0000"
    },
    "api": true,
    "in_person_sign": true,
    "picture": true,
    "voice": true,
    "created_at": "2014-04-05T20:09:48+0000"
}
client = SignaturitClient.new('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.set_document_storage('sftp', {
    :user => 'YOUR_UNIX_USER',
    :password => 'YOUR_USER_PASSWORD',
    :port => 2222,
    :dir => '/data/signaturit',
    :host => 'storage.company.com',
    :auth_method => 'PASS'
})

{
    "id": "3d1bf4f8-bcfe-11e3-8d1e-0a063b2144ed",
    "users_limit": 2147483647,
    "max_allowed_requests": 2147483647,
    "month_allowed_requests": 2147483647,
    "day_allowed_requests": 2147483647,
    "multi_sign": true,
    "multi_page": true,
    "alerts": true,
    "default_branding": {
        "id": "3e5f836a-db3a-11e3-8d1e-0a063b2144ed",
        "shared": true,
        "subject_tag": "signaturit",
        "application_texts": [],
        "reminders": [1800, 50400],
        "expire_time": 64800,
        "hide_contact_section": false,
        "hide_info_section": false,
        "hide_legal_section": false,
        "created_at": "2014-04-05T20:09:47+0000"
    },
    "api": true,
    "in_person_sign": true,
    "picture": true,
    "voice": true,
    "created_at": "2014-04-05T20:09:48+0000"
}
client = SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.set_document_storage('sftp', {
    'user': 'YOUR_UNIX_USER',
    'password': 'YOUR_USER_PASSWORD',
    'port': 2222,
    'dir': '/data/signaturit',
    'host': 'storage.company.com',
    'auth_method': 'PASS'
})

{
    "id": "3d1bf4f8-bcfe-11e3-8d1e-0a063b2144ed",
    "users_limit": 2147483647,
    "max_allowed_requests": 2147483647,
    "month_allowed_requests": 2147483647,
    "day_allowed_requests": 2147483647,
    "multi_sign": true,
    "multi_page": true,
    "alerts": true,
    "default_branding": {
        "id": "3e5f836a-db3a-11e3-8d1e-0a063b2144ed",
        "shared": true,
        "subject_tag": "signaturit",
        "application_texts": [],
        "reminders": [1800, 50400],
        "expire_time": 64800,
        "hide_contact_section": false,
        "hide_info_section": false,
        "hide_legal_section": false,
        "created_at": "2014-04-05T20:09:47+0000"
    },
    "api": true,
    "in_person_sign": true,
    "picture": true,
    "voice": true,
    "created_at": "2014-04-05T20:09:48+0000"
}
$client = new Signaturit\Client('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
$client->setDocumentStorage(
    'sftp',
    array(
        'user' => 'YOUR_UNIX_USER',
        'password' => 'YOUR_USER_PASSWORD',
        'port' => '2222',
        'dir' => '/data/signaturit',
        'host' => 'storage.company.com',
        'auth_method' => 'PASS'
    )
);

{
    "id": "3d1bf4f8-bcfe-11e3-8d1e-0a063b2144ed",
    "users_limit": 2147483647,
    "max_allowed_requests": 2147483647,
    "month_allowed_requests": 2147483647,
    "day_allowed_requests": 2147483647,
    "multi_sign": true,
    "multi_page": true,
    "alerts": true,
    "default_branding": {
        "id": "3e5f836a-db3a-11e3-8d1e-0a063b2144ed",
        "shared": true,
        "subject_tag": "signaturit",
        "application_texts": [],
        "reminders": [1800, 50400],
        "expire_time": 64800,
        "hide_contact_section": false,
        "hide_info_section": false,
        "hide_legal_section": false,
        "created_at": "2014-04-05T20:09:47+0000"
    },
    "api": true,
    "in_person_sign": true,
    "picture": true,
    "voice": true,
    "created_at": "2014-04-05T20:09:48+0000"
}
client = new SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
client.setDocumentStorage('sftp', {
    user: 'YOUR_UNIX_USER',
    password: 'YOUR_USER_PASSWORD',
    port: '2222',
    dir: '/data/signaturit',
    host: 'storage.company.com',
    auth_method: 'PASS'
});

{
    "id": "3d1bf4f8-bcfe-11e3-8d1e-0a063b2144ed",
    "users_limit": 2147483647,
    "max_allowed_requests": 2147483647,
    "month_allowed_requests": 2147483647,
    "day_allowed_requests": 2147483647,
    "multi_sign": true,
    "multi_page": true,
    "alerts": true,
    "default_branding": {
        "id": "3e5f836a-db3a-11e3-8d1e-0a063b2144ed",
        "shared": true,
        "subject_tag": "signaturit",
        "application_texts": [],
        "reminders": [1800, 50400],
        "expire_time": 64800,
        "hide_contact_section": false,
        "hide_info_section": false,
        "hide_legal_section": false,
        "created_at": "2014-04-05T20:09:47+0000"
    },
    "api": true,
    "in_person_sign": true,
    "picture": true,
    "voice": true,
    "created_at": "2014-04-05T20:09:48+0000"
}
Amazon S3 parameters
type
Value must be s3, in order to tell the system that you'll be storing the documents in amazon s3.
bucket
Your amazon s3 bucket.
key
Amazon s3 key.
secret
Amazon s3 secret.
Example request
$ curl
-X POST
-H 'Content-Type: application/json'
-H 'Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0'
-d '{"type": "s3", "bucket": "YOUR_BUCKET_NAME", "key": "YOUR_KEY", "secret": "YOUR_KEY_SECRET"}'
api.sandbox.signaturit.com/v2/account/storage.json

{
    "id": "3d1bf4f8-bcfe-11e3-8d1e-0a063b2144ed",
    "users_limit": 2147483647,
    "max_allowed_requests": 2147483647,
    "month_allowed_requests": 2147483647,
    "day_allowed_requests": 2147483647,
    "multi_sign": true,
    "multi_page": true,
    "alerts": true,
    "default_branding": {
        "id": "3e5f836a-db3a-11e3-8d1e-0a063b2144ed",
        "shared": true,
        "subject_tag": "signaturit",
        "application_texts": [],
        "reminders": [1800, 50400],
        "expire_time": 64800,
        "hide_contact_section": false,
        "hide_info_section": false,
        "hide_legal_section": false,
        "created_at": "2014-04-05T20:09:47+0000"
    },
    "api": true,
    "in_person_sign": true,
    "picture": true,
    "voice": true,
    "created_at": "2014-04-05T20:09:48+0000"
}
client = SignaturitClient.new('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.set_document_storage('s3', {
    :bucket => 'YOUR_BUCKET_NAME',
    :key => 'YOUR_KEY',
    :secret => 'YOUR_KEY_SECRET'
})

{
    "id": "3d1bf4f8-bcfe-11e3-8d1e-0a063b2144ed",
    "users_limit": 2147483647,
    "max_allowed_requests": 2147483647,
    "month_allowed_requests": 2147483647,
    "day_allowed_requests": 2147483647,
    "multi_sign": true,
    "multi_page": true,
    "alerts": true,
    "default_branding": {
        "id": "3e5f836a-db3a-11e3-8d1e-0a063b2144ed",
        "shared": true,
        "subject_tag": "signaturit",
        "application_texts": [],
        "reminders": [1800, 50400],
        "expire_time": 64800,
        "hide_contact_section": false,
        "hide_info_section": false,
        "hide_legal_section": false,
        "created_at": "2014-04-05T20:09:47+0000"
    },
    "api": true,
    "in_person_sign": true,
    "picture": true,
    "voice": true,
    "created_at": "2014-04-05T20:09:48+0000"
}
client = SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.set_document_storage('s3', {
    'bucket': 'YOUR_BUCKET_NAME',
    'key': 'YOUR_KEY',
    'secret': 'YOUR_KEY_SECRET'
})

{
    "id": "3d1bf4f8-bcfe-11e3-8d1e-0a063b2144ed",
    "users_limit": 2147483647,
    "max_allowed_requests": 2147483647,
    "month_allowed_requests": 2147483647,
    "day_allowed_requests": 2147483647,
    "multi_sign": true,
    "multi_page": true,
    "alerts": true,
    "default_branding": {
        "id": "3e5f836a-db3a-11e3-8d1e-0a063b2144ed",
        "shared": true,
        "subject_tag": "signaturit",
        "application_texts": [],
        "reminders": [1800, 50400],
        "expire_time": 64800,
        "hide_contact_section": false,
        "hide_info_section": false,
        "hide_legal_section": false,
        "created_at": "2014-04-05T20:09:47+0000"
    },
    "api": true,
    "in_person_sign": true,
    "picture": true,
    "voice": true,
    "created_at": "2014-04-05T20:09:48+0000"
}
$client = new Signaturit\Client('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
$client->setDocumentStorage(
    's3',
    array(
        'bucket' => 'YOUR_BUCKET_NAME',
        'key' => 'YOUR_KEY',
        'secret' => 'YOUR_KEY_SECRET'
    )
);

{
    "id": "3d1bf4f8-bcfe-11e3-8d1e-0a063b2144ed",
    "users_limit": 2147483647,
    "max_allowed_requests": 2147483647,
    "month_allowed_requests": 2147483647,
    "day_allowed_requests": 2147483647,
    "multi_sign": true,
    "multi_page": true,
    "alerts": true,
    "default_branding": {
        "id": "3e5f836a-db3a-11e3-8d1e-0a063b2144ed",
        "shared": true,
        "subject_tag": "signaturit",
        "application_texts": [],
        "reminders": [1800, 50400],
        "expire_time": 64800,
        "hide_contact_section": false,
        "hide_info_section": false,
        "hide_legal_section": false,
        "created_at": "2014-04-05T20:09:47+0000"
    },
    "api": true,
    "in_person_sign": true,
    "picture": true,
    "voice": true,
    "created_at": "2014-04-05T20:09:48+0000"
}
client = new SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
client.setDocumentStorage('s3', {
    bucket: 'YOUR_BUCKET_NAME',
    key: 'YOUR_KEY',
    secret: 'YOUR_KEY_SECRET'
});

{
    "id": "3d1bf4f8-bcfe-11e3-8d1e-0a063b2144ed",
    "users_limit": 2147483647,
    "max_allowed_requests": 2147483647,
    "month_allowed_requests": 2147483647,
    "day_allowed_requests": 2147483647,
    "multi_sign": true,
    "multi_page": true,
    "alerts": true,
    "default_branding": {
        "id": "3e5f836a-db3a-11e3-8d1e-0a063b2144ed",
        "shared": true,
        "subject_tag": "signaturit",
        "application_texts": [],
        "reminders": [1800, 50400],
        "expire_time": 64800,
        "hide_contact_section": false,
        "hide_info_section": false,
        "hide_legal_section": false,
        "created_at": "2014-04-05T20:09:47+0000"
    },
    "api": true,
    "in_person_sign": true,
    "picture": true,
    "voice": true,
    "created_at": "2014-04-05T20:09:48+0000"
}

DELETE /account/storage.(json | xml)

Description

Set your account's document storage to the default signaturit document storage.

Status Codes
  • 200 Success
  • 403 Permission denied
Example request
$ curl
-X DELETE
-H 'Content-Type: application/json'
-H 'Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0'
api.sandbox.signaturit.com/v2/account/storage.json

{
    "id":"3d1bf4f8-bcfe-11e3-8d1e-0a063b2144ed",
    "users_limit":2147483647,
    "max_allowed_requests":2147483647,
    "month_allowed_requests"=>2147483647,
    "day_allowed_requests"=>2147483647,
    "multi_sign":true,
    "multi_page":true,
    "alerts":true,
    "default_branding":{
        "id":"3e5f836a-db3a-11e3-8d1e-0a063b2144ed",
        "shared"=>true,
        "subject_tag"=>"signaturit",
        "application_texts":[],
        "reminders":[1800, 50400],
        "expire_time":64800,
        "hide_contact_section":false,
        "hide_info_section":false,
        "hide_legal_section":false,
        "created_at":"2014-04-05T20:09:47+0000"
    },
    "api":true,
    "in_person_sign":true,
    "picture":true,
    "created_at":"2014-04-05T20:09:48+0000"
}
client = SignaturitClient.new('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.revert_to_default_document_storage

{
    "id":"3d1bf4f8-bcfe-11e3-8d1e-0a063b2144ed",
    "users_limit":2147483647,
    "max_allowed_requests":2147483647,
    "month_allowed_requests"=>2147483647,
    "day_allowed_requests"=>2147483647,
    "multi_sign":true,
    "multi_page":true,
    "alerts":true,
    "default_branding":{
        "id":"3e5f836a-db3a-11e3-8d1e-0a063b2144ed",
        "shared"=>true,
        "subject_tag"=>"signaturit",
        "application_texts":[],
        "reminders":[1800, 50400],
        "expire_time":64800,
        "hide_contact_section":false,
        "hide_info_section":false,
        "hide_legal_section":false,
        "created_at":"2014-04-05T20:09:47+0000"
    },
    "api":true,
    "in_person_sign":true,
    "picture":true,
    "created_at":"2014-04-05T20:09:48+0000"
}
client = SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.revert_to_default_document_storage()

{
    "id":"3d1bf4f8-bcfe-11e3-8d1e-0a063b2144ed",
    "users_limit":2147483647,
    "max_allowed_requests":2147483647,
    "month_allowed_requests"=>2147483647,
    "day_allowed_requests"=>2147483647,
    "multi_sign":true,
    "multi_page":true,
    "alerts":true,
    "default_branding":{
        "id":"3e5f836a-db3a-11e3-8d1e-0a063b2144ed",
        "shared"=>true,
        "subject_tag"=>"signaturit",
        "application_texts":[],
        "reminders":[1800, 50400],
        "expire_time":64800,
        "hide_contact_section":false,
        "hide_info_section":false,
        "hide_legal_section":false,
        "created_at":"2014-04-05T20:09:47+0000"
    },
    "api":true,
    "in_person_sign":true,
    "picture":true,
    "created_at":"2014-04-05T20:09:48+0000"
}
$client = new Signaturit\Client('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
$client->revertToDefaultDocumentStorage();

{
    "id":"3d1bf4f8-bcfe-11e3-8d1e-0a063b2144ed",
    "users_limit":2147483647,
    "max_allowed_requests":2147483647,
    "month_allowed_requests"=>2147483647,
    "day_allowed_requests"=>2147483647,
    "multi_sign":true,
    "multi_page":true,
    "alerts":true,
    "default_branding":{
        "id":"3e5f836a-db3a-11e3-8d1e-0a063b2144ed",
        "shared"=>true,
        "subject_tag"=>"signaturit",
        "application_texts":[],
        "reminders":[1800, 50400],
        "expire_time":64800,
        "hide_contact_section":false,
        "hide_info_section":false,
        "hide_legal_section":false,
        "created_at":"2014-04-05T20:09:47+0000"
    },
    "api":true,
    "in_person_sign":true,
    "picture":true,
    "created_at":"2014-04-05T20:09:48+0000"
}
client = new SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
client.revertToDefaultDocumentStorage();

{
    "id":"3d1bf4f8-bcfe-11e3-8d1e-0a063b2144ed",
    "users_limit":2147483647,
    "max_allowed_requests":2147483647,
    "month_allowed_requests"=>2147483647,
    "day_allowed_requests"=>2147483647,
    "multi_sign":true,
    "multi_page":true,
    "alerts":true,
    "default_branding":{
        "id":"3e5f836a-db3a-11e3-8d1e-0a063b2144ed",
        "shared"=>true,
        "subject_tag"=>"signaturit",
        "application_texts":[],
        "reminders":[1800, 50400],
        "expire_time":64800,
        "hide_contact_section":false,
        "hide_info_section":false,
        "hide_legal_section":false,
        "created_at":"2014-04-05T20:09:47+0000"
    },
    "api":true,
    "in_person_sign":true,
    "picture":true,
    "created_at":"2014-04-05T20:09:48+0000"
}

Branding

One branding represents the full customization of signaturit app. Every color, text or feature is a parameter of branding entity.

Id
Branding identifier.
Shared
Branding object with shared = 1 are shared between Signaturit accounts. These brandings can't be updated.
Subject tag
Tag showed in every email subject.
Corporate layout color
Primary color used in all application. Signaturit's layout color is green.
Corporate text color
Primary color used in application. Signaturit's primary text color is black.
Alternate text color
Secondary color used application. Signaturit's alternate text color is white.
Application texts
Array with all the customizable texts for application widgets.
Callback URL
A URL that will receive the signature events as POST requests in realtime.
Position Y
Signature default position y.
Position X
Signature default position x.
Terms and conditions label
Text showed in signature pad, near the terms button.
Terms and conditions text
Custom message for terms and conditions text displayed when clicked on the terms link. It can be HTML.
Reminders
Array with time values (in seconds) to wait until send a reminder email.
Expire time
Expiration time (in seconds) of document.
Events url
Url to receive info for every event that happens in our system (see Events URL section).
Welcome page
Boolean that tells if the explanation page should appear on the app or not
Side menu
Boolean that tells if the side menu with decline option should appear on the app or not
{
    "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
    "shared": false,
    "subject_tag": "signaturit_developer",
    "corporate_layout_color": "#FAAC58",
    "corporate_text_color": "#B43104",
    "application_texts": {
                "sign_button": "Sign"
    },
    "callback_url": "http://testing.api.dev/thanks",
    "position_y": 0.3,
    "position_x": 0.5,
    "terms_and_conditions_label": "Please, accept this terms.",
    "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
    "reminders": [1200, 4500],
    "expire_time": 56000,
    "events_url": "http://testing.api.dev/parse",
    "created_at": "2014-08-26T10:04:00+0000"
}

GET /brandings.(json | xml)

Description

Get all brandings from your account.

Status Codes
  • 200 Success
  • 400 Wrong params
  • 403 Permission denied
Response

Branding list in JSON or XML format.

Example request
$ curl
-X GET
-H 'Content-Type: application/json'
-H 'Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0'
api.sandbox.signaturit.com/v2/brandings.json

[
    {
        "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
        "shared": false,
        "subject_tag": "signaturit_developer",
        "corporate_layout_color": "#ACACAC",
        "corporate_text_color": "#FCFCFC",
        "application_texts": {
            "sign_button": "Sign!",
            "send_button": "Send!",
            "photo": "We need a photo to fulfill this test request",
            "voice": "We need a voice record to fulfill this test request",
            "multi_page": "The pages that you need to sign in this test request are: "
        },
        "callback_url": "http://testing.api.dev/thanks",
        "position_y": [0.3],
        "position_x": [0.5],
        "terms_and_conditions_label": "Please, accept this terms.",
        "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
        "reminders": [1200, 4500],
        "expire_time": 56000,
        "events_url": "http://testing.api.dev/parse",
        "created_at": "2014-08-26T10:04:00+0000"
    },
    {
        "id": "eec5e47a-2871-11e4-b3d4-0aa7697eb409",
        "shared": true,
        "subject_tag": "signaturit",
        "application_texts": [],
        "reminders": [604800, 1209600, 1814400, 2419200],
        "expire_time": 2592000,
        "created_at": "2014-08-20T13:57:51+0000"
    }
]
client = SignaturitClient.new('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.get_brandings

[
    {
        "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
        "shared": false,
        "subject_tag": "signaturit_developer",
        "corporate_layout_color": "#ACACAC",
        "corporate_text_color": "#FCFCFC",
        "application_texts": {
            "sign_button": "Sign!",
            "send_button": "Send!",
            "photo": "We need a photo to fulfill this test request",
            "voice": "We need a voice record to fulfill this test request",
            "multi_page": "The pages that you need to sign in this test request are: "
        },
        "callback_url": "http://testing.api.dev/thanks",
        "position_y": [0.3],
        "position_x": [0.5],
        "terms_and_conditions_label": "Please, accept this terms.",
        "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
        "reminders": [1200, 4500],
        "expire_time": 56000,
        "events_url": "http://testing.api.dev/parse",
        "created_at": "2014-08-26T10:04:00+0000"
    },
    {
        "id": "eec5e47a-2871-11e4-b3d4-0aa7697eb409",
        "shared": true,
        "subject_tag": "signaturit",
        "application_texts": [],
        "reminders": [604800, 1209600, 1814400, 2419200],
        "expire_time": 2592000,
        "created_at": "2014-08-20T13:57:51+0000"
    }
]
client = SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.get_brandings()

[
    {
        "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
        "shared": false,
        "subject_tag": "signaturit_developer",
        "corporate_layout_color": "#ACACAC",
        "corporate_text_color": "#FCFCFC",
        "application_texts": {
            "sign_button": "Sign!",
            "send_button": "Send!",
            "photo": "We need a photo to fulfill this test request",
            "voice": "We need a voice record to fulfill this test request",
            "multi_page": "The pages that you need to sign in this test request are: "
        },
        "callback_url": "http://testing.api.dev/thanks",
        "position_y": [0.3],
        "position_x": [0.5],
        "terms_and_conditions_label": "Please, accept this terms.",
        "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
        "reminders": [1200, 4500],
        "expire_time": 56000,
        "events_url": "http://testing.api.dev/parse",
        "created_at": "2014-08-26T10:04:00+0000"
    },
    {
        "id": "eec5e47a-2871-11e4-b3d4-0aa7697eb409",
        "shared": true,
        "subject_tag": "signaturit",
        "application_texts": [],
        "reminders": [604800, 1209600, 1814400, 2419200],
        "expire_time": 2592000,
        "created_at": "2014-08-20T13:57:51+0000"
    }
]
$client = new Signaturit\Client('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
$client->getBrandings();

[
    {
        "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
        "shared": false,
        "subject_tag": "signaturit_developer",
        "corporate_layout_color": "#ACACAC",
        "corporate_text_color": "#FCFCFC",
        "application_texts": {
            "sign_button": "Sign!",
            "send_button": "Send!",
            "photo": "We need a photo to fulfill this test request",
            "voice": "We need a voice record to fulfill this test request",
            "multi_page": "The pages that you need to sign in this test request are: "
        },
        "callback_url": "http://testing.api.dev/thanks",
        "position_y": [0.3],
        "position_x": [0.5],
        "terms_and_conditions_label": "Please, accept this terms.",
        "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
        "reminders": [1200, 4500],
        "expire_time": 56000,
        "events_url": "http://testing.api.dev/parse",
        "created_at": "2014-08-26T10:04:00+0000"
    },
    {
        "id": "eec5e47a-2871-11e4-b3d4-0aa7697eb409",
        "shared": true,
        "subject_tag": "signaturit",
        "application_texts": [],
        "reminders": [604800, 1209600, 1814400, 2419200],
        "expire_time": 2592000,
        "created_at": "2014-08-20T13:57:51+0000"
    }
]
client = new SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
client.getBrandings();

[
    {
        "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
        "shared": false,
        "subject_tag": "signaturit_developer",
        "corporate_layout_color": "#ACACAC",
        "corporate_text_color": "#FCFCFC",
        "application_texts": {
            "sign_button": "Sign!",
            "send_button": "Send!",
            "photo": "We need a photo to fulfill this test request",
            "voice": "We need a voice record to fulfill this test request",
            "multi_page": "The pages that you need to sign in this test request are: "
        },
        "callback_url": "http://testing.api.dev/thanks",
        "position_y": [0.3],
        "position_x": [0.5],
        "terms_and_conditions_label": "Please, accept this terms.",
        "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
        "reminders": [1200, 4500],
        "expire_time": 56000,
        "events_url": "http://testing.api.dev/parse",
        "created_at": "2014-08-26T10:04:00+0000"
    },
    {
        "id": "eec5e47a-2871-11e4-b3d4-0aa7697eb409",
        "shared": true,
        "subject_tag": "signaturit",
        "application_texts": [],
        "reminders": [604800, 1209600, 1814400, 2419200],
        "expire_time": 2592000,
        "created_at": "2014-08-20T13:57:51+0000"
    }
]

GET /brandings/{id}.(json | xml)

Description

Get a branding.

Status Codes
  • 200 Success
  • 400 Wrong params
  • 403 Permission denied
  • 404 Branding not found
Response

A branding in JSON or XML format.

Example request
$ curl
-X GET
-H 'Content-Type: application/json'
-H 'Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0'
api.sandbox.signaturit.com/v2/brandings/0b1db805-2cf7-11e4-b3d4-0aa7697eb409.json

{
    "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
    "shared": false,
    "subject_tag": "signaturit_developer",
    "corporate_layout_color": "#FAAC58",
    "corporate_text_color": "#B43104",
    "application_texts": {
                "sign_button": "Sign"
    },
    "callback_url": "http://testing.api.dev/thanks",
    "position_y": [0.3],
    "position_x": [0.5],
    "terms_and_conditions_label": "Please, accept this terms.",
    "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
    "reminders": [1200, 4500],
    "expire_time": 56000,
    "events_url": "http://testing.api.dev/parse",
    "created_at": "2014-08-26T10:04:00+0000"
 }
client = SignaturitClient.new('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.get_branding('0b1db805-2cf7-11e4-b3d4-0aa7697eb409')

{
    "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
    "shared": false,
    "subject_tag": "signaturit_developer",
    "corporate_layout_color": "#FAAC58",
    "corporate_text_color": "#B43104",
    "application_texts": {
                "sign_button": "Sign"
    },
    "callback_url": "http://testing.api.dev/thanks",
    "position_y": [0.3],
    "position_x": [0.5],
    "terms_and_conditions_label": "Please, accept this terms.",
    "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
    "reminders": [1200, 4500],
    "expire_time": 56000,
    "events_url": "http://testing.api.dev/parse",
    "created_at": "2014-08-26T10:04:00+0000"
 }
client = SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.get_branding('0b1db805-2cf7-11e4-b3d4-0aa7697eb409')

{
    "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
    "shared": false,
    "subject_tag": "signaturit_developer",
    "corporate_layout_color": "#FAAC58",
    "corporate_text_color": "#B43104",
    "application_texts": {
                "sign_button": "Sign"
    },
    "callback_url": "http://testing.api.dev/thanks",
    "position_y": [0.3],
    "position_x": [0.5],
    "terms_and_conditions_label": "Please, accept this terms.",
    "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
    "reminders": [1200, 4500],
    "expire_time": 56000,
    "events_url": "http://testing.api.dev/parse",
    "created_at": "2014-08-26T10:04:00+0000"
 }
$client = new Signaturit\Client('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
$client->getBranding('0b1db805-2cf7-11e4-b3d4-0aa7697eb409');

{
    "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
    "shared": false,
    "subject_tag": "signaturit_developer",
    "corporate_layout_color": "#FAAC58",
    "corporate_text_color": "#B43104",
    "application_texts": {
                "sign_button": "Sign"
    },
    "callback_url": "http://testing.api.dev/thanks",
    "position_y": [0.3],
    "position_x": [0.5],
    "terms_and_conditions_label": "Please, accept this terms.",
    "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
    "reminders": [1200, 4500],
    "expire_time": 56000,
    "events_url": "http://testing.api.dev/parse",
    "created_at": "2014-08-26T10:04:00+0000"
 }
client = new SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
client.getBranding('0b1db805-2cf7-11e4-b3d4-0aa7697eb409');

{
    "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
    "shared": false,
    "subject_tag": "signaturit_developer",
    "corporate_layout_color": "#FAAC58",
    "corporate_text_color": "#B43104",
    "application_texts": {
                "sign_button": "Sign"
    },
    "callback_url": "http://testing.api.dev/thanks",
    "position_y": [0.3],
    "position_x": [0.5],
    "terms_and_conditions_label": "Please, accept this terms.",
    "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
    "reminders": [1200, 4500],
    "expire_time": 56000,
    "events_url": "http://testing.api.dev/parse",
    "created_at": "2014-08-26T10:04:00+0000"
 }

POST /brandings.(json | xml)

Description

Create a single branding.

Status Codes
  • 200 Success
  • 400 Wrong params
  • 403 Permission denied
Parameters
primary
This branding will be the default one for your account. OPTIONAL
subject_tag
Tag showed in every email subject. OPTIONAL
corporate_layout_color
Primary color used in all application widgets. OPTIONAL
corporate_text_color
Primary color used on texts.OPTIONAL
corporate_text_alternate_color
Secondary color used on texts. OPTIONAL
application_texts
Array with all the customizable texts for application widgets. OPTIONAL
  • - sign_button: Sign button text.
  • - send_button: Send button text.
  • - photo: Tells user that a photo is needed in the current process.
  • - voice: Tells user that a voice record is needed in the current process.
  • - multi_page: Tells user the number of pages to sign.
reminders
Array with time values (in seconds) to wait until send a reminder email. Set 0 to disable reminders. OPTIONAL
expire_time
This parameter sets the expiration time (in seconds) of a document. Set 0 to disable expiration. OPTIONAL
callback_url
Url to redirect the user when finish the signature process, instead of survey. OPTIONAL
events_url
Url to receive info for every event that happens in our system (see Events URL section). OPTIONAL
signature_pos_x
Array telling the signature default position X, every position range is from 0 to 1. The index of array references the document number, so first position value will apply to first document. OPTIONAL
signature_pos_y
Array telling the signature default position Y, every position range is from 0 to 1. The index of array references the document number, so first position value will apply to first document. OPTIONAL
terms_and_conditions_label
Text showed in signature pad, near the terms button. OPTIONAL
terms_and_conditions_text
Text that follow our terms text. It can be HTML. OPTIONAL
Welcome page
Boolean that tells if the explanation page should appear on the app or not
Side menu
Boolean that tells if the side menu with decline option should appear on the app or not
Response

The new branding in JSON or XML format.

Example request
$ curl
-X POST
-H 'Content-Type: application/json'
-H 'Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0'
-d '{
        "primary": "1",
        "subject_tag": "signaturit_developer",
        "corporate_layout_color": "#FAAC58",
        "corporate_text_color": "#B43104",
        "application_texts": {
                        "sign_button": "Sign"
        },
        "reminders": [1200, 4500],
        "expire_time": "56000",
        "callback_url": "http://testing.api.dev/thanks",
        "events_url": "http://testing.api.dev/parse",
        "signature_pos_x": [0.5],
        "signature_pos_y": [0.3],
        "terms_and_conditions_label": "Please, accept this terms.",
        "terms_and_conditions_text": "I will accept all this terms for testing purposes"
    }'
api.sandbox.signaturit.com/v2/brandings.json

{
    "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
    "shared": false,
    "subject_tag": "signaturit_developer",
    "corporate_layout_color": "#FAAC58",
    "corporate_text_color": "#B43104",
    "application_texts": {
                "sign_button": "Sign"
    },
    "callback_url": "http://testing.api.dev/thanks",
    "position_y": [0.3],
    "position_x": [0.5],
    "terms_and_conditions_label": "Please, accept this terms.",
    "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
    "reminders": [1200, 4500],
    "expire_time": 56000,
    "events_url": "http://testing.api.dev/parse",
    "created_at": "2014-08-26T10:04:00+0000"
}
client = SignaturitClient.new('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.create_branding({
    :primary => '1',
    :subject_tag => 'signaturit_developer',
    :corporate_layout_color => '#FAAC58',
    :corporate_text_color => '#B43104',
    :application_texts => {
                "sign_button": "Sign"
    },
    :reminders => [1200, 4500],
    :expire_time => '56000',
    :callback_url => 'http://testingapi.dev/thanks',
    :events_url => 'http://testingapi.dev/parse',
    :signature_pos_x => '[0.5]',
    :signature_pos_y => '[0.3]',
    :terms_and_conditions_label => 'Please, accept this terms.',
    :terms_and_conditions_text => 'I will accept all this terms for testing purposes'
})

{
    "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
    "shared": false,
    "subject_tag": "signaturit_developer",
    "corporate_layout_color": "#FAAC58",
    "corporate_text_color": "#B43104",
    "application_texts": {
                "sign_button": "Sign"
    },
    "callback_url": "http://testing.api.dev/thanks",
    "position_y": [0.3],
    "position_x": [0.5],
    "terms_and_conditions_label": "Please, accept this terms.",
    "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
    "reminders": [1200, 4500],
    "expire_time": 56000,
    "events_url": "http://testing.api.dev/parse",
    "created_at": "2014-08-26T10:04:00+0000"
}
client = SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.create_branding({
    'primary': 1,
    'subject_tag': 'signaturit_developer',
    'corporate_layout_color': '#FAAC58',
    'corporate_text_color': '#B43104',
    'application_texts': {
                "sign_button": "Sign"
    },
    'reminders': [1200, 4500],
    'expire_time': 56000,
    'callback_url': 'http://testing.api.dev/thanks',
    'events_url': 'http://testing.api.dev/parse',
    'signature_pos_x': [0.5],
    'signature_pos_y': [0.3],
    'terms_and_conditions_label': 'Please, accept this terms.',
    'terms_and_conditions_text': 'I will accept all this terms for testing purposes'
})
{
    "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
    "shared": false,
    "subject_tag": "signaturit_developer",
    "corporate_layout_color": "#FAAC58",
    "corporate_text_color": "#B43104",
    "application_texts": {
                "sign_button": "Sign"
    },
    "callback_url": "http://testing.api.dev/thanks",
    "position_y": [0.3],
    "position_x": [0.5],
    "terms_and_conditions_label": "Please, accept this terms.",
    "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
    "reminders": [1200, 4500],
    "expire_time": 56000,
    "events_url": "http://testing.api.dev/parse",
    "created_at": "2014-08-26T10:04:00+0000"
}
$client = new Signaturit\Client('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
$client->createBranding(array(
    'primary' => true,
    'subject_tag' => 'signaturit_developer',
    'corporate_layout_color' => '#FAAC58',
    'corporate_text_color' => '#B43104',
    'application_texts' => array(
                "sign_button": "Sign"
    ),
    'reminders' => array(1200, 4500),
    'expire_time' => 56000,
    'callback_url' => 'http://testingapi.dev/thanks',
    'events_url' => 'http://testingapi.dev/parse',
    'signature_pos_x' => array(0.5),
    'signature_pos_y' => array(0.3),
    'terms_and_conditions_label' => 'Please, accept this terms.',
    'terms_and_conditions_text' => 'I will accept all this terms for testing purposes'
));

{
    "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
    "shared": false,
    "subject_tag": "signaturit_developer_updater",
    "corporate_layout_color": "#FAAC58",
    "corporate_text_color": "#B43104",
    "application_texts": {
                "sign_button": "Sign"
    },
    "callback_url": "http://testing.api.dev/thanks",
    "position_y": 0.3,
    "position_x": 0.5,
    "terms_and_conditions_label": "Please, accept this terms.",
    "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
    "reminders": [1200, 4500],
    "expire_time": 56000,
    "events_url": "http://testing.api.dev/parse",
    "created_at": "2014-08-26T10:04:00+0000"
}
client = new SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
client.createBranding({
    primary: true,
    subject_tag: 'signaturit_developer',
    "corporate_layout_color": "#FAAC58",
    "corporate_text_color": "#B43104",
    "application_texts": {
                "sign_button": "Sign"
    }
    reminders: [1200, 4500],
    expire_time: 56000,
    callback_url: 'http://testingapi.dev/thanks',
    events_url: 'http://testingapi.dev/parse',
    signature_pos_x: [0.5],
    signature_pos_y: [0.3],
    terms_and_conditions_label: 'Please, accept this terms.',
    terms_and_conditions_text: 'I will accept all this terms for testing purposes'
});

{
    "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
    "shared": false,
    "subject_tag": "signaturit_developer_updater",
    "corporate_layout_color": "#FAAC58",
    "corporate_text_color": "#B43104",
    "application_texts": {
                "sign_button": "Sign"
    },
    "callback_url": "http://testing.api.dev/thanks",
    "position_y": 0.3,
    "position_x": 0.5,
    "terms_and_conditions_label": "Please, accept this terms.",
    "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
    "reminders": [1200, 4500],
    "expire_time": 56000,
    "events_url": "http://testing.api.dev/parse",
    "created_at": "2014-08-26T10:04:00+0000"
}

PATCH /brandings/{id}.(json | xml)

Description

Update a single branding.

Status Codes
  • 200 Success
  • 400 Wrong params
  • 403 Permission denied
  • 404 Branding not found
Parameters

Same parameters as CREATE BRANDING method.

Response

The updated branding in JSON or XML format.

Example request
$ curl
-X PATCH
-H 'Content-Type: application/json'
-H 'Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0'
-d '{
        "subject_tag": "signaturit_developer_updater",
        "application_texts": {
            "button.send": "Sign again!",
        }
    }'
api.sandbox.signaturit.com/v2/brandings/3eed17f5-2d08-11e4-b3d4-0aa7697eb409.json

{
    "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
    "shared": false,
    "subject_tag": "signaturit_developer_updater",
    "corporate_layout_color": "#FAAC58",
    "corporate_text_color": "#B43104",
    "application_texts": {
                "sign_button": "Sign"
    },
    "callback_url": "http://testing.api.dev/thanks",
    "position_y": 0.3,
    "position_x": 0.5,
    "terms_and_conditions_label": "Please, accept this terms.",
    "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
    "reminders": [1200, 4500],
    "expire_time": 56000,
    "events_url": "http://testing.api.dev/parse",
    "created_at": "2014-08-26T10:04:00+0000"
}
client = SignaturitClient.new('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.update_branding('3eed17f5-2d08-11e4-b3d4-0aa7697eb409', {
    :subject_tag => 'signaturit_developer_updater',
    :application_texts => {
        :button.send => 'Sign again!'
    }
})

{
    "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
    "shared": false,
    "subject_tag": "signaturit_developer_updater",
    "corporate_layout_color": "#FAAC58",
    "corporate_text_color": "#B43104",
    "application_texts": {
                "sign_button": "Sign"
    },
    "callback_url": "http://testing.api.dev/thanks",
    "position_y": 0.3,
    "position_x": 0.5,
    "terms_and_conditions_label": "Please, accept this terms.",
    "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
    "reminders": [1200, 4500],
    "expire_time": 56000,
    "events_url": "http://testing.api.dev/parse",
    "created_at": "2014-08-26T10:04:00+0000"
}
client = SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.update_branding('3eed17f5-2d08-11e4-b3d4-0aa7697eb409', {
    'subject_tag': 'signaturit_developer_updater',
    'application_texts': {
        'button.send': 'Sign again!'
    }
})

{
    "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
    "shared": false,
    "subject_tag": "signaturit_developer_updater",
    "corporate_layout_color": "#FAAC58",
    "corporate_text_color": "#B43104",
    "application_texts": {
                "sign_button": "Sign"
    },
    "callback_url": "http://testing.api.dev/thanks",
    "position_y": 0.3,
    "position_x": 0.5,
    "terms_and_conditions_label": "Please, accept this terms.",
    "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
    "reminders": [1200, 4500],
    "expire_time": 56000,
    "events_url": "http://testing.api.dev/parse",
    "created_at": "2014-08-26T10:04:00+0000"
}
$client = new Signaturit\Client('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
$client->updateBranding(
    '3eed17f5-2d08-11e4-b3d4-0aa7697eb409',
    array(
        'subject_tag' => 'signaturit_developer_updater',
        'application_texts' => array(
            'button.send' => 'Sign again!'
        )
    )
);

{
    "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
    "shared": false,
    "subject_tag": "signaturit_developer_updater",
    "corporate_layout_color": "#FAAC58",
    "corporate_text_color": "#B43104",
    "application_texts": {
                "sign_button": "Sign"
    },
    "callback_url": "http://testing.api.dev/thanks",
    "position_y": 0.3,
    "position_x": 0.5,
    "terms_and_conditions_label": "Please, accept this terms.",
    "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
    "reminders": [1200, 4500],
    "expire_time": 56000,
    "events_url": "http://testing.api.dev/parse",
    "created_at": "2014-08-26T10:04:00+0000"
}
client = new SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
client.updateBranding('3eed17f5-2d08-11e4-b3d4-0aa7697eb409', {
    subject_tag: 'signaturit_developer_updater',
    application_texts: {
        button.send: 'Sign again!'
    }
});

{
    "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
    "shared": false,
    "subject_tag": "signaturit_developer_updater",
    "corporate_layout_color": "#FAAC58",
    "corporate_text_color": "#B43104",
    "application_texts": {
                "sign_button": "Sign"
    },
    "callback_url": "http://testing.api.dev/thanks",
    "position_y": 0.3,
    "position_x": 0.5,
    "terms_and_conditions_label": "Please, accept this terms.",
    "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
    "reminders": [1200, 4500],
    "expire_time": 56000,
    "events_url": "http://testing.api.dev/parse",
    "created_at": "2014-08-26T10:04:00+0000"
}

PUT /brandings/{id}/logo.(json | xml)

Description

Change the logo of the branding.

Status Codes
  • 200 Success
  • 400 Wrong params
  • 403 Permission denied
  • 404 Branding not found
Example request
$ curl
-X PATCH
-H 'Content-Type: application/json'
-H 'Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0'
-T '/files/company-logo.png'
api.sandbox.signaturit.com/v2/brandings/3eed17f5-2d08-11e4-b3d4-0aa7697eb409/logo.json

{
    "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
    "shared": false,
    "subject_tag": "signaturit_developer",
    "corporate_layout_color": "#ACACAC",
    "corporate_text_color": "#FCFCFC",
    "application_texts": {
        "sign_button": "Sign!",
        "send_button": "Send!",
        "photo": "We need a photo to fulfill this test request",
        "voice": "We need a voice record to fulfill this test request",
        "multi_page": "The pages that you need to sign in this test request are: "
    },
    "callback_url": "http://testing.api.dev/thanks",
    "position_y": 0.3,
    "position_x": 0.5,
    "terms_and_conditions_label": "Please, accept this terms.",
    "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
    "reminders": [1200, 4500],
    "expire_time": 56000,
    "events_url": "http://testing.api.dev/parse",
    "created_at": "2014-08-26T10:04:00+0000"
}
client = SignaturitClient.new('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.update_branding_logo('3eed17f5-2d08-11e4-b3d4-0aa7697eb409', '/files/company-logo.png')

{
    "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
    "shared": false,
    "subject_tag": "signaturit_developer",
    "corporate_layout_color": "#ACACAC",
    "corporate_text_color": "#FCFCFC",
    "application_texts": {
        "sign_button": "Sign!",
        "send_button": "Send!",
        "photo": "We need a photo to fulfill this test request",
        "voice": "We need a voice record to fulfill this test request",
        "multi_page": "The pages that you need to sign in this test request are: "
    },
    "callback_url": "http://testing.api.dev/thanks",
    "position_y": 0.3,
    "position_x": 0.5,
    "terms_and_conditions_label": "Please, accept this terms.",
    "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
    "reminders": [1200, 4500],
    "expire_time": 56000,
    "events_url": "http://testing.api.dev/parse",
    "created_at": "2014-08-26T10:04:00+0000"
}
client = SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.update_branding_logo('3eed17f5-2d08-11e4-b3d4-0aa7697eb409', '/files/company-logo.png')

{
    "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
    "shared": false,
    "subject_tag": "signaturit_developer",
    "corporate_layout_color": "#ACACAC",
    "corporate_text_color": "#FCFCFC",
    "application_texts": {
        "sign_button": "Sign!",
        "send_button": "Send!",
        "photo": "We need a photo to fulfill this test request",
        "voice": "We need a voice record to fulfill this test request",
        "multi_page": "The pages that you need to sign in this test request are: "
    },
    "callback_url": "http://testing.api.dev/thanks",
    "position_y": 0.3,
    "position_x": 0.5,
    "terms_and_conditions_label": "Please, accept this terms.",
    "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
    "reminders": [1200, 4500],
    "expire_time": 56000,
    "events_url": "http://testing.api.dev/parse",
    "created_at": "2014-08-26T10:04:00+0000"
}
$client = new Signaturit\Client('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
$client->updateBrandingLogo('3eed17f5-2d08-11e4-b3d4-0aa7697eb409', '/files/company-logo.png');

{
    "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
    "shared": false,
    "subject_tag": "signaturit_developer",
    "corporate_layout_color": "#ACACAC",
    "corporate_text_color": "#FCFCFC",
    "application_texts": {
        "sign_button": "Sign!",
        "send_button": "Send!",
        "photo": "We need a photo to fulfill this test request",
        "voice": "We need a voice record to fulfill this test request",
        "multi_page": "The pages that you need to sign in this test request are: "
    },
    "callback_url": "http://testing.api.dev/thanks",
    "position_y": 0.3,
    "position_x": 0.5,
    "terms_and_conditions_label": "Please, accept this terms.",
    "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
    "reminders": [1200, 4500],
    "expire_time": 56000,
    "events_url": "http://testing.api.dev/parse",
    "created_at": "2014-08-26T10:04:00+0000"
}
client = new SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
client.updateBrandingLogo('3eed17f5-2d08-11e4-b3d4-0aa7697eb409', '/files/company-logo.png');

{
    "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
    "shared": false,
    "subject_tag": "signaturit_developer",
    "corporate_layout_color": "#ACACAC",
    "corporate_text_color": "#FCFCFC",
    "application_texts": {
        "sign_button": "Sign!",
        "send_button": "Send!",
        "photo": "We need a photo to fulfill this test request",
        "voice": "We need a voice record to fulfill this test request",
        "multi_page": "The pages that you need to sign in this test request are: "
    },
    "callback_url": "http://testing.api.dev/thanks",
    "position_y": 0.3,
    "position_x": 0.5,
    "terms_and_conditions_label": "Please, accept this terms.",
    "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
    "reminders": [1200, 4500],
    "expire_time": 56000,
    "events_url": "http://testing.api.dev/parse",
    "created_at": "2014-08-26T10:04:00+0000"
}

PUT /brandings/{id}/email/{template}.(json | xml)

Description

Change template of an email.

Status Codes
  • 200 Success
  • 400 Wrong params
  • 403 Permission denied
  • 404 Branding not found
Parameters

The template could be one of the following options:

sign_request
This template is the one the user receives when you send him a document to sign.
sign_receipt
This template is the one the user receives with a copy of signed document.
request_expired
This template is the one the user receives when a document expires.
pending_sign
This template is the one the user receives as a reminder of a document pending to sign.

The submitted HTML file can use some magic words:

{{sender_email}}
Tag replace by the sender email.
{{sign_button}}
Tag replaced by the signaturit button. This tag only can be used in sign_request and pending_sign templates.
{{signer_name}}
This tag is replaced by the signer name. OPTIONAL
{{signer_email}}
This tag is replaced by the signer email. OPTIONAL
{{filename}}
This tag is replaced by the file name. OPTIONAL
{{logo}}
This tag is replaced by the current logo. OPTIONAL
{{remaining_time}}
Show the remaining time for a document before its expiration. This tag can only be used in pending_sign template.
Example request
$ curl
-X PUT
-H 'Content-Type: application/json'
-H 'Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0'
-T '/files/emails/signature.html'
api.sandbox.signaturit.com/v2/brandings/3eed17f5-2d08-11e4-b3d4-0aa7697eb409/emails/sign_request.json

{
    "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
    "shared": false,
    "subject_tag": "signaturit_developer",
    "corporate_layout_color": "#ACACAC",
    "corporate_text_color": "#FCFCFC",
    "application_texts": {
        "sign_button": "Sign!",
        "send_button": "Send!",
        "photo": "We need a photo to fulfill this test request",
        "voice": "We need a voice record to fulfill this test request",
        "multi_page": "The pages that you need to sign in this test request are: "
    },
    "callback_url": "http://testing.api.dev/thanks",
    "position_y": 0.3,
    "position_x": 0.5,
    "terms_and_conditions_label": "Please, accept this terms.",
    "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
    "reminders": [1200, 4500],
    "expire_time": 56000,
    "events_url": "http://testing.api.dev/parse",
    "created_at": "2014-08-26T10:04:00+0000"
}
client = SignaturitClient.new('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.update_branding_template('3eed17f5-2d08-11e4-b3d4-0aa7697eb409', 'sign_request', '/files/emails/signature.html')

{
    "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
    "shared": false,
    "subject_tag": "signaturit_developer",
    "corporate_layout_color": "#ACACAC",
    "corporate_text_color": "#FCFCFC",
    "application_texts": {
        "sign_button": "Sign!",
        "send_button": "Send!",
        "photo": "We need a photo to fulfill this test request",
        "voice": "We need a voice record to fulfill this test request",
        "multi_page": "The pages that you need to sign in this test request are: "
    },
    "callback_url": "http://testing.api.dev/thanks",
    "position_y": 0.3,
    "position_x": 0.5,
    "terms_and_conditions_label": "Please, accept this terms.",
    "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
    "reminders": [1200, 4500],
    "expire_time": 56000,
    "events_url": "http://testing.api.dev/parse",
    "created_at": "2014-08-26T10:04:00+0000"
}
client = SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.update_branding_template('3eed17f5-2d08-11e4-b3d4-0aa7697eb409', 'sign_request', '/files/emails/signature.html')

{
    "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
    "shared": false,
    "subject_tag": "signaturit_developer",
    "corporate_layout_color": "#ACACAC",
    "corporate_text_color": "#FCFCFC",
    "application_texts": {
        "sign_button": "Sign!",
        "send_button": "Send!",
        "photo": "We need a photo to fulfill this test request",
        "voice": "We need a voice record to fulfill this test request",
        "multi_page": "The pages that you need to sign in this test request are: "
    },
    "callback_url": "http://testing.api.dev/thanks",
    "position_y": 0.3,
    "position_x": 0.5,
    "terms_and_conditions_label": "Please, accept this terms.",
    "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
    "reminders": [1200, 4500],
    "expire_time": 56000,
    "events_url": "http://testing.api.dev/parse",
    "created_at": "2014-08-26T10:04:00+0000"
}
$client = new Signaturit\Client('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
$client->updateBrandingTemplate('3eed17f5-2d08-11e4-b3d4-0aa7697eb409', 'sign_request', '/files/emails/signature.html');

{
    "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
    "shared": false,
    "subject_tag": "signaturit_developer",
    "corporate_layout_color": "#ACACAC",
    "corporate_text_color": "#FCFCFC",
    "application_texts": {
        "sign_button": "Sign!",
        "send_button": "Send!",
        "photo": "We need a photo to fulfill this test request",
        "voice": "We need a voice record to fulfill this test request",
        "multi_page": "The pages that you need to sign in this test request are: "
    },
    "callback_url": "http://testing.api.dev/thanks",
    "position_y": 0.3,
    "position_x": 0.5,
    "terms_and_conditions_label": "Please, accept this terms.",
    "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
    "reminders": [1200, 4500],
    "expire_time": 56000,
    "events_url": "http://testing.api.dev/parse",
    "created_at": "2014-08-26T10:04:00+0000"
}
client = new SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
client.updateBrandingTemplate('3eed17f5-2d08-11e4-b3d4-0aa7697eb409', 'sign_request', '/files/emails/signature.html');

{
    "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409",
    "shared": false,
    "subject_tag": "signaturit_developer",
    "corporate_layout_color": "#ACACAC",
    "corporate_text_color": "#FCFCFC",
    "application_texts": {
        "sign_button": "Sign!",
        "send_button": "Send!",
        "photo": "We need a photo to fulfill this test request",
        "voice": "We need a voice record to fulfill this test request",
        "multi_page": "The pages that you need to sign in this test request are: "
    },
    "callback_url": "http://testing.api.dev/thanks",
    "position_y": 0.3,
    "position_x": 0.5,
    "terms_and_conditions_label": "Please, accept this terms.",
    "terms_and_conditions_text": "I will accept all this terms for testing purposes.",
    "reminders": [1200, 4500],
    "expire_time": 56000,
    "events_url": "http://testing.api.dev/parse",
    "created_at": "2014-08-26T10:04:00+0000"
}

Events URL

The events URL allows you to configure a URL where we will send information in realtime about the signature process.

The configuration of this web service is done through the Create branding method, passing your web service's URL in the events_url parameter.

Example request
$ curl
-X POST
-H 'Content-Type: application/json'
-H 'Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0'
-d '{
        ...
        "events_url": "http://testing.api.dev/parse",
        ...
    }'
api.sandbox.signaturit.com/v2/brandings.json
client = SignaturitClient.new('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.create_branding({
    ...
    :events_url => 'http://testingapi.dev/parse',
    ...
})
client = SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.create_branding({
    ...
    'events_url': 'http://testing.api.dev/parse',
    ...
})
$client = new Signaturit\Client('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
$client->createBranding(array(
    ...
    'events_url' => 'http://testingapi.dev/parse',
    ...
));
client = new SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
client.createBranding({
    ...
    events_url: 'http://testingapi.dev/parse',
    ...
});

From this moment, the URL http://testingapi.dev/parse will receive the events from all jobs that use this branding.

Example received request
{
    "date": 2015-02-25T13:38:33+0000,
    "job": {
        "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "signer_email": "john.doe@gmail.com",
        "signer_name": "John",
        "status": "READY",
        "file": ...
    },
    "type": "open"
}

The list of events that you will receive is:

processed
The request email has been processed.
delivered
The request email has been delivered to the signer.
open
The signer opened the email.
opened
The signer opened the web app.
signed
The signer signed the document.
audit_trail_ready
The audit trail is ready to be downloaded.
signed_document_ready
The signed document is ready to be downloaded.

Template

A template is a prepared document with fields with predefined positions that can be sent repeatedly.

Id
Template identifier.
Name
The template hashtag in order to use it on the email client.
{
    "id":"3d1bf4f8-bcfe-11e3-8d1e-0a063b2144ed",
    "name": "#nda",
    "created_at":"2014-04-05T20:09:48+0000"
}

GET /templates.(json | xml)

Description

List templates from the requester.

Status Codes
  • 200 Success
  • 400 Wrong params
  • 403 Permission denied
Parameters
limit
Max number of templates to retrieve. The template limit is 100. OPTIONAL
offset
Results offset. Default value is 0. OPTIONAL
Response

A collection of templates in JSON or XML format.

Example request
$ curl
-X GET
-H 'Content-Type: application/json'
-H 'Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0'
api.sandbox.signaturit.com/v2/templates.json

[
    {
        "id": "e5d25677-8a52-11e3-af02-080027880ca6",
        "name": "#nda",
        "created_at": "2014-08-20T14:19:51+0000"
    }
]
client = SignaturitClient.new('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.get_templates

[
    {
        "id": "e5d25677-8a52-11e3-af02-080027880ca6",
        "name": "#nda",
        "created_at": "2014-08-20T14:19:51+0000"
    }
]
client = SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.get_templates()

[
    {
        "id": "e5d25677-8a52-11e3-af02-080027880ca6",
        "name": "#nda",
        "created_at": "2014-08-20T14:19:51+0000"
    }
]
$client = new Signaturit\Client('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
$client->getTemplates();

[
    {
        "id": "e5d25677-8a52-11e3-af02-080027880ca6",
        "name": "#nda",
        "created_at": "2014-08-20T14:19:51+0000"
    }
]
client = new SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
client.getTemplates();

[
    {
        "id": "e5d25677-8a52-11e3-af02-080027880ca6",
        "name": "#nda",
        "created_at": "2014-08-20T14:19:51+0000"
    }
]

Signature

A signature represents a request to one or more signers.

Id
Signature identifier
Subject
Email subject
Mandatory photo
A signature with mandatory photo, requires a photo of the signer.
Mandatory voice
A signature with mandatory voice, requires a voice record of the signer
Mandatory pages
Pages where the signer needs to sign.
Reminders
If the signer doesn't sign in a certain time, we will send a reminder email.
Expire time
When the time is over, the signature will expire and signer cannot sign the document.
Jobs
Array of documents involved in the signature process.
Source
The source of the signature request.
Body
Content of email.
Sign url
Url to begin the signature process. ONLY IN CREATE REQUEST
{
    "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "subject": "Receipt number 250",
    "sequential": false,
    "mandatory_photo": [0],
    "mandatory_voice": [0],
    "jobs": [
        {
            "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
            "created_at": "2014-08-21T08:53:35+0000",
            "signer_email": "bob_soap@signatur.it",
            "signer_name": "Bob Soap",
            "status": "ERROR",
            "error_msg": "Invalid email",
            "file": {
                "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
                "name": "Signaturit.pdf",
                "pages": 11,
                "created_at": "2014-08-21T08:53:35+0000",
                "expiration_date": "2019-08-21T08:53:35+0000"
            },
            "events": [
                {
                    "type": "processed",
                    "date": "2014-08-21T08:55:14+0000"
                }
            ],
        }
    ],
    "mandatory_pages": [],
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Please, can you sign this document?"
}

GET /signs/count.(json | xml)

Description

Count signature requests from the requester.

Status Codes
  • 200 Success
  • 400 Wrong params
  • 403 Permission denied
Parameters
status
Filter signatures with documents with certain status. OPTIONAL
since
Signatures returned will be the ones who are sent at this date or later. OPTIONAL
data
Here you can set your own data, to filter requests using your own params. If you have a custom data field named crm_id, then you must do the query using the key data.crm_id. OPTIONAL
Response

Total of signature requests in JSON or XML format.

Example request
$ curl
-X GET
-H 'Content-Type: application/json'
-H 'Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0'
api.sandbox.signaturit.com/v2/signs/count.json

{
    "count": 2
}
client = SignaturitClient.new('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.count_signatures

{
    "count": 2
}
client = SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.count_signatures()

{
    "count": 2
}
$client = new Signaturit\Client('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
$client->countSignatures();

{
    "count": 2
}
client = new SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
client.countSignatures();

{
    "count": 2
}

GET /signs.(json | xml)

Description

Get all signature requests from the user.

Status Codes
  • 200 Success
  • 400 Wrong params
  • 403 Permission denied
Parameters
limit
Max number of signatures to retrieve. The signature limit is 100. OPTIONAL
offset
Results offset. Default value is 0. OPTIONAL
status
Filter signatures with documents with certain status. OPTIONAL
since
Signatures returned will be the ones who are sent at this date or later. OPTIONAL
data
Here you can set your own data, to filter requests using your own params. If you have a custom data field named crm_id, then you must do the query using the key data.crm_id. OPTIONAL
Response

A list of signature requests in JSON or XML format.

Example request
$ curl
-X GET
-H 'Content-Type: application/json'
-H 'Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0'
api.sandbox.signaturit.com/v2/signs.json

[
    {
        "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "subject": "Receipt number 250",
        "sequential": false,
        "mandatory_photo": [0],
        "mandatory_voice": [0],
        "jobs": [
            {
                "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
                "created_at": "2014-08-21T08:53:35+0000",
                "signer_email": "bob_soap@signatur.it",
                "signer_name": "Bob Soap",
                "status": "READY",
                "file": {
                    "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
                    "name": "Signaturit.pdf",
                    "pages": 11,
                    "created_at": "2014-08-21T08:53:35+0000",
                    "expiration_date": "2019-08-21T08:53:35+0000"
                },
                "events": [
                    {
                        "type": "processed",
                        "date": "2014-08-21T08:55:14+0000"
                    }
                ],
            }
        ],
        "mandatory_pages": [],
        "reminders": [604800, 1209600, 1814400, 2419200],
        "expire_time": 2592000,
        "source": "api",
        "body": "Please, can you sign this document?"
    },
    {
        "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "subject": "Urgent contract",
        "sequential": false,
        "mandatory_photo": [1],
        "mandatory_voice": [1],
        "jobs": [
            {
                "id": "29109781-f42d-11e4-b3d4-0aa7697eb409",
                "created_at": "2014-08-21T08:53:35+0000",
                "signer_email": "bob_soap@signatur.it",
                "signer_name": "Bob Soap",
                "status": "READY",
                "file": {
                    "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
                    "name": "contract.pdf",
                    "pages": 5,
                    "created_at": "2014-08-21T08:53:35+0000",
                    "expiration_date": "2019-08-21T08:53:35+0000"
                },
                "events": [
                    {
                        "type": "processed",
                        "date": "2014-08-21T08:55:14+0000"
                    }
                ],
              }
        ]
        "mandatory_pages": [],
        "reminders": [604800, 1209600, 1814400, 2419200],
        "expire_time": 2592000,
        "source": "api",
        "body": "Very important contract. Sign it, please."
    }
]
client = SignaturitClient.new('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.get_signatures

[
    {
        "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "subject": "Receipt number 250",
        "sequential": false,
        "mandatory_photo": [0],
        "mandatory_voice": [0],
        "jobs": [
            {
                "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
                "created_at": "2014-08-21T08:53:35+0000",
                "signer_email": "bob_soap@signatur.it",
                "signer_name": "Bob Soap",
                "status": "READY",
                "file": {
                    "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
                    "name": "Signaturit.pdf",
                    "pages": 11,
                    "created_at": "2014-08-21T08:53:35+0000",
                    "expiration_date": "2019-08-21T08:53:35+0000"
                },
                "events": [
                    {
                        "type": "processed",
                        "date": "2014-08-21T08:55:14+0000"
                    }
                ],
            }
        ],
        "mandatory_pages": [],
        "reminders": [604800, 1209600, 1814400, 2419200],
        "expire_time": 2592000,
        "source": "api",
        "body": "Please, can you sign this document?"
    },
    {
        "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "subject": "Urgent contract",
        "sequential": false,
        "mandatory_photo": [1],
        "mandatory_voice": [1],
        "jobs": [
            {
                "id": "29109781-f42d-11e4-b3d4-0aa7697eb409",
                "created_at": "2014-08-21T08:53:35+0000",
                "signer_email": "bob_soap@signatur.it",
                "signer_name": "Bob Soap",
                "status": "READY",
                "file": {
                    "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
                    "name": "contract.pdf",
                    "pages": 5,
                    "created_at": "2014-08-21T08:53:35+0000",
                    "expiration_date": "2019-08-21T08:53:35+0000"
                },
                "events": [
                    {
                        "type": "processed",
                        "date": "2014-08-21T08:55:14+0000"
                    }
                ],
              }
        ]
        "mandatory_pages": [],
        "reminders": [604800, 1209600, 1814400, 2419200],
        "expire_time": 2592000,
        "source": "api",
        "body": "Very important contract. Sign it, please."
    }
]
client = SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.get_signatures()

[
    {
        "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "subject": "Receipt number 250",
        "sequential": false,
        "mandatory_photo": [0],
        "mandatory_voice": [0],
        "jobs": [
            {
                "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
                "created_at": "2014-08-21T08:53:35+0000",
                "signer_email": "bob_soap@signatur.it",
                "signer_name": "Bob Soap",
                "status": "READY",
                "file": {
                    "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
                    "name": "Signaturit.pdf",
                    "pages": 11,
                    "created_at": "2014-08-21T08:53:35+0000",
                    "expiration_date": "2019-08-21T08:53:35+0000"
                },
                "events": [
                    {
                        "type": "processed",
                        "date": "2014-08-21T08:55:14+0000"
                    }
                ],
            }
        ],
        "mandatory_pages": [],
        "reminders": [604800, 1209600, 1814400, 2419200],
        "expire_time": 2592000,
        "source": "api",
        "body": "Please, can you sign this document?"
    },
    {
        "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "subject": "Urgent contract",
        "sequential": false,
        "mandatory_photo": [1],
        "mandatory_voice": [1],
        "jobs": [
            {
                "id": "29109781-f42d-11e4-b3d4-0aa7697eb409",
                "created_at": "2014-08-21T08:53:35+0000",
                "signer_email": "bob_soap@signatur.it",
                "signer_name": "Bob Soap",
                "status": "READY",
                "file": {
                    "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
                    "name": "contract.pdf",
                    "pages": 5,
                    "created_at": "2014-08-21T08:53:35+0000",
                    "expiration_date": "2019-08-21T08:53:35+0000"
                },
                "events": [
                    {
                        "type": "processed",
                        "date": "2014-08-21T08:55:14+0000"
                    }
                ],
              }
        ]
        "mandatory_pages": [],
        "reminders": [604800, 1209600, 1814400, 2419200],
        "expire_time": 2592000,
        "source": "api",
        "body": "Very important contract. Sign it, please."
    }
]
$client = new Signaturit\Client('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
$client->getSignatures();

[
    {
        "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "subject": "Receipt number 250",
        "sequential": false,
        "mandatory_photo": [0],
        "mandatory_voice": [0],
        "jobs": [
            {
                "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
                "created_at": "2014-08-21T08:53:35+0000",
                "signer_email": "bob_soap@signatur.it",
                "signer_name": "Bob Soap",
                "status": "READY",
                "file": {
                    "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
                    "name": "Signaturit.pdf",
                    "pages": 11,
                    "created_at": "2014-08-21T08:53:35+0000",
                    "expiration_date": "2019-08-21T08:53:35+0000"
                },
                "events": [
                    {
                        "type": "processed",
                        "date": "2014-08-21T08:55:14+0000"
                    }
                ],
            }
        ],
        "mandatory_pages": [],
        "reminders": [604800, 1209600, 1814400, 2419200],
        "expire_time": 2592000,
        "source": "api",
        "body": "Please, can you sign this document?"
    },
    {
        "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "subject": "Urgent contract",
        "sequential": false,
        "mandatory_photo": [1],
        "mandatory_voice": [1],
        "jobs": [
            {
                "id": "29109781-f42d-11e4-b3d4-0aa7697eb409",
                "created_at": "2014-08-21T08:53:35+0000",
                "signer_email": "bob_soap@signatur.it",
                "signer_name": "Bob Soap",
                "status": "READY",
                "file": {
                    "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
                    "name": "contract.pdf",
                    "pages": 5,
                    "created_at": "2014-08-21T08:53:35+0000",
                    "expiration_date": "2019-08-21T08:53:35+0000"
                },
                "events": [
                    {
                        "type": "processed",
                        "date": "2014-08-21T08:55:14+0000"
                    }
                ],
              }
        ]
        "mandatory_pages": [],
        "reminders": [604800, 1209600, 1814400, 2419200],
        "expire_time": 2592000,
        "source": "api",
        "body": "Very important contract. Sign it, please."
    }
]
client = new SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
client.getSignatures();

[
    {
        "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "subject": "Receipt number 250",
        "sequential": false,
        "mandatory_photo": [0],
        "mandatory_voice": [0],
        "jobs": [
            {
                "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
                "created_at": "2014-08-21T08:53:35+0000",
                "signer_email": "bob_soap@signatur.it",
                "signer_name": "Bob Soap",
                "status": "READY",
                "file": {
                    "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
                    "name": "Signaturit.pdf",
                    "pages": 11,
                    "created_at": "2014-08-21T08:53:35+0000",
                    "expiration_date": "2019-08-21T08:53:35+0000"
                },
                "events": [
                    {
                        "type": "processed",
                        "date": "2014-08-21T08:55:14+0000"
                    }
                ],
            }
        ],
        "mandatory_pages": [],
        "reminders": [604800, 1209600, 1814400, 2419200],
        "expire_time": 2592000,
        "source": "api",
        "body": "Please, can you sign this document?"
    },
    {
        "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "subject": "Urgent contract",
        "sequential": false,
        "mandatory_photo": [1],
        "mandatory_voice": [1],
        "jobs": [
            {
                "id": "29109781-f42d-11e4-b3d4-0aa7697eb409",
                "created_at": "2014-08-21T08:53:35+0000",
                "signer_email": "bob_soap@signatur.it",
                "signer_name": "Bob Soap",
                "status": "READY",
                "file": {
                    "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
                    "name": "contract.pdf",
                    "pages": 5,
                    "created_at": "2014-08-21T08:53:35+0000",
                    "expiration_date": "2019-08-21T08:53:35+0000"
                },
                "events": [
                    {
                        "type": "processed",
                        "date": "2014-08-21T08:55:14+0000"
                    }
                ],
              }
        ]
        "mandatory_pages": [],
        "reminders": [604800, 1209600, 1814400, 2419200],
        "expire_time": 2592000,
        "source": "api",
        "body": "Very important contract. Sign it, please."
    }
]
Example request filter signatures with custom crm_id key
$ curl
-X GET
-H 'Content-Type: application/json'
-H 'Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0'
api.sandbox.signaturit.com/v2/signs.json?data.crm_id=2445

[
    {
        "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        data_info: [
            {
                created_at: "2015-02-10T13:59:04+0000",
                key: "crm_id",
                value: "2455"
            }
        ],
        "subject": "Receipt number 250",
        "sequential": false,
        "mandatory_photo": [0],
        "mandatory_voice": [0],
        "jobs": [
            {
                "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
                "created_at": "2014-08-21T08:53:35+0000",
                "signer_email": "bob_soap@signatur.it",
                "signer_name": "Bob Soap",
                "status": "READY",
                "file": {
                    "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
                    "name": "Signaturit.pdf",
                    "pages": 11,
                    "created_at": "2014-08-21T08:53:35+0000",
                    "expiration_date": "2019-08-21T08:53:35+0000"
                },
                "events": [
                    {
                        "type": "processed",
                        "date": "2014-08-21T08:55:14+0000"
                    }
                ],
            }
        ],
        "mandatory_pages": [],
        "reminders": [604800, 1209600, 1814400, 2419200],
        "expire_time": 2592000,
        "source": "api",
        "body": "Please, can you sign this document?"
    }
]
client = SignaturitClient.new('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.get_signatures(nil, nil, nil, nil, { :crm_id => 2445 })

[
    {
        "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        data_info: [
            {
                created_at: "2015-02-10T13:59:04+0000",
                key: "crm_id",
                value: "2455"
            }
        ],
        "subject": "Receipt number 250",
        "sequential": false,
        "mandatory_photo": [0],
        "mandatory_voice": [0],
        "jobs": [
            {
                "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
                "created_at": "2014-08-21T08:53:35+0000",
                "signer_email": "bob_soap@signatur.it",
                "signer_name": "Bob Soap",
                "status": "READY",
                "file": {
                    "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
                    "name": "Signaturit.pdf",
                    "pages": 11,
                    "created_at": "2014-08-21T08:53:35+0000",
                    "expiration_date": "2019-08-21T08:53:35+0000"
                },
                "events": [
                    {
                        "type": "processed",
                        "date": "2014-08-21T08:55:14+0000"
                    }
                ],
            }
        ],
        "mandatory_pages": [],
        "reminders": [604800, 1209600, 1814400, 2419200],
        "expire_time": 2592000,
        "source": "api",
        "body": "Please, can you sign this document?"
    }
]
client = SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.get_signatures(data={'crm_id': 2445'})

[
    {
        "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        data_info: [
            {
                created_at: "2015-02-10T13:59:04+0000",
                key: "crm_id",
                value: "2455"
            }
        ],
        "subject": "Receipt number 250",
        "sequential": false,
        "mandatory_photo": [0],
        "mandatory_voice": [0],
        "jobs": [
            {
                "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
                "created_at": "2014-08-21T08:53:35+0000",
                "signer_email": "bob_soap@signatur.it",
                "signer_name": "Bob Soap",
                "status": "READY",
                "file": {
                    "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
                    "name": "Signaturit.pdf",
                    "pages": 11,
                    "created_at": "2014-08-21T08:53:35+0000",
                    "expiration_date": "2019-08-21T08:53:35+0000"
                },
                "events": [
                    {
                        "type": "processed",
                        "date": "2014-08-21T08:55:14+0000"
                    }
                ],
            }
        ],
        "mandatory_pages": [],
        "reminders": [604800, 1209600, 1814400, 2419200],
        "expire_time": 2592000,
        "source": "api",
        "body": "Please, can you sign this document?"
    }
]
$client = new Signaturit\Client('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
$client->getSignatures(null, null, null, null, array('crm_id' => 2445));

[
    {
        "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        data_info: [
            {
                created_at: "2015-02-10T13:59:04+0000",
                key: "crm_id",
                value: "2455"
            }
        ],
        "subject": "Receipt number 250",
        "sequential": false,
        "mandatory_photo": [0],
        "mandatory_voice": [0],
        "jobs": [
            {
                "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
                "created_at": "2014-08-21T08:53:35+0000",
                "signer_email": "bob_soap@signatur.it",
                "signer_name": "Bob Soap",
                "status": "READY",
                "file": {
                    "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
                    "name": "Signaturit.pdf",
                    "pages": 11,
                    "created_at": "2014-08-21T08:53:35+0000",
                    "expiration_date": "2019-08-21T08:53:35+0000"
                },
                "events": [
                    {
                        "type": "processed",
                        "date": "2014-08-21T08:55:14+0000"
                    }
                ],
            }
        ],
        "mandatory_pages": [],
        "reminders": [604800, 1209600, 1814400, 2419200],
        "expire_time": 2592000,
        "source": "api",
        "body": "Please, can you sign this document?"
    }
]
client = new SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
client.getSignatures(null, null, null, null, { crm_id: 2445 });

[
    {
        "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        data_info: [
            {
                created_at: "2015-02-10T13:59:04+0000",
                key: "crm_id",
                value: "2455"
            }
        ],
        "subject": "Receipt number 250",
        "sequential": false,
        "mandatory_photo": [0],
        "mandatory_voice": [0],
        "jobs": [
            {
                "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
                "created_at": "2014-08-21T08:53:35+0000",
                "signer_email": "bob_soap@signatur.it",
                "signer_name": "Bob Soap",
                "status": "READY",
                "file": {
                    "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
                    "name": "Signaturit.pdf",
                    "pages": 11,
                    "created_at": "2014-08-21T08:53:35+0000",
                    "expiration_date": "2019-08-21T08:53:35+0000"
                },
                "events": [
                    {
                        "type": "processed",
                        "date": "2014-08-21T08:55:14+0000"
                    }
                ],
            }
        ],
        "mandatory_pages": [],
        "reminders": [604800, 1209600, 1814400, 2419200],
        "expire_time": 2592000,
        "source": "api",
        "body": "Please, can you sign this document?"
    }
]

GET /signs/{id}.(json | xml)

Description

Get a given signature request.

Status Codes
  • 200 Success
  • 400 Wrong params
  • 403 Permission denied
  • 404 Signature not found.
Response

Single signature request in JSON or XML format.

Example request
$ curl
-X GET
-H 'Content-Type: application/json'
-H 'Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0'
api.sandbox.signaturit.com/v2/signs/6f6c974e-2910-11e4-b3d4-0aa7697eb409.json

{
    "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "subject": "Urgent contract",
    "sequential": [0],
    "mandatory_photo": [1],
    "mandatory_voice": [1],
    "jobs": [
        {
            "id": "29109781-f42d-11e4-b3d4-0aa7697eb409",
            "created_at": "2014-08-21T08:53:35+0000",
            "signer_email": "bob_soap@signatur.it",
            "signer_name": "Bob Soap",
            "status": "READY",
            "file": {
                "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
                "name": "contract.pdf",
                "pages": 5,
                "created_at": "2014-08-21T08:53:35+0000",
                "expiration_date": "2019-08-21T08:53:35+0000"
            },
            "events": [
                {
                    "type": "processed",
                    "date": "2014-08-21T08:55:14+0000"
                }
            ],
        }
    ],
    "mandatory_pages": [],
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Very important contract. Sign it, please."
}
client = SignaturitClient.new('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.get_signature('6f6c974e-2910-11e4-b3d4-0aa7697eb409')

{
    "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "subject": "Urgent contract",
    "sequential": [0],
    "mandatory_photo": [1],
    "mandatory_voice": [1],
    "jobs": [
        {
            "id": "29109781-f42d-11e4-b3d4-0aa7697eb409",
            "created_at": "2014-08-21T08:53:35+0000",
            "signer_email": "bob_soap@signatur.it",
            "signer_name": "Bob Soap",
            "status": "READY",
            "file": {
                "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
                "name": "contract.pdf",
                "pages": 5,
                "created_at": "2014-08-21T08:53:35+0000",
                "expiration_date": "2019-08-21T08:53:35+0000"
            },
            "events": [
                {
                    "type": "processed",
                    "date": "2014-08-21T08:55:14+0000"
                }
            ],
        }
    ],
    "mandatory_pages": [],
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Very important contract. Sign it, please."
}
client = SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.get_signature('6f6c974e-2910-11e4-b3d4-0aa7697eb409')

{
    "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "subject": "Urgent contract",
    "sequential": [0],
    "mandatory_photo": [1],
    "mandatory_voice": [1],
    "jobs": [
        {
            "id": "29109781-f42d-11e4-b3d4-0aa7697eb409",
            "created_at": "2014-08-21T08:53:35+0000",
            "signer_email": "bob_soap@signatur.it",
            "signer_name": "Bob Soap",
            "status": "READY",
            "file": {
                "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
                "name": "contract.pdf",
                "pages": 5,
                "created_at": "2014-08-21T08:53:35+0000",
                "expiration_date": "2019-08-21T08:53:35+0000"
            },
            "events": [
                {
                    "type": "processed",
                    "date": "2014-08-21T08:55:14+0000"
                }
            ],
        }
    ],
    "mandatory_pages": [],
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Very important contract. Sign it, please."
}
$client = new Signaturit\Client('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
$client->getSignature('6f6c974e-2910-11e4-b3d4-0aa7697eb409');

{
    "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "subject": "Urgent contract",
    "sequential": [0],
    "mandatory_photo": [1],
    "mandatory_voice": [1],
    "jobs": [
        {
            "id": "29109781-f42d-11e4-b3d4-0aa7697eb409",
            "created_at": "2014-08-21T08:53:35+0000",
            "signer_email": "bob_soap@signatur.it",
            "signer_name": "Bob Soap",
            "status": "READY",
            "file": {
                "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
                "name": "contract.pdf",
                "pages": 5,
                "created_at": "2014-08-21T08:53:35+0000",
                "expiration_date": "2019-08-21T08:53:35+0000"
            },
            "events": [
                {
                    "type": "processed",
                    "date": "2014-08-21T08:55:14+0000"
                }
            ],
        }
    ],
    "mandatory_pages": [],
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Very important contract. Sign it, please."
}
client = new SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
client.getSignature('6f6c974e-2910-11e4-b3d4-0aa7697eb409');

{
    "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "subject": "Urgent contract",
    "sequential": [0],
    "mandatory_photo": [1],
    "mandatory_voice": [1],
    "jobs": [
        {
            "id": "29109781-f42d-11e4-b3d4-0aa7697eb409",
            "created_at": "2014-08-21T08:53:35+0000",
            "signer_email": "bob_soap@signatur.it",
            "signer_name": "Bob Soap",
            "status": "READY",
            "file": {
                "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
                "name": "contract.pdf",
                "pages": 5,
                "created_at": "2014-08-21T08:53:35+0000",
                "expiration_date": "2019-08-21T08:53:35+0000"
            },
            "events": [
                {
                    "type": "processed",
                    "date": "2014-08-21T08:55:14+0000"
                }
            ],
        }
    ],
    "mandatory_pages": [],
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Very important contract. Sign it, please."
}

GET /signs/{id}/documents.(json | xml)

Description

Get all documents from a signature request.

Status Codes
  • 200 Success
  • 400 Wrong params
  • 403 Permission denied
  • 404 Signature not found.
Response

A list of documents in JSON or XML format.

Example request
$ curl
-X GET
-H 'Content-Type: application/json'
-H 'Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0'
api.sandbox.signaturit.com/v2/signs/6f6c974e-2910-11e4-b3d4-0aa7697eb409/documents.json

{
    "id": "29109781-f42d-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "signer_email": "bob_soap@signatur.it",
    "signer_name": "Bob Soap",
    "status": "READY",
    "file": {
        "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
        "name": "contract.pdf",
        "pages": 5,
        "created_at": "2014-08-21T08:53:35+0000",
        "expiration_date": "2019-08-21T08:53:35+0000"
    },
    "events": [
        {
            "type": "processed",
            "date": "2014-08-21T08:55:14+0000"
        }
    ],
}
client = SignaturitClient.new('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.get_signature_documents('6f6c974e-2910-11e4-b3d4-0aa7697eb409')

{
    "id": "29109781-f42d-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "signer_email": "bob_soap@signatur.it",
    "signer_name": "Bob Soap",
    "status": "READY",
    "file": {
        "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
        "name": "contract.pdf",
        "pages": 5,
        "created_at": "2014-08-21T08:53:35+0000",
        "expiration_date": "2019-08-21T08:53:35+0000"
    },
    "events": [
        {
            "type": "processed",
            "date": "2014-08-21T08:55:14+0000"
        }
    ],
}
client = SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.get_signature_documents('6f6c974e-2910-11e4-b3d4-0aa7697eb409')

{
    "id": "29109781-f42d-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "signer_email": "bob_soap@signatur.it",
    "signer_name": "Bob Soap",
    "status": "READY",
    "file": {
        "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
        "name": "contract.pdf",
        "pages": 5,
        "created_at": "2014-08-21T08:53:35+0000",
        "expiration_date": "2019-08-21T08:53:35+0000"
    },
    "events": [
        {
            "type": "processed",
            "date": "2014-08-21T08:55:14+0000"
        }
    ],
}
$client = new Signaturit\Client('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
$client->getSignatureDocuments('6f6c974e-2910-11e4-b3d4-0aa7697eb409');

{
    "id": "29109781-f42d-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "signer_email": "bob_soap@signatur.it",
    "signer_name": "Bob Soap",
    "status": "READY",
    "file": {
        "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
        "name": "contract.pdf",
        "pages": 5,
        "created_at": "2014-08-21T08:53:35+0000",
        "expiration_date": "2019-08-21T08:53:35+0000"
    },
    "events": [
        {
            "type": "processed",
            "date": "2014-08-21T08:55:14+0000"
        }
    ],
}
client = new SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
client.getSignatureDocuments('6f6c974e-2910-11e4-b3d4-0aa7697eb409');

{
    "id": "29109781-f42d-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "signer_email": "bob_soap@signatur.it",
    "signer_name": "Bob Soap",
    "status": "READY",
    "file": {
        "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
        "name": "contract.pdf",
        "pages": 5,
        "created_at": "2014-08-21T08:53:35+0000",
        "expiration_date": "2019-08-21T08:53:35+0000"
    },
    "events": [
        {
            "type": "processed",
            "date": "2014-08-21T08:55:14+0000"
        }
    ],
}

GET /signs/{id}/documents/{id}.(json | xml)

Description

Get a single document from a signature request.

Status Codes
  • 200 Success
  • 400 Wrong params
  • 403 Permission denied
  • 404 Signature not found.
  • 404 Document not found.
Response

Single document in JSON or XML format.

Example request
$ curl
-X GET
-H 'Content-Type: application/json'
-H 'Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0'
api.sandbox.signaturit.com/v2/signs/6f6c974e-2910-11e4-b3d4-0aa7697eb409/documents/29109781-f42d-11e4-b3d4-0aa7697eb409.json

{
    "id": "29109781-f42d-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "signer_email": "bob_soap@signatur.it",
    "signer_name": "Bob Soap",
    "status": "READY",
    "file": {
        "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
        "name": "contract.pdf",
        "pages": 5,
        "created_at": "2014-08-21T08:53:35+0000",
        "expiration_date": "2019-08-21T08:53:35+0000"
    },
    "events": [
        {
            "type": "processed",
            "date": "2014-08-21T08:55:14+0000"
        }
    ],
}
client = SignaturitClient.new('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.get_signature_document('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409')

{
    "id": "29109781-f42d-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "signer_email": "bob_soap@signatur.it",
    "signer_name": "Bob Soap",
    "status": "READY",
    "file": {
        "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
        "name": "contract.pdf",
        "pages": 5,
        "created_at": "2014-08-21T08:53:35+0000",
        "expiration_date": "2019-08-21T08:53:35+0000"
    },
    "events": [
        {
            "type": "processed",
            "date": "2014-08-21T08:55:14+0000"
        }
    ],
}
client = SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.get_signature_documents('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409')

{
    "id": "29109781-f42d-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "signer_email": "bob_soap@signatur.it",
    "signer_name": "Bob Soap",
    "status": "READY",
    "file": {
        "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
        "name": "contract.pdf",
        "pages": 5,
        "created_at": "2014-08-21T08:53:35+0000",
        "expiration_date": "2019-08-21T08:53:35+0000"
    },
    "events": [
        {
            "type": "processed",
            "date": "2014-08-21T08:55:14+0000"
        }
    ],
}
$client = new Signaturit\Client('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
$client->getSignatureDocument('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409');

{
    "id": "29109781-f42d-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "signer_email": "bob_soap@signatur.it",
    "signer_name": "Bob Soap",
    "status": "READY",
    "file": {
        "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
        "name": "contract.pdf",
        "pages": 5,
        "created_at": "2014-08-21T08:53:35+0000",
        "expiration_date": "2019-08-21T08:53:35+0000"
    },
    "events": [
        {
            "type": "processed",
            "date": "2014-08-21T08:55:14+0000"
        }
    ],
}
client = new SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
client.getSignatureDocument('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409');

{
    "id": "29109781-f42d-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "signer_email": "bob_soap@signatur.it",
    "signer_name": "Bob Soap",
    "status": "READY",
    "file": {
        "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
        "name": "contract.pdf",
        "pages": 5,
        "created_at": "2014-08-21T08:53:35+0000",
        "expiration_date": "2019-08-21T08:53:35+0000"
    },
    "events": [
        {
            "type": "processed",
            "date": "2014-08-21T08:55:14+0000"
        }
    ],
}

POST /signs.(json | xml)

Description

Create a new signature request.

Status Codes
  • 200 Success
  • 400 Wrong params
  • 403 Permission denied
Parameters
subject
Email subject. OPTIONAL
body
Email body. Can be HTML code. OPTIONAL
recipients
Array with signature recipients containing fullname, email and phone (optionally). If a phone is supplied, the document will be protected with a password that will be sent to the signer in a SMS message.
in_person_sign
Whether a notification email will be sent to the signer or not. OPTIONAL
files
Array with pdf files.
mandatory_photo
Array with booleans that tell if photo capture will be asked to finish the signature process. The index of array references the document number, so first value will apply to first document.OPTIONAL
mandatory_voice
Array with booleans that tell if voice record will be asked to finish the signature process. The index of array references the document number, so first value will apply to first document.OPTIONAL
mandatory_pages
Array of arrays with the pages that signer needs to sign for every document. The index of array references the document number, so first array of pages will apply to first document. OPTIONAL
reminders
Array with time values (in seconds) to wait until send a reminder email. Set 0 to disable reminders. OPTIONAL
expire_time
Expiration time (in seconds) of document. Set 0 to disable expiration. OPTIONAL
callback_url
Url to redirect the user when finish the signature process, instead of survey. OPTIONAL
signature_pos_x
Array telling the signature default position X, every position range is from 0 to 1. The index of array references the document number, so first position value will apply to first document. OPTIONAL
signature_pos_y
Array telling the signature default position Y, every position range is from 0 to 1. The index of array references the document number, so first position value will apply to first document. OPTIONAL
sign_terms
Text showed in signature pad, near the terms button. OPTIONAL
terms_and_conditions_text
Text that follow our terms text. It can be HTML. OPTIONAL
branding_id
Use a custom branding for this signature request. OPTIONAL
templates
Templates to use in the signature request. You can use the id or hashtag. OPTIONAL
data
Your custom info. It's an array where you can set the key - value pair that you want.
Response

New signature request in JSON or XML format.

Example request
$ curl
-X POST
-H 'Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0'
-F 'recipients[0][fullname]=John' -F 'recipients[0][email]=john.doe@gmail.com'
-F 'subject=Please, sign this document'
-F 'mandatory_pages[0]=[4]' -F 'mandatory_pages[1]=5'
-F 'body=Hey! Please sign this, in order to test our integration.'
-F 'mandatory_photo[0]=1'
-F 'mandatory_voice[0]=1'
-F 'files[0]=@/lab/legal/consent.pdf'
api.sandbox.signaturit.com/v2/signs.json

{
    "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "subject": "Please, sign this document",
    "sequential": false,
    "mandatory_photo": [1],
    "mandatory_voice": [1],
    "jobs":
    {
        "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "signer_email": "john.doe@gmail.com",
        "signer_name": "John",
        "status": "READY",
        "file": {
            "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
            "name": "consent.pdf",
            "pages": 2,
            "created_at": "2014-08-21T08:53:35+0000",
            "expiration_date": "2019-08-21T08:53:35+0000"
        }
     },
    "mandatory_pages": [[4, 5]],
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Hey! Please sign this, in order to test our integration."
    "sign_url": "http://app.sandbox.signaturit.com\/en\/document\/974e6f6c-2910-11e4-b3d4-0aa7697eb409\/9781f42d-2910-11e4-b3d4-0aa7697eb409"
}
client = SignaturitClient.new('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.create_signature_request('/lab/legal/consent.pdf', {
    :fullname => 'John',
    :email => 'john.doe@gmail.com'
}, {
    :subject => "Please, sign this document",
    :mandatory_pages => [[4, 5]],
    :body => "Hey! Please sign this, in order to test our integration."
    :mandatory_photo => [1],
    :mandatory_voice => [1]
})

{
    "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "subject": "Please, sign this document",
    "sequential": false,
    "mandatory_photo": [1],
    "mandatory_voice": [1],
    "jobs":
    {
        "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "signer_email": "john.doe@gmail.com",
        "signer_name": "John",
        "status": "READY",
        "file": {
            "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
            "name": "consent.pdf",
            "pages": 2,
            "created_at": "2014-08-21T08:53:35+0000",
            "expiration_date": "2019-08-21T08:53:35+0000"
        }
     },
    "mandatory_pages": [[4, 5]],
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Hey! Please sign this, in order to test our integration."
    "sign_url": "http://app.sandbox.signaturit.com\/en\/document\/974e6f6c-2910-11e4-b3d4-0aa7697eb409\/9781f42d-2910-11e4-b3d4-0aa7697eb409"
}
client = SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.create_signature_request('/lab/legal/consent.pdf', {
    'fullname': 'John',
    'email': 'john.doe@gmail.com'
}, {
    'subject': 'Please, sign this document',
    'body': 'Hey! Please sign this, in order to test our integration.',
    'mandatory_pages': [[4, 5]],
    'mandatory_photo': [1],
    'mandatory_voice': [1]
})
{
    "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "subject": "Please, sign this document",
    "sequential": false,
    "mandatory_photo": [1],
    "mandatory_voice": [1],
    "jobs":
    {
        "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "signer_email": "john.doe@gmail.com",
        "signer_name": "John",
        "status": "READY",
        "file": {
            "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
            "name": "consent.pdf",
            "pages": 2,
            "created_at": "2014-08-21T08:53:35+0000",
            "expiration_date": "2019-08-21T08:53:35+0000"
        }
     },
    "mandatory_pages": [[4, 5]],
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Hey! Please sign this, in order to test our integration."
    "sign_url": "http://app.sandbox.signaturit.com\/en\/document\/974e6f6c-2910-11e4-b3d4-0aa7697eb409\/9781f42d-2910-11e4-b3d4-0aa7697eb409"
}
$client = new Signaturit\Client('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
$client->createSignatureRequest(
    array('/lab/legal/consent.pdf'),
    array(
        'fullname' => 'John',
        'email' => 'john.doe@gmail.com'
    ),
    array(
        'subject' => 'Please, sign this document',
        'mandatory_pages' => array(array(4, 5)),
        'body' => 'Hey! Please sign this, in order to test our integration.'
        'mandatory_photo' => array(1),
        'mandatory_voice' => array(1)
    )
);

{
    "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "subject": "Please, sign this document",
    "sequential": false,
    "mandatory_photo": [1],
    "mandatory_voice": [1],
    "jobs":
    {
        "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "signer_email": "john.doe@gmail.com",
        "signer_name": "John",
        "status": "READY",
        "file": {
            "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
            "name": "consent.pdf",
            "pages": 2,
            "created_at": "2014-08-21T08:53:35+0000",
            "expiration_date": "2019-08-21T08:53:35+0000"
        }
     },
    "mandatory_pages": [[4, 5]],
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Hey! Please sign this, in order to test our integration."
    "sign_url": "http://app.sandbox.signaturit.com\/en\/document\/974e6f6c-2910-11e4-b3d4-0aa7697eb409\/9781f42d-2910-11e4-b3d4-0aa7697eb409"
}
client = new SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
client.createSignatureRequest('/lab/legal/consent.pdf', {
    fullname: 'John',
    email: 'john.doe@gmail.com'
}, {
    subject: 'Please, sign this document',
    mandatory_pages: [[4,5]],
    body: 'Hey! Please sign this, in order to test our integration.',
    mandatory_photo: [1],
    mandatory_voice: [1]
});

{
    "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "subject": "Please, sign this document",
    "sequential": false,
    "mandatory_photo": [1],
    "mandatory_voice": [1],
    "jobs":
    {
        "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "signer_email": "john.doe@gmail.com",
        "signer_name": "John",
        "status": "READY",
        "file": {
            "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
            "name": "consent.pdf",
            "pages": 2,
            "created_at": "2014-08-21T08:53:35+0000",
            "expiration_date": "2019-08-21T08:53:35+0000"
        }
     },
    "mandatory_pages": [[4, 5]],
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Hey! Please sign this, in order to test our integration."
    "sign_url": "http://app.sandbox.signaturit.com\/en\/document\/974e6f6c-2910-11e4-b3d4-0aa7697eb409\/9781f42d-2910-11e4-b3d4-0aa7697eb409"
}
Example request using a template with hashtag #NDA instead of file
$ curl
-X POST
-H 'Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0'
-F 'recipients[0][fullname]=John' -F 'recipients[0][email]=john.doe@gmail.com'
-F 'subject=Please, sign this document'
-F 'body=Hey! Please sign this, in order to test our integration.'
-F 'templates[0]=#NDA'
api.sandbox.signaturit.com/v2/signs.json

{
    "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "subject": "Please, sign this document",
    "sequential": false,
    "mandatory_photo": [0],
    "mandatory_voice": [0],
    "jobs":
    {
        "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "signer_email": "john.doe@gmail.com",
        "signer_name": "John",
        "status": "READY",
        "file": {
            "id": "975cdde0-2910-11e4-b3d4-0aa7697eb409",
            "name": "nda15.pdf",
            "pages": 10,
            "created_at": "2014-08-21T08:53:35+0000",
            "expiration_date": "2019-08-21T08:53:35+0000"
        }
     },
    "mandatory_pages": []
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Hey! Please sign this, in order to test our integration."
    "sign_url": "http://app.sandbox.signaturit.com\/en\/document\/974e6f6c-2910-11e4-b3d4-0aa7697eb409\/9781f42d-2910-11e4-b3d4-0aa7697eb409"
}
client = SignaturitClient.new('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.create_signature_request('/lab/legal/consent.pdf', {
    :fullname => 'John',
    :email => 'john.doe@gmail.com'
}, {
    :subject => "Please, sign this document",
    :body => "Hey! Please sign this, in order to test our integration."
    :templates => ['#NDA']
})

{
    "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "subject": "Please, sign this document",
    "sequential": false,
    "mandatory_photo": [0],
    "mandatory_voice": [0],
    "jobs":
    {
        "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "signer_email": "john.doe@gmail.com",
        "signer_name": "John",
        "status": "READY",
        "file": {
            "id": "975cdde0-2910-11e4-b3d4-0aa7697eb409",
            "name": "nda15.pdf",
            "pages": 10,
            "created_at": "2014-08-21T08:53:35+0000",
            "expiration_date": "2019-08-21T08:53:35+0000"
        }
     },
    "mandatory_pages": []
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Hey! Please sign this, in order to test our integration."
    "sign_url": "http://app.sandbox.signaturit.com\/en\/document\/974e6f6c-2910-11e4-b3d4-0aa7697eb409\/9781f42d-2910-11e4-b3d4-0aa7697eb409"
}
client = SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.create_signature_request([], {
    'fullname': 'John',
    'email': 'john.doe@gmail.com'
}, {
    'subject': 'Please, sign this document',
    'body': 'Hey! Please sign this, in order to test our integration.',
    'templates': ['#NDA']
})
{
    "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "subject": "Please, sign this document",
    "sequential": false,
    "mandatory_photo": [0],
    "mandatory_voice": [0],
    "jobs":
    {
        "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "signer_email": "john.doe@gmail.com",
        "signer_name": "John",
        "status": "READY",
        "file": {
            "id": "975cdde0-2910-11e4-b3d4-0aa7697eb409",
            "name": "nda15.pdf",
            "pages": 10,
            "created_at": "2014-08-21T08:53:35+0000",
            "expiration_date": "2019-08-21T08:53:35+0000"
        }
     },
    "mandatory_pages": []
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Hey! Please sign this, in order to test our integration."
    "sign_url": "http://app.sandbox.signaturit.com\/en\/document\/974e6f6c-2910-11e4-b3d4-0aa7697eb409\/9781f42d-2910-11e4-b3d4-0aa7697eb409"
}
$client = new Signaturit\Client('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
$client->createSignatureRequest(
    array(),
    array(
        'fullname' => 'John',
        'email' => 'john.doe@gmail.com'
    ),
    array(
        'subject' => 'Please, sign this document',
        'body' => 'Hey! Please sign this, in order to test our integration.'
        'templates' => array('#NDA')
    )
);

{
    "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "subject": "Please, sign this document",
    "sequential": false,
    "mandatory_photo": [0],
    "mandatory_voice": [0],
    "jobs":
    {
        "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "signer_email": "john.doe@gmail.com",
        "signer_name": "John",
        "status": "READY",
        "file": {
            "id": "975cdde0-2910-11e4-b3d4-0aa7697eb409",
            "name": "nda15.pdf",
            "pages": 10,
            "created_at": "2014-08-21T08:53:35+0000",
            "expiration_date": "2019-08-21T08:53:35+0000"
        }
     },
    "mandatory_pages": []
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Hey! Please sign this, in order to test our integration."
    "sign_url": "http://app.sandbox.signaturit.com\/en\/document\/974e6f6c-2910-11e4-b3d4-0aa7697eb409\/9781f42d-2910-11e4-b3d4-0aa7697eb409"
}
client = new SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
client.createSignatureRequest('', {
    fullname: 'John',
    email: 'john.doe@gmail.com'
}, {
    subject: 'Please, sign this document',
    body: 'Hey! Please sign this, in order to test our integration.',
    templates: '#NDA'
});

{
    "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "subject": "Please, sign this document",
    "sequential": false,
    "mandatory_photo": [0],
    "mandatory_voice": [0],
    "jobs":
    {
        "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "signer_email": "john.doe@gmail.com",
        "signer_name": "John",
        "status": "READY",
        "file": {
            "id": "975cdde0-2910-11e4-b3d4-0aa7697eb409",
            "name": "nda15.pdf",
            "pages": 10,
            "created_at": "2014-08-21T08:53:35+0000",
            "expiration_date": "2019-08-21T08:53:35+0000"
        }
     },
    "mandatory_pages": []
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Hey! Please sign this, in order to test our integration."
    "sign_url": "http://app.sandbox.signaturit.com\/en\/document\/974e6f6c-2910-11e4-b3d4-0aa7697eb409\/9781f42d-2910-11e4-b3d4-0aa7697eb409"
}
Example request using a template with hashtag #NDA instead of file with the fields filled
$ curl
-X POST
-H 'Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0'
-F 'recipients[0][fullname]=John' -F 'recipients[0][email]=john.doe@gmail.com'
-F 'subject=Please, sign this document'
-F 'body=Hey! Please sign this, in order to test our integration.'
-F 'templates[0]=#NDA'
-F 'data[widget_id]=DEFAULT_VALUE'
api.sandbox.signaturit.com/v2/signs.json

{
    "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "subject": "Please, sign this document",
    "sequential": false,
    "mandatory_photo": [0],
    "mandatory_voice": [0],
    "jobs":
    {
        "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "signer_email": "john.doe@gmail.com",
        "signer_name": "John",
        "status": "READY",
        "file": {
            "id": "975cdde0-2910-11e4-b3d4-0aa7697eb409",
            "name": "nda15.pdf",
            "pages": 10,
            "created_at": "2014-08-21T08:53:35+0000",
            "expiration_date": "2019-08-21T08:53:35+0000"
        }
     },
    "mandatory_pages": []
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Hey! Please sign this, in order to test our integration."
    "sign_url": "http://app.sandbox.signaturit.com\/en\/document\/974e6f6c-2910-11e4-b3d4-0aa7697eb409\/9781f42d-2910-11e4-b3d4-0aa7697eb409"
}
client = SignaturitClient.new('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.create_signature_request('/lab/legal/consent.pdf', {
    :fullname => 'John',
    :email => 'john.doe@gmail.com'
}, {
    :subject => "Please, sign this document",
    :body => "Hey! Please sign this, in order to test our integration.",
    :templates => ['#NDA'],
    :data => ['WIDGET_ID' => 'DEFAULT_VALUE']
})

{
    "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "subject": "Please, sign this document",
    "sequential": false,
    "mandatory_photo": [0],
    "mandatory_voice": [0],
    "jobs":
    {
        "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "signer_email": "john.doe@gmail.com",
        "signer_name": "John",
        "status": "READY",
        "file": {
            "id": "975cdde0-2910-11e4-b3d4-0aa7697eb409",
            "name": "nda15.pdf",
            "pages": 10,
            "created_at": "2014-08-21T08:53:35+0000",
            "expiration_date": "2019-08-21T08:53:35+0000"
        }
     },
    "mandatory_pages": []
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Hey! Please sign this, in order to test our integration."
    "sign_url": "http://app.sandbox.signaturit.com\/en\/document\/974e6f6c-2910-11e4-b3d4-0aa7697eb409\/9781f42d-2910-11e4-b3d4-0aa7697eb409"
}
client = SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.create_signature_request([], {
    'fullname': 'John',
    'email': 'john.doe@gmail.com'
}, {
    'subject': 'Please, sign this document',
    'body': 'Hey! Please sign this, in order to test our integration.',
    'templates': ['#NDA'],
    'data': ['WIDGET_ID': 'DEFAULT_VALUE']
})
{
    "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "subject": "Please, sign this document",
    "sequential": false,
    "mandatory_photo": [0],
    "mandatory_voice": [0],
    "jobs":
    {
        "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "signer_email": "john.doe@gmail.com",
        "signer_name": "John",
        "status": "READY",
        "file": {
            "id": "975cdde0-2910-11e4-b3d4-0aa7697eb409",
            "name": "nda15.pdf",
            "pages": 10,
            "created_at": "2014-08-21T08:53:35+0000",
            "expiration_date": "2019-08-21T08:53:35+0000"
        }
     },
    "mandatory_pages": []
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Hey! Please sign this, in order to test our integration."
    "sign_url": "http://app.sandbox.signaturit.com\/en\/document\/974e6f6c-2910-11e4-b3d4-0aa7697eb409\/9781f42d-2910-11e4-b3d4-0aa7697eb409"
}
$client = new Signaturit\Client('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
$client->createSignatureRequest(
    array(),
    array(
        'fullname' => 'John',
        'email' => 'john.doe@gmail.com'
    ),
    array(
        'subject' => 'Please, sign this document',
        'body' => 'Hey! Please sign this, in order to test our integration.'
        'templates' => array('#NDA'),
        'data' => array('WIDGET_ID' => 'DEFAULT_DATA')
    )
);

{
    "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "subject": "Please, sign this document",
    "sequential": false,
    "mandatory_photo": [0],
    "mandatory_voice": [0],
    "jobs":
    {
        "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "signer_email": "john.doe@gmail.com",
        "signer_name": "John",
        "status": "READY",
        "file": {
            "id": "975cdde0-2910-11e4-b3d4-0aa7697eb409",
            "name": "nda15.pdf",
            "pages": 10,
            "created_at": "2014-08-21T08:53:35+0000",
            "expiration_date": "2019-08-21T08:53:35+0000"
        }
     },
    "mandatory_pages": []
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Hey! Please sign this, in order to test our integration."
    "sign_url": "http://app.sandbox.signaturit.com\/en\/document\/974e6f6c-2910-11e4-b3d4-0aa7697eb409\/9781f42d-2910-11e4-b3d4-0aa7697eb409"
}
client = new SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
client.createSignatureRequest('', {
    fullname: 'John',
    email: 'john.doe@gmail.com'
}, {
    subject: 'Please, sign this document',
    body: 'Hey! Please sign this, in order to test our integration.',
    templates: '#NDA',
    data: {
    	'WIDGET_ID': 'DEFAULT_VALUE'
    }
});

{
    "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "subject": "Please, sign this document",
    "sequential": false,
    "mandatory_photo": [0],
    "mandatory_voice": [0],
    "jobs":
    {
        "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "signer_email": "john.doe@gmail.com",
        "signer_name": "John",
        "status": "READY",
        "file": {
            "id": "975cdde0-2910-11e4-b3d4-0aa7697eb409",
            "name": "nda15.pdf",
            "pages": 10,
            "created_at": "2014-08-21T08:53:35+0000",
            "expiration_date": "2019-08-21T08:53:35+0000"
        }
     },
    "mandatory_pages": []
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Hey! Please sign this, in order to test our integration."
    "sign_url": "http://app.sandbox.signaturit.com\/en\/document\/974e6f6c-2910-11e4-b3d4-0aa7697eb409\/9781f42d-2910-11e4-b3d4-0aa7697eb409"
}
Example request using a custom data
$ curl
-X POST
-H 'Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0'
-F 'recipients[0][fullname]=John' -F 'recipients[0][email]=john.doe@gmail.com'
-F 'subject=Please, sign this document'
-F 'body=Hey! Please sign this, in order to test our integration.'
-F 'templates[0]=#NDA'
-F 'data[crm_id]=2445'
api.sandbox.signaturit.com/v2/signs.json

{
    "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
     data_info: [
        {
            created_at: "2015-02-10T13:59:04+0000",
            key: "crm_id",
            value: "2455"
        }
    ],
    "subject": "Please, sign this document",
    "sequential": false,
    "mandatory_photo": [0],
    "mandatory_voice": [0],
    "jobs":
    {
        "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "signer_email": "john.doe@gmail.com",
        "signer_name": "John",
        "status": "READY",
        "file": {
            "id": "975cdde0-2910-11e4-b3d4-0aa7697eb409",
            "name": "nda15.pdf",
            "pages": 10,
            "created_at": "2014-08-21T08:53:35+0000",
            "expiration_date": "2019-08-21T08:53:35+0000"
        }
     },
    "mandatory_pages": []
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Hey! Please sign this, in order to test our integration."
    "sign_url": "http://app.sandbox.signaturit.com\/en\/document\/974e6f6c-2910-11e4-b3d4-0aa7697eb409\/9781f42d-2910-11e4-b3d4-0aa7697eb409"
}
client = SignaturitClient.new('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.create_signature_request('/lab/legal/consent.pdf', {
    :fullname => 'John',
    :email => 'john.doe@gmail.com'
}, {
    :subject => "Please, sign this document",
    :body => "Hey! Please sign this, in order to test our integration."
    :templates => ['#NDA'],
    :data => { :crm_id: 2445 }
})

{
    "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
     data_info: [
        {
            created_at: "2015-02-10T13:59:04+0000",
            key: "crm_id",
            value: "2455"
        }
    ],
    "subject": "Please, sign this document",
    "sequential": false,
    "mandatory_photo": [0],
    "mandatory_voice": [0],
    "jobs":
    {
        "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "signer_email": "john.doe@gmail.com",
        "signer_name": "John",
        "status": "READY",
        "file": {
            "id": "975cdde0-2910-11e4-b3d4-0aa7697eb409",
            "name": "nda15.pdf",
            "pages": 10,
            "created_at": "2014-08-21T08:53:35+0000",
            "expiration_date": "2019-08-21T08:53:35+0000"
        }
     },
    "mandatory_pages": []
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Hey! Please sign this, in order to test our integration."
    "sign_url": "http://app.sandbox.signaturit.com\/en\/document\/974e6f6c-2910-11e4-b3d4-0aa7697eb409\/9781f42d-2910-11e4-b3d4-0aa7697eb409"
}
client = SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.create_signature_request([], {
    'fullname': 'John',
    'email': 'john.doe@gmail.com'
}, {
    'subject': 'Please, sign this document',
    'body': 'Hey! Please sign this, in order to test our integration.',
    'templates': ['#NDA'],
    'data': { 'crm_id': 2445 }
})
{
    "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
     data_info: [
        {
            created_at: "2015-02-10T13:59:04+0000",
            key: "crm_id",
            value: "2455"
        }
    ],
    "subject": "Please, sign this document",
    "sequential": false,
    "mandatory_photo": [0],
    "mandatory_voice": [0],
    "jobs":
    {
        "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "signer_email": "john.doe@gmail.com",
        "signer_name": "John",
        "status": "READY",
        "file": {
            "id": "975cdde0-2910-11e4-b3d4-0aa7697eb409",
            "name": "nda15.pdf",
            "pages": 10,
            "created_at": "2014-08-21T08:53:35+0000",
            "expiration_date": "2019-08-21T08:53:35+0000"
        }
     },
    "mandatory_pages": []
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Hey! Please sign this, in order to test our integration."
    "sign_url": "http://app.sandbox.signaturit.com\/en\/document\/974e6f6c-2910-11e4-b3d4-0aa7697eb409\/9781f42d-2910-11e4-b3d4-0aa7697eb409"
}
$client = new Signaturit\Client('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
$client->createSignatureRequest(
    array(),
    array(
        'fullname' => 'John',
        'email' => 'john.doe@gmail.com'
    ),
    array(
        'subject' => 'Please, sign this document',
        'body' => 'Hey! Please sign this, in order to test our integration.'
        'templates' => array('#NDA'),
        'data'      => array( 'crm_id' => 2445 )
    )
);

{
    "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
     data_info: [
        {
            created_at: "2015-02-10T13:59:04+0000",
            key: "crm_id",
            value: "2455"
        }
    ],
    "subject": "Please, sign this document",
    "sequential": false,
    "mandatory_photo": [0],
    "mandatory_voice": [0],
    "jobs":
    {
        "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "signer_email": "john.doe@gmail.com",
        "signer_name": "John",
        "status": "READY",
        "file": {
            "id": "975cdde0-2910-11e4-b3d4-0aa7697eb409",
            "name": "nda15.pdf",
            "pages": 10,
            "created_at": "2014-08-21T08:53:35+0000",
            "expiration_date": "2019-08-21T08:53:35+0000"
        }
     },
    "mandatory_pages": []
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Hey! Please sign this, in order to test our integration."
    "sign_url": "http://app.sandbox.signaturit.com\/en\/document\/974e6f6c-2910-11e4-b3d4-0aa7697eb409\/9781f42d-2910-11e4-b3d4-0aa7697eb409"
}
client = new SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
client.createSignatureRequest('', {
    fullname: 'John',
    email: 'john.doe@gmail.com'
}, {
    subject: 'Please, sign this document',
    body: 'Hey! Please sign this, in order to test our integration.',
    templates: '#NDA',
    data: { crm_id: 2445 }
});

{
    "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
     data_info: [
        {
            created_at: "2015-02-10T13:59:04+0000",
            key: "crm_id",
            value: "2455"
        }
    ],
    "subject": "Please, sign this document",
    "sequential": false,
    "mandatory_photo": [0],
    "mandatory_voice": [0],
    "jobs":
    {
        "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "signer_email": "john.doe@gmail.com",
        "signer_name": "John",
        "status": "READY",
        "file": {
            "id": "975cdde0-2910-11e4-b3d4-0aa7697eb409",
            "name": "nda15.pdf",
            "pages": 10,
            "created_at": "2014-08-21T08:53:35+0000",
            "expiration_date": "2019-08-21T08:53:35+0000"
        }
     },
    "mandatory_pages": []
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Hey! Please sign this, in order to test our integration."
    "sign_url": "http://app.sandbox.signaturit.com\/en\/document\/974e6f6c-2910-11e4-b3d4-0aa7697eb409\/9781f42d-2910-11e4-b3d4-0aa7697eb409"
}

GET /signs/{id}/documents/{id}/download/doc_proof

Description

Download the audit trail of the signed PDF file (Only available after signing the document).

Status Codes
  • 200 Success
  • 400 Wrong params
  • 403 Permission denied
  • 404 Signature not found
  • 404 Document not found
Response

PDF file.

Example request
$ curl
-X GET
-H 'Content-Type: application/json'
-H 'Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0'
api.sandbox.signaturit.com/v2/signs/6f6c974e-2910-11e4-b3d4-0aa7697eb409/documents/29109781-f42d-11e4-b3d4-0aa7697eb409/download/doc_proof
client = SignaturitClient.new('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.get_audit_trail('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409', '/file.pdf')
client = SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.get_audit_trail('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409', '/file.pdf')
$client = new Signaturit\Client('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
$client->getAuditTrail('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409', '/file.pdf');
client = new SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
client.getAuditTrail('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409', '/file.pdf');

GET /signs/{id}/documents/{id}/download/signed

Description

Download the signed PDF file (Only available after signing the document).

Status Codes
  • 200 Success
  • 400 Wrong params
  • 403 Permission denied
  • 404 Signature not found
  • 404 Document not found
Response

PDF file.

Example request
$ curl
-X GET
-H 'Content-Type: application/json'
-H 'Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0'
api.sandbox.signaturit.com/v2/signs/6f6c974e-2910-11e4-b3d4-0aa7697eb409/documents/29109781-f42d-11e4-b3d4-0aa7697eb409/download/signed
client = SignaturitClient.new('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.get_signed_document('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409', '/file.pdf')
client = SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.get_signed_document('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409', '/file.pdf')
$client = new Signaturit\Client('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
$client->getSignedDocument('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409', '/file.pdf');
client = new SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
client.getSignedDocument('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409', '/file.pdf');

GET /v2/signs/{signId}/cancel.(json | xml)

Description

Cancel a signature. The signer will not be able to sign the document.

Status Codes
  • 200 Success
  • 400 Wrong params
  • 403 Permission denied
  • 404 Signature not found
Response

Canceled signature in JSON or XML format.

Example request
$ curl
-X GET
-H 'Content-Type: application/json'
-H 'Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0'
api.sandbox.signaturit.com/v2/signs/6f6c974e-2910-11e4-b3d4-0aa7697eb409/cancel.json

{
    "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "subject": "Urgent contract",
    "sequential": false,
    "mandatory_photo": [1],
    "mandatory_voice": [1],
    "jobs":
    {
        "id": "29109781-f42d-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "signer_email": "bob_soap@signatur.it",
        "signer_name": "Bob Soap",
        "status": "CANCELED",
        "file": {
            "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
            "name": "contract.pdf",
            "pages": 5,
            "created_at": "2014-08-21T08:53:35+0000",
            "expiration_date": "2019-08-21T08:53:35+0000"
        },
        "events": [
            {
                "type": "processed",
                "date": "2014-08-21T08:55:14+0000"
            }
        ],
    },
    "mandatory_pages": [],
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Very important contract. Sign it, please."
}
client = SignaturitClient.new('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.cancel_signature_request('6f6c974e-2910-11e4-b3d4-0aa7697eb40')

{
    "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "subject": "Urgent contract",
    "sequential": false,
    "mandatory_photo": [1],
    "mandatory_voice": [1],
    "jobs":
    {
        "id": "29109781-f42d-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "signer_email": "bob_soap@signatur.it",
        "signer_name": "Bob Soap",
        "status": "CANCELED",
        "file": {
            "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
            "name": "contract.pdf",
            "pages": 5,
            "created_at": "2014-08-21T08:53:35+0000",
            "expiration_date": "2019-08-21T08:53:35+0000"
        },
        "events": [
            {
                "type": "processed",
                "date": "2014-08-21T08:55:14+0000"
            }
        ],
    },
    "mandatory_pages": [],
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Very important contract. Sign it, please."
}
client = SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0')
client.cancel_signature_request('6f6c974e-2910-11e4-b3d4-0aa7697eb40')

{
    "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "subject": "Urgent contract",
    "sequential": false,
    "mandatory_photo": [1],
    "mandatory_voice": [1],
    "jobs":
    {
        "id": "29109781-f42d-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "signer_email": "bob_soap@signatur.it",
        "signer_name": "Bob Soap",
        "status": "CANCELED",
        "file": {
            "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
            "name": "contract.pdf",
            "pages": 5,
            "created_at": "2014-08-21T08:53:35+0000",
            "expiration_date": "2019-08-21T08:53:35+0000"
        },
        "events": [
            {
                "type": "processed",
                "date": "2014-08-21T08:55:14+0000"
            }
        ],
    },
    "mandatory_pages": [],
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Very important contract. Sign it, please."
}
$client = new Signaturit\Client('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
$client->cancelSignatureRequest('6f6c974e-2910-11e4-b3d4-0aa7697eb40');

{
    "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "subject": "Urgent contract",
    "sequential": false,
    "mandatory_photo": [1],
    "mandatory_voice": [1],
    "jobs":
    {
        "id": "29109781-f42d-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "signer_email": "bob_soap@signatur.it",
        "signer_name": "Bob Soap",
        "status": "CANCELED",
        "file": {
            "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
            "name": "contract.pdf",
            "pages": 5,
            "created_at": "2014-08-21T08:53:35+0000",
            "expiration_date": "2019-08-21T08:53:35+0000"
        },
        "events": [
            {
                "type": "processed",
                "date": "2014-08-21T08:55:14+0000"
            }
        ],
    },
    "mandatory_pages": [],
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Very important contract. Sign it, please."
}
client = new SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
client.cancelSignatureRequest('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409');

{
    "id": "29109781-f42d-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "signer_email": "bob_soap@signatur.it",
    "signer_name": "Bob Soap",
    "status": "READY",
    "file": {
        "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
        "name": "contract.pdf",
        "pages": 5,
        "created_at": "2014-08-21T08:53:35+0000",
        "expiration_date": "2019-08-21T08:53:35+0000"
    },
    "events": [
        {
            "type": "processed",
            "date": "2014-08-21T08:55:14+0000"
        }
    ],
}

GET /v2/signs/{signId}/documents/{documentId}/reminder.(json | xml)

Description

Send a reminder. A reminder email will be sent to the signer.

Status Codes
  • 200 Success
  • 400 Wrong params
  • 403 Permission denied
  • 404 Signature not found
  • 404 Document not found
Response

Document in JSON or XML format.

Example request
$ curl
-X POST
-H 'Content-Type: application/json'
-H 'Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0'
api.sandbox.signaturit.com/v2/signs/6f6c974e-2910-11e4-b3d4-0aa7697eb409/documents/29109781-f42d-11e4-b3d4-0aa7697eb409/reminder.json

{
    "id": "29109781-f42d-11e4-b3d4-0aa7697eb409",
    "signer_email": "bob_soap@signatur.it",
    "signer_name": "Bob Soap",
    "status": "READY"
    file: {
        "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
        "name": "contract.pdf",
        "pages": 5,
        "created_at": "2014-08-21T08:53:35+0000",
        "expiration_date": "2019-08-21T08:53:35+0000"
    },
    events: [
        {
            type: "processed",
            date: "2014-10-30T09:58:01+0000"
        },
        {
            type: "delivered",
            date: "2014-10-30T09:58:03+0000"
        },
        {
            type: "open",
            date: "2014-10-30T09:58:15+0000"
        },
        {
            type: "reminder_sent",
            date: "2014-10-30T11:33:46+0000"
        }
    ]
}

client = SignaturitClient.new('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
client.send_reminder('6f6c974e-2910-11e4-b3d4-0aa7697eb40', '29109781-f42d-11e4-b3d4-0aa7697eb409');

{
    "id": "29109781-f42d-11e4-b3d4-0aa7697eb409",
    "signer_email": "bob_soap@signatur.it",
    "signer_name": "Bob Soap",
    "status": "READY"
    file: {
        "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
        "name": "contract.pdf",
        "pages": 5,
        "created_at": "2014-08-21T08:53:35+0000",
        "expiration_date": "2019-08-21T08:53:35+0000"
    },
    events: [
        {
            type: "processed",
            date: "2014-10-30T09:58:01+0000"
        },
        {
            type: "delivered",
            date: "2014-10-30T09:58:03+0000"
        },
        {
            type: "open",
            date: "2014-10-30T09:58:15+0000"
        },
        {
            type: "reminder_sent",
            date: "2014-10-30T11:33:46+0000"
        }
    ]
}

_send_reminder_php.twig
client = SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
client.send_reminder('6f6c974e-2910-11e4-b3d4-0aa7697eb40', '29109781-f42d-11e4-b3d4-0aa7697eb409');

{
    "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "subject": "Urgent contract",
    "sequential": false,
    "mandatory_photo": [1],
    "mandatory_voice": [1],
    "jobs":
    {
        "id": "29109781-f42d-11e4-b3d4-0aa7697eb409",
        "created_at": "2014-08-21T08:53:35+0000",
        "signer_email": "bob_soap@signatur.it",
        "signer_name": "Bob Soap",
        "status": "CANCELED",
        "file": {
            "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
            "name": "contract.pdf",
            "pages": 5,
            "created_at": "2014-08-21T08:53:35+0000",
            "expiration_date": "2019-08-21T08:53:35+0000"
        },
        "events": [
            {
                "type": "processed",
                "date": "2014-08-21T08:55:14+0000"
            }
        ],
    },
    "mandatory_pages": [],
    "reminders": [604800, 1209600, 1814400, 2419200],
    "expire_time": 2592000,
    "source": "api",
    "body": "Very important contract. Sign it, please."
}
$client = new Signaturit\Client('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
$client->sendReminder('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409');

{
    "id": "29109781-f42d-11e4-b3d4-0aa7697eb409",
    "signer_email": "bob_soap@signatur.it",
    "signer_name": "Bob Soap",
    "status": "READY"
    file: {
        "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
        "name": "contract.pdf",
        "pages": 5,
        "created_at": "2014-08-21T08:53:35+0000",
        "expiration_date": "2019-08-21T08:53:35+0000"
    },
    events: [
        {
            type: "processed",
            date: "2014-10-30T09:58:01+0000"
        },
        {
            type: "delivered",
            date: "2014-10-30T09:58:03+0000"
        },
        {
            type: "open",
            date: "2014-10-30T09:58:15+0000"
        },
        {
            type: "reminder_sent",
            date: "2014-10-30T11:33:46+0000"
        }
    ]
}

client = new SignaturitClient('ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0');
client.sendReminder('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409');

{
    "id": "29109781-f42d-11e4-b3d4-0aa7697eb409",
    "created_at": "2014-08-21T08:53:35+0000",
    "signer_email": "bob_soap@signatur.it",
    "signer_name": "Bob Soap",
    "status": "READY",
    "file": {
        "id": "975caac0-2910-11e4-b3d4-0aa7697eb409",
        "name": "contract.pdf",
        "pages": 5,
        "created_at": "2014-08-21T08:53:35+0000",
        "expiration_date": "2019-08-21T08:53:35+0000"
    },
    "events": [
        {
            "type": "processed",
            "date": "2014-08-21T08:55:14+0000"
        }
    ],
}

Photo ID validation

POST /v2/photoid/validate.(json | xml)

Description

Validates a ID document providing image captures from the document front and back sides.

Status Codes
  • 200 Success
  • 400 Wrong params
  • 403 Permission denied
Parameters
Front
Front capture of the ID as a file
Back
Back capture of the ID as a file (not all ID documents need it)
Response

Captured data from the document and validations in JSON or XML format.

Example request
$ curl
-X POST
-H 'Content-Type: application/json'
-H 'Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0'
-F 'front=@/front.jpg'
-F 'back=@/back.jpg'
api.qa.signaturit.com/v2/photoid/validate.json

{
    "front":"the_document_front_image_base64_encoded",
    "back":"the_document_back_image_base64_encoded",
    "photo":"the_document_photo_image_base64_encoded",
    "signature":"the_document_signature_image_base64_encoded",
    "data":{
        "type":"identity",
        "side":"0",
        "expeditor":"esp",
        "nationality":"esp",
        "surname":"delgado",
        "id_number":"33777628c",
        "doc_number":"apa167078",
        "street_address":"c._diego_martin_de_oliva_6",
        "city_address":"jerez_de_la_frontera",
        "state_address":"c\u00c1diz",
        "address":"c\u00c1diz",
        "birthplace":"c\u00c1diz",
        "parents":"angel_\/_magdalena",
        "birthdate":"1981-09-04",
        "expiry":"2023-09-17",
        "sex":"f",
        "authority":"25425a6d1",
        "mrz":"pena<delgado<<<<<elesa<<<<<<<<",
        "model_id":"idespc2",
        "sides_number":"2"
},
    "validations":{
        "test_expiry_date":"ok",
        "test_mrz_fields_integrity_doc_number":"ok",
        "test_mrz_fields_integrity_birthdate":"ok",
        "test_mrz_fields_integrity_expiry":"ok",
        "test_correspondence_visible_mrz_expeditor":"ok",
        "test_color_image":"ok",
        "test_correspondence_visible_mrz_surname":"ok",
        "test_correspondence_visible_mrz_doc_number":"ok",
        "test_mrz_global_integrity":"fail",
        "test_correspondence_visible_mrz_id_number":"fail",
        "test_correspondence_visible_mrz_expiry":"fail",
        "test_correspondence_visible_mrz_birthdate":"fail",
        "test_correspondence_visible_mrz_sex":"fail"
    }
}