API Reference
  1. RESOURCES AND ENDPOINTS
  2. Document

Create Document

post
https://www.signwell.com/api/v1/documents

Creates and optionally sends a new document for signing. If draft is set to true the document will not be sent. Recipients are notified by email, SMS, or both based on each recipient's delivery_method. SMS delivery is available only to workspaces that are eligible for SMS and have it enabled, and requires a phone_number in E.164 format.

Body Params
boolean
Defaults to false

Set to true to enable Test Mode. Documents created with Test Mode do not count towards API billing and are not legally binding. Defaults to false

boolean
Defaults to false

Only applies when test_mode is true. When true, and the document has an SMS-only recipient, sends the document owner a test-mode preview email (with a masked phone number) instead of the regular SMS sender-copy email. No SMS is sent and no credits are used, in test mode or otherwise. Defaults to false.

files
array of objects
required

Document files can be uploaded by specifying a file URL or base64 string. Either file_url or file_base64 must be present (not both). Valid file types are: .pdf, .doc, .docx, .pages, .ppt, .pptx, .key, .xls, .xlsx, .numbers, .jpg, .jpeg, .png, .tiff, .tif, .webp, .html, and .htm

files*
string

The name of the document.

string

Email subject for the signature request that recipients will see. Defaults to the default system subject or a template subject (if the document is created from a template). Applies to email notifications only; SMS notifications always use fixed system templates.

string

Email message for the signature request that recipients will see. Defaults to the default system message or a template message (if the document is created from a template). Applies to email notifications only; SMS notifications always use fixed system templates.

recipients
array of objects
required

Document recipients are people that must complete and/or sign a document.

recipients*
boolean
Defaults to false

Whether the document can still be updated before sending a signature request. If set to false the document is sent for signing as part of this request. Defaults to false.

boolean
Defaults to false

When set to true the document will enter self-sign mode, which allows the document creator to sign and complete a document without any field setup. Must use the embedded_edit_url in the response and (if embedding) the embedded requesting workflow.

boolean
Defaults to false

When set to true the document will have a signature page added to the end, and all signers will be required to add their signature on that page.

integer
≥ 1

Number of days before the signature request expires. Defaults to the account expiration setting or template expiration (if the document is created from a template).

boolean
Defaults to true

Whether to send signing reminders to recipients. Reminders are sent on day 3, day 6, and day 10 if set to true. Defaults to true.

boolean
Defaults to false

When set to true recipients will sign one at a time in the order of the recipients collection of this request.

uuid

Unique identifier for API Application settings to use. API Applications are optional and mainly used when isolating OAuth apps or for more control over embedded API settings

boolean
Defaults to false

When set to true it enables embedded signing in your website/web application. Embedded functionality works with an iFrame and email authentication is disabled. :embedded_signinig defaults to false.

boolean
Defaults to false

On embedding signing, document owners (and CC'd contacts) do not get a notification email when documents have been completed. Setting this param to true will send out those final completed notifications. Default is false

boolean
Defaults to false

An alternative way (if you can’t use the recommended way) of placing fields in specific locations of your document by using special text tags. Useful when changing the content of your files changes the location of fields. See API documentation for “Text Tags” for details. Defaults to false.

string

Sets the custom requester name for the document. When set, this is the name used for all email communications, signing notifications, and in the audit file.

string

Sets the custom requester email for the document. When set, this is the email used for all email communications, signing notifications, and in the audit file.

url

A URL that recipients are redirected to after successfully signing a document.

boolean
Defaults to true

Whether to allow recipients the option to decline signing a document. If multiple signers are involved in a document, any single recipient can cancel the entire document signing process by declining to sign.

boolean
Defaults to true

In some cases a signer is not the right person to sign and may need to reassign their signing responsibilities to another person. This feature allows them to reassign the document to someone else.

url

A URL that recipients are redirected to if the document is declined.

string

Sets the language for all recipients on the document and updates all recipient side interactions including the document email and the document itself. Accepted languages: English, Français, Español, Deutsch, Polski, Português, Dansk, Nederlands, Italiano, Русский, Svenska, العربية, Ελληνικά, Türkçe, Slovenčina. Defaults to English. Language should be sent in ISO 639-1 format: en, fr, es, de, pl, pt, da, nl, it, ru, sv, ar, el, tr, sk.

conditional_rules
array of objects

Conditional logic rules that show, hide, or require fields based on what a signer does to other fields. Every identifier is a field api_id. At most 10 rules per document or template.

conditional_rules
metadata
object

Optional key-value data that can be associated with the document. If set, will be available every time the document data is returned.

fields
array of arrays of objects

Document fields placed on a document for collecting data or signatures from recipients. At least one field must be present in the Create Document request if draft is false (unless adding a signature page by using with_signature_page). Field data should be sent as a 2-dimensional JSON array. One array of fields is needed for each file in the files array. An array of fields can be empty if you have a file that does not contain any fields.

fields
attachment_requests
array of objects

Attachments that a recipient must upload to complete the signing process. Attachment requests are shown after all document fields have been completed.

attachment_requests
copied_contacts
array of objects

Copied contacts are emailed the final document once it has been completed by all recipients.

copied_contacts
labels
array of objects

Labels can be used to organize documents in a way that can make it easy to find using the document search in SignWell. A document can have multiple labels.

labels
checkbox_groups
array of objects

Checkbox fields that are placed on a document can be grouped with selection requirements. At least 2 checkbox fields in an array of fields must be assigned to the same recipient.

checkbox_groups
Responses

Updated 4 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago