Skip to content
/
Widget signature verified

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

Webhooks

Receive real-time notifications about document events.

OperationsWebhooks

Widget completed (Awaiting verification)Webhook

Request

This webhook is triggered when a recipient signs an envelope via the widget, but has not yet verified. It includes contact and document details.

Security
basicAuth
Bodyapplication/x-www-form-urlencodedrequired
actionstringrequired

The action taken. Defaults to verify-envelope-widget.

Example: "verify-envelope-widget"
action_datestring(date-time)required

The UTC timestamp of when the envelope was signed

Example: "2025-08-07T11:32:54+00:00"
company_idintegerrequired

The ID of the company that owns the envelope

Example: 64034
contact_idintegerrequired

The ID of the contact who signed the envelope

Example: 8117397
contact_namestringrequired

The name of the contact who signed the envelope

Example: "Abby"
contact_emailstring(email)required

The email address of the contact who signed the envelope

Example: "abby@signable.co.uk"
envelope_fingerprintstringrequired

A string identifying the signed envelope

Example: "584ea8b41b0d4c17a96b967433b211e6"
envelope_documentsstringrequired

A stringified JSON array of documents in the envelope

Example: "[{\"document_fingerprint\":\"584ea8b41b0d4c17a96b967433b211e6\",\"document_title\":\"Word Doc\",\"document_download\":\"https://api.signableapi.com/shareable/document?t=03cbb315-4f68-400d-a5cc-c2884996d061\"}]"
envelope_metastring

A JSON string of any meta information added to the envelope

Example: "{\"envelope_title\":\"Word Doc\"}"
user_idintegerrequired

The ID of the user associated with this event

Example: 0
client_ipstring(ipv4)required

The IP address from which the envelope was signed

Example: "203.0.113.123"
application/x-www-form-urlencoded
action=verify-envelope-widget&action_date=2025-08-07T11%3A32%3A54%2B00%3A00&company_id=64034&contact_id=8117397&contact_name=Abby&contact_email=abby%40signable.co.uk&envelope_fingerprint=584ea8b41b0d4c17a96b967433b211e6&envelope_documents=%5B%7B%22document_fingerprint%22%3A%22584ea8b41b0d4c17a96b967433b211e6%22%2C%22document_title%22%3A%22Word%20Doc%22%2C%22document_download%22%3A%22https%3A%2F%2Fapi.signableapi.com%2Fshareable%2Fdocument%3Ft%3D03cbb315-4f68-400d-a5cc-c2884996d061%22%7D%5D&envelope_meta=%7B%22envelope_title%22%3A%22Word%20Doc%22%7D&user_id=0&client_ip=203.0.113.123

Responses

Acknowledge receipt

Widget signature verifiedWebhook

Request

This webhook is triggered when a recipient verifies their signed envelope through the verification email. It includes details about the contact, documents, and verification.

Security
basicAuth
Bodyapplication/x-www-form-urlencodedrequired
actionstringrequired

The action taken. Defaults to verified-envelope-widget.

Example: "verified-envelope-widget"
action_datestring(date-time)required

The UTC timestamp of when the envelope was verified

Example: "2025-08-07T12:10:48+00:00"
company_idintegerrequired

The ID of the company that owns the envelope

Example: 64034
contact_idintegerrequired

The ID of the contact who verified the envelope

Example: 8117397
contact_namestringrequired

The name of the contact who verified the envelope

Example: "Abby"
contact_emailstring(email)required

The email address of the contact who verified the envelope

Example: "abby@signable.co.uk"
envelope_fingerprintstringrequired

A string identifying the verified envelope

Example: "584ea8b41b0d4c17a96b967433b211e6"
envelope_documentsstringrequired

A stringified JSON array of documents in the envelope

Example: "[{\"document_title\":\"Word Doc\",\"document_fingerprint\":\"584ea8b41b0d4c17a96b967433b211e6\",\"document_pdf\":\"https://api.signableapi.com/shareable/document?t=03cbb315-4f68-400d-a5cc-c2884996d061\",\"document_download\":\"https://api.signableapi.com/shareable/document?t=03cbb315-4f68-400d-a5cc-c2884996d061\"}]"
envelope_downloadstring(uri)required

