List company settings

Arguments

Argument Required/optional Description
None

Example Request

cURL

curl https://api.signable.co.uk/v1/settings
-u d41d8cd98f00b204e9800998ecf8427e:x
		

PHP


// Start the call
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://api.signable.co.uk/v1/settings');
// Set your API key
curl_setopt($curl, CURLOPT_USERPWD, "d41d8cd98f00b204e9800998ecf8427e:x");
// Signable is a safe peer
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
// Don't output the content right away
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
// Place the result into a variable to work with.
$response = curl_exec($curl);
// Close the cURL request.
curl_close($curl);
// Output the response
var_dump($response);
			

Example Response

{
  "http": 200,
  "setting_signature_more_info": true,
  "setting_signature_format_accepted": "typed,drawn,upload",
  "setting_signature_format_default": false,
  "setting_email_pdf_attach": true,
  "setting_email_envelope_open": false,
  "setting_email_main_email": false,
  "setting_email_return_address_user": false,
  "setting_signing_consumer_regulations_act": false,
  "setting_signing_tooltips": true,
  "setting_signing_questions": true,
  "setting_pdf_audit_trail_hide": true
}


Update company settings

Arguments

Argument Required/optional Description
setting_signature_more_info optional If you enable this, the signatures on your PDF's will appear with more information about the signature underneath in green text.
setting_signature_format_default optional This option allows you to select which signature option is offered to your signers by default. Formats accepted are 'drawn', 'typed' or 'upload'
setting_email_pdf_attach optional If you enable this then the document you want signed will be attached as a PDF in the emails. If this is disabled, your clients will still be able to view the document by clicking on the link in the email.
setting_email_envelope_open optional If you enable this option you will receive an email notification when someone opens the document you have sent them to sign.
setting_email_main_email optional If you enable this option the email address you have setup on your company profile page will receive email notifications when documents are signed, rejected or cancelled.
setting_email_return_address_user optional By default, your envelopes (documents) will be sent from document@signable.co.uk however the 'Return Email' (as in the email address that receives any replies) is set to your main company email address. Here you can change this so that the 'Return Email' will be set to the Users email address who actually sent the envelope out. The email itself will still come from document@signable.co.uk though.
setting_signing_consumer_regulations_act optional This setting sets your account compliant with the Consumer Contract Regulations 2013 Act.
setting_signing_tooltips optional This setting allows you to disable the tooltips that are shown when a signer attempts to sign the document.
setting_signing_questions optional This setting allows you to disable the ability for signers to send you questions or comments directly from the siging page.
setting_pdf_audit_trail_hide optional This setting allows you to hide the email address for each party on the PDF certificate.
setting_signature_format_accepted optional Select which signature formats you are willing to accept from your signers. Formats accepted are 'drawn', 'typed' or 'upload'.

Example Request

cURL

curl https:/api.signable.co.uk/v1/settings 
   -u d41d8cd98f00b204e9800998ecf8427e:x 
   -X PUT 
   -d "setting_signature_more_info=false" 
		

PHP


// Start the call
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://api.signable.co.uk/v1/settings');
// Set your API key
curl_setopt($curl, CURLOPT_USERPWD, "d41d8cd98f00b204e9800998ecf8427e:x");
// Signable is a safe peer
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
// Don't output the content right away
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
// Set it as a PUT request
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PUT");
// Set the PUT parameters.
curl_setopt($curl, CURLOPT_POSTFIELDS, 'setting_signature_more_info=false');
// Place the result into a variable to work with.
$response = curl_exec($curl);
// Close the cURL request.
curl_close($curl);
// Output the response
var_dump($response);
			

Example Response


{
  "http": 200,
  "message": "Signable Demo settings have been updated.",
  "href": "https://api.signable.co.uk/v1/companies/1234",
  "company_id": "1234",
  "company_name": "Signable Demo",
  "setting_signature_more_info": true,
  "setting_signature_format_accepted": "typed,drawn,upload",
  "setting_signature_format_default": "drawn",
  "setting_email_pdf_attach": true,
  "setting_email_envelope_open": false,
  "setting_email_main_email": false,
  "setting_email_return_address_user": false,
  "setting_signing_consumer_regulations_act": false,
  "setting_signing_tooltips": true,
  "setting_signing_questions": true,
  "setting_pdf_audit_trail_hide": false
}