Skip to content
/
Envelope email bounced

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 openedWebhook

Request

This webhook is triggered when a recipient opens an envelope. It includes basic information about the envelope, the recipient, and associated documents.

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

The action taken. Defaults to opened-envelope.

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

The UTC timestamp of when the envelope was opened

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

The ID of the company that owns the envelope

Example: 64034
contact_idintegerrequired

The ID of the contact who opened the envelope

Example: 7418454
contact_namestringrequired

The name of the contact who opened the envelope

Example: "Abby"
contact_emailstring(email)required

The email address of the contact who opened the envelope

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

A string identifying the opened envelope

Example: "584ea8b41b0d4c17a96b967433b211e6"
envelope_documentsstringrequired

A stringified JSON array of documents in the envelope

Example: "[{\"document_title\":\"Blank 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_metastring

A JSON string of any meta information added to the envelope

Example: ""
user_idintegerrequired

The ID of the user associated with this event

Example: 267199
client_ipstring(ipv4)required

The IP address from which the envelope was opened

Example: "203.0.113.106"
application/x-www-form-urlencoded
action=opened-envelope&action_date=2025-08-07T10%3A14%3A26%2B00%3A00&company_id=64034&contact_id=7418454&contact_name=Abby&contact_email=abby%40signable.co.uk&envelope_fingerprint=584ea8b41b0d4c17a96b967433b211e6&envelope_documents=%5B%7B%22document_title%22%3A%22Blank%20Word%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_meta=&user_id=267199&client_ip=203.0.113.106

Responses

Acknowledge receipt

Envelope email bouncedWebhook

Request

Triggered when an email to a signer fails to deliver.

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

The action taken. Defaults to bounced-envelope.

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

The UTC timestamp of when the email bounced

Example: "2025-08-07T11:33:03+00:00"
company_idintegerrequired

The ID of the company that owns the envelope

Example: 64034
envelope_bounce_emailstring(email)required

The email address that bounced

Example: "abby@singable.co.uk"
envelope_bounce_reasonstringrequired

The reason the email failed to deliver

Example: "unable to get mx info: failed to get IPs from PTR record: lookup <nil>: unrecognized address"
envelope_bounce_urlstring(uri)required

A link to view the bounce details

Example: "https://app.signable.co.uk/envelope/bounce/584ea8b41b0d4c17a96b967433b211e6/584ea8b41b0d4c17a96b967433b211e6"
envelope_fingerprintstringrequired

A string identifying the bounced envelope

Example: "584ea8b41b0d4c17a96b967433b211e6"
envelope_metastring

A JSON string of any meta information added to the envelope

Example: "{\"envelope_title\":\"Word Doc.docx\"}"
client_ipstring(ipv4)required

The IP address from which the bounce originated

Example: "198.51.100.36"
application/x-www-form-urlencoded
action=bounced-envelope&action_date=2025-08-07T11%3A33%3A03%2B00%3A00&company_id=64034&envelope_bounce_email=abby%40singable.co.uk&envelope_bounce_reason=unable%20to%20get%20mx%20info%3A%20failed%20to%20get%20IPs%20from%20PTR%20record%3A%20lookup%20%3Cnil%3E%3A%20unrecognized%20address&envelope_bounce_url=https%3A%2F%2Fapp.signable.co.uk%2Fenvelope%2Fbounce%2F584ea8b41b0d4c17a96b967433b211e6%2F584ea8b41b0d4c17a96b967433b211e6&envelope_fingerprint=584ea8b41b0d4c17a96b967433b211e6&envelope_meta=%7B%22envelope_title%22%3A%22Word%20Doc.docx%22%7D&client_ip=198.51.100.36

Responses

Acknowledge receipt

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