API Reference

ACCOUNT Contains information about an account and its settings
AccountResponse Object.
account_idThe id of the Account.
email_addressThe email address associated with the Account.
callback_urlThe URL that HelloSign events will be POSTed to.
is_paid_hsReturns true if the user has a paid HelloSign account.
is_paid_hfReturns true f the user has a paid HelloFax account.
quotasAn object detailing remaining monthly quotas.
account_idThe id of the Account.
ACTION
URI - DESCRIPTION

Get Account

POST /profile/userprofile

Returns your Account settings

Description

Returns the properties and settings of your Account


Request Parameters

access_token (Required)

User access token for retrieve the user account.


Response

Returns an Account object

EXAMPLE REQUEST / RESPONSE

POST https://esign.simplesign.io/api/v2/profile/userprofile


curl 'https://esign.simplesign.io/api/v2/profile/userprofile' \


Show response

Update Account

POST /user/updateuser

Updates your Account settings

Description

Updates the properties and settings of your 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

telephone (Optional)

User telephone

reg_no (Optional)

User Reg no

post_code (Optional)

User Post code


Response

Returns a successfull message

EXAMPLE REQUEST / RESPONSE

POST https://esign.simplesign.io/api/v2/user/updateuser


curl 'https://esign.simplesign.io/api/v2/user/updateuser \


Show response

Create free account

POST /user/registernewuser

Create free user account

Description

Creates a Simple Sign free Account
(Free User will have 3 signatures and 3 SMS access to the Simple Sign features)


Request Parameters

email (Required)

The email address to create new Account.

password (Required)

Password for new account.

full_name (Required)

User full name

company (Required)

User company.

phone_no (Optional)

User contact no.


Response

Returns an successfull message

EXAMPLE REQUEST / RESPONSE

POST https://esign.simplesign.io/api/v2/user/registernewuser


Show response
$curlParams = array(
'email' => 'john_mcauley@yopmail.com',
'password' => 'newyear',
'full_name' => 'John Mcauley',
'company' => 'Simplesign'
);
$curlParams = http_build_query($curlParams);
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/api/v2/user/registernewuser",
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: application/x-www-form-urlencoded"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
return "cURL Error #:" . $err;
} else {
$result = json_decode($response,true);
return $result;
}

Create super user account (need approval)

POST /user/registeruser

Create a Simple Sign Super user account

Description

Creates a Simple Sign Super user Account that is associated with the specified Super Admin email address.
(Super User will have unlimited access to the Simple Sign features)


Request Parameters

access_token (Required)

Super admin access token.

superadmin_email (Required)

The email address of Super Admin Account.

email (Required)

The email address to create new Account.

password (Required)

Password for new account.

full_name (Required)

User full name

company (Required)

User company.

phone_no (Optional)

User contact no.


Response

Returns an successfull message

EXAMPLE REQUEST / RESPONSE

POST https://esign.simplesign.io/api/v2/user/registeruser


curl 'https://esign.simplesign.io/api/v2/user/registeruser'\
-F email=me@mailinator.com'
-F password=test123'
-F full_name=textpress'
-F company=textpress'


Show response

Log in Account

POST /home/dologin

Returns access token

Description

Returns the access token of your Account


Request Parameters

email (Required)

The email address of user account.

password (Required)

Account password


Response

Returns an Account object

EXAMPLE REQUEST / RESPONSE

POST https://esign.simplesign.io/api/v2/home/dologin


curl 'https://esign.simplesign.io/api/v2/home/dologin'\
-F 'email=user@simplesign.com' \
-F 'password=123456;' \


Show response
TEMPLATE Contains information about the templates you and your team have created
SignatureRequestResponse Object.
test_modeWhether this is a test signature request. Test requests have no legal value. Defaults to 0.
signature_request_idThe id of the SignatureRequest.
requester_email_addressThe email address of the initiator of the SignatureRequest.
titleThe title the specified Account uses for the SignatureRequest.
subjectThe subject in the email that was initially sent to the signers.
messageThe custom message in the email that was initially sent to the signers.
is_completeWhether or not the SignatureRequest has been fully executed by all signers.
has_errorWhether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings).
final_copy_uri(Deprecated) The relative URI where the PDF copy of the finalized documents can be downloaded. Only present when is_complete = true. This will be removed at some point; use the files_url instead.
files_urlThe URL where a copy of the request's documents can be downloaded.
signing_urlThe URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing HelloSign accounts as they will be required to log in before signing.
details_urlThe URL where the requester and the signers can view the current status of the SignatureRequest.
cc_email_addressesA list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed.
signing_redirect_urlThe URL you want the signer redirected to after they successfully sign.
is_completeWhether or not the SignatureRequest has been fully executed by all signers.
is_completeWhether or not the SignatureRequest has been fully executed by all signers.
is_completeWhether or not the SignatureRequest has been fully executed by all signers.
ACTION
URI - DESCRIPTION

List Templates

POST /usertemplate/gettemplates

Lists your Templates.

Description

Returns a list of the Templates that are accessible by you.


Request Parameters

access_token (Required)

User access token.


Response

An array of Template to the given status

EXAMPLE REQUEST / RESPONSE

POST https://esign.simplesign.io/api/v2/usertemplate/gettemplates


curl 'https://esign.simplesign.io/api/v2/usertemplate/gettemplates' \
-F 'file=@NDA.pdf'\


Show response

Create Template

POST / usertemplate/uploadpdftemplate

Create a template with PDF

Description

Create a template with PDF.


Request Parameters

access_token (Required)

User access token.

file (Required)

Use file[] to indicate the uploaded file(s) to use for the template.


Response

Returns a Template Id

EXAMPLE REQUEST / RESPONSE

POST https://esign.simplesign.io/api/v2/usertemplate/uploadpdftemplate


curl 'https://esign.simplesign.io/api/v2/usertemplate/uploadpdftemplate' \
-F 'file=@NDA.pdf' \


Show response

Delete Template

POST / usertemplate/deletetemplate

Deletes the specified template.

Description

Completely deletes the template specified from the account


Request Parameters

access_token (Required)

User access token.

template_id (Required)

The id of the Template to delete.

EXAMPLE REQUEST / RESPONSE

POST https://esign.simplesign.io/api/v2/usertemplate/deletetemplate


curl 'https://esign.simplesign.io/api/v2/usertemplate/deletetemplate' \


Show response
Send Contract Contains information regarding documents that need to be send
SignatureRequestResponse Object.
test_modeWhether this is a test signature request. Test requests have no legal value. Defaults to 0.
signature_request_idThe id of the SignatureRequest.
requester_email_addressThe email address of the initiator of the SignatureRequest.
titleThe title the specified Account uses for the SignatureRequest.
subjectThe subject in the email that was initially sent to the signers.
messageThe custom message in the email that was initially sent to the signers.
is_completeWhether or not the SignatureRequest has been fully executed by all signers.
has_errorWhether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings).
final_copy_uri(Deprecated) The relative URI where the PDF copy of the finalized documents can be downloaded. Only present when is_complete = true. This will be removed at some point; use the files_url instead.
files_urlThe URL where a copy of the request's documents can be downloaded.
signing_urlThe URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing HelloSign accounts as they will be required to log in before signing.
details_urlThe URL where the requester and the signers can view the current status of the SignatureRequest.
cc_email_addressesA list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed.
signing_redirect_urlThe URL you want the signer redirected to after they successfully sign.
is_completeWhether or not the SignatureRequest has been fully executed by all signers.
is_completeWhether or not the SignatureRequest has been fully executed by all signers.
is_completeWhether or not the SignatureRequest has been fully executed by all signers.
ACTION
URI - DESCRIPTION

Send PDF

POST /contract/send

Creates and sends a new contract with the pdf documents.

Description

Creates and sends a new contract with the pdf documents.


Request Parameters

access_token (Required)

User access token.

file (Required)

Use file to indicate the uploaded pdf file(s) to send

recipient_email (Required)

