Signaturit is a scalable and reliable digital signature solution. Our Customer Success team will help you in your integration efforts and to answer any questions that you may have.
Go to your user panel to get the access token you will need to attach to every request.
The functionalities contained in this page (API for developers guide) are supported by Signaturit Solutions, S.L.U., ensuring their correct performance and operation. Any other functionality developed through the API that is not included in this guide is not officially supported by Signaturit and its use and implementation shall be the responsibility of the customer, assuming any risks that may be incurred by this for both internal and external users
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.
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'
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
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.
$ pip install signaturit_sdk
$ gem install signaturit-sdk -v 1.0.0
$ composer require signaturit/signaturit-sdk 1.0.0
$ npm install signaturit-sdk@1.0.0
Cocoapods
pod 'Signaturit'
Maven
<dependency>
<groupId>com.signaturit.api</groupId>
<artifactId>java-sdk</artifactId>
<version>1.1.6</version>
</dependency>
Gradle
compile 'com.signaturit.api:java-sdk:1.1.6'
PM> Install-Package Signaturit
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.
Events sent in embedded integrations.
The fired event type.
When your api request returns a 40x error, we inform you about the error in the same response.
The way to deal with this response error message, is different in every language.
$ curl
-X POST
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/signatures.json
begin
client.create_signature(file, recipients)
rescue Exception => exception
puts exception.response
end
print client.create_signature(files, recipients, params)
echo $client->createSignature($files, $recipients);
client.createSignature(file, recipients).then(function () {
// success result
}, function (error) {
console.log(error)
})
client.createSignature([file!], recipients: recipients, params: params, successHandler: { response in
print(response)
})
try {
Response response = client.createSignature(files, recipients, options);
Log.w("debug", response.body().string());
} catch (IOException exception) {
exception.printStackTrace();
}
try {
dynamic response = client.createSignature(files, recipients, options);
System.Console.WriteLine(response);
}
catch (System.AggregateException e) {
FlurlHttpException exception = (FlurlHttpException) e.InnerException;
System.Console.WriteLine(exception.GetResponseString());
}
We recommend you to create your Signaturit integration in our Sandbox environment.
Once completed, you may want to release your integration to the Production environment.
How to do that, depends in the way you interact with our API.
If your integrations executes HTTP requests to our server directly (with cURL for example), you will need to change the endpoint URL to https://api.signaturit.com and the Access Token for the one you will find in your Production Enterprise Account.
If you are using one of our SDKs, the Signaturit object creation, accepts a second parameter (boolean). When this parameter is false (the default value), the requests are done to our Sandbox environment. When this parameter is true, the requests are done to our Production environment. Remember to change your Access Token too.
sandbox
$ curl
-X GET
-H "Authorization: Bearer YOUR_SANDBOX_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/signatures/count.json
production
$ curl
-X GET
-H "Authorization: Bearer YOUR_PRODUCTION_ACCESS_TOKEN"
https://api.signaturit.com/v3/signatures/count.json
sandbox
client = SignaturitClient.new('YOUR_SANDBOX_ACCESS_TOKEN')
production
client = SignaturitClient.new('YOUR_PRODUCTION_ACCESS_TOKEN', true)
sandbox
client = SignaturitClient('YOUR_SANDBOX_ACCESS_TOKEN')
production
client = SignaturitClient('YOUR_PRODUCTION_ACCESS_TOKEN', true)
sandbox
$client = new Signaturit\Client('YOUR_SANDBOX_ACCESS_TOKEN');
production
$client = new Signaturit\Client('YOUR_PRODUCTION_ACCESS_TOKEN', true);
sandbox
client = new SignaturitClient('YOUR_SANDBOX_ACCESS_TOKEN');
production
client = new SignaturitClient('YOUR_PRODUCTION_ACCESS_TOKEN', true);
sandbox
let client: Signaturit = Signaturit(accessToken: "YOUR_SANDBOX_ACCESS_TOKEN", production: false)
production
let client: Signaturit = Signaturit(accessToken: "YOUR_PRODUCTION_ACCESS_TOKEN", production: true)
sandbox
Client client = new Client("YOUR_SANDBOX_ACCESS_TOKEN", false);
production
Client client = new Client("YOUR_PRODUCTION_ACCESS_TOKEN", true);
sandbox
Signaturit.Client client = new Signaturit.Client("YOUR_SANDBOX_ACCESS_TOKEN", false);
production
Signaturit.Client client = new Signaturit.Client("YOUR_PRODUCTION_ACCESS_TOKEN", true);
A signature represents a request to one or more signers with one or more 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:
A list of events related with the document.
Inside every event item you can find the next information:
The event type.
The available types are:
The file information.
Inside the file item you can find the next information:
The document status.
The available status are:
Count signature requests.
Filter signatures with documents with certain status. OPTIONAL
The available status are:
Total of signature requests in JSON or XML format.
$ curl
-X GET
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/signatures/count.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.count_signatures
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.count_signatures()
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->countSignatures();
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.countSignatures();
let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)
client.countSignatures()
Client client = new Client("YOUR_ACCESS_TOKEN", false);
client.countSignatures();
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.countSignatures();
Get all signature requests.
Filter signatures with documents with certain status. OPTIONAL
The available status are:
A list of signature requests in JSON or XML format.
$ curl
-X GET
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/signatures.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.get_signatures
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.get_signatures()
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->getSignatures();
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.getSignatures();
let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)
client.getSignatures()
Client client = new Client("YOUR_ACCESS_TOKEN", false);
client.getSignatures();
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.getSignatures();
$ curl
-X GET
-H 'Authorization: Bearer YOUR_ACCESS_TOKEN'
https://api.sandbox.signaturit.com/v3/signatures.json?crm_id=2445
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.get_signatures(nil, nil, { :crm_id => 2445 })
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.get_signatures(conditions={'crm_id': 2445'})
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->getSignatures(null, null, [ 'crm_id' => 2445 ]);
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.getSignatures(null, null, { crm_id: 2445 });
let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)
client.getSignatures(["crm_id": "2445"])
Client client = new Client("YOUR_ACCESS_TOKEN", false);
HashMap<String, Object> parameters = new HashMap<String, Object>();
HashMap<String, String> dataParam = new HashMap<String, String>();
dataParam.put("crm_id", "2445");
parameters.put("data", dataParam);
client.getSignatures(parameters);
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.getSignatures(100, 0, new { crm_id = "2445" })
*Only if a signer declines the signature, the field decliner_email will appear in the given response.
Get a given signature request.
Single signature request in JSON or XML format.
$ curl
-X GET
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/signatures/6f6c974e-2910-11e4-b3d4-0aa7697eb409.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.get_signature('6f6c974e-2910-11e4-b3d4-0aa7697eb409')
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.get_signature('6f6c974e-2910-11e4-b3d4-0aa7697eb409')
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->getSignature('6f6c974e-2910-11e4-b3d4-0aa7697eb409');
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.getSignature('6f6c974e-2910-11e4-b3d4-0aa7697eb409');
let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)
client.getSignature("6f6c974e-2910-11e4-b3d4-0aa7697eb409")
Client client = new Client("YOUR_ACCESS_TOKEN", false);
client.getSignature("6f6c974e-2910-11e4-b3d4-0aa7697eb409");
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.getSignature("6f6c974e-2910-11e4-b3d4-0aa7697eb409");
*Only if a signer declines the signature, the field decliner_email will appear in the given response.
Create a new signature request.
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
Custom information in a key: value format that you can include in the signature request. OPTIONAL
When the key values correspond to a PDF form field, it will be filled and stamped automatically to the document.
When the key values correspond to a Signaturit template widget field, it will be filled by default to the signer in app and the signer will be allowed to modify the value.
All other key:value pairs will be stored in the signature and can be used later as search criteria on the "Get Signatures" endpoint described above. The maximum length allowed for these fields is 64 characters.
The signature request delivery type. OPTIONAL
The available delivery types are:
Expiration time of the document (in days). OPTIONAL
It must be a positive number and can't be greater than 365 days.
URL that receive realtime information about this signature process. OPTIONAL
See the signatures event url section for more information.
List with signature recipients containing name, email and extra requirements for the signature process if needed.
The index of the array recipients does not indicate their order.
Every item can contain the next information:
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.
A boolean (1 or 0) which indicates if the sign must be signed with digital certificate. You must add a widget with type dcf in order to use this option
Text which indicates the name of the digital certificate to be used.
* Certificates extension files must be .pfx or .p12.
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]
A single number or a list with the number of required photos you need for every document in this recipient. OPTIONAL
The index of the list references the document number, so first value will apply to first document.
Example to require 5 photos in every document.
require_photo=5
Example to require 2 photos for the first document and 5 photo files for the second one.
require_photo=[2, 5]
A single number or a list with the number of required photo ids you need for every document in this recipient. OPTIONAL
The index of the list references the document number, so first value will apply to first document.
Example to require 5 photos ids in every document.
require_photo_id=5
Example to require 2 photos ids for the first document and 5 photo files for the second one.
require_photo_id=[2, 5]
If you want to assign widgets to signer, you can specify them too.
Every widget must be set using the following parameters:
A boolean (0 or 1) to enable a password in the document that will be sent as an SMS to the recipient's phone. OPTIONAL
If you use this feature, you will need to set the phone parameter in the recipient item.
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.
A string that define the recipient type. OPTIONAL
Note: the default value is signer.
Possible values are:
List with email recipients containing name and email for people that will receive a copy of the signed document when the process is completed. OPTIONAL
Every item can contain the next information:
Additional email address that will be used as email Reply-To header OPTIONAL
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.
The signing mode lets you control the order in which your recipients receive and sign your documents OPTIONAL
Note: the default value is sequential.
The available signing modes are:
The type of the signature. OPTIONAL
Note: the default value is the advanced signature request.
The available types are:
New signature request in JSON or XML format.
$ 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
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.create_signature(['/path/to/the/pdf/document.pdf'], { :name => 'John', :email => 'john.doe@gmail.com' })
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.create_signature(['/path/to/the/pdf/document.pdf'], { 'name': 'John', 'email': 'john.doe@gmail.com' })
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->createSignature(['/path/to/the/pdf/document.pdf'], [ 'name' => 'John', 'email' => 'john.doe@gmail.com' ]);
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.createSignature(['/path/to/the/pdf/document.pdf'], { name: 'John', email: 'john.doe@gmail.com' } );
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
})
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);
var recipients = new [] {
new { name = "John" , email = "john.doe@gmail.com"}
};
var files = new [] {
"/path/to/the/pdf/document.pdf"
};
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.createSignature(files, recipients, null);
$ 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
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.create_signature('/path/to/the/pdf/document.pdf', { :name => 'John', :email => 'john.doe@gmail.com' }, { :templates => ['#NDA'] })
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.create_signature([], { 'name': 'John', 'email': 'john.doe@gmail.com' }, { 'templates': ['#NDA'] })
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->createSignature( [], [ 'name' => 'John', 'email' => 'john.doe@gmail.com' ), [ 'templates' => ['#NDA'] ] ];
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.createSignature('', { name: 'John', email: 'john.doe@gmail.com' }, { templates: '#NDA' });
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
})
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);
var recipients = new [] {
new { name = "John" , email = "john.doe@gmail.com"}
};
var parameters = new { templates = "#NDA" };
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.createSignature(null, recipients, parameters);
$ 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
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'] })
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.create_signature([], { 'name': 'John', 'email': 'john.doe@gmail.com' }, { 'templates': ['#NDA'], 'data': ['WIDGET_ID': 'DEFAULT_VALUE'] })
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->createSignature( [], [ 'name' => 'John', 'email' => 'john.doe@gmail.com' ], [ 'templates' => ['#NDA'], 'data' => ['WIDGET_ID' => 'DEFAULT_DATA'] ] );
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.createSignature('', { name: 'John', email: 'john.doe@gmail.com' }, { templates: '#NDA', data: { 'WIDGET_ID': 'DEFAULT_VALUE' } });
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
})
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);
var recipients = new [] {
new { name = "John" , email = "john.doe@gmail.com"}
};
var parameters = new { templates = "#NDA", data = new { WIDGET_ID = "DEFAULT_NODE" } };
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.createSignature(null, recipients, parameters);
$ 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
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 } })
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.create_signature([], { 'name': 'John', 'email': 'john.doe@gmail.com' }, { 'templates': ['#NDA'], 'data': { 'crm_id': 2445 } })
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->createSignature( [], [ 'name' => 'John', 'email' => 'john.doe@gmail.com' ], [ 'templates' => ['#NDA'], 'data' => [ 'crm_id' => 2445 ] ] );
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.createSignature('', { name: 'John', email: 'john.doe@gmail.com' }, { templates: '#NDA', data: { crm_id: 2445 } });
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
})
Client client = new Client("YOUR_ACCESS_TOKEN", false);
ArrayList<File> filePath = new ArrayList<File>();
ArrayList<HashMap<String, Object>> recipients = new ArrayList<HashMap<String,Object>>();
HashMap<String, Object> recipient= new HashMap<String, Object>();
recipient.put("email", "john.doe@gmail.com");
recipient.put("fullname", "John");
recipients.add(recipient);
HashMap<String, Object> data = new HashMap<String, Object>();
data.put("WIDGET_ID", "DEFAULT_VALUE");
data.put("crm_id", 2445);
HashMap<String, Object> parameters = new HashMap<String, Object>();
parameters.put("templates", "#NDA");
parameters.put("data", data);
Response response = client.createSignature(filePath, recipients, parameters);
var recipients = new [] {
new { name = "John" , email = "john.doe@gmail.com"}
};
var parameters = new { templates = "#NDA", data = new { crm_id = "2445" } };
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.createSignature(null, recipients, parameters);
$ curl
-X POST
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
-F "recipients[0][name]=John"
-F "recipients[0][email]=john.doe@gmail.com"
-F "recipients[0][widgets][0][default]=This is a non-editable text"
-F "recipients[0][widgets][0][page]=1"
-F "recipients[0][widgets][0][left]=71.10583280773"
-F "recipients[0][widgets][0][top]=1.5"
-F "recipients[0][widgets][0][type]=text"
-F "recipients[0][widgets][0][height]=5"
-F "recipients[0][widgets][0][width]=30"
-F "recipients[0][widgets][0][editable]=0"
-F "recipients[0][widgets][1][default]=This is an editable text"
-F "recipients[0][widgets][1][page]=1"
-F "recipients[0][widgets][1][left]=31.10583280773"
-F "recipients[0][widgets][1][top]=1.5"
-F "recipients[0][widgets][1][type]=text"
-F "recipients[0][widgets][1][height]=5"
-F "recipients[0][widgets][1][width]=30"
-F "recipients[0][widgets][1][editable]=1"
-F "recipients[0][widgets][2][default]=0"
-F "recipients[0][widgets][2][page]=1"
-F "recipients[0][widgets][2][left]=31.10583280773"
-F "recipients[0][widgets][2][top]=10"
-F "recipients[0][widgets][2][type]=check"
-F "recipients[0][widgets][2][height]=5"
-F "recipients[0][widgets][2][width]=5"
-F "recipients[0][widgets][2][editable]=0"
-F "recipients[0][widgets][3][default]=1"
-F "recipients[0][widgets][3][page]=1"
-F "recipients[0][widgets][3][left]=41.10583280773"
-F "recipients[0][widgets][3][top]=10"
-F "recipients[0][widgets][3][type]=check"
-F "recipients[0][widgets][3][height]=5"
-F "recipients[0][widgets][3][width]=5"
-F "recipients[0][widgets][3][editable]=0"
-F "recipients[0][widgets][4][default]=1"
-F "recipients[0][widgets][4][page]=1"
-F "recipients[0][widgets][4][left]=71.10583280773"
-F "recipients[0][widgets][4][top]=10"
-F "recipients[0][widgets][4][type]=check"
-F "recipients[0][widgets][4][height]=5"
-F "recipients[0][widgets][4][width]=5"
-F "recipients[0][widgets][4][editable]=1"
-F "recipients[0][widgets][4][options]=show_yes_no_option"
-F "recipients[0][widgets][5][default]=0"
-F "recipients[0][widgets][5][page]=1"
-F "recipients[0][widgets][5][left]=31.10583280773"
-F "recipients[0][widgets][5][top]=20"
-F "recipients[0][widgets][5][type]=radio"
-F "recipients[0][widgets][5][height]=5"
-F "recipients[0][widgets][5][width]=5"
-F "recipients[0][widgets][5][editable]=1"
-F "recipients[0][widgets][5][custom_id]=radio_01"
-F "recipients[0][widgets][5][options][index]=0"
-F "recipients[0][widgets][6][default]=0"
-F "recipients[0][widgets][6][page]=1"
-F "recipients[0][widgets][6][left]=41.10583280773"
-F "recipients[0][widgets][6][top]=20"
-F "recipients[0][widgets][6][type]=radio"
-F "recipients[0][widgets][6][height]=5"
-F "recipients[0][widgets][6][width]=5"
-F "recipients[0][widgets][6][editable]=1"
-F "recipients[0][widgets][6][custom_id]=radio_01"
-F "recipients[0][widgets][6][options][index]=1"
-F "recipients[0][widgets][7][default]=0"
-F "recipients[0][widgets][7][page]=1"
-F "recipients[0][widgets][7][left]=31.10583280773"
-F "recipients[0][widgets][7][top]=25"
-F "recipients[0][widgets][7][type]=radio"
-F "recipients[0][widgets][7][height]=5"
-F "recipients[0][widgets][7][width]=5"
-F "recipients[0][widgets][7][editable]=1"
-F "recipients[0][widgets][7][custom_id]=radio_01"
-F "recipients[0][widgets][7][options][index]=2"
-F "recipients[0][widgets][8][default]=0"
-F "recipients[0][widgets][8][page]=1"
-F "recipients[0][widgets][8][left]=41.10583280773"
-F "recipients[0][widgets][8][top]=25"
-F "recipients[0][widgets][8][type]=radio"
-F "recipients[0][widgets][8][height]=5"
-F "recipients[0][widgets][8][width]=5"
-F "recipients[0][widgets][8][editable]=0"
-F "recipients[0][widgets][8][custom_id]=radio_02"
-F "recipients[0][widgets][8][options][index]=0"
-F "recipients[0][widgets][9][default]=0"
-F "recipients[0][widgets][9][page]=1"
-F "recipients[0][widgets][9][left]=51.10583280773"
-F "recipients[0][widgets][9][top]=25"
-F "recipients[0][widgets][9][type]=radio"
-F "recipients[0][widgets][9][height]=5"
-F "recipients[0][widgets][9][width]=5"
-F "recipients[0][widgets][9][editable]=0"
-F "recipients[0][widgets][9][custom_id]=radio_02"
-F "recipients[0][widgets][9][options][index]=1"
-F "recipients[0][widgets][10][default]=0"
-F "recipients[0][widgets][10][page]=1"
-F "recipients[0][widgets][10][left]=41.10583280773"
-F "recipients[0][widgets][10][top]=30"
-F "recipients[0][widgets][10][type]=select"
-F "recipients[0][widgets][10][height]=5"
-F "recipients[0][widgets][10][width]=50"
-F "recipients[0][widgets][10][editable]=1"
-F "recipients[0][widgets][10][options][select][0][value]=option A"
-F "recipients[0][widgets][10][options][select][0][default]=1"
-F "recipients[0][widgets][10][options][select][1][value]=option B"
-F "recipients[0][widgets][10][options][select][1][default]=0"
-F "recipients[0][widgets][11][default]=0"
-F "recipients[0][widgets][11][page]=1"
-F "recipients[0][widgets][11][left]=50"
-F "recipients[0][widgets][11][top]=90"
-F "recipients[0][widgets][11][type]=signature"
-F "recipients[0][widgets][11][height]=9.9784615384615"
-F "recipients[0][widgets][11][width]=25"
-F "recipients[0][widgets][12][default]=2017-07-27"
-F "recipients[0][widgets][12][page]=1"
-F "recipients[0][widgets][12][left]=35"
-F "recipients[0][widgets][12][top]=1.5"
-F "recipients[0][widgets][12][type]=date"
-F "recipients[0][widgets][12][height]=5"
-F "recipients[0][widgets][12][width]=30"
-F "recipients[0][widgets][13][page]=1"
-F "recipients[0][widgets][13][left]=20"
-F "recipients[0][widgets][13][top]=5"
-F "recipients[0][widgets][13][type]=text"
-F "recipients[0][widgets][13][height]=5"
-F "recipients[0][widgets][13][width]=30"
-F "recipients[0][widgets][13][editable]=1"
-F "recipients[0][widgets][13][options][validation_rule]=email"
-F "files[0]=nda.pdf"
https://api.sandbox.signaturit.com/v3/signatures.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.create_signature( 'nda.pdf', { :email => 'signer@signaturit.com', :name => 'signer', :widgets => [ { :default => 'This is a non-editable text', :page => 1, :part => 0, :left => 71.10583280773, :top => 1.5, :type => 'text', :height => 5, :width => 30, :editable => 0 }, { :default => 'This is a editable text', :page => 1, :part => 0, :left => 31.10583280773, :top => 1.5, :type => 'text', :height => 1.9956923076923, :width => 17, :editable => 1 }, { :default => 0, :page => 1, :part => 0, :left => 31.10583280773, :top => 10, :type => 'check', :height => 5, :width => 5, :editable => 0 }, { :default => 1, :page => 1, :part => 0, :left => 41.10583280773, :top => 10, :type => 'check', :height => 5, :width => 5, :editable => 0 }, { :default => 1, :page => 1, :part => 0, :left => 71.10583280773, :top => 10, :type => 'check', :height => 5, :width => 5, :editable => 1, :options => 'show_yes_no_option', }, { :default => 0, :page => 1, :part => 0, :left => 31.10583280773, :top => 20, :type => 'radio', :height => 5, :width => 5, :editable => 1, :options => { :id => 'radio_01', :index => 0, } }, { :default => 0, :page => 1, :part => 0, :left => 41.10583280773, :top => 20, :type => 'radio', :height => 5, :width => 5, :editable => 1, :options => { :id => 'radio_01', :index => 1 } }, { :default => 0, :page => 1, :part => 0, :left => 31.10583280773, :top => 25, :type => 'radio', :height => 5, :width => 5, :editable => 1, :options => { :id => 'radio_01', :index => 2, } }, { :default => 0, :page => 1, :part => 0, :left => 41.10583280773, :top => 25, :type => 'radio', :height => 5, :width => 5, :editable => 0, :options => { :id => 'radio_02', :index => 0 } }, { :default => 0, :page => 1, :part => 0, :left => 51.10583280773, :top => 25, :type => 'radio', :height => 5, :width => 5, :editable => 0, :options => { :id => 'radio_02', :index => 1 } }, { :default => 0, :page => 1, :part => 0, :left => 41.10583280773, :top => 30, :type => 'select', :height => 5, :width => 50, :editable => 1, :options => { :select => [ { :value => 'option A', :default => 1, }, { :value => 'option B', :default => 0 } ] } }, { :height => 9.9784615384615, :page => 1, :part => 0, :left => 50, :top => 90, :type => 'signature', :width => 25 }, { :page => 1, :part => 0, :left => 20, :top => 5, :type => 'text', :height => 5, :width => 30, :editable => 1, :options => { :validation_rule => 'email' } } } )
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.create_signature( ['nda.pdf'], [ { 'email': 'signer@signaturit.com', 'name': 'signer', 'widgets': [ { 'default': 'This is a non-editable text', 'page': 1, 'part': 0, 'left': 71.10583280773, 'top': 1.5, 'type': 'text', 'height': 5, 'width': 30, 'editable': 0 }, { 'default': 'This is a editable text', 'page': 1, 'part': 0, 'left': 31.10583280773, 'top': 1.5, 'type': 'text', 'height': 1.9956923076923, 'width': 17, 'editable': 1 }, { 'default': 0, 'page': 1, 'part': 0, 'left': 31.10583280773, 'top': 10, 'type': 'check', 'height': 5, 'width': 5, 'editable': 0 }, { 'default': 1, 'page': 1, 'part': 0, 'left': 41.10583280773, 'top': 10, 'type': 'check', 'height': 5, 'width': 5, 'editable': 0 }, { 'default': 1, 'page': 1, 'part': 0, 'left': 71.10583280773, 'top': 10, 'type': 'check', 'height': 5, 'width': 5, 'editable': 1, 'options': 'show_yes_no_option' }, { 'default': 0, 'page': 1, 'part': 0, 'left': 31.10583280773, 'top': 20, 'type': 'radio', 'height': 5, 'width': 5, 'editable': 1, 'options': { 'id': 'radio_01', 'index': 0, } }, { 'default': 0, 'page': 1, 'part': 0, 'left': 41.10583280773, 'top': 20, 'type': 'radio', 'height': 5, 'width': 5, 'editable': 1, 'options': { 'id': 'radio_01', 'index': 1 } }, { 'default': 0, 'page': 1, 'part': 0, 'left': 31.10583280773, 'top': 25, 'type': 'radio', 'height': 5, 'width': 5, 'editable': 1, 'options': { 'id': 'radio_01', 'index': 2, } }, { 'default': 0, 'page': 1, 'part': 0, 'left': 41.10583280773, 'top': 25, 'type': 'radio', 'height': 5, 'width': 5, 'editable': 0, 'options': { 'id': 'radio_02', 'index': 0 } }, { 'default': 0, 'page': 1, 'part': 0, 'left': 51.10583280773, 'top': 25, 'type': 'radio', 'height': 5, 'width': 5, 'editable': 0, 'options': { 'id': 'radio_02', 'index': 1 } }, { 'default': 0, 'page': 1, 'part': 0, 'left': 41.10583280773, 'top': 30, 'type': 'select', 'height': 5, 'width': 50, 'editable': 1, 'options': { 'select': [ { 'value': 'option A', 'default': 1, }, { 'value': 'option B', 'default': 0 } ] } }, { 'height': 9.9784615384615, 'page': 1, 'part': 0, 'left': 50, 'top': 90, 'type': 'signature', 'width': 25 }, { 'page': 1, 'part': 0, 'left': 20, 'top': 5, 'type': 'text', 'height': 5, 'width': 30, 'editable': 1, 'options': { 'validation_rule': 'email' } }, ] } ] )
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->createSignature( 'nda.pdf', [ [ 'email' => 'signer@signaturit.com', 'name' => 'signer', 'widgets' => [ [ 'default' => 'This is a non-editable text', 'page' => 1, 'part' => 0, 'left' => 71.10583280773, 'top' => 1.5, 'type' => 'text', 'height' => 5, 'width' => 30, 'editable' => 0 ], [ 'default' => 'This is a editable text', 'page' => 1, 'part' => 0, 'left' => 31.10583280773, 'top' => 1.5, 'type' => 'text', 'height' => 1.9956923076923, 'width' => 17, 'editable' => 1 ], [ 'default' => 0, 'page' => 1, 'part' => 0, 'left' => 31.10583280773, 'top' => 10, 'type' => 'check', 'height' => 5, 'width' => 5, 'editable' => 0 ], [ 'default' => 1, 'page' => 1, 'part' => 0, 'left' => 41.10583280773, 'top' => 10, 'type' => 'check', 'height' => 5, 'width' => 5, 'editable' => 0 ], [ 'default' => 1, 'page' => 1, 'part' => 0, 'left' => 71.10583280773, 'top' => 10, 'type' => 'check', 'height' => 5, 'width' => 5, 'editable' => 1, 'options' => 'show_yes_no_option' ], [ 'default' => 0, 'page' => 1, 'part' => 0, 'left' => 31.10583280773, 'top' => 20, 'type' => 'radio', 'height' => 5, 'width' => 5, 'editable' => 1, 'options' => [ 'id' => 'radio_01', 'index' => 0, ] ], [ 'default' => 0, 'page' => 1, 'part' => 0, 'left' => 41.10583280773, 'top' => 20, 'type' => 'radio', 'height' => 5, 'width' => 5, 'editable' => 1, 'options' => [ 'id' => 'radio_01', 'index' => 1 ] ], [ 'default' => 0, 'page' => 1, 'part' => 0, 'left' => 31.10583280773, 'top' => 25, 'type' => 'radio', 'height' => 5, 'width' => 5, 'editable' => 1, 'options' => [ 'id' => 'radio_01', 'index' => 2, ] ], [ 'default' => 0, 'page' => 1, 'part' => 0, 'left' => 41.10583280773, 'top' => 25, 'type' => 'radio', 'height' => 5, 'width' => 5, 'editable' => 0, 'options' => [ 'id' => 'radio_02', 'index' => 0 ] ], [ 'default' => 0, 'page' => 1, 'part' => 0, 'left' => 51.10583280773, 'top' => 25, 'type' => 'radio', 'height' => 5, 'width' => 5, 'editable' => 0, 'options' => [ 'id' => 'radio_02', 'index' => 1 ] ], [ 'default' => 0, 'page' => 1, 'part' => 0, 'left' => 41.10583280773, 'top' => 30, 'type' => 'select', 'height' => 5, 'width' => 50, 'editable' => 1, 'options' => [ 'select' => [ [ 'value' => 'option A', 'default' => 1, ], [ 'value' => 'option B', 'default' => 0 ] ] ] ], [ 'height' => 9.9784615384615, 'page' => 1, 'part' => 0, 'left' => 50, 'top' => 90, 'type' => 'signature', 'width' => 25 ], [ 'page' => 1, 'part' => 0, 'left' => 20, 'top' => 5, 'type' => 'text', 'height' => 5, 'width' => 30, 'editable' => 1, 'options' => [ 'validation_rule' => 'email' ] ], ] ] ] )
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.createSignature( 'nda.pdf', { email: 'signer@signaturit.com', name: 'signer', widgets: [ { default: 'This is a non-editable text', page: 1, part: 0, left: 71.10583280773, top: 1.5, type: 'text', height: 5, width: 30, editable: 0 }, { default: 'This is a editable text', page: 1, part: 0, left: 31.10583280773, top: 1.5, type: 'text', height: 1.9956923076923, width: 17, editable: 1 }, { default: 0, page: 1, part: 0, left: 31.10583280773, top: 10, type: 'check', height: 5, width: 5, editable: 0 }, { default: 1, page: 1, part: 0, left: 41.10583280773, top: 10, type: 'check', height: 5, width: 5, editable: 0 }, { default: 1, page: 1, part: 0, left: 71.10583280773, top: 10, type: 'check', height: 5, width: 5, editable: 1, options: 'show_yes_no_option' }, { default: 0, page: 1, part: 0, left: 31.10583280773, top: 20, type: 'radio', height: 5, width: 5, editable: 1, options: { id: 'radio_01', index: 0, } }, { default: 0, page: 1, part: 0, left: 41.10583280773, top: 20, type: 'radio', height: 5, width: 5, editable: 1, options: { id: 'radio_01', index: 1 } }, { default: 0, page: 1, part: 0, left: 31.10583280773, top: 25, type: 'radio', height: 5, width: 5, editable: 1, options: { id: 'radio_01', index: 2, } }, { default: 0, page: 1, part: 0, left: 41.10583280773, top: 25, type: 'radio', height: 5, width: 5, editable: 0, options: { id: 'radio_02', index: 0 } }, { default: 0, page: 1, part: 0, left: 51.10583280773, top: 25, type: 'radio', height: 5, width: 5, editable: 0, options: { id: 'radio_02', index: 1 } }, { default: 0, page: 1, part: 0, left: 41.10583280773, top: 30, type: 'select', height: 5, width: 50, editable: 1, options: { select: [ { value: 'option A', default: 1, }, { value: 'option B', default: 0 } ] } }, { height: 9.9784615384615, page: 1, part: 0, left: 50, top: 90, type: 'signature', width: 25 }, { page: 1, part: 0, left: 20, top: 5, type: 'text', height: 5, width: 30, editable: 1, options: { validation_rule: 'email' } }, } )
Client client = new Client("YOUR_ACCESS_TOKEN", false);
/* Define Documents */
ArrayList<File> documentsList = new ArrayList<File>();
File document = new File("nda.pdf");
documentsList.add(document);
/* Define Widgets */
ArrayList<Map<String, Object>> widgets = new ArrayList<Map<String, Object>>();
/* 1st Widget */
Map<String, Object> widget1 = new HashMap<String, Object>();
widget1.put("default", "This is a non-editable text");
widget1.put("page", 1);
widget1.put("part", 0);
widget1.put("left", 71.10583280773);
widget1.put("top", 1.5);
widget1.put("type", "text");
widget1.put("height", 5);
widget1.put("width", 30);
widget1.put("editable", 0);
widgets.add(widget1);
/* 2nd Widget */
Map<String, Object> widget2 = new HashMap<String, Object>();
widget2.put("default", "This is a editable text");
widget2.put("page", 1);
widget2.put("part", 0);
widget2.put("left", 31.10583280773);
widget2.put("top", 1.5);
widget2.put("type", "text");
widget2.put("height", 1.9956923076923);
widget2.put("width", 17);
widget2.put("editable", 1);
widgets.add(widget2);
/* 3rd Widget */
Map<String, Object> widget3 = new HashMap<String, Object>();
widget3.put("default", 0);
widget3.put("page", 1);
widget3.put("part", 0);
widget3.put("left", 31.10583280773);
widget3.put("top", 10);
widget3.put("type", "check");
widget3.put("height", 5);
widget3.put("width", 5);
widget3.put("editable", 0);
widgets.add(widget3);
/* 4th Widget */
Map<String, Object> widget4 = new HashMap<String, Object>();
widget4.put("default", 1);
widget4.put("page", 1);
widget4.put("part", 0);
widget4.put("left", 41.10583280773);
widget4.put("top", 10);
widget4.put("type", "check");
widget4.put("height", 5);
widget4.put("width", 5);
widget4.put("editable", 0);
widgets.add(widget4);
/* 5th Widget */
Map<String, Object> widget5 = new HashMap<String, Object>();
widget5.put("default", 1);
widget5.put("page", 1);
widget5.put("part", 0);
widget5.put("left", 71.10583280773);
widget5.put("top", 10);
widget5.put("type", "check");
widget5.put("height", 5);
widget5.put("width", 5);
widget5.put("editable", 1);
widget5.put("options", "show_yes_no_option");
widgets.add(widget5);
/* 6th Widget */
Map<String, Object> widget6 = new HashMap<String, Object>();
widget6.put("default", 0);
widget6.put("page", 1);
widget6.put("part", 0);
widget6.put("left", 31.10583280773);
widget6.put("top", 20);
widget6.put("type", "radio");
widget6.put("height", 5);
widget6.put("width", 5);
widget6.put("editable", 1);
Map<String, Object> widget6Options = new HashMap<String, Object>();
widget6Options.put("id", "radio_01");
widget6Options.put("index", 0);
widget6.put("options", widget6Options);
widgets.add(widget6);
/* 7th Widget */
Map<String, Object> widget7 = new HashMap<String, Object>();
widget7.put("default", 0);
widget7.put("page", 1);
widget7.put("part", 0);
widget7.put("left", 41.10583280773);
widget7.put("top", 20);
widget7.put("type", "radio");
widget7.put("height", 5);
widget7.put("width", 5);
widget7.put("editable", 1);
Map<String, Object> widget7Options = new HashMap<String, Object>();
widget7Options.put("id", "radio_01");
widget7Options.put("index", 1);
widget7.put("options", widget7Options);
widgets.add(widget7);
/* 8th Widget */
Map<String, Object> widget8 = new HashMap<String, Object>();
widget8.put("default", 0);
widget8.put("page", 1);
widget8.put("part", 0);
widget8.put("left", 31.10583280773);
widget8.put("top", 25);
widget8.put("type", "radio");
widget8.put("height", 5);
widget8.put("width", 5);
widget8.put("editable", 1);
Map<String, Object> widget8Options = new HashMap<String, Object>();
widget8Options.put("id", "radio_01");
widget8Options.put("index", 2);
widget8.put("options", widget8Options);
widgets.add(widget8);
/* 9th Widget */
Map<String, Object> widget9 = new HashMap<String, Object>();
widget9.put("default", 0);
widget9.put("page", 1);
widget9.put("part", 0);
widget9.put("left", 41.10583280773);
widget9.put("top", 25);
widget9.put("type", "radio");
widget9.put("height", 5);
widget9.put("width", 5);
widget9.put("editable", 0);
Map<String, Object> widget9Options = new HashMap<String, Object>();
widget9Options.put("id", "radio_02");
widget9Options.put("index", 0);
widget9.put("options", widget9Options);
widgets.add(widget9);
/* 10th Widget */
Map<String, Object> widget10 = new HashMap<String, Object>();
widget10.put("default", 0);
widget10.put("page", 1);
widget10.put("part", 0);
widget10.put("left", 51.10583280773);
widget10.put("top", 25);
widget10.put("type", "radio");
widget10.put("height", 5);
widget10.put("width", 5);
widget10.put("editable", 0);
Map<String, Object> widget10Options = new HashMap<String, Object>();
widget10Options.put("id", "radio_02");
widget10Options.put("index", 1);
widget10.put("options", widget10Options);
widgets.add(widget10);
/* 11th Widget */
Map<String, Object> widget11 = new HashMap<String, Object>();
widget11.put("default", 0);
widget11.put("page", 1);
widget11.put("part", 0);
widget11.put("left", 41.10583280773);
widget11.put("top", 30);
widget11.put("type", "select");
widget11.put("height", 5);
widget11.put("width", 50);
widget11.put("editable", 1);
Map<String, Object> widget11Options = new HashMap<String, Object>();
List<Map<String, Object>> select = new ArrayList<Map<String, Object>>();
Map<String, Object> selectOption1 = new HashMap<String, Object>();
selectOption1.put("value", "option A");
selectOption1.put("default", 1);
Map<String, Object> selectOption2 = new HashMap<String, Object>();
selectOption2.put("value", "option B");
selectOption2.put("default", 0);
select.add(selectOption1);
select.add(selectOption2);
widget11Options.put("select", select);
widget11.put("options", widget11Options);
widgets.add(widget11);
/* 12th Widget */
Map<String, Object> widget12 = new HashMap<String, Object>();
widget12.put("height", 9.9784615384615);
widget12.put("page", 1);
widget12.put("part", 0);
widget12.put("left", 50);
widget12.put("top", 90);
widget12.put("type", "signature");
widget12.put("width", 25);
widgets.add(widget12);
widget13.put("page", 1);
widget13.put("part", 0);
widget13.put("left", 20);
widget13.put("top", 5);
widget13.put("type", "text");
widget13.put("height", 5);
widget13.put("width", 30);
widget13.put("editable", 1);
Map<String, Object> widget13Options = new HashMap<String, Object>();
widget13Options.put("validation_rule", "email");
widget13.put("options", widget13Options);
widgets.add(widget13);
/* Define Recipients */
ArrayList<HashMap<String, Object>> recipientsList = new ArrayList<HashMap<String, Object>>();
HashMap<String, Object> recipient = new HashMap<String, Object>();
recipient.put("email", "signer@signaturit.com");
recipient.put("name", "signer");
recipient.put("widgets", widgets);
recipientsList.add(recipient);
/* Create Signature */
client.createSignature(documentsList, recipientsList);
$ curl
-X POST
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
-F "recipients[0][name]=John"
-F "recipients[0][email]=nonvalidemail"
-F "files[0]=@/path/to/the/pdf/document.pdf"
https://api.sandbox.signaturit.com/v3/signatures.json
$ 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/file/non_valid_file.zip"
https://api.sandbox.signaturit.com/v3/signatures.json
Send a reminder. A reminder email will be sent to the signer.
Document in JSON or XML format.
$ curl
-X POST
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/signatures/6f6c974e-2910-11e4-b3d4-0aa7697eb409/reminder.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN');
client.send_signature_reminder('6f6c974e-2910-11e4-b3d4-0aa7697eb40');
client = SignaturitClient('YOUR_ACCESS_TOKEN');
client.send_signature_reminder('6f6c974e-2910-11e4-b3d4-0aa7697eb40');
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->sendSignatureReminder('6f6c974e-2910-11e4-b3d4-0aa7697eb409');
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.sendSignatureReminder('6f6c974e-2910-11e4-b3d4-0aa7697eb409');
let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)
client.sendSignatureReminder("6f6c974e-2910-11e4-b3d4-0aa7697eb409")
Client client = new Client("YOUR_ACCESS_TOKEN");
client.sendSignatureReminder("6f6c974e-2910-11e4-b3d4-0aa7697eb409");
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.sendReminder("6f6c974e-2910-11e4-b3d4-0aa7697eb409");
Cancel a signature request. The signer will not be able to sign the document.
Reason of canceling the signature request. OPTIONAL
Note: PATCH request does not support multipart/form-data as Content-Type. Content-Type should be set to application/x-www-form-urlencoded or application/json.
Canceled signature in JSON or XML format.
$ curl
-X PATCH
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/signatures/6f6c974e-2910-11e4-b3d4-0aa7697eb409/cancel.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.cancel_signature('6f6c974e-2910-11e4-b3d4-0aa7697eb40')
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.cancel_signature('6f6c974e-2910-11e4-b3d4-0aa7697eb40')
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->cancelSignature('6f6c974e-2910-11e4-b3d4-0aa7697eb40');
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.cancelSignature('6f6c974e-2910-11e4-b3d4-0aa7697eb409');
let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)
client.cancelSignature("6f6c974e-2910-11e4-b3d4-0aa7697eb409")
Client client = new Client("YOUR_ACCESS_TOKEN");
client.cancelSignature("6f6c974e-2910-11e4-b3d4-0aa7697eb409");
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.cancelSignature("6f6c974e-2910-11e4-b3d4-0aa7697eb409");
Delete a signature request. In progress requests cannot be deleted.
$ curl
-X DELETE
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/signatures/6f6c974e-2910-11e4-b3d4-0aa7697eb409
Download the signed PDF file.
The PDF file binary content.
$ curl
-X GET
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/signatures/6f6c974e-2910-11e4-b3d4-0aa7697eb409/documents/29109781-f42d-11e4-b3d4-0aa7697eb409/download/signed
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.download_signed_document('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409')
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.download_signed_document('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409')
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->downloadSignedDocument('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409');
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.downloadSignedDocument('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409');
let destination = Alamofire.Request.suggestedDownloadDestination(directory: .DocumentDirectory, domain: .UserDomainMask)
let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)
client.downloadSignedDocument("6f6c974e-2910-11e4-b3d4-0aa7697eb409", document"id": "29109781-f42d-11e4-b3d4-0aa7697eb409", path: destination)
Client client = new Client("YOUR_ACCESS_TOKEN");
client.downloadSignedDocument("6f6c974e-2910-11e4-b3d4-0aa7697eb409", "29109781-f42d-11e4-b3d4-0aa7697eb409");
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.downloadSignedDocument("6f6c974e-2910-11e4-b3d4-0aa7697eb409", "29109781-f42d-11e4-b3d4-0aa7697eb409");
Changes the email of the signer. It creates a new document and replaces the wrong one. Only requests with an error in email delivery can be changed.
The ID of the new document.
$ curl
-X POST
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/signatures/6f6c974e-2910-11e4-b3d4-0aa7697eb409/documents/29109781-f42d-11e4-b3d4-0aa7697eb409/signer
Generates the binary content of the audit trail PDF.
Empty response.
$ curl
-X GET
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/signatures/6f6c974e-2910-11e4-b3d4-0aa7697eb409/generate/audit_trail
Changes the name of the signature.
The ID of the signature.
$ curl
-X POST
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/signatures/6f6c974e-2910-11e4-b3d4-0aa7697eb409/name
Download the binary content of the audit trail PDF.
PDF file.
$ curl
-X GET
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/signatures/6f6c974e-2910-11e4-b3d4-0aa7697eb409/documents/29109781-f42d-11e4-b3d4-0aa7697eb409/download/audit_trail
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.download_audit_trail('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409')
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.download_audit_trail('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409')
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->downloadAuditTrail('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409');
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.downloadAuditTrail('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409');
let destination = Alamofire.Request.suggestedDownloadDestination(directory: .DocumentDirectory, domain: .UserDomainMask)
let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)
client.downloadAuditTrail("6f6c974e-2910-11e4-b3d4-0aa7697eb409", document"id": "29109781-f42d-11e4-b3d4-0aa7697eb409", path: destination)
Client client = new Client("YOUR_ACCESS_TOKEN");
client.downloadAuditTrail("6f6c974e-2910-11e4-b3d4-0aa7697eb409", "29109781-f42d-11e4-b3d4-0aa7697eb409");
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.downloadAuditTrail("6f6c974e-2910-11e4-b3d4-0aa7697eb409", "29109781-f42d-11e4-b3d4-0aa7697eb409");
Download a zip with all files separated in folders.
ZIP file.
$ curl
-X GET
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/signatures/6f6c974e-2910-11e4-b3d4-0aa7697eb409/documents/29109781-f42d-11e4-b3d4-0aa7697eb409/download/attachments
The events URL allows you to configure a URL where we will send information in realtime about the signature process.
The list of events that you will receive is:
The media type of the events we send to your endpoints is set to application/x-www-form-urlencoded by default.
You can receive the events on other formats such as json or xml.
To do so, add the media type extension you want to get to the end of the URL where you want to receive these events: for example https://httpbin.org/post.json we will post the information in json format.
Some widgets accept built-in validation rules, in order to validate the entered data. For setting a validation rule, you must add the validation_rule option of the widget in signature creation request.
Here you can find a list of currently implemented validation rules:
This endpoint is used to get certificated files.
The file with JSON format.
$ curl
-X GET
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/files/3ccd2306-8b51-473e-adcf-b955b0f3a2d5.json
This endpoint is used to upload files and certificate them.
The file with JSON format.
$ curl
-X POST
-F 'file=@"/certifiedFile.pdf"'
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/files.json
A response with the id of the chunk and related info to complete the upload with remaining chunks with JSON format.
$ curl
-X POST
-F 'file=@"/certifiedFile.pdf"'
-F 'chunk=1'
-F 'chunks=3'
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/files.json
The event hooks are the information sent about the signature process.
List event hooks from the requester.
A collection of event hooks in JSON format.
$ curl
-X GET
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/event-hooks?method[]=POST&limit=2&page=4&search=email_&status[]=200
Fires again the event hook. It can only be done by the event hook requester or the account administrator otherwise it will return a HTTP not authorized response code.
An empty response.
$ curl
-X POST
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/event-hooks/6-V7J4cBdHtiVHKnd1DU/retry
A template is a prepared document that can be sent repeatedly.
List templates from the requester.
A collection of templates in JSON or XML format.
$ curl
-X GET
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/templates.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.get_templates
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.get_templates()
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->getTemplates();
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.getTemplates();
let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)
client.getTemplates()
Client client = new Client("YOUR_ACCESS_TOKEN");
client.getTemplates();
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.getTemplates();
A email represents a request to one or more signers with one or more documents.
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:
A list of events related with the certificate.
Inside every event item you can find the next information:
The event type.
The available types are:
The list of attached files.
Inside every file item you can find the next information:
The email status.
The available status are:
Count certified emails.
Filter emails with certain status. OPTIONAL
The available status are:
Total of certified emails in JSON or XML format.
$ curl
-X GET
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/emails/count.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.count_emails
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.count_emails()
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->countEmails();
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.countEmails();
let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)
client.countEmails()
Client client = new Client("YOUR_ACCESS_TOKEN");
client.countEmails();
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.countEmails();
Get all certified emails.
Filter emails with certain status. OPTIONAL
The available status are:
A list of email requests in JSON or XML format.
$ curl
-X GET
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/emails.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.get_emails
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.get_emails()
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->getEmails();
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.getEmails();
let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)
client.getEmails()
Client client = new Client("YOUR_ACCESS_TOKEN");
client.getEmails();
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.getEmails();
Get a given certified email request.
Single certified email request in JSON or XML format.
$ curl
-X GET
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/emails/6f6c974e-2910-11e4-b3d4-0aa7697eb409.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.get_email('6f6c974e-2910-11e4-b3d4-0aa7697eb409')
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.get_email('6f6c974e-2910-11e4-b3d4-0aa7697eb409')
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->getEmail('6f6c974e-2910-11e4-b3d4-0aa7697eb409');
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.getEmail('6f6c974e-2910-11e4-b3d4-0aa7697eb409');
let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)
client.getEmail("6f6c974e-2910-11e4-b3d4-0aa7697eb409")
Client client = new Client("YOUR_ACCESS_TOKEN");
client.getEmail("6f6c974e-2910-11e4-b3d4-0aa7697eb409");
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.getEmail("6f6c974e-2910-11e4-b3d4-0aa7697eb409");
Create a new email request.
Email body (html code is allowed). OPTIONAL
URL that receive realtime information about this email process. OPTIONAL
See the emails event url section for more information.
Custom information in a key: value format that you can include in the email request. OPTIONAL
These key:value pairs will be stored in the email and can be used later as search criteria on the "Get certified emails" endpoint described above.
List with email recipients containing name, email and extra requirements for the email process if needed.
Every item can contain the next information:
Also, you can use the next format to specify to, cc and bcc:
Email recipients.
Email cc. Format is the same as recipients.
Email bcc. Format is the same as recipients.
List with email recipients containing name, email and extra requirements for the email process if needed.
The available types are:
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.
New certified email in JSON or XML format.
$ 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
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.create_email_request('/path/to/the/pdf/document.pdf', { :name => 'John', :email => 'john.doe@gmail.com' })
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.create_email_request('/path/to/the/pdf/document.pdf', { 'name': 'John', 'email': 'john.doe@gmail.com' })
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->createEmail('/path/to/the/pdf/document.pdf', [ 'name' => 'John', 'email' => 'john.doe@gmail.com' ]);
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.createEmail('/path/to/the/pdf/document.pdf', { name: 'John', email: 'john.doe@gmail.com' } );
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
})
Client client = new Client("YOUR_ACCESS_TOKEN", false);
ArrayList<File> files = new ArrayList<File>();
File file1 = new File("/path/to/the/pdf/document1.pdf");
files.add(file1);
File file2 = new File("/path/to/the/pdf/document2.pdf");
files.add(file2);
ArrayList<HashMap<String, Object>> recipients = new ArrayList<HashMap<String, Object>>();
HashMap<String, Object> recipient1 = new HashMap<String, Object>();
recipient1.put("name","Alice");
recipient1.put("email","alice@signaturit.com");
ArrayList<HashMap<String, Object>> cc = new ArrayList<HashMap<String, Object>>();
HashMap<String, Object> cc1 = new HashMap<String, Object>();
cc1.put("name","Bob");
cc1.put("email","bob@signaturit.com");
cc.add(cc1);
recipient1.put("cc", cc);
recipients.add(recipient1);
client.createEmail(files, recipients);
var recipients = new [] {
new { name = "John" , email = "john.doe@gmail.com"}
};
var files = new [] {
"/path/to/the/pdf/document.pdf"
};
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.createEmail(files, recipients);
Download the binary content of the audit trail PDF.
PDF file.
$ curl
-X GET
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/emails/6f6c974e-2910-11e4-b3d4-0aa7697eb409/certificates/29109781-f42d-11e4-b3d4-0aa7697eb409/download/audit_trail
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.download_email_audit_trail('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409')
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.download_email_audit_trail('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409')
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->downloadEmailAuditTrail('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409');
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.downloadEmailAuditTrail('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409');
let destination = Alamofire.Request.suggestedDownloadDestination(directory: .DocumentDirectory, domain: .UserDomainMask)
let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)
client.downloadAuditTrail("6f6c974e-2910-11e4-b3d4-0aa7697eb409", document"id": "29109781-f42d-11e4-b3d4-0aa7697eb409", path: destination)
Client client = new Client("YOUR_ACCESS_TOKEN");
client.downloadEmailAuditTrail("6f6c974e-2910-11e4-b3d4-0aa7697eb409", "29109781-f42d-11e4-b3d4-0aa7697eb409");
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.downloadAuditTrail("6f6c974e-2910-11e4-b3d4-0aa7697eb409", "29109781-f42d-11e4-b3d4-0aa7697eb409");
The events URL allows you to configure a URL where we will send information in realtime about the email process.
The list of events that you will receive is:
A SMS represents a request to one or more signers with one or more documents.
The certificate items that have been created with the SMS request. A certificate item is created for recipient.
Inside every certificate item you can find the next information:
A list of events related with the certificate.
Inside every event item you can find the next information:
The event type.
The available types are:
The SMS status.
The available status are:
Count certified SMS.
Filter SMS with certain status. OPTIONAL
The available status are:
Total of certified SMS in JSON or XML format.
$ curl
-X GET
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/sms/count.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.count_emails
Client client = new Client("YOUR_ACCESS_TOKEN", false);
client.countSMS();
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN");
client.countEmails();
Get all certified SMS.
Filter SMS with certain status. OPTIONAL
The available status are:
A list of SMS requests in JSON or XML format.
$ curl
-X GET
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/sms.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.get_sms
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.get_sms()
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->getSms();
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.getSms();
Client client = new Client("YOUR_ACCESS_TOKEN");
client.getSMS();
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN");
client.getSms();
Get a given certified SMS request.
Single certified SMS request in JSON or XML format.
$ curl
-X GET
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/sms/6f6c974e-2910-11e4-b3d4-0aa7697eb409.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.get_single_sms('6f6c974e-2910-11e4-b3d4-0aa7697eb409')
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.get_single_sms('6f6c974e-2910-11e4-b3d4-0aa7697eb409')
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->getSingleSms('6f6c974e-2910-11e4-b3d4-0aa7697eb409');
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.getSingleSms('6f6c974e-2910-11e4-b3d4-0aa7697eb409');
Client client = new Client("YOUR_ACCESS_TOKEN");
client.getSingleSMS("6f6c974e-2910-11e4-b3d4-0aa7697eb409");
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN");
client.getSingleSMS("6f6c974e-2910-11e4-b3d4-0aa7697eb409");
Create a new SMS request.
SMS body. The number of characters cannot be more than 120.
URL that receive realtime information about this SMS process. OPTIONAL
See the sms event url section for more information.
List with SMS recipients containing name and phone number.
Every item can contain the next information:
The available types are:
Send a modified version of the SMS with an url that redirects the user to our platform to open the PDF attachments.
With this method, you can track when the user opens the attached files.
Note: This method only supports PDF documents to be attached.
New certified SMS in JSON or XML format.
$ curl
-X POST
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
-F "recipients[0][name]=John"
-F "recipients[0][phone]=34123445566"
-F "attachments[0]=@/path/to/the/pdf/document.pdf"
-F "type=open_document"
https://api.sandbox.signaturit.com/v3/sms.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.create_sms('path/to/the/pdf/document.pdf', { :phone => '34123445566', :name => 'John' }, '', { :type => 'open_document' })
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.create_sms(['path/to/the/pdf/document.pdf'], {'phone':'34123445566', 'name': 'John'}, '', {'type':'open_document'})
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->createSms(['path/to/the/pdf/document.pdf'], ['phone' => '34123445566', 'name' => 'John'], '', ['type' => 'open_document']);
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.createSms(['path/to/the/pdf/document.pdf'], {'phone':'34123445566', 'name': 'John'}, '', {'type':'open_document'});
Client client = new Client("YOUR_ACCESS_TOKEN", false);
ArrayList<File> filePath = new ArrayList<File>();
File temp = new File("/path/to/the/pdf/document.pdf");
filePath.add(temp);
ArrayList<HashMap<String, Object>> recipients = new ArrayList<HashMap<String,Object>>();
HashMap<String, Object> recipient= new HashMap<String, Object>();
recipient.put("phone", "34123445566");
recipient.put("fullname", "John");
recipients.add(recipient);
HashMap<String, Object> parameters = new HashMap<String, Object>();
parameters.put("type", "open_document");
Response response = client.createSms(filePath, recipients, "See it here {{url}}", parameters);
var recipients = new [] {
new { name = "John" , phone = "34123445566"}
};
var files = new [] {
"/path/to/the/pdf/document.pdf"
};
var parameters = new { type = "open_document" };
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.createSMS(files, recipients, '', parameters);
Download the binary content of the audit trail PDF.
PDF file.
$ curl
-X GET
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/sms/6f6c974e-2910-11e4-b3d4-0aa7697eb409/certificates/29109781-f42d-11e4-b3d4-0aa7697eb409/download/audit_trail
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.download_sms_audit_trail('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409')
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.download_sms_audit_trail('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409')
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->downloadSmsAuditTrail('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409');
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.downloadSmsAuditTrail('6f6c974e-2910-11e4-b3d4-0aa7697eb409', '29109781-f42d-11e4-b3d4-0aa7697eb409');
Client client = new Client("YOUR_ACCESS_TOKEN");
client.downloadSmsAuditTrail("6f6c974e-2910-11e4-b3d4-0aa7697eb409", "29109781-f42d-11e4-b3d4-0aa7697eb409");
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.downloadSmsAuditTrail("6f6c974e-2910-11e4-b3d4-0aa7697eb409", "29109781-f42d-11e4-b3d4-0aa7697eb409");
The events URL allows you to configure a URL where we will send information in realtime about the SMS process.
The list of events that you will receive is:
A branding represents the full customization of signaturit's app.
List with all the customizable texts for application widgets.
The available texts are:
The template content for the emails sent to the user. See Custom templates section for more information.
Get all brandings from your account.
Branding list in JSON or XML format.
$ curl
-X GET
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/brandings.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.get_brandings
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.get_brandings()
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->getBrandings();
[{ "application_texts": { "multi_page": "The pages that you need to sign in this test request are:", "photo": "We need a photo to fulfill this test request", "send_button": "Send!", "sign_button": "Sign!", "terms_and_conditions": "I will accept all this terms for testing purposes.", "voice": "We need a voice record to fulfill this test request" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }, { "application_texts": [], "created_at": "2014-08-20T13:57:51+0000", "id": "eec5e47a-2871-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }]client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.getBrandings();
[{ "application_texts": { "multi_page": "The pages that you need to sign in this test request are:", "photo": "We need a photo to fulfill this test request", "send_button": "Send!", "sign_button": "Sign!", "terms_and_conditions": "I will accept all this terms for testing purposes.", "voice": "We need a voice record to fulfill this test request" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }, { "application_texts": [], "created_at": "2014-08-20T13:57:51+0000", "id": "eec5e47a-2871-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }]let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)
client.getBrandings()
[{ "application_texts": { "multi_page": "The pages that you need to sign in this test request are:", "photo": "We need a photo to fulfill this test request", "send_button": "Send!", "sign_button": "Sign!", "terms_and_conditions": "I will accept all this terms for testing purposes.", "voice": "We need a voice record to fulfill this test request" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }, { "application_texts": [], "created_at": "2014-08-20T13:57:51+0000", "id": "eec5e47a-2871-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }]Client client = new Client("YOUR_ACCESS_TOKEN");
client.getBrandings();
[{ "application_texts": { "multi_page": "The pages that you need to sign in this test request are:", "photo": "We need a photo to fulfill this test request", "send_button": "Send!", "sign_button": "Sign!", "terms_and_conditions": "I will accept all this terms for testing purposes.", "voice": "We need a voice record to fulfill this test request" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }, { "application_texts": [], "created_at": "2014-08-20T13:57:51+0000", "id": "eec5e47a-2871-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" }]Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.getBrandings();
Get a branding.
A branding in JSON or XML format.
$ curl
-X GET
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/brandings/0b1db805-2cf7-11e4-b3d4-0aa7697eb409.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.get_branding('0b1db805-2cf7-11e4-b3d4-0aa7697eb409')
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.get_branding('0b1db805-2cf7-11e4-b3d4-0aa7697eb409')
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->getBranding('0b1db805-2cf7-11e4-b3d4-0aa7697eb409');
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.getBranding('0b1db805-2cf7-11e4-b3d4-0aa7697eb409');
let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)
client.getBranding("0b1db805-2cf7-11e4-b3d4-0aa7697eb409")
Client client = new Client("YOUR_ACCESS_TOKEN");
client.getBranding("0b1db805-2cf7-11e4-b3d4-0aa7697eb409");
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.getBranding("0b1db805-2cf7-11e4-b3d4-0aa7697eb409");
Create a single branding.
List with all the customizable texts for application widgets. OPTIONAL
The available texts are:
The template content for the emails sent to the user. See Custom templates section for more information.
The template content for the SMS sent to the user. See Custom templates section for more information.
The new branding in JSON or XML format.
$ curl
-X POST
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
-d "layout_color=#FAAC58"
-d "text_color=#B43104"
-d "application_texts[send_button]=Sign"
-d "show_welcome_page=1"
https://api.sandbox.signaturit.com/v3/brandings.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.create_branding({ :layout_color => '#FAAC58', :text_color => '#B43104', :application_texts => { "send_button": "Sign" } })
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.create_branding({ 'layout_color': '#FAAC58', 'text_color': '#B43104', 'application_texts': { "send_button": "Sign" } })
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->createBranding([ 'layout_color' => '#FAAC58', 'text_color' => '#B43104', 'application_texts' => [ "send_button" => "Sign" ] ]);
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.createBranding({ "layout_color": "#FAAC58", "text_color": "#B43104", "application_texts": { "send_button": "Sign" } });
let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)
client.createBranding(["layout_color": "#FAAC58", "text_color": "#B43104", "application_texts": ["send_button": "Sign"]])
Client client = new Client("YOUR_ACCESS_TOKEN");
HashMap<String, String> applicationText = new HashMap<String, String>();
applicationText.put("send_button", "Sign");
HashMap<String, Object> parameters = new HashMap<String, Object>();
parameters.put("layout_color", "#FAAC58");
parameters.put("text_color", "#B43104");
parameters.put("application_texts", applicationText);
client.createBranding(parameters);
var params = new { layout_color = "#FAAC58", text_color = "#B43104", application_texts = new { send_button = "Sign" } };
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.createBranding(params);
Update a single branding.
Same parameters as CREATE BRANDING method.
The updated branding in JSON or XML format.
$ 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
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.update_branding('3eed17f5-2d08-11e4-b3d4-0aa7697eb409', { :application_texts => { :send_button => 'Sign again!' } })
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.update_branding('3eed17f5-2d08-11e4-b3d4-0aa7697eb409', { 'application_texts': { 'send_button': 'Sign again!' } })
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->updateBranding( '3eed17f5-2d08-11e4-b3d4-0aa7697eb409', [ 'application_texts' => [ 'send_button' => 'Sign again!' ] ] );
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.updateBranding('3eed17f5-2d08-11e4-b3d4-0aa7697eb409', { application_texts: { send_button: 'Sign again!' } });
let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)
client.updateBranding("3eed17f5-2d08-11e4-b3d4-0aa7697eb409", params: ["application_texts": ["send_button": "Sign again!"]])
Client client = new Client("YOUR_ACCESS_TOKEN");
HashMap<String, String> applicationText = new HashMap<String, String>();
applicationText.put("send_button", "Sign again!");
HashMap<String, Object> parameters = new HashMap<String, Object>();
parameters.put("layout_color", "#FAAC58");
parameters.put("text_color", "#B43104");
parameters.put("application_texts", applicationText);
client.updateBranding("3eed17f5-2d08-11e4-b3d4-0aa7697eb409", parameters);
var params = new { application_texts = new { send_button = "Sign again!" } };
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.updateBranding("3eed17f5-2d08-11e4-b3d4-0aa7697eb409", params);
You can customize the templates for emails and SMS that are sent to the user. Every template should be linked to a branding, so every request using this branding will use that template instead of Signaturit one.
This template is the one the user receives when you send him a document to sign.
Note: In this template, sign_button magic word is required.
This template is the one the user receives as a reminder of a document pending to sign.
Note: In this template, sign_button magic word is required.
This template is the one the user receives when requester cancels the signature.
This template is the one the user receives when you send him a document through certified emails.
Note: In this template, email_button magic word is required.
This template is the one the user receives when you send him a document to validate (as a validator).
Note: In this template, validate_button magic word is required.
This template is the one the requester receives once a signature request is finished.
This template is the one the requester receives when signer declines a signature request.
This template is the one the requester receives when a signature expires.
This template is the one the user receives when an SMS code is sent as a password to open a document.
Note: In this template, code magic word is required.
This template is the one the user receives when an SMS code is sent to validate the signing of a document.
Note: In this template, code magic word is required.
The submitted file must be a HTML template. You can write some magic words on the content, to use custom information from our side. The following words can be used.
Tag replaced by the signaturit button.
Note: This tag only can be used in signatures_request and pending_sign templates.
Tag replaced by the validate document button.
Note: This tag only can be used in validation_request template.
Show the expiry date for a document.
Note: This tag can only be used in pending_sign template.
Note: Do not use this magic word, if you plan that your requests will not expire.
Tag replaced by the signaturit button.
Note: This tag only can be used in emails_request template.
Tag replaced by the body parameter text.
Note: This tag only can be used in signatures_request template.
Tag replaced by the sms code.
Note: This tag only can be used in sms_verify and sms_validate templates.
Tag replaced by reason why a signature is declined by signer
Note: This tag only can be used in document_declined template.
Tag replaced by button to see the signature detail on dashboard
Note: This tag only can be used in document_declined template.
Tag replaced by the signer (or signers) name and email in format NAME - EMAIL
Note: This tag only can be used in signed_document template.
Finally, if you want to set a subject for your templates, you must add it on your html file, using html tag title. Email subject will be the text set between this tags.
$ curl
-X POST
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
-d "templates[signatures_request]=<html><body><div>Sign the document</div><div>{{sign_button}}</div></body></html>"
https://api.sandbox.signaturit.com/v3/brandings.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.create_branding({ :templates => { :signatures_request => '<html><body><div>Sign the document</div><div>{{sign_button}}</div></body></html>' } })
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.create_branding({ 'templates': { 'signatures_request': '<html><body><div>Sign the document</div><div>{{sign_button}}</div></body></html>' } })
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->createBranding([ 'templates' => [ 'signatures_request' => '<html><body><div>Sign the document</div><div>{{sign_button}}</div></body></html>' ] ] );
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.createBranding({ templates: { signatures_request: '<html><body><div>Sign the document</div><div>{{sign_button}}</div></body></html>' } });
let client: Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN", production: false)
client.createBranding(["templates": ["signatures_request": "<html><body><div>Sign the document</div><div>{{sign_button}}</div></body></html>"]])
Client client = new Client("YOUR_ACCESS_TOKEN");
HashMap<String, String> templates = new HashMap<String, String>();
templates.put("signatures_request", "<html><body><div>Sign the document</div><div>{{sign_button}}</div></body></html>");
HashMap<String, Object> parameters = new HashMap<String, Object>();
parameters.put("templates", templates);
client.createBranding(parameters);
var params = new { templates = new { signatures_request = "<html><body><div>Sign the document</div><div>{{sign_button}}</div></body></html>" } };
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.createBranding(params);
Validates an ID document providing image captures from the document front and back sides.
Type of the document. Defaults to ID.
Available document types are:
Captured data from the document and validations in JSON or XML format.
$ curl
-X POST
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
-F "front=@/path/to/the/front.jpg"
-F "back=@/path/to/the/back.jpg"
-F "document_type=PA"
-F "document_country=FRA"
https://api.sandbox.signaturit.com/v3/photoid/validate.json
A credit refers to the units consumed when utilizing the digital signature services provided by Signaturit. Each credit corresponds to a transaction or signature request.
Get the number of remaining credits in your account.
Credit data in JSON or XML format.
$ curl
-X GET
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/account/credits.json
You can subscribe to Signaturit events using subscriptions. When you create a subscription, if the process event matches the one you are subscribed, event info will be sent to the url submitted.
Subscription is formed basically by the desired events an a url to send the information.
When you are subscribed to a event, you will get the following information when the event triggers.
The media type of the events we send to your endpoints is set to application/x-www-form-urlencoded by default.
You can receive the events on other formats such as json or xml.
To do so, add the media type extension you want to get to the end of the URL where you want to receive these events: for example https://httpbin.org/post.json we will post the information in json format.
If you want to add an extra security layer, you can filter by IP, as we send all events from 34.241.96.22, both in Sandbox and in Production.
Get all subscriptions.
Subscription list in JSON or XML format.
$ curl
-X GET
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/subscriptions.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.get_subscriptions
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.get_subscriptions()
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->getSubscriptions();
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.getSubscriptions();
Client client = new Client("YOUR_ACCESS_TOKEN", false)
client.getSubscriptions();
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.getSubscriptions();
Get a subscription.
Subscription in JSON or XML format.
$ curl
-X GET
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/subscriptions/b2c7de2f-862c-11e6-88d5-06875124f8dd.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.get_subscription('b2c7de2f-862c-11e6-88d5-06875124f8dd')
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.get_subscription('b2c7de2f-862c-11e6-88d5-06875124f8dd')
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->getSubscription('b2c7de2f-862c-11e6-88d5-06875124f8dd');
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.getSubscription('b2c7de2f-862c-11e6-88d5-06875124f8dd');
Client client = new Client("YOUR_ACCESS_TOKEN");
client.getSubscription("b2c7de2f-862c-11e6-88d5-06875124f8dd");
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.getSubscription("b2c7de2f-862c-11e6-88d5-06875124f8dd");
Create a new subscription.
Signature events
Email events
SMS events
Subscription in JSON or XML format.
$ curl
-X POST
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
-d "url=https://httpbin.org/post"
-d "events[0]=*"
https://api.sandbox.signaturit.com/v3/subscriptions.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.create_subscription('https://httpbin.org/post', ['*'])
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.create_subscription('https://httpbin.org/post', ['*'])
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->createSubscription('https://httpbin.org/post', ['*']);
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.createSubscription('https://httpbin.org/post', ['*']);
Client client = new Client("YOUR_ACCESS_TOKEN", false)
String[] events = {"*"};
client.createSubscription("https://httpbin.org/post", events);
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.createSubscription("https://httpbin.org/post", new [] { "*" });
$ curl
-X POST
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
-d "url=https://httpbin.org/post"
-d "events[0]=email_processed"
-d "events[1]=email_delivered"
https://api.sandbox.signaturit.com/v3/subscriptions.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.create_subscription('https://httpbin.org/post', ['email_processed', 'email_delivered'])
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.create_subscription('https://httpbin.org/post', ['email_processed', 'email_delivered'])
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->createSubscription('https://httpbin.org/post', ['email_processed', 'email_delivered']);
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.createSubscription('https://httpbin.org/post', ['email_processed', 'email_delivered']);
Client client = new Client("YOUR_ACCESS_TOKEN", false)
String[] events = {"email_processed", "email_delivered"};
client.createSubscription("https://httpbin.org/post", events);
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
String[] events = {"email_processed", "email_delivered"};
client.createSubscription("https://httpbin.org/post", new [] { "email_processed", "email_delivered" });
Updates a subscription.
Same parameters as POST method.
$ curl
-X PATCH
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
-d "url=new_url.json"
https://api.sandbox.signaturit.com/v3/subscriptions/b2c7de2f-862c-11e6-88d5-06875124f8dd.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.update_subscription('b2c7de2f-862c-11e6-88d5-06875124f8dd', { :url => 'new_url.json' })
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.update_subscription('b2c7de2f-862c-11e6-88d5-06875124f8dd', url='new_url.json')
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->updateSubscription('b2c7de2f-862c-11e6-88d5-06875124f8dd', 'new_url.json', null);
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.updateSubscription('b2c7de2f-862c-11e6-88d5-06875124f8dd', 'new_url.json', null);
Client client = new Client("YOUR_ACCESS_TOKEN", false)
client.updateSubscription("b2c7de2f-862c-11e6-88d5-06875124f8dd", "https://newurl.com.json", null);
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.updateSubscription("b2c7de2f-862c-11e6-88d5-06875124f8dd", new { url = "new_url.json" });
Deletes a subscription.
$ curl
-X DELETE
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/subscriptions/b2c7de2f-862c-11e6-88d5-06875124f8dd.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.delete_subscription('b2c7de2f-862c-11e6-88d5-06875124f8dd')
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.delete_subscription('b2c7de2f-862c-11e6-88d5-06875124f8dd')
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->deleteSubscription('b2c7de2f-862c-11e6-88d5-06875124f8dd');
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.deleteSubscription('b2c7de2f-862c-11e6-88d5-06875124f8dd');
Client client = new Client("YOUR_ACCESS_TOKEN", false)
client.deleteSubscription("b2c7de2f-862c-11e6-88d5-06875124f8dd");
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.deleteSubscription("b2c7de2f-862c-11e6-88d5-06875124f8dd");
Team is formed by one or more seats. Every seat can be linked only to one user, you can request a user to join your team and if he accepts, it'll become part of your team.
You can also create groups in your team. Every group can have managers and members. Every user designed as manager, will view all requests made by the group members.
Get team users.
Seats in JSON or XML format.
$ curl
-X GET
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/team/users.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.get_users()
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.get_users()
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->getUsers();
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.getUsers();
Client client = new Client("YOUR_ACCESS_TOKEN", false)
client.getUsers();
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.getUsers();
Get team seats.
Seats in JSON or XML format.
$ curl
-X GET
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/team/seats.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.get_seats
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.get_seats()
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->getSeats();
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.getSeats();
Client client = new Client("YOUR_ACCESS_TOKEN", false)
client.getSeats();
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.getSeats();
Get a user from the team.
Seat in JSON or XML format.
$ curl
-X GET
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/team/users/d8125099-871e-11e6-88d5-06875124f8dd.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.get_user('d8125099-871e-11e6-88d5-06875124f8dd')
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.get_user('d8125099-871e-11e6-88d5-06875124f8dd')
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->getUser('d8125099-871e-11e6-88d5-06875124f8dd');
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.getUser('d8125099-871e-11e6-88d5-06875124f8dd');
Client client = new Client("YOUR_ACCESS_TOKEN", false)
client.getUser("d8125099-871e-11e6-88d5-06875124f8dd");
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.getUser("d8125099-871e-11e6-88d5-06875124f8dd");
Request a user to join the team. User will get an email with the link to register in your team.
Seat in JSON or XML format.
$ curl
-X POST
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
-d "email=bob.soap@signaturit.com"
-d "role=admin"
https://api.sandbox.signaturit.com/v3/team/users.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.invite_user('bob.soap@signaturit.com', 'admin')
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.invite_user('bob.soap@signaturit.com', 'admin')
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->inviteUser('bob.soap@signaturit.com', 'admin');
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.inviteUser('bob.soap@signaturit.com', 'admin');
Client client = new Client("YOUR_ACCESS_TOKEN", false)
client.inviteUser("bob.soap@signaturit.com", "admin");
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.inviteUser("bob.soap@signaturit.com", "admin");
Update user role.
User in JSON or XML format.
$ curl
-X PATCH
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
-d "role=member"
https://api.sandbox.signaturit.com/v3/team/users/d8125099-871e-11e6-88d5-06875124f8ed.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.change_user_role('d8125099-871e-11e6-88d5-06875124f8ed.', 'member')
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.change_user_role('d8125099-871e-11e6-88d5-06875124f8ed.', 'member')
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->changeUserRole('d8125099-871e-11e6-88d5-06875124f8ed.', 'member');
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.changeUserRole('d8125099-871e-11e6-88d5-06875124f8ed.', 'member');
Client client = new Client("YOUR_ACCESS_TOKEN", false)
client.changeUserRole("d8125099-871e-11e6-88d5-06875124f8dd", "member");
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.changeUserRole("d8125099-871e-11e6-88d5-06875124f8dd", "member");
Remove user from account and made the seat inactive again.
Seat in JSON or XML format.
$ curl
-X DELETE
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/team/users/d8125099-871e-11e6-88d5-06875124f8dd.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.remove_user('d8125099-871e-11e6-88d5-06875124f8dd')
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.remove_user('d8125099-871e-11e6-88d5-06875124f8dd')
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->removeUser('d8125099-871e-11e6-88d5-06875124f8dd');
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.removeUser('d8125099-871e-11e6-88d5-06875124f8dd');
Client client = new Client("YOUR_ACCESS_TOKEN", false)
client.removeUser("d8125099-871e-11e6-88d5-06875124f8dd");
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.removeUser("d8125099-871e-11e6-88d5-06875124f8dd");
Remove seat from account.
Seat in JSON or XML format.
$ curl
-X DELETE
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/team/users/d8125099-871e-11e6-88d5-06875124f8dd.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.remove_seat('d8125099-871e-11e6-88d5-06875124f8dd')
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.remove_seat('d8125099-871e-11e6-88d5-06875124f8dd')
$client = SignaturitClient('YOUR_ACCESS_TOKEN')
$client->removeSeat('d8125099-871e-11e6-88d5-06875124f8dd')
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.removeSeat('d8125099-871e-11e6-88d5-06875124f8dd');
Client client = new Client("YOUR_ACCESS_TOKEN", false)
client.removeSeat("d8125099-871e-11e6-88d5-06875124f8dd");
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.removeSeat("d8125099-871e-11e6-88d5-06875124f8dd");
Get team groups.
Groups in JSON or XML format.
$ curl
-X GET
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/team/groups.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.get_groups
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.get_groups()
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->getGroups();
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.getGroups();
Client client = new Client("YOUR_ACCESS_TOKEN", false)
client.getGroups();
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.getGroups();
Get single group.
Group in JSON or XML format.
$ curl
-X GET
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/team/groups/id.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.get_group('d8125099-871e-11e6-88d5-06875124f8dd')
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.get_group('d8125099-871e-11e6-88d5-06875124f8dd')
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->getGroup('d8125099-871e-11e6-88d5-06875124f8dd');
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.getGroup('d8125099-871e-11e6-88d5-06875124f8dd');
Client client = new Client("YOUR_ACCESS_TOKEN", false)
client.getGroup("d8125099-871e-11e6-88d5-06875124f8dd");
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.getGroup("d8125099-871e-11e6-88d5-06875124f8dd");
Create a new group.
Group in JSON or XML format.
$ curl
-X POST
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
-d "name=Founders"
https://api.sandbox.signaturit.com/v3/team/groups.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.create_group('founders')
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.create_group('founders')
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->createGroup('founders')
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.createGroup('founders')
Client client = new Client("YOUR_ACCESS_TOKEN", false)
client.createGroup("Founders");
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.createGroup("Founders");
Update a group.
Group in JSON or XML format.
$ curl
-X PATCH
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
-d "name=Members"
https://api.sandbox.signaturit.com/v3/team/groups/d8125099-871e-11e6-88d5-06875124f8dd.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.update_group('d8125099-871e-11e6-88d5-06875124f8dd', 'Members')
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.update_group('d8125099-871e-11e6-88d5-06875124f8dd', 'Members')
$client = SignaturitClient('YOUR_ACCESS_TOKEN');
$client->updateGroup('d8125099-871e-11e6-88d5-06875124f8dd', 'Members');
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.updateGroup('d8125099-871e-11e6-88d5-06875124f8dd', 'Members')
Client client = new Client("YOUR_ACCESS_TOKEN", false)
client.updateGroup("d8125099-871e-11e6-88d5-06875124f8dd", "Members");
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.updateGroup("d8125099-871e-11e6-88d5-06875124f8dd", "Members");
Delete a group.
$ curl
-X DELETE
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/team/groups/d8125099-871e-11e6-88d5-06875124f8dd.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.delete_group('d8125099-871e-11e6-88d5-06875124f8dd')
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.delete_group('d8125099-871e-11e6-88d5-06875124f8dd')
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->deleteGroup('d8125099-871e-11e6-88d5-06875124f8dd');
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.deleteGroup('d8125099-871e-11e6-88d5-06875124f8dd');
Client client = new Client("YOUR_ACCESS_TOKEN", false)
client.deleteGroup("d8125099-871e-11e6-88d5-06875124f8dd");
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.deleteGroup("d8125099-871e-11e6-88d5-06875124f8dd");
Add a new seat to a group, with manager role.
Group in JSON or XML format.
$ curl
-X POST
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/team/groups/d8125099-871e-11e6-88d5-06875124f8dd/managers/d8125099-871e-11e6-88d5-06875124f8dd.json
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.add_manager_to_group('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd')
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.add_manager_to_group('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd')
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client.addManagerToGroup('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd');
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.addManagerToGroup('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd');
Client client = new Client("YOUR_ACCESS_TOKEN", false)
client.addManagerToGroup("d8125099-871e-11e6-88d5-06875124f8dd", "d8125099-871e-11e6-88d5-06875124f8dd");
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.addManagerToGroup("d8125099-871e-11e6-88d5-06875124f8dd", "d8125099-871e-11e6-88d5-06875124f8dd");
Remove a manager from group.
Group in JSON or XML format.
$ curl
-X DELETE
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/team/groups/d8125099-871e-11e6-88d5-06875124f8dd/managers/d8125099-871e-11e6-88d5-06875124f8dd.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.remove_manager_from_group('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd')
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.remove_manager_from_group('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd')
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->removeManagerFromGroup('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd');
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.removeManagerFromGroup('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd');
Client client = new Client("YOUR_ACCESS_TOKEN", false)
client.removeManagerFromGroup("d8125099-871e-11e6-88d5-06875124f8dd", "d8125099-871e-11e6-88d5-06875124f8dd");
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.removeManagerFromGroup("d8125099-871e-11e6-88d5-06875124f8dd", "d8125099-871e-11e6-88d5-06875124f8dd");
Add a new seat to a group, with member role.
Group in JSON or XML format.
$ curl
-X POST
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/team/groups/d8125099-871e-11e6-88d5-06875124f8dd/members/d8125099-871e-11e6-88d5-06875124f8dd.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.add_member_to_group('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd')
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.add_member_to_group('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd')
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client.addMemberToGroup('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd');
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.addMemberToGroup('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd');
Client client = new Client("YOUR_ACCESS_TOKEN", false)
client.addMemberToGroup("d8125099-871e-11e6-88d5-06875124f8dd", "d8125099-871e-11e6-88d5-06875124f8dd");
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.addMemberToGroup("d8125099-871e-11e6-88d5-06875124f8dd", "d8125099-871e-11e6-88d5-06875124f8dd");
Remove a member from group.
Group in JSON or XML format.
$ curl
-X DELETE
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/team/groups/d8125099-871e-11e6-88d5-06875124f8dd/members/d8125099-871e-11e6-88d5-06875124f8dd.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.remove_member_from_group('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd')
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.remove_member_from_group('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd')
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client.removeMemberFromGroup('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd');
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.removeMemberFromGroup('d8125099-871e-11e6-88d5-06875124f8dd', 'd8125099-871e-11e6-88d5-06875124f8dd');
Client client = new Client("YOUR_ACCESS_TOKEN", false)
client.removeMemberFromGroup("d8125099-871e-11e6-88d5-06875124f8dd", "d8125099-871e-11e6-88d5-06875124f8dd");
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.removeMemberFromGroup("d8125099-871e-11e6-88d5-06875124f8dd", "d8125099-871e-11e6-88d5-06875124f8dd");
You can create your own contacts, to use it when sending requests through signaturit. A contact is formed by an email and a name.
Get your contacts.
Contacts in JSON or XML format.
$ curl
-X GET
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/contacts.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.get_contacts
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.get_contacts()
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->getContacts();
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.getContacts();
Client client = new Client("YOUR_ACCESS_TOKEN", false)
client.getContacts();
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.getContacts();
Get a single contact.
Contact in JSON or XML format.
$ curl
-X GET
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/contacts/e8125099-871e-11e6-88d5-06875124f8dd.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.get_contact('e8125099-871e-11e6-88d5-06875124f8dd')
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.get_contact('e8125099-871e-11e6-88d5-06875124f8dd')
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->getContact('e8125099-871e-11e6-88d5-06875124f8dd');
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.getContact('e8125099-871e-11e6-88d5-06875124f8dd');
Client client = new Client("YOUR_ACCESS_TOKEN", false)
client.getContact("e8125099-871e-11e6-88d5-06875124f8dd");
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.getContact("e8125099-871e-11e6-88d5-06875124f8dd");
Create a new contact.
Contact in JSON or XML format.
$ curl
-X POST
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
-d "email=john.doe@signaturit.com"
-d "name=John Doe"
https://api.sandbox.signaturit.com/v3/contacts.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.create_contact('john.doe@signaturit.com', 'John Doe')
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.create_contact('john.doe@signaturit.com', 'John Doe')
$client = SignaturitClient('YOUR_ACCESS_TOKEN')
$client->createContact('john.doe@signaturit.com', 'John Doe');
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.createContact('john.doe@signaturit.com', 'John Doe');
Client client = new Client("YOUR_ACCESS_TOKEN", false)
client.createContact("john.doe@signaturit.com", "John Doe");
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.createContact("john.doe@signaturit.com", "John Doe");
Update a current contact.
Contact in JSON or XML format.
$ curl
-X PATCH
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
-d "email=john.smith@signaturit.com"
https://api.sandbox.signaturit.com/v3/contacts/e6125099-871e-11e6-88d5-06875124f8dd.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.update_contact('e6125099-871e-11e6-88d5-06875124f8dd', { :email => 'john.smith@signaturit.com' })
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.update_contact(contact_id='e6125099-871e-11e6-88d5-06875124f8dd', email='john.smith@signaturit.com')
$client = new Signaturit\Client('YOUR_ACCESS_TOKEN');
$client->updateContact('e6125099-871e-11e6-88d5-06875124f8dd', 'john.smith@signaturit.com', null);
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.updateContact('e6125099-871e-11e6-88d5-06875124f8dd', 'john.smith@signaturit.com', null);
Client client = new Client("YOUR_ACCESS_TOKEN", false);
client.updateContact("e6125099-871e-11e6-88d5-06875124f8dd", "john.smith@signaturit.com", null);
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.updateContact("e6125099-871e-11e6-88d5-06875124f8dd", "john.smith@signaturit.com", null);
Delete a current contact.
$ curl
-X DELETE
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
https://api.sandbox.signaturit.com/v3/contacts/e6125099-871e-11e6-88d5-06875124f8dd.json
client = SignaturitClient.new('YOUR_ACCESS_TOKEN')
client.delete_contact('e6125099-871e-11e6-88d5-06875124f8dd')
client = SignaturitClient('YOUR_ACCESS_TOKEN')
client.delete_contact('e6125099-871e-11e6-88d5-06875124f8dd')
$client = SignaturitClient('YOUR_ACCESS_TOKEN');
$client->deleteContact('e6125099-871e-11e6-88d5-06875124f8dd');
client = new SignaturitClient('YOUR_ACCESS_TOKEN');
client.deleteContact('e6125099-871e-11e6-88d5-06875124f8dd');
Client client = new Client("YOUR_ACCESS_TOKEN", false);
client.deleteContact("e6125099-871e-11e6-88d5-06875124f8dd");
Signaturit.Client client = new Signaturit.Client("YOUR_ACCESS_TOKEN", false);
client.deleteContact("e6125099-871e-11e6-88d5-06875124f8dd");