Skip to content
/
Get company settings

Signable API (1.0.0)

The Signable API provides secure and efficient access to Signable's electronic signature platform. With this RESTful API, you can send documents for signature, manage templates, track envelope status, and automate your document workflows from within your own applications.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
Signable

help@signable.co.uk

License

Proprietary

Terms of Service

Languages
Servers
Mock server

https://developers.signable.app/_mock/openapi/

Production server

https://api.signable.co.uk/v1/

Partners

Manage partner integrations.

Operations

Envelopes

Send, track, and manage documents for e-signature.

Operations

Templates

Create and reuse predefined document templates.

Operations

Contacts

Manage contact details for signers and stakeholders.

Operations

Users

Control user accounts and roles.

Operations

Branding

Customize visual and branding settings for emails.

Operations

Settings

Configure account-wide preferences and defaults.

Operations

Get company settings

Request

Your Signable account settings control how documents are delivered, signed, and managed across your team. This section of the API lets you retrieve and update your company's signing preferences, email notification rules, signature formats, and more—giving you full control over how your documents behave. Settings can be accessed via the API or in the Signable web app under Company Settings > Preferences.

Security
basicAuth
curl -i -X GET \
  -u <username>:<password> \
  https://developers.signable.app/_mock/openapi/settings

Responses

Company settings returned successfully

Bodyapplication/json
httpinteger
Example: 200
setting_signature_more_infoboolean

If enabled, the signature will display the signer name and timestamp under each signature block on the generated Envelope PDF.

Example: true
setting_signature_format_defaultstring

Which signature format is offered by default. Accepted values: drawn, typed, or upload.

Example: "typed"
setting_signature_format_acceptedstring

Comma-separated list of signature formats your account accepts. Valid values: drawn, typed, upload.

Example: "typed,drawn,upload"
setting_email_pdf_attachboolean

If enabled, a PDF copy of the envelope will be attached to emails sent to recipients. If disabled, recipients must instead use a link in the email to view and download the envelope.

Example: true
setting_email_pdf_attach_senderboolean

If enabled, a PDF copy of the signed envelope will be attached to the sign-complete notification email sent to your company email address. If disabled, the envelope must be downloaded from the app.

Example: true
setting_email_envelope_openboolean

If enabled, an email notification will be sent when someone opens the envelope.

Example: true
setting_email_main_emailboolean

If enabled, notifications (signed, rejected, cancelled) are sent to your company’s main email address.

Example: true
setting_email_return_address_userboolean

If enabled, the "Return Email" will be set to the user who sent the envelope, rather than the main company email. If disabled, the "Return Email" will be set to your main company email address. Regardless of this property, emails will always be sent from document@signable.co.uk.

Example: true
setting_signing_consumer_regulations_actboolean

Enables Consumer Contract Regulations 2013 compliance for your account. Only set this to 'Yes' if you believe that you need this enabled. This setting will change some of the terminology on the signing page to become compliant with this Act.

Example: false
setting_signing_questionsboolean

If enabled, signers can send you questions or comments directly from the signing page.

Example: true
setting_pdf_audit_trail_hideboolean

If enabled, all party email addresses and mobile numbers will be hidden on the signing page and PDF certificate audit trail.

Example: true
setting_all_at_once_defaultboolean

If enabled, envelopes are sent to all parties simultaneously by default (all-at-once signing). If disabled, envelopes are sent to the first party only (one-at-a-time signing). Default is true.

Example: true
setting_signing_tooltipsbooleanDeprecated

If enabled, tooltip hints will be shown when a signer attempts to sign a document.

Example: false
Response
application/json
{
  "http": 200,
  "setting_signature_more_info": true,
  "setting_signature_format_accepted": "typed,drawn,upload",
  "setting_signature_format_default": "typed",
  "setting_email_pdf_attach": true,
  "setting_email_pdf_attach_sender": true,
  "setting_email_envelope_open": true,
  "setting_email_main_email": true,
  "setting_email_return_address_user": true,
  "setting_signing_consumer_regulations_act": false,
  "setting_signing_tooltips": false,
  "setting_signing_questions": true,
  "setting_pdf_audit_trail_hide": true,
  "setting_all_at_once_default": false
}

Update company settings

Request

Security
basicAuth
Bodyapplication/jsonrequired
setting_signature_more_infoboolean

If enabled, the signature will display the signer name and timestamp under each signature block on the generated Envelope PDF.

Example: true
setting_signature_format_defaultstring

Which signature format is offered by default. Accepted values: drawn, typed, or upload.

Example: "typed"
setting_signature_format_acceptedstring

Comma-separated list of signature formats your account accepts. Valid values: drawn, typed, upload.

Example: "typed,drawn,upload"
setting_email_pdf_attachboolean

If enabled, a PDF copy of the envelope will be attached to emails sent to recipients. If disabled, recipients must instead use a link in the email to view and download the envelope.

