Skip to content
Last updated

This glossary defines key terms used throughout the Signable API documentation.


API key

A unique authentication credential used to access the Signable API. Generate API keys in Company SettingsAPI & Webhooks. Production keys access live data and send actual envelopes. Test keys access a sandbox environment for testing without affecting production data.

Branding

Customisation applied to signing pages and email notifications. Configure branding in Company SettingsBranding to add your company logo, set brand colours, and customise email text. Parties see your branding instead of Signable's default branding.

Cancelled

An envelope status indicating the envelope was terminated before completion. Parties cannot sign cancelled envelopes. Signable sends cancellation notifications to all parties who had not yet signed.

Complete

An envelope status indicating all required parties have signed or received copies. Download signed documents from the Signable dashboard or via the API.

Contact

A stored name and email address. Signable automatically creates contacts when you send envelopes. Access contacts in the Contacts section of the Signable dashboard.

Document

A PDF, Word, or Excel file uploaded for signing. Documents must be contained within an envelope before sending. Upload documents when creating envelopes in the dashboard or via the API.

Draft

An envelope status indicating the envelope has been created but not sent. Edit or delete draft envelopes in EnvelopesDrafts in the dashboard, or via the API.

Envelope

A container that holds documents, parties, and signing workflow settings. Create envelopes in the Signable dashboard or via the API. View envelopes in Envelopes in the dashboard.

Expired

An envelope status indicating the envelope exceeded its expiry date without completion. Configure expiry dates in Envelope settings. Signable automatically cancels expired envelopes.

Failed

An envelope status indicating document processing failed. Common causes include corrupt files, password-protected PDFs, or unsupported file formats. Review error details in the dashboard or API response.

Field

An interactive element on a document where parties provide input or signatures. Add fields when creating envelopes or templates. Field types include signature, text, date, checkbox, dropdown, and file upload.

Fingerprint

A unique 32-character identifier assigned to envelopes, templates, and documents. Fingerprints appear in dashboard URLs and API responses. Use fingerprints to reference resources in API calls.

ID

A numerical identifier assigned to companies, contacts, users, and parties. IDs appear in API responses and dashboard URLs.

Partner

An account type that manages multiple customer accounts. Partners create and administer sub-accounts. Configure partner settings in Company SettingsPartner.

Party

A recipient of an envelope. Parties can be signers (required to sign documents) or copy-only (receive completed documents). Each party receives an email notification with access to the envelope.

Party role

A defined role in a template, such as "Employee" or "Manager". Create party roles when building templates. Assign actual parties to these roles when sending envelopes.

Prefillable fields

Template fields that can be populated with data before sending. Configure prefillable fields when creating templates. When sending an envelope, populate these fields via the dashboard or API. Signers cannot modify prefilled data.

Processing

A temporary envelope status indicating Signable is processing uploaded documents. The status automatically transitions to draft upon completion, typically within seconds.

Rejected

An envelope status indicating a party declined to sign. When one party rejects an envelope, all other parties lose access. View rejection details in the envelope information in the dashboard.

Sent

An envelope status indicating the envelope has been sent to parties for signing. View sent envelopes in EnvelopesSent. Send reminders from the envelope details page or via the API.

Settings

Account-wide configuration options in Company SettingsSettings. Settings control expiry periods, reminder schedules, signing page options, and email preferences. These defaults apply to all envelopes unless overridden.

Signed

An envelope status indicating all required parties have signed. Download signed documents from the envelope details page or via the API. Signable stores signed documents indefinitely on paid plans.

Sub-account

A separate account created and managed by a partner. Each sub-account operates independently with its own users, envelopes, templates, and settings. Manage sub-accounts in Company SettingsPartnerSub-accounts or via the API.

Tag

A text placeholder inserted into documents before upload, such as {{signature_1}} or {{date_1}}. Signable automatically converts tags to fields during document processing. See the tag documentation for syntax details.

Template

A reusable document with predefined fields and party roles. Create templates in TemplatesCreate template in the dashboard. Reference templates when sending envelopes via the dashboard or API. Templates cannot be created via the API.

Verify

An envelope status indicating signature completion pending email verification. Applies only to widget envelopes with verification enabled. Parties receive a verification email and must confirm before the envelope transitions to signed. Enable verification in TemplatesWidget settings.

Webhook

An HTTP POST notification sent to a configured URL when events occur (such as envelope signed or rejected). Configure webhook URLs in Company SettingsAPI & Webhooks. Test webhooks using the testing tool in the dashboard.

Widget

A publicly accessible template shared via URL or embedded in a website. Create widgets from templates in TemplatesShare as widget. Anyone can access and sign widgets without authentication. Each signature creates a new envelope.