# Signable API 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. Version: 1.0.0 License: Proprietary ## Servers Production server ``` https://api.signable.co.uk/v1 ``` ## Security ### basicAuth Authenticate using HTTP Basic Authentication. Use your API key as the username and the password can be anything. For ease of use we recommend "x". Type: http Scheme: basic ## Download OpenAPI description [Signable API](https://signable-developer-portal.redocly.app/_spec/openapi.yaml) ## Partners Manage partner integrations. ### List sub-accounts - [GET /companies](https://signable-developer-portal.redocly.app/openapi/partners/getcompanies.md): Returns a paginated list of sub-accounts associated with the Partner account. This endpoint is only available to Signable Partners. ### Create a sub-account - [POST /companies](https://signable-developer-portal.redocly.app/openapi/partners/createcompany.md): Creates a new sub-account under the Partner account. This endpoint is only available to Signable Partners. ### Get a sub-account - [GET /companies/{company_id}](https://signable-developer-portal.redocly.app/openapi/partners/getcompany.md): Returns details about a specific sub-account associated with the Partner account. This endpoint is only available to Signable Partners. ### Update a sub-account - [PUT /companies/{company_id}](https://signable-developer-portal.redocly.app/openapi/partners/updatecompany.md): Updates details of a specific sub-account associated with the authenticated Partner account. This endpoint is only available to Signable Partners. ### Delete a sub-account - [DELETE /companies/{company_id}](https://signable-developer-portal.redocly.app/openapi/partners/deletecompany.md): Permanently deletes a sub-account (company) from the Partner account. This operation is irreversible and can only be performed by Signable Partners. ### View usage for all sub-accounts - [GET /usage](https://signable-developer-portal.redocly.app/openapi/partners/getcompaniesusage.md): Retrieves usage data for all sub-accounts under a Partner account, including current and previous period comparisons. This endpoint is only available to Signable Partners. ## Envelopes Send, track, and manage documents for e-signature. ### List envelopes - [GET /envelopes](https://signable-developer-portal.redocly.app/openapi/envelopes/listenvelopes.md): Returns a paginated list of envelopes. You can filter by status or search by title using optional query parameters. ### Send an envelope - [POST /envelopes](https://signable-developer-portal.redocly.app/openapi/envelopes/sendenvelope.md): Creates and queues a new envelope for sending, using one of the following methods for attaching documents: ⚠️ Only one document input method can be used per request. ### Get envelope details - [GET /envelopes/{envelope_fingerprint}](https://signable-developer-portal.redocly.app/openapi/envelopes/getenvelope.md): Returns the full details of a specific envelope, including document data, party information, field data, and envelope history. ### Delete an envelope - [DELETE /envelopes/{envelope_fingerprint}](https://signable-developer-portal.redocly.app/openapi/envelopes/deleteenvelope.md): Deletes an envelope. Only available for envelopes in , , or status. No notification email is sent to signers when an envelope is deleted. ### Send envelope reminder - [PUT /envelopes/{envelope_fingerprint}/remind](https://signable-developer-portal.redocly.app/openapi/envelopes/remindenvelope.md): Sends a reminder email to all outstanding signing parties for the specified envelope. If automatic reminders are enabled, this also resets the countdown timer for the next scheduled reminder. ### Cancel an envelope - [PUT /envelopes/{envelope_fingerprint}/cancel](https://signable-developer-portal.redocly.app/openapi/envelopes/cancelenvelope.md): Cancels a envelope. A cancellation email will be sent to all signing parties, and the envelope will no longer be available for signing. ### Expire an envelope - [PUT /envelopes/{envelope_fingerprint}/expire](https://signable-developer-portal.redocly.app/openapi/envelopes/expireenvelope.md): Expires a envelope, preventing any further signing interaction. No notification email is sent to signers when an envelope expires. ## Templates Create and reuse predefined document templates. ### List templates - [GET /templates](https://signable-developer-portal.redocly.app/openapi/templates/listtemplates.md): Retrieves a paginated list of all templates available in your account. ### Get template - [GET /templates/{template_fingerprint}](https://signable-developer-portal.redocly.app/openapi/templates/gettemplate.md): Retrieves metadata and configuration for a single template. ### Delete a template - [DELETE /templates/{template_fingerprint}](https://signable-developer-portal.redocly.app/openapi/templates/deletetemplate.md): Deletes a template by its fingerprint. ## Contacts Manage contact details for signers and stakeholders. ### List contacts - [GET /contacts](https://signable-developer-portal.redocly.app/openapi/contacts/listcontacts.md): Retrieves a paginated list of all contacts. Use and query parameters to control pagination. ### Create a contact - [POST /contacts](https://signable-developer-portal.redocly.app/openapi/contacts/createcontact.md): Adds a new contact to your contact list. ### Get a contact - [GET /contacts/{contact_id}](https://signable-developer-portal.redocly.app/openapi/contacts/getcontact.md): Retrieves details of a single contact by . ### Update a contact - [PUT /contacts/{contact_id}](https://signable-developer-portal.redocly.app/openapi/contacts/updatecontact.md): Updates a contact's name or email address. ### Delete a contact - [DELETE /contacts/{contact_id}](https://signable-developer-portal.redocly.app/openapi/contacts/deletecontact.md): Deletes a contact by their . ### List envelopes for a contact - [GET /contacts/{contact_id}/envelopes](https://signable-developer-portal.redocly.app/openapi/contacts/listcontactenvelopes.md): Returns a paginated list of all envelopes that the contact is a recipient of. Each envelope includes basic metadata such as its current status, timestamps, and optional signed PDF link. ## Users Control user accounts and roles. ### List users - [GET /user](https://signable-developer-portal.redocly.app/openapi/users/listusers.md): Retrieves a paginated list of all users in your account. You can control pagination using the and query parameters. ### Create a user - [POST /user](https://signable-developer-portal.redocly.app/openapi/users/createuser.md): Adds a new user to your account. You must provide the user’s name, email address, and their role ID. ### Get a user - [GET /users/{user_id}](https://signable-developer-portal.redocly.app/openapi/users/getuser.md): Retrieves the details of a single user by their unique . The response includes the user's name, email, role, and timestamps. ### Update a user - [PUT /users/{user_id}](https://signable-developer-portal.redocly.app/openapi/users/updateuser.md): Updates an existing user by their . You can change their name, email address, or assigned role. ### Delete a user - [DELETE /users/{user_id}](https://signable-developer-portal.redocly.app/openapi/users/deleteuser.md): Removes a user from your account using their . The response confirms the deletion and includes the user's basic details. ## Branding Customize visual and branding settings for emails. ### Get branding settings - [GET /branding](https://signable-developer-portal.redocly.app/openapi/branding/getbranding.md): Returns your company's current branding settings, including any uploaded logo and primary colour. These settings control how Signable emails and signing pages appear to your signers. ### Update branding settings - [PUT /branding](https://signable-developer-portal.redocly.app/openapi/branding/updatebranding.md): Update your account's branding settings. This includes the logo and the primary colour used on emails and signing pages. ### List branding emails - [GET /branding/emails](https://signable-developer-portal.redocly.app/openapi/branding/getbrandingemails.md) ### Update a branding email - [PUT /branding/emails/{branding_email_type}](https://signable-developer-portal.redocly.app/openapi/branding/updatebrandingemail.md): You can include variables like and in your email body to personalise content. See the full list of supported variables → ## Settings Configure account-wide preferences and defaults. ### Get company settings - [GET /settings](https://signable-developer-portal.redocly.app/openapi/settings/listsettings.md): 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. ### Update company settings - [PUT /settings](https://signable-developer-portal.redocly.app/openapi/settings/updatesettings.md) ## Webhooks Receive real-time notifications about document events. ### List webhooks - [GET /webhooks](https://signable-developer-portal.redocly.app/openapi/webhooks/listwebhooks.md): Retrieves a paginated list of all webhooks currently registered to receive event notifications. Supports offset and limit for pagination. Webhooks include metadata about creation, update, and suspension state. ### Create a webhook - [POST /webhooks](https://signable-developer-portal.redocly.app/openapi/webhooks/createwebhook.md): Registers a new webhook that will be triggered when a specific event occurs. You must provide a valid and a supported . The created webhook will immediately be eligible to receive matching notifications. ### Get a webhook - [GET /webhooks/{webhook_id}](https://signable-developer-portal.redocly.app/openapi/webhooks/getwebhook.md): Retrieves details of a specific webhook by its unique . The response includes the current status and metadata of the webhook. ### Update a webhook - [PUT /webhooks/{webhook_id}](https://signable-developer-portal.redocly.app/openapi/webhooks/updatewebhook.md): Updates the webhook identified by . You may change the and/or the . ### Delete a webhook - [DELETE /webhooks/{webhook_id}](https://signable-developer-portal.redocly.app/openapi/webhooks/deletewebhook.md): Deletes the webhook identified by . Once removed, the webhook will no longer receive event notifications. ### Envelope sent - [POST send-envelope](https://signable-developer-portal.redocly.app/openapi/webhooks/receivesendenvelopewebhook.md): This webhook is triggered after an envelope has been successfully processed and sent. It delivers information about the envelope, the recipient, any additional metadata, and a download URL. ### Envelope signed - [POST signed-envelope](https://signable-developer-portal.redocly.app/openapi/webhooks/receivesignedenvelopewebhook.md): 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. ### Envelope cancelled - [POST cancelled-envelope](https://signable-developer-portal.redocly.app/openapi/webhooks/receivecancelledenvelopewebhook.md): 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. ### Envelope signed & complete - [POST signed-envelope-complete](https://signable-developer-portal.redocly.app/openapi/webhooks/receivesignedenvelopecompletewebhook.md): 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. ### Envelope rejected - [POST rejected-envelope](https://signable-developer-portal.redocly.app/openapi/webhooks/receiverejectedenvelopewebhook.md): This webhook is triggered when a recipient rejects an envelope. It includes details about the envelope, the rejecting contact, and relevant metadata. ### Envelope opened - [POST opened-envelope](https://signable-developer-portal.redocly.app/openapi/webhooks/receiveopenedenvelopewebhook.md): This webhook is triggered when a recipient opens an envelope. It includes basic information about the envelope, the recipient, and associated documents. ### Envelope email bounced - [POST bounced-envelope](https://signable-developer-portal.redocly.app/openapi/webhooks/receivebouncedenvelopewebhook.md): Triggered when an email to a signer fails to deliver. ### Widget completed (Awaiting verification) - [POST verify-envelope-widget](https://signable-developer-portal.redocly.app/openapi/webhooks/receiveverifyenvelopewidgetwebhook.md): This webhook is triggered when a recipient signs an envelope via the widget, but has not yet verified. It includes contact and document details. ### Widget signature verified - [POST verified-envelope-widget](https://signable-developer-portal.redocly.app/openapi/webhooks/receiveverifiedenvelopewidgetwebhook.md): This webhook is triggered when a recipient verifies their signed envelope through the verification email. It includes details about the contact, documents, and verification. ### Template added - [POST add-template](https://signable-developer-portal.redocly.app/openapi/webhooks/receiveaddtemplatewebhook.md): 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. ### Contact added - [POST add-contact](https://signable-developer-portal.redocly.app/openapi/webhooks/receiveaddcontactwebhook.md): This webhook is triggered when a new contact is added to the account. It includes basic information about the contact and the company that added them. ### User added - [POST add-user](https://signable-developer-portal.redocly.app/openapi/webhooks/receiveadduserwebhook.md): This webhook is triggered when a new user is added to the account. It includes identifying information about the user and their assigned role.