Example: true
setting_email_pdf_attach_senderboolean

If enabled, a PDF copy of the signed envelope will be attached to the sign-complete notification email sent to your company email address. If disabled, the envelope must be downloaded from the app.

Example: true
setting_email_envelope_openboolean

If enabled, an email notification will be sent when someone opens the envelope.

Example: true
setting_email_main_emailboolean

If enabled, notifications (signed, rejected, cancelled) are sent to your company’s main email address.

Example: true
setting_email_return_address_userboolean

If enabled, the "Return Email" will be set to the user who sent the envelope, rather than the main company email. If disabled, the "Return Email" will be set to your main company email address. Regardless of this property, emails will always be sent from document@signable.co.uk.

Example: true
setting_signing_consumer_regulations_actboolean

Enables Consumer Contract Regulations 2013 compliance for your account. Only set this to 'Yes' if you believe that you need this enabled. This setting will change some of the terminology on the signing page to become compliant with this Act.

Example: false
setting_signing_questionsboolean

If enabled, signers can send you questions or comments directly from the signing page.

Example: true
setting_pdf_audit_trail_hideboolean

If enabled, all party email addresses and mobile numbers will be hidden on the signing page and PDF certificate audit trail.

Example: true
setting_all_at_once_defaultboolean

If enabled, envelopes are sent to all parties simultaneously by default (all-at-once signing). If disabled, envelopes are sent to the first party only (one-at-a-time signing). Default is true.

Example: true
setting_signing_tooltipsbooleanDeprecated

If enabled, tooltip hints will be shown when a signer attempts to sign a document.

Example: false
curl -i -X PUT \
  -u <username>:<password> \
  https://developers.signable.app/_mock/openapi/settings \
  -H 'Content-Type: application/json' \
  -d '{
    "setting_signature_more_info": true,
    "setting_signature_format_accepted": "typed,drawn,upload",
    "setting_signature_format_default": "typed",
    "setting_email_pdf_attach": true,
    "setting_email_pdf_attach_sender": true,
    "setting_email_envelope_open": true,
    "setting_email_main_email": true,
    "setting_email_return_address_user": true,
    "setting_signing_consumer_regulations_act": false,
    "setting_signing_tooltips": false,
    "setting_signing_questions": true,
    "setting_pdf_audit_trail_hide": true,
    "setting_all_at_once_default": false
  }'

Responses

Settings updated successfully

Bodyapplication/json
httpinteger
Example: 200
messagestring
Example: "Signable Ltd settings have been updated."
hrefstring(uri)
Example: "https://api.signable.co.uk/v1/companies/32275"
company_idstring
Example: "32275"
company_namestring
Example: "Signable Ltd"
setting_signature_more_infoboolean

If enabled, the signature will display the signer name and timestamp under each signature block on the generated Envelope PDF.

Example: true
setting_signature_format_defaultstring

Which signature format is offered by default. Accepted values: drawn, typed, or upload.

Example: "typed"
setting_signature_format_acceptedstring

Comma-separated list of signature formats your account accepts. Valid values: drawn, typed, upload.

Example: "typed,drawn,upload"
setting_email_pdf_attachboolean

If enabled, a PDF copy of the envelope will be attached to emails sent to recipients. If disabled, recipients must instead use a link in the email to view and download the envelope.

Example: true
setting_email_pdf_attach_senderboolean

If enabled, a PDF copy of the signed envelope will be attached to the sign-complete notification email sent to your company email address. If disabled, the envelope must be downloaded from the app.

Example: true
setting_email_envelope_openboolean

If enabled, an email notification will be sent when someone opens the envelope.

Example: true
setting_email_main_emailboolean

If enabled, notifications (signed, rejected, cancelled) are sent to your company’s main email address.

Example: true
setting_email_return_address_userboolean

If enabled, the "Return Email" will be set to the user who sent the envelope, rather than the main company email. If disabled, the "Return Email" will be set to your main company email address. Regardless of this property, emails will always be sent from document@signable.co.uk.

Example: true
setting_signing_consumer_regulations_actboolean

Enables Consumer Contract Regulations 2013 compliance for your account. Only set this to 'Yes' if you believe that you need this enabled. This setting will change some of the terminology on the signing page to become compliant with this Act.

Example: false
setting_signing_questionsboolean

If enabled, signers can send you questions or comments directly from the signing page.

Example: true
setting_pdf_audit_trail_hideboolean

If enabled, all party email addresses and mobile numbers will be hidden on the signing page and PDF certificate audit trail.

Example: true
setting_all_at_once_defaultboolean

If enabled, envelopes are sent to all parties simultaneously by default (all-at-once signing). If disabled, envelopes are sent to the first party only (one-at-a-time signing). Default is true.

Example: true
setting_signing_tooltipsbooleanDeprecated

If enabled, tooltip hints will be shown when a signer attempts to sign a document.

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

Webhooks

Receive real-time notifications about document events.

OperationsWebhooks