SignWell Document API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as X-Api-Key (api_key).
Paths & Operations 9
Across 7 paths, the API surfaces 9 operations — 1 DELETE, 3 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.
Document 9
Create, send, and manage documents for electronic signing.
GET
/api/v1/documents
List Documents
listDocuments2 params→ 200401429
POST
/api/v1/documents
Create Document
createDocumentbody→ 201400422429
GET
/api/v1/documents/{id}
Get Document
getDocument1 param→ 200404429
DELETE
/api/v1/documents/{id}
Delete Document
deleteDocument1 param→ 204404429
POST
/api/v1/document_templates/documents
Create Document from Template
createDocumentFromTemplatebody→ 201400422429
POST
/api/v1/documents/{id}/send
Update and Send Document
sendDocument1 parambody→ 201422429
PATCH
/api/v1/documents/{id}/recipients
Update Recipients
updateRecipients1 parambody→ 200409400422404429
POST
/api/v1/documents/{id}/remind
Send Reminder
sendReminder1 parambody→ 201422404429
GET
/api/v1/documents/{id}/completed_pdf
Completed PDF
getCompletedPdf4 params→ 200404429
Schemas 47
The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are DocumentResponse (37 properties), DocumentFromTemplateResponse (37 properties), DocumentFromTemplateRequest (32 properties), DocumentRequest (29 properties). Each schema is shown below with its type and property counts.
Page
integer
The page number for pagination. Defaults to the first page.
Files
array
Document files can be uploaded by specifying a file URL or base64 string. Either fileurl or filebase64 must be present (not both). Valid file types are: .pdf,…
FileInfo
object
File information
2 properties2 required
DocumentFromTemplateRequest
object
32 properties1 required
DropdownOption
A dropdown option - either a simple string or a detailed object with name and optional apiid
LabelsUpdate
array
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. Upd…
Labels
array
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.
SendReminderRequest
object
1 property
CheckboxGroupInfo
object
Checkbox group configuration
9 properties3 required
TemplateFieldValues
array
Fields of your template(s) that you can prepopulate with values. Signature and Initials fields cannot be signed through the API.
FieldType
string
Type of signing field
AttachmentRequests
array
Attachments that a recipient must upload to complete the signing process. Attachment requests are shown after all document fields have been completed.
DocumentResponse
object
37 properties2 required
IncludeAuditPage
boolean
Whether to include the audit page as part of the document. Defaults to true
CheckboxValidation
string
Validation rule for checkbox groups
DocumentId
string
Unique identifier for a document.
AttachmentRequestInfo
object
Attachment request information
3 properties2 required
TemplateRecipients
array
Document recipients are people that must complete and/or sign a document. Recipients of the document must be assigned to a placeholder of the template. Recipie…
DocumentListResponse
object
List of documents with pagination
6 properties4 required
FileFormat
string
Format of the file to be downloaded. Supported formats are 'pdf' and 'zip'.
Fields
array
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 dr…
ValidationErrorResponse
object
Validation error response. The errors object contains field-specific error details with dynamic keys.
1 property1 required
RateLimitErrorResponse
object
Rate limit exceeded error response (HTTP 429)
1 property1 required
update_recipients_request
object
1 property1 required
TextValidation
string
Validation rule for text fields
Limit
integer
The number of documents to fetch. Defaults to 10, max is 50.
CompletedDocumentId
string
Unique identifier for a completed document.
ReminderRecipients
array
Optional list if recipients within the document to send a reminder email to. If none are specified, all recipients that have not signed yet will receive a remi…
LabelRequest
object
Labels can be used to organize documents and templates in a way that can make it easy to find using the document search/template search in SignWell. Labels can…
1 property1 required
DateFormat
string
Date format for date fields. Valid values: MM/DD/YYYY, DD/MM/YYYY, YYYY/MM/DD, Month DD, YYYY, MM/DD/YYYY hh:mm:ss a. Default: MM/DD/YYYY
CheckboxGroups
array
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…
AdditionalFiles
array
AdditionalFields
array
Fields to be added to any appended files (not existing files). Document fields placed on a document for collecting data or signatures from recipients. Field da…
CopiedContactInfo
object
Copied contact information
3 properties1 required
UrlOnly
boolean
Whether to return the URL of the completed PDF or the actual PDF content. Defaults to false.
CompletedPdfUrlResponse
object
JSON response containing the URL to the completed PDF file (returned when urlonly=true)
1 property1 required
UpdateDocumentAndSendRequest
object
19 properties
LabelInfo
object
Label information
2 properties
CompletedPdfResponse
update_recipients_map
array
List of recipients to update on the document.
CopiedContacts
array
Copied contacts are emailed the final document once it has been completed by all recipients.
DocumentFromTemplateResponse
object
37 properties2 required
ErrorResponse
object
Standard error response
2 properties
CompletedPdfBinaryResponse
string
Raw PDF binary data (default response when urlonly=false)
CompletedPdfZipResponse
string
ZIP file containing the completed PDF (returned when fileformat=zip)
Recipients
array
Document recipients are people that must complete and/or sign a document.
DocumentRequest
object
29 properties2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of SignWell Document API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