A download link for the entire envelope

Example: "https://api.signableapi.com/shareable/envelope?t=03cbb315-4f68-400d-a5cc-c2884996d061"
envelope_fieldsstring

A stringified JSON array of fields completed during verification

Example: "[{\"field_id\":460176431,\"field_name\":\"Untitled\",\"field_type\":\"text\",\"field_value\":\"Abby\"}]"
envelope_metastring

A JSON string of any meta information added to the envelope

Example: "{\"envelope_title\":\"Word Doc\"}"
signature_fingerprintstringrequired

A string identifying the verification applied

Example: "584ea8b41b0d4c17a96b967433b211e6"
client_ipstring(ipv4)required

The IP address from which the envelope was verified

Example: "203.0.113.124"
application/x-www-form-urlencoded
action=verified-envelope-widget&action_date=2025-08-07T12%3A10%3A48%2B00%3A00&company_id=64034&contact_id=8117397&contact_name=Abby&contact_email=abby%40signable.co.uk&envelope_fingerprint=584ea8b41b0d4c17a96b967433b211e6&envelope_documents=%5B%7B%22document_title%22%3A%22Word%20Doc%22%2C%22document_fingerprint%22%3A%22584ea8b41b0d4c17a96b967433b211e6%22%2C%22document_pdf%22%3A%22https%3A%2F%2Fapi.signableapi.com%2Fshareable%2Fdocument%3Ft%3D03cbb315-4f68-400d-a5cc-c2884996d061%22%2C%22document_download%22%3A%22https%3A%2F%2Fapi.signableapi.com%2Fshareable%2Fdocument%3Ft%3D03cbb315-4f68-400d-a5cc-c2884996d061%22%7D%5D&envelope_download=https%3A%2F%2Fapi.signableapi.com%2Fshareable%2Fenvelope%3Ft%3D03cbb315-4f68-400d-a5cc-c2884996d061&envelope_fields=%5B%7B%22field_id%22%3A460176431%2C%22field_name%22%3A%22Untitled%22%2C%22field_type%22%3A%22text%22%2C%22field_value%22%3A%22Abby%22%7D%5D&envelope_meta=%7B%22envelope_title%22%3A%22Word%20Doc%22%7D&signature_fingerprint=584ea8b41b0d4c17a96b967433b211e6&client_ip=203.0.113.124

Responses

Acknowledge receipt

Template addedWebhook

Request

This webhook is triggered when a new template is added to the account. It includes basic information about the template, including its title and fingerprint.

Security
basicAuth
Bodyapplication/x-www-form-urlencodedrequired
actionstringrequired

The action taken. Defaults to add-template.

Example: "add-template"
action_datestring(date-time)required

The UTC timestamp of when the template was added

Example: "2025-08-07T12:36:56+00:00"
company_idintegerrequired

The ID of the company that added the template

Example: 64034
template_fingerprintstringrequired

A string identifying the newly added template

Example: "584ea8b41b0d4c17a96b967433b211e6"
template_titlestringrequired

The title of the added template

Example: "Signable Contract"
template_page_totalintegerrequired

The number of pages in the template

Example: 5
template_pagesArray of objectsrequired

An array of page metadata (if available)

template_thumbnailsArray of strings(uri)required

An array of thumbnail URLs (if available)

client_ipstring(ipv4)required

The IP address from which the template was added

Example: "203.0.113.150"
application/x-www-form-urlencoded
action=add-template&action_date=2025-08-07T12%3A36%3A56%2B00%3A00&company_id=64034&template_fingerprint=584ea8b41b0d4c17a96b967433b211e6&template_title=Signable%20Contract&template_page_total=5&template_pages=%5Bobject%20Object%5D&template_thumbnails=http%3A%2F%2Fexample.com&client_ip=203.0.113.150

Responses

Acknowledge receipt