Signaturit for Developers.

Signaturit is a scalable and reliable digital signature solution. Our Customer Success team will help you in your integration efforts and to answer any questions that you may have.

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 sandbox servers. In these server, you can try all the methods for free.

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

Every API call in sandbox is done to the URL: https://api.sandbox.signaturit.com/v3.

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

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

0Auth2

Signaturit API uses OAuth2 in order to authenticate the requests to the servers, so you need to get the access token from the dashboard once registered.

The access token is a string like:

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 requests.

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 "Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0"

https://api.sandbox.signaturit.com/v3/signatures.json

Libraries

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

  • Python SDK

    $ pip install signaturit_sdk

  • Ruby SDK

    $ gem install signaturit-sdk -v 1.0.0

  • PHP SDK

    $ composer require signaturit/signaturit-sdk 1.0.0

  • Node.js SDK

    $ npm install signaturit-sdk@1.0.0

  • Swift SDK

    • Cocoapods

      pod 'Signaturit'

  • Java SDK

    • Maven

      <dependency>

      <groupId>com.signaturit.api</groupId>

      <artifactId>java-sdk</artifactId>

      <version>1.1.6</version>

      </dependency>

    • Gradle

      compile 'com.signaturit.api:java-sdk:1.1.6'

  • .NET SDK

    PM> Install-Package Signaturit

Support

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

Post message

Events sent in embedded integrations.

event

The fired event type.

ready
The document is loaded and ready to sign.
signed
The document is correctly signed.
declined
The signer decided not to sign the document.
completed
All documents in a signing process have been signed correctly.
close
The signer has clicked the Close button after signing the document.
documentId
The document identifier.
signatureId
The signature identifier.

Error Handling

When your api request returns a 40x error, we inform you about the error in the same response.

The way to deal with this response error message, is different in every language.

Example

$ curl

-X POST

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/signatures.json


{"status_code":400,"message":"Invalid recipient list"}

begin

client.create_signature(file, recipients)

rescue Exception => exception

puts exception.response

end


{"status_code":400,"message":"Invalid recipient list"}

print client.create_signature(files, recipients, params)


{"status_code":400,"message":"Invalid recipient list"}

echo $client->createSignature($files, $recipients);


{"status_code":400,"message":"Invalid recipient list"}

client.createSignature(file, recipients).then(function () {

// success result

}, function (error) {

console.log(error)

})


{"status_code":400,"message":"Invalid recipient list"}

client.createSignature([file!], recipients: recipients, params: params, successHandler: { response in

print(response)

})


{"status_code":400,"message":"Invalid recipient list"}

try {

Response response = client.createSignature(files, recipients, options);

Log.w("debug", response.body().string());

} catch (IOException exception) {

exception.printStackTrace();

}


{"status_code":400,"message":"Invalid recipient list"}

try {

dynamic response = client.createSignature(files, recipients, options);

System.Console.WriteLine(response);

}

catch (System.AggregateException e) {

FlurlHttpException exception = (FlurlHttpException) e.InnerException;

System.Console.WriteLine(exception.GetResponseString());

}


{"status_code":400,"message":"Invalid recipient list"}

Moving to Production

We recommend you to create your Signaturit integration in our Sandbox environment.

Once completed, you may want to release your integration to the Production environment.

How to do that, depends in the way you interact with our API.

If your integrations executes HTTP requests to our server directly (with cURL for example), you will need to change the endpoint URL to https://api.signaturit.com and the Access Token for the one you will find in your Production Enterprise Account.

If you are using one of our SDKs, the Signaturit object creation, accepts a second parameter (boolean). When this parameter is false (the default value), the requests are done to our Sandbox environment. When this parameter is true, the requests are done to our Production environment. Remember to change your Access Token too.


sandbox

$ curl

-X GET

-H "Authorization: Bearer YOUR_SANDBOX_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/signatures/count.json


production

$ curl

-X GET

-H "Authorization: Bearer YOUR_PRODUCTION_ACCESS_TOKEN"

https://api.signaturit.com/v3/signatures/count.json

sandbox

client = SignaturitClient.new('YOUR_SANDBOX_ACCESS_TOKEN')


production

client = SignaturitClient.new('YOUR_PRODUCTION_ACCESS_TOKEN', true)

sandbox

client = SignaturitClient('YOUR_SANDBOX_ACCESS_TOKEN')


production

client = SignaturitClient('YOUR_PRODUCTION_ACCESS_TOKEN', true)

sandbox

$client = new Signaturit\Client('YOUR_SANDBOX_ACCESS_TOKEN');


production

$client = new Signaturit\Client('YOUR_PRODUCTION_ACCESS_TOKEN', true);

sandbox

client = new SignaturitClient('YOUR_SANDBOX_ACCESS_TOKEN');


production

client = new SignaturitClient('YOUR_PRODUCTION_ACCESS_TOKEN', true);

sandbox

let client: Signaturit = Signaturit(accessToken: "YOUR_SANDBOX_ACCESS_TOKEN", production: false)


production

let client: Signaturit = Signaturit(accessToken: "YOUR_PRODUCTION_ACCESS_TOKEN", production: true)

sandbox

Client client = new Client("YOUR_SANDBOX_ACCESS_TOKEN", false);


production

Client client = new Client("YOUR_PRODUCTION_ACCESS_TOKEN", true);

sandbox

Signaturit.Client client = new Signaturit.Client("YOUR_SANDBOX_ACCESS_TOKEN", false);


production

Signaturit.Client client = new Signaturit.Client("YOUR_PRODUCTION_ACCESS_TOKEN", true);

Signature

A signature represents a request to one or more signers with one or more documents.

created_at
The creation date.
data
Custom information that you can include in the signature request. See the signature create call for more information.
documents

The document items that have been created for the signature request. A document item is created for every signer and uploaded file.

Inside every document item you can find the next information:

email
The signer's email.
events

A list of events related with the document.

Inside every event item you can find the next information:

created_at
The creation date.
type

The event type.

The available types are:

email_processed
The email has been processed
email_delivered
The email has been delivered
email_opened
The email has been opened
email_bounced
The server cannot deliver the message. Bounces often are caused by outdated or incorrectly entered email addresses.
email_deferred
The email cannot immediately be delivered, but it hasn’t been completely rejected. Sometimes called a soft bounce, it will be retried for 72 hours.
reminder_email_processed
The reminder email has been processed
reminder_email_delivered
The reminder email has been delivered
reminder_email_opened
The reminder email has been opened
sms_processed
The SMS has been processed.
sms_delivered
The SMS has been delivered.
password_sms_processed
The password SMS has been processed.
password_sms_delivered
The password SMS has been delivered.
document_opened
The document has been opened.
document_signed
The document has been signed.
document_completed
The document has been completed and ready to be downloaded.
audit_trail_completed
The audit trail has been completed and ready to be downloaded.
document_declined
The document has been declined.
document_expired
The document has expired.
document_canceled
The document has been canceled.
photo_added
The signer has attached a photo in the process.
voice_added
The signer has attached an audio in the process.
file_added
The signer has attached a file in the process.
photo_id_added
The signer has attached a photo id in the process.
file

The file information.

Inside the file item you can find the next information:

name
The file name.
pages
The number of pages.
size
The file size.
id
The document identifier.
name
The signer's name.
status

The document status.

The available status are:

in_queue
The document is being processed.
ready
The document is ready to be signed.
signing
The document is being digitally signed.
completed
The document has been signed.
expired
The document has expired.
canceled
The document has been canceled.
declined
The document has been declined.
error
There was some error processing the request.
canceled
The document has been canceled.
id
The signature request identifier.
{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "john@signaturit.com", "events": [{ "created_at": "2014-08-21T08:55:14+0000", "type": "email_processed" }, { "created_at": "2014-08-21T08:55:20+0000", "type": "email_delivered" }], "file": { "name": "document.pdf", "pages": 5, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

GET /v3/signatures/count.(json | xml)

Description

Count signature requests.

Parameters
status

Filter signatures with documents with certain status. OPTIONAL

The available status are:

in_queue
The document is being processed.
ready
The document is ready to be signed.
signing
The document is being digitally signed.
completed
The document has been signed.
expired
The document has expired.
canceled
The document has been canceled.
declined
The document has been declined.
error
There was some error processing the request.
since
Signatures counted will be the ones who are sent at this date or later. The format of this value should be YYYY-MM-DD. OPTIONAL
until
Signatures counted will be the ones who are sent before this date. The format of this value should be YYYY-MM-DD. OPTIONAL
ids
Limit the result set to a list of signatures. The format is a comma separated list of signature ids. OPTIONAL
data
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 crm_id. OPTIONAL
Response

Total of signature requests in JSON or XML format.

Example request

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/signatures/count.json


{ "count": 2 }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.count_signatures


{ "count": 2 }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.count_signatures()


{ "count": 2 }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->countSignatures();


{ "count": 2 }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.countSignatures();


{ "count": 2 }

let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)

client.countSignatures()


{ "count": 2 }

Client client = new Client("YOUR_ACCESS_TOKEN", false);

client.countSignatures();


{ "count": 2 }

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.countSignatures();


{ "count": 2 }

GET /v3/signatures.(json | xml)

Description

Get all signature requests.

Parameters
limit
Max number of signatures to retrieve. The signature limit is 100. OPTIONAL
offset
Results offset. Default value is 0. Note that the result window size (limit + offset) cannot exceed 10.000 OPTIONAL
status

Filter signatures with documents with certain status. OPTIONAL

The available status are:

in_queue
The document is being processed.
ready
The document is ready to be signed.
signing
The document is being digitally signed.
completed
The document has been signed.
expired
The document has expired.
canceled
The document has been canceled.
declined
The document has been declined.
error
There was some error processing the request.
since
Signatures returned will be the ones who are sent at this date or later. The format of this value should be YYYY-MM-DD. OPTIONAL
until
Signatures returned will be the ones who are sent before this date. The format of this value should be YYYY-MM-DD. OPTIONAL
ids
Limit the result set to a list of signatures. The format is a comma separated list of signature ids. 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 crm_id parameter. OPTIONAL
Response

A list of signature requests in JSON or XML format.

Example request

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/signatures.json


[{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "document.pdf", "pages": 11, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }, { "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "david@signaturit.com", "events": [{ "type": "processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 82412 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "David", "status": "ready" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }]

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.get_signatures


[{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "document.pdf", "pages": 11, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }, { "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "david@signaturit.com", "events": [{ "type": "processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 82412 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "David", "status": "ready" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }]

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.get_signatures()


[{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "document.pdf", "pages": 11, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }, { "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "david@signaturit.com", "events": [{ "type": "processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 82412 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "David", "status": "ready" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }]

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->getSignatures();


[{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "document.pdf", "pages": 11, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }, { "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "david@signaturit.com", "events": [{ "type": "processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 82412 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "David", "status": "ready" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }]

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.getSignatures();


[{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "document.pdf", "pages": 11, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }, { "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "david@signaturit.com", "events": [{ "type": "processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 82412 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "David", "status": "ready" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }]

let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)

client.getSignatures()


[{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "document.pdf", "pages": 11, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }, { "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "david@signaturit.com", "events": [{ "type": "processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 82412 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "David", "status": "ready" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }]

Client client = new Client("YOUR_ACCESS_TOKEN", false);

client.getSignatures();


[{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "document.pdf", "pages": 11, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }, { "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "david@signaturit.com", "events": [{ "type": "processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 82412 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "David", "status": "ready" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }]

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.getSignatures();


[{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "document.pdf", "pages": 11, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }, { "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "david@signaturit.com", "events": [{ "type": "processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 82412 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "David", "status": "ready" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }]
Example request filter signatures with custom crm_id key.

$ curl

-X GET

-H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

https://api.sandbox.signaturit.com/v3/signatures.json?crm_id=2445


[{ "created_at": "2014-08-21T08:53:35+0000", "data": [{ "key": "crm_id", "value": "2455" }], "documents": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "document.pdf", "pages": 11, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }]

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.get_signatures(nil, nil, { :crm_id => 2445 })


