Integrations
Learn more
Contact us
Simple Sign International AB
Karlavägen 20
11431 Stockholm, SWEDEN
Phone: +46(0)10 750 09 66
Recommended by iOSXpert Business auf Mac & iPhone GmbH as the 2020 software of choice!
API Reference
ACCOUNT Contains information about an account and its settings
ACTION
URI - DESCRIPTION
Get Account
GET /account
Returns your Account settings.
Get Account
GET /account
Returns your Account settings.
Returns your Account settings.
Description
Returns the information about your Simple Sign Account.
Request Parameters
access_token (required)
The access token of your account
Response
Returns an Account object
EXAMPLE REQUEST / RESPONSE
GET https://esign.simplesign.io/v3/account
curl 'https://esign.simplesign.io/v3/account' \
Show response
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/account?access_token={your access token}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache",
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #:".$err;
} else {
echo $response;
}
$(document).ready(function() {
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/account?access_token={your access token}",
"method": "GET"
}
$.ajax(settings).done(function(response) {
console.log(response);
});
});
Verify Account
GET /verifyaccount
Verifies that your account exists in Simple Sign.
Verify Account
GET /verifyaccount
Verifies that your account exists in Simple Sign.
Verifies that your account exists in Simple Sign.
Description
Verifies whether a Simple Sign Account exists for the given email address.
Note This method is restricted to paid API users.
Request Parameters
email (required)
Email address to check account
Response
Returns a success message.
EXAMPLE REQUEST / RESPONSE
GET https://esign.simplesign.io/v3/verifyaccount
curl 'https://esign.simplesign.io/v3/verifyaccount' \
Show response
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/verifyaccount?email=clarkkent@yopmail.com",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
$(document).ready(function() {
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/verifyaccount?email=clarkkent@yopmail.com",
"method": "GET"
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
Update Account
POST/updateaccount
Updates your account's settings.
Update Account
POST/updateaccount
Updates your account's settings.
Updates your account's settings.
Description
Updates the properties and settings of your Simple Sign Account.
Request Parameters
access_token (required)
User access token
full_name (optional)
Full name of user account
company (optional)
User company
address (optional)
User address
city (optional)
User city
phone_no (optional)
User phone no
reg_no (optional)
User Reg no
post_code (optional)
User Post code
Response
Returns a success message.
EXAMPLE REQUEST / RESPONSE
POST https://esign.simplesign.io/v3/updateaccount
curl 'https://esign.simplesign.io/v3/updateaccount \
Show response
$curlParams['access_token'] = '{your access token}';
$curlParams['full_name'] = '{John Doe}';
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/updateaccount",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => $curlParams,
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache",
"content-type: multipart/form-data"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
$(document).ready(function() {
var form = new FormData();
form.append('access_token', '{your access token}');
form.append('full_name', '{John Doe}');
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/updateaccount",
"method": "POST",
"processData": false,
"contentType": false,
"mimeType": "multipart/form-data",
"data": form
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
Create Account
POST/createaccount
Creates a new Simple Sign account.
Create Account
POST/createaccount
Creates a new Simple Sign account.
Creates a new Simple Sign account.
Description
Creates a new Simple Sign Account that is associated with the specified email address.
Request Parameters
email (required)
The email for the new Account
password (required)
The password for the new Account
full_name (required)
The full name of the new Account holder
company (required)
The company associated with the new Account
phone_no (optional)
The phone number of the new Account holder
Response
Returns a success message.
EXAMPLE REQUEST / RESPONSE
POST https://esign.simplesign.io/v3/createaccount
curl 'https://esign.simplesign.io/v3/createaccount \
Show response
$curlParams['email'] = '{email address}';
$curlParams['password'] = '{your password}';
$curlParams['full_name'] = '{your full name}';
$curlParams['company'] = '{your company name}';
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/createaccount",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => $curlParams,
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache",
"content-type: multipart/form-data"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
$(document).ready(function() {
var form = new FormData();
form.append('email', '{email address}');
form.append('password', '{your password}');
form.append('full_name', '{your full name}');
form.append('company', '{your company name}');
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/createaccount",
"method": "POST",
"processData": false,
"contentType": false,
"mimeType": "multipart/form-data",
"data": form
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
Account Data
GET/accountdata
Returns your account data usage.
Account Data
GET/accountdata
Returns your account data usage.
Returns your account data usage.
Description
Returns the information about your Simple Sign account usage.
Request Parameters
access_token (required)
The access token of your account
Response
Returns an Accountdata usage object.
EXAMPLE REQUEST / RESPONSE
GET https://esign.simplesign.io/v3/accountdata
curl 'https://esign.simplesign.io/v3/accountdata \
Show response
$curl=curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://esign.simplesign.io/v3/accountdata?access_token={Your access token}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'cache-control: no-cache'
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo'cURL Error #: '.$err;
} else {
echo $response;
}
$(document).ready(function() {
var settings = {
"async": true,
"crossDomain": true,
"url": "http://esign.simplesign.io/v3/accountdata?access_token={WvJ2gfoPU3cmzsthnEFe70lKobdBtt3SId3owcU1}",
"method": "GET",
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
TEMPLATE contains information about the templates created by you and other users in your organization.
ACTION
URI - DESCRIPTION
Get Templates
GET /gettemplates
Gets your templates.
Get Templates
GET /gettemplates
Gets your templates.
Gets your templates.
Description
Returns a list of the Templates that are accessible to you.
Request Parameters
access_token (required)
User access token
template_id (optional)
id for a specific template to get only particular template detail
page_limit (optional)
Records per page limits (default: 10)
current_page (optional)
Page index starting from 0 (default: 0)
Response
Returns a Template object
EXAMPLE REQUEST / RESPONSE
GET https://esign.simplesign.io/v3/gettemplates
curl 'https://esign.simplesign.io/v3/gettemplates' \
Show response
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/gettemplates?access_token={your access token}&page_limit={no of records}¤t_page={page number}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
$(document).ready(function() {
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/gettemplates?access_token={your access token}&page_limit={no of records}¤t_page={page number}",
"method": "GET"
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
Create Template
POST /createtemplate
Creates a template from a document you upload.
Create Template
POST /createtemplate
Creates a template from a document you upload.
Creates a template from a document you upload.
Description
Creates a template from the selected file. This template is added to your Simple Sign account using the corresponding user access token.
Request Parameters
access_token (required)
User access token
file (required)
Use file to upload document to send
Response
Returns a Template id
EXAMPLE REQUEST / RESPONSE
POST https://esign.simplesign.io/v3/createtemplate
curl 'https://esign.simplesign.io/v3/createtemplate' \
-F 'file=@NDA.pdf' \
Show response
-F 'file=@NDA.pdf' \
$cfile = new CURLFile(realpath('singlepage.pdf'));
$curlParams['access_token'] = '{your access token}';
$curlParams['file'] = $cfile;
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/createtemplate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 300,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => $curlParams,
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache",
"content-type: multipart/form-data"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #:" . $err;
} else {
$return = json_decode($response,true);
}
$(document).ready(function() {
$('#fileUpload').click(function() {
var form = new FormData();
form.append("access_token", "{your access token}");
form.append("file", $('#file_upload')[0].files[0]); //for jQuey code
form.append("file", document.getElementById('file_upload').files[0]); //for javascript code
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/createtemplate",
"method": "POST",
"processData": false,
"contentType": false,
"mimeType": "multipart/form-data",
"data": form
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
});
<form action="#" method="post" enctype="multipart/form-data">
<input type="file" name="file_upload" id="file_upload">
<input type="button" name="fileUpload" id="fileUpload" value="Upload">
</form>
Delete Template
POST /deletetemplates
Deletes the specified templates.
Delete Template
POST /deletetemplates
Deletes the specified templates.
Deletes the specified templates.
Description
Completely deletes the specified template(s) from your Simple Sign account. Provide the specific template ID(s) to delete the corresponding template(s).
Request Parameters
access_token (required)
User access token
templates (optional)
Response
Returns a success message.
EXAMPLE REQUEST / RESPONSE
POST https://esign.simplesign.io/v3/deletetemplates
curl 'https://esign.simplesign.io/v3/deletetemplates' \
Show response
$curlParams['access_token'] = '{your access token}';
$curlParams['templates'] = json_encode([41, 42]);
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/deletetemplates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => $curlParams,
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache",
"content-type: multipart/form-data"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
$(document).ready(function() {
var form = new FormData();
form.append('access_token', '{your access token}');
form.append('templates', '[41, 42]');
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/deletetemplates",
"method": "POST",
"processData": false,
"contentType": false,
"mimeType": "multipart/form-data",
"data": form
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
USERS contains information about your sub-users and their account settings.
ACTION
URI - DESCRIPTION
Get Users
GET /users
Gets your users' information and their account settings.
Get Users
GET /users
Gets your users' information and their account settings.
Gets your users' information and their account settings.
Description
Returns information about the users in your organization as well as their account settings. If your access token is incorrect, the error message of "Invalid access_token" will be returned.
Request Parameters
access_token (required)
User access token
page_limit (optional)
Records per page limits (default: 10)
current_page (optional)
Page index starting from 0 (default: 0)
Response
Returns Users object
EXAMPLE REQUEST / RESPONSE
GET https://esign.simplesign.io/v3/users
curl 'https://esign.simplesign.io/v3/users' \
Show response
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/users?access_token={your access token}&page_limit={no of records}¤t_page={page number}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
$(document).ready(function() {
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/users?access_token={your access token}&page_limit={no of records}¤t_page={page number}",
"method": "GET"
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
Create Users
POST /createusers
Creates new users in your Simple Sign organizational account.
Create Users
POST /createusers
Creates new users in your Simple Sign organizational account.
Creates new users in your Simple Sign organizational account.
Description
Creates new users in your Simple Sign organization and adds those new users into specified groups and roles. To add multiple users use multiple user keys.
Request Parameters
access_token (required)
User access token
users (required)
user_fields (optional)
EXAMPLE REQUEST / RESPONSE
POST https://esign.simplesign.io/v3/createusers
curl 'https://esign.simplesign.io/v3/createusers' \
Show response
$users = array(
[
'user_member' => [
'full_name' => 'Robin Williams',
'email' => 'robinwilliams@yopmail.com',
'password' => 'robin123'
],
'groups' => [
[
'group_name' => 'Developers',
'role_name' => 'Admin'
],
[
'group_name' => 'Default',
'role_name' => 'Member'
]
]
],
[
'user_member' => [
'full_name' => 'Heath Ledger',
'email' => 'heathledger@yopmail.com',
'password' => 'heath123'
],
'groups' => [
[
'group_name' => 'Default',
'role_name' => 'Member'
]
]
]
);
$userFields = [
[
'fields' => [
[
'title' => 'Company name',
'type' => 'text',
'value' => 'Test compnay'
],
[
'title' => 'Select expiry date',
'type' => 'datepicker',
'value' => '02/25/2020'
],
[
'title' => 'Gender',
'type' => 'droplist',
'options' => ['Male', 'Female'],
'value' => 'Make Two'
]
]
]
];
$curlParams['access_token'] = '{your access token}';
$curlParams['users'] = json_encode($users);
$curlParams['user_fields'] = json_encode($userFields);
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/createusers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => $curlParams,
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache",
"content-type: multipart/form-data"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
$(document).ready(function() {
var form = new FormData();
form.append('access_token', '{your access token}');
form.append('users', '[{"user_member": {"full_name": "Robin Williams", "email": "robinwilliams@yopmail.com", "password": "robin123"}, "groups": [{"group_name": "Developers", "role_name": "Admin"}, {"group_name": "Default", "role_name": "Member"}]}, {"user_member": {"full_name": "Heath Ledger", "email": "heathledger@yopmail.com", "password": "heath123"}, "groups": [{"group_name": "Default", "role_name": "Member"}]}]');
form.append('user_fields', '[{"fields": [{"title": "One", "type": "text", "value": "One Value"}, {"title": "Two", "type": "datepicker", "value": "02/25/2020"}, {"title": "Three Multiples Choicess", "type": "droplist", "options": ["Make One", "Make Two", "Make Three"], "value": "Make Two"}]}]');
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/createusers",
"method": "POST",
"processData": false,
"contentType": false,
"mimeType": "multipart/form-data",
"data": form
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
Update Users
POST /updateusers
Updates user information.
Update Users
POST /updateusers
Updates user information.
Updates user information.
Description
Updates user information along with groups and roles. To update multiple users use multiple user keys.
Request Parameters
access_token (required)
User access token
Users (required)
EXAMPLE REQUEST / RESPONSE
POST https://esign.simplesign.io/v3/updateusers
curl 'https://esign.simplesign.io/v3/updateusers' \
Show response
$users = array(
[
'user_member' => [
'account_id' => 284,
'full_name' => 'Robin Will',
'email' => 'robinwill@yopmail.com',
'password' => 'robin123'
],
'groups' => [
[
'group_name' => 'Developers',
'role_name' => 'Member'
],
[
'group_name' => 'Default',
'role_name' => 'Admin'
]
]
],
[
'user_member' => [
'account_id' => 285,
'full_name' => 'Heath Led',
'email' => 'heathled@yopmail.com',
'password' => 'heath123'
],
'groups' => [
[
'group_name' => 'Default',
'role_name' => 'Admin'
]
]
]
);
$curlParams['access_token'] = '{your access token}';
$curlParams['users'] = json_encode($users);
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/updateusers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => $curlParams,
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache",
"content-type: multipart/form-data"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
$(document).ready(function() {
var form = new FormData();
form.append('access_token', '{your access token}');
form.append('users', '[{"user_member": {"account_id": 284, "full_name": "Robin Will", "email": "robinwill@yopmail.com", "password": "robin123"}, "groups": [{"group_name": "Developers", "role_name": "Member"}, {"group_name": "Default", "role_name": "Admin"}]}, {"user_member": {"account_id": 285, "full_name": "Heath Led", "email": "heathled@yopmail.com", "password": "heath123"}, "groups": [{"group_name": "Default", "role_name": "Admin"}]}]');
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/updateusers",
"method": "POST",
"processData": false,
"contentType": false,
"mimeType": "multipart/form-data",
"data": form
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
Get User Info
GET /userinfo
Get user info for users in your account.
Get User Info
GET /userinfo
Get user info for users in your account.
Get user info for users in your account.
Description
Get details about all of the users in your organization. Each account_id corresponds to an organizational account and each access_token corresponds to a specific user within that organization.
Request Parameters
access_token (required)
User access token
account_id (required)
Account id
Response
Returns Users object
EXAMPLE REQUEST / RESPONSE
POST https://esign.simplesign.io/v3/userinfo
curl 'https://esign.simplesign.io/v3/userinfo' \
Show response
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/userinfo?access_token={your access token}&account_id={account id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
$(document).ready(function() {
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/userinfo?access_token={your access token}&account_id={account id}",
"method": "GET"
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
Delete Users
POST /deleteusers
Permanently deletes users who are in your organization.
Delete Users
POST /deleteusers
Permanently deletes users who are in your organization.
Permanently deletes users who are in your organization.
Description
Deletes users from your Simple Sign organizational account by providing the specific account ID, to delete multiple accounts provide multiple account IDs.
Request Parameters
access_token (required)
User access token
users (required)
EXAMPLE REQUEST / RESPONSE
POST https://esign.simplesign.io/v3/deleteusers
curl 'https://esign.simplesign.io/v3/deleteusers' \
Show response
$curlParams['access_token'] = '{your access token}';
$curlParams['user'] = json_encode([284, 285]);
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/deleteusers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => $curlParams,
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache",
"content-type: multipart/form-data"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
$(document).ready(function() {
var form = new FormData();
form.append('access_token', '{your access token}');
form.append('user', '[284, 285]');
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/deleteusers",
"method": "POST",
"processData": false,
"contentType": false,
"mimeType": "multipart/form-data",
"data": form
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
Activate/Deactivate Users
POST /changeuserstatus
Activate/Deactivate a user.
Activate/Deactivate Users
POST /changeuserstatus
Activate/Deactivate a user.
Activate/Deactivate a user.
Description
Activate and deactivate users by providing the account ID and the correct user access token. Additionally, provide the status you wish to assign to the corresponding user.
Request Parameters
access_token (required)
User access token
account_id (required)
User access token
status (required)
active for activate, inactive for deactivate the team member
EXAMPLE REQUEST / RESPONSE
POST https://esign.simplesign.io/v3/changeuserstatus
curl 'https://esign.simplesign.io/v3/changeuserstatus' \
Show response
$curlParams['access_token'] = "{your access token}";
$curlParams['account_id'] = "{your account id}";
$curlParams['status'] = "active";
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/changeuserstatus",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => $curlParams,
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache",
"content-type: multipart/form-data"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
$(document).ready(function() {
var form = new FormData();
form.append('access_token', '{your access token}');
form.append('account_id', '{your account id}');
form.append('status', 'active');
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/changeuserstatus",
"method": "POST",
"processData": false,
"contentType": false,
"mimeType": "multipart/form-data",
"data": form
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
SEND DOCUMENT contains information regarding documents that need to be signed.
ACTION
URI - DESCRIPTION
Send Document
POST /senddocument
Creates a signature request using your own file (.pdf .docx .xls).
Send Document
POST /senddocument
Creates a signature request using your own file (.pdf .docx .xls).
Creates a signature request using your own file (.pdf .docx .xls).
Description
Send a new signature request with your chosen file (.pdf .docx .xls file type only). If you want to add a signature box for your recipients, then input the tag #signer-1# in the location of the document where you want the signature box to be. To add signature boxes for additional reipients add #signer-2#, #signer-3#, etc. for the second recipient, 3rd recipient, etc.
Request Parameters
access_token (required)
User access token
file or files[] (required)
Use file or files[] which indicates the uploaded document file(s) to be sent for signature
recipients (required)
The recipients variable contains all of the information regarding the recipient while the people_fields key contains contact information about the recipient(s), organization_fields key contains information about the organization, and the details key contains additional specific recipient information such as the authentication and invitation method for that recipient
attachment (optional)
Attach an extra file with your document (can be .pdf, .docx, .xls, .png, .jpeg, .jpg)
You can attach multiple files by repeating the same parameters, such as attachment2 (optional), attachment2_name, attachment2_mandatory (optional) and so on.
attachment_name (optional)
Add name to attached file
attachment_mandatory (optional)
Make it mandatory for your recipient to read your attachment before being able to sign the document (1 for mandatory and 0 for optional)
show_attachment (optional)
The attachment will be either preopened (1) or closed (0) for the recipient. 1 is for preopened and 0 is for closed.
sender_email (optional)
Set this parameter if you want to send the document from this specific sub-user's email
visible_name (optional)
The title of your document (shown to the recipients)
folder_name (optional)
When including this parameter in conjunction with the specified endpoint, the signed copy of the document will be stored in the folder with the name added to your Simple Sign account
language_id (optional)
Language (en, sv, de, fi, fr, no, da, es, pl, sk)
Note: English en, Swedish sv, German de, Finnish fi, French fr, Norwegian no, Danish da, Spanish es, Polish pl, Slovakia sk.
due_days (optional)
Number of days until document expires (e.g. 1, 2, 12)
reminder_days (optional)
Number of days until a reminder is sent (e.g. 1, 2, 12) and should be noted that the reminder is only sent to those who haven't signed
invitation_message (optional)
Invitation message you wish to to display in the invitation email
confirmation_message (optional)
Confirmation message you wish to send after the document is signed
video_title (optional)
Title of the video you want to display on the signing page
video or video_url (optional)
Use video_url to add a YouTube or Vimeo video to the signing page while on the other hand using the variable video to upload your own video file (file type must be mp4 and file size must be less than 10mb)
invitation_url (optional)
Invitation_url returns the signing URL for your recipient instead of sending them an invitation email for them to sign (1 for return link and 0 for sending document via email)
iframe_url (optional)
Generates GUI URL for sending the document selected document. (1 for return link and 0 for sending document via email)
iframe_settings (optional)
Pass a json object in iframe_settings like showing below where 1 is to activate and 0 is to deactivate the specific setting.
document_chat (optional)
Enable the chat on document for your recipient. (1 for enable the chat and 0 for disable chat)
transfer_signature_role (optional)
Enable the transfer signature role for your recipient. (1 for enable the transfer signature and 0 for disable transfer signature)
Add signature box to PDF (optional)
By using #signer-1# tag in your pdf document, you can add signature box for single recipient. For multiple recipients add tags like, #signer-1#, #signer-2#
Minimum font size must be 16px, font style must be Arial
redirect_url (optional)
Your recipient will be redirected to the given URL after sign.
document_type (optional)
Categorize your templates and documents into Contract types. This will make your account more organized and you will have an easier way to find your documents and templates when needed.
document_key (optional)
Add an extra level of security to your sensitive documents by making them password protected.
Response
Returns a success message
EXAMPLE REQUEST / RESPONSE
POST https://esign.simplesign.io/v3/senddocument
curl 'https://esign.simplesign.io/v3/senddocument'
Show response
$cfile = new CURLFile(realpath('singlepage.pdf'));
$recipients = array(
[
'people_fields' => [
'name' => 'John Smith',
'email' => 'johnsmith@yopmail.com',
'personal_no' => '19800130-1234',
'mobile' => '+46701234567',
'address' => 'Sturegatan 1',
'city' => 'Stockholm',
'zipcode'=>'111 22'
],
'organization_fields' => [
'name' => 'Tesla Innovations AB',
'org_no' => '556677-8899',
'phone' => '+46754893027'
],
'details' => [
'recipient_role' => 'CEO',
'authentication' => 'Regular Signature',
'invitation_type' => 'email',
'invitation_order' => '1',
'confirmation' => 'email',
'id_attachment' => 'no'
]
],
[
'people_fields' => [
'name' => 'Gillian Andersson',
'email' => 'gillianandersson@yopmail.com',
'personal_no' => '19800130-0122',
'mobile' => '+46701255487',
'address' => 'Sturegatan 2',
'city' => 'London',
'zipcode' => '555 88'
],
'details' => [
'recipient_role' => 'EMPLOYEE',
'authentication' => 'pin via sms',
'invitation_type' => 'pos',
'invitation_order' => '1',
'confirmation' => 'email',
'id_attachment' => 'no'
]
]
);
$curlParams['access_token'] = '{your access token}';
$curlParams['file'] = $cfile;
$curlParams['recipients'] = json_encode($recipients);
$curlParams['language_id'] = 'en';
$curlParams['invitation_message'] = 'This is invitation message';
$curlParams['confirmation_message'] = 'This is confirmation message';
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/senddocument",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => $curlParams,
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache",
"content-type: multipart/form-data"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
$(document).ready(function() {
$('#fileUpload').click(function() {
var form = new FormData();
form.append("access_token", "{your access token}");
form.append("recipients", '[{"people_fields": {"name":"John Smith", "email": "johnsmith@yopmail.com", "personal_no": "19800130-1234", "mobile": "+46701234567", "address": "Sturegatan 1", "city": "Stockholm", "zipcode": "111 22"}, "organization_fields": {"name": "Tesla Innovations AB", "org_no": "556677-8899", "phone": "+46754893027"}, "details": {"recipient_role": "CEO", "authentication": "Regular Signature", "invitation_type": "email", "invitation_order": "1", "confirmation": "email", "id_attachment": "no"}}, {"people_fields": {"name":"Gillian Andersson", "email": "gillianandersson@yopmail.com", "personal_no": "19800130-0122", "mobile": "+46701255487", "address": "Sturegatan 2", "city": "London", "zipcode": "555 88"}, "details": {"recipient_role": "EMPLOYEE", "authentication": "pin via sms", "invitation_type": "pos", "invitation_order": "1", "confirmation": "email", "id_attachment": "no"}}]');
form.append("file", $('#file_upload')[0].files[0]); //for jQuey code
form.append("file", document.getElementById('file_upload').files[0]); //for javascript code
form.append("language_id", "en");
form.append("invitation_message", "This is invitation message");
form.append("confirmation_message", "This is confirmation message");
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/senddocument",
"method": "POST",
"processData": false,
"contentType": false,
"mimeType": "multipart/form-data",
"data": form
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
});
<form action="#" method="post" enctype="multipart/form-data">
<input type="file" name="file_upload" id="file_upload">
<input type="button" name="fileUpload" id="fileUpload" value="Upload">
</form>
Send Prebuilt Template
POST /sendtemplate
Creates a signature request using an already built template saved in your Simple Sign account.
Send Prebuilt Template
POST /sendtemplate
Creates a signature request using an already built template saved in your Simple Sign account.
Creates a signature request using an already built template saved in your Simple Sign account.
Description
Creates and sends a new signature request based off of the template specified with the template_id parameter.
Request Parameters
access_token (required)
User access token
template_id (required)
Use template_id to create a signature request
recipients (required)
The recipients variable contains all of the information regarding the recipient while the people_fields key contains contact information about the recipient(s), organization_fields key contains information about the organization, and the details key contains additional specific recipient information such as the authentication and invitation method for that recipient
documentfields (optional)
The documentfields variable contains all information regarding document fields and should be noted that document fields are related with the document only, not with recipient/contact information
create_tables (optional)
Generate dynamic data table(s) in your template. When you include this parameter, a data table will be added to your
template.
sender_email (optional)
Set this parameter if you want to send the document from this specific sub-user's email
visible_name (optional)
The title of your document (shown to the recipients)
folder_name (optional)
When including this parameter in conjunction with the specified endpoint, the signed copy of the document will be stored in the folder with the name added to your Simple Sign account
language_id (optional)
Language (en, sv, de, fi, fr, no, da, es, pl, sk)
Note: English en, Swedish sv, German de, Finnish fi, French fr, Norwegian no, Danish da, Spanish es, Polish pl, Slovakia sk.
due_days (optional)
Number of days until document expires (e.g. 1, 2, 12)
reminder_days (optional)
Number of days until a reminder is sent (e.g. 1, 2, 12) and should be noted that the reminder is only sent to those who haven't signed
invitation_message (optional)
Invitation message you wish to to display in the invitation email
confirmation_message (optional)
Confirmation message you wish to send after the document is signed
video_title (optional)
Title of the video you want to display on the signing page
video or video_url (optional)
Use video_url to add a YouTube or Vimeo video to the signing page while on the other hand using the variable video to upload your own video file (file type must be mp4 and file size must be less than 10mb)
iframe_url (optional)
Generates GUI URL for sending the document selected document. (1 for return link and 0 for sending document via email)
document_chat (optional)
Enable the chat on document for your recipient. (1 for enable the chat and 0 for disable chat)
transfer_signature_role (optional)
Enable the transfer signature role for your recipient. (1 for enable the transfer signature and 0 for disable transfer signature)
invitation_url (optional)
Invitation_url returns the signing URL for your recipient instead of sending them an invitation email for them to sign (1 for return link and 0 for sending document via email)
redirect_url (optional)
Your recipient will be redirected to the given URL after sign.
attachment_#attachment-name# (optional)
By using this parameter you can add attachment in your template.
#attachment-name# must be replaced with the name of attachment that is used in the template from attachment settings. (Format could be: .pdf, .jpg, .jpeg, .doc, .docx, .png, .xls)
#attachment-name# must be replaced with the name of attachment that is used in the template from attachment settings. (Format could be: .pdf, .jpg, .jpeg, .doc, .docx, .png, .xls)
show_attachment (optional)
The attachment will be either preopened (1) or closed (0) for the recipient. 1 is for preopened and 0 is for closed.
Response
Returns a succesfulmessage
EXAMPLE REQUEST / RESPONSE
POST https://esign.simplesign.io/v3/sendtemplate
curl 'https://esign.simplesign.io/v3/sendtemplate' \
Show response
$recipients = array(
[
'people_fields' => [
'name' => 'John Smith',
'email' => 'johnsmith@yopmail.com',
'personal_no' => '19800130-1234',
'mobile' => '+46701234567',
'address' => 'Sturegatan 1',
'city' => 'Stockholm',
'zipcode' => '111 22'
],
'organization_fields' => [
'name' => 'Tesla Innovations AB',
'org_no' => '556677-8899',
'phone' => '+46754893027'
],
'details' => [
'recipient_role' => 'CEO',
'authentication' => 'Regular Signature',
'invitation_type' => 'email',
'invitation_order' => '1',
'confirmation' => 'email',
'id_attachment' => 'no'
]
],
[
'people_fields' => [
'name' => 'Gillian Andersson',
'email' => 'gillianandersson@yopmail.com',
'personal_no' => '19800130-0122',
'mobile' => '+46701255487',
'address' => 'Sturegatan 2',
'city' => 'London',
'zipcode' => '555 88'
],
'details' => [
'recipient_role' => 'EMPLOYEE',
'authentication' => 'Regular Signature',
'invitation_type' => 'pos',
'invitation_order' => '1',
'confirmation' => 'email',
'id_attachment' => 'no'
]
]
);
$curlParams['access_token'] = '{your access token}';
$curlParams['template_id'] = '{template_id}';
$curlParams['recipients'] = json_encode($recipients);
$curlParams['language_id'] = 'en';
$curlParams['invitation_message'] = 'This is invitation message';
$curlParams['confirmation_message'] = 'This is confirmation message';
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/sendtemplate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => $curlParams,
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache",
"content-type: multipart/form-data"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
$(document).ready(function() {
var form = new FormData();
form.append("access_token", "{your access token}");
form.append("template_id", "{template_id}");
form.append("recipients", '[{"people_fields": {"name":"John Smith", "email": "johnsmith@yopmail.com", "personal_no": "19800130-1234", "mobile": "+46701234567", "address": "Sturegatan 1", "city": "Stockholm", "zipcode": "111 22"}, "organization_fields": {"name": "Tesla Innovations AB", "org_no": "556677-8899", "phone": "+46754893027"}, "details": {"recipient_role": "CEO", "authentication": "Regular Signature", "invitation_type": "email", "invitation_order": "1", "confirmation": "email", "id_attachment": "no"}}, {"people_fields": {"name":"Gillian Andersson", "email": "gillianandersson@yopmail.com", "personal_no": "19800130-0122", "mobile": "+46701255487", "address": "Sturegatan 2", "city": "London", "zipcode": "555 88"}, "details": {"recipient_role": "EMPLOYEE", "authentication": "Regular Signature", "invitation_type": "pos", "invitation_order": "1", "confirmation": "email", "id_attachment": "no"}}]');
form.append("language_id", "sv");
form.append("invitation_message", "This is invitation message");
form.append("confirmation_message", "This is confirmation message");
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/sendtemplate",
"method": "POST",
"processData": false,
"contentType": false,
"mimeType": "multipart/form-data",
"data": form
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
Generate Iframe URL
POST /generateiframe
Generates GUI URL for sending the specific document or already built template from your account.
Generate Iframe URL
POST /generateiframe
Generates GUI URL for sending the specific document or already built template from your account.
Generates GUI URL for sending the specific document or already built template from your account.
Description
Generates GUI URL for sending the specific document or already built template from your account.
Request Parameters
access_token (required)
User access token
file (required)
Use file which indicates the uploaded document file(s) to be sent for signature in iframe
template_id (optional)
To populate pre built templates from your account in to iframe.
Response
Returns a success message
EXAMPLE REQUEST / RESPONSE
POST https://esign.simplesign.io/v3/generateiframe
curl 'https://esign.simplesign.io/v3/generateiframe' \
Show response
$curlParams['access_token'] = 'WvJ2kroPU3cmzsINnEFe70lKobdBtt3SId3owcU1';
$curlParams['file'] = new CURLFile(realpath('singlepage.pdf'));
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://esign.simplesign.io/v3/generateiframe',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => $curlParams,
CURLOPT_HTTPHEADER => array(
'cache-control: no-cache',
'content-type: multipart/form-data'
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #: " . $err;
} else {
echo $response;
}
$(document).ready(function() {
$('#fileUpload').click(function() {
var form = new FormData();
form.append("access_token", "{your access token}");
form.append("file", $('#file_upload')[0].files[0]); //for jQuey code
form.append("file", document.getElementById('file_upload').files[0]); //for javascript code
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/generateiframe",
"method": "POST",
"processData": false,
"contentType": false,
"mimeType": "multipart/form-data",
"data": form
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
});
<form action="#" method="post" enctype="multipart/form-data">
<input type="file" name="file_upload" id="file_upload">
<input type="button" name="fileUpload" id="fileUpload" value="Upload">
</form>
Revoke Document
POST /revokedocument
Revoke your documents
Revoke Document
POST /revokedocument
Revoke your documents
Revoke your documents
Description
You can revoke your sent documents
Request Parameters
access_token (required)
User access token
document_id (required)
ID for a specific document
Response
Returns a success message
EXAMPLE REQUEST / RESPONSE
POST https://esign.simplesign.io/v3/revokedocument
curl 'https://esign.simplesign.io/v3/revokedocument' \
Show response
$curlParams['access_token'] = 'WvJ2kroPU3cmzsINnEFe70lKobdBtt3SId3owcU1';
$curlParams['document_id'] = 5436;
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://esign.simplesign.io/v3/revokedocument',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => $curlParams,
CURLOPT_HTTPHEADER => array(
'cache-control: no-cache',
'content-type: multipart/form-data'
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #: " . $err;
} else {
echo $response;
}
$(document).ready(function() {
var form = new FormData();
form.append("access_token", "{your access token}");
form.append("document_id", 5436);
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/revokedocument",
"method": "POST",
"processData": false,
"contentType": false,
"mimeType": "multipart/form-data",
"data": form
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
CONTACTS contains information about your people.
ACTION
URI - DESCRIPTION
Get People
GET /people
Gets all of the people added by a specific user.
Get People
GET /people
Gets all of the people added by a specific user.
Gets all of the people added by a specific user.
Description
Gets the complete information of all people details from your Simple Sign account with the access token.
Request Parameters
access_token (required)
User access token
page_limit (optional)
Records per page limits (default: 10)
current_page (optional)
Page index starting from 0 (default: 0)
Response
Returns People object
EXAMPLE REQUEST / RESPONSE
GET https://esign.simplesign.io/v3/people
curl 'https://esign.simplesign.io/v3/people' \
Show response
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/people?access_token={your access token}&page_limit={no of records}¤t_page={page number}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
$(document).ready(function() {
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/people?access_token={your access token}&page_limit={no of records}¤t_page={page number}",
"method": "GET"
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
Add People
POST /addpeople
Adds new people into your contact directory.
Add People
POST /addpeople
Adds new people into your contact directory.
Adds new people into your contact directory.
Description
Adds new people into contact directory. To add multiple people use multiple people_fields keys while putting the contact data in the people variable. To connect that people with an organization simply provide the name of the organization in people_fields key.
Request Parameters
access_token (required)
User access token
people (required)
Response
Returns People id(s) object
EXAMPLE REQUEST / RESPONSE
POST https://esign.simplesign.io/v3/addpeople
curl 'https://esign.simplesign.io/v3/addpeople' \
Show response
$people = array(
[
'people_fields' => [
'first_name' => 'John',
'last_name' => 'Smith',
'email' => 'johnsmith@yopmail.com',
'personal_no' => '19811228-9874',
'mobile' => '+46714879421',
'address' => 'Sturegatan',
'city' => 'Stockholm',
'zipcode' => '111 24',
'country' => 'Sweden'
]
],
[
'people_fields' => [
'first_name' => 'Gillian',
'last_name' => 'Andersson',
'email' => 'gillianandersson@yopmail.com',
'personal_no' => '19670919-9530',
'mobile' => '+46713476895',
'address' => 'Svartmangatan',
'city' => 'Stockholm',
'zipcode' => '111 30',
'country' => 'Sweden'
]
]
);
$curlParams['access_token'] = '{your access token}';
$curlParams['people'] = json_encode($people);
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/addpeople",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => $curlParams,
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache",
"content-type: multipart/form-data"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
$(document).ready(function() {
var form = new FormData();
form.append("access_token", "{your access token}");
form.append("people", '[{"people_fields": {"first_name": "John", "last_name": "Smith", "email": "johnsmith@yopmail.com", "personal_no": "19811228-9874", "mobile": "+46714879421", "address": "Sturegatan", "city": "Stockholm", "zipcode": "111 24", "country": "Sweden"}}, {"people_fields": {"first_name": "Gillian", "last_name": "Andersson", "email": "gillianandersson@yopmail.com", "personal_no": "19670919-9530", "mobile": "+46713476895", "address": "Svartmangatan", "city": "Stockholm", "zipcode": "111 30", "country": "Sweden"}}]');
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/addpeople",
"method": "POST",
"processData": false,
"contentType": false,
"mimeType": "multipart/form-data",
"data": form
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
Update People
POST /updatepeople
Updates existing people in your contact directory.
Update People
POST /updatepeople
Updates existing people in your contact directory.
Updates existing people in your contact directory.
Description
Updates the information of existing people. To update multiple people use multiple people_fields keys with the correct contact data stored in the people variable.
Request Parameters
access_token (required)
User access token
people (required)
Response
Returns a success message.
EXAMPLE REQUEST / RESPONSE
POST https://esign.simplesign.io/v3/updatepeople
curl 'https://esign.simplesign.io/v3/updatepeople' \
-f 123
Show response
-f 123
$people = array(
[
'people_fields' => [
'people_id' => 282,
'first_name' => 'John',
'last_name' => 'Smith',
'email' => 'johnsmith@yopmail.com',
'personal_no' => '19811228-9874',
'mobile' => '+46714879421',
'address' => 'Sturegatan',
'zipcode' => '111 24',
'city' => 'Stockholm',
'country' => 'Sweden'
]
],
[
'people_fields' => [
'people_id' => 283,
'first_name' => 'Gillian',
'last_name' => 'Andersson',
'email' => 'gillianandersson@yopmail.com',
'personal_no' => '19670919-9530',
'mobile' => '+46713476895',
'address' => 'Svartmangatan',
'zipcode' => '111 30',
'city' => 'Stockholm',
'country' => 'Sweden'
]
]
);
$curlParams['access_token'] = '{your access token}';
$curlParams['people'] = json_encode($people);
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/updatepeople",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => $curlParams,
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache",
"content-type: multipart/form-data"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
$(document).ready(function() {
var form = new FormData();
form.append('access_token', '{your access token}');
form.append('people', '[{"people_fields": {"people_id": "282", "first_name": "John", "last_name": "Smith", "email": "johnsmith@yopmail.com", "personal_no": "19811228-9874", "mobile": "+46714879421", "address": "Sturegatan", "zipcode": "111 24", "city": "Stockholm", "country": "Sweden"}}, {"people_fields": {"people_id": "283", "first_name": "Gillian", "last_name": "Andersson", "email": "gillianandersson@yopmail.com", "personal_no": "19670919-9530", "mobile": "+46713476895", "address": "Svartmangatan", "zipcode": "111 30", "city": "Stockholm", "country": "Sweden"}}]');
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/updatepeople",
"method": "POST",
"processData": false,
"contentType": false,
"mimeType": "multipart/form-data",
"data": form
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
Get People Info
GET /peopleinfo
Gets details of a specific people based on the specific people ID you submit.
Get People Info
GET /peopleinfo
Gets details of a specific people based on the specific people ID you submit.
Gets details of a specific people based on the specific people ID you submit.
Description
Gets the information for a specific people. Provide an access_token (the user that added the people) and a people_id (the specific people).
Request Parameters
access_token (required)
User access token
people_id (required)
People id
Response
Returns People object
EXAMPLE REQUEST / RESPONSE
GET https://esign.simplesign.io/v3/peopleinfo
curl 'https://esign.simplesign.io/v3/peopleinfo' \
-f 123
Show response
-f 123
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/peopleinfo?access_token={your access token}&people_id={people id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
$(document).ready(function() {
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/peopleinfo?access_token={your access token}&people_id={people id}",
"method": "GET",
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
Delete People
POST /deletepeople
Deletes the people in your contact directory.
Delete People
POST /deletepeople
Deletes the people in your contact directory.
Deletes the people in your contact directory.
Description
Deletes a people from your contact directory by providing the specific people_id corresponding with the correct people. Provide multiple IDs to delete multiple people.
Request Parameters
access_token (required)
User access token
people (required)
Response
EXAMPLE REQUEST / RESPONSE
POST https://esign.simplesign.io/v3/deletepeople
curl 'https://esign.simplesign.io/v3/deletepeople' \
-f 123
Show response
-f 123
$curlParams['access_token'] = '{your access token}';
$curlParams['people'] = json_encode([282, 283]);
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/deletepeople",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => $curlParams,
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache",
"content-type: multipart/form-data"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
$(document).ready(function() {
var form = new FormData();
form.append('access_token', '{your access token}');
form.append('people', '[282, 283]');
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/deletepeople",
"method": "POST",
"processData": false,
"contentType": false,
"mimeType": "multipart/form-data",
"data": form
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
YOUR DOCUMENTS contains information about documents that you and users in your organization have sent.
ACTION
URI - DESCRIPTION
Get All Documents
GET /alldocuments
Returns your sent documents.
Get All Documents
GET /alldocuments
Returns your sent documents.
Returns your sent documents.
Description
Returns a full list of your sent documents.
Request Parameters
access_token (required)
User access token
document_limit (optional)
Records per page limits (default: 25)
current_page (optional)
Page number starting from 1 (default: 1)
user_id (optional)
ID of your User / Team mate to get related documents with specific account.
from_date (optional)
Specify the date to get document from date (default: YYYY-MM-DD).
Fetch documents from a specific sent date.
Note: Hours must be in 24 hours format
to_date (optional)
Specify the date to get document to date (default: YYYY-MM-DD)
Documents will be fetched till date.
Note: Hours must be in 24 hours format
task_filter (optional)
Provide the task name with its status to get specific data.
Note: status should be passed (yes, no and in_process).
Note: status should be passed (yes, no and in_process).
completed_fromdate (optional)
Specify the date to get document (only completed) from date (default: YYYY-MM-DD).
Fetch documents from a specific completed date.
Note: Hours must be in 24 hours format
Note: Hours must be in 24 hours format
completed_todate (optional)
Specify the date to get document (only document) to date (default: YYYY-MM-DD)
Completed documents will be fetched till date.
Note: Hours must be in 24 hours format
Note: Hours must be in 24 hours format
Response
Returns a Document object
EXAMPLE REQUEST / RESPONSE
GET https://esign.simplesign.io/v3/alldocuments
curl 'https://esign.simplesign.io/v3/alldocuments' \
Show response
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/alldocuments?access_token={your access token}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
$(document).ready(function() {
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/alldocuments?access_token={your access token}",
"method": "GET"
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
Get Signed Documents
GET /signeddocuments
Returns your signed documents only.
Get Signed Documents
GET /signeddocuments
Returns your signed documents only.
Returns your signed documents only.
Description
Returns a full list of your signed documents only.
Request Parameters
access_token (required)
User access token
order (required)
Reorganizes records into ascending or descending order (default: ascending order).
Pass asc for ascending and desc for descending
user_id (optional)
ID of your User / Team mate to get related documents with specific account.
from_date (optional)
Specify the date to get document from date (default: YYYY-MM-DD-HH-MM-SS)
Fetch documents from a specific signed date
Note: Hours must be in 24 hours format
to_date (optional)
Specify the date to get document to date (default: YYYY-MM-DD-HH-MM-SS)
Documents will be fetched till date.
Note: Hours must be in 24 hours format
document_type (optional)
Specify the document type to retrieve all documents related to the specified document type.
task_filter (optional)
Provide the task name with its status to get specific data.
Note: status should be passed (yes, no and in_process).
Note: status should be passed (yes, no and in_process).
completed_fromdate (optional)
Specify the date to get document (only completed) from date (default: YYYY-MM-DD).
Fetch documents from a specific completed date.
Note: Hours must be in 24 hours format
Note: Hours must be in 24 hours format
completed_todate (optional)
Specify the date to get document (only document) to date (default: YYYY-MM-DD)
Completed documents will be fetched till date.
Note: Hours must be in 24 hours format
Note: Hours must be in 24 hours format
Response
Returns a Document object
EXAMPLE REQUEST / RESPONSE
GET https://esign.simplesign.io/v3/signeddocuments
curl 'https://esign.simplesign.io/v3/signeddocuments' \
Show response
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/signeddocuments?access_token={your access token}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
$(document).ready(function() {
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/signeddocuments?access_token={your access token}",
"method": "GET"
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
Get Document Details
GET /specificdocumentdetail
Gets all of the details regarding a document.
Get Document Details
GET /specificdocumentdetail
Gets all of the details regarding a document.
Gets all of the details regarding a document.
Description
To get details about your sent documents.
Request Parameters
access_token (required)
User access token
document_id (required)
id for a specific document
EXAMPLE REQUEST / RESPONSE
GET https://esign.simplesign.io/v3/specificdocumentdetail
curl 'https://esign.simplesign.io/v3/specificdocumentdetail' \
Show response
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/specificdocumentdetail?access_token={your access token}&document_id={your document id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
$(document).ready(function() {
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/specificdocumentdetail?access_token={your access token}&document_id={your document id}",
"method": "GET"
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
Get Document Details by Status
GET /getdocumentinfobystatus
Returns the details of sent document(s) with respect to the given status.
Get Document Details by Status
GET /getdocumentinfobystatus
Returns the details of sent document(s) with respect to the given status.
Returns the details of sent document(s) with respect to the given status.
Description
Return the details of sent document(s) with respect to the given status.
The parameters to use are:
access_token (required)
User access token
status (required)
Status of document (delivered, reviewed, signed, rejected)
document_id (optional)
id for a specific document to get only particular document details
page_limit (required)
Records per page limits (default: 10)
current_page (required)
Page index starting from 0 (default: 0)
user_id (optional)
ID of your User / Team mate to get related documents with specific account.
from_date (optional)
Specify the date to get document from date (default: YYYY-MM-DD)
Note: Hours must be in 24 hours format
to_date (optional)
Specify the date to get document to date (default: YYYY-MM-DD)
Note: Hours must be in 24 hours format
task_filter (optional)
Provide the task name with its status to get specific data.
Note: status should be passed (yes, no and in_process).
Note: status should be passed (yes, no and in_process).
completed_fromdate (optional)
Specify the date to get document (only completed) from date (default: YYYY-MM-DD).
Fetch documents from a specific completed date.
Note: Hours must be in 24 hours format
Note: Hours must be in 24 hours format
completed_todate (optional)
Specify the date to get document (only document) to date (default: YYYY-MM-DD)
Completed documents will be fetched till date.
Note: Hours must be in 24 hours format
Note: Hours must be in 24 hours format
Response
Returns the info of sent documents with respect to the given status.
EXAMPLE REQUEST / RESPONSE
GET https://esign.simplesign.io/v3/getdocumentinfobystatus
curl 'https://esign.simplesign.io/v3/getdocumentinfobystatus' \
Show response
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/getdocumentinfobystatus?access_token={your access token}&status=signed",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
$(document).ready(function() {
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/getdocumentinfobystatus?access_token={your access token}&status=signed",
"method": "GET"
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
Delete Document
POST /deletedocument
Delete the document.
Delete Document
POST /deletedocument
Delete the document.
Delete the document.
Description
Completely deletes the un-signed document from the system.
Request Parameters
access_token (required)
User access token
document_id (required)
Document id you want to delete
email (required)
Email address of account owner
confirm_text (required)
Enter delete in confirm_text
EXAMPLE REQUEST / RESPONSE
POST https://esign.simplesign.io/v3/deletedocument
curl 'https://esign.simplesign.io/v3/deletedocument' \
-F 112'
Show response
-F 112'
$curlParams['access_token'] = '{your access token}';
$curlParams['document_id'] = '1455';
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/deletedocument",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => $curlParams,
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache",
"content-type: multipart/form-data"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
$(document).ready(function() {
var form = new FormData();
form.append('access_token', '{your access token}');
form.append('document_id', '1455');
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/deletedocument",
"method": "POST",
"processData": false,
"contentType": false,
"mimeType": "multipart/form-data",
"data": form
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
Get Document PDF
GET /getdocumentpdf
Download Document PDF.
Get Document PDF
GET /getdocumentpdf
Download Document PDF.
Download Document PDF.
Description
Download a PDF of the document.
Request Parameters
access_token (required)
User access token
document_id (required)
Signed document id
EXAMPLE REQUEST / RESPONSE
GET https://esign.simplesign.io/v3/getdocumentpdf
curl 'https://esign.simplesign.io/v3/getdocumentpdf
Show response
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/getdocumentpdf?access_token={your access token}&document_id=16669",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => "",
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
$(document).ready(function() {
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/getdocumentpdf?access_token={your access token}&document_id=16669",
"method": "GET"
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
Send Reminder
POST /remindertorecipients
Send a reminder to the recipients.
Send Reminder
POST /remindertorecipients
Send a reminder to the recipients.
Send a reminder to the recipients.
Description
Sends a reminder to recipients of a particular document. * This reminder will only be sent to those parties that haven't signed this document.
Request Parameters
access_token (required)
User access token
document_id (required)
document id
reminder_type (required)
Reminder type 1 for Email, 2 for SMS, 3 for both SMS & Email
EXAMPLE REQUEST / RESPONSE
POST https://esign.simplesign.io/v3/remindertorecipients
curl 'https://esign.simplesign.io/v3/remindertorecipients' \
Show response
$curlParams['access_token'] = '{your access token}';
$curlParams['document_id'] = 136427;
$curlParams['reminder_type'] = 3;
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/remindertorecipients",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => $curlParams,
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache",
"content-type: multipart/form-data"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
$(document).ready(function() {
var form = new FormData();
form.append("access_token", "{your access token}");
form.append("document_id", 136427);
form.append("reminder_type", 3);
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/remindertorecipients",
"method": "POST",
"processData": false,
"contentType": false,
"mimeType": "multipart/form-data",
"data": form
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
Revoke Document
POST /revokedocument
Revoke your sent document.
Revoke Document
POST /revokedocument
Revoke your sent document.
Revoke your sent document.
Description
Revoke your sent document.
Request Parameters
access_token (required)
User access token
document_id (required)
document id
EXAMPLE REQUEST / RESPONSE
POST https://esign.simplesign.io/v3/revokedocument
curl 'https://esign.simplesign.io/v3/revokedocument' \
Show response
$curlParams['access_token'] = '{your access token}';
$curlParams['document_id'] = 526257;
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/revokedocument",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => $curlParams,
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache",
"content-type: multipart/form-data"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
$(document).ready(function() {
var form = new FormData();
form.append("access_token", "{your access token}");
form.append("document_id", 526257);
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/revokedocument",
"method": "POST",
"processData": false,
"contentType": false,
"mimeType": "multipart/form-data",
"data": form
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
Contract Control contains information about contract that you and users in your organization have created.
ACTION
URI - DESCRIPTION
Get All Contracts
GET /allcontracts
Returns your created contracts.
Get All Contracts
GET /allcontracts
Returns your created contracts.
Returns your created contracts.
Description
Returns a full list of your created contracts.
Request Parameters
access_token (required)
User access token
page_limit (optional)
Records per page limits (default: 10)
current_page (optional)
Page number starting from 1 (default: 1)
category (optional)
Category name
type_name (optional)
Document type name
Response
Returns a Contract object
EXAMPLE REQUEST / RESPONSE
GET https://esign.simplesign.io/v3/allcontracts
curl 'https://esign.simplesign.io/v3/allcontracts' \
Show response
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/allcontracts?access_token={your access token}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
$(document).ready(function() {
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/allcontracts?access_token={your access token}",
"method": "GET"
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
Create Contract
POST /createcontractcontrol
Create a contract in contract control.
Create Contract
POST /createcontractcontrol
Create a contract in contract control.
Create a contract in contract control.
Description
Create a contract in contract control
Request Parameters
access_token (required)
User access token
contract_control_name (required)
Contract name
category (optional)
Category name
document_type (optional)
Document type name
Response
Returns a Contract object
EXAMPLE REQUEST / RESPONSE
GET https://esign.simplesign.io/v3/createcontractcontrol
curl 'https://esign.simplesign.io/v3/createcontractcontrol' \
Show response
$curlParams['access_token'] = '{your access token}';
$curlParams['contract_control_name'] = 'Demo';
$curlParams['document_type'] = 'HR';
$curlParams['category'] = 'Bill';
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/createcontractcontrol",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST,
CURLOPT_POSTFIELDS => $curlParams,
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
$(document).ready(function() {
var form = new FormData();
form.append('access_token', '{your access token}');
form.append('contract_control_name', 'Demo');
form.append('document_type', 'HR');
form.append('category', 'Bill');
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/createcontractcontrol",
"method ": "POST ",
"processData ": false,
"contentType ": false,
"mimeType ": "multipart/form-data ",
"data": form
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
Get Contract Details
GET /specificcontract
Gets all of the details regarding a contract.
Get Contract Details
GET /specificcontract
Gets all of the details regarding a contract.
Gets all of the details regarding a contract.
Description
To get details about your created contract.
Request Parameters
access_token (required)
User access token
contract_id (required)
id for a specific contract
EXAMPLE REQUEST / RESPONSE
GET https://esign.simplesign.io/v3/specificcontract
curl 'https://esign.simplesign.io/v3/specificcontract' \
Show response
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/specificcontract?access_token={your access token}&contract_id={your contract id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
$(document).ready(function() {
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/specificcontract?access_token={your access token}&contract_id={your contract id}",
"method": "GET"
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
Update Contract
POST /updatecontractcontrol
Update the specific contract.
Update Contract
POST /updatecontractcontrol
Update the specific contract.
Update the specific contract.
Description
Update the specific contract.
The parameters to use are:
access_token (required)
User access token
contract_id (required)
id for a specific contract to update only particular contract details
contract_no (optional)
Contract number of the contract
type_id (optional)
Document type id
category_id (optional)
Category id
organization_id (optional)
Organization id
status (optional)
Status of the contract 1/0
related_documents (optional)
Link the send document in contract control
Note: related_documents should be pass in json format.
custom_box (optional)
Note: custom_box should be pass in json format.
cost (optional)
Note: cost should be pass in json format.
revenue (optional)
Note: revenue should be pass in json format.
period_renewal (optional)
Note: period_renewal should be pass in json format.
task (optional)
Note: task should be pass in json format.
contract_contacts (optional)
Note: contract_contacts should be pass in json format.
contract_managers (optional)
Note: contract_managers should be pass in json format.
Response
Returns the info of update contract with respect to the given status.
EXAMPLE REQUEST / RESPONSE
POST https://esign.simplesign.io/v3/updatecontractcontrol
curl 'https://esign.simplesign.io/v3/updatecontractcontrol' \
Show response
$curlParams['access_token'] = '{your access token}';
$curlParams['contract_id'] = '1';
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/updatecontractcontrol",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => " ",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST ",
CURLOPT_POSTFIELDS => $curlParams,
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache "
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #: " . $err;
} else {
echo $response;
}
$(document).ready(function() {
var form = new FormData();
form.append('access_token', '{your access token}');
form.append('contract_id', '1');
var settings = {
"async ": true,
"crossDomain ": true,
"url ": "https://esign.simplesign.io/v3/updatecontractcontrol ",
"method ": "POST ",
"processData ": false,
"contentType ": false,
"mimeType ": "multipart/form-data ",
"data ": form
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
Delete Contract
POST /deletecontract
Delete the contract.
Delete Contract
POST /deletecontract
Delete the contract.
Delete the contract.
Description
Completely deletes the contract from the system.
Request Parameters
access_token (required)
User access token
contract_id (required)
Contract id you want to delete
EXAMPLE REQUEST / RESPONSE
POST https://esign.simplesign.io/v3/deletecontract
curl 'https://esign.simplesign.io/v3/deletecontract' \
-F 112'
Show response
-F 112'
$curlParams['access_token'] = '{your access token}';
$curlParams['contract_id'] = '1';
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/deletecontract ",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => " ",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST ",
CURLOPT_POSTFIELDS => $curlParams,
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache ",
"content-type: multipart/form-data "
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #: " . $err;
} else {
echo $response;
}
$(document).ready(function() {
var form = new FormData();
form.append('access_token', '{your access token}');
form.append('contract_id', '1');
var settings = {
"async ": true,
"crossDomain ": true,
"url ": "https://esign.simplesign.io/v3/deletecontract ",
"method ": "POST ",
"processData ": false,
"contentType ": false,
"mimeType ": "multipart/form-data ",
"data ": form
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
WEBHOOKS Configure a webhook to get notification when your document is sent , signed or rejected.
ACTION
URI - DESCRIPTION
Configure Webhook
POST /cofigurewebhook
to enable or disable the webhook triggers.
Configure Webhook
POST /cofigurewebhook
to enable or disable the webhook triggers.
to enable or disable the webhook triggers.
Description
Configure endpoint URL and add trigger event to get notification on your endpoint URL when document is sent, signed or rejected.
Request Parameters
access_token (required)
User access token
webhook_url (required)
Your endpoint URL where you will get response data, when document is sent ,signed or rejected.
webhook_trigger (required)
Here you will pass an object to activate triggers to perform action, when document is sent, signed or rejected, you can turn on and off each trigger.
Response
Returns a success message
EXAMPLE REQUEST / RESPONSE
POST https://esign.simplesign.io/v3/cofigurewebhook
curl 'https://esign.simplesign.io/v3/cofigurewebhook'
Show response
$web_hook_call = [
'when_document_sent' => 'on',
'when_document_signed' => 'on',
'when_document_rejected' => 'off',
'when_document_viewed' => 'off'
];
$webhook_url = 'https://www.test.com';
$curlParams['access_token'] = '{your access token}';
$curlParams['webhook_url'] = $webhook_url;
$curlParams['webhook_trigger'] = json_encode($web_hook_call);
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/v3/cofigurewebhook",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => $curlParams,
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache",
"content-type: multipart/form-data"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
$(document).ready(function() {
var form = new FormData();
form.append("access_token", "{your access token}");
form.append("webhook_url", 'https://www.test.com');
form.append("webhook_trigger", '{"when_document_sent":"on","when_document_signed":"off","when_document_rejected":"on", "when_document_viewed":"off" }');
var settings = {
"async": true,
"crossDomain": true,
"url": "https://esign.simplesign.io/v3/cofigurewebhook",
"method": "POST",
"processData": false,
"contentType": false,
"mimeType": "multipart/form-data",
"data": form
}
$.ajax(settings).done(function (response) {
console.log(response);
});
});
Send micro signature Microsignature is the process to get quick confirmation from your recipient using BankID verification.
ACTION
URI - DESCRIPTION
Send micro signature
POST /sendmicrosignature
to initiate the micro signature process.
Send micro signature
POST /sendmicrosignature
to initiate the micro signature process.
to initiate the micro signature process.
Description
Microsignature is the process to get quick confirmation from your recipient using BankID verification. Your added message will be visible to recipient's BankID application.
Request Parameters
access_token (required)
User access token
message (required)
Message to be visible for recipient in BankID application.
email (optional)
Recipient's email to get confirmation on the complitation of process.
authentication (optional)
Recipient authentication can be completed using either Swedish BankID or Norwegian BankID as the chosen method. Use BankID/NorwegianBankID as parameter.
mobile_no (required with Norwegian BankID)
The recipient's mobile number is essential for receiving SMS messages to initiate the Norwegian BankID process. Providing the mobile number is mandatory when selecting Norwegian BankID as the authentication method.
personal_no (required with Swedish BankID)
Recipient's personalnumber to initiate the Bankid process.
Response
Returns a success message
EXAMPLE REQUEST / RESPONSE
POST https://esign.simplesign.io/v3/sendmicrosignature
curl 'https://esign.simplesign.io/v3/sendmicrosignature'
Show response
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://esign.simplesign.io/v3/sendmicrosignature',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => array('access_token' => '{access_token}','message' => 'Test Message','email' =>
'test@yopmail.com','personal_no' => '{personal_no}'),
));
$response = curl_exec($curl);
curl_close($curl);
var form = new FormData();
form.append("access_token", "{access_token}");
form.append("message", "Test Message");
form.append("email", "test@yopmail.com");
form.append("personal_no", "{personal_no}");
var settings = {
"url": "https://esign.simplesign.io/v3/sendmicrosignature",
"method": "POST",
"timeout": 0,
"processData": false,
"mimeType": "multipart/form-data",
"contentType": false,
"data": form
};
$.ajax(settings).done(function (response) {
console.log(response);
});
ID Check ID Check is the process to check idetification of person using BankID.
ACTION
URI - DESCRIPTION
ID Check
POST /idverfication
to initiate the ID Check process.
ID Check
POST /idverfication
to initiate the ID Check process.
to initiate the ID Check process.
Description
ID Check is the process to check idetification of person using personalnumber with BankID.
Request Parameters
access_token (required)
User access token
personal_no (required)
Recipient's personalnumber to initiate the Bankid process.
Response
Returns a success message
EXAMPLE REQUEST / RESPONSE
POST https://esign.simplesign.io/v3/idverfication
curl 'https://esign.simplesign.io/v3/idverfication'
Show response
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://acceptance.simplesign.io/v3/idverfication',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => array('access_token' => '{access_token}','personal_no' => '{personal_no}'),
));
$response = curl_exec($curl);
curl_close($curl);
var form = new FormData();
form.append("access_token", "{access_token}");
form.append("personal_no", "{personal_no}");
var settings = {
"url": "https://esign.simplesign.io/v3/idverfication",
"method": "POST",
"timeout": 0,
"processData": false,
"mimeType": "multipart/form-data",
"contentType": false,
"data": form
};
$.ajax(settings).done(function (response) {
console.log(response);
});
Error Names
contains details of possible errors that might be returned.
contains details of possible errors that might be returned.
ERROR
DESCRIPTION
Email is missing
Return error if there is no email in api call.
Access Token is missing
Return error if there is no access token in api call.
Password is missing
Return error if there is no password in api call.
Email or password is incorrect
Return error if there is an invalid email or password in the api call.
invalid_request
Return error if the request is missing a required
parameter, the request includes an invalid parameter value, the request includes a single parameter more than once,
or the request is incorrect or malformed in any other such way. Check the "access token" parameter.
invalid_scope
The requested scope is invalid, unknown,
or malformed. Check the "super" scope.
template_id is missing
Return error if template id is missing in api call.
No records found
Return error if no record is found.