Email address which you want to send contract. If multiple recipient email separate email delimiter sign(|)

recipient_name (Required)

Name of the sigining parties (if multiple parties then separate with delimiter sign(|)

attachment (Optional)

Attach an extra pdf file with your contract. (File type must be pdf )

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

reg_no or personal_no (Optional)

Registration or Personal Number of recipient which you want to send contract. If multiple recipient separate reg_no with delimiter sign(|)

sender_email (Optional)

Send this parameter if you want to send contract from subuser.

visible_name (Optional)

The title you want to assign to the signature Request

language_id (Optional)

Language (en,sv,de,fi,fr,no,da)

due_date (Optional)

Contract expiry date

reminder_date (Optional)

Reminder date

invitation_message (Optional)

Invitation message you want to add in invitation email

confirmation_message (Optional)

Confirmation message you want to send after contract sign

confirmation (Optional)

Confirmation type If multiple recipients separate confirmation with delimiter sign(|)(1 for email and 2 for email and sms)

role (Optional)

Role If multiple recipients, separate role with delimiter sign(|) (1 for signing and 2 for review)

id_attachment (Optional)

Add id attacchment if you want id before siging(0 for false 1 for true)If multiple recipients separate attachment with delimiter sign(|)

invitation_type (Optional)

Sigining invitation type (1 for email 2 for email & sms) If multiple recipients, separate invitation_type with delimiter sign(|)

authentication (Optional)

Authentication type for signing(1 for no authentication, 3 for sign using BankID, 4 for pin via sms)If multiple recipients, separate authentication with delimiter sign(|)

video_title (Optional)

Title of your video, which you want to show on your signing area

video or video_url (Optional)

Send video_url if you want to add your youtube and vimeo url and video parameter if you want to upload video(file type must be mp4 and file size must be less than 10 mb

invitation_order (Optional)

Signing invitation order for recipient If multiple invitation_order separate invitation_order with delimiter sign(|)

invitation_url (Optional)

Invitation Url returns the signing URL for your recipient instead of sending him an invitation email (1 for return link and 0 for sending contract in email)

Add signature box in pdf

By using #signer-1# tag in your pdf, you can add signature box for single recipient. For multiple recipients you can add tags like, #signer-1# , #signer-2#

Minimum font size must be 16px, font style must be Arial.


Response

Returns a successfull message

EXAMPLE REQUEST / RESPONSE

POST https://esign.simplesign.io/api/v2/contract/send


curl 'https://esign.simplesign.io/api/v2/contract/send'


Show response
$cfile = new CURLFile(realpath('pdf_template.pdf'));
$curlParams = array(
'access_token' => 'ttyErWHw5SueWOg7y9AZddqM30goYrGodKKz0E9z',
'file' => $cfile,
'recipient_name' => 'John Markus',
'recipient_email' => 'john_markus@yopmail.com'
);
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/api/v2/contract/send",
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) {
return "cURL Error #:" . $err;
} else {
$result = json_decode($response,true);
return $result;
}
var form = new FormData();
form.append("access_token", "n1Vnx3WVYDwOZD5QbC8bou80Gj3f5qVL3CRL9paa");
form.append("file", "avtal_912YAY6BC6D06S.pdf");
form.append("recipient_name", "John Doe");
form.append("recipient_email", "Johndoe@yopmail.com");
form.append("attachment", "avtal_912YAY6BC6D06S.pdf");
form.append("reg_no", "123456789");

var settings = {
"async": true,
"crossDomain": true,
"url": "http://esign.simplesign.io/api/v2/contract/send",
"method": "POST",
"headers": {
"cache-control": "no-cache",
"postman-token": "4371c31f-d328-729a-243c-566cde9c6170"
},
"processData": false,
"contentType": false,
"mimeType": "multipart/form-data",
"data": form
}

$.ajax(settings).done(function (response) {
console.log(response);
});

Send Template

POST /contract/sendwithtemplate

Creates and sends a new Contract based off of a Template..

Description

Creates and sends a new Contract based off of the Template specified with the template_id parameter.


Request Parameters

access_token (Required)

User access token.

Template_id (Required)

Template id (you can get id when you create template from API, or when you edit a template from your SimpleSign account, last parameter of URL is your template id)

recipient_email (Required)

Email address which you want to send signature. If multiple recipient email separate email delimiter sign(|)

reg_no or personal_no (Optional)

Registration or Personal Number of recipient which you want to send contract. If multiple recipient separate reg_no with delimiter sign(|)

recipient_name (Required)

Recipient name of the sigining parties(if multiple parties then separate with delimiter sign(|)

sender_email (Optional)

Send this parameter if you want to send contract from subuser.

visible_name (Optional)

The title you want to assign to the signature Request

language_id (Optional)

Language (en,sv,de,fi,fr,no,da)

due_date (Optional)

Contract expiry date

reminder_date (Optional)

Reminder date

invitation_message (Optional)

Invitation message you want to add in invitation email

confirmation_message (Optional)

Confirmation message you want to send after contract sign

confirmation (Optional)

Confirmation type If multiple recipients, separate confirmation with delimiter sign(|)(1 for email and 2 for email and sms)

role (Optional)

Role If multiple recipients, separate role with delimiter sign(|) (1 for signing and 2 for review)

id_attachment (Optional)

Add id attacchment if you want id before siging(0 for false 1 for true)If multiple recipients separate attachment with delimiter sign(|)

invitation_type (Optional)

Sigining invitation type (1 for email 2 for email & sms) If multiple recipients, separate invitation_type with delimiter sign(|)

authentication (Optional)

Authentication type for signing(1 for no authentication, 3 for sign using BankID, 4 for pin via sms)If multiple recipients, separate authentication with delimiter sign(|)

video_title (Optional)

Title of your video, which you want to show on your signing area

video or video_url (Optional)

Send video_url if you want to add your youtube and vimeo url and video parameter if you want to upload video(file type must be mp4 and file size must be less than 10 mb

invitation_order (Optional)

Signing invitation order for recipient If multiple recipients separate invitation_order with delimiter sign(|)


Response

Returns a successfull message

EXAMPLE REQUEST / RESPONSE

POST https://esign.simplesign.io/api/v2/contract/sendwithtemplate


curl 'https://esign.simplesign.io/api/v2/contract/sendwithtemplate' \


Show response
$curlParams = array(
'access_token' => 'ttyErWHw5SueWOg7y9AZddqM30goYrGodKKz0Fc8',
'template_id' => 1234,
'recipient_email' => 'jhon_marcus@yopmail.com',
'recipient_name' => 'Jhon Marcus'
);
$curlParams = http_build_query($curlParams);
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/api/v2/contract/sendwithtemplate",
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: application/x-www-form-urlencoded"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
return "cURL Error #:" . $err;
} else {
$result = json_decode($response,true);
return $result;
}
var form = new FormData();
form.append("access_token", "n1Vnx3WVYDwOZD5QbC8bou80Gj3f5qVL3CRL9paa");
form.append("template_id", "1509");
form.append("recipient_email", "johndoe@yopmail.com");
form.append("recipient_name", "John Doe");
form.append("reg_no", "123456789");
form.append("visible_name", "Demo template");

var settings = {
"async": true,
"crossDomain": true,
"url": "http://esign.simplesign.io/api/v2/contract/sendwithtemplate",
"method": "POST",
"headers": {
"cache-control": "no-cache",
"postman-token": "ad59048d-c2c5-9318-155b-c0783580856e"
},
"processData": false,
"contentType": false,
"mimeType": "multipart/form-data",
"data": form
}

$.ajax(settings).done(function (response) {
console.log(response);
});
Sub Users Contains information about sub users
SignatureRequestResponse Object.
test_modeWhether this is a test signature request. Test requests have no legal value. Defaults to 0.
contract_idThe id of the SignatureRequest.
requester_email_addressThe email address of the initiator of the contract.
titleThe title the specified Account uses for the SignatureRequest.
subjectThe subject in the email that was initially sent to the signers.
messageThe custom message in the email that was initially sent to the signers.
is_completeWhether or not the SignatureRequest has been fully executed by all signers.
has_errorWhether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings).
final_copy_uri(Deprecated) The relative URI where the PDF copy of the finalized documents can be downloaded. Only present when is_complete = true. This will be removed at some point; use the files_url instead.
files_urlThe URL where a copy of the request's documents can be downloaded.
signing_urlThe URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing HelloSign accounts as they will be required to log in before signing.
details_urlThe URL where the requester and the signers can view the current status of the SignatureRequest.
cc_email_addressesA list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed.
signing_redirect_urlThe URL you want the signer redirected to after they successfully sign.
is_completeWhether or not the SignatureRequest has been fully executed by all signers.
is_completeWhether or not the SignatureRequest has been fully executed by all signers.
is_completeWhether or not the SignatureRequest has been fully executed by all signers.
ACTION
URI - DESCRIPTION

Get subusers

POST /user/getuserlist

Get you sub users list

Description

Returns a list of sub users and its details.


Request Parameters

access_token (Required)

User access token.


Response

An array of Template to the given status

EXAMPLE REQUEST / RESPONSE

POST https://esign.simplesign.io/api/v2/user/getuserlist


curl 'https://esign.simplesign.io/api/v2/user/getuserlist' \


Show response

Create sub user

POST /user/createsubuser/

Create a new sub user

Description

Create sub users in your account.


Request Parameters

access_token (Required)

User access token.

fullname (Required)

Sub user full name

email (Required)

Sub user email address

password (Required)

Password for sub user account

profile_image (Optional)

Sub user profile image

EXAMPLE REQUEST / RESPONSE

POST https://esign.simplesign.io/api/v2/user/createsubuser


curl 'https://esign.simplesign.io/api/v2/user/createsubuser' \
-F fullname \
-F email@mailinator.com \


Show response

Delete Sub user

POST /user/destroy

Delete ad sub user

Description

Delete a specific sub user from your account.


Request Parameters

access_token (Required)

User access token.

user_id (Required)

Sub user id.

EXAMPLE REQUEST / RESPONSE

POST https://esign.simplesign.io/api/v2/user/destroy


curl 'https://esign.simplesign.io/api/v2/user/destroy' \


Show response

Activate/Deactivate User

POST /user/changestatus

Activate/Deactivate sub user

Description

Activate and deactivate sub user.


Request Parameters

access_token (Required)

User access token.

user_id (Required)

Sub user id

status (Required)

1 for activate account, 0 for deactivate account

EXAMPLE REQUEST / RESPONSE

POST https://esign.simplesign.io/api/v2/user/changestatus


curl 'https://esign.simplesign.io/api/v2/user/changestatus' \


Show response

Update Sub User Account

POST /user/updatesubuser

Updates sub user Account's

Description

Updates sub user account details..


Request Parameters

access_token (Required)

User access token.

full_name (Optional)

Full name of user account

email (Optional)

User email

password (Optional)

User password


Response

Returns an Account object

EXAMPLE REQUEST / RESPONSE

POST https://esign.simplesign.io/api/v2/user/updatesubuser


curl 'https://esign.simplesign.io/api/v2/user/updatesubuser' \


Show response
RECIPIENT Contains information about recipient
SignatureRequestResponse Object.
test_modeWhether this is a test signature request. Test requests have no legal value. Defaults to 0.
contract_idThe id of the contract.
requester_email_addressThe email address of the initiator of the contract.
titleThe title the specified Account uses for the SignatureRequest.
subjectThe subject in the email that was initially sent to the signers.
messageThe custom message in the email that was initially sent to the signers.
is_completeWhether or not the SignatureRequest has been fully executed by all signers.
has_errorWhether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings).
final_copy_uri(Deprecated) The relative URI where the PDF copy of the finalized documents can be downloaded. Only present when is_complete = true. This will be removed at some point; use the files_url instead.
files_urlThe URL where a copy of the request's documents can be downloaded.
signing_urlThe URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing HelloSign accounts as they will be required to log in before signing.
details_urlThe URL where the requester and the signers can view the current status of the SignatureRequest.
cc_email_addressesA list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed.
signing_redirect_urlThe URL you want the signer redirected to after they successfully sign.
is_completeWhether or not the SignatureRequest has been fully executed by all signers.
is_completeWhether or not the SignatureRequest has been fully executed by all signers.
is_completeWhether or not the SignatureRequest has been fully executed by all signers.
ACTION
URI - DESCRIPTION