[{ "created_at": "2014-08-21T08:53:35+0000", "data": [{ "key": "crm_id", "value": "2455" }], "documents": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "document.pdf", "pages": 11, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }]

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.get_signatures(conditions={'crm_id': 2445'})


[{ "created_at": "2014-08-21T08:53:35+0000", "data": [{ "key": "crm_id", "value": "2455" }], "documents": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "document.pdf", "pages": 11, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }]

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->getSignatures(null, null, [ 'crm_id' => 2445 ]);


[{ "created_at": "2014-08-21T08:53:35+0000", "data": [{ "key": "crm_id", "value": "2455" }], "documents": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "document.pdf", "pages": 11, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }]

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.getSignatures(null, null, { crm_id: 2445 });


[{ "created_at": "2014-08-21T08:53:35+0000", "data": [{ "key": "crm_id", "value": "2455" }], "documents": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "document.pdf", "pages": 11, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }]

let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)

client.getSignatures(["crm_id": "2445"])


[{ "created_at": "2014-08-21T08:53:35+0000", "data": [{ "key": "crm_id", "value": "2455" }], "documents": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "document.pdf", "pages": 11, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }]

Client client = new Client("YOUR_ACCESS_TOKEN", false);

HashMap<String, Object> parameters = new HashMap<String, Object>();

HashMap<String, String> dataParam = new HashMap<String, String>();

dataParam.put("crm_id", "2445");

parameters.put("data", dataParam);

client.getSignatures(parameters);


[{ "created_at": "2014-08-21T08:53:35+0000", "data": [{ "key": "crm_id", "value": "2455" }], "documents": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "document.pdf", "pages": 11, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }]

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.getSignatures(100, 0, new { crm_id = "2445" })


[{ "created_at": "2014-08-21T08:53:35+0000", "data": [{ "key": "crm_id", "value": "2455" }], "documents": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "document.pdf", "pages": 11, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }]

GET /v3/signatures/{id}.(json | xml)

Description

Get a given signature request.

Response

Single signature request in JSON or XML format.

Example request

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/signatures/6f6c974e-2910-11e4-b3d4-0aa7697eb409.json


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "email": "john@signaturit.com", "events": [{ "created_at": "2014-08-21T08:55:14+0000", "type": "email_processed" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.get_signature('6f6c974e-2910-11e4-b3d4-0aa7697eb409')


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "email": "john@signaturit.com", "events": [{ "created_at": "2014-08-21T08:55:14+0000", "type": "email_processed" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.get_signature('6f6c974e-2910-11e4-b3d4-0aa7697eb409')


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "email": "john@signaturit.com", "events": [{ "created_at": "2014-08-21T08:55:14+0000", "type": "email_processed" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->getSignature('6f6c974e-2910-11e4-b3d4-0aa7697eb409');


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "email": "john@signaturit.com", "events": [{ "created_at": "2014-08-21T08:55:14+0000", "type": "email_processed" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.getSignature('6f6c974e-2910-11e4-b3d4-0aa7697eb409');


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "email": "john@signaturit.com", "events": [{ "created_at": "2014-08-21T08:55:14+0000", "type": "email_processed" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)

client.getSignature("6f6c974e-2910-11e4-b3d4-0aa7697eb409")


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "email": "john@signaturit.com", "events": [{ "created_at": "2014-08-21T08:55:14+0000", "type": "email_processed" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

Client client = new Client("YOUR_ACCESS_TOKEN", false);

client.getSignature("6f6c974e-2910-11e4-b3d4-0aa7697eb409");


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "email": "john@signaturit.com", "events": [{ "created_at": "2014-08-21T08:55:14+0000", "type": "email_processed" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.getSignature("6f6c974e-2910-11e4-b3d4-0aa7697eb409");


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "email": "john@signaturit.com", "events": [{ "created_at": "2014-08-21T08:55:14+0000", "type": "email_processed" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

POST /v3/signatures.(json | xml)

Description

Create a new signature request.

Parameters
body

Email body (html code is allowed) for email and sms type requests. OPTIONAL

Note: For sms request types it will be truncated to 120 characters

Note: For sms the body should contain the tag {{url}} where we will include the document url

branding_id
Use a custom branding for the signature request. OPTIONAL
callback_url
Url to redirect the user when finish the signature process. OPTIONAL
data

Custom information in a key: value format that you can include in the signature request. OPTIONAL

When the key values correspond to a PDF form field, it will be filled and stamped automatically to the document.

When the key values correspond to a Signaturit template widget field, it will be filled by default to the signer in app and the signer will be allowed to modify the value.

All other key:value pairs will be stored in the signature and can be used later as search criteria on the "Get Signatures" endpoint described above. The maximum length allowed for these fields is 64 characters.

delivery_type

The signature request delivery type. OPTIONAL

The available delivery types are:

email
The signature request is sent by email. This is the default behavior when no type is specified.
sms
The signature request is sent by SMS. You must include the phone in the recipients parameter.
url
The signature request is not sent to the signer. Instead of this, the creation request will return a url parameter that you can open in the browser to complete the signature.
expire_time

Expiration time of the document (in days). OPTIONAL

It must be a positive number and can't be greater than 365 days.

events_url

URL that receive realtime information about this signature process. OPTIONAL

See the signatures event url section for more information.

files
List with pdf / doc files.
name
Name assigned to the signature.
recipients

List with signature recipients containing name, email and extra requirements for the signature process if needed.

Every item can contain the next information:

email
The signer's email address.
name
The signer's name.
phone

The signer's phone. OPTIONAL

The phone number should contain the country code. For example, for spain (+34) the value for the phone 555667788 is:

phone=34555667788

This is a requirement for sms request types and when requiring a SMS validation with the require_sms_validation feature.

sign_with_digital_certificate_file

A boolean (1 or 0) which indicates if the sign must be signed with digital certificate. You must add a widget with type dcf in order to use this option

digital_certificate_name

Text which indicates the name of the digital certificate to be used.
* Certificates extension files must be .pfx or .p12.

require_file_attachment

A single number or a list with the number of required attached files you need for every document in this recipient. OPTIONAL

The index of the list references the document number, so first value will apply to first document.

Example to require 5 attached files in every document.

require_file_attachment=5

Example to require 2 attached files for the first document and 5 attached files for the second one.

require_file_attachment=[2, 5]

require_photo

A single number or a list with the number of required photos you need for every document in this recipient. OPTIONAL

The index of the list references the document number, so first value will apply to first document.

Example to require 5 photos in every document.

require_photo=5

Example to require 2 photos for the first document and 5 photo files for the second one.

require_photo=[2, 5]

require_photo_id

A single number or a list with the number of required photo ids you need for every document in this recipient. OPTIONAL

The index of the list references the document number, so first value will apply to first document.

Example to require 5 photos ids in every document.

require_photo_id=5

Example to require 2 photos ids for the first document and 5 photo files for the second one.

require_photo_id=[2, 5]

widgets

If you want to assign widgets to signer, you can specify them too.

Every widget must be set using the following parameters:

page
Page where widget is required (range 1..N).
left
Widget position on page on the X axis (range 1..100).
top
Widget position on page on the Y axis (range 1..100).
height
Widget height in percentage relative to page size.
width
Widget width in percentage relative to page size.
type
Widget type. Types are: date, image, check, radio, select, text, signature and digital certificate. At least one signature widget must be set.
default
Default value for the widget.
editable
If the signer will be able to fill this widget or not. If not editable, the value will be stamped directly to the document.
word_anchor
Set this value to find a single word in the document and anchor the widget to that position. If the word is found multiple times, there will be a widget for each one. This parameter doesn't support spaces or special characters.
If set, editable can't be disable.
If set, page parameter will be ignored.
If set, height and width are mandatory
If set, top and left represent the distance to the top-left corner of the word (range 1..100).
options
Widget options. This is only required on radio and select widgets, and optional in check, text and date widgets, see examples. Here you can define your validation rules
required
Defines if a widget is necessary to be filled out or not by the signer. For example, setting the Checkbox widget as non-required (0) will allow the user to leave it blank. If setting the Checkbox widget as required (1), then the signer needs to check it in order to complete the document.
require_sms_validation

A boolean (0 or 1) to enable a password in the document that will be sent as an SMS to the recipient's phone. OPTIONAL

If you use this feature, you will need to set the phone parameter in the recipient item.

sms_code

A boolean with a true value to enable a code acceptance that will be sent as an SMS to the recipient's phone. OPTIONAL

If you use this feature, you will need to set the phone parameter in the recipient item.

type

A string that define the recipient type. OPTIONAL

Note: the default value is signer.

Possible values are:

signer
A regular signer that will receive the document and have to sign it.
validator
The validator will receive the document in the specified order and will be able to see the previous recipients signs and data inserted
cc

List with email recipients containing name and email for people that will receive a copy of the signed document when the process is completed. OPTIONAL

Every item can contain the next information:

email
The recipient email address.
name
The recipient name.
reply_to

Additional email address that will be used as email Reply-To header OPTIONAL

reminders

A single value or an array with time values in days to wait until sending and automatic reminder. OPTIONAL

You can set it 0 to disable reminders.

signing_mode

The signing mode lets you control the order in which your recipients receive and sign your documents OPTIONAL

Note: the default value is sequential.

The available signing modes are:

sequential
Each recipient receives the request once the previous recipient has completed their action.
parallel
All recipients receive the request in parallel.
subject
Email subject for email type requests. OPTIONAL
templates
Templates to use in the signature request. You can use the id or hashtag. OPTIONAL
type

The type of the signature. OPTIONAL

Note: the default value is the advanced signature request.

The available types are:

simple
A simple signature request is created.
advanced
An advanced signature request is created. We capture the biometric information of the signer with the signature draw.
smart
The system creates different type of signature depending in the user device. A simple signature is created for desktop pcs and advanced signature is created for mobile and tablet devices.
More details about widgets
Radio widget
custom_id
Value to reference multiple radio widgets that belongs to the same group. Only one widget within the same group can be selected. OPTIONAL
options[index]
Position of the widget in the group. Used for reference the widget within the group. Two radio widgets with the same index on the same group will behave as the same widget.OPTIONAL
default
The default radio button selected for the group. The index value should be used for reference. All radio buttons widget of the same group should have the same default value. OPTIONAL
Check widget
options
You can set show_yes_no_option as options value in order to show Yes\No option with the widget. Only works with editable widgets. OPTIONAL
Response

New signature request in JSON or XML format.

Example request

$ curl

-X POST

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

-F "recipients[0][name]=John"

-F "recipients[0][email]=john.doe@gmail.com"

-F "files[0]=@/path/to/the/pdf/document.pdf"

https://api.sandbox.signaturit.com/v3/signatures.json


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [], "name": "John", "status": "ready", "file": { "name": "document.pdf", "pages": 2, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.create_signature(['/path/to/the/pdf/document.pdf'], { :name => 'John', :email => 'john.doe@gmail.com' })


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [], "name": "John", "status": "ready", "file": { "name": "document.pdf", "pages": 2, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.create_signature(['/path/to/the/pdf/document.pdf'], { 'name': 'John', 'email': 'john.doe@gmail.com' })


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [], "name": "John", "status": "ready", "file": { "name": "document.pdf", "pages": 2, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->createSignature(['/path/to/the/pdf/document.pdf'], [ 'name' => 'John', 'email' => 'john.doe@gmail.com' ]);


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [], "name": "John", "status": "ready", "file": { "name": "document.pdf", "pages": 2, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.createSignature(['/path/to/the/pdf/document.pdf'], { name: 'John', email: 'john.doe@gmail.com' } );


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [], "name": "John", "status": "ready", "file": { "name": "document.pdf", "pages": 2, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

let pdf = NSBundle.mainBundle().URLForResource("document", withExtension: "pdf")

let signer = [["email": "john.doe@gmail.com", "fullname": "John"]]

let params = []

let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)

client.createSignature([pdf], recipients: signer, params: params, successHandler: { response in

})


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [], "name": "John", "status": "ready", "file": { "name": "document.pdf", "pages": 2, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

Client client = new Client("YOUR_ACCESS_TOKEN", false);

ArrayList<File> filePath = new ArrayList<File>();

File temp = new File("/path/to/the/pdf/document.pdf");

filePath.add(temp);

ArrayList<HashMap<String, Object>> recipients = new ArrayList<HashMap<String,Object>>();

HashMap<String, Object> recipient= new HashMap<String, Object>();

recipient.put("email", "john.doe@gmail.com");

recipient.put("fullname", "John");

recipients.add(recipient);

Response response = client.createSignature(filePath, recipients);


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [], "name": "John", "status": "ready", "file": { "name": "document.pdf", "pages": 2, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

var recipients = new [] {

new { name = "John" , email = "john.doe@gmail.com"}

};

var files = new [] {

"/path/to/the/pdf/document.pdf"

};

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.createSignature(files, recipients, null);


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [], "name": "John", "status": "ready", "file": { "name": "document.pdf", "pages": 2, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }
Example request using a template with hashtag #NDA instead of file

$ curl

-X POST

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

-d "recipients[0][name]=John"

-d "recipients[0][email]=john.doe@gmail.com"

-d "templates[0]=#NDA"

https://api.sandbox.signaturit.com/v3/signatures.json


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [], "file": { "name": "nda15.pdf", "pages": 10, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.create_signature('/path/to/the/pdf/document.pdf', { :name => 'John', :email => 'john.doe@gmail.com' }, { :templates => ['#NDA'] })


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [], "file": { "name": "nda15.pdf", "pages": 10, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.create_signature([], { 'name': 'John', 'email': 'john.doe@gmail.com' }, { 'templates': ['#NDA'] })


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [], "file": { "name": "nda15.pdf", "pages": 10, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->createSignature( [], [ 'name' => 'John', 'email' => 'john.doe@gmail.com' ), [ 'templates' => ['#NDA'] ] ];


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [], "file": { "name": "nda15.pdf", "pages": 10, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.createSignature('', { name: 'John', email: 'john.doe@gmail.com' }, { templates: '#NDA' });


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [], "file": { "name": "nda15.pdf", "pages": 10, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

let signer = [["email": "john.doe@gmail.com", "fullname": "John"]]

let params = ["templates": "#NDA"]

let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)

client.createSignature([], recipients: signer, params: params, successHandler: { response in

})


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [], "file": { "name": "nda15.pdf", "pages": 10, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

Client client = new Client("YOUR_ACCESS_TOKEN", false);

ArrayList<File> filePath = new ArrayList<File>();

ArrayList<HashMap<String, Object>> recipients = new ArrayList<HashMap<String,Object>>();

HashMap<String, Object> recipient= new HashMap<String, Object>();

recipient.put("email", "john.doe@gmail.com");

recipient.put("fullname", "John");

recipients.add(recipient);

HashMap<String, Object> parameters = new HashMap<String, Object>();

parameters.put("templates", "#NDA");

Response response = client.createSignature(filePath, recipients, parameters);


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [], "file": { "name": "nda15.pdf", "pages": 10, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

var recipients = new [] {

new { name = "John" , email = "john.doe@gmail.com"}

};

var parameters = new { templates = "#NDA" };

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.createSignature(null, recipients, parameters);


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [], "file": { "name": "nda15.pdf", "pages": 10, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-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 YOUR_ACCESS_TOKEN"

-d "recipients[0][name]=John"

-d "recipients[0][email]=john.doe@gmail.com"

-d "templates[0]=#NDA"

-d "data[widget_id]=DEFAULT_VALUE"

https://api.sandbox.signaturit.com/v3/signatures.json


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "file": { "name": "nda15.pdf", "pages": 10, "size": 72218 }, "name": "John", "status": "ready" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.create_signature('/path/to/the/pdf/document.pdf', { :name => 'John', :email => 'john.doe@gmail.com' }, { :templates => ['#NDA'], :data => ['WIDGET_ID' => 'DEFAULT_VALUE'] })


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "file": { "name": "nda15.pdf", "pages": 10, "size": 72218 }, "name": "John", "status": "ready" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.create_signature([], { 'name': 'John', 'email': 'john.doe@gmail.com' }, { 'templates': ['#NDA'], 'data': ['WIDGET_ID': 'DEFAULT_VALUE'] })


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "file": { "name": "nda15.pdf", "pages": 10, "size": 72218 }, "name": "John", "status": "ready" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->createSignature( [], [ 'name' => 'John', 'email' => 'john.doe@gmail.com' ], [ 'templates' => ['#NDA'], 'data' => ['WIDGET_ID' => 'DEFAULT_DATA'] ] );


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "file": { "name": "nda15.pdf", "pages": 10, "size": 72218 }, "name": "John", "status": "ready" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.createSignature('', { name: 'John', email: 'john.doe@gmail.com' }, { templates: '#NDA', data: { 'WIDGET_ID': 'DEFAULT_VALUE' } });


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "file": { "name": "nda15.pdf", "pages": 10, "size": 72218 }, "name": "John", "status": "ready" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

let signer = [["email": "john.doe@gmail.com", "fullname": "John"]]

let params = ["templates": "#NDA", "data": ["WIDGET_ID": "DEFAULT_VALUE"]]

let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)

client.createSignature([], recipients: signer, params: params, successHandler: { response in

})


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "file": { "name": "nda15.pdf", "pages": 10, "size": 72218 }, "name": "John", "status": "ready" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

Client client = new Client("YOUR_ACCESS_TOKEN", false);

ArrayList<File> filePath = new ArrayList<File>();

ArrayList<HashMap<String, Object>> recipients = new ArrayList<HashMap<String,Object>>();

HashMap<String, Object> recipient= new HashMap<String, Object>();

recipient.put("email", "john.doe@gmail.com");

recipient.put("fullname", "John");

recipients.add(recipient);

HashMap<String, Object> data = new HashMap<String, Object>();

data.put("WIDGET_ID", "DEFAULT_VALUE");

HashMap<String, Object> parameters = new HashMap<String, Object>();

parameters.put("templates", "#NDA");

parameters.put("data", data);

Response response = client.createSignature(filePath, recipients, parameters);


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "file": { "name": "nda15.pdf", "pages": 10, "size": 72218 }, "name": "John", "status": "ready" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

var recipients = new [] {

new { name = "John" , email = "john.doe@gmail.com"}

};

var parameters = new { templates = "#NDA", data = new { WIDGET_ID = "DEFAULT_NODE" } };

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.createSignature(null, recipients, parameters);


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "file": { "name": "nda15.pdf", "pages": 10, "size": 72218 }, "name": "John", "status": "ready" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }
Example request using a custom data

$ curl

-X POST

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

-d "recipients[0][name]=John"

-d "recipients[0][email]=john.doe@gmail.com"

-d "templates[0]=#NDA"

-d "data[crm_id]=2445"

https://api.sandbox.signaturit.com/v3/signatures.json


{ "created_at": "2014-08-21T08:53:35+0000", "data": [{ "key": "crm_id", "value": "2455" }], "documents": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "file": { "name": "nda15.pdf", "pages": 10, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.create_signature('/path/to/the/pdf/document.pdf', { :name => 'John', :email => 'john.doe@gmail.com' }, { :templates => ['#NDA'], :data => { :crm_id: 2445 } })


{ "created_at": "2014-08-21T08:53:35+0000", "data": [{ "key": "crm_id", "value": "2455" }], "documents": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "file": { "name": "nda15.pdf", "pages": 10, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.create_signature([], { 'name': 'John', 'email': 'john.doe@gmail.com' }, { 'templates': ['#NDA'], 'data': { 'crm_id': 2445 } })


{ "created_at": "2014-08-21T08:53:35+0000", "data": [{ "key": "crm_id", "value": "2455" }], "documents": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "file": { "name": "nda15.pdf", "pages": 10, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->createSignature( [], [ 'name' => 'John', 'email' => 'john.doe@gmail.com' ], [ 'templates' => ['#NDA'], 'data' => [ 'crm_id' => 2445 ] ] );


{ "created_at": "2014-08-21T08:53:35+0000", "data": [{ "key": "crm_id", "value": "2455" }], "documents": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "file": { "name": "nda15.pdf", "pages": 10, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.createSignature('', { name: 'John', email: 'john.doe@gmail.com' }, { templates: '#NDA', data: { crm_id: 2445 } });


{ "created_at": "2014-08-21T08:53:35+0000", "data": [{ "key": "crm_id", "value": "2455" }], "documents": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "file": { "name": "nda15.pdf", "pages": 10, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

let signer = [["email": "john.doe@gmail.com", "fullname": "John"]]

let params = ["templates": "#NDA", "data": ["crm_id": 2445]]

let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)

client.createSignature([], recipients: signer, params: params, successHandler: { response in

})


{ "created_at": "2014-08-21T08:53:35+0000", "data": [{ "key": "crm_id", "value": "2455" }], "documents": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "file": { "name": "nda15.pdf", "pages": 10, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

Client client = new Client("YOUR_ACCESS_TOKEN", false);

ArrayList<File> filePath = new ArrayList<File>();

ArrayList<HashMap<String, Object>> recipients = new ArrayList<HashMap<String,Object>>();

HashMap<String, Object> recipient= new HashMap<String, Object>();

recipient.put("email", "john.doe@gmail.com");

recipient.put("fullname", "John");

recipients.add(recipient);

HashMap<String, Object> data = new HashMap<String, Object>();

data.put("WIDGET_ID", "DEFAULT_VALUE");

data.put("crm_id", 2445);

HashMap<String, Object> parameters = new HashMap<String, Object>();

parameters.put("templates", "#NDA");

parameters.put("data", data);

Response response = client.createSignature(filePath, recipients, parameters);


{ "created_at": "2014-08-21T08:53:35+0000", "data": [{ "key": "crm_id", "value": "2455" }], "documents": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "file": { "name": "nda15.pdf", "pages": 10, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

var recipients = new [] {

new { name = "John" , email = "john.doe@gmail.com"}

};

var parameters = new { templates = "#NDA", data = new { crm_id = "2445" } };

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.createSignature(null, recipients, parameters);


{ "created_at": "2014-08-21T08:53:35+0000", "data": [{ "key": "crm_id", "value": "2455" }], "documents": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "file": { "name": "nda15.pdf", "pages": 10, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }
Example request using all widget options on a signer:

$ curl

-X POST

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

-F "recipients[0][name]=John"

-F "recipients[0][email]=john.doe@gmail.com"

-F "recipients[0][widgets][0][default]=This is a non-editable text"

-F "recipients[0][widgets][0][page]=1"

-F "recipients[0][widgets][0][left]=71.10583280773"

-F "recipients[0][widgets][0][top]=1.5"

-F "recipients[0][widgets][0][type]=text"

-F "recipients[0][widgets][0][height]=5"

-F "recipients[0][widgets][0][width]=30"

-F "recipients[0][widgets][0][editable]=0"

-F "recipients[0][widgets][1][default]=This is an editable text"

-F "recipients[0][widgets][1][page]=1"

-F "recipients[0][widgets][1][left]=31.10583280773"

-F "recipients[0][widgets][1][top]=1.5"

-F "recipients[0][widgets][1][type]=text"

-F "recipients[0][widgets][1][height]=5"

-F "recipients[0][widgets][1][width]=30"

-F "recipients[0][widgets][1][editable]=1"

-F "recipients[0][widgets][2][default]=0"

-F "recipients[0][widgets][2][page]=1"

-F "recipients[0][widgets][2][left]=31.10583280773"

-F "recipients[0][widgets][2][top]=10"

-F "recipients[0][widgets][2][type]=check"

-F "recipients[0][widgets][2][height]=5"

-F "recipients[0][widgets][2][width]=5"

-F "recipients[0][widgets][2][editable]=0"

-F "recipients[0][widgets][3][default]=1"

-F "recipients[0][widgets][3][page]=1"

-F "recipients[0][widgets][3][left]=41.10583280773"

-F "recipients[0][widgets][3][top]=10"

-F "recipients[0][widgets][3][type]=check"

-F "recipients[0][widgets][3][height]=5"

-F "recipients[0][widgets][3][width]=5"

-F "recipients[0][widgets][3][editable]=0"

-F "recipients[0][widgets][4][default]=1"

-F "recipients[0][widgets][4][page]=1"

-F "recipients[0][widgets][4][left]=71.10583280773"

-F "recipients[0][widgets][4][top]=10"

-F "recipients[0][widgets][4][type]=check"

-F "recipients[0][widgets][4][height]=5"

-F "recipients[0][widgets][4][width]=5"

-F "recipients[0][widgets][4][editable]=1"

-F "recipients[0][widgets][4][options]=show_yes_no_option"

-F "recipients[0][widgets][5][default]=0"

-F "recipients[0][widgets][5][page]=1"

-F "recipients[0][widgets][5][left]=31.10583280773"

-F "recipients[0][widgets][5][top]=20"

-F "recipients[0][widgets][5][type]=radio"

-F "recipients[0][widgets][5][height]=5"

-F "recipients[0][widgets][5][width]=5"

-F "recipients[0][widgets][5][editable]=1"

-F "recipients[0][widgets][5][custom_id]=radio_01"

-F "recipients[0][widgets][5][options][index]=0"

-F "recipients[0][widgets][6][default]=0"

-F "recipients[0][widgets][6][page]=1"

-F "recipients[0][widgets][6][left]=41.10583280773"

-F "recipients[0][widgets][6][top]=20"

-F "recipients[0][widgets][6][type]=radio"

-F "recipients[0][widgets][6][height]=5"

-F "recipients[0][widgets][6][width]=5"

-F "recipients[0][widgets][6][editable]=1"

-F "recipients[0][widgets][6][custom_id]=radio_01"

-F "recipients[0][widgets][6][options][index]=1"

-F "recipients[0][widgets][7][default]=0"

-F "recipients[0][widgets][7][page]=1"

-F "recipients[0][widgets][7][left]=31.10583280773"

-F "recipients[0][widgets][7][top]=25"

-F "recipients[0][widgets][7][type]=radio"

-F "recipients[0][widgets][7][height]=5"

-F "recipients[0][widgets][7][width]=5"

-F "recipients[0][widgets][7][editable]=1"

-F "recipients[0][widgets][7][custom_id]=radio_01"

-F "recipients[0][widgets][7][options][index]=2"

-F "recipients[0][widgets][8][default]=0"

-F "recipients[0][widgets][8][page]=1"

-F "recipients[0][widgets][8][left]=41.10583280773"

-F "recipients[0][widgets][8][top]=25"

-F "recipients[0][widgets][8][type]=radio"

-F "recipients[0][widgets][8][height]=5"

-F "recipients[0][widgets][8][width]=5"

-F "recipients[0][widgets][8][editable]=0"

-F "recipients[0][widgets][8][custom_id]=radio_02"

-F "recipients[0][widgets][8][options][index]=0"

-F "recipients[0][widgets][9][default]=0"

-F "recipients[0][widgets][9][page]=1"

-F "recipients[0][widgets][9][left]=51.10583280773"

-F "recipients[0][widgets][9][top]=25"

-F "recipients[0][widgets][9][type]=radio"

-F "recipients[0][widgets][9][height]=5"

-F "recipients[0][widgets][9][width]=5"

-F "recipients[0][widgets][9][editable]=0"

-F "recipients[0][widgets][9][custom_id]=radio_02"

-F "recipients[0][widgets][9][options][index]=1"

-F "recipients[0][widgets][10][default]=0"

-F "recipients[0][widgets][10][page]=1"

-F "recipients[0][widgets][10][left]=41.10583280773"

-F "recipients[0][widgets][10][top]=30"

-F "recipients[0][widgets][10][type]=select"

-F "recipients[0][widgets][10][height]=5"

-F "recipients[0][widgets][10][width]=50"

-F "recipients[0][widgets][10][editable]=1"

-F "recipients[0][widgets][10][options][select][0][value]=option A"

-F "recipients[0][widgets][10][options][select][0][default]=1"

-F "recipients[0][widgets][10][options][select][1][value]=option B"

-F "recipients[0][widgets][10][options][select][1][default]=0"

-F "recipients[0][widgets][11][default]=0"

-F "recipients[0][widgets][11][page]=1"

-F "recipients[0][widgets][11][left]=50"

-F "recipients[0][widgets][11][top]=90"

-F "recipients[0][widgets][11][type]=signature"

-F "recipients[0][widgets][11][height]=9.9784615384615"

-F "recipients[0][widgets][11][width]=25"

-F "recipients[0][widgets][12][default]=2017-07-27"

-F "recipients[0][widgets][12][page]=1"

-F "recipients[0][widgets][12][left]=35"

-F "recipients[0][widgets][12][top]=1.5"

-F "recipients[0][widgets][12][type]=date"

-F "recipients[0][widgets][12][height]=5"

-F "recipients[0][widgets][12][width]=30"

-F "recipients[0][widgets][13][page]=1"

-F "recipients[0][widgets][13][left]=20"

-F "recipients[0][widgets][13][top]=5"

-F "recipients[0][widgets][13][type]=text"

-F "recipients[0][widgets][13][height]=5"

-F "recipients[0][widgets][13][width]=30"

-F "recipients[0][widgets][13][editable]=1"

-F "recipients[0][widgets][13][options][validation_rule]=email"

-F "files[0]=nda.pdf"

https://api.sandbox.signaturit.com/v3/signatures.json


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [], "file": { "name": "nda15.pdf", "pages": 10, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.create_signature( 'nda.pdf', { :email => 'signer@signaturit.com', :name => 'signer', :widgets => [ { :default => 'This is a non-editable text', :page => 1, :part => 0, :left => 71.10583280773, :top => 1.5, :type => 'text', :height => 5, :width => 30, :editable => 0 }, { :default => 'This is a editable text', :page => 1, :part => 0, :left => 31.10583280773, :top => 1.5, :type => 'text', :height => 1.9956923076923, :width => 17, :editable => 1 }, { :default => 0, :page => 1, :part => 0, :left => 31.10583280773, :top => 10, :type => 'check', :height => 5, :width => 5, :editable => 0 }, { :default => 1, :page => 1, :part => 0, :left => 41.10583280773, :top => 10, :type => 'check', :height => 5, :width => 5, :editable => 0 }, { :default => 1, :page => 1, :part => 0, :left => 71.10583280773, :top => 10, :type => 'check', :height => 5, :width => 5, :editable => 1, :options => 'show_yes_no_option', }, { :default => 0, :page => 1, :part => 0, :left => 31.10583280773, :top => 20, :type => 'radio', :height => 5, :width => 5, :editable => 1, :options => { :id => 'radio_01', :index => 0, } }, { :default => 0, :page => 1, :part => 0, :left => 41.10583280773, :top => 20, :type => 'radio', :height => 5, :width => 5, :editable => 1, :options => { :id => 'radio_01', :index => 1 } }, { :default => 0, :page => 1, :part => 0, :left => 31.10583280773, :top => 25, :type => 'radio', :height => 5, :width => 5, :editable => 1, :options => { :id => 'radio_01', :index => 2, } }, { :default => 0, :page => 1, :part => 0, :left => 41.10583280773, :top => 25, :type => 'radio', :height => 5, :width => 5, :editable => 0, :options => { :id => 'radio_02', :index => 0 } }, { :default => 0, :page => 1, :part => 0, :left => 51.10583280773, :top => 25, :type => 'radio', :height => 5, :width => 5, :editable => 0, :options => { :id => 'radio_02', :index => 1 } }, { :default => 0, :page => 1, :part => 0, :left => 41.10583280773, :top => 30, :type => 'select', :height => 5, :width => 50, :editable => 1, :options => { :select => [ { :value => 'option A', :default => 1, }, { :value => 'option B', :default => 0 } ] } }, { :height => 9.9784615384615, :page => 1, :part => 0, :left => 50, :top => 90, :type => 'signature', :width => 25 }, { :page => 1, :part => 0, :left => 20, :top => 5, :type => 'text', :height => 5, :width => 30, :editable => 1, :options => { :validation_rule => 'email' } } } )


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [], "file": { "name": "nda15.pdf", "pages": 10, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.create_signature( ['nda.pdf'], [ { 'email': 'signer@signaturit.com', 'name': 'signer', 'widgets': [ { 'default': 'This is a non-editable text', 'page': 1, 'part': 0, 'left': 71.10583280773, 'top': 1.5, 'type': 'text', 'height': 5, 'width': 30, 'editable': 0 }, { 'default': 'This is a editable text', 'page': 1, 'part': 0, 'left': 31.10583280773, 'top': 1.5, 'type': 'text', 'height': 1.9956923076923, 'width': 17, 'editable': 1 }, { 'default': 0, 'page': 1, 'part': 0, 'left': 31.10583280773, 'top': 10, 'type': 'check', 'height': 5, 'width': 5, 'editable': 0 }, { 'default': 1, 'page': 1, 'part': 0, 'left': 41.10583280773, 'top': 10, 'type': 'check', 'height': 5, 'width': 5, 'editable': 0 }, { 'default': 1, 'page': 1, 'part': 0, 'left': 71.10583280773, 'top': 10, 'type': 'check', 'height': 5, 'width': 5, 'editable': 1, 'options': 'show_yes_no_option' }, { 'default': 0, 'page': 1, 'part': 0, 'left': 31.10583280773, 'top': 20, 'type': 'radio', 'height': 5, 'width': 5, 'editable': 1, 'options': { 'id': 'radio_01', 'index': 0, } }, { 'default': 0, 'page': 1, 'part': 0, 'left': 41.10583280773, 'top': 20, 'type': 'radio', 'height': 5, 'width': 5, 'editable': 1, 'options': { 'id': 'radio_01', 'index': 1 } }, { 'default': 0, 'page': 1, 'part': 0, 'left': 31.10583280773, 'top': 25, 'type': 'radio', 'height': 5, 'width': 5, 'editable': 1, 'options': { 'id': 'radio_01', 'index': 2, } }, { 'default': 0, 'page': 1, 'part': 0, 'left': 41.10583280773, 'top': 25, 'type': 'radio', 'height': 5, 'width': 5, 'editable': 0, 'options': { 'id': 'radio_02', 'index': 0 } }, { 'default': 0, 'page': 1, 'part': 0, 'left': 51.10583280773, 'top': 25, 'type': 'radio', 'height': 5, 'width': 5, 'editable': 0, 'options': { 'id': 'radio_02', 'index': 1 } }, { 'default': 0, 'page': 1, 'part': 0, 'left': 41.10583280773, 'top': 30, 'type': 'select', 'height': 5, 'width': 50, 'editable': 1, 'options': { 'select': [ { 'value': 'option A', 'default': 1, }, { 'value': 'option B', 'default': 0 } ] } }, { 'height': 9.9784615384615, 'page': 1, 'part': 0, 'left': 50, 'top': 90, 'type': 'signature', 'width': 25 }, { 'page': 1, 'part': 0, 'left': 20, 'top': 5, 'type': 'text', 'height': 5, 'width': 30, 'editable': 1, 'options': { 'validation_rule': 'email' } }, ] } ] )


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [], "file": { "name": "nda15.pdf", "pages": 10, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->createSignature( 'nda.pdf', [ [ 'email' => 'signer@signaturit.com', 'name' => 'signer', 'widgets' => [ [ 'default' => 'This is a non-editable text', 'page' => 1, 'part' => 0, 'left' => 71.10583280773, 'top' => 1.5, 'type' => 'text', 'height' => 5, 'width' => 30, 'editable' => 0 ], [ 'default' => 'This is a editable text', 'page' => 1, 'part' => 0, 'left' => 31.10583280773, 'top' => 1.5, 'type' => 'text', 'height' => 1.9956923076923, 'width' => 17, 'editable' => 1 ], [ 'default' => 0, 'page' => 1, 'part' => 0, 'left' => 31.10583280773, 'top' => 10, 'type' => 'check', 'height' => 5, 'width' => 5, 'editable' => 0 ], [ 'default' => 1, 'page' => 1, 'part' => 0, 'left' => 41.10583280773, 'top' => 10, 'type' => 'check', 'height' => 5, 'width' => 5, 'editable' => 0 ], [ 'default' => 1, 'page' => 1, 'part' => 0, 'left' => 71.10583280773, 'top' => 10, 'type' => 'check', 'height' => 5, 'width' => 5, 'editable' => 1, 'options' => 'show_yes_no_option' ], [ 'default' => 0, 'page' => 1, 'part' => 0, 'left' => 31.10583280773, 'top' => 20, 'type' => 'radio', 'height' => 5, 'width' => 5, 'editable' => 1, 'options' => [ 'id' => 'radio_01', 'index' => 0, ] ], [ 'default' => 0, 'page' => 1, 'part' => 0, 'left' => 41.10583280773, 'top' => 20, 'type' => 'radio', 'height' => 5, 'width' => 5, 'editable' => 1, 'options' => [ 'id' => 'radio_01', 'index' => 1 ] ], [ 'default' => 0, 'page' => 1, 'part' => 0, 'left' => 31.10583280773, 'top' => 25, 'type' => 'radio', 'height' => 5, 'width' => 5, 'editable' => 1, 'options' => [ 'id' => 'radio_01', 'index' => 2, ] ], [ 'default' => 0, 'page' => 1, 'part' => 0, 'left' => 41.10583280773, 'top' => 25, 'type' => 'radio', 'height' => 5, 'width' => 5, 'editable' => 0, 'options' => [ 'id' => 'radio_02', 'index' => 0 ] ], [ 'default' => 0, 'page' => 1, 'part' => 0, 'left' => 51.10583280773, 'top' => 25, 'type' => 'radio', 'height' => 5, 'width' => 5, 'editable' => 0, 'options' => [ 'id' => 'radio_02', 'index' => 1 ] ], [ 'default' => 0, 'page' => 1, 'part' => 0, 'left' => 41.10583280773, 'top' => 30, 'type' => 'select', 'height' => 5, 'width' => 50, 'editable' => 1, 'options' => [ 'select' => [ [ 'value' => 'option A', 'default' => 1, ], [ 'value' => 'option B', 'default' => 0 ] ] ] ], [ 'height' => 9.9784615384615, 'page' => 1, 'part' => 0, 'left' => 50, 'top' => 90, 'type' => 'signature', 'width' => 25 ], [ 'page' => 1, 'part' => 0, 'left' => 20, 'top' => 5, 'type' => 'text', 'height' => 5, 'width' => 30, 'editable' => 1, 'options' => [ 'validation_rule' => 'email' ] ], ] ] ] )


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [], "file": { "name": "nda15.pdf", "pages": 10, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.createSignature( 'nda.pdf', { email: 'signer@signaturit.com', name: 'signer', widgets: [ { default: 'This is a non-editable text', page: 1, part: 0, left: 71.10583280773, top: 1.5, type: 'text', height: 5, width: 30, editable: 0 }, { default: 'This is a editable text', page: 1, part: 0, left: 31.10583280773, top: 1.5, type: 'text', height: 1.9956923076923, width: 17, editable: 1 }, { default: 0, page: 1, part: 0, left: 31.10583280773, top: 10, type: 'check', height: 5, width: 5, editable: 0 }, { default: 1, page: 1, part: 0, left: 41.10583280773, top: 10, type: 'check', height: 5, width: 5, editable: 0 }, { default: 1, page: 1, part: 0, left: 71.10583280773, top: 10, type: 'check', height: 5, width: 5, editable: 1, options: 'show_yes_no_option' }, { default: 0, page: 1, part: 0, left: 31.10583280773, top: 20, type: 'radio', height: 5, width: 5, editable: 1, options: { id: 'radio_01', index: 0, } }, { default: 0, page: 1, part: 0, left: 41.10583280773, top: 20, type: 'radio', height: 5, width: 5, editable: 1, options: { id: 'radio_01', index: 1 } }, { default: 0, page: 1, part: 0, left: 31.10583280773, top: 25, type: 'radio', height: 5, width: 5, editable: 1, options: { id: 'radio_01', index: 2, } }, { default: 0, page: 1, part: 0, left: 41.10583280773, top: 25, type: 'radio', height: 5, width: 5, editable: 0, options: { id: 'radio_02', index: 0 } }, { default: 0, page: 1, part: 0, left: 51.10583280773, top: 25, type: 'radio', height: 5, width: 5, editable: 0, options: { id: 'radio_02', index: 1 } }, { default: 0, page: 1, part: 0, left: 41.10583280773, top: 30, type: 'select', height: 5, width: 50, editable: 1, options: { select: [ { value: 'option A', default: 1, }, { value: 'option B', default: 0 } ] } }, { height: 9.9784615384615, page: 1, part: 0, left: 50, top: 90, type: 'signature', width: 25 }, { page: 1, part: 0, left: 20, top: 5, type: 'text', height: 5, width: 30, editable: 1, options: { validation_rule: 'email' } }, } )


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [], "file": { "name": "nda15.pdf", "pages": 10, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

Client client = new Client("YOUR_ACCESS_TOKEN", false);

/* Define Documents */

ArrayList<File> documentsList = new ArrayList<File>();

File document = new File("nda.pdf");

documentsList.add(document);

/* Define Widgets */

ArrayList<Map<String, Object>> widgets = new ArrayList<Map<String, Object>>();

/* 1st Widget */

Map<String, Object> widget1 = new HashMap<String, Object>();

widget1.put("default", "This is a non-editable text");

widget1.put("page", 1);

widget1.put("part", 0);

widget1.put("left", 71.10583280773);

widget1.put("top", 1.5);

widget1.put("type", "text");

widget1.put("height", 5);

widget1.put("width", 30);

widget1.put("editable", 0);

widgets.add(widget1);

/* 2nd Widget */

Map<String, Object> widget2 = new HashMap<String, Object>();

widget2.put("default", "This is a editable text");

widget2.put("page", 1);

widget2.put("part", 0);

widget2.put("left", 31.10583280773);

widget2.put("top", 1.5);

widget2.put("type", "text");

widget2.put("height", 1.9956923076923);

widget2.put("width", 17);

widget2.put("editable", 1);

widgets.add(widget2);

/* 3rd Widget */

Map<String, Object> widget3 = new HashMap<String, Object>();

widget3.put("default", 0);

widget3.put("page", 1);

widget3.put("part", 0);

widget3.put("left", 31.10583280773);

widget3.put("top", 10);

widget3.put("type", "check");

widget3.put("height", 5);

widget3.put("width", 5);

widget3.put("editable", 0);

widgets.add(widget3);

/* 4th Widget */

Map<String, Object> widget4 = new HashMap<String, Object>();

widget4.put("default", 1);

widget4.put("page", 1);

widget4.put("part", 0);

widget4.put("left", 41.10583280773);

widget4.put("top", 10);

widget4.put("type", "check");

widget4.put("height", 5);

widget4.put("width", 5);

widget4.put("editable", 0);

widgets.add(widget4);

/* 5th Widget */

Map<String, Object> widget5 = new HashMap<String, Object>();

widget5.put("default", 1);

widget5.put("page", 1);

widget5.put("part", 0);

widget5.put("left", 71.10583280773);

widget5.put("top", 10);

widget5.put("type", "check");

widget5.put("height", 5);

widget5.put("width", 5);

widget5.put("editable", 1);

widget5.put("options", "show_yes_no_option");

widgets.add(widget5);

/* 6th Widget */

Map<String, Object> widget6 = new HashMap<String, Object>();

widget6.put("default", 0);

widget6.put("page", 1);

widget6.put("part", 0);

widget6.put("left", 31.10583280773);

widget6.put("top", 20);

widget6.put("type", "radio");

widget6.put("height", 5);

widget6.put("width", 5);

widget6.put("editable", 1);

Map<String, Object> widget6Options = new HashMap<String, Object>();

widget6Options.put("id", "radio_01");

widget6Options.put("index", 0);

widget6.put("options", widget6Options);

widgets.add(widget6);

/* 7th Widget */

Map<String, Object> widget7 = new HashMap<String, Object>();

widget7.put("default", 0);

widget7.put("page", 1);

widget7.put("part", 0);

widget7.put("left", 41.10583280773);

widget7.put("top", 20);

widget7.put("type", "radio");

widget7.put("height", 5);

widget7.put("width", 5);

widget7.put("editable", 1);

Map<String, Object> widget7Options = new HashMap<String, Object>();

widget7Options.put("id", "radio_01");

widget7Options.put("index", 1);

widget7.put("options", widget7Options);

widgets.add(widget7);

/* 8th Widget */

Map<String, Object> widget8 = new HashMap<String, Object>();

widget8.put("default", 0);

widget8.put("page", 1);

widget8.put("part", 0);

widget8.put("left", 31.10583280773);

widget8.put("top", 25);

widget8.put("type", "radio");

widget8.put("height", 5);

widget8.put("width", 5);

widget8.put("editable", 1);

Map<String, Object> widget8Options = new HashMap<String, Object>();

widget8Options.put("id", "radio_01");

widget8Options.put("index", 2);

widget8.put("options", widget8Options);

widgets.add(widget8);

/* 9th Widget */

Map<String, Object> widget9 = new HashMap<String, Object>();

widget9.put("default", 0);

widget9.put("page", 1);

widget9.put("part", 0);

widget9.put("left", 41.10583280773);

widget9.put("top", 25);

widget9.put("type", "radio");

widget9.put("height", 5);

widget9.put("width", 5);

widget9.put("editable", 0);

Map<String, Object> widget9Options = new HashMap<String, Object>();

widget9Options.put("id", "radio_02");

widget9Options.put("index", 0);

widget9.put("options", widget9Options);

widgets.add(widget9);

/* 10th Widget */

Map<String, Object> widget10 = new HashMap<String, Object>();

widget10.put("default", 0);

widget10.put("page", 1);

widget10.put("part", 0);

widget10.put("left", 51.10583280773);

widget10.put("top", 25);

widget10.put("type", "radio");

widget10.put("height", 5);

widget10.put("width", 5);

widget10.put("editable", 0);

Map<String, Object> widget10Options = new HashMap<String, Object>();

widget10Options.put("id", "radio_02");

widget10Options.put("index", 1);

widget10.put("options", widget10Options);

widgets.add(widget10);

/* 11th Widget */

Map<String, Object> widget11 = new HashMap<String, Object>();

widget11.put("default", 0);

widget11.put("page", 1);

widget11.put("part", 0);

widget11.put("left", 41.10583280773);

widget11.put("top", 30);

widget11.put("type", "select");

widget11.put("height", 5);

widget11.put("width", 50);

widget11.put("editable", 1);

Map<String, Object> widget11Options = new HashMap<String, Object>();

List<Map<String, Object>> select = new ArrayList<Map<String, Object>>();

Map<String, Object> selectOption1 = new HashMap<String, Object>();

selectOption1.put("value", "option A");

selectOption1.put("default", 1);

Map<String, Object> selectOption2 = new HashMap<String, Object>();

selectOption2.put("value", "option B");

selectOption2.put("default", 0);

select.add(selectOption1);

select.add(selectOption2);

widget11Options.put("select", select);

widget11.put("options", widget11Options);

widgets.add(widget11);

/* 12th Widget */

Map<String, Object> widget12 = new HashMap<String, Object>();

widget12.put("height", 9.9784615384615);

widget12.put("page", 1);

widget12.put("part", 0);

widget12.put("left", 50);

widget12.put("top", 90);

widget12.put("type", "signature");

widget12.put("width", 25);

widgets.add(widget12);

widget13.put("page", 1);

widget13.put("part", 0);

widget13.put("left", 20);

widget13.put("top", 5);

widget13.put("type", "text");

widget13.put("height", 5);

widget13.put("width", 30);

widget13.put("editable", 1);

Map<String, Object> widget13Options = new HashMap<String, Object>();

widget13Options.put("validation_rule", "email");

widget13.put("options", widget13Options);

widgets.add(widget13);

/* Define Recipients */

ArrayList<HashMap<String, Object>> recipientsList = new ArrayList<HashMap<String, Object>>();

HashMap<String, Object> recipient = new HashMap<String, Object>();

recipient.put("email", "signer@signaturit.com");

recipient.put("name", "signer");

recipient.put("widgets", widgets);

recipientsList.add(recipient);

/* Create Signature */

client.createSignature(documentsList, recipientsList);


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [], "file": { "name": "nda15.pdf", "pages": 10, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

POST /v3/signatures/{signId}/reminder.(json | xml)

Description

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

Response

Document in JSON or XML format.

Example request

$ curl

-X POST

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/signatures/6f6c974e-2910-11e4-b3d4-0aa7697eb409/reminder.json


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-10-30T09:58:01+0000" }, { "type": "email_delivered", "created_at": "2014-10-30T09:58:03+0000" }, { "type": "email_opened", "created_at": "2014-10-30T09:58:15+0000" }, { "type": "reminder_email_processed", "created_at": "2014-10-30T11:33:46+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN');

client.send_signature_reminder('6f6c974e-2910-11e4-b3d4-0aa7697eb40');


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-10-30T09:58:01+0000" }, { "type": "email_delivered", "created_at": "2014-10-30T09:58:03+0000" }, { "type": "email_opened", "created_at": "2014-10-30T09:58:15+0000" }, { "type": "reminder_email_processed", "created_at": "2014-10-30T11:33:46+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

client = SignaturitClient('YOUR_ACCESS_TOKEN');

client.send_signature_reminder('6f6c974e-2910-11e4-b3d4-0aa7697eb40');


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-10-30T09:58:01+0000" }, { "type": "email_delivered", "created_at": "2014-10-30T09:58:03+0000" }, { "type": "email_opened", "created_at": "2014-10-30T09:58:15+0000" }, { "type": "reminder_email_processed", "created_at": "2014-10-30T11:33:46+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->sendSignatureReminder('6f6c974e-2910-11e4-b3d4-0aa7697eb409');


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-10-30T09:58:01+0000" }, { "type": "email_delivered", "created_at": "2014-10-30T09:58:03+0000" }, { "type": "email_opened", "created_at": "2014-10-30T09:58:15+0000" }, { "type": "reminder_email_processed", "created_at": "2014-10-30T11:33:46+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.sendSignatureReminder('6f6c974e-2910-11e4-b3d4-0aa7697eb409');


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-10-30T09:58:01+0000" }, { "type": "email_delivered", "created_at": "2014-10-30T09:58:03+0000" }, { "type": "email_opened", "created_at": "2014-10-30T09:58:15+0000" }, { "type": "reminder_email_processed", "created_at": "2014-10-30T11:33:46+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)

client.sendSignatureReminder("6f6c974e-2910-11e4-b3d4-0aa7697eb409")


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-10-30T09:58:01+0000" }, { "type": "email_delivered", "created_at": "2014-10-30T09:58:03+0000" }, { "type": "email_opened", "created_at": "2014-10-30T09:58:15+0000" }, { "type": "reminder_email_processed", "created_at": "2014-10-30T11:33:46+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

Client client = new Client("YOUR_ACCESS_TOKEN");

client.sendSignatureReminder("6f6c974e-2910-11e4-b3d4-0aa7697eb409");


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-10-30T09:58:01+0000" }, { "type": "email_delivered", "created_at": "2014-10-30T09:58:03+0000" }, { "type": "email_opened", "created_at": "2014-10-30T09:58:15+0000" }, { "type": "reminder_email_processed", "created_at": "2014-10-30T11:33:46+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.sendReminder("6f6c974e-2910-11e4-b3d4-0aa7697eb409");


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-10-30T09:58:01+0000" }, { "type": "email_delivered", "created_at": "2014-10-30T09:58:03+0000" }, { "type": "email_opened", "created_at": "2014-10-30T09:58:15+0000" }, { "type": "reminder_email_processed", "created_at": "2014-10-30T11:33:46+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

PATCH /v3/signatures/{signId}/cancel.(json | xml)

Description

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

Parameters
reason

Reason of canceling the signature request. OPTIONAL

Note: PATCH request does not support multipart/form-data as Content-Type. Content-Type should be set to application/x-www-form-urlencoded or application/json.

Response

Canceled signature in JSON or XML format.

Example request

$ curl

-X PATCH

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/signatures/6f6c974e-2910-11e4-b3d4-0aa7697eb409/cancel.json


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": { "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }, { "type": "email_delivered", "created_at": "2014-08-21T08:55:18+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "canceled" }, "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.cancel_signature('6f6c974e-2910-11e4-b3d4-0aa7697eb40')


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": { "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }, { "type": "email_delivered", "created_at": "2014-08-21T08:55:18+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "canceled" }, "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.cancel_signature('6f6c974e-2910-11e4-b3d4-0aa7697eb40')


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": { "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }, { "type": "email_delivered", "created_at": "2014-08-21T08:55:18+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "canceled" }, "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->cancelSignature('6f6c974e-2910-11e4-b3d4-0aa7697eb40');


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": { "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }, { "type": "email_delivered", "created_at": "2014-08-21T08:55:18+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "canceled" }, "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.cancelSignature('6f6c974e-2910-11e4-b3d4-0aa7697eb409');


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": { "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }, { "type": "email_delivered", "created_at": "2014-08-21T08:55:18+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "canceled" }, "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)

client.cancelSignature("6f6c974e-2910-11e4-b3d4-0aa7697eb409")


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": { "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }, { "type": "email_delivered", "created_at": "2014-08-21T08:55:18+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "canceled" }, "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

Client client = new Client("YOUR_ACCESS_TOKEN");

client.cancelSignature("6f6c974e-2910-11e4-b3d4-0aa7697eb409");


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": { "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }, { "type": "email_delivered", "created_at": "2014-08-21T08:55:18+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "canceled" }, "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.cancelSignature("6f6c974e-2910-11e4-b3d4-0aa7697eb409");


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "documents": { "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }, { "type": "email_delivered", "created_at": "2014-08-21T08:55:18+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "canceled" }, "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

DELETE /v3/signatures/{signatureId}

Description

Delete a signature request. In progress requests cannot be deleted.

Example request

$ curl

-X DELETE

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/signatures/6f6c974e-2910-11e4-b3d4-0aa7697eb409

GET /v3/signatures/{id}/documents/{id}/download/signed

Description

Download the signed PDF file.

Response

The PDF file binary content.

Example request

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/signatures/6f6c974e-2910-11e4-b3d4-0aa7697eb409/documents/29109781-f42d-11e4-b3d4-0aa7697eb409/download/signed

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.download_signed_document('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409')

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.download_signed_document('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409')

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->downloadSignedDocument('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409');

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.downloadSignedDocument('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409');

let destination = Alamofire.Request.suggestedDownloadDestination(directory: .DocumentDirectory, domain: .UserDomainMask)

let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)

client.downloadSignedDocument("6f6c974e-2910-11e4-b3d4-0aa7697eb409", document"id": "29109781-f42d-11e4-b3d4-0aa7697eb409", path: destination)

Client client = new Client("YOUR_ACCESS_TOKEN");

client.downloadSignedDocument("6f6c974e-2910-11e4-b3d4-0aa7697eb409", "29109781-f42d-11e4-b3d4-0aa7697eb409");

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.downloadSignedDocument("6f6c974e-2910-11e4-b3d4-0aa7697eb409", "29109781-f42d-11e4-b3d4-0aa7697eb409");

POST /v3/signatures/{id}/documents/{id}/signer

Description

Changes the email of the signer. It creates a new document and replaces the wrong one. Only requests with an error in email delivery can be changed.

Parameters
email
Signer's email
name
Signer's name. If none provided, previous name will be used. OPTIONAL
Response

The ID of the new document.

Example request

$ curl

-X POST

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/signatures/6f6c974e-2910-11e4-b3d4-0aa7697eb409/documents/29109781-f42d-11e4-b3d4-0aa7697eb409/signer


{"id":"b34cf7f7-df65-4133-abc5-7897ffa6b4ef"}

GET /v3/signatures/{id}/generate/audit_trail

Description

Generates the binary content of the audit trail PDF.

Response

Empty response.

Example request

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/signatures/6f6c974e-2910-11e4-b3d4-0aa7697eb409/generate/audit_trail

POST /v3/signatures/{id}/name

Description

Changes the name of the signature.

Parameters
name
Signature new name
Response

The ID of the signature.

Example request

$ curl

-X POST

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/signatures/6f6c974e-2910-11e4-b3d4-0aa7697eb409/name


{"id":"6f6c974e-2910-11e4-b3d4-0aa7697eb409"}

GET /v3/signatures/{id}/documents/{id}/download/audit_trail

Description

Download the binary content of the audit trail PDF.

Response

PDF file.

Example request

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/signatures/6f6c974e-2910-11e4-b3d4-0aa7697eb409/documents/29109781-f42d-11e4-b3d4-0aa7697eb409/download/audit_trail

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.download_audit_trail('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409')

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.download_audit_trail('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409')

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->downloadAuditTrail('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409');

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.downloadAuditTrail('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409');

let destination = Alamofire.Request.suggestedDownloadDestination(directory: .DocumentDirectory, domain: .UserDomainMask)

let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)

client.downloadAuditTrail("6f6c974e-2910-11e4-b3d4-0aa7697eb409", document"id": "29109781-f42d-11e4-b3d4-0aa7697eb409", path: destination)

Client client = new Client("YOUR_ACCESS_TOKEN");

client.downloadAuditTrail("6f6c974e-2910-11e4-b3d4-0aa7697eb409", "29109781-f42d-11e4-b3d4-0aa7697eb409");

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.downloadAuditTrail("6f6c974e-2910-11e4-b3d4-0aa7697eb409", "29109781-f42d-11e4-b3d4-0aa7697eb409");

GET /v3/signatures/{id}/documents/{id}/download/attachments

Description

Download a zip with all files separated in folders.

Response

ZIP file.

Example request

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/signatures/6f6c974e-2910-11e4-b3d4-0aa7697eb409/documents/29109781-f42d-11e4-b3d4-0aa7697eb409/download/attachments

Events URL

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

Example received request.
{ "created_at": "2015-02-25T13:38:33+0000", "document": { "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-10-30T09:58:01+0000" }, { "type": "email_delivered", "created_at": "2014-10-30T09:58:03+0000" }, { "type": "email_opened", "created_at": "2014-10-30T09:58:15+0000" }, { "type": "reminder_email_processed", "created_at": "2014-10-30T11:33:46+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }, "type": "reminder_email_processed" }

The list of events that you will receive is:

email_processed
The email has been processed
email_delivered
The email has been delivered
email_opened
The email has been opened
email_bounced
The server cannot deliver the message. Bounces often are caused by outdated or incorrectly entered email addresses.
email_deferred
The email cannot immediately be delivered, but it hasn’t been completely rejected. Sometimes called a soft bounce, it will be retried for 72 hours.
reminder_email_processed
The reminder email has been processed
reminder_email_delivered
The reminder email has been delivered
reminder_email_opened
The reminder email has been opened
sms_processed
The SMS has been processed.
sms_delivered
The SMS has been delivered.
password_sms_processed
The password SMS has been processed.
password_sms_delivered
The password SMS has been delivered.
document_opened
The document has been opened.
document_signed
The document has been signed.
document_completed
The document has been completed and ready to be downloaded.
audit_trail_completed
The audit trail has been completed and ready to be downloaded.
document_declined
The document has been declined.
document_expired
The document has expired.
document_canceled
The document has been canceled.
photo_added
The signer has attached a photo in the process.
voice_added
The signer has attached an audio in the process.
file_added
The signer has attached a file in the process.
photo_id_added
The signer has attached a photo id in the process.

The media type of the events we send to your endpoints is set to application/x-www-form-urlencoded by default.

You can receive the events on other formats such as json or xml.

To do so, add the media type extension you want to get to the end of the URL where you want to receive these events: for example https://httpbin.org/post.json we will post the information in json format.

Widget validation rules

Some widgets accept built-in validation rules, in order to validate the entered data. For setting a validation rule, you must add the validation_rule option of the widget in signature creation request.

Here you can find a list of currently implemented validation rules:

email
Value must be a valid email. Only works with text widgets
phone
Value must be a valid phone number with prefix. Only works with text widgets
zip
Value must be a valid Spanish zip code. Only works with text widgets
dni
Value must be a valid Spanish document number (can be DNI or NIE). Only works with text widgets
age
Entered date should be older than 18 years. Only works with date widgets

Certified files

GET /v3/files/{id}.(json | xml)

Description

This endpoint is used to get certificated files.

Parameters
id
Id of the file to be retrieved.
Response

The file with JSON format.

Example request

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/files/3ccd2306-8b51-473e-adcf-b955b0f3a2d5.json


{ "created_at": "2023-08-03T11:27:24+0000", "id": "2e48685c-cf36-4320-8a2f-f62cd09bbfd3", "md5": "db35f1f6ec7d4aa23c8559c225f49fde", "name": "certifiedFile.pdf", "size": 485917 }

POST /v3/files.(json | xml)

Description

This endpoint is used to upload files and certificate them.

Parameters
file
File to be uploaded.
Response

The file with JSON format.

Example request

$ curl

-X POST

-F 'file=@"/certifiedFile.pdf"'

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/files.json


{ "created_at": "2023-08-03T11:27:24+0000", "id": "2e48685c-cf36-4320-8a2f-f62cd09bbfd3", "md5": "db35f1f6ec7d4aa23c8559c225f49fde", "name": "certifiedFile.pdf", "size": 485917 }
Parameters
file
File to be uploaded.
chunk
Number of the current chunk.
chunks
Number of total chunks.
upload_key
Key to identify the file being uploaded. OPTIONAL This parameter is optional on its first call, then it is mandatory in order to know which file is being upload
Response

A response with the id of the chunk and related info to complete the upload with remaining chunks with JSON format.

Example request

$ curl

-X POST

-F 'file=@"/certifiedFile.pdf"'

-F 'chunk=1'

-F 'chunks=3'

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/files.json


{ "id": "3ccd2306-8b51-473e-adcf-b955b0f3a2d5", "created_at": "Thu, 03 Aug 2023 11:31:28 +0000", "name": "certifiedFilePart1.pdf", "chunk": 1, "total_chunks": 3, "upload_key": "5fabdfc2ad3841d6cfcb191ba0c3df22", "completed": false }

Event hooks

The event hooks are the information sent about the signature process.

id
The event hook identifier.
status_code
The request status code.
url
The url given (refer to event_url).
method
The method of the request.
event_type
The event hook type. Defined in this list.
created_at
The event hook creation date.
{ "id":"LeWz6YYBdHtiVHKnGjII", "status_code":200, "url":"http://www.webprovided.com", "method":"POST", "event_type":"email_processed", "created_at":"2023-03-28T07:21:39+0000" }

GET /v3/event-hooks

Description

List event hooks from the requester.

Parameters
limit
Max number of event hooks to retrieve. The limit is 100. OPTIONAL
page
Page to be shown. Default value is 1. OPTIONAL
date
Stringified array. Example: '{"from": "2023-03-01","to": "2023-03-28"}'. OPTIONAL
status
Status of the event hook. It must be an array. OPTIONAL
method
The method which is being used through the request. It must be an array.
Examples are: POST, GET OPTIONAL
search
Response

A collection of event hooks in JSON format.

Example request

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/event-hooks?method[]=POST&limit=2&page=4&search=email_&status[]=200


{ "web_hooks": [ { "id": "LeWz6YYBdHtiVHKnGjII", "status_code": 200, "url": "http://www.webprovided.com", "method": "POST", "event_type": "email_processed", "created_at": "2023-03-16T09:14:34+0000" }, { "id": "MeWz7YYBdHtiVHKnGjII", "status_code": 200, "url": "http://www.webprovided.com", "method": "POST", "event_type": "email_opened", "created_at": "2023-03-16T10:14:54+0000" } ], "total": 2 }

GET /v3/event-hooks/{eventHookId}/retry

Description

Fires again the event hook. It can only be done by the event hook requester or the account administrator otherwise it will return a HTTP not authorized response code.

Response

An empty response.

Example request

$ curl

-X POST

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/event-hooks/6-V7J4cBdHtiVHKnd1DU/retry


{}

Template

A template is a prepared document that can be sent repeatedly.

id
The template identifier.
name
The template name.
created_at
The template creation date.
{ "created_at":"2014-04-05T20:09:48+0000", "id":"3d1bf4f8-bcfe-11e3-8d1e-0a063b2144ed", "name": "#nda" }

GET /v3/templates.(json | xml)

Description

List templates from the requester.

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 "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/templates.json


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

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.get_templates


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

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.get_templates()


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

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->getTemplates();


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

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.getTemplates();


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

let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)

client.getTemplates()


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

Client client = new Client("YOUR_ACCESS_TOKEN");

client.getTemplates();


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

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.getTemplates();


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

Certified email

A email represents a request to one or more signers with one or more documents.

created_at
The email creation date.
certificates

The certificate items that have been created with the email request. A certificate item is created for recipient.

Inside every certificate item you can find the next information:

email
The recipient's email.
events

A list of events related with the certificate.

Inside every event item you can find the next information:

created_at
The creation date.
type

The event type.

The available types are:

email_processed
Email has been processed.
email_delivered
The document is ready to be signed.
email_opened
The document has been signed.
documents_opened
The document overview has been opened.
document_opened
The document has been opened.
document_downloaded
The document has been downloaded.
certification_completed
The certification process finished
attachments

The list of attached files.

Inside every file item you can find the next information:

name
The file name.
size
The file size.
id
The certificate creation date.
name
The recipient's name.
status

The email status.

The available status are:

in_queue
The email is being processed.
sent
The email has been sent.
error
There was some error processing the email.
id
The certified email identifier.
{ "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "john@signaturit.com", "events": [{ "created_at": "2014-08-21T08:55:14+0000", "type": "email_processed" }, { "created_at": "2014-08-21T08:55:20+0000", "type": "email_delivered" }], "file": { "name": "document.pdf", "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

GET /v3/emails/count.(json | xml)

Description

Count certified emails.

Parameters
status

Filter emails with certain status. OPTIONAL

The available status are:

in_queue
The email is being processed.
sent
The email has been sent.
error
There was some error processing the email.
since
Emails returned will be the ones who are sent at this date or later. The format of this value should be YYYY-MM-DD. OPTIONAL
Response

Total of certified emails in JSON or XML format.

Example request

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/emails/count.json


{ "count": 2 }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.count_emails


{ "count": 2 }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.count_emails()


{ "count": 2 }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->countEmails();


{ "count": 2 }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.countEmails();


{ "count": 2 }

let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)

client.countEmails()


{ "count": 2 }

Client client = new Client("YOUR_ACCESS_TOKEN");

client.countEmails();


{ "count": 2 }

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.countEmails();


{ "count": 2 }

GET /v3/emails.(json | xml)

Description

Get all certified emails.

Parameters
limit
Max number of emails to retrieve. The email limit is 100. OPTIONAL
offset
Results offset. Default value is 0. OPTIONAL
status

Filter emails with certain status. OPTIONAL

The available status are:

in_queue
The email is being processed.
sent
The email has been sent.
error
There was some error processing the request.
since
emails returned will be the ones who are sent at this date or later. The format of this value should be YYYY-MM-DD. OPTIONAL
Response

A list of email requests in JSON or XML format.

Example request

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/emails.json


[{ "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "document.pdf", "pages": 11, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }, { "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "david@signaturit.com", "events": [{ "type": "processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "David", "status": "sent" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }]

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.get_emails


[{ "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "document.pdf", "pages": 11, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }, { "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "david@signaturit.com", "events": [{ "type": "processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "David", "status": "sent" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }]

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.get_emails()


[{ "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "document.pdf", "pages": 11, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }, { "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "david@signaturit.com", "events": [{ "type": "processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "David", "status": "sent" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }]

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->getEmails();


[{ "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "document.pdf", "pages": 11, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }, { "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "david@signaturit.com", "events": [{ "type": "processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "David", "status": "sent" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }]

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.getEmails();


[{ "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "document.pdf", "pages": 11, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }, { "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "david@signaturit.com", "events": [{ "type": "processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "David", "status": "sent" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }]

let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)

client.getEmails()


[{ "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "document.pdf", "pages": 11, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }, { "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "david@signaturit.com", "events": [{ "type": "processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "David", "status": "sent" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }]

Client client = new Client("YOUR_ACCESS_TOKEN");

client.getEmails();


[{ "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "document.pdf", "pages": 11, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }, { "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "david@signaturit.com", "events": [{ "type": "processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "David", "status": "sent" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }]

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.getEmails();


[{ "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "document.pdf", "pages": 11, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }, { "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "created_at": "2014-08-21T08:53:35+0000", "email": "david@signaturit.com", "events": [{ "type": "processed", "created_at": "2014-08-21T08:55:14+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "David", "status": "sent" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }]

GET /v3/emails/{id}.(json | xml)

Description

Get a given certified email request.

Response

Single certified email request in JSON or XML format.

Example request

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/emails/6f6c974e-2910-11e4-b3d4-0aa7697eb409.json


{ "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "email": "john@signaturit.com", "events": [{ "created_at": "2014-08-21T08:55:14+0000", "type": "email_processed" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.get_email('6f6c974e-2910-11e4-b3d4-0aa7697eb409')


{ "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "email": "john@signaturit.com", "events": [{ "created_at": "2014-08-21T08:55:14+0000", "type": "email_processed" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.get_email('6f6c974e-2910-11e4-b3d4-0aa7697eb409')


{ "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "email": "john@signaturit.com", "events": [{ "created_at": "2014-08-21T08:55:14+0000", "type": "email_processed" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->getEmail('6f6c974e-2910-11e4-b3d4-0aa7697eb409');


{ "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "email": "john@signaturit.com", "events": [{ "created_at": "2014-08-21T08:55:14+0000", "type": "email_processed" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.getEmail('6f6c974e-2910-11e4-b3d4-0aa7697eb409');


{ "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "email": "john@signaturit.com", "events": [{ "created_at": "2014-08-21T08:55:14+0000", "type": "email_processed" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)

client.getEmail("6f6c974e-2910-11e4-b3d4-0aa7697eb409")


{ "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "email": "john@signaturit.com", "events": [{ "created_at": "2014-08-21T08:55:14+0000", "type": "email_processed" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

Client client = new Client("YOUR_ACCESS_TOKEN");

client.getEmail("6f6c974e-2910-11e4-b3d4-0aa7697eb409");


{ "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "email": "john@signaturit.com", "events": [{ "created_at": "2014-08-21T08:55:14+0000", "type": "email_processed" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.getEmail("6f6c974e-2910-11e4-b3d4-0aa7697eb409");


{ "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "email": "john@signaturit.com", "events": [{ "created_at": "2014-08-21T08:55:14+0000", "type": "email_processed" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

POST /v3/emails.(json | xml)

Description

Create a new email request.

Parameters
body

Email body (html code is allowed). OPTIONAL

branding_id
Use a custom branding for the email request. OPTIONAL
events_url

URL that receive realtime information about this email process. OPTIONAL

See the emails event url section for more information.

attachments
List of attached files.
recipients

List with email recipients containing name, email and extra requirements for the email process if needed.

Every item can contain the next information:

email
The recipient email address.
name
The recipient name.

Also, you can use the next format to specify to, cc and bcc:

to

Email recipients.

email
The recipient email address.
name
The recipient name.
cc

Email cc. Format is the same as recipients.

email
The cc email address.
name
The cc name.
bcc

Email bcc. Format is the same as recipients.

email
The bcc email address.
name
The bcc name.
type

List with email recipients containing name, email and extra requirements for the email process if needed.

The available types are:

delivery
Send the email as it is certifying the delivery process.
open_document

Send a modified version of the email with a button that redirects the user to our platform to open the PDF attachments.

With this method, you can track when the user opens the attached files.

Note: This method only supports PDF documents to be attached.

open_every_document
This type works like the open_document type but allows to track the opening of every PDF file in emails with multiple attachments.
subject
Email subject for email type requests. OPTIONAL
Response

New certified email in JSON or XML format.

Example request

$ curl

-X POST

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

-F "recipients[0][name]=John"

-F "recipients[0][email]=john.doe@gmail.com"

-F "attachments[0]=@/path/to/the/pdf/document.pdf"

https://api.sandbox.signaturit.com/v3/emails.json


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "certificates": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [], "file": { "name": "document.pdf", "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.create_email_request('/path/to/the/pdf/document.pdf', { :name => 'John', :email => 'john.doe@gmail.com' })


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "certificates": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [], "file": { "name": "document.pdf", "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.create_email_request('/path/to/the/pdf/document.pdf', { 'name': 'John', 'email': 'john.doe@gmail.com' })


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "certificates": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [], "file": { "name": "document.pdf", "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->createEmail('/path/to/the/pdf/document.pdf', [ 'name' => 'John', 'email' => 'john.doe@gmail.com' ]);


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "certificates": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [], "file": { "name": "document.pdf", "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.createEmail('/path/to/the/pdf/document.pdf', { name: 'John', email: 'john.doe@gmail.com' } );


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "certificates": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [], "file": { "name": "document.pdf", "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

let pdf = NSBundle.mainBundle().URLForResource("document", withExtension: "pdf")

let recipient = [["email": "john.doe@gmail.com", "fullname": "John"]]

let params = []

let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)

client.createEmail([pdf], recipients: recipient, subject: "", body: "", params: params, successHandler: { response in

})


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "certificates": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [], "file": { "name": "document.pdf", "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

Client client = new Client("YOUR_ACCESS_TOKEN", false);

ArrayList<File> files = new ArrayList<File>();

File file1 = new File("/path/to/the/pdf/document1.pdf");

files.add(file1);

File file2 = new File("/path/to/the/pdf/document2.pdf");

files.add(file2);

ArrayList<HashMap<String, Object>> recipients = new ArrayList<HashMap<String, Object>>();

HashMap<String, Object> recipient1 = new HashMap<String, Object>();

recipient1.put("name","Alice");

recipient1.put("email","alice@signaturit.com");

ArrayList<HashMap<String, Object>> cc = new ArrayList<HashMap<String, Object>>();

HashMap<String, Object> cc1 = new HashMap<String, Object>();

cc1.put("name","Bob");

cc1.put("email","bob@signaturit.com");

cc.add(cc1);

recipient1.put("cc", cc);

recipients.add(recipient1);

client.createEmail(files, recipients);


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "certificates": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [], "file": { "name": "document.pdf", "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

var recipients = new [] {

new { name = "John" , email = "john.doe@gmail.com"}

};

var files = new [] {

"/path/to/the/pdf/document.pdf"

};

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.createEmail(files, recipients);


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "certificates": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [], "file": { "name": "document.pdf", "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

GET /v3/emails/{id}/certificates/{id}/download/audit_trail

Description

Download the binary content of the audit trail PDF.

Response

PDF file.

Example request

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/emails/6f6c974e-2910-11e4-b3d4-0aa7697eb409/certificates/29109781-f42d-11e4-b3d4-0aa7697eb409/download/audit_trail

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.download_email_audit_trail('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409')

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.download_email_audit_trail('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409')

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->downloadEmailAuditTrail('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409');

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.downloadEmailAuditTrail('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409');

let destination = Alamofire.Request.suggestedDownloadDestination(directory: .DocumentDirectory, domain: .UserDomainMask)

let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)

client.downloadAuditTrail("6f6c974e-2910-11e4-b3d4-0aa7697eb409", document"id": "29109781-f42d-11e4-b3d4-0aa7697eb409", path: destination)

Client client = new Client("YOUR_ACCESS_TOKEN");

client.downloadEmailAuditTrail("6f6c974e-2910-11e4-b3d4-0aa7697eb409", "29109781-f42d-11e4-b3d4-0aa7697eb409");

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.downloadAuditTrail("6f6c974e-2910-11e4-b3d4-0aa7697eb409", "29109781-f42d-11e4-b3d4-0aa7697eb409");

Events URL

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

Example received request.
{ "created_at": "2015-02-25T13:38:33+0000", "certificate": { "created_at": "2014-08-21T08:53:35+0000", "email": "john.doe@gmail.com", "events": [{ "type": "email_processed", "created_at": "2014-08-21T08:53:39+0000" }], "name": "John", "status": "sent", "file": { "name": "document.pdf", "pages": 2, "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409" }, "type": "email_processed" }

The list of events that you will receive is:

email_processed
The email has been processed.
email_delivered
The email has been delivered.
email_opened
The email has been opened.
email_bounced
The server cannot deliver the message. Bounces often are caused by outdated or incorrectly entered email addresses.
email_deferred
The email cannot immediately be delivered, but it hasn’t been completely rejected. Sometimes called a soft bounce, it will be retried for 72 hours.
documents_opened
The document overview has been opened.
document_opened
The document has been opened.
document_downloaded
The document has been downloaded.
certification_completed
The certification process finished

Certified SMS

A SMS represents a request to one or more signers with one or more documents.

created_at
The SMS creation date.
certificates

The certificate items that have been created with the SMS request. A certificate item is created for recipient.

Inside every certificate item you can find the next information:

phone
The recipient's phone.
events

A list of events related with the certificate.

Inside every event item you can find the next information:

created_at
The creation date.
type

The event type.

The available types are:

sms_processed
SMS has been processed.
sms_delivered
The SMS has been delivered to recipient's phone.
documents_opened
The document overview has been opened.
document_opened
The document has been opened.
document_downloaded
The document has been downloaded.
certification_completed
The certification process finished
status

The SMS status.

The available status are:

in_queue
The SMS is being processed.
sent
The SMS has been sent.
error
There was some error processing the SMS.
id
The certified SMS identifier.
{ "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "created_at": "2014-08-21T08:53:35+0000", "phone": "34123445566", "events": [{ "created_at": "2014-08-21T08:55:14+0000", "type": "sms_processed" }, { "created_at": "2014-08-21T08:55:20+0000", "type": "sms_delivered" }], "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

GET /v3/sms/count.(json | xml)

Description

Count certified SMS.

Parameters
status

Filter SMS with certain status. OPTIONAL

The available status are:

in_queue
The SMS is being processed.
sent
The SMS has been sent.
error
There was some error processing the SMS.
since
SMS returned will be the ones who are sent at this date or later. The format of this value should be YYYY-MM-DD. OPTIONAL
Response

Total of certified SMS in JSON or XML format.

Example request

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/sms/count.json


{ "count": 2 }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.count_emails


{ "count": 2 }

Client client = new Client("YOUR_ACCESS_TOKEN", false);

client.countSMS();


{ "count": 2 }

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN");

client.countEmails();


{ "count": 2 }

GET /v3/sms.(json | xml)

Description

Get all certified SMS.

Parameters
limit
Max number of SMS to retrieve. The SMS limit is 100. OPTIONAL
offset
Results offset. Default value is 0. OPTIONAL
status

Filter SMS with certain status. OPTIONAL

The available status are:

in_queue
The SMS is being processed.
sent
The SMS has been sent.
error
There was some error processing the request.
since
SMS returned will be the ones who are sent at this date or later. The format of this value should be YYYY-MM-DD. OPTIONAL
Response

A list of SMS requests in JSON or XML format.

Example request

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/sms.json


[ { "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "phone": "34123445566", "events": [{ "type": "sms_processed", "created_at": "2014-08-21T08:55:14+0000" }], "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }, { "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "created_at": "2014-08-21T08:53:35+0000", "phone": "34123778899", "events": [{ "type": "sms_processed", "created_at": "2014-08-21T08:55:14+0000" }], "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "David", "status": "sent" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }]

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.get_sms


[ { "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "phone": "34123445566", "events": [{ "type": "sms_processed", "created_at": "2014-08-21T08:55:14+0000" }], "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }, { "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "created_at": "2014-08-21T08:53:35+0000", "phone": "34123778899", "events": [{ "type": "sms_processed", "created_at": "2014-08-21T08:55:14+0000" }], "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "David", "status": "sent" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }]

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.get_sms()


[ { "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "phone": "34123445566", "events": [{ "type": "sms_processed", "created_at": "2014-08-21T08:55:14+0000" }], "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }, { "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "created_at": "2014-08-21T08:53:35+0000", "phone": "34123778899", "events": [{ "type": "sms_processed", "created_at": "2014-08-21T08:55:14+0000" }], "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "David", "status": "sent" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }]

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->getSms();


[ { "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "phone": "34123445566", "events": [{ "type": "sms_processed", "created_at": "2014-08-21T08:55:14+0000" }], "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }, { "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "created_at": "2014-08-21T08:53:35+0000", "phone": "34123778899", "events": [{ "type": "sms_processed", "created_at": "2014-08-21T08:55:14+0000" }], "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "David", "status": "sent" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }]

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.getSms();


[ { "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "phone": "34123445566", "events": [{ "type": "sms_processed", "created_at": "2014-08-21T08:55:14+0000" }], "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }, { "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "created_at": "2014-08-21T08:53:35+0000", "phone": "34123778899", "events": [{ "type": "sms_processed", "created_at": "2014-08-21T08:55:14+0000" }], "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "David", "status": "sent" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }]

Client client = new Client("YOUR_ACCESS_TOKEN");

client.getSMS();


[ { "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "phone": "34123445566", "events": [{ "type": "sms_processed", "created_at": "2014-08-21T08:55:14+0000" }], "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }, { "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "created_at": "2014-08-21T08:53:35+0000", "phone": "34123778899", "events": [{ "type": "sms_processed", "created_at": "2014-08-21T08:55:14+0000" }], "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "David", "status": "sent" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }]

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN");

client.getSms();


[ { "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "phone": "34123445566", "events": [{ "type": "sms_processed", "created_at": "2014-08-21T08:55:14+0000" }], "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }, { "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "created_at": "2014-08-21T08:53:35+0000", "phone": "34123778899", "events": [{ "type": "sms_processed", "created_at": "2014-08-21T08:55:14+0000" }], "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "David", "status": "sent" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }]

GET /v3/sms/{id}.(json | xml)

Description

Get a given certified SMS request.

Response

Single certified SMS request in JSON or XML format.

Example request

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/sms/6f6c974e-2910-11e4-b3d4-0aa7697eb409.json


{ "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "phone": "34123445566", "events": [{ "created_at": "2014-08-21T08:55:14+0000", "type": "sms_processed" }], "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.get_single_sms('6f6c974e-2910-11e4-b3d4-0aa7697eb409')


{ "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "phone": "34123445566", "events": [{ "created_at": "2014-08-21T08:55:14+0000", "type": "sms_processed" }], "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.get_single_sms('6f6c974e-2910-11e4-b3d4-0aa7697eb409')


{ "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "phone": "34123445566", "events": [{ "created_at": "2014-08-21T08:55:14+0000", "type": "sms_processed" }], "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->getSingleSms('6f6c974e-2910-11e4-b3d4-0aa7697eb409');


{ "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "phone": "34123445566", "events": [{ "created_at": "2014-08-21T08:55:14+0000", "type": "sms_processed" }], "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.getSingleSms('6f6c974e-2910-11e4-b3d4-0aa7697eb409');


{ "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "phone": "34123445566", "events": [{ "created_at": "2014-08-21T08:55:14+0000", "type": "sms_processed" }], "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

Client client = new Client("YOUR_ACCESS_TOKEN");

client.getSingleSMS("6f6c974e-2910-11e4-b3d4-0aa7697eb409");


{ "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "phone": "34123445566", "events": [{ "created_at": "2014-08-21T08:55:14+0000", "type": "sms_processed" }], "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN");

client.getSingleSMS("6f6c974e-2910-11e4-b3d4-0aa7697eb409");


{ "created_at": "2014-08-21T08:53:35+0000", "certificates": [{ "phone": "34123445566", "events": [{ "created_at": "2014-08-21T08:55:14+0000", "type": "sms_processed" }], "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }], "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409" }

POST /v3/sms.(json | xml)

Description

Create a new SMS request.

Parameters
body

SMS body. The number of characters cannot be more than 120.

branding_id
Use a custom branding for the SMS request. OPTIONAL
events_url

URL that receive realtime information about this SMS process. OPTIONAL

See the sms event url section for more information.

attachments
List of attached files. Only works with open_document and open_every_document type.
recipients

List with SMS recipients containing name and phone number.

Every item can contain the next information:

phone
The recipient phone number. Must start with country prefix.
name
The recipient name.
type

The available types are:

delivery
Send the SMS as it is certifying the delivery process.
open_document

Send a modified version of the SMS with an url that redirects the user to our platform to open the PDF attachments.

With this method, you can track when the user opens the attached files.

Note: This method only supports PDF documents to be attached.

open_every_document
This type works like the open_document type but allows to track the opening of every PDF file in emails with multiple attachments.
Response

New certified SMS in JSON or XML format.

Example request

$ curl

-X POST

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

-F "recipients[0][name]=John"

-F "recipients[0][phone]=34123445566"

-F "attachments[0]=@/path/to/the/pdf/document.pdf"

-F "type=open_document"

https://api.sandbox.signaturit.com/v3/sms.json


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "certificates": { "created_at": "2014-08-21T08:53:35+0000", "phone": "34123445566", "events": [], "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.create_sms('path/to/the/pdf/document.pdf', { :phone => '34123445566', :name => 'John' }, '', { :type => 'open_document' })


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "certificates": { "created_at": "2014-08-21T08:53:35+0000", "phone": "34123445566", "events": [], "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.create_sms(['path/to/the/pdf/document.pdf'], {'phone':'34123445566', 'name': 'John'}, '', {'type':'open_document'})


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "certificates": { "created_at": "2014-08-21T08:53:35+0000", "phone": "34123445566", "events": [], "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->createSms(['path/to/the/pdf/document.pdf'], ['phone' => '34123445566', 'name' => 'John'], '', ['type' => 'open_document']);


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "certificates": { "created_at": "2014-08-21T08:53:35+0000", "phone": "34123445566", "events": [], "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.createSms(['path/to/the/pdf/document.pdf'], {'phone':'34123445566', 'name': 'John'}, '', {'type':'open_document'});


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "certificates": { "created_at": "2014-08-21T08:53:35+0000", "phone": "34123445566", "events": [], "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

Client client = new Client("YOUR_ACCESS_TOKEN", false);

ArrayList<File> filePath = new ArrayList<File>();

File temp = new File("/path/to/the/pdf/document.pdf");

filePath.add(temp);

ArrayList<HashMap<String, Object>> recipients = new ArrayList<HashMap<String,Object>>();

HashMap<String, Object> recipient= new HashMap<String, Object>();

recipient.put("phone", "34123445566");

recipient.put("fullname", "John");

recipients.add(recipient);

HashMap<String, Object> parameters = new HashMap<String, Object>();

parameters.put("type", "open_document");

Response response = client.createSms(filePath, recipients, "See it here {{url}}", parameters);


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "certificates": { "created_at": "2014-08-21T08:53:35+0000", "phone": "34123445566", "events": [], "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

var recipients = new [] {

new { name = "John" , phone = "34123445566"}

};

var files = new [] {

"/path/to/the/pdf/document.pdf"

};

var parameters = new { type = "open_document" };

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.createSMS(files, recipients, '', parameters);


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "certificates": { "created_at": "2014-08-21T08:53:35+0000", "phone": "34123445566", "events": [], "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

GET /v3/sms/{id}/certificates/{id}/download/audit_trail

Description

Download the binary content of the audit trail PDF.

Response

PDF file.

Example request

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/sms/6f6c974e-2910-11e4-b3d4-0aa7697eb409/certificates/29109781-f42d-11e4-b3d4-0aa7697eb409/download/audit_trail

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.download_sms_audit_trail('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409')


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "certificates": { "created_at": "2014-08-21T08:53:35+0000", "phone": "34123445566", "events": [], "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.download_sms_audit_trail('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409')


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "certificates": { "created_at": "2014-08-21T08:53:35+0000", "phone": "34123445566", "events": [], "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->downloadSmsAuditTrail('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409');


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "certificates": { "created_at": "2014-08-21T08:53:35+0000", "phone": "34123445566", "events": [], "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.downloadSmsAuditTrail('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409');


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "certificates": { "created_at": "2014-08-21T08:53:35+0000", "phone": "34123445566", "events": [], "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

Client client = new Client("YOUR_ACCESS_TOKEN");

client.downloadSmsAuditTrail("6f6c974e-2910-11e4-b3d4-0aa7697eb409", "29109781-f42d-11e4-b3d4-0aa7697eb409");


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "certificates": { "created_at": "2014-08-21T08:53:35+0000", "phone": "34123445566", "events": [], "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.downloadSmsAuditTrail("6f6c974e-2910-11e4-b3d4-0aa7697eb409", "29109781-f42d-11e4-b3d4-0aa7697eb409");


{ "created_at": "2014-08-21T08:53:35+0000", "data": [], "certificates": { "created_at": "2014-08-21T08:53:35+0000", "phone": "34123445566", "events": [], "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "sent" }, "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409" }

Events URL

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

Example received request.
{ "created_at": "2015-02-25T13:38:33+0000", "certificate": { "created_at": "2014-08-21T08:53:35+0000", "phone": "34123445566", "events": [{ "type": "sms_processed", "created_at": "2014-08-21T08:53:39+0000" }], "name": "John", "status": "sent", "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409" }, "type": "sms_processed" }

The list of events that you will receive is:

sms_processed
The sms has been processed.
sms_delivered
The sms has been delivered.
documents_opened
The document overview has been opened.
document_opened
The document has been opened.
document_downloaded
The document has been downloaded.
certification_completed
The certification process finished

Branding

A branding represents the full customization of signaturit's app.

application_texts

List with all the customizable texts for application widgets.

The available texts are:

send_button
Send button text.
terms_and_conditions
Text that follow our terms text (html code is allowed).
created_at
The branding creation date.
id
The branding identifier.
layout_color
Primary element color.
logo
The logo sent in emails.
signature_color
The color that will be used in the signature draw (only black and blue colors are allowed). OPTIONAL
templates

The template content for the emails sent to the user. See Custom templates section for more information.

text_color
Primary text color.
{ "application_texts": { "send_button": "Sign", "terms_and_conditions": "I will accept all this terms for testing purposes." }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#FAAC58", "templates": [], "text_color": "#B43104" }

GET /v3/brandings.(json | xml)

Description

Get all brandings from your account.

Response

Branding list in JSON or XML format.

Example request

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/brandings.json


[{ "application_texts": { "multi_page": "The pages that you need to sign in this test request are:", "photo": "We need a photo to fulfill this test request", "send_button": "Send!", "sign_button": "Sign!", "terms_and_conditions": "I will accept all this terms for testing purposes.", "voice": "We need a voice record to fulfill this test request" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }, { "application_texts": [], "created_at": "2014-08-20T13:57:51+0000", "id": "eec5e47a-2871-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }]

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.get_brandings


[{ "application_texts": { "multi_page": "The pages that you need to sign in this test request are:", "photo": "We need a photo to fulfill this test request", "send_button": "Send!", "sign_button": "Sign!", "terms_and_conditions": "I will accept all this terms for testing purposes.", "voice": "We need a voice record to fulfill this test request" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }, { "application_texts": [], "created_at": "2014-08-20T13:57:51+0000", "id": "eec5e47a-2871-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }]

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.get_brandings()


[{ "application_texts": { "multi_page": "The pages that you need to sign in this test request are:", "photo": "We need a photo to fulfill this test request", "send_button": "Send!", "sign_button": "Sign!", "terms_and_conditions": "I will accept all this terms for testing purposes.", "voice": "We need a voice record to fulfill this test request" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }, { "application_texts": [], "created_at": "2014-08-20T13:57:51+0000", "id": "eec5e47a-2871-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }]

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->getBrandings();


[{ "application_texts": { "multi_page": "The pages that you need to sign in this test request are:", "photo": "We need a photo to fulfill this test request", "send_button": "Send!", "sign_button": "Sign!", "terms_and_conditions": "I will accept all this terms for testing purposes.", "voice": "We need a voice record to fulfill this test request" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }, { "application_texts": [], "created_at": "2014-08-20T13:57:51+0000", "id": "eec5e47a-2871-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }]

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.getBrandings();

[{ "application_texts": { "multi_page": "The pages that you need to sign in this test request are:", "photo": "We need a photo to fulfill this test request", "send_button": "Send!", "sign_button": "Sign!", "terms_and_conditions": "I will accept all this terms for testing purposes.", "voice": "We need a voice record to fulfill this test request" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }, { "application_texts": [], "created_at": "2014-08-20T13:57:51+0000", "id": "eec5e47a-2871-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }]

let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)

client.getBrandings()

[{ "application_texts": { "multi_page": "The pages that you need to sign in this test request are:", "photo": "We need a photo to fulfill this test request", "send_button": "Send!", "sign_button": "Sign!", "terms_and_conditions": "I will accept all this terms for testing purposes.", "voice": "We need a voice record to fulfill this test request" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }, { "application_texts": [], "created_at": "2014-08-20T13:57:51+0000", "id": "eec5e47a-2871-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }]

Client client = new Client("YOUR_ACCESS_TOKEN");

client.getBrandings();

[{ "application_texts": { "multi_page": "The pages that you need to sign in this test request are:", "photo": "We need a photo to fulfill this test request", "send_button": "Send!", "sign_button": "Sign!", "terms_and_conditions": "I will accept all this terms for testing purposes.", "voice": "We need a voice record to fulfill this test request" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }, { "application_texts": [], "created_at": "2014-08-20T13:57:51+0000", "id": "eec5e47a-2871-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }]

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.getBrandings();

[{ "application_texts": { "multi_page": "The pages that you need to sign in this test request are:", "photo": "We need a photo to fulfill this test request", "send_button": "Send!", "sign_button": "Sign!", "terms_and_conditions": "I will accept all this terms for testing purposes.", "voice": "We need a voice record to fulfill this test request" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }, { "application_texts": [], "created_at": "2014-08-20T13:57:51+0000", "id": "eec5e47a-2871-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }]

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

Description

Get a branding.

Response

A branding in JSON or XML format.

Example request

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/brandings/0b1db805-2cf7-11e4-b3d4-0aa7697eb409.json


{ "application_texts": { "multi_page": "The pages that you need to sign in this test request are:", "photo": "We need a photo to fulfill this test request", "send_button": "Send!", "sign_button": "Sign!", "terms_and_conditions": "I will accept all this terms for testing purposes.", "voice": "We need a voice record to fulfill this test request" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.get_branding('0b1db805-2cf7-11e4-b3d4-0aa7697eb409')


{ "application_texts": { "multi_page": "The pages that you need to sign in this test request are:", "photo": "We need a photo to fulfill this test request", "send_button": "Send!", "sign_button": "Sign!", "terms_and_conditions": "I will accept all this terms for testing purposes.", "voice": "We need a voice record to fulfill this test request" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.get_branding('0b1db805-2cf7-11e4-b3d4-0aa7697eb409')


{ "application_texts": { "multi_page": "The pages that you need to sign in this test request are:", "photo": "We need a photo to fulfill this test request", "send_button": "Send!", "sign_button": "Sign!", "terms_and_conditions": "I will accept all this terms for testing purposes.", "voice": "We need a voice record to fulfill this test request" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->getBranding('0b1db805-2cf7-11e4-b3d4-0aa7697eb409');


{ "application_texts": { "multi_page": "The pages that you need to sign in this test request are:", "photo": "We need a photo to fulfill this test request", "send_button": "Send!", "sign_button": "Sign!", "terms_and_conditions": "I will accept all this terms for testing purposes.", "voice": "We need a voice record to fulfill this test request" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.getBranding('0b1db805-2cf7-11e4-b3d4-0aa7697eb409');


{ "application_texts": { "multi_page": "The pages that you need to sign in this test request are:", "photo": "We need a photo to fulfill this test request", "send_button": "Send!", "sign_button": "Sign!", "terms_and_conditions": "I will accept all this terms for testing purposes.", "voice": "We need a voice record to fulfill this test request" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }

let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)

client.getBranding("0b1db805-2cf7-11e4-b3d4-0aa7697eb409")


{ "application_texts": { "multi_page": "The pages that you need to sign in this test request are:", "photo": "We need a photo to fulfill this test request", "send_button": "Send!", "sign_button": "Sign!", "terms_and_conditions": "I will accept all this terms for testing purposes.", "voice": "We need a voice record to fulfill this test request" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }

Client client = new Client("YOUR_ACCESS_TOKEN");

client.getBranding("0b1db805-2cf7-11e4-b3d4-0aa7697eb409");


{ "application_texts": { "multi_page": "The pages that you need to sign in this test request are:", "photo": "We need a photo to fulfill this test request", "send_button": "Send!", "sign_button": "Sign!", "terms_and_conditions": "I will accept all this terms for testing purposes.", "voice": "We need a voice record to fulfill this test request" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.getBranding("0b1db805-2cf7-11e4-b3d4-0aa7697eb409");


{ "application_texts": { "multi_page": "The pages that you need to sign in this test request are:", "photo": "We need a photo to fulfill this test request", "send_button": "Send!", "sign_button": "Sign!", "terms_and_conditions": "I will accept all this terms for testing purposes.", "voice": "We need a voice record to fulfill this test request" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }

POST /v3/brandings.(json | xml)

Description

Create a single branding.

Parameters
application_texts

List with all the customizable texts for application widgets. OPTIONAL

The available texts are:

send_button
Send button text.
open_sign_button
Customizable text for Signature e-mail sign button.
open_email_button
Customizable text for Certified e-mail sign button.
terms_and_conditions
Text that follow our terms text (html code is allowed).
layout_color
Primary element color. OPTIONAL
logo
signature_color
The color that will be used in the signature draw (only black and blue colors are allowed). OPTIONAL
templates

The template content for the emails sent to the user. See Custom templates section for more information.

sms-templates

The template content for the SMS sent to the user. See Custom templates section for more information.

text_color
Primary text color.
show_csv
Hide or show the CSV image and text that is stamped in the signed file. OPTIONAL
show_biometric_hash
Hide or show the Biometric Hash in the signed document and audit trail. OPTIONAL
show_welcome_page
Hide or show the welcome page that appears before showing the document. OPTIONAL
header_color
Sign app Custom header color. OPTIONAL
footer_color
Sign app Custom footer color. OPTIONAL
name
To name the created branding. The maximum length allowed for this field is 24 characters. OPTIONAL
Response

The new branding in JSON or XML format.

Example request

$ curl

-X POST

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

-d "layout_color=#FAAC58"

-d "text_color=#B43104"

-d "application_texts[send_button]=Sign"

-d "show_welcome_page=1"

https://api.sandbox.signaturit.com/v3/brandings.json


{ "application_texts": { "send_button": "Sign" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#FAAC58", "templates": [], "text_color": "#B43104" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.create_branding({ :layout_color => '#FAAC58', :text_color => '#B43104', :application_texts => { "send_button": "Sign" } })


{ "application_texts": { "send_button": "Sign" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#FAAC58", "templates": [], "text_color": "#B43104" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.create_branding({ 'layout_color': '#FAAC58', 'text_color': '#B43104', 'application_texts': { "send_button": "Sign" } })


{ "application_texts": { "send_button": "Sign" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#FAAC58", "templates": [], "text_color": "#B43104" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->createBranding([ 'layout_color' => '#FAAC58', 'text_color' => '#B43104', 'application_texts' => [ "send_button" => "Sign" ] ]);


{ "application_texts": { "send_button": "Sign" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#FAAC58", "templates": [], "text_color": "#B43104" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.createBranding({ "layout_color": "#FAAC58", "text_color": "#B43104", "application_texts": { "send_button": "Sign" } });


{ "application_texts": { "send_button": "Sign" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#FAAC58", "templates": [], "text_color": "#B43104" }

let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)

client.createBranding(["layout_color": "#FAAC58", "text_color": "#B43104", "application_texts": ["send_button": "Sign"]])


{ "application_texts": { "send_button": "Sign" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#FAAC58", "templates": [], "text_color": "#B43104" }

Client client = new Client("YOUR_ACCESS_TOKEN");

HashMap<String, String> applicationText = new HashMap<String, String>();

applicationText.put("send_button", "Sign");

HashMap<String, Object> parameters = new HashMap<String, Object>();

parameters.put("layout_color", "#FAAC58");

parameters.put("text_color", "#B43104");

parameters.put("application_texts", applicationText);

client.createBranding(parameters);


{ "application_texts": { "send_button": "Sign" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#FAAC58", "templates": [], "text_color": "#B43104" }

var params = new { layout_color = "#FAAC58", text_color = "#B43104", application_texts = new { send_button = "Sign" } };

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.createBranding(params);


{ "application_texts": { "send_button": "Sign" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#FAAC58", "templates": [], "text_color": "#B43104" }

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

Description

Update a single branding.

Parameters

Same parameters as CREATE BRANDING method.

Response

The updated branding in JSON or XML format.

Example request

$ curl

-X PATCH

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

-d "application_texts[send_button]=Sign again!"

https://api.sandbox.signaturit.com/v3/brandings/3eed17f5-2d08-11e4-b3d4-0aa7697eb409.json


{ "application_texts": { "send_button": "Sign again!" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#FAAC58", "templates": [], "text_color": "#B43104" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.update_branding('3eed17f5-2d08-11e4-b3d4-0aa7697eb409', { :application_texts => { :send_button => 'Sign again!' } })


{ "application_texts": { "send_button": "Sign again!" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#FAAC58", "templates": [], "text_color": "#B43104" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.update_branding('3eed17f5-2d08-11e4-b3d4-0aa7697eb409', { 'application_texts': { 'send_button': 'Sign again!' } })


{ "application_texts": { "send_button": "Sign again!" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#FAAC58", "templates": [], "text_color": "#B43104" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->updateBranding( '3eed17f5-2d08-11e4-b3d4-0aa7697eb409', [ 'application_texts' => [ 'send_button' => 'Sign again!' ] ] );


{ "application_texts": { "send_button": "Sign again!" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#FAAC58", "templates": [], "text_color": "#B43104" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.updateBranding('3eed17f5-2d08-11e4-b3d4-0aa7697eb409', { application_texts: { send_button: 'Sign again!' } });


{ "application_texts": { "send_button": "Sign again!" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#FAAC58", "templates": [], "text_color": "#B43104" }

let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)

client.updateBranding("3eed17f5-2d08-11e4-b3d4-0aa7697eb409", params: ["application_texts": ["send_button": "Sign again!"]])


{ "application_texts": { "send_button": "Sign again!" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#FAAC58", "templates": [], "text_color": "#B43104" }

Client client = new Client("YOUR_ACCESS_TOKEN");

HashMap<String, String> applicationText = new HashMap<String, String>();

applicationText.put("send_button", "Sign again!");

HashMap<String, Object> parameters = new HashMap<String, Object>();

parameters.put("layout_color", "#FAAC58");

parameters.put("text_color", "#B43104");

parameters.put("application_texts", applicationText);

client.updateBranding("3eed17f5-2d08-11e4-b3d4-0aa7697eb409", parameters);


{ "application_texts": { "send_button": "Sign again!" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#FAAC58", "templates": [], "text_color": "#B43104" }

var params = new { application_texts = new { send_button = "Sign again!" } };

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.updateBranding("3eed17f5-2d08-11e4-b3d4-0aa7697eb409", params);


{ "application_texts": { "send_button": "Sign again!" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#FAAC58", "templates": [], "text_color": "#B43104" }

Create custom templates

You can customize the templates for emails and SMS that are sent to the user. Every template should be linked to a branding, so every request using this branding will use that template instead of Signaturit one.

Templates
signatures_request

This template is the one the user receives when you send him a document to sign.

Note: In this template, sign_button magic word is required.

signatures_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.

Note: In this template, sign_button magic word is required.

document_canceled

This template is the one the user receives when requester cancels the signature.

emails_request

This template is the one the user receives when you send him a document through certified emails.

Note: In this template, email_button magic word is required.

validation_request

This template is the one the user receives when you send him a document to validate (as a validator).

Note: In this template, validate_button magic word is required.

signed_document

This template is the one the requester receives once a signature request is finished.

document_declined

This template is the one the requester receives when signer declines a signature request.

request_expired_requester

This template is the one the requester receives when a signature expires.

SMS templates
sms_verify

This template is the one the user receives when an SMS code is sent as a password to open a document.

Note: In this template, code magic word is required.

sms_validate

This template is the one the user receives when an SMS code is sent to validate the signing of a document.

Note: In this template, code magic word is required.


The submitted file must be a HTML template. You can write some magic words on the content, to use custom information from our side. The following words can be used.

Magic words
{{sender_email}}
Tag replace by the sender email.
{{sign_button}}

Tag replaced by the signaturit button.

Note: This tag only can be used in signatures_request and pending_sign templates.

{{validate_button}}

Tag replaced by the validate document button.

Note: This tag only can be used in validation_request template.

{{signer_name}}
This tag is replaced by the signer name.
{{signer_email}}
This tag is replaced by the signer email.
{{filename}}
This tag is replaced by the file name (or names).
{{logo}}
This tag is replaced by the current logo.
{{remaining_time}}

Show the expiry date for a document.

Note: This tag can only be used in pending_sign template.

Note: Do not use this magic word, if you plan that your requests will not expire.

{{email_button}}

Tag replaced by the signaturit button.

Note: This tag only can be used in emails_request template.

{{email_body}}

Tag replaced by the body parameter text.

Note: This tag only can be used in signatures_request template.

{{code}}

Tag replaced by the sms code.

Note: This tag only can be used in sms_verify and sms_validate templates.

{{reason}}

Tag replaced by reason why a signature is declined by signer

Note: This tag only can be used in document_declined template.

{{dashboard_button}}

Tag replaced by button to see the signature detail on dashboard

Note: This tag only can be used in document_declined template.

{{signers}}

Tag replaced by the signer (or signers) name and email in format NAME - EMAIL

Note: This tag only can be used in signed_document template.


Finally, if you want to set a subject for your templates, you must add it on your html file, using html tag title. Email subject will be the text set between this tags.

Example request creating a branding with a template

$ curl

-X POST

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

-d "templates[signatures_request]=<html><body><div>Sign the document</div><div>{{sign_button}}</div></body></html>"

https://api.sandbox.signaturit.com/v3/brandings.json


{ "application_texts": [], "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.create_branding({ :templates => { :signatures_request => '<html><body><div>Sign the document</div><div>{{sign_button}}</div></body></html>' } })


{ "application_texts": [], "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.create_branding({ 'templates': { 'signatures_request': '<html><body><div>Sign the document</div><div>{{sign_button}}</div></body></html>' } })


{ "application_texts": [], "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->createBranding([ 'templates' => [ 'signatures_request' => '<html><body><div>Sign the document</div><div>{{sign_button}}</div></body></html>' ] ] );


{ "application_texts": [], "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.createBranding({ templates: { signatures_request: '<html><body><div>Sign the document</div><div>{{sign_button}}</div></body></html>' } });


{ "application_texts": [], "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409" }

let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)

client.createBranding(["templates": ["signatures_request": "<html><body><div>Sign the document</div><div>{{sign_button}}</div></body></html>"]])


{ "application_texts": [], "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409" }

Client client = new Client("YOUR_ACCESS_TOKEN");

HashMap<String, String> templates = new HashMap<String, String>();

templates.put("signatures_request", "<html><body><div>Sign the document</div><div>{{sign_button}}</div></body></html>");

HashMap<String, Object> parameters = new HashMap<String, Object>();

parameters.put("templates", templates);

client.createBranding(parameters);


{ "application_texts": [], "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409" }

var params = new { templates = new { signatures_request = "<html><body><div>Sign the document</div><div>{{sign_button}}</div></body></html>" } };

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.createBranding(params);


{ "application_texts": [], "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409" }

Photo ID validation

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

Description

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

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)
document_type

Type of the document. Defaults to ID.

Available document types are:

ID
ID Card
DL
Driver license
RP
Residence permit
PA
Passport
document_country
Country code of the document in ISO 3166-1 alpha-3 format. Defaults to ESP
Response

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

Example request

$ curl

-X POST

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

-F "front=@/path/to/the/front.jpg"

-F "back=@/path/to/the/back.jpg"

-F "document_type=PA"

-F "document_country=FRA"

https://api.sandbox.signaturit.com/v3/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" } }

Package

A package consists on a set of signatures/emails/sms sent on a bulk request.

id
Package identifier.
type
Package type, signature/email/sms depending of the request made.
created_at
Package creation date.
sent_at
Package sent date.
signatures
Package signatures info (based on package type).
emails
Package emails info (based on package type).
sms
Package SMS info (based on package type).
{ "created_at":"2016-09-15T14:58:14+0000", "id":"8B1D4385-E21E-48C2-94C9-651B3CF73815", "sent_at":"2016-09-15T14:58:39+0000", "signatures":{ "F8B947BB-5F37-4D03-B4A1-917B5E21A462":[ { "id":"0E21B38F-8E27-43C4-B4F8-EEFAAA776C7D", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" }, { "id":"97933277-D0A3-4A8A-A9AB-FFA3AD5AE0CA", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" } ] }, "type":"signature" }

GET /v3/packages.(json | xml)

Description

List packages from the requester.

Parameters
limit
Max number of packages to retrieve. Package limit is 100. OPTIONAL
offset
Results offset. Default value is 0. OPTIONAL
since
Packages returned will be the ones who are sent at this date or later. The format of this value should be YYYY-MM-DD. OPTIONAL
Response

A collection of packages in JSON or XML format.

Example request

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/packages.json


[ { "created_at":"2016-09-15T14:58:14+0000", "id":"8B1D4385-E21E-48C2-94C9-651B3CF73815", "sent_at":"2016-09-15T14:58:39+0000", "signatures":{ "F8B947BB-5F37-4D03-B4A1-917B5E21A462":[ { "id":"0E21B38F-8E27-43C4-B4F8-EEFAAA776C7D", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" }, { "id":"97933277-D0A3-4A8A-A9AB-FFA3AD5AE0CA", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" } ] }, "type":"signature" }]

GET /v3/packages/{packageId}.(json | xml)

Description

Get a single package from the requester.

Response

A package in JSON or XML format.

Example request

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/packages/8B1D4385-E21E-48C2-94C9-651B3CF73815.json


{ "created_at":"2016-09-15T14:58:14+0000", "id":"8B1D4385-E21E-48C2-94C9-651B3CF73815", "sent_at":"2016-09-15T14:58:39+0000", "signatures":{ "F8B947BB-5F37-4D03-B4A1-917B5E21A462":[ { "id":"0E21B38F-8E27-43C4-B4F8-EEFAAA776C7D", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" }, { "id":"97933277-D0A3-4A8A-A9AB-FFA3AD5AE0CA", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" } ] }, "type":"signature" }

POST /v3/packages/signatures.(json | xml)

Description

Perform a signature bulk request.

Parameters

You can use the same parameters used on create signature method to adjust your request. The only difference is that a sheet file must be included with all the recipient info.

sheet
A sheet file in xlsx/csv format. This file will contain all the info about signers.
have_header
Whether sheet's first row is the header or not. Header will not be used as signer row, but header keys can be used to set custom data on your pdfs.
Response

A package in JSON or XML format.

Example request for 10 single signatures

To do a bulk signature request, the submitted sheet should be like this.

email
email1@test.com
email2@test.com
email3@test.com
email4@test.com
email5@test.com
email6@test.com
email7@test.com
email8@test.com
email9@test.com
email10@test.com

So, row with email will be the header, and for every row with an email address, a signature request will be created.

$ curl

-X POST

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

-F "sheet=@documents/sheets/recipients.xlsx"

-F "files[0]=@documents/important/nda.pdf"

-F "have_header=1"

-F "subject=Bulk request test"

-F "body=This is a test to see if 10 signatures are generated"

https://api.sandbox.signaturit.com/v3/packages/signatures.json


{ "created_at":"2016-09-15T14:58:14+0000", "id":"8B1D4385-E21E-48C2-94C9-651B3CF73815", "sent_at":"2016-09-15T14:58:39+0000", "signatures":{ "F8B947BB-5F37-4D03-B4A1-917B5E21A462":[ { "id":"0E21B38F-8E27-43C4-B4F8-EEFAAA776C7D", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" } ], "F8B947BB-5F37-4D03-B4A1-917B5E21A463":[ { "id":"0E21B38F-8E27-43C4-B4F8-EEFAAA776C8D", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" } ], "F8B947BB-5F37-4D03-B4A1-917B5E21A464":[ { "id":"0E21B38F-8E27-43C4-B4F8-EEFAAA774C7D", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" } ], "F8B947BB-5F37-4D03-B4A1-917B5E21A452":[ { "id":"0E21B38F-8E27-43C4-B4F8-EEFADA7D6C7D", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" } ], "F8B947BB-5F37-4D03-B4A1-917C5E21A462":[ { "id":"0E21B38F-8E27-43C4-B4F8-EEFACA776C7D", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" } ], "F8B947BB-5F37-4D03-B4A1-917BDE21A462":[ { "id":"0E21B38F-8E27-43C4-B4F8-EEFAAA776C7D", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" } ], "F8B947BB-5F37-4D03-B4A1-917B5E21A462":[ { "id":"0E21B38F-8E27-43C4-B4F8-EEXAAA776C7D", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" } ], "F8B947BB-5F37-4D03-B4A1-917B5E21D452":[ { "id":"0E21B38F-8E27-43C4-B4F8-EEFADA7D6C7D", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" } ], "F8B947BB-5F37-4D03-B4A1-917C5E21A46X":[ { "id":"0E21B38F-8E27-43C4-B4F8-EEFAXA776C7D", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" } ], "F8B947BB-5F37-4D03-B4A1-917BDE21A46E":[ { "id":"0E21B38F-8E27-43C4-B4F8-EEDAAA776C7D", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" } ], "F8B947BB-5F37-4D03-B4A1-917B5E21A46D":[ { "id":"0E21B38F-8E27-43C4-B4F8-EEDAAA776C7D", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" } ] }, "type":"signature" }
Example request for 5 sequential signatures

To do a bulk signature request with signers on sequential order, the submitted sheet should be like this.

email email2 email3
email1@test.com email1@test2.com email1@test3.com
email2@test.com email2@test2.com email2@test3.com
email3@test.com email3@test2.com email3@test3.com
email4@test.com email4@test2.com email4@test3.com
email5@test.com email5@test2.com email5@test3.com

We have a header as well, and for every row, the first column will be signer 1, the second signer 2, etc.

$ curl

-X POST

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

-F "sheet=@documents/sheets/recipients.xlsx"

-F "files[0]=@documents/important/nda.pdf"

-F "have_header=1"

-F "subject=Bulk sequential request test"

-F "body=This is a test to see if 5 signatures are generated for 3 signers each"

https://api.sandbox.signaturit.com/v3/packages/signatures.json


{ "created_at":"2016-09-15T14:58:14+0000", "id":"8B1D4385-E21E-48C2-94C9-651B3CF73815", "sent_at":"2016-09-15T14:58:39+0000", "signatures":{ "F8B947BB-5F37-4D03-B4A1-917B5E21A462":[ { "id":"0E21B38F-8E27-43C4-B4F8-EEFAAA776C7D", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" }, { "id":"0E21B38F-8E27-43C4-B4F8-EEFAAA776C7E", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" }, { "id":"0E21B38F-8E27-43C4-B4F8-EEFAAA776C7F", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" } ], "F8B947BB-5F37-4D03-B4A1-917B5E21A463":[ { "id":"0E21B38F-8E27-43C4-B4F8-EEFAAA776C8D", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" }, { "id":"0E21B38F-8E27-43C4-B4F8-EEFAAA776C8E", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" }, { "id":"0E21B38F-8E27-43C4-B4F8-EEFAAA776C8F", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" } ], "F8B947BB-5F37-4D03-B4A1-917B5E21A464":[ { "id":"0E21B38F-8E27-43C4-B4F8-EEFAAA774C7D", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" }, { "id":"0E21B38F-8E27-43C4-B4F8-EEFAAA774C7Y", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" }, { "id":"0E21B38F-8E27-43C4-B4F8-EEFAAA774C7X", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" } ], "F8B947BB-5F37-4D03-B4A1-917B5E21A452":[ { "id":"0E21B38F-8E27-43C4-B4F8-EEFADA7D6C7D", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" }, { "id":"0E21B38F-8E27-43C4-B4F8-EEFADA7D6C7A", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" }, { "id":"0E21B38F-8E27-43C4-B4F8-EEFADA7D6C7E", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" } ], "F8B947BB-5F37-4D03-B4A1-917C5E21A462":[ { "id":"0E21B38F-8E27-43C4-B4F8-EEFACA776C7D", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" }, { "id":"0E21B38F-8E27-43C4-B4F8-EEFADA7DSC7D", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" }, { "id":"0E21B38F-8E27-43C4-B4F8-EEFADA7D6X7D", "status":"ready", "created_at":"2016-09-15T14:58:20+0000" } ] }, "type":"signature" }

You can put more data in your rows than emails, for example.

email name email2 name2
email1@test.com Name1 email1@test2.com Name2
email2@test.com Name21 email2@test2.com Name22

Only columns with emails will be used as signers, so basically we'll have 2 sequential requests with 3 signers.

Using custom data in your bulk requests

Let's make some use of non e-mail data on the header. First, you need to have a pdf with some form fields, then you can add field key on header and then, for every row, set the value needed for that request.

email name email2 name2 email3
email1@test.com Name1 email1@test2.com Name2 email1@test3.com
email2@test.com Name21 email2@test2.com Name22 email2@test3.com

Looking at the previous example, pdf form fields name and name2 will be filled with row values for every signer. So for example, name for first request will be Name1, and for the second, Name2.

POST /v3/packages/emails.(json | xml)

Description

Perform a certified email bulk request.

Parameters

You can use the same parameters used on create email method to adjust your request. The only difference is that a sheet file must be included with all the recipient info.

sheet
A sheet file in xlsx/csv format. This file will contain all the info about recipients.
Response

A package in JSON or XML format.

Example request for 10 certified requests

To do a bulk email request, the submitted sheet should be like this.

email
email1@test.com
email2@test.com
email3@test.com
email4@test.com
email5@test.com
email6@test.com
email7@test.com
email8@test.com
email9@test.com
email10@test.com

Pretty much the same as the signature request sheet, but in this case, the header is mandatory. The column with header key email will be the one used as recipient email.

$ curl

-X POST

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

-F "sheet=@documents/sheets/recipients.xlsx"

-F "subject=Bulk email request test"

-F "body=This is a test to see if 10 email requests are generated."

https://api.sandbox.signaturit.com/v3/packages/emails.json


{ "created_at": "2016-09-16T09:40:42+0000", "id": "a24745c3-7bf1-11e6-a02d-080027360b09", "sent_at": "2016-09-16T09:40:56+0000", "emails": { "a36c2085-7bf1-11e6-a02d-080027360b09": [ { "id": "a39f3367-7bf1-11e6-a02d-080027360b09", "status": "in_queue", "created_at": "2016-09-16T09:40:44+0000" } ], "a8baae4f-7bf1-11e6-a02d-080027360b09": [ { "id": "a8d2c9b7-7bf1-11e6-a02d-080027360b09", "status": "in_queue", "created_at": "2016-09-16T09:40:53+0000" } ], "a36c2085-7bf1-11e6-a02d-080027360b10": [ { "id": "a39f3367-7bf1-11e6-a02d-080027360b10", "status": "in_queue", "created_at": "2016-09-16T09:40:44+0000" } ], "a8baae4f-7bf1-11e6-a02d-080027360b11": [ { "id": "a8d2c9b7-7bf1-11e6-a02d-080027360b11", "status": "in_queue", "created_at": "2016-09-16T09:40:53+0000" } ], "a36c2085-7bf1-11e6-a02d-080027360b12": [ { "id": "a39f3367-7bf1-11e6-a02d-080027360b12", "status": "in_queue", "created_at": "2016-09-16T09:40:44+0000" } ], "a8baae4f-7bf1-11e6-a02d-080027360b13": [ { "id": "a8d2c9b7-7bf1-11e6-a02d-08002736013", "status": "in_queue", "created_at": "2016-09-16T09:40:53+0000" } ], "a36c2085-7bf1-11e6-a02d-080027360b14": [ { "id": "a39f3367-7bf1-11e6-a02d-080027360b14", "status": "in_queue", "created_at": "2016-09-16T09:40:44+0000" } ], "a8baae4f-7bf1-11e6-a02d-080027360b015": [ { "id": "a8d2c9b7-7bf1-11e6-a02d-080027360b15", "status": "in_queue", "created_at": "2016-09-16T09:40:53+0000" } ], "a36c2085-7bf1-11e6-a02d-080027360b16": [ { "id": "a39f3367-7bf1-11e6-a02d-080027360b16", "status": "in_queue", "created_at": "2016-09-16T09:40:44+0000" } ], "a8baae4f-7bf1-11e6-a02d-080027360b017": [ { "id": "a8d2c9b7-7bf1-11e6-a02d-080027360b17", "status": "in_queue", "created_at": "2016-09-16T09:40:53+0000" } ] }, "type":"email" }

POST /v3/packages/sms.(json | xml)

Description

Perform a certified SMS bulk request.

Parameters

You can use the same parameters used on create email method to adjust your request. The only difference is that a sheet file must be included with all the recipient info.

sheet
A sheet file in xlsx/csv format. This file will contain all the info about recipients.
Response

A package in JSON or XML format.

Example request for 10 certified SMS

To do a bulk SMS request, the submitted sheet should be like this:

phone
34111111110
34111111111
34111111112
34111111113
34111111114
34111111115
34111111116
34111111117
34111111118
34111111119

Same as the email request sheet, but in this case the required column must be phone.

$ curl

-X POST

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

-F "sheet=@documents/sheets/recipients.xlsx"

-F "body=This is a test to see if 10 sms requests are generated."

https://api.sandbox.signaturit.com/v3/packages/sms.json


{ "created_at": "2016-09-16T09:40:42+0000", "id": "a24745c3-7bf1-11e6-a02d-080027360b09", "sent_at": "2016-09-16T09:40:56+0000", "sms": { "a36c2085-7bf1-11e6-a02d-080027360b09": [ { "id": "a39f3367-7bf1-11e6-a02d-080027360b09", "status": "in_queue", "created_at": "2016-09-16T09:40:44+0000" } ], "a8baae4f-7bf1-11e6-a02d-080027360b09": [ { "id": "a8d2c9b7-7bf1-11e6-a02d-080027360b09", "status": "in_queue", "created_at": "2016-09-16T09:40:53+0000" } ], "a36c2085-7bf1-11e6-a02d-080027360b10": [ { "id": "a39f3367-7bf1-11e6-a02d-080027360b10", "status": "in_queue", "created_at": "2016-09-16T09:40:44+0000" } ], "a8baae4f-7bf1-11e6-a02d-080027360b11": [ { "id": "a8d2c9b7-7bf1-11e6-a02d-080027360b11", "status": "in_queue", "created_at": "2016-09-16T09:40:53+0000" } ], "a36c2085-7bf1-11e6-a02d-080027360b12": [ { "id": "a39f3367-7bf1-11e6-a02d-080027360b12", "status": "in_queue", "created_at": "2016-09-16T09:40:44+0000" } ], "a8baae4f-7bf1-11e6-a02d-080027360b13": [ { "id": "a8d2c9b7-7bf1-11e6-a02d-08002736013", "status": "in_queue", "created_at": "2016-09-16T09:40:53+0000" } ], "a36c2085-7bf1-11e6-a02d-080027360b14": [ { "id": "a39f3367-7bf1-11e6-a02d-080027360b14", "status": "in_queue", "created_at": "2016-09-16T09:40:44+0000" } ], "a8baae4f-7bf1-11e6-a02d-080027360b015": [ { "id": "a8d2c9b7-7bf1-11e6-a02d-080027360b15", "status": "in_queue", "created_at": "2016-09-16T09:40:53+0000" } ], "a36c2085-7bf1-11e6-a02d-080027360b16": [ { "id": "a39f3367-7bf1-11e6-a02d-080027360b16", "status": "in_queue", "created_at": "2016-09-16T09:40:44+0000" } ], "a8baae4f-7bf1-11e6-a02d-080027360b017": [ { "id": "a8d2c9b7-7bf1-11e6-a02d-080027360b17", "status": "in_queue", "created_at": "2016-09-16T09:40:53+0000" } ] }, "type":"sms" }

GET /v3/packages/{packageId}/download/audit_trail

Description

This method generate the package audit trail with current status for requests and download it.

Response

PDF file.

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/packages/a8baae4f-7bf1-11e6-a02d-080027360b017/download/audit_trail.json

Subscription

You can subscribe to Signaturit events using subscriptions. When you create a subscription, if the process event matches the one you are subscribed, event info will be sent to the url submitted.

Subscription is formed basically by the desired events an a url to send the information.

id
Subscription identifier.
events
An array with the events you want to subscribe.
url
Url used to send event information.

When you are subscribed to a event, you will get the following information when the event triggers.

{ "created_at": "2015-02-25T13:38:33+0000", "document": { "email": "john@signaturit.com", "events": [{ "type": "email_processed", "created_at": "2014-10-30T09:58:01+0000" }, { "type": "email_delivered", "created_at": "2014-10-30T09:58:03+0000" }, { "type": "email_opened", "created_at": "2014-10-30T09:58:15+0000" }, { "type": "reminder_email_processed", "created_at": "2014-10-30T11:33:46+0000" }], "file": { "name": "contract.pdf", "pages": 5, "size": 72218 }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }, "type": "reminder_email_processed" }

The media type of the events we send to your endpoints is set to application/x-www-form-urlencoded by default.

You can receive the events on other formats such as json or xml.

To do so, add the media type extension you want to get to the end of the URL where you want to receive these events: for example https://httpbin.org/post.json we will post the information in json format.

GET /v3/subscriptions.(json | xml)

Description

Get all subscriptions.

Parameters
limit
Max number of subscriptions to retrieve. The subscription limit is 100. OPTIONAL
offset
Results offset. Default value is 0. OPTIONAL
event
Show subscriptions attached to that event. OPTIONAL
Response

Subscription list in JSON or XML format.

Example request

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/subscriptions.json


[ { "created_at": "2016-09-29T10:20:25+0000", "events": ["*"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "https://httpbin.org/post" } ]

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.get_subscriptions


[ { "created_at": "2016-09-29T10:20:25+0000", "events": ["*"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "https://httpbin.org/post" } ]

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.get_subscriptions()


[ { "created_at": "2016-09-29T10:20:25+0000", "events": ["*"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "https://httpbin.org/post" } ]

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->getSubscriptions();


[ { "created_at": "2016-09-29T10:20:25+0000", "events": ["*"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "https://httpbin.org/post" } ]

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.getSubscriptions();


[ { "created_at": "2016-09-29T10:20:25+0000", "events": ["*"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "https://httpbin.org/post" } ]

Client client = new Client("YOUR_ACCESS_TOKEN", false)

client.getSubscriptions();


[ { "created_at": "2016-09-29T10:20:25+0000", "events": ["*"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "https://httpbin.org/post" } ]

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.getSubscriptions();


[ { "created_at": "2016-09-29T10:20:25+0000", "events": ["*"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "https://httpbin.org/post" } ]

GET /v3/subscriptions/{id}.(json | xml)

Description

Get a subscription.

Response

Subscription in JSON or XML format.

Example request

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/subscriptions/b2c7de2f-862c-11e6-88d5-06875124f8dd.json


{ "created_at": "2016-09-29T10:20:25+0000", "events": ["*"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "https://httpbin.org/post" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.get_subscription('b2c7de2f-862c-11e6-88d5-06875124f8dd')


{ "created_at": "2016-09-29T10:20:25+0000", "events": ["*"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "https://httpbin.org/post" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.get_subscription('b2c7de2f-862c-11e6-88d5-06875124f8dd')


{ "created_at": "2016-09-29T10:20:25+0000", "events": ["*"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "https://httpbin.org/post" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->getSubscription('b2c7de2f-862c-11e6-88d5-06875124f8dd');


{ "created_at": "2016-09-29T10:20:25+0000", "events": ["*"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "https://httpbin.org/post" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.getSubscription('b2c7de2f-862c-11e6-88d5-06875124f8dd');


{ "created_at": "2016-09-29T10:20:25+0000", "events": ["*"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "https://httpbin.org/post" }

Client client = new Client("YOUR_ACCESS_TOKEN");

client.getSubscription("b2c7de2f-862c-11e6-88d5-06875124f8dd");


{ "created_at": "2016-09-29T10:20:25+0000", "events": ["*"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "https://httpbin.org/post" }

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.getSubscription("b2c7de2f-862c-11e6-88d5-06875124f8dd");


{ "created_at": "2016-09-29T10:20:25+0000", "events": ["*"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "https://httpbin.org/post" }

POST /v3/subscriptions.(json | xml)

Description

Create a new subscription.

Parameters
url
Url where the event information will be sent.
events
Array with the event you want to subscribe. You can select one or more events. If you want to subscribe to all events, you can use the code "*".

Signature events

email_processed
The email has been processed
email_delivered
The email has been delivered
email_opened
The email has been opened
email_bounced
The server cannot deliver the message. Bounces often are caused by outdated or incorrectly entered email addresses.
email_deferred
The email cannot immediately be delivered, but it hasn’t been completely rejected. Sometimes called a soft bounce, it will be retried for 72 hours.
reminder_email_processed
The reminder email has been processed
reminder_email_delivered
The reminder email has been delivered
reminder_email_opened
The reminder email has been opened
sms_processed
The SMS has been processed.
sms_delivered
The SMS has been delivered.
password_sms_processed
The password SMS has been processed.
password_sms_delivered
The password SMS has been delivered.
document_opened
The document has been opened.
document_signed
The document has been signed.
document_completed
The document has been completed and ready to be downloaded.
audit_trail_completed
The audit trail has been completed and ready to be downloaded.
document_declined
The document has been declined.
document_expired
The document has expired.
document_canceled
The document has been canceled.
photo_added
The signer has attached a photo in the process.
voice_added
The signer has attached an audio in the process.
file_added
The signer has attached a file in the process.
photo_id_added
The signer has attached a photo id in the process.

Email events

email_processed
The email has been processed.
email_delivered
The email has been delivered.
email_opened
The email has been opened.
documents_opened
The document overview has been opened.
document_opened
The document has been opened.
document_downloaded
The document has been downloaded.
certification_completed
The certification process finished

SMS events

sms_processed
The email has been processed.
sms_delivered
The email has been delivered.
documents_opened
The document overview has been opened.
document_opened
The document has been opened.
document_downloaded
The document has been downloaded.
certification_completed
The certification process finished
Response

Subscription in JSON or XML format.

Example of subscribing to all events

$ curl

-X POST

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

-d "url=https://httpbin.org/post"

-d "events[0]=*"

https://api.sandbox.signaturit.com/v3/subscriptions.json


{ "created_at": "2016-09-29T10:20:25+0000", "events": ["*"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "https://httpbin.org/post" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.create_subscription('https://httpbin.org/post', ['*'])


{ "created_at": "2016-09-29T10:20:25+0000", "events": ["*"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "https://httpbin.org/post" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.create_subscription('https://httpbin.org/post', ['*'])


{ "created_at": "2016-09-29T10:20:25+0000", "events": ["*"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "https://httpbin.org/post" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->createSubscription('https://httpbin.org/post', ['*']);


{ "created_at": "2016-09-29T10:20:25+0000", "events": ["*"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "https://httpbin.org/post" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.createSubscription('https://httpbin.org/post', ['*']);


{ "created_at": "2016-09-29T10:20:25+0000", "events": ["*"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "https://httpbin.org/post" }

Client client = new Client("YOUR_ACCESS_TOKEN", false)

String[] events = {"*"};

client.createSubscription("https://httpbin.org/post", events);


{ "created_at": "2016-09-29T10:20:25+0000", "events": ["*"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "https://httpbin.org/post" }

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.createSubscription("https://httpbin.org/post", new [] { "*" });


{ "created_at": "2016-09-29T10:20:25+0000", "events": ["*"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "https://httpbin.org/post" }
Example of subscribing to events of email delivery process

$ curl

-X POST

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

-d "url=https://httpbin.org/post"

-d "events[0]=email_processed"

-d "events[1]=email_delivered"

https://api.sandbox.signaturit.com/v3/subscriptions.json


{ "created_at": "2016-09-29T10:20:25+0000", "events": ["email_processed", "email_delivered"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "https://httpbin.org/post" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.create_subscription('https://httpbin.org/post', ['email_processed', 'email_delivered'])


{ "created_at": "2016-09-29T10:20:25+0000", "events": ["email_processed", "email_delivered"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "https://httpbin.org/post" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.create_subscription('https://httpbin.org/post', ['email_processed', 'email_delivered'])


{ "created_at": "2016-09-29T10:20:25+0000", "events": ["email_processed", "email_delivered"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "https://httpbin.org/post" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->createSubscription('https://httpbin.org/post', ['email_processed', 'email_delivered']);


{ "created_at": "2016-09-29T10:20:25+0000", "events": ["email_processed", "email_delivered"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "https://httpbin.org/post" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.createSubscription('https://httpbin.org/post', ['email_processed', 'email_delivered']);


{ "created_at": "2016-09-29T10:20:25+0000", "events": ["email_processed", "email_delivered"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "https://httpbin.org/post" }

Client client = new Client("YOUR_ACCESS_TOKEN", false)

String[] events = {"email_processed", "email_delivered"};

client.createSubscription("https://httpbin.org/post", events);


{ "created_at": "2016-09-29T10:20:25+0000", "events": ["email_processed", "email_delivered"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "https://httpbin.org/post" }

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

String[] events = {"email_processed", "email_delivered"};

client.createSubscription("https://httpbin.org/post", new [] { "email_processed", "email_delivered" });


{ "created_at": "2016-09-29T10:20:25+0000", "events": ["email_processed", "email_delivered"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "https://httpbin.org/post" }

PATCH /v3/subscriptions/{id}.(json | xml)

Description

Updates a subscription.

Parameters

Same parameters as POST method.

Example request

$ curl

-X PATCH

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

-d "url=new_url.json"

https://api.sandbox.signaturit.com/v3/subscriptions/b2c7de2f-862c-11e6-88d5-06875124f8dd.json


{ "created_at": "2016-09-29T10:20:25+0000", "events": ["email_processed", "email_delivered"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "new_url.json" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.update_subscription('b2c7de2f-862c-11e6-88d5-06875124f8dd', { :url => 'new_url.json' })


{ "created_at": "2016-09-29T10:20:25+0000", "events": ["email_processed", "email_delivered"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "new_url.json" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.update_subscription('b2c7de2f-862c-11e6-88d5-06875124f8dd', url='new_url.json')


{ "created_at": "2016-09-29T10:20:25+0000", "events": ["email_processed", "email_delivered"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "new_url.json" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->updateSubscription('b2c7de2f-862c-11e6-88d5-06875124f8dd', 'new_url.json', null);


{ "created_at": "2016-09-29T10:20:25+0000", "events": ["email_processed", "email_delivered"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "new_url.json" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.updateSubscription('b2c7de2f-862c-11e6-88d5-06875124f8dd', 'new_url.json', null);


{ "created_at": "2016-09-29T10:20:25+0000", "events": ["email_processed", "email_delivered"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "new_url.json" }

Client client = new Client("YOUR_ACCESS_TOKEN", false)

client.updateSubscription("b2c7de2f-862c-11e6-88d5-06875124f8dd", "https://newurl.com.json", null);


{ "created_at": "2016-09-29T10:20:25+0000", "events": ["email_processed", "email_delivered"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "new_url.json" }

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.updateSubscription("b2c7de2f-862c-11e6-88d5-06875124f8dd", new { url = "new_url.json" });


{ "created_at": "2016-09-29T10:20:25+0000", "events": ["email_processed", "email_delivered"], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "new_url.json" }

DELETE /v3/subscriptions/{id}.(json | xml)

Description

Deletes a subscription.

Example request

$ curl

-X DELETE

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/subscriptions/b2c7de2f-862c-11e6-88d5-06875124f8dd.json


[]

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.delete_subscription('b2c7de2f-862c-11e6-88d5-06875124f8dd')


[]

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.delete_subscription('b2c7de2f-862c-11e6-88d5-06875124f8dd')


[]

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->deleteSubscription('b2c7de2f-862c-11e6-88d5-06875124f8dd');


[]

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.deleteSubscription('b2c7de2f-862c-11e6-88d5-06875124f8dd');


[]

Client client = new Client("YOUR_ACCESS_TOKEN", false)

client.deleteSubscription("b2c7de2f-862c-11e6-88d5-06875124f8dd");


[]

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.deleteSubscription("b2c7de2f-862c-11e6-88d5-06875124f8dd");


[]

Team

Team is formed by one or more seats. Every seat can be linked only to one user, you can request a user to join your team and if he accepts, it'll become part of your team.

email
Email from user linked to the seat.
name
Name from user linked to the seat.
position
Position from user linked to the seat.
role
Seat role.
status
Current status of the seat, can be:
active
Seat is linked to a user.
pending
If a team request has been sent to the user and user has not joined yet to the team.
inactive
Seat is empty.
[ { "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "position": "CEO", "role": "admin" }, { "created_at": "2016-10-06T10:03:13+0000", "id": "17f0dc63-8bac-11e6-88d5-06875124f8dd", "role": "member" } ]

You can also create groups in your team. Every group can have managers and members. Every user designed as manager, will view all requests made by the group members.

managers
Users that can manage group members.
members
Group members.
name
Group name.

GET /v3/team/users.(json | xml)

Description

Get team users.

Response

Seats in JSON or XML format.

Example request

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/team/users.json


[ { "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "position": "CEO", "role": "admin", "status": "active" }, { "created_at": "2016-10-06T10:03:13+0000", "id": "17f0dc63-8bac-11e6-88d5-06875124f8dd", "role": "member", "status": "inactive" } ]

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.get_users()


[ { "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "position": "CEO", "role": "admin", "status": "active" }, { "created_at": "2016-10-06T10:03:13+0000", "id": "17f0dc63-8bac-11e6-88d5-06875124f8dd", "role": "member", "status": "inactive" } ]

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.get_users()


[ { "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "position": "CEO", "role": "admin", "status": "active" }, { "created_at": "2016-10-06T10:03:13+0000", "id": "17f0dc63-8bac-11e6-88d5-06875124f8dd", "role": "member", "status": "inactive" } ]

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->getUsers();


[ { "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "position": "CEO", "role": "admin", "status": "active" }, { "created_at": "2016-10-06T10:03:13+0000", "id": "17f0dc63-8bac-11e6-88d5-06875124f8dd", "role": "member", "status": "inactive" } ]

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.getUsers();


[ { "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "position": "CEO", "role": "admin", "status": "active" }, { "created_at": "2016-10-06T10:03:13+0000", "id": "17f0dc63-8bac-11e6-88d5-06875124f8dd", "role": "member", "status": "inactive" } ]

Client client = new Client("YOUR_ACCESS_TOKEN", false)

client.getUsers();


[ { "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "position": "CEO", "role": "admin", "status": "active" }, { "created_at": "2016-10-06T10:03:13+0000", "id": "17f0dc63-8bac-11e6-88d5-06875124f8dd", "role": "member", "status": "inactive" } ]

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.getUsers();


[ { "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "position": "CEO", "role": "admin", "status": "active" }, { "created_at": "2016-10-06T10:03:13+0000", "id": "17f0dc63-8bac-11e6-88d5-06875124f8dd", "role": "member", "status": "inactive" } ]

GET /v3/team/seats.(json | xml)

Description

Get team seats.

Response

Seats in JSON or XML format.

Example request

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/team/seats.json


[ { "email": "john.doe@signaturit.com", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "status": "active" } ]

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.get_seats


[ { "email": "john.doe@signaturit.com", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "status": "active" } ]

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.get_seats()


[ { "email": "john.doe@signaturit.com", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "status": "active" } ]

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->getSeats();


[ { "email": "john.doe@signaturit.com", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "status": "active" } ]

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.getSeats();


[ { "email": "john.doe@signaturit.com", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "status": "active" } ]

Client client = new Client("YOUR_ACCESS_TOKEN", false)

client.getSeats();


[ { "email": "john.doe@signaturit.com", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "status": "active" } ]

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.getSeats();


[ { "email": "john.doe@signaturit.com", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "status": "active" } ]

GET /v3/team/user/id.(json | xml)

Description

Get a user from the team.

Response

Seat in JSON or XML format.

Example request

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/team/users/d8125099-871e-11e6-88d5-06875124f8dd.json


{ "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "position": "CEO", "role": "admin", "status": "active" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.get_user('d8125099-871e-11e6-88d5-06875124f8dd')


{ "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "position": "CEO", "role": "admin", "status": "active" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.get_user('d8125099-871e-11e6-88d5-06875124f8dd')


{ "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "position": "CEO", "role": "admin", "status": "active" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->getUser('d8125099-871e-11e6-88d5-06875124f8dd');


{ "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "position": "CEO", "role": "admin", "status": "active" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.getUser('d8125099-871e-11e6-88d5-06875124f8dd');


{ "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "position": "CEO", "role": "admin", "status": "active" }

Client client = new Client("YOUR_ACCESS_TOKEN", false)

client.getUser("d8125099-871e-11e6-88d5-06875124f8dd");


{ "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "position": "CEO", "role": "admin", "status": "active" }

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.getUser("d8125099-871e-11e6-88d5-06875124f8dd");


{ "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "position": "CEO", "role": "admin", "status": "active" }

POST /v3/team/users.(json | xml)

Description

Request a user to join the team. User will get an email with the link to register in your team.

Parameters
email
Email of the user that'll be joining the team.
role
User role. You can choose between admin or member.
Response

Seat in JSON or XML format.

Example request

$ curl

-X POST

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

-d "email=bob.soap@signaturit.com"

-d "role=admin"

https://api.sandbox.signaturit.com/v3/team/users.json


{ "created_at": "2016-09-30T15:02:02+0000", "email": "bob.soap@signaturit.com", "id": "d8125099-871e-11e6-88d5-06875124f8ed", "role": "admin" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.invite_user('bob.soap@signaturit.com', 'admin')


{ "created_at": "2016-09-30T15:02:02+0000", "email": "bob.soap@signaturit.com", "id": "d8125099-871e-11e6-88d5-06875124f8ed", "role": "admin" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.invite_user('bob.soap@signaturit.com', 'admin')


{ "created_at": "2016-09-30T15:02:02+0000", "email": "bob.soap@signaturit.com", "id": "d8125099-871e-11e6-88d5-06875124f8ed", "role": "admin" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->inviteUser('bob.soap@signaturit.com', 'admin');


{ "created_at": "2016-09-30T15:02:02+0000", "email": "bob.soap@signaturit.com", "id": "d8125099-871e-11e6-88d5-06875124f8ed", "role": "admin" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.inviteUser('bob.soap@signaturit.com', 'admin');


{ "created_at": "2016-09-30T15:02:02+0000", "email": "bob.soap@signaturit.com", "id": "d8125099-871e-11e6-88d5-06875124f8ed", "role": "admin" }

Client client = new Client("YOUR_ACCESS_TOKEN", false)

client.inviteUser("bob.soap@signaturit.com", "admin");


{ "created_at": "2016-09-30T15:02:02+0000", "email": "bob.soap@signaturit.com", "id": "d8125099-871e-11e6-88d5-06875124f8ed", "role": "admin" }

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.inviteUser("bob.soap@signaturit.com", "admin");


{ "created_at": "2016-09-30T15:02:02+0000", "email": "bob.soap@signaturit.com", "id": "d8125099-871e-11e6-88d5-06875124f8ed", "role": "admin" }

PATCH /v3/team/users/id.(json | xml)

Description

Update user role.

Response

User in JSON or XML format.

Example request

$ curl

-X PATCH

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

-d "role=member"

https://api.sandbox.signaturit.com/v3/team/users/d8125099-871e-11e6-88d5-06875124f8ed.json


{ "created_at": "2016-09-30T15:02:02+0000", "email": "bob.soap@signaturit.com", "id": "d8125099-871e-11e6-88d5-06875124f8ed", "role": "member", "status": "pending" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.change_user_role('d8125099-871e-11e6-88d5-06875124f8ed.', 'member')


{ "created_at": "2016-09-30T15:02:02+0000", "email": "bob.soap@signaturit.com", "id": "d8125099-871e-11e6-88d5-06875124f8ed", "role": "member", "status": "pending" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.change_user_role('d8125099-871e-11e6-88d5-06875124f8ed.', 'member')


{ "created_at": "2016-09-30T15:02:02+0000", "email": "bob.soap@signaturit.com", "id": "d8125099-871e-11e6-88d5-06875124f8ed", "role": "member", "status": "pending" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->changeUserRole('d8125099-871e-11e6-88d5-06875124f8ed.', 'member');


{ "created_at": "2016-09-30T15:02:02+0000", "email": "bob.soap@signaturit.com", "id": "d8125099-871e-11e6-88d5-06875124f8ed", "role": "member", "status": "pending" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.changeUserRole('d8125099-871e-11e6-88d5-06875124f8ed.', 'member');


{ "created_at": "2016-09-30T15:02:02+0000", "email": "bob.soap@signaturit.com", "id": "d8125099-871e-11e6-88d5-06875124f8ed", "role": "member", "status": "pending" }

Client client = new Client("YOUR_ACCESS_TOKEN", false)

client.changeUserRole("d8125099-871e-11e6-88d5-06875124f8dd", "member");


{ "created_at": "2016-09-30T15:02:02+0000", "email": "bob.soap@signaturit.com", "id": "d8125099-871e-11e6-88d5-06875124f8ed", "role": "member", "status": "pending" }

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.changeUserRole("d8125099-871e-11e6-88d5-06875124f8dd", "member");


{ "created_at": "2016-09-30T15:02:02+0000", "email": "bob.soap@signaturit.com", "id": "d8125099-871e-11e6-88d5-06875124f8ed", "role": "member", "status": "pending" }

DELETE /v3/team/users/id.(json | xml)

Description

Remove user from account and made the seat inactive again.

Response

Seat in JSON or XML format.

Example request

$ curl

-X DELETE

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/team/users/d8125099-871e-11e6-88d5-06875124f8dd.json


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "role": "admin", "status": "inactive" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.remove_user('d8125099-871e-11e6-88d5-06875124f8dd')


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "role": "admin", "status": "inactive" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.remove_user('d8125099-871e-11e6-88d5-06875124f8dd')


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "role": "admin", "status": "inactive" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->removeUser('d8125099-871e-11e6-88d5-06875124f8dd');


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "role": "admin", "status": "inactive" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.removeUser('d8125099-871e-11e6-88d5-06875124f8dd');


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "role": "admin", "status": "inactive" }

Client client = new Client("YOUR_ACCESS_TOKEN", false)

client.removeUser("d8125099-871e-11e6-88d5-06875124f8dd");


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "role": "admin", "status": "inactive" }

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.removeUser("d8125099-871e-11e6-88d5-06875124f8dd");


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "role": "admin", "status": "inactive" }

DELETE /v3/team/seats/id.(json | xml)

Description

Remove seat from account.

Response

Seat in JSON or XML format.

Example request

$ curl

-X DELETE

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/team/users/d8125099-871e-11e6-88d5-06875124f8dd.json


{ "id": "d8125099-871e-11e6-88d5-06875124f8dd", "status": "inactive" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.remove_seat('d8125099-871e-11e6-88d5-06875124f8dd')


{ "id": "d8125099-871e-11e6-88d5-06875124f8dd", "status": "inactive" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.remove_seat('d8125099-871e-11e6-88d5-06875124f8dd')


{ "id": "d8125099-871e-11e6-88d5-06875124f8dd", "status": "inactive" }

$client = SignaturitClient('YOUR_ACCESS_TOKEN')

$client->removeSeat('d8125099-871e-11e6-88d5-06875124f8dd')


{ "id": "d8125099-871e-11e6-88d5-06875124f8dd", "status": "inactive" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.removeSeat('d8125099-871e-11e6-88d5-06875124f8dd');


{ "id": "d8125099-871e-11e6-88d5-06875124f8dd", "status": "inactive" }

Client client = new Client("YOUR_ACCESS_TOKEN", false)

client.removeSeat("d8125099-871e-11e6-88d5-06875124f8dd");


{ "id": "d8125099-871e-11e6-88d5-06875124f8dd", "status": "inactive" }

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.removeSeat("d8125099-871e-11e6-88d5-06875124f8dd");


{ "id": "d8125099-871e-11e6-88d5-06875124f8dd", "status": "inactive" }

GET /v3/team/groups.(json | xml)

Description

Get team groups.

Response

Groups in JSON or XML format.

Example request

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/team/groups.json


[ { "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Founders" } ]

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.get_groups


[ { "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Founders" } ]

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.get_groups()


[ { "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Founders" } ]

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->getGroups();


[ { "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Founders" } ]

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.getGroups();


[ { "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Founders" } ]

Client client = new Client("YOUR_ACCESS_TOKEN", false)

client.getGroups();


[ { "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Founders" } ]

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.getGroups();


[ { "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Founders" } ]

GET /v3/team/groups/id.(json | xml)

Description

Get single group.

Response

Group in JSON or XML format.

Example request

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/team/groups/id.json


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Test group" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.get_group('d8125099-871e-11e6-88d5-06875124f8dd')


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Test group" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.get_group('d8125099-871e-11e6-88d5-06875124f8dd')


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Test group" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->getGroup('d8125099-871e-11e6-88d5-06875124f8dd');


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Test group" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.getGroup('d8125099-871e-11e6-88d5-06875124f8dd');


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Test group" }

Client client = new Client("YOUR_ACCESS_TOKEN", false)

client.getGroup("d8125099-871e-11e6-88d5-06875124f8dd");


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Test group" }

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.getGroup("d8125099-871e-11e6-88d5-06875124f8dd");


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Test group" }

POST /v3/team/groups.(json | xml)

Description

Create a new group.

Response

Group in JSON or XML format.

Example request

$ curl

-X POST

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

-d "name=Founders"

https://api.sandbox.signaturit.com/v3/team/groups.json


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Founders" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.create_group('founders')


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Founders" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.create_group('founders')


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Founders" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->createGroup('founders')


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Founders" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.createGroup('founders')


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Founders" }

Client client = new Client("YOUR_ACCESS_TOKEN", false)

client.createGroup("Founders");


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Founders" }

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.createGroup("Founders");


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Founders" }

PATCH /v3/team/groups/id.(json | xml)

Description

Update a group.

Response

Group in JSON or XML format.

Example request

$ curl

-X PATCH

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

-d "name=Members"

https://api.sandbox.signaturit.com/v3/team/groups/d8125099-871e-11e6-88d5-06875124f8dd.json


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Members" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.update_group('d8125099-871e-11e6-88d5-06875124f8dd', 'Members')


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Members" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.update_group('d8125099-871e-11e6-88d5-06875124f8dd', 'Members')


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Members" }

$client = SignaturitClient('YOUR_ACCESS_TOKEN');

$client->updateGroup('d8125099-871e-11e6-88d5-06875124f8dd', 'Members');


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Members" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.updateGroup('d8125099-871e-11e6-88d5-06875124f8dd', 'Members')


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Members" }

Client client = new Client("YOUR_ACCESS_TOKEN", false)

client.updateGroup("d8125099-871e-11e6-88d5-06875124f8dd", "Members");


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Members" }

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.updateGroup("d8125099-871e-11e6-88d5-06875124f8dd", "Members");


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Members" }

DELETE /v3/team/groups/id.(json | xml)

Description

Delete a group.

Example request

$ curl

-X DELETE

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/team/groups/d8125099-871e-11e6-88d5-06875124f8dd.json


[]

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.delete_group('d8125099-871e-11e6-88d5-06875124f8dd')


[]

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.delete_group('d8125099-871e-11e6-88d5-06875124f8dd')


[]

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->deleteGroup('d8125099-871e-11e6-88d5-06875124f8dd');


[]

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.deleteGroup('d8125099-871e-11e6-88d5-06875124f8dd');


[]

Client client = new Client("YOUR_ACCESS_TOKEN", false)

client.deleteGroup("d8125099-871e-11e6-88d5-06875124f8dd");


[]

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.deleteGroup("d8125099-871e-11e6-88d5-06875124f8dd");


[]

POST /v3/team/groups/id/managers/id.(json | xml)

Description

Add a new seat to a group, with manager role.

Response

Group in JSON or XML format.

Example request

$ curl

-X POST

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/team/groups/d8125099-871e-11e6-88d5-06875124f8dd/managers/d8125099-871e-11e6-88d5-06875124f8dd.json


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [ { "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "position": "CEO", "role": "admin", "status": "active" } ], "members": [], "name": "Founders" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.add_manager_to_group('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd')


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [ { "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "position": "CEO", "role": "admin", "status": "active" } ], "members": [], "name": "Founders" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.add_manager_to_group('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd')


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [ { "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "position": "CEO", "role": "admin", "status": "active" } ], "members": [], "name": "Founders" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client.addManagerToGroup('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd');


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [ { "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "position": "CEO", "role": "admin", "status": "active" } ], "members": [], "name": "Founders" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.addManagerToGroup('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd');


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [ { "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "position": "CEO", "role": "admin", "status": "active" } ], "members": [], "name": "Founders" }

Client client = new Client("YOUR_ACCESS_TOKEN", false)

client.addManagerToGroup("d8125099-871e-11e6-88d5-06875124f8dd", "d8125099-871e-11e6-88d5-06875124f8dd");


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [ { "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "position": "CEO", "role": "admin", "status": "active" } ], "members": [], "name": "Founders" }

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.addManagerToGroup("d8125099-871e-11e6-88d5-06875124f8dd", "d8125099-871e-11e6-88d5-06875124f8dd");


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [ { "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "position": "CEO", "role": "admin", "status": "active" } ], "members": [], "name": "Founders" }

DELETE /v3/team/groups/id/managers/id.(json | xml)

Description

Remove a manager from group.

Response

Group in JSON or XML format.

Example request

$ curl

-X DELETE

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/team/groups/d8125099-871e-11e6-88d5-06875124f8dd/managers/d8125099-871e-11e6-88d5-06875124f8dd.json


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Founders" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.remove_manager_from_group('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd')


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Founders" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.remove_manager_from_group('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd')


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Founders" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->removeManagerFromGroup('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd');


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Founders" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.removeManagerFromGroup('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd');


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Founders" }

Client client = new Client("YOUR_ACCESS_TOKEN", false)

client.removeManagerFromGroup("d8125099-871e-11e6-88d5-06875124f8dd", "d8125099-871e-11e6-88d5-06875124f8dd");


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Founders" }

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.removeManagerFromGroup("d8125099-871e-11e6-88d5-06875124f8dd", "d8125099-871e-11e6-88d5-06875124f8dd");


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Founders" }

POST /v3/team/groups/id/members/id.(json | xml)

Description

Add a new seat to a group, with member role.

Response

Group in JSON or XML format.

Example request

$ curl

-X POST

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/team/groups/d8125099-871e-11e6-88d5-06875124f8dd/members/d8125099-871e-11e6-88d5-06875124f8dd.json


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [ { "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "position": "CEO", "role": "admin", "status": "active" } ], "name": "Founders" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.add_member_to_group('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd')


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [ { "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "position": "CEO", "role": "admin", "status": "active" } ], "name": "Founders" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.add_member_to_group('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd')


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [ { "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "position": "CEO", "role": "admin", "status": "active" } ], "name": "Founders" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client.addMemberToGroup('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd');


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [ { "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "position": "CEO", "role": "admin", "status": "active" } ], "name": "Founders" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.addMemberToGroup('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd');


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [ { "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "position": "CEO", "role": "admin", "status": "active" } ], "name": "Founders" }

Client client = new Client("YOUR_ACCESS_TOKEN", false)

client.addMemberToGroup("d8125099-871e-11e6-88d5-06875124f8dd", "d8125099-871e-11e6-88d5-06875124f8dd");


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [ { "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "position": "CEO", "role": "admin", "status": "active" } ], "name": "Founders" }

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.addMemberToGroup("d8125099-871e-11e6-88d5-06875124f8dd", "d8125099-871e-11e6-88d5-06875124f8dd");


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [ { "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "position": "CEO", "role": "admin", "status": "active" } ], "name": "Founders" }

DELETE /v3/team/groups/id/members/id.(json | xml)

Description

Remove a member from group.

Response

Group in JSON or XML format.

Example request

$ curl

-X DELETE

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/team/groups/d8125099-871e-11e6-88d5-06875124f8dd/members/d8125099-871e-11e6-88d5-06875124f8dd.json


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Founders" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.remove_member_from_group('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd')


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Founders" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.remove_member_from_group('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd')


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Founders" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client.removeMemberFromGroup('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd');


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Founders" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.removeMemberFromGroup('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd');


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Founders" }

Client client = new Client("YOUR_ACCESS_TOKEN", false)

client.removeMemberFromGroup("d8125099-871e-11e6-88d5-06875124f8dd", "d8125099-871e-11e6-88d5-06875124f8dd");


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Founders" }

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.removeMemberFromGroup("d8125099-871e-11e6-88d5-06875124f8dd", "d8125099-871e-11e6-88d5-06875124f8dd");


{ "created_at": "2016-09-30T15:02:02+0000", "id": "d8125099-871e-11e6-88d5-06875124f8dd", "managers": [], "members": [], "name": "Founders" }

Contacts

You can create your own contacts, to use it when sending requests through signaturit. A contact is formed by an email and a name.

email
Contact email.
name
Contact name.
{ "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "e8125099-871e-11e6-88d5-06875124f8dd" }

GET /v3/contacts.(json | xml)

Description

Get your contacts.

Response

Contacts in JSON or XML format.

Example request

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/contacts.json


[ { "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "e8125099-871e-11e6-88d5-06875124f8dd" }, { "created_at": "2016-09-30T15:02:02+0000", "email": "bob.soap@signaturit.com", "name": "Bob Soap", "id": "e8525099-871e-11e6-88d5-06875124f8dd" } ]

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.get_contacts


[ { "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "e8125099-871e-11e6-88d5-06875124f8dd" }, { "created_at": "2016-09-30T15:02:02+0000", "email": "bob.soap@signaturit.com", "name": "Bob Soap", "id": "e8525099-871e-11e6-88d5-06875124f8dd" } ]

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.get_contacts()


[ { "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "e8125099-871e-11e6-88d5-06875124f8dd" }, { "created_at": "2016-09-30T15:02:02+0000", "email": "bob.soap@signaturit.com", "name": "Bob Soap", "id": "e8525099-871e-11e6-88d5-06875124f8dd" } ]

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->getContacts();


[ { "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "e8125099-871e-11e6-88d5-06875124f8dd" }, { "created_at": "2016-09-30T15:02:02+0000", "email": "bob.soap@signaturit.com", "name": "Bob Soap", "id": "e8525099-871e-11e6-88d5-06875124f8dd" } ]

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.getContacts();


[ { "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "e8125099-871e-11e6-88d5-06875124f8dd" }, { "created_at": "2016-09-30T15:02:02+0000", "email": "bob.soap@signaturit.com", "name": "Bob Soap", "id": "e8525099-871e-11e6-88d5-06875124f8dd" } ]

Client client = new Client("YOUR_ACCESS_TOKEN", false)

client.getContacts();


[ { "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "e8125099-871e-11e6-88d5-06875124f8dd" }, { "created_at": "2016-09-30T15:02:02+0000", "email": "bob.soap@signaturit.com", "name": "Bob Soap", "id": "e8525099-871e-11e6-88d5-06875124f8dd" } ]

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.getContacts();


[ { "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "e8125099-871e-11e6-88d5-06875124f8dd" }, { "created_at": "2016-09-30T15:02:02+0000", "email": "bob.soap@signaturit.com", "name": "Bob Soap", "id": "e8525099-871e-11e6-88d5-06875124f8dd" } ]

GET /v3/contacts/id.(json | xml)

Description

Get a single contact.

Response

Contact in JSON or XML format.

Example request

$ curl

-X GET

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/contacts/e8125099-871e-11e6-88d5-06875124f8dd.json


{ "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "e8125099-871e-11e6-88d5-06875124f8dd" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.get_contact('e8125099-871e-11e6-88d5-06875124f8dd')


{ "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "e8125099-871e-11e6-88d5-06875124f8dd" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.get_contact('e8125099-871e-11e6-88d5-06875124f8dd')


{ "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "e8125099-871e-11e6-88d5-06875124f8dd" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->getContact('e8125099-871e-11e6-88d5-06875124f8dd');


{ "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "e8125099-871e-11e6-88d5-06875124f8dd" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.getContact('e8125099-871e-11e6-88d5-06875124f8dd');


{ "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "e8125099-871e-11e6-88d5-06875124f8dd" }

Client client = new Client("YOUR_ACCESS_TOKEN", false)

client.getContact("e8125099-871e-11e6-88d5-06875124f8dd");


{ "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "e8125099-871e-11e6-88d5-06875124f8dd" }

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.getContact("e8125099-871e-11e6-88d5-06875124f8dd");


{ "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "e8125099-871e-11e6-88d5-06875124f8dd" }

POST /v3/contacts.(json | xml)

Description

Create a new contact.

Response

Contact in JSON or XML format.

Parameters
email
Email of the new contact.
name
Name of the new contact.
Example request

$ curl

-X POST

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

-d "email=john.doe@signaturit.com"

-d "name=John Doe"

https://api.sandbox.signaturit.com/v3/contacts.json


{ "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "e6125099-871e-11e6-88d5-06875124f8dd" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.create_contact('john.doe@signaturit.com', 'John Doe')


{ "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "e6125099-871e-11e6-88d5-06875124f8dd" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.create_contact('john.doe@signaturit.com', 'John Doe')


{ "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "e6125099-871e-11e6-88d5-06875124f8dd" }

$client = SignaturitClient('YOUR_ACCESS_TOKEN')

$client->createContact('john.doe@signaturit.com', 'John Doe');


{ "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "e6125099-871e-11e6-88d5-06875124f8dd" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.createContact('john.doe@signaturit.com', 'John Doe');


{ "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "e6125099-871e-11e6-88d5-06875124f8dd" }

Client client = new Client("YOUR_ACCESS_TOKEN", false)

client.createContact("john.doe@signaturit.com", "John Doe");


{ "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "e6125099-871e-11e6-88d5-06875124f8dd" }

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.createContact("john.doe@signaturit.com", "John Doe");


{ "created_at": "2016-09-30T15:02:02+0000", "email": "john.doe@signaturit.com", "name": "John Doe", "id": "e6125099-871e-11e6-88d5-06875124f8dd" }

PATCH /v3/contacts/id.(json | xml)

Description

Update a current contact.

Response

Contact in JSON or XML format.

Parameters
email
Email of the new contact.
name
Name of the new contact.
Example request

$ curl

-X PATCH

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

-d "email=john.smith@signaturit.com"

https://api.sandbox.signaturit.com/v3/contacts/e6125099-871e-11e6-88d5-06875124f8dd.json


{ "created_at": "2016-09-30T15:02:02+0000", "email": "john.smith@signaturit.com", "name": "John Doe", "id": "e6125099-871e-11e6-88d5-06875124f8dd" }

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.update_contact('e6125099-871e-11e6-88d5-06875124f8dd', { :email => 'john.smith@signaturit.com' })


{ "created_at": "2016-09-30T15:02:02+0000", "email": "john.smith@signaturit.com", "name": "John Doe", "id": "e6125099-871e-11e6-88d5-06875124f8dd" }

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.update_contact(contact_id='e6125099-871e-11e6-88d5-06875124f8dd', email='john.smith@signaturit.com')


{ "created_at": "2016-09-30T15:02:02+0000", "email": "john.smith@signaturit.com", "name": "John Doe", "id": "e6125099-871e-11e6-88d5-06875124f8dd" }

$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');

$client->updateContact('e6125099-871e-11e6-88d5-06875124f8dd', 'john.smith@signaturit.com', null);


{ "created_at": "2016-09-30T15:02:02+0000", "email": "john.smith@signaturit.com", "name": "John Doe", "id": "e6125099-871e-11e6-88d5-06875124f8dd" }

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.updateContact('e6125099-871e-11e6-88d5-06875124f8dd', 'john.smith@signaturit.com', null);


{ "created_at": "2016-09-30T15:02:02+0000", "email": "john.smith@signaturit.com", "name": "John Doe", "id": "e6125099-871e-11e6-88d5-06875124f8dd" }

Client client = new Client("YOUR_ACCESS_TOKEN", false);

client.updateContact("e6125099-871e-11e6-88d5-06875124f8dd", "john.smith@signaturit.com", null);


{ "created_at": "2016-09-30T15:02:02+0000", "email": "john.smith@signaturit.com", "name": "John Doe", "id": "e6125099-871e-11e6-88d5-06875124f8dd" }

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.updateContact("e6125099-871e-11e6-88d5-06875124f8dd", "john.smith@signaturit.com", null);


{ "created_at": "2016-09-30T15:02:02+0000", "email": "john.smith@signaturit.com", "name": "John Doe", "id": "e6125099-871e-11e6-88d5-06875124f8dd" }

DELETE /v3/contacts/id.(json | xml)

Description

Delete a current contact.

Example request

$ curl

-X DELETE

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

https://api.sandbox.signaturit.com/v3/contacts/e6125099-871e-11e6-88d5-06875124f8dd.json


[]

client = SignaturitClient.new('YOUR_ACCESS_TOKEN')

client.delete_contact('e6125099-871e-11e6-88d5-06875124f8dd')


[]

client = SignaturitClient('YOUR_ACCESS_TOKEN')

client.delete_contact('e6125099-871e-11e6-88d5-06875124f8dd')


[]

$client = SignaturitClient('YOUR_ACCESS_TOKEN');

$client->deleteContact('e6125099-871e-11e6-88d5-06875124f8dd');


[]

client = new SignaturitClient('YOUR_ACCESS_TOKEN');

client.deleteContact('e6125099-871e-11e6-88d5-06875124f8dd');


[]

Client client = new Client("YOUR_ACCESS_TOKEN", false);

client.deleteContact("e6125099-871e-11e6-88d5-06875124f8dd");


[]

Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);

client.deleteContact("e6125099-871e-11e6-88d5-06875124f8dd");


[]