Skip to content
/
Envelope cancelled

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

Envelope signedWebhook

Request

This webhook is triggered when a recipient completes signing an envelope. It includes detailed information about the envelope, signer, documents, custom fields, and signature fingerprint.

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

A string of the signed envelope

Example: "584ea8b41b0d4c17a96b967433b211e6"
envelope_documentsstringrequired

JSON string of the documents within the envelope

Example: "[{\"document_title\":\"Make Tests\",\"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_fieldsstringrequired

JSON string of completed fields in the envelope

Example: "[{\"field_id\":458946901,\"field_name\":\"Untitled\",\"field_type\":\"text\",\"field_value\":\"1st Aug\"},{\"field_id\":458946905,\"field_name\":\"Untitled\",\"field_type\":\"text\",\"field_value\":\"hiousfdjp\"}]"
envelope_downloadstring(uri)required

URL to download the full signed envelope

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

ID of the signer

Example: 7418454
contact_namestringrequired

Name of the signer

Example: "Abby"
contact_emailstring(email)required

Email address of the signer

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

ID of the sub-account (company) the envelope belongs to

Example: 64034
user_idintegerrequired

Internal user ID associated with the signing action

Example: 267199
signature_fingerprintstringrequired

Unique fingerprint identifying the signature event

Example: "584ea8b41b0d4c17a96b967433b211e6"
client_ipstring(ipv4)required

IP address of the device used to sign

Example: "65.179.58.205"
envelope_metastring

A JSON string of any additional metadata attached to the envelope

Example: ""
actionstringrequired

The action taken. Defaults to signed-envelope.

Example: "signed-envelope"
action_datestring(date-time)required

UTC timestamp of when the signing occurred

Example: "2025-08-01T14:37:47+00:00"
application/x-www-form-urlencoded
envelope_fingerprint=584ea8b41b0d4c17a96b967433b211e6&envelope_documents=%5B%7B%22document_title%22%3A%22Make%20Tests%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_fields=%5B%7B%22field_id%22%3A458946901%2C%22field_name%22%3A%22Untitled%22%2C%22field_type%22%3A%22text%22%2C%22field_value%22%3A%221st%20Aug%22%7D%5D&envelope_download=https%3A%2F%2Fapi.signableapi.com%2Fshareable%2Fenvelope%3Ft%3D03cbb315-4f68-400d-a5cc-c2884996d061&contact_id=7418454&contact_name=Abby&contact_email=abby%40signable.co.uk&company_id=64034&user_id=267199&signature_fingerprint=584ea8b41b0d4c17a96b967433b211e6&client_ip=87.177.50.205&envelope_meta=&action=signed-envelope&action_date=2025-08-01T14%3A37%3A47%2B00%3A00

Responses

Acknowledge receipt

Envelope cancelledWebhook

Request

This webhook is triggered when an envelope is cancelled before completion. It includes the envelope fingerprint, user details, and any metadata associated with the envelope.

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

A string representing the cancelled envelope

Example: "584ea8b41b0d4c17a96b967433b211e6"
envelope_titlestringrequired

The title of the cancelled envelope

Example: "tagstest - Copy"
actionstringrequired

The action taken. Defaults to cancelled-envelope.

Example: "cancelled-envelope"
action_datestring(date-time)required

The UTC timestamp of when the envelope was cancelled

Example: "2025-08-06T12:59:03+00:00"
envelope_metastring

A JSON string of any meta information associated with the envelope

Example: ""
company_idintegerrequired

The ID of the company linked to the envelope

Example: 64034
user_idintegerrequired

The ID of the user who cancelled the envelope

Example: 267199
client_ipstring(ipv4)required

The IP address of the user or system that triggered the cancellation

Example: "203.0.113.42"
application/x-www-form-urlencoded
envelope_fingerprint=584ea8b41b0d4c17a96b967433b211e6&envelope_title=tagstest%20-%20Copy&action=cancelled-envelope&action_date=2025-08-06T12%3A59%3A03%2B00%3A00&envelope_meta=&company_id=64034&user_id=267199&client_ip=203.0.113.42

Responses

Acknowledge receipt

Envelope signed & completeWebhook

Request

This webhook is triggered when all required parties have completed signing an envelope. It includes the envelope fingerprint, documents, any captured field data, and a download link.

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

A string representing the signed envelope

Example: "584ea8b41b0d4c17a96b967433b211e6"
envelope_documentsstringrequired

A JSON string representing the signed documents within 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 URL to download the completed envelope

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

A JSON string of captured field values within the envelope

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

A JSON string of any meta information associated with the envelope

Example: ""
actionstringrequired

The action taken. Defaults to signed-envelope-complete.

Example: "signed-envelope-complete"
action_datestring(date-time)required

The UTC timestamp of when the envelope was fully signed

Example: "2025-08-07T10:14:33+00:00"
company_idintegerrequired

The ID of the company associated with the envelope

Example: 64034
user_idintegerrequired

The ID of the user who sent or owns the envelope

Example: 267199
client_ipstring(ipv4)required

The IP address of the client that triggered the completion

Example: "203.0.113.17"
application/x-www-form-urlencoded
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%3A460133805%2C%22field_name%22%3A%22Untitled%22%2C%22field_type%22%3A%22text%22%2C%22field_value%22%3A%22Test%22%7D%5D&envelope_meta=&action=signed-envelope-complete&action_date=2025-08-07T10%3A14%3A33%2B00%3A00&company_id=64034&user_id=267199&client_ip=203.0.113.17

Responses

Acknowledge receipt