Get Recipient

POST /recipient/recipient

Get recipient details

Description

Get recipient and its details by the user


Request Parameters

access_token (Required)

User access token.


Response

Returns an Recipient object

EXAMPLE REQUEST / RESPONSE

POST https://esign.simplesign.io/api/v2/recipient/recipient


curl 'https://esign.simplesign.io/api/v2/recipient/recipient' \


Show response

Create Recipient

POST /recipient/addrecipient

Create recipient

Description

Add a new recipient on user account


Request Parameters

access_token (Required)

User access token.

fullname (Required)

Fullname of the recipient

email (Required)

Email of the recipient

company (Optional)

Company of the recipient

mobile (Optional)

Contact no of the recipient

address (Optional)

Address of the recipient

city (Optional)

City of the recipient

zip (Optional)

Zip code of recipient

reg_no (Optional)

Reg no of recipient

extra_fields (Optional)

[ { "fieldName":"Gender", "fieldValue":"male" } ]


Response

Returns an Recipient object

EXAMPLE REQUEST / RESPONSE

POST https://esign.simplesign.io/api/v2/recipient/addrecipient


curl 'https://esign.simplesign.io/api/v2/recipient/addrecipient' \


Show response

Update Recipient

POST /recipient/updaterecipient

Update recipient

Description

