Signaturit for Developers.

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

1

Register

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

2

Authenticate

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

3

Start signing

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

Sandbox

In order to test the API thoroughly, we offer you 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==1.0.0

  • 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.0.9</version>

      </dependency>

    • Gradle

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

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.

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
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.
reminder_sms_processed
The reminder sms has been processed.
reminder_sms_delivered
The reminder 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.
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 returned will be the ones who are sent at this date or later. The format of this value should be YYYY-MM-DD. 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 }

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. 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
data
Here you can set your own data, to filter requests using your own params. If you have a custom data field named crm_id, then you must do the query using the key data.crm_id. OPTIONAL
Response

A list of signature requests in JSON or XML format.

Example request

$ curl

-X GET

-H "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" }]
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, 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, 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, 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>();

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

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" }]

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" }

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.

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

You can set it 0 to disable reminders (not recommended).

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

require_audio

A single number or a list with the number of required audio 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 audio files in every document.

require_audio=5

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

require_audio=[2, 5]

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 audio 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 audio files for the second one.

require_photo_id=[2, 5]

require_signature_in_coordinates

A list of values with the information to set the correct placement for the signature. OPTIONAL

Example to require signature in page 1 at top 80% and left 10% height 10% and width 25% and signature in page 3 at top 60% and left 10% width 10% and height 25%.

require_signature_in_coordinates = [{

"top": 80,

"left": 10,

"height": 10,

"width": 25

}, {}, {

"top": 60,

"left": 10,

"height": 10,

"width": 25

}]

require_sms_validation

A boolean with a true value 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.

Note: this parameter only works with signatures type = simple.

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.

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.
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" }
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" }
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" }
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");

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

data.put("crm_id", 2445);

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" }

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": "email_reminder_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_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": "email_reminder_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_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": "email_reminder_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->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": "email_reminder_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.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": "email_reminder_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.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": "email_reminder_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.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": "email_reminder_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.

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" }

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", documentId: "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");

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", documentId: "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");

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": "email_reminder_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": "email_reminder_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
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.
reminder_sms_processed
The reminder sms has been processed.
reminder_sms_delivered
The reminder 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.
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.

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" }]

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.
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", "data": [], "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
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 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 }

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

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" }]

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" }

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
data
Custom information in a key: value format that you can include in 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> 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.createEmail(filePath, 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" }
Example request using a custom data

$ 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"

-F "data[crm_id]=2445"

https://api.sandbox.signaturit.com/v3/emails.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", "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_email_request('/path/to/the/pdf/document.pdf', { :name => 'John', :email => 'john.doe@gmail.com' }, { :subject => "Please, read this document", :body => "Hey! Please read this, in order to test our integration.", :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", "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_email_request([], { 'name': 'John', 'email': 'john.doe@gmail.com' }, { 'subject': 'Please, read this document', 'body': 'Hey! Please read this, in order to test our integration.', '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", "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->createEmailRequest( [], [ 'name' => 'John', 'email' => 'john.doe@gmail.com' ], [ 'subject' => 'Please, read this document', 'body' => 'Hey! Please read this, in order to test our integration.', '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", "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.createEmailRequest('', { name: 'John', email: 'john.doe@gmail.com' }, { subject: 'Please, read this document', body: 'Hey! Please read this, in order to test our integration.', 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", "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 = []

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

client.createEmail([], recipients: signer, subject: "Please, read this document", body: "Hey! Please read this, in order to test our integration.", 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", "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>();

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.createEmail(filePath, recipients, "Please, read this document", "Hey! Please read this, in order to test our integration.");


{ "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", "size": 72218 }, "id": "9781f42d-2910-11e4-b3d4-0aa7697eb409", "name": "John", "status": "ready" }, "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", documentId: "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");

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.
documents_opened
The document overview has been opened.
document_opened
The document has been opened.
document_downloaded
The document has been downloaded.

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:

sign_button
Sign button text.
send_button
Send button text.
photo
Tells user that a photo is needed in the current process.
voice
Tells user that a voice record is needed in the current process.
multi_page
Tells user the number of pages to sign.
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.
templates

The template content for the emails sent to the user.

The available templates are:

signatures_request
This template is the one the user receives when you send him a document to sign.
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.
emails_request
This template is the one the user receives when you send him a document through certified emails.

The submitted HTML file can use some magic words:

{{sender_email}}
Tag replace by the sender email.
{{sign_button}}
Tag replaced by the signaturit button. This tag only can be used in signatures_request and pending_sign templates.
{{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.
{{logo}}
This tag is replaced by the current logo.
{{remaining_time}}
Show the remaining time for a document before its expiration. This tag can only be used in pending_sign template.
{{email_body}}
Tag replaced by the body parameter text. This tag only can be used in signatures_request template.
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" }]

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" }

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:

sign_button
Sign button text.
send_button
Send button text.
photo
Tells user that a photo is needed in the current process.
voice
Tells user that a voice record is needed in the current process.
multi_page
Tells user the number of pages to sign.
terms_and_conditions
Text that follow our terms text (html code is allowed).
layout_color
Primary element color. OPTIONAL
logo
The logo sent in emails (base64 encoded). OPTIONAL
templates

The template content for the emails sent to the user.

The available templates are:

signatures_request
This template is the one the user receives when you send him a document to sign.
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.
emails_request
This template is the one the user receives when you send him a document through certified emails.

The submitted HTML file can use some magic words:

{{sender_email}}
Tag replace by the sender email.
{{sign_button}}
Tag replaced by the signaturit button. This tag only can be used in signatures_request and pending_sign templates.
{{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.
{{logo}}
This tag is replaced by the current logo.
{{remaining_time}}
Show the remaining time for a document before its expiration. This tag can only be used in pending_sign template.
{{email_body}}
Tag replaced by the body parameter text. This tag only can be used in signatures_request template.
text_color
Primary text color. 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"

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 applicationTextColors = new HashMap();

applicationText.put("send_button", "Sign");

HashMap parameters = new HashMap();

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" }

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" }, "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" }, "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" }, "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" }, "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" }, "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" }, "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 applicationTextColors = new HashMap();

applicationText.put("send_button", "Sign again!");

HashMap parameters = new HashMap();

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" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#FAAC58", "templates": [], "text_color": "#B43104" }

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)
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"

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" } }