We've moved! Most of this page's information still applies but for the most up to date version,
click here.
The Signable API allows you to integrate Signable directly into your website or internal systems. It's REST based which means that it's easy to use and consume. We have designed it to be very powerful which means you can integrate nearly every bit of Signable into your own systems.
\nWith the Signable API you can:
\nCreate and send an Envelope
\nManage Envelopes
\nManage Templates
\nCreate and manage Webhooks
\nManage Company Settings, Users, and Branding
\nCreate and manage Sub-Accounts (Partners Only)
\nAn uploaded PDF, Word or Excel file or a Template.
\nA collection of Documents to be signed. An envelope can contain as many Documents as you need. An Envelope can consist of a mixture of Templates and uploaded documents.
To combine uploaded documents and Templates in one Envelope you must use the Signable web-app, this is currently not possible when using the Signable API.
It is only possible to send one Template at the time via the API.
A document template, created from an uploaded PDF, Word or Excel file. Templates can contain fields, which can be assigned to predetermined Party Roles.
\nTemplates can be shared as widgets, if they only contain one (1) Party Role. Widgets can either be shared via a URL, or embedded onto a webpage.
\nWhen signed, a new Envelope will be created. There is no limit to the number of times a Widget can be signed. Each time a widget is signed this will use one Envelope from your allowance. Once a Widget has been signed, signatures need to be verified by email before they are valid.
\nThe widget URL can be appended with the envelope_meta parameter, to set a base64-encoded JSON value. For example https://sign.signable.app/#/widget/aadfwRcaqN?envelope_meta={some-base64-encoded-JSON-string}. This value will be passed back in verify-envelope-widget and signed-envelope-widget webhook payloads, in the envelope_meta property.
A recipient of an Envelope. In most cases, this will be a person who is signing an Envelope. Envelope Parties can also be set as ‘copy only’, in which case they will receive a copy of the envelope once all other parties have signed.
\nA role for a Party on a Template, which can be assigned to an Envelope Party. Envelope Parties can have roles from multiple Templates.
\nConsists primarily of a name and email address. Contacts are created automatically when an envelope is sent, based on Parties.
\nA fingerprint is a unique identifier string of 32 characters. Envelopes, Templates and Documents all have their own types of fingerprint. In this documentation fingerprints are most commonly used to reference Envelopes and Templates.
\nA numerical identifier. Most commonly used to refer to Companies, Contacts and Users.
\nAn input on a document. Fields can be text, date, signatures, file uploads, dropdown or checkbox.
\nCan be used to create a field in place on an uploaded document. It is not currently possible to create every field type using tags. Learn more about tags.
\nA field in a Template that has been marked as Prefillable / A Merge Field. These fields can then be populated at point of sending. If a field is not populated on send, the party the field has been assigned to will be able to complete the field as normal. If the field has been prefilled, it is not possible for the signer to amend the field at point of signing. Learn more about Prefillable fields.
\nPlease note: Although the preferred term is 'Prefillable Fields', for legacy reasons, this concept may also be referred to as 'Merge Fields'. Be aware terms may occasionally be used interchangeably, they are the same concept.
\nAn account that can act as a parent for other Signable accounts. If you are interested in becoming a Signable Partner, please contact our team.
\nA company account managed by a Signable Partner. These accounts have an API key by default when they are created.
\nAuthentication to the Signable API is based on Basic HTTP Auth using your API key, as the username. To create an API key, please go to the API Key section in your Signable account.
\nThe Signable API can be run in two different modes, ‘test’ and ‘live’. Usually you would use the ‘test’ mode when you are developing your integration and want to be sure that whilst you're testing, you won’t impact your actual account.
\nThe main difference is that test is a read-only version of the API.
\nGET calls will return the same information in both test and live.
\nThis read-only version means that POST, PUT and DELETE requests don’t actually perform the required action however they return the response as if they had done. This means that you can test the response exactly as you would get it when in live mode without the fear that you are adding or deleting valuable information.
\nYou can tell if the call was done in ‘test’ mode because there will be a ‘test’ variable sent in the response, which would be set to true.
Even though you can access the test version of the API without being on a valid monthly plan, your account must be upgraded to a plan that supports the API to create a ‘live’ key. See all Signable plans.
\nAll calls must be passed to us via HTTPS. All HTTP calls will be ignored.
\nWe currently support TLS 1.2 and higher. Learn more about TLS.
\nYour requests will be rate limited to 5 requests per second per IP. This limit is in place to protect the API and other users from potential abusive behaviour.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Features","slug":"features"},{"content":"Signable Concepts","slug":"signable-concepts"},{"content":"API Authentication","slug":"api-authentication"},{"content":"Test vs Live API Keys","slug":"test-vs-live-api-keys"},{"content":"HTTPS","slug":"https"},{"content":"Rate Limiting","slug":"rate-limiting"}],"owner":"2304617","collectionId":"767d689a-d778-49f7-a798-ec290ba66d16","publishedId":"UVJYLKjV","public":true,"customColor":{"top-bar":"0098ce","right-sidebar":"375364","highlight":"0098ce"},"publishDate":"2025-06-18T09:42:32.000Z"},"item":[{"name":"Get Started","item":[{"name":"Step 1: Setup up an 'Envelope Complete' Webhook","item":[{"name":"Create a webhook","id":"464b2966-06dc-4f19-993e-210cd0a2dfff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"webhook_type\": \"all\",\r\n \"webhook_url\": \"https://example.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.signable.co.uk/v1/webhooks","description":"Create your webhook using the signed-envelope-complete webhook type. This will be used to notify you when an envelope has been signed by all parties and is therefore considered \"complete\".
Next you're going to set up an integration that watches for when your signed-envelope-complete webhook fires off, to then trigger a GET request of the completed envelope, and extract the envelope_download_url contained within, which will then store that as a completed envelope in your preferred location.
Make sure you setup Signable Tags in the document before sending.
\n*Either document_url or document_file_content (and document_file_name) have to be passed in.
Finally, send an envelope to check it all works as expected.
\nThis is a very simple use case; the API is capable of doing much more, but this will get you up and running very quickly. If you have any further questions, please contact us at help@signable.co.uk
\n","_postman_id":"6274305a-b130-418e-80a7-3ab5931080b0","auth":{"type":"basic","basic":{},"isInherited":true,"source":{"_postman_id":"767d689a-d778-49f7-a798-ec290ba66d16","id":"767d689a-d778-49f7-a798-ec290ba66d16","name":"Signable API","type":"collection"}}}],"id":"bbc8e641-2e9e-4992-aab8-3fe67fc6964c","description":"There are many use cases for Signable and the API, but one of the most common is using your system to prefill data onto an envelope and then storing your completed envelopes outside of Signable.
\nFor this usecase we're going to assume that you have a system which can generate documents with all information prefilled and also include your desired Signable tags for fields you need your signer to fill in.
\n","_postman_id":"bbc8e641-2e9e-4992-aab8-3fe67fc6964c","auth":{"type":"basic","basic":{},"isInherited":true,"source":{"_postman_id":"767d689a-d778-49f7-a798-ec290ba66d16","id":"767d689a-d778-49f7-a798-ec290ba66d16","name":"Signable API","type":"collection"}}},{"name":"Partner","item":[{"name":"Create a Sub-Account","id":"b6b2ad64-12fb-47e9-9074-0d69767d6f77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"company_name\": \"Example Inc\",\r\n \"user_name\": \"Anne Example\",\r\n \"user_email\": \"anne@example.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.signable.co.uk/v1/companies","description":"Get the envelope usage for the current and previous month for each of your sub-accounts for the last 3 months maximum.
\n","auth":{"type":"basic","basic":{},"isInherited":true,"source":{"_postman_id":"767d689a-d778-49f7-a798-ec290ba66d16","id":"767d689a-d778-49f7-a798-ec290ba66d16","name":"Signable API","type":"collection"}},"urlObject":{"path":["usage"],"host":["https://api.signable.co.uk/v1"],"query":[{"description":{"content":"A positive integer indicating the first record to retrieve. Optional, defaults to the first company (0).
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"A positive integer indicating the maximum number of companies to return. Optional, defaults to 10.
\n","type":"text/plain"},"key":"limit","value":"10"}],"variable":[]}},"response":[{"id":"6e13966b-f5ae-4e5e-983f-2a224f1c1cff","name":"View usage per Sub-Account","originalRequest":{"method":"GET","header":[{"key":"KsYSmaLdSwqnPJyWeOMQKXHtxLXfmWka","value":"","type":"text","disabled":true}],"url":{"raw":"https://api.signable.co.uk/v1/usage?offset=0&limit=10","host":["https://api.signable.co.uk/v1"],"path":["usage"],"query":[{"key":"offset","value":"0","description":"A positive integer indicating the first record to retrieve. Optional, defaults to the first company (0)."},{"key":"limit","value":"10","description":"A positive integer indicating the maximum number of companies to return. Optional, defaults to 10."}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"http\": 200,\n \"offset\": 0,\n \"limit\": 10,\n \"total_companies\": \"3\",\n \"current_start_date\": \"2020-01-01T16:31:02+0000\",\n \"current_end_date\": \"2020-02-01T16:31:02+0000\",\n \"previous_start_date\": \"2020-12-01T16:31:02+0000\",\n \"previous_end_date\": \"2020-01-01T16:31:02+0000\",\n \"next\": \"https://api.signable.co.uk/v1/usage?offset=10&limit=10\",\n \"companies\": [\n {\n \"company_id\": \"1000\",\n \"company_name\": \"Test Company 1\",\n \"current_usage\": \"50\",\n \"previous_usage\": \"150\",\n \"company_created\": \"2019-10-07T13:35:30+0000\"\n },\n {\n \"company_id\": \"1001\",\n \"company_name\": \"Test Company 2\",\n \"current_usage\": \"0\",\n \"previous_usage\": \"20\",\n \"company_created\": \"2019-10-07T13:35:30+0000\"\n },\n {\n \"company_id\": \"1002\",\n \"company_name\": \"Test Company 3\",\n \"current_usage\": \"1000\",\n \"previous_usage\": \"1500\",\n \"company_created\": \"2019-10-07T13:35:30+0000\"\n }\n ]\n}"}],"_postman_id":"74cd1c24-1221-4242-9854-26f5adbd0452"},{"name":"List Sub-Accounts","id":"a4972628-ff87-4467-a953-9ab5a0747819","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.signable.co.uk/v1/companies?offset=0&limit=10","auth":{"type":"basic","basic":{},"isInherited":true,"source":{"_postman_id":"767d689a-d778-49f7-a798-ec290ba66d16","id":"767d689a-d778-49f7-a798-ec290ba66d16","name":"Signable API","type":"collection"}},"urlObject":{"path":["companies"],"host":["https://api.signable.co.uk/v1"],"query":[{"description":{"content":"A positive integer indicating the first record to retrieve. Optional, defaults to the first sub-account (0).
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"A positive integer indicating the maximum number of sub-accounts to return. Optional, defaults to 10.
\n","type":"text/plain"},"key":"limit","value":"10"}],"variable":[]}},"response":[{"id":"d834ce82-cacb-4c36-9dfa-550fb4f36222","name":"List Sub-Accounts","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.signable.co.uk/v1/companies?offset=0&limit=10","host":["https://api.signable.co.uk/v1"],"path":["companies"],"query":[{"key":"offset","value":"0","description":"A positive integer indicating the first record to retrieve. Optional, defaults to the first sub-account (0)."},{"key":"limit","value":"10","description":"A positive integer indicating the maximum number of sub-accounts to return. Optional, defaults to 10."}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"http\": 200,\n \"offset\": 0,\n \"limit\": 10,\n \"total_companies\": \"3\",\n \"next\": \"https://api.signable.co.uk/v1/companies?offset=10&limit=10\",\n \"companies\": [\n {\n \"company_id\": \"2001\",\n \"company_name\": \"Example Sub Account 1\",\n \"company_email\": \"john@smith.com\",\n \"company_api_key\": \"d41d8cd98f00b204e9800998ecf8427e\",\n \"company_created\": \"2021-10-07T13:35:30+0000\"\n },\n {\n \"company_id\": \"2002\",\n \"company_name\": \"Example Sub Account 2\",\n \"company_email\": \"jane@smith.com\",\n \"company_api_key\": \"d41d8cd98f00b204e9800998ecf8427e\",\n \"company_created\": \"2021-10-07T13:35:30+0000\"\n },\n {\n \"company_id\": \"2003\",\n \"company_name\": \"Example Sub Account 3\",\n \"company_email\": \"joe@smith.com\",\n \"company_api_key\": \"d41d8cd98f00b204e9800998ecf8427e\",\n \"company_created\": \"2021-10-07T13:35:30+0000\"\n }\n]\n}\n"}],"_postman_id":"a4972628-ff87-4467-a953-9ab5a0747819"},{"name":"Get a Sub-Account","id":"6d36f754-421e-439b-998d-5ded5e8fca7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.signable.co.uk/v1/companies/{{Sub-Account Company ID}}","description":"These endpoints are only available to Signable Partners, if you are interested in becoming a Partner please contact our team.
\n","event":[{"listen":"prerequest","script":{"id":"740b28a0-0e9d-4f06-aa31-aa1369163063","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5cdb7f09-142c-4989-bbe4-5b4f4f496887","type":"text/javascript","exec":[""]}}],"_postman_id":"c7294ba0-a048-40fe-acd8-16dba4ea3e9a","auth":{"type":"basic","basic":{},"isInherited":true,"source":{"_postman_id":"767d689a-d778-49f7-a798-ec290ba66d16","id":"767d689a-d778-49f7-a798-ec290ba66d16","name":"Signable API","type":"collection"}}},{"name":"Envelopes","item":[{"name":"Send an Envelope without using a Template","id":"345be7c5-d85c-44b3-b153-ab32cb8ea161","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.signable.co.uk/v1/envelopes","description":"Please note: It is not possible to send a mixture of non-template and template documents in the same envelope. These must be sent separately.
\nMake sure you setup Signable Tags in the document before sending.
\n*Either document_url or document_file_content (and document_file_name) have to be passed in.
When enabled, the POST - Send envelope using a template will return the field envelope_signing_embed which contains an iframe with the URL of the signing page which you can use to display the signing page in your app. Contact our team to request Embedded Signing be enabled for your account.
To get the signing page URL of subsequent parties, follow these steps:
\nEnable the ‘Envelope Sent’ webhook
\nOnce the first party has signed, obtain further envelope_signing_embed signing links from webhook's event response.
If required, you can suppress Signable notification emails to the signers - to fully control the signing page and any notifications. Once embedded signing is enabled on your account, you will see a setting to suppress those emails under Company Settings > Preferences > Emails
\nThe signer will always receive a Signed and Completed email notification with a link to the final document - that email will be from Signable.
\nYou may want to make sure you use envelope_redirect_url to keep the user in your app after signing.
When using Embedded Signing in your app you're accountable for ensuring the signer's identity. You can do this by for example making sure that the page with the embedded signing is:
\n* Secured via SSL, so have an https address.
* Behind a username/password login type system unique to only 1 single signing party.
This is so that if there is a dispute, the evidence you have collected to assert the signer's identity can be provided to help trace the signature back to the signer.
\n","auth":{"type":"basic","basic":{},"isInherited":true,"source":{"_postman_id":"767d689a-d778-49f7-a798-ec290ba66d16","id":"767d689a-d778-49f7-a798-ec290ba66d16","name":"Signable API","type":"collection"}},"urlObject":{"path":["envelopes"],"host":["https://api.signable.co.uk/v1"],"query":[],"variable":[]}},"response":[{"id":"34606161-d2b7-42f1-89f5-179294fd14e9","name":"Send an Envelope using a Template","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"envelope_title\": \"Example Envelope from Template\",\n\t\"envelope_password_protect\": true,\n \"envelope_requires_otp\": false,\n \"envelope_documents\": [\n {\n \"document_title\": \"Sample Document\",\n \"document_template_fingerprint\": \"b786a173554cc06371198caf0b250704\",\n \"document_merge_fields\": [\n {\n \"field_id\": \"185752033\",\n \"field_value\": \"Tester Tester\"\n },\n {\n \"field_id\": \"185752039\",\n \"field_value\": \"TBC\"\n }\n ]\n }\n ],\n \"envelope_parties\": [\n {\n \"party_name\": \"Jo Bloggs\",\n \"party_email\": \"jo@example.com\",\n \"party_id\": \"7943316\",\n \"party_role\": \"signer\",\n \"party_message\": \"hello world\",\n \"party_password\": \"password321\"\n },\n {\n \"party_name\": \"Anne Example\",\n \"party_email\": \"anne@example.com\",\n \"party_id\": \"7943317\",\n \"party_role\": \"copy\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.signable.co.uk/v1/envelopes"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"http\": 202,\n \"message\": \"Your envelope with title Example Envelope from Template will be processed and sent out.\",\n \"href\": \"https://api.signable.co.uk/v1/envelopes/0dfd1c78e19f6b59504675e21f2f2b8c\",\n \"envelope_title\": \"Example Envelope from Template\",\n \"envelope_fingerprint\": \"0dfd1c78e19f6b59504675e21f2f2b8c\",\n \"envelope_password_protect\": true,\n \"envelope_redirect_url\": \"\",\n \"envelope_queued\": \"2021-12-08T11:35:00+0000\",\n \"envelope_all_at_once_enabled\": false,\n \"envelope_requires_otp\": false,\n \"envelope_parties\": [\n {\n \"party_id\": 7943316,\n \"party_title\": \"Jo Bloggs\",\n \"party_mobile_last4\": null,\n \"party_password\": \"password321\"\n },\n {\n \"party_id\": 7943317,\n \"party_title\": \"Anne Example\",\n \"party_mobile_last4\": null,\n \"party_password\": \"autogen_16djb22j2\"\n }\n ]\n}"},{"id":"67c9394e-5b35-47c0-9ccc-e4b3e7055d1f","name":"With party password","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"envelope_title\": \"Example Envelope from Template\",\n \"envelope_password_protect\": true,\n\t\"envelope_documents\": [\n\t\t{\n\t\t\t\"document_title\": \"Sample Document\",\n\t\t\t\"document_template_fingerprint\": \"b786a173554cc06371198caf0b250704\"\n\t\t}\n\t],\n\t\"envelope_parties\": [\n\t\t{\n\t\t\t\"party_name\": \"Jo Bloggs\",\n\t\t\t\"party_email\": \"jo@example.com\",\n\t\t\t\"party_id\": \"7943316\",\n\t\t\t\"party_role\": \"signer\",\n\t\t\t\"party_message\": \"hello world\",\n\t\t\t\"party_password\": \"myCustomPassword\"\n\t\t}\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.signable.co.uk/v1/envelopes"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"http\": 202,\n \"message\": \"Your envelope with title Example Envelope from Template will be processed and sent out.\",\n \"href\": \"https://api.signable.co.uk/v1/envelopes/0dfd1c78e19f6b59504675e21f2f2b8c\",\n \"envelope_title\": \"Example Envelope from Template\",\n \"envelope_fingerprint\": \"0dfd1c78e19f6b59504675e21f2f2b8c\",\n \"envelope_password_protect\": true,\n \"envelope_redirect_url\": \"\",\n \"envelope_queued\": \"2021-12-08T11:35:00+0000\",\n \"envelope_all_at_once_enabled\": false,\n \"envelope_parties\": [\n {\n \"party_id\": 7943316,\n \"party_title\": \"Jo Bloggs\",\n \"party_mobile_last4\": null,\n \"party_password\": \"myCustomPassword\"\n }\n ]\n}"},{"id":"568b96a6-226b-493b-9f18-79e1c092310d","name":"With embedded signing","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"envelope_title\": \"Example Envelope from Template\",\n\t\"envelope_documents\": [\n\t\t{\n\t\t\t\"document_title\": \"Sample Document\",\n\t\t\t\"document_template_fingerprint\": \"b786a173554cc06371198caf0b250704\"\n\t\t}\n\t],\n\t\"envelope_parties\": [\n\t\t{\n\t\t\t\"party_name\": \"Jo Bloggs\",\n\t\t\t\"party_email\": \"jo@example.com\",\n\t\t\t\"party_id\": \"7943316\",\n\t\t\t\"party_role\": \"signer\",\n\t\t\t\"party_message\": \"hello world\"\n\t\t}\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.signable.co.uk/v1/envelopes"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"","enabled":true,"type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"http\": 202,\n \"message\": \"Your envelope with title My envelope will be processed and sent out.\",\n \"href\": \"https://api.signable.co.uk/v1/envelopes/d41d8cd98f00b204e9800998ecf8427e\",\n \"envelope_title\": \"My envelope\",\n \"envelope_fingerprint\": \"d41d8cd98f00b204e9800998ecf8427e\",\n \"envelope_signing_embed\": \"\",\n \"envelope_queued\": \"2013-10-25T13:53:49+0000\",\n \"envelope_all_at_once_enabled\": false,\n \"envelope_parties\": [\n {\n \"party_id\": 7943316,\n \"party_title\": \"Jo Bloggs\",\n \"party_mobile_last4\": null,\n \"party_password\": null\n }\n ]\n}"}],"_postman_id":"a4ea0032-7339-4a73-9d96-00c860fce95c"},{"name":"Send an Envelope using multiple Templates","id":"44bbfee2-6ad6-4751-9bf3-240a576e5865","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"envelope_title\": \"Example Envelope from Template\",\n\t\"envelope_documents\": [\n\t\t{\n\t\t\t\"document_title\": \"Sample Document\",\n\t\t\t\"document_template_fingerprint\": \"d8b71ad3506b6b67c08a4a3485ef807x\"\n\t\t},\n\t\t{\n\t\t\t\"document_title\": \"Another Sample Document\",\n\t\t\t\"document_template_fingerprint\": \"96d04c621f4ab0673b00b401a06db9ex\"\n\t\t}\n\t],\n\t\"envelope_parties\": [\n\t\t{\n\t\t\t\"party_name\": \"Jo Bloggs\",\n\t\t\t\"party_email\": \"jo@example.com\",\n\t\t\t\"party_role\": \"signer\",\n\t\t\t\"party_message\": \"hello world\",\n \"party_documents\": [\n {\n \"party_id\": 7943316,\n \"document_template_fingerprint\": \"d8b71ad3506b6b67c08a4a3485ef807x\"\n },\n {\n \"party_id\": 7943715,\n \"document_template_fingerprint\": \"96d04c621f4ab0673b00b401a06db9ex\"\n }\n ]\n\t\t}\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.signable.co.uk/v1/envelopes","description":"Sends a reminder email to the active signing party, which includes a link to sign the envelope.
\nImportant: Reminders can only be sent for active (sent/in progress) Envelopes.
\nImportant: Only active (sent/in progress) Envelopes can be cancelled.
\nImportant: Only active (sent/in progress) Envelopes can be expired.
\nImportant: If the envelope has been sent and is in progress you must first ether expire or cancel the envelope.
\nCancelling an envelope will let parties know it's been cancelled via email, whereas expiring an envelope is a silent cancel and doesn't let signers know it's been cancelled.
\nIf an envelope has been cancelled and the signer tries accessing it via their unique signing url, they'll be redirected to a page letting them know that the envelope is no longer available and to contact the sender.
\nEnvelopes created will be shared according to the Default API Sharing Settings, this can be adjusted in the Signable App: https://signable.app/company-settings/developer
\nSharing restrictions are only considered for Users & Teams while using the Signable APP. All Envelopes will be shown while using this API.
\nIf you wish to set sharing settings for Envelopes created via the API for Users that use the Signable APP you may adjust this in Signable App > Company Settings > API & Webhooks
\n![](\"https://signable.help/wp-content/uploads/image-275-1024x552.png\")
","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"101d94ee-1ebc-490e-b4d0-a96db2be9f45"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"480c209f-ac33-479c-b715-a2d3b588ea4e"}}],"_postman_id":"8df9df70-076a-4388-8278-33f9734ce12b","auth":{"type":"basic","basic":{},"isInherited":true,"source":{"_postman_id":"767d689a-d778-49f7-a798-ec290ba66d16","id":"767d689a-d778-49f7-a798-ec290ba66d16","name":"Signable API","type":"collection"}}},{"name":"Templates","item":[{"name":"Get a list of Templates","event":[{"listen":"prerequest","script":{"id":"bbf4c57a-b6bd-4929-a5bd-e28ed09924f9","exec":[""],"type":"text/javascript"}},{"listen":"test","script":{"id":"87e29681-9bc5-4563-a1c4-b73a3251de2c","exec":[""],"type":"text/javascript"}}],"id":"bfbabba5-2d1d-4203-845d-46a1c0e7b922","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.signable.co.uk/v1/templates?offset=0&limit=10","auth":{"type":"basic","basic":{},"isInherited":true,"source":{"_postman_id":"767d689a-d778-49f7-a798-ec290ba66d16","id":"767d689a-d778-49f7-a798-ec290ba66d16","name":"Signable API","type":"collection"}},"urlObject":{"path":["templates"],"host":["https://api.signable.co.uk/v1"],"query":[{"description":{"content":"A positive integer indicating the first record to retrieve. Optional, defaults to the first template (0).
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"A positive integer indicating the maximum number of templates to return. Optional, defaults to 10.
\n","type":"text/plain"},"key":"limit","value":"10"}],"variable":[]}},"response":[{"id":"0b10baf0-04ba-4d80-a3e0-0afb30f231cd","name":"Get a list of Templates","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.signable.co.uk/v1/templates?offset=0&limit=24","host":["https://api.signable.co.uk/v1"],"path":["templates"],"query":[{"key":"offset","value":"0"},{"key":"limit","value":"24"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 08 Dec 2021 13:32:50 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=UTF-8","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,POST,DELETE,PUT,OPTIONS","enabled":true},{"key":"Access-Control-Allow-Headers","value":"Authorization","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"http\": 200,\n \"offset\": 0,\n \"limit\": 24,\n \"total_templates\": \"2\",\n \"templates\": [\n {\n \"template_id\": \"21137093\",\n \"template_fingerprint\": \"76ba1c4fed14be4170ee6b52f1e235e8\",\n \"template_title\": \"Sample Sales Agreement\",\n \"template_page_total\": \"5\",\n \"template_in_progress\": \"0\",\n \"template_parties_total\": \"1\",\n \"template_widget_url\": \"https://app.signable.co.uk/widget/url/yAAwy6D5z4\",\n \"template_widget_embed\": \"\",\n \"template_pdf_url\": \"https://docs.signable.co.uk/original/76ba1c4fed14be4170ee6b52f1e235e8.pdf\",\n \"template_thumbnails\": [\n \"https://docs.signable.co.uk/small/76ba1c4fed14be4170ee6b52f1e235e8-0.jpg\",\n \"https://docs.signable.co.uk/small/76ba1c4fed14be4170ee6b52f1e235e8-1.jpg\",\n \"https://docs.signable.co.uk/small/76ba1c4fed14be4170ee6b52f1e235e8-2.jpg\",\n \"https://docs.signable.co.uk/small/76ba1c4fed14be4170ee6b52f1e235e8-3.jpg\",\n \"https://docs.signable.co.uk/small/76ba1c4fed14be4170ee6b52f1e235e8-4.jpg\"\n ],\n \"template_pages\": [\n \"https://docs.signable.co.uk/large/76ba1c4fed14be4170ee6b52f1e235e8-0.jpg\",\n \"https://docs.signable.co.uk/large/76ba1c4fed14be4170ee6b52f1e235e8-1.jpg\",\n \"https://docs.signable.co.uk/large/76ba1c4fed14be4170ee6b52f1e235e8-2.jpg\",\n \"https://docs.signable.co.uk/large/76ba1c4fed14be4170ee6b52f1e235e8-3.jpg\",\n \"https://docs.signable.co.uk/large/76ba1c4fed14be4170ee6b52f1e235e8-4.jpg\"\n ],\n \"template_parties\": [\n {\n \"party_id\": \"7951562\",\n \"party_name\": \"Signer 1\"\n }\n ],\n \"template_uploaded\": \"2021-12-08T13:32:23+0000\"\n },\n {\n \"template_id\": \"21112429\",\n \"template_fingerprint\": \"b786a173554cc06371198caf0b250704\",\n \"template_title\": \"Sample Contract\",\n \"template_page_total\": \"1\",\n \"template_in_progress\": \"1\",\n \"template_parties_total\": \"1\",\n \"template_widget_url\": \"https://app.signable.co.uk/widget/url/\",\n \"template_widget_embed\": \"\",\n \"template_pdf_url\": \"https://docs.signable.co.uk/original/b786a173554cc06371198caf0b250704.pdf\",\n \"template_thumbnails\": [\n \"https://docs.signable.co.uk/small/b786a173554cc06371198caf0b250704-0.jpg\"\n ],\n \"template_pages\": [\n \"https://docs.signable.co.uk/large/b786a173554cc06371198caf0b250704-0.jpg\"\n ],\n \"template_parties\": [\n {\n \"party_id\": \"7943316\",\n \"party_name\": \"Party\",\n \"party_merge_fields\": [\n {\n \"field_id\": \"163570318\",\n \"field_merge\": \"Name Of Sender\",\n \"field_type\": \"text\"\n }\n ]\n }\n ],\n \"template_uploaded\": \"2021-12-07T15:18:57+0000\"\n }\n ]\n}"}],"_postman_id":"bfbabba5-2d1d-4203-845d-46a1c0e7b922"},{"name":"Get an individual Template","id":"444e70fd-7e5c-4bb4-8dda-697e11eb4144","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.signable.co.uk/v1/templates/{{Template Fingerprint}}","description":"A positive integer indicating the first record to retrieve. Defaults to the first contact (0).
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"A positive integer indicating the maximum number of contacts to return. Defaults to 10.
\n","type":"text/plain"},"key":"limit","value":"50"}],"variable":[]}},"response":[{"id":"61fbee41-38c6-4612-ae8b-58d2ca7306a2","name":"List Contacts","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.signable.co.uk/v1/contacts?offset=0&limit=50","host":["https://api.signable.co.uk/v1"],"path":["contacts"],"query":[{"key":"offset","value":"0"},{"key":"limit","value":"50"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 08 Dec 2021 13:43:36 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=UTF-8","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,POST,DELETE,PUT,OPTIONS","enabled":true},{"key":"Access-Control-Allow-Headers","value":"Authorization","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"http\": 200,\n \"offset\": 0,\n \"limit\": 50,\n \"total_contacts\": \"2\",\n \"contacts\": [\n {\n \"contact_id\": \"7593927\",\n \"contact_name\": \"Jo Bloggs\",\n \"contact_email\": \"jo.bloggs@example.com\",\n \"contact_outstanding_documents\": \"0\",\n \"contact_created\": \"2021-12-08T13:41:48+0000\"\n },\n {\n \"contact_id\": \"7592080\",\n \"contact_name\": \"Jo Bloggs\",\n \"contact_email\": \"jo@example.com\",\n \"contact_outstanding_documents\": \"0\",\n \"contact_created\": \"2021-12-08T11:34:21+0000\"\n }\n ]\n}"}],"_postman_id":"baaacace-47af-45ed-a956-fa22bdfc616e"},{"name":"Get an individual Contact","id":"98292735-a400-468e-8418-5dd368294b9c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.signable.co.uk/v1/contacts/{{Contact ID}}","description":"*Either contact_name or contact_email must be provided.
Passwords will be sent to the email address provided, which the user can later update.
\nA positive integer indicating the first record to retrieve. Optional, defaults to the first user (0).
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"A positive integer indicating the maximum number of users to return. Optional, defaults to 10
\n","type":"text/plain"},"key":"limit","value":"50"}],"variable":[]}},"response":[{"id":"7780949f-49a2-4669-818f-c5f02beeb31d","name":"List users","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.signable.co.uk/v1/users?offset=0&limit=50","host":["https://api.signable.co.uk/v1"],"path":["users"],"query":[{"key":"offset","value":"0","description":"A positive integer indicating the first record to retrieve. Optional, defaults to the first user (0)."},{"key":"limit","value":"50","description":"A positive integer indicating the maximum number of users to return. Optional, defaults to 10."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 08 Dec 2021 14:41:40 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=UTF-8","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"close","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,POST,DELETE,PUT,OPTIONS","enabled":true},{"key":"Access-Control-Allow-Headers","value":"Authorization","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"http\": 200,\n \"offset\": 0,\n \"limit\": 50,\n \"total_users\": \"2\",\n \"users\": [\n {\n \"user_id\": \"326241\",\n \"role_id\": \"3\",\n \"user_name\": \"Jo Bloggs\",\n \"user_email\": \"jo@example.com\",\n \"user_added\": \"2021-12-07T15:18:57+0000\",\n \"user_last_updated\": \"2021-12-08T13:47:39+0000\"\n },\n {\n \"user_id\": \"326403\",\n \"role_id\": \"3\",\n \"user_name\": \"Anne Example\",\n \"user_email\": \"anne@example.com\",\n \"user_added\": \"2021-12-08T14:40:15+0000\",\n \"user_last_updated\": \"2021-12-08T14:40:16+0000\"\n }\n ]\n}"}],"_postman_id":"75e44f48-42cf-4941-ae52-76420ecaa4cf"},{"name":"Get an individual User","id":"6aa00db9-b2a2-4fe1-95bd-701da84333bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.signable.co.uk/v1/users/{{User ID}}","description":"\\r\\n \\t
| \\r\\n
\\r\\n \\t
| \\r\\n
\\n \\t
| \\n
\\n \\t
| \\n
\\n \\t
| \\n
\\n \\t
| \\n
\\n \\t
| \\n
*Only one (1) property can be updated at the same time.
\nYou can include variables in your email body as placeholders.
\n","auth":{"type":"basic","basic":{},"isInherited":true,"source":{"_postman_id":"767d689a-d778-49f7-a798-ec290ba66d16","id":"767d689a-d778-49f7-a798-ec290ba66d16","name":"Signable API","type":"collection"}},"urlObject":{"path":["branding","emails","email-signed"],"host":["https://api.signable.co.uk/v1"],"query":[],"variable":[]}},"response":[{"id":"9b335076-0de1-4669-8988-078f4c109d0a","name":"Update Branding emails","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"branding_email_type\": \"email-signed\",\n \"branding_email_subject\": \"You've Signed, Go You!\",\n \"branding_email_content\": \"\\n\\n \\t
| \\n
\\n \\t
| \\n
Branding is updatable by logging into the app. Here are a couple of help guides:
\nWebhooks are used to get an instant response to an action performed within Signable.
\nFor example when an envelope is sent out (via the API or through the Web App) a ‘send-envelope’ event is posted to a webhook which can be setup either via the API or via your Signable account.
\nAll webhook URLs are POSTed the information. You will be able to retrieve this information from your webhook by grabbing the POST array.
\nWebhooks can be created via the API & Webhook section under Company Settings on the Signable web app or via the Signable API, see \"API Endpoints > Webhooks\".
\nIf you want to test the response that you get from the webhook, you can use a service like PipeDream [3rd party service] to view the response.
\nBelow are some sample responses which you will receive depending on which webhook is called.
\nPlease note - All webhook POST requests will use the Content-Type:content-type: application/x-www-form-urlencoded and require a 200 response.
Generic webhook, triggered for all actions.
\nAction Reference: all
Called when an Envelope is sent.
\nAction Reference: send-envelope
View More
\nCalled when an Envelope is signed by a recipient party.
\nAction Reference: signed-envelope
View More
\nCalled when an Envelope has been signed by all recipient parties.
\nAction Reference: signed-envelope-complete
Called when the envelope is cancelled by the sending company.
\nAction Reference: cancelled-envelope
Called when the envelope is rejected by a recipient party.
\nAction Reference: rejected-envelope
This fires when a signer opens the signing page to view the Envelope.
\nAction Reference: opened-envelope
View More
\nThis fires when an envelope is sent to a signer and the email bounces back.
\nAction Reference: bounced-envelope
Called when the envelope fails to send
\nAction Reference: send-envelope-failed
Called when a user is added to the company.
\nAction Reference: add-user
Called when a contact (a.k.a. client) is added to the company.
\nAction Reference: add-contact
Called when a Template is added to a company.
\nAction Reference: add-template
Called when a Widget Template has been completed, before the user has verified their signature.
\nAction Reference: verify-envelope-widget
Action Reference: signed-envelope-widget
View More
\nBelow is an example of how the POST event trigger for the signed-envelope webhook will look, when a party has signed. (Example image taken from PipeDream)
Response body example:
\n{ \n \"http\": 400, \n \"code\": 10555, \n \"message\": \"To be able to update branding options you must pass in at least one option\" \n}\n\n