Update recipient and its information


Request Parameters

access_token (Required)

User access token.

full_name (Optional)

Fullname of the recipient

email (Optional)

Email of the recipient

company (Optional)

Company of the recipient

mobile (Optional)

Contact no of the recipient

address (Optional)

Address of the recipient

city (Optional)

City of the recipient

zip (Optional)

Zip code of recipient

reg_no (Optional)

Reg no of recipient

extra_fields (Optional)

[ { "fieldName":"Gender", "fieldValue":"male" } ]


Response

Returns an Recipient id object

EXAMPLE REQUEST / RESPONSE

POST https://esign.simplesign.io/api/v2/recipient/updaterecipient


curl 'https://esign.simplesign.io/api/v2/recipient/updaterecipient' \
-f 123


Show response

Get Recipient Info

POST /recipient/recipientinfo

Get recipient details

Description

Get the information of recipient and its details


Request Parameters

access_token (Required)

User access token.

recipient_id (Required)

Recipient id


Response

Returns an Recipient id object

EXAMPLE REQUEST / RESPONSE

POST https://esign.simplesign.io/api/v2/recipient/recipientinfo


curl 'https://esign.simplesign.io/api/v2/recipient/recipientinfo' \
-f 123


Show response

Delete Recipient

POST /recipient/deleterecipient

