SignWell
API integration

create_a_sign_well_document

Create a SignWell document and optionally send it for signing; recipients are notified by email, SMS, or both based on delivery_method. Provide the files as the files array (one or more files, each with file_url or file_base64, which accepts base64 content or an uploaded file id) or, for a single file, as top-level file_name + file_base64. Set draft to true to create without sending (send later with documents send; the document needs fields or text tags to be sent); set expires_in to 365 or less and provide phone_number in E.164 format for SMS recipients. Returns: cfr_part11, test_mode, id, name, subject, and 37 more. Required: recipients, plus a file via files or file_name + file_base64.

get_single_sign_well_document_by_id

Get a SignWell document with all associated data by id; supply the unique document ID from a creation request or Document page URL. Returns: cfr_part11, cfr_part11_signing_mode, test_mode, id, name, subject, message, metadata, created_at, updated_at, recipients, status, files, fields, allow_decline, allow_reassign, and 26 more. Required: id.

delete_a_sign_well_document_by_id

Delete a SignWell document by id; deleting also cancels document signing if it is in progress. Returns an empty 204 response on success. Required: id.

sign_well_documents_send

Update a draft SignWell document and send it to its recipients for signing. Returns: cfr_part11, test_mode, id, subject, message, updated_at, recipients, status, files, fields, allow_decline, allow_reassign, and 30 more. subject and message apply to email notifications only; SMS notifications use fixed system templates. Required: document_id.

create_a_sign_well_document_templates_document

Create a SignWell document from one or more templates and optionally send it for signature; pre-signed template signatures and initials copy over as visible content without generating signing events. Returns: cfr_part11, cfr_part11_signing_mode, test_mode, id, template_ids, name, recipients, status, files, fields, and 32 more. Required: recipients.

sign_well_document_recipients_bulk_update

Update one or more recipients on a sent SignWell document; only recipients who have not started signing can be changed, and only while the document is in sent, viewed, pending, or bounced status. Returns the updated document with id, status, and its recipients (id, name, email, signing_url). Required: document_id, recipients.

sign_well_document_authentications_bulk_update

Update passcode delivery settings for recipients on a sent SignWell document; only recipients who have not started signing can be updated. Returns the updated document object including id, status, recipients, and updated_at. Required: document_id, recipients.

create_a_sign_well_document_remind

Send a reminder to SignWell document recipients who have not signed yet, delivered via each recipient's method (email, SMS, or both). Returns the updated document object including id, status, recipients with signing_url, and subject. Required: document_id.

get_single_sign_well_document_completed_pdf_by_id

Download the completed PDF or ZIP file for a signed Signwell document. Returns file_url in a JSON object when url_only=true, otherwise streams the raw PDF or ZIP binary. zip is unavailable on 21 CFR Part 11 documents. Required: id.

create_a_sign_well_document_template

Create a new reusable SignWell document template. Provide the files as the files array (one or more files, each with exactly one of file_url or file_base64, which accepts base64 content or an uploaded file id) or, for a single file, as top-level file_name + file_base64; at least one placeholder should be left unassigned. Returns the created template including id, name, status, created_at, fields, placeholders, and files. Required: placeholders, plus a file via files or file_name + file_base64.

get_single_sign_well_document_template_by_id

Get a SignWell document template by id, including all associated template data. Returns: id, api_application_id, requester_email_address, custom_requester_name, custom_requester_email, name, subject, message, metadata, created_at, updated_at, placeholders, copied_placeholders, status, reminders, archived, files, fields, and 13 more. Required: id.

update_a_sign_well_document_template_by_id

Update an existing SignWell document template by id. Returns the updated template including id, name, status, fields, placeholders, and updated_at. Required: id.

delete_a_sign_well_document_template_by_id

Delete a SignWell document template by id. Returns an empty 204 response on success. Required: id.

get_single_sign_well_api_application_by_id

Get a specific SignWell API Application by id. Returns: id, name, callback_urls, created_at, updated_at, owner, preferences. Required: id.

delete_a_sign_well_api_application_by_id

Delete a SignWell API Application by id. Returns an empty 204 response on success. Required: id.

list_all_sign_well_hooks

List all webhooks registered in your SignWell account. Returns: id, callback_url, api_application_id.

create_a_sign_well_hook

Register a SignWell webhook to receive document lifecycle events at a callback URL. Returns the created webhook with id, callback_url, and api_application_id. Required: callback_url. A document_signed event is not emitted when a pre-signed template signature/initials was merely copied as document content.

delete_a_sign_well_hook_by_id

Delete a registered SignWell webhook by id so document events stop being posted to its callback URL. Returns an empty 204 response on success. Required: id.

list_all_sign_well_me

Retrieve the SignWell account information associated with the authenticated API key, including the credential record, user, account, workspace, and contact. Returns: id, role, archived, user, account, workspace, contact. Takes no parameters.

get_single_sign_well_bulk_send_by_id

Get a SignWell bulk send by id. Returns: id, name, api_application_id, documents_count, documents_completed, documents_not_completed, created_at, user_id, status, templates. Required: id.

list_all_sign_well_bulk_sends

List SignWell bulk sends. Returns: id, name, api_application_id, documents_count, documents_completed, documents_not_completed, created_at, user_id, status, template_ids. Optional filters: user_email, api_application_id.

create_a_sign_well_bulk_send

Create a SignWell bulk send that sends a template to multiple recipients from CSV data; the CSV is validated before the send is enqueued (invalid rows return a 422). Returns: id, template_ids, api_application_id, documents_count, created_at, user_id, status. Required: template_ids, bulk_send_csv.

list_all_sign_well_bulk_sends_csv_templates

Get the SignWell Bulk Send CSV template for one or more document templates: a blank CSV whose columns hold the required and optional recipient data for a bulk send, named [placeholder]_[field label] (e.g. signer_company_name). Returns the base64-encoded CSV in data. Required: template_ids[].

create_a_sign_well_bulk_sends_validate_csv

Validate a SignWell bulk send CSV, checking its structure and row data before creating the bulk send. Returns the validated CSV configuration with defaults applied: bulk_send_csv, template_ids, skip_row_errors, name, subject, message. Invalid CSVs return 422 row-level errors. Required: template_ids, bulk_send_csv.

list_all_sign_well_bulk_send_documents

List the SignWell documents generated for a bulk send. Returns each document's id, name, status, recipients, files, and created_at. Required: bulk_send_id.

get_single_sign_well_document_nom_151_certificate_by_id

Download the NOM-151 certificate for a completed SignWell document by id. By default returns the certificate ZIP file; with url_only=true returns JSON with file_url; with object_only=true returns the raw constancia certificate object as JSON. Required: id. Only succeeds when a NOM-151 certificate is available for the document.