Delete recipient

Description

Completely delete recipient from the system


Request Parameters

access_token (Required)

User access token.

recipient_id (Required)

Recipient id


Response

EXAMPLE REQUEST / RESPONSE

POST https://esign.simplesign.io/api/v2/recipient/deleterecipient


curl 'https://esign.simplesign.io/api/v2/recipient/deleterecipient' \
-f 123


Show response
Sent history Contains information about contracts that you and your team have sent.
SignatureRequestResponse Object.
test_modeWhether this is a test signature request. Test requests have no legal value. Defaults to 0.
signature_request_idThe id of the SignatureRequest.
requester_email_addressThe email address of the initiator of the SignatureRequest.
titleThe title the specified Account uses for the SignatureRequest.
subjectThe subject in the email that was initially sent to the signers.
messageThe custom message in the email that was initially sent to the signers.
is_completeWhether or not the SignatureRequest has been fully executed by all signers.
has_errorWhether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings).
final_copy_uri(Deprecated) The relative URI where the PDF copy of the finalized documents can be downloaded. Only present when is_complete = true. This will be removed at some point; use the files_url instead.
files_urlThe URL where a copy of the request's documents can be downloaded.
signing_urlThe URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing HelloSign accounts as they will be required to log in before signing.
details_urlThe URL where the requester and the signers can view the current status of the SignatureRequest.
cc_email_addressesA list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed.
signing_redirect_urlThe URL you want the signer redirected to after they successfully sign.
is_completeWhether or not the SignatureRequest has been fully executed by all signers.
is_completeWhether or not the SignatureRequest has been fully executed by all signers.
is_completeWhether or not the SignatureRequest has been fully executed by all signers.
ACTION
URI - DESCRIPTION

Get sent contract

POST /overview/history

Returns your sent contracts

Description

Returns the list your sent contract


Request Parameters

access_token (Required)

User access token.

pagelimit

Records per page limits (default: 10)

current_page

Page index starting from 0 (default: 0)


Response

Returns a Contract object

EXAMPLE REQUEST / RESPONSE

POST https://esign.simplesign.io/api/v2/overview/history


curl 'https://esign.simplesign.io/api/v2/overview/history' \


Show response
$curlParams = array(
'access_token' => 'ttyErWHw5SueWOg7y9AZddqM30goYrGodKKz0rSb',
'pagelimit' => 5
);
$curlParams = http_build_query($curlParams);
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/api/v2/overview/history",
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: application/x-www-form-urlencoded"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
return "cURL Error #:" . $err;
} else {
$result = json_decode($response,true);
return $result;
}

Get contract list by status

POST /overview/sentoffersbystatus/

Return the list of sent contract with respect to the given status

Description

Return the list of sent contract with respect to the given status.


Request Parameters

access_token (Required)

User access token.

status (Required)

Status of contract(0 for sent, 3 for reviewed 4 for all parties signed).

pagelimit

Records per page limits (default: 10)

current_page

Page index starting from 0 (default: 0)


Response

Returns a the list of sent contract with respect to the given status

EXAMPLE REQUEST / RESPONSE

POST https://esign.simplesign.io/api/v2/overview/sentoffersbystatus


curl 'https://esign.simplesign.io/api/v2/overview/sentoffersbystatus' \


Show response

Get contract details

POST /overview/offerdetails

Return the details of specific contract

Description

Return the details of contract by the contract id.


Request Parameters

access_token (Required)

User access token.

contract_id (Required)

Id for specific contract.


EXAMPLE REQUEST / RESPONSE

POST https://esign.simplesign.io/api/v2/overview/offerdetails


curl 'https://esign.simplesign.io/api/v2/overview/offerdetails' \


Show response
$curlParams = array(
'access_token' => 'ttyErWHw5SueWOg7y9AZddqM30goYrGodKKz0Fc8',
'contract_id' => 10598
);
$curlParams = http_build_query($curlParams);
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://esign.simplesign.io/api/v2/overview/offerdetails",
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: application/x-www-form-urlencoded"
),
));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if($err) {
return "cURL Error #:" . $err;
} else {
$result = json_decode($response,true);
return $result;
}

Delete contract

POST /overview/deletecontract

Delete the contract

Description

Completely delete the un signed 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/api/v2/overview/deletecontract


curl 'https://esign.simplesign.io/api/v2/overview/deletecontract' \
-F 112'

Get Signed PDF

POST /overview/getcontractpdf

Download Contract PDF

Description

You can download contract PDF.


Request Parameters

access_token (Required)

User access token.

contract_id (Required)

Signed contract id


EXAMPLE REQUEST / RESPONSE

POST https://esign.simplesign.io/api/v2/overview/getcontractpdf


curl 'https://esign.simplesign.io/api/v2/overview/getcontractpdf' \


Show response
Error names

List and details of possible errors that can 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 invalid email or password send in api call

invalid_request

The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. 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 found

Kom igång direkt. Prova gratis!