{"openapi":"3.0.1","info":{"title":"SignWell Developer API","description":"API for creating, managing, and tracking electronic signature workflows.","version":"v1","termsOfService":"https://www.signwell.com/terms/","contact":{"email":"support@signwell.com"}},"tags":[{"name":"Document","description":"Create, send, and manage documents for electronic signing."},{"name":"Template","description":"Create and manage reusable document templates."},{"name":"Bulk Send","description":"Send a document to multiple recipients in batch using templates."},{"name":"Webhooks","description":"Subscribe to document lifecycle events via webhook callbacks."},{"name":"API Application","description":"Manage API application settings and branding."},{"name":"Me","description":"Retrieve account information for the authenticated API key."},{"name":"Account","description":"Retrieve and update account settings and branding."},{"name":"Regional","description":"Access region-specific endpoints for data residency compliance."}],"paths":{"/api/v1/documents":{"post":{"summary":"Create Document","description":"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.","tags":["Document"],"security":[{"api_key":[]}],"operationId":"createDocument","parameters":[{"name":"X-TestMode-Enabled","in":"header","required":false,"schema":{"$ref":"#/components/schemas/TestModeHeader"}}],"responses":{"201":{"description":"created","content":{"application/json":{"example":{"id":"1b9a02e9-2b2d-42f1-81e6-a28e7c239f43","archived":false,"created_at":"2026-09-29T15:21:41Z","decline_message":null,"embedded_edit_url":"https://www.signwell.com/edit/document/fa84f9ee-bf49-4328-b931-6cd7d787bad5/","error_message":null,"embedded_preview_url":null,"language":"en","name":"Agreement","requester_email_address":"requester@domain.com","status":"Created","test_mode":false,"updated_at":"2026-09-29T15:21:41Z","cfr_part11":false,"cfr_part11_signing_mode":null,"allow_decline":true,"allow_reassign":true,"api_application_id":null,"custom_requester_email":"requester@domain.com","custom_requester_name":"Requester","decline_redirect_url":"https://www.domain.com/decline_path/","embedded_signing":false,"expires_in":365,"metadata":{"key1":"value1","key2":"value2"},"redirect_url":"https://www.domain.com/redirect_path/","reminders":true,"embedded":null,"apply_signing_order":false,"message":"Normal Body","subject":"Normal subject","labels":[{"id":"4ff0abe6-4ea3-423c-810a-a2b490a07323","name":"My First Label"},{"id":"0e557e71-a85b-40af-acd6-85e90c57c2c4","name":"My Second Label"},{"id":"e397b2e7-313c-44cb-87b3-7ffd86298c8c","name":"My Third Label"}],"fields":[[{"api_id":"DateField_1","height":"19.0","page":1,"required":true,"type":"date","value":"06/05/2021","width":"86.0","x":230,"y":60,"date_format":"DD/MM/YYYY","formula":"","lock_sign_date":true,"recipient_id":"recipient_id_1"},{"api_id":"DateSigned_1","height":"19.0","page":1,"required":true,"type":"autofill_date_signed","value":null,"width":"86.0","x":260,"y":80,"recipient_id":"recipient_id_1"},{"api_id":"Email_1","height":"19.0","page":1,"required":false,"type":"autofill_email","value":null,"width":"86.0","x":260,"y":90,"recipient_id":"recipient_id_1"},{"api_id":"Company_1","height":"19.0","page":1,"required":true,"type":"autofill_company","value":"Great Company","width":"86.0","x":260,"y":80,"recipient_id":"recipient_id_1"},{"api_id":"Name_1","height":"19.0","page":1,"required":true,"type":"autofill_name","value":"Recipient One","width":"86.0","x":260,"y":80,"recipient_id":"recipient_id_1"},{"api_id":"FirstName_1","height":"19.0","page":1,"required":true,"type":"autofill_name","value":"Recipient","width":"86.0","x":260,"y":80,"recipient_id":"recipient_id_1"},{"api_id":"LastName_1","height":"19.0","page":1,"required":true,"type":"autofill_name","value":"One","width":"86.0","x":260,"y":80,"recipient_id":"recipient_id_1"},{"api_id":"Phone_1","height":"19.0","page":1,"required":true,"type":"autofill_phone","value":"123456789","width":"86.0","x":260,"y":100,"recipient_id":"recipient_id_1"},{"api_id":"Title_1","height":"19.0","page":1,"required":true,"type":"autofill_title","value":"Important Title","width":"86.0","x":260,"y":100,"recipient_id":"recipient_id_1"}],[{"api_id":"DateField_2","height":"2.0","page":1,"required":true,"type":"date","value":"05/06/2021","width":"1.0","x":260,"y":80,"date_format":"MM/DD/YYYY","formula":"","lock_sign_date":false,"recipient_id":"recipient_id_2"},{"api_id":"Signature_1","height":"32.0","page":2,"required":true,"type":"signature","value":null,"width":"112.0","x":260,"y":80,"recipient_id":"recipient_id_2"},{"api_id":"Signature_2","height":"2.0","page":1,"required":true,"type":"signature","value":null,"width":"1.0","x":260,"y":80,"recipient_id":"recipient_id_2"},{"api_id":"CheckBox_1","height":"13.0","page":1,"required":true,"type":"checkbox","value":"t","width":"13.0","x":260,"y":80,"name":null,"recipient_id":"recipient_id_2"},{"api_id":"CheckBox_2","height":"2.0","page":1,"required":true,"type":"checkbox","value":"t","width":"1.0","x":260,"y":80,"name":"Checkbox name","recipient_id":"recipient_id_2"},{"api_id":"Initials_1","height":"32.0","page":2,"required":true,"type":"initials","value":null,"width":"44.0","x":260,"y":80,"recipient_id":"recipient_id_2"},{"api_id":"Initials_2","height":"2.0","page":1,"required":true,"type":"initials","value":null,"width":"1.0","x":260,"y":80,"recipient_id":"recipient_id_2"},{"api_id":"TextField_1","height":"19.0","page":1,"required":true,"type":"text","value":"123456","width":"86.0","x":260,"y":80,"fixed_width":true,"label":"label","validation":"numbers","recipient_id":"recipient_id_2"},{"api_id":"TextField_2","height":"2.0","page":1,"required":true,"type":"text","value":"123456","width":"1.0","x":260,"y":80,"fixed_width":true,"label":"label","validation":"numbers","recipient_id":"recipient_id_2"},{"api_id":"TextField_3","height":"20.0","page":1,"required":true,"type":"text","value":"123456","width":"100.0","x":260,"y":80,"fixed_width":true,"label":"label","validation":"numbers","recipient_id":"recipient_id_2"},{"api_id":"TextField_4","height":"20.0","page":1,"required":true,"type":"text","value":"123456","width":"100.0","x":260,"y":80,"fixed_width":true,"label":"label","validation":"numbers","recipient_id":"recipient_id_2"},{"api_id":"Company_2","height":"19.0","page":1,"required":true,"type":"autofill_company","value":"Great Company","width":"86.0","x":260,"y":80,"recipient_id":"recipient_id_1"},{"api_id":"Email_2","height":"19.0","page":1,"required":true,"type":"autofill_email","value":"recipient1@domain.com","width":"86.0","x":260,"y":90,"recipient_id":"recipient_id_1"},{"api_id":"Name_2","height":"19.0","page":1,"required":true,"type":"autofill_name","value":"Recipient One","width":"86.0","x":260,"y":80,"recipient_id":"recipient_id_1"},{"api_id":"FirstName_2","height":"19.0","page":1,"required":true,"type":"autofill_name","value":"Recipient","width":"86.0","x":260,"y":80,"recipient_id":"recipient_id_1"},{"api_id":"LastName_2","height":"19.0","page":1,"required":true,"type":"autofill_name","value":"One","width":"86.0","x":260,"y":80,"recipient_id":"recipient_id_1"},{"api_id":"Phone_2","height":"19.0","page":1,"required":true,"type":"autofill_phone","value":"123456789","width":"86.0","x":260,"y":100,"recipient_id":"recipient_id_1"},{"api_id":"Title_2","height":"19.0","page":1,"required":true,"type":"autofill_title","value":"Important Title","width":"86.0","x":260,"y":100,"recipient_id":"recipient_id_1"}]],"files":[{"name":"filename1.pdf","pages_number":0},{"name":"filename2.pdf","pages_number":0}],"copied_contacts":[{"name":"CC one","email":"cc1@domain.com"}],"recipients":[{"delivery_method":"email","email":"recipient1@domain.com","id":"recipient_id_1","message":"This is a message","name":"Recipient One","passcode":"123","send_email":false,"send_email_delay":0,"status":"created","subject":"Hi, please sign this contract","signing_order":1,"signing_url":"https://www.signwell.com/docs/de41ea24a4/","bounced":null,"bounced_details":null,"passcode_delivery":{"enabled":false,"methods":null,"expire_after_access":false},"attachment_requests":[{"name":"normal name","required":true,"url":"https://www.signwell.com/document_attachments/a2OlP9G2dKh4bj4kY1rRFzJB4Gn/?access=dd6fcd69-6388-4230-8df1-42f2a87626e0"}]},{"delivery_method":"email","email":"recipient2@domain.com","id":"recipient_id_2","message":null,"name":"Recipient 2","passcode":null,"send_email":false,"send_email_delay":0,"status":"created","subject":null,"signing_order":2,"signing_url":"https://www.signwell.com/docs/f4938b8e4d/","bounced":null,"bounced_details":null,"passcode_delivery":{"enabled":false,"methods":null,"expire_after_access":false},"attachment_requests":[{"name":"Driver License","required":false,"url":"https://www.signwell.com/document_attachments/M50jMGzwDYUGBrEqXJG7ibKG3LB/?access=dd6fcd69-6388-4230-8df1-42f2a87626e0"}]}],"checkbox_groups":[{"id":"d0a4ae89-5a9e-4f94-9bbb-1bd770a83ff4","group_name":"Group 1","recipient_id":null,"checkbox_ids":["CheckBox_1","CheckBox_2"],"validation":"minimum","required":true,"min_value":1}],"conditional_rules":[{"id":"1c9fd537-0a08-458c-bfcb-1d2011be791a","target_id":"Name_1","action_type":"require","action_field_ids":["Email_1"],"conditions":[{"condition_type":"any_of","status":"completed","join_operator":"and_operator","field_api_ids":["Name_1"],"position":1}]}],"conditional_logic_decisions":[]},"schema":{"$ref":"#/components/schemas/DocumentResponse"}}}},"400":{"description":"bad request","content":{"application/json":{"example":{"errors":{"message":"The request contains invalid key values.","invalid_keys":["name"]}},"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"example":{"errors":{"custom_requester_email":["is invalid"],"custom_requester_name":["is too long (maximum is 100 characters)"],"decline_redirect_url":["is not a valid URL"],"redirect_url":["is not a valid URL"],"expires_in":["must be less than or equal to 365"],"metadata":["The key/value pairs must not exceed 50","Check the following keys: [qgtxtpsnyxjwzvbzhnmrjziscxsmgcugpqanuygve], length needs to be less than 40 characters","Check the value of the following keys: [ke50], length needs to be less than 500 characters and must be a string"],"api_application_id":["The provided API application id is invalid"],"subject":["is too long (maximum is 255 characters)"],"message":["is too long (maximum is 4000 characters)"],"recipients":{"duplicated_ids":"These ids are duplicated: recipient_id_1.","duplicated_emails":"These emails are duplicated: recipient1domain.com.","recipient_1":{"name":["is too long (maximum is 255 characters)"],"email":["format is invalid."]},"recipient_2":{"email":["format is invalid."]}},"copied_contacts":{"copied_contact_1":{"name":["is too long (maximum is 255 characters)"],"email":["format is invalid."]},"copied_contact_2":{"email":["format is invalid.","is already a recipient"]}},"attachment_requests":{"invalid_ids":"These recipient ids are not present in the recipients array: [recipient_id_3]"},"fields":{"duplicated_api_ids":"These api ids are duplicated: CheckBox_2.","invalid_ids":"These recipient ids are not present in the recipients array: [recipient_id_2, recipient_id_3]","file_1":{"field_1":{"date_format":["Not allowed for text."],"lock_sign_date":["Not allowed for text."]}},"file_2":{"field_1":{"date_format":["Not allowed for checkbox."],"fixed_width":["Not allowed for checkbox."],"validation":["Not allowed for checkbox."],"label":["Not allowed for checkbox."],"lock_sign_date":["Not allowed for checkbox."]},"field_2":{"invalid_date_value":"DateField value must be in Iso8601 format.","fixed_width":["Not allowed for date."],"validation":["Not allowed for date."],"label":["Not allowed for date."],"date_format":["Allowed formats for date fields are: MM/DD/YYYY | DD/MM/YYYY | YYYY/MM/DD | Month DD, YYYY | MM/DD/YYYY hh:mm:ss a"]},"field_3":{"date_format":["Not allowed for initials."],"fixed_width":["Not allowed for initials."],"validation":["Not allowed for initials."],"label":["Not allowed for initials."],"lock_sign_date":["Not allowed for initials."]},"field_4":{"date_format":["Not allowed for signature."],"fixed_width":["Not allowed for signature."],"validation":["Not allowed for signature."],"label":["Not allowed for signature."],"lock_sign_date":["Not allowed for signature."]}}},"checkbox_groups":{"min_value_negative":"The min value must be greater than or equal to 0 in the checkbox group Group 1"},"files":{"file_1":{"file_data":["At least one of file_url or file_base64 should be present"]},"file_2":{"file_data":["Only one of file_url or file_base64 should be present, not both"]},"file_3":{"file_url":["is not a valid URL"]},"file_4":{"file_base64":["the file type is unsupported, we support the following formats: application/msword, application/pdf, application/octet-stream, application/x-ole-storage, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/vnd.ms-powerpoint, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/x-iwork-keynote-sffkey, application/x-iwork-numbers-sffnumbers, application/x-iwork-pages-sffpages, image/jpeg, image/png, image/tiff, image/webp, text/html"]},"file_5":{"name":["The file extension is invalid."]},"file_6":{"name":["can't be blank"]}}}},"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentRequest"}}},"required":true},"x-readme":{"code-samples":[{"language":"ruby","name":"Ruby SDK","install":"gem install signwell_sdk","code":"require 'signwell_sdk'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\napi = SignWell::Resources::DocumentApi.new\n\nrequest = SignWell::Models::DocumentRequest.new(\n  test_mode: true,\n  name: 'NDA',\n  files: [\n    SignWell::Models::FilesInner.new(file_url: 'https://example.com/nda.pdf', name: 'nda.pdf')\n  ],\n  recipients: [\n    SignWell::Models::RecipientsInner.new(id: '1', name: 'Jane Doe', email: 'jane@example.com')\n  ],\n  fields: [\n    [\n      SignWell::Models::FieldsInnerInner.new(\n        x: 20, y: 60, page: 1,\n        recipient_id: '1',\n        type: 'signature',\n        required: true\n      )\n    ]\n  ]\n)\n\ndocument = api.create_document(request)\nputs document.id"},{"language":"ruby","name":"Embedded Signing","install":"gem install signwell_sdk","code":"require 'signwell_sdk'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\ndocument = SignWell::Embedded.create_signing_document(\n  name: 'NDA',\n  files: [{ name: 'nda.pdf', file_url: 'https://example.com/nda.pdf' }],\n  recipients: [{ name: 'Jane Doe', email: 'jane@example.com' }],\n  fields: [[{ x: 20, y: 60, page: 1, type: 'signature' }]],\n  test_mode: true\n)\n\n# Signing URL for the first recipient — open it in an iframe with embedded.js\nsigning_url = SignWell::Embedded.embedded_signing_url(document)\nputs signing_url\n\n# Or get all signing URLs as { email => url }\nputs SignWell::Embedded.embedded_signing_urls(document)"},{"language":"ruby","name":"Embedded Requesting","install":"gem install signwell_sdk","code":"require 'signwell_sdk'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\ndocument = SignWell::Embedded.create_requesting_document(\n  name: 'Contract',\n  files: [{ name: 'contract.pdf', file_url: 'https://example.com/contract.pdf' }],\n  recipients: [{ name: 'Jane Doe', email: 'jane@example.com' }],\n  test_mode: true\n)\n\n# The edit URL opens the field placement editor in an iframe with embedded.js\nputs document.embedded_edit_url"},{"language":"ruby","name":"SMS Delivery","install":"gem install signwell_sdk","code":"require 'signwell_sdk'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\napi = SignWell::Resources::DocumentApi.new\n\n# SMS delivery is available only to workspaces that are eligible for SMS and have it enabled.\n# Use 'email_and_sms' to notify by both channels, or 'sms' for SMS only. A phone_number\n# in E.164 format is required whenever the delivery method includes SMS.\nrequest = SignWell::Models::DocumentRequest.new(\n  test_mode: true,\n  name: 'NDA',\n  files: [\n    SignWell::Models::FilesInner.new(file_url: 'https://example.com/nda.pdf', name: 'nda.pdf')\n  ],\n  recipients: [\n    SignWell::Models::RecipientsInner.new(\n      id: '1',\n      name: 'Jane Doe',\n      email: 'jane@example.com',\n      delivery_method: 'email_and_sms',\n      phone_number: '+14155551234'\n    )\n  ],\n  fields: [\n    [\n      SignWell::Models::FieldsInnerInner.new(\n        x: 20, y: 60, page: 1,\n        recipient_id: '1',\n        type: 'signature',\n        required: true\n      )\n    ]\n  ]\n)\n\ndocument = api.create_document(request)\nputs document.id"}]}}},"/api/v1/documents/{id}":{"get":{"summary":"Get Document","description":"Returns a document and all associated document data. Supply the unique document ID from either a document creation request or Document page URL. Each recipient includes its `delivery_method`, and recipients whose delivery includes SMS also include an `sms` object with the masked phone number and SMS delivery status.","tags":["Document"],"security":[{"api_key":[]}],"operationId":"getDocument","parameters":[{"name":"id","in":"path","schema":{"$ref":"#/components/schemas/DocumentId"},"required":true}],"responses":{"200":{"description":"successful","content":{"application/json":{"example":{"id":"1234c241-ea39-40a8-94a9-6bc69e83e9d6","archived":false,"created_at":"2026-09-29T15:21:39Z","decline_message":null,"embedded_edit_url":"https://www.signwell.com/edit/document/64e31e56-6947-408b-be0b-e00a493418b1/","error_message":null,"embedded_preview_url":null,"language":"en","name":"fruit_general/eius.odt","requester_email_address":"jessica_2@little.example","status":"Created","test_mode":false,"updated_at":"2026-09-29T15:21:39Z","cfr_part11":false,"cfr_part11_signing_mode":null,"allow_decline":false,"allow_reassign":true,"api_application_id":null,"custom_requester_email":"gidget_schamberger@vonrueden.example","custom_requester_name":"Kanan Jarrus","decline_redirect_url":"http://ledner-kiehn.example/theo_rosenbaum","embedded_signing":false,"expires_in":10,"metadata":{"neque":"error","numquam":"veritatis"},"redirect_url":"http://effertz.example/junita","reminders":false,"embedded":null,"apply_signing_order":false,"message":"<p>Hey there,</p><p>&nbsp;</p><p>Please review and complete this document. You can click on the document below to get started.</p>","subject":"Please complete fruit_general/eius.odt","labels":[{"id":"ff7924f7-2aa0-4be2-86d0-bd3dac46aebc","name":"Fr. Adriene Bergstrom"},{"id":"5775b8d7-9732-40d8-bc23-015e64f4c545","name":"Fr. Denyse Harvey"}],"fields":[[{"api_id":"CheckBox_2","height":"13.0","page":1,"required":true,"type":"checkbox","value":null,"width":"13.0","x":1.1,"y":1.1,"name":null,"recipient_id":null,"signing_elements_group_id":"de4ae90e-689f-471d-a94a-9f01f9d21016"},{"api_id":"CheckBox_3","height":"13.0","page":1,"required":true,"type":"checkbox","value":null,"width":"13.0","x":1.1,"y":1.1,"name":null,"recipient_id":null},{"api_id":"Signature_1","height":"32.0","page":1,"required":true,"type":"signature","value":null,"width":"112.0","x":1.1,"y":1.1,"recipient_id":"6fb069d2-b8bb-4d29-bb43-1bf31dbcd17c"}]],"files":[{"name":"placeat.pages","pages_number":1}],"copied_contacts":[{"name":"Micah Medhurst","email":"armandina@kshlerin.test"}],"recipients":[{"delivery_method":"email","email":"ailene@schmidt.example","id":"6fb069d2-b8bb-4d29-bb43-1bf31dbcd17c","message":null,"name":"Nelida Welch","passcode":null,"send_email":null,"send_email_delay":null,"status":"created","subject":null,"signing_order":1,"signing_url":"https://www.signwell.com/docs/bcf19efc05/","bounced":null,"bounced_details":null,"passcode_delivery":{"enabled":false,"methods":null,"expire_after_access":false},"attachment_requests":[{"name":"marine-strict/id.xls","required":true,"url":"https://www.signwell.com/document_attachments/ennolMAbpATzYbbapLkDcZ2Y0Ke/?access=9e538077-bd17-4409-858a-df39840ef31e"}]},{"delivery_method":"email","email":"joyce_waters@hickle.test","id":"cd08b8e0-c3f6-477e-9dbf-a462b6588422","message":null,"name":"Berry Littel","passcode":null,"send_email":null,"send_email_delay":null,"status":"created","subject":null,"signing_order":2,"signing_url":"https://www.signwell.com/docs/d4dd90dc68/","bounced":null,"bounced_details":null,"passcode_delivery":{"enabled":false,"methods":null,"expire_after_access":false},"attachment_requests":[]}],"checkbox_groups":[{"id":"de4ae90e-689f-471d-a94a-9f01f9d21016","group_name":null,"recipient_id":null,"checkbox_ids":["CheckBox_2"],"validation":null,"required":false}],"conditional_rules":[{"id":"5cef7865-37a3-4458-ad86-4ebc6c567642","target_id":"employment_status","action_type":"require","action_field_ids":["manager_name"],"conditions":[{"condition_type":"any_of","status":"completed","join_operator":"and_operator","field_api_ids":["employment_status"],"position":1}]}],"conditional_logic_decisions":[]},"schema":{"$ref":"#/components/schemas/DocumentResponse"}}}},"404":{"description":"not_found","content":{"application/json":{"example":{"message":"Not found","meta":{"error":"record_not_found","message":"Couldn't find the document requested","messages":["Couldn't find the document requested"]}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}}},"x-readme":{"code-samples":[{"language":"ruby","name":"Ruby SDK","install":"gem install signwell_sdk","code":"require 'signwell_sdk'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\napi = SignWell::Resources::DocumentApi.new\n\ndocument = api.get_document('document_id')\nputs document.status"}]}},"delete":{"summary":"Delete Document","description":"Deletes a document. Deleting a document will also cancel document signing (if in progress).  Supply the unique document ID from either a Create Document request or document page URL.","tags":["Document"],"security":[{"api_key":[]}],"operationId":"deleteDocument","parameters":[{"name":"id","in":"path","schema":{"$ref":"#/components/schemas/DocumentId"},"required":true}],"responses":{"204":{"description":"no content"},"404":{"description":"not found","content":{"application/json":{"example":{"message":"Not found","meta":{"error":"record_not_found","message":"Couldn't find the document requested","messages":["Couldn't find the document requested"]}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}}},"x-readme":{"code-samples":[{"language":"ruby","name":"Ruby SDK","install":"gem install signwell_sdk","code":"require 'signwell_sdk'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\napi = SignWell::Resources::DocumentApi.new\n\napi.delete_document('document_id')"}]}}},"/api/v1/document_templates/documents":{"post":{"summary":"Create Document from Template","description":"Creates and optionally sends a new document for signing. If `draft` is set to true the document will not be sent. Pre-signed template signatures and initials are copied to the new document as document content — they remain visible on the document but do not generate a signing event, do not emit a `document_signed` webhook, and the recipient's status will not reflect them as a real signing action. If the template was pre-signed for a signer and the request adds new unsigned signature/initials fields for that same signer, the pre-applied ratifications are cleared silently so the signer is asked to sign once. 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.","tags":["Document"],"security":[{"api_key":[]}],"operationId":"createDocumentFromTemplate","parameters":[{"name":"X-TestMode-Enabled","in":"header","required":false,"schema":{"$ref":"#/components/schemas/TestModeHeader"}}],"responses":{"201":{"description":"created","content":{"application/json":{"example":{"id":"95a49223-3955-470a-8da0-9d8f059c8c22","archived":false,"created_at":"2026-09-29T15:21:43Z","decline_message":null,"embedded_edit_url":"https://www.signwell.com/edit/document/76aab0ca-959f-469a-a901-e3aaa9e24883/","error_message":null,"embedded_preview_url":null,"language":"en","name":"Agreement","requester_email_address":"requester@domain.com","status":"Created","test_mode":false,"updated_at":"2026-09-29T15:21:43Z","template_ids":["8ed515fe-9981-49fb-846e-d25b0f207e73","dc6eadb2-c0ad-4524-b9ce-e435a3eb27b0"],"cfr_part11":false,"cfr_part11_signing_mode":null,"allow_decline":true,"allow_reassign":true,"api_application_id":null,"custom_requester_email":"requester@domain.com","custom_requester_name":"Requester","decline_redirect_url":"https://www.domain.com/decline_path/","embedded_signing":false,"expires_in":365,"metadata":{"key1":"value1","key2":"value2"},"redirect_url":"https://www.domain.com/redirect_path/","reminders":true,"embedded":null,"apply_signing_order":false,"message":"Normal Body","subject":"Normal subject","labels":[],"fields":[[{"api_id":"DateField_2","height":"19.0","page":1,"required":false,"type":"date","value":null,"width":"86.0","x":1.1,"y":1.1,"date_format":"MM/DD/YYYY","formula":"","lock_sign_date":true,"recipient_id":"recipient_1"},{"api_id":"Signature_1","height":"19.0","page":1,"required":true,"type":"signature","value":"","width":"86.0","x":1.1,"y":1.1,"recipient_id":"document_sender"},{"api_id":"TextField_1","height":"19.0","page":1,"required":true,"type":"text","value":"a_valid_email@domain.com","width":"86.0","x":1.1,"y":1.1,"fixed_width":false,"label":"","validation":"no_text_validation","recipient_id":"recipient_1"},{"api_id":"DateField_1","height":"19.0","page":1,"required":true,"type":"date","value":"05/06/2021","width":"86.0","x":1.1,"y":1.1,"date_format":"MM/DD/YYYY","formula":"","lock_sign_date":false,"recipient_id":"recipient_1"},{"api_id":"CheckBox_1","height":"19.0","page":1,"required":true,"type":"checkbox","value":"t","width":"86.0","x":1.1,"y":1.1,"name":null,"recipient_id":"recipient_1"}],[{"api_id":"Initials_1","height":"19.0","page":1,"required":true,"type":"initials","value":"","width":"86.0","x":1.1,"y":1.1,"recipient_id":"document_sender"}],[{"api_id":"DateField_1_1","height":"19.0","page":1,"required":true,"type":"date","value":null,"width":"86.0","x":230,"y":60,"date_format":"DD/MM/YYYY","formula":"","lock_sign_date":true,"recipient_id":"recipient_1"},{"api_id":"DateField_2_1","height":"19.0","page":1,"required":true,"type":"date","value":"05/06/2021","width":"86.0","x":230,"y":120,"date_format":"MM/DD/YYYY","formula":"","lock_sign_date":false,"recipient_id":"recipient_1"}],[{"api_id":"Signature_1_1","height":"32.0","page":2,"required":true,"type":"signature","value":null,"width":"112.0","x":260,"y":80,"recipient_id":"recipient_2"},{"api_id":"CheckBox_3","height":"13.0","page":1,"required":true,"type":"checkbox","value":"t","width":"13.0","x":260,"y":80,"name":null,"recipient_id":"recipient_2"},{"api_id":"Initials_4","height":"32.0","page":2,"required":true,"type":"initials","value":null,"width":"44.0","x":260,"y":80,"recipient_id":"recipient_2"},{"api_id":"TextField_5","height":"19.0","page":1,"required":true,"type":"text","value":"123456","width":"86.0","x":260,"y":80,"fixed_width":true,"label":"label","validation":"numbers","recipient_id":"recipient_2"}]],"files":[{"name":"repellendus.docx","pages_number":2},{"name":"occaecati.png","pages_number":2},{"name":"filename1.pdf","pages_number":0},{"name":"filename2.pdf","pages_number":0}],"copied_contacts":[{"name":"CC one","email":"cc1@domain.com"},{"name":"CC 2","email":"cc2@domain.com"}],"recipients":[{"delivery_method":"email","email":"document_sender@domain.com","id":"document_sender","message":null,"name":"Recipient 0","passcode":"123","send_email":false,"send_email_delay":0,"status":"created","subject":null,"signing_order":1,"signing_url":"https://www.signwell.com/docs/c0c8e86467/","bounced":null,"bounced_details":null,"placeholder_name":"Document Sender","passcode_delivery":{"enabled":false,"methods":null,"expire_after_access":false},"attachment_requests":[]},{"delivery_method":"email","email":"recipient_1@domain.com","id":"recipient_1","message":null,"name":"Recipient 1","passcode":null,"send_email":false,"send_email_delay":0,"status":"created","subject":null,"signing_order":2,"signing_url":"https://www.signwell.com/docs/d072999784/","bounced":null,"bounced_details":null,"placeholder_name":"Placeholder 1","passcode_delivery":{"enabled":false,"methods":null,"expire_after_access":false},"attachment_requests":[{"name":"normal name","required":true,"url":"https://www.signwell.com/document_attachments/3PjWL7zZEGFJJGpXZn8Eu4bpnwX/?access=259d3090-ddfb-46cf-9761-52d24a5129e0"}]},{"delivery_method":"email","email":"recipient_2@domain.com","id":"recipient_2","message":null,"name":"Recipient 2","passcode":null,"send_email":false,"send_email_delay":0,"status":"created","subject":null,"signing_order":3,"signing_url":"https://www.signwell.com/docs/b05f7be651/","bounced":null,"bounced_details":null,"placeholder_name":"Placeholder 2","passcode_delivery":{"enabled":false,"methods":null,"expire_after_access":false},"attachment_requests":[{"name":"Driver License","required":false,"url":"https://www.signwell.com/document_attachments/zMORBG0M1esd2E8XbXDzsqjl56DO/?access=259d3090-ddfb-46cf-9761-52d24a5129e0"}]}],"checkbox_groups":[],"conditional_rules":[{"id":"dd22c10c-e06f-4607-be9b-c88b4103d20d","target_id":"DateField_1","action_type":"require","action_field_ids":["DateField_2"],"conditions":[{"condition_type":"any_of","status":"completed","join_operator":"and_operator","field_api_ids":["DateField_1"],"position":1}]}],"conditional_logic_decisions":[]},"schema":{"$ref":"#/components/schemas/DocumentFromTemplateResponse"}}}},"400":{"description":"bad request","content":{"application/json":{"example":{"errors":{"message":"The request contains invalid key values.","invalid_keys":["name"]}},"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"example":{"errors":{"template_id_or_ids":"At least one of template_id or template_ids should be present.","custom_requester_email":["is invalid"],"custom_requester_name":["is too long (maximum is 100 characters)"],"decline_redirect_url":["is not a valid URL"],"redirect_url":["is not a valid URL"],"expires_in":["must be less than or equal to 365"],"metadata":["The key/value pairs must not exceed 50","Check the following keys: [qgtxtpsnyxjwzvbzhnmrjziscxsmgcugpqanuygve], length needs to be less than 40 characters","Check the value of the following keys: [ke50], length needs to be less than 500 characters and must be a string"],"api_application_id":["The provided API application id is invalid"],"subject":["is too long (maximum is 255 characters)"],"message":["is too long (maximum is 4000 characters)"],"recipients":{"duplicated_ids":"These ids are duplicated: recipient_id_1.","duplicated_emails":"These emails are duplicated: recipient1domain.com.","recipient_1":{"name":["is too long (maximum is 255 characters)"],"email":["format is invalid."]},"recipient_2":{"email":["format is invalid."]}},"copied_contacts":{"copied_contact_1":{"name":["is too long (maximum is 255 characters)"],"email":["format is invalid."]},"copied_contact_2":{"email":["format is invalid.","is already a recipient"]}},"attachment_requests":{"invalid_ids":"These recipient ids are not present in the recipients array: [recipient_id_3]"},"fields":{"duplicated_api_ids":"These api ids are duplicated: CheckBox_2.","invalid_ids":"These recipient ids are not present in the recipients array: [recipient_id_2, recipient_id_3]","file_1":{"field_1":{"date_format":["Not allowed for text."],"lock_sign_date":["Not allowed for text."]}},"file_2":{"field_1":{"date_format":["Not allowed for checkbox."],"fixed_width":["Not allowed for checkbox."],"validation":["Not allowed for checkbox."],"label":["Not allowed for checkbox."],"lock_sign_date":["Not allowed for checkbox."]},"field_2":{"invalid_date_value":"DateField value must be in Iso8601 format.","fixed_width":["Not allowed for date."],"validation":["Not allowed for date."],"label":["Not allowed for date."],"date_format":["Allowed formats for date fields are: MM/DD/YYYY | DD/MM/YYYY | YYYY/MM/DD | Month DD, YYYY | MM/DD/YYYY hh:mm:ss a"]},"field_3":{"date_format":["Not allowed for initials."],"fixed_width":["Not allowed for initials."],"validation":["Not allowed for initials."],"label":["Not allowed for initials."],"lock_sign_date":["Not allowed for initials."]},"field_4":{"date_format":["Not allowed for signature."],"fixed_width":["Not allowed for signature."],"validation":["Not allowed for signature."],"label":["Not allowed for signature."],"lock_sign_date":["Not allowed for signature."]}}},"checkbox_groups":{"min_value_negative":"The min value must be greater than or equal to 0 in the checkbox group Group 1"},"files":{"file_1":{"file_data":["At least one of file_url or file_base64 should be present"]},"file_2":{"file_data":["Only one of file_url or file_base64 should be present, not both"]},"file_3":{"file_url":["is not a valid URL"]},"file_4":{"file_base64":["the file type is unsupported, we support the following formats: application/msword, application/pdf, application/octet-stream, application/x-ole-storage, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/vnd.ms-powerpoint, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/x-iwork-keynote-sffkey, application/x-iwork-numbers-sffnumbers, application/x-iwork-pages-sffpages, image/jpeg, image/png, image/tiff, image/webp, text/html"]},"file_5":{"name":["The file extension is invalid."]},"file_6":{"name":["can't be blank"]}}}},"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentFromTemplateRequest"}}},"required":true},"x-readme":{"code-samples":[{"language":"ruby","name":"Ruby SDK","install":"gem install signwell_sdk","code":"require 'signwell_sdk'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\napi = SignWell::Resources::DocumentApi.new\n\nrequest = SignWell::Models::DocumentFromTemplateRequest.new(\n  test_mode: true,\n  template_id: 'template_id',\n  name: 'Contract for Acme Corp',\n  recipients: [\n    SignWell::Models::TemplateRecipientsInner.new(\n      id: '1',\n      name: 'Jane Doe',\n      email: 'jane@example.com',\n      placeholder_name: 'Client'\n    )\n  ]\n)\n\ndocument = api.create_document_from_template(request)\nputs document.id"},{"language":"ruby","name":"Embedded Signing","install":"gem install signwell_sdk","code":"require 'signwell_sdk'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\ndocument = SignWell::Embedded.create_signing_document_from_template(\n  template_id: 'template_id',\n  recipients: [{ placeholder_name: 'Client', name: 'Jane Doe', email: 'jane@example.com' }]\n)\n\n# Signing URL for the first recipient — open it in an iframe with embedded.js\nsigning_url = SignWell::Embedded.embedded_signing_url(document)\nputs signing_url"},{"language":"ruby","name":"SMS Delivery","install":"gem install signwell_sdk","code":"require 'signwell_sdk'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\napi = SignWell::Resources::DocumentApi.new\n\n# SMS delivery is available only to workspaces that are eligible for SMS and have it enabled.\n# With 'sms' the signing link is delivered by SMS only, so email can be omitted and a\n# phone_number in E.164 format is required.\nrequest = SignWell::Models::DocumentFromTemplateRequest.new(\n  test_mode: true,\n  template_id: 'template_id',\n  name: 'Contract for Acme Corp',\n  recipients: [\n    SignWell::Models::TemplateRecipientsInner.new(\n      id: '1',\n      name: 'Jane Doe',\n      delivery_method: 'sms',\n      phone_number: '+14155551234',\n      placeholder_name: 'Client'\n    )\n  ]\n)\n\ndocument = api.create_document_from_template(request)\nputs document.id"}]}}},"/api/v1/documents/{id}/send":{"post":{"summary":"Update and Send Document","description":"Updates a draft document and sends it to be signed by recipients. `subject` and `message` apply to email notifications only; SMS notifications always use fixed system templates.","tags":["Document"],"security":[{"api_key":[]}],"operationId":"sendDocument","parameters":[{"name":"id","in":"path","schema":{"$ref":"#/components/schemas/DocumentId"},"required":true},{"name":"X-TestMode-Enabled","in":"header","required":false,"schema":{"$ref":"#/components/schemas/TestModeHeader"}}],"responses":{"201":{"description":"created","content":{"application/json":{"example":{"id":"d7955008-c997-466c-957d-117433a84c36","archived":false,"copied_contacts":[{"email":"johnathan@greenfelder-homenick.example","name":"Taylor Renner MD"}],"created_at":"2026-09-29T15:21:44Z","custom_requester_email":"isa_durgan@pfannerstill.test","custom_requester_name":"Anakin Skywalker","decline_redirect_url":"https://www.domain.com/decline_path/","embedded_edit_url":"https://www.signwell.com/edit/document/2e7159fd-e621-44da-bc9a-40cafa00199a/","embedded_preview_url":null,"error_message":null,"fields":[[{"api_id":"CheckBox_8","height":"13.0","required":true,"type":"checkbox","value":null,"width":"13.0","x":1.1,"y":1.1,"name":null,"page":1,"recipient_id":null},{"api_id":"CheckBox_9","height":"13.0","required":true,"type":"checkbox","value":null,"width":"13.0","x":1.1,"y":1.1,"name":null,"page":1,"recipient_id":null},{"api_id":"Signature_7","height":"32.0","required":true,"type":"signature","value":null,"width":"112.0","x":1.1,"y":1.1,"page":1,"recipient_id":"661f061f-8436-4c05-8e22-b8ff9cfb1f93"}]],"labels":[{"id":"a941a0a9-886b-4395-bbe8-8238fc0b346f","name":"My First Label"},{"id":"46579fff-93c8-4b2a-9d55-56e9723d114d","name":"My Second Label"},{"id":"9f5e4955-f139-49ac-9c47-f891af9dd3bd","name":"My Third Label"}],"language":"en","metadata":{"key1":"value1","key2":"value2"},"name":"Agreement","recipients":[{"id":"661f061f-8436-4c05-8e22-b8ff9cfb1f93","attachment_requests":[],"email":"wenona.gerlach@rohan-daugherty.test","message":null,"name":"Fatimah Rolfson II","passcode":null,"send_email_delay":null,"signing_order":7,"status":"draft","subject":null,"bounced":null,"bounced_details":null,"send_email":null,"signing_url":"https://www.signwell.com/docs/2756204beb/","delivery_method":"email"},{"id":"9c1f44e1-d046-43f6-a794-e8bc1f9bc56d","attachment_requests":[],"email":"ed_boyer@mcdermott.example","message":null,"name":"Amb. Rebbecca Jones","passcode":null,"send_email_delay":null,"signing_order":8,"status":"draft","subject":null,"bounced":null,"bounced_details":null,"send_email":null,"signing_url":"https://www.signwell.com/docs/5dacf9d699/","delivery_method":"email"}],"subject":"Normal subject","test_mode":false,"updated_at":"2026-09-29T15:21:44Z","decline_message":null,"api_application_id":null,"cfr_part11":false,"cfr_part11_signing_mode":null,"embedded":null,"allow_decline":true,"allow_reassign":true,"apply_signing_order":false,"embedded_signing":false,"expires_in":365,"message":"Normal Body","reminders":true,"requester_email_address":"19.arthricia@stroman.example","redirect_url":"https://www.domain.com/redirect_path/","status":"Draft","files":[{"name":"sunt.jpg","pages_number":1}],"conditional_rules":[]},"schema":{"$ref":"#/components/schemas/DocumentResponse"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"example":{"errors":{"decline_redirect_url":["is not a valid URL"],"redirect_url":["is not a valid URL"],"expires_in":["must be less than or equal to 365"],"metadata":["The key/value pairs must not exceed 50","Check the following keys: [qgtxtpsnyxjwzvbzhnmrjziscxsmgcugpqanuygve], length needs to be less than 40 characters","Check the value of the following keys: [ke50], length needs to be less than 500 characters and must be a string"],"subject":["is too long (maximum is 255 characters)"],"message":["is too long (maximum is 4000 characters)"]}},"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDocumentAndSendRequest"}}},"required":true},"x-readme":{"code-samples":[{"language":"ruby","name":"Ruby SDK","install":"gem install signwell_sdk","code":"require 'signwell_sdk'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\napi = SignWell::Resources::DocumentApi.new\n\nrequest = SignWell::Models::UpdateDocumentAndSendRequest.new(\n  subject: 'Please sign this NDA',\n  message: 'Hi Jane, please review and sign this document.'\n)\n\ndocument = api.send_document('document_id', request)\nputs document.status"}]}}},"/api/v1/documents/{id}/recipients":{"patch":{"summary":"Update Recipients","description":"Updates one or more recipients on a document that has already been sent. Only recipients who have not started signing may be updated. Recipient IDs must be retrieved from the Get Document response. Allowed document statuses: sent, viewed, pending, bounced. For non-embedded documents, updated recipients will receive a new notification email. For embedded signing documents, email behavior follows each recipient's send_email setting. This endpoint does not support changing a recipient's `delivery_method` or `phone_number`; SMS delivery settings are set when the document is created.","tags":["Document"],"security":[{"api_key":[]}],"operationId":"updateRecipients","parameters":[{"name":"id","in":"path","schema":{"$ref":"#/components/schemas/DocumentId"},"required":true}],"responses":{"200":{"description":"successful","content":{"application/json":{"example":{"id":"54472c61-ff97-435e-b064-f75d720fe78a","archived":false,"created_at":"2026-09-29T15:21:45Z","decline_message":null,"embedded_edit_url":null,"error_message":null,"embedded_preview_url":"https://www.signwell.com/preview/document/54472c61-ff97-435e-b064-f75d720fe78a/","language":"en","name":"design-story/dolorum.txt","requester_email_address":"loggins.25@reichert.test","status":"Sent","test_mode":false,"updated_at":"2026-09-29T15:21:45Z","cfr_part11":false,"cfr_part11_signing_mode":null,"allow_decline":false,"allow_reassign":true,"api_application_id":null,"custom_requester_email":"stewart@langworth-olson.test","custom_requester_name":"Poe Dameron","decline_redirect_url":"http://langosh-smith.test/julian","embedded_signing":false,"expires_in":10,"metadata":{"beatae":"velit","impedit":"omnis"},"redirect_url":"http://heaney.example/taren.lowe","reminders":false,"embedded":null,"apply_signing_order":false,"message":"<p>Hey there,</p><p>&nbsp;</p><p>Please review and complete this document. You can click on the document below to get started.</p>","subject":"Please complete design-story/dolorum.txt","labels":[{"id":"0f19daa1-3555-4940-b86f-d31025537ee6","name":"Yoshiko Purdy"},{"id":"7c71be7a-6da4-4e2d-bdbb-95e22c9478d3","name":"Danilo Beer Ret."}],"fields":[[{"api_id":"CheckBox_14","height":"13.0","page":1,"required":true,"type":"checkbox","value":null,"width":"13.0","x":1.1,"y":1.1,"name":null,"recipient_id":null,"signing_elements_group_id":"076f646e-ba9c-47db-bf2c-15d6e6208710"},{"api_id":"CheckBox_15","height":"13.0","page":1,"required":true,"type":"checkbox","value":null,"width":"13.0","x":1.1,"y":1.1,"name":null,"recipient_id":null},{"api_id":"Signature_13","height":"32.0","page":1,"required":true,"type":"signature","value":null,"width":"112.0","x":1.1,"y":1.1,"recipient_id":"d17ea9f6-a077-45d4-89df-0639688a234b"}]],"files":[{"name":"eos.pages","pages_number":1}],"copied_contacts":[{"name":"Dr. Allen Gusikowski","email":"billy@volkman.example"}],"recipients":[{"delivery_method":"email","email":"updated@example.com","id":"d17ea9f6-a077-45d4-89df-0639688a234b","message":null,"name":"Updated Name","passcode":null,"send_email":null,"send_email_delay":null,"status":null,"subject":null,"signing_order":13,"signing_url":"https://www.signwell.com/docs/1540268bd5/","bounced":null,"bounced_details":null,"passcode_delivery":{"enabled":false,"methods":null,"expire_after_access":false},"attachment_requests":[{"name":"angel-outside/excepturi.avi","required":true,"url":"https://www.signwell.com/document_attachments/qn2E7De0gdtQED15e63gu1qzDXw/?access=6214eb15-94ee-48a8-9faa-93b567512238"}]},{"delivery_method":"email","email":"anika.bogan@welch.example","id":"eefd041b-c1ed-42f3-8dcc-96455df2b56a","message":null,"name":"Lieselotte Koepp DVM","passcode":null,"send_email":null,"send_email_delay":null,"status":null,"subject":null,"signing_order":14,"signing_url":"https://www.signwell.com/docs/5afcad8b17/","bounced":null,"bounced_details":null,"passcode_delivery":{"enabled":false,"methods":null,"expire_after_access":false},"attachment_requests":[]}],"checkbox_groups":[{"id":"076f646e-ba9c-47db-bf2c-15d6e6208710","group_name":null,"recipient_id":null,"checkbox_ids":["CheckBox_14"],"validation":null,"required":false}],"conditional_rules":[],"conditional_logic_decisions":[]},"schema":{"$ref":"#/components/schemas/DocumentResponse"}}}},"400":{"description":"bad request - invalid structure","content":{"application/json":{"example":{"errors":{"invalid_keys":["recipients"],"base":["The request contains invalid key values."]}}}}},"404":{"description":"not found","content":{"application/json":{"example":{"message":"Not found","meta":{"error":"record_not_found","message":"Couldn't find the document requested","messages":["Couldn't find the document requested"]}}}}},"409":{"description":"conflict - document not in eligible state","content":{"application/json":{"example":{"errors":{"base":["Document in 'completed' status cannot have recipients managed. Only sent, viewed, pending, or bounced documents are eligible."]}}}}},"422":{"description":"unprocessable entity - business rule violation","content":{"application/json":{"example":{"errors":{"recipients[a3355d8c-7cc1-4506-ad69-750d50f768dc]":["Dewayne Turcotte (lowell_corkery@kuvalis.example) has started signing so you can't edit or replace them now. You can Update & Resend if you need to change recipients who already started signing."]}}}}},"429":{"description":"rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRecipientsRequest"}}},"required":true},"x-readme":{"code-samples":[{"language":"ruby","name":"Ruby SDK","install":"gem install signwell_sdk","code":"require 'signwell_sdk'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\napi = SignWell::Resources::DocumentApi.new\n\nrequest = SignWell::Models::UpdateRecipientsRequest.new(\n  recipients: [\n    SignWell::Models::UpdateRecipientsMapInner.new(\n      id: 'recipient_id',\n      name: 'Jane Doe',\n      email: 'jane.doe@example.com'\n    )\n  ]\n)\n\ndocument = api.update_recipients('document_id', request)\nputs document.recipients.map(&:email)"}]}}},"/api/v1/documents/{id}/authentication":{"patch":{"summary":"Update Authentication","description":"Update passcode delivery settings for recipients on a sent document. Only recipients who have not started signing can be updated.","tags":["Document"],"security":[{"api_key":[]}],"operationId":"updateAuthentication","parameters":[{"name":"id","in":"path","schema":{"$ref":"#/components/schemas/DocumentId"},"required":true}],"responses":{"200":{"description":"successful","content":{"application/json":{"example":{"id":"babfa7a0-9e9e-4612-9a4c-d06eedc75ced","archived":false,"created_at":"2026-09-29T15:21:47Z","decline_message":null,"embedded_edit_url":null,"error_message":null,"embedded_preview_url":"https://www.signwell.com/preview/document/babfa7a0-9e9e-4612-9a4c-d06eedc75ced/","language":"en","name":"branch-cutting/soluta.numbers","requester_email_address":"40.jessica@boyle.example","status":"Sent","test_mode":false,"updated_at":"2026-09-29T15:21:48Z","cfr_part11":false,"cfr_part11_signing_mode":null,"allow_decline":false,"allow_reassign":true,"api_application_id":null,"custom_requester_email":"alta@wyman.test","custom_requester_name":"Chirrut Imwe","decline_redirect_url":"http://stiedemann.example/minh","embedded_signing":false,"expires_in":10,"metadata":{"id":"quia","alias":"minima"},"redirect_url":"http://bartell.example/ladawn_hahn","reminders":false,"embedded":null,"apply_signing_order":false,"message":"<p>Hey there,</p><p>&nbsp;</p><p>Please review and complete this document. You can click on the document below to get started.</p>","subject":"Please complete branch-cutting/soluta.numbers","labels":[{"id":"458457f4-0122-4fb1-88cc-9c71bfc09774","name":"Ligia Grady"},{"id":"65bc5878-b04e-4614-99a0-6b9ba277325a","name":"Shirely Prohaska"}],"fields":[[{"api_id":"CheckBox_29","height":"13.0","page":1,"required":true,"type":"checkbox","value":null,"width":"13.0","x":1.1,"y":1.1,"name":null,"recipient_id":null,"signing_elements_group_id":"a7cbc044-2a70-4fbb-b048-a6c4751ef4f5"},{"api_id":"CheckBox_30","height":"13.0","page":1,"required":true,"type":"checkbox","value":null,"width":"13.0","x":1.1,"y":1.1,"name":null,"recipient_id":null},{"api_id":"Signature_28","height":"32.0","page":1,"required":true,"type":"signature","value":null,"width":"112.0","x":1.1,"y":1.1,"recipient_id":"e3b3fd66-2b06-48f9-919d-0b9cda7a7196"}]],"files":[{"name":"perspiciatis.mp3","pages_number":1}],"copied_contacts":[{"name":"Kenna Fadel","email":"bao@ziemann.example"}],"recipients":[{"delivery_method":"email","email":"marna.keeling@stehr.example","id":"e3b3fd66-2b06-48f9-919d-0b9cda7a7196","message":null,"name":"Sydney Gerlach","passcode":null,"send_email":null,"send_email_delay":null,"status":null,"subject":null,"signing_order":28,"signing_url":"https://www.signwell.com/docs/92beae1043/","bounced":null,"bounced_details":null,"passcode_delivery":{"enabled":true,"methods":["email"],"expire_after_access":false},"attachment_requests":[{"name":"vegetarian_report/repellendus.odt","required":true,"url":"https://www.signwell.com/document_attachments/kRq578o6KMHdM0aPrL8BU2Rb83BK/?access=e98d363f-dcb7-4c12-a328-ad48af51b8ec"}]},{"delivery_method":"email","email":"chong_schaden@leuschke.test","id":"77b2721b-6df3-42b1-8288-d477a750c747","message":null,"name":"Lemuel Lynch","passcode":null,"send_email":null,"send_email_delay":null,"status":null,"subject":null,"signing_order":29,"signing_url":"https://www.signwell.com/docs/b60aa3c746/","bounced":null,"bounced_details":null,"passcode_delivery":{"enabled":false,"methods":null,"expire_after_access":false},"attachment_requests":[]}],"checkbox_groups":[{"id":"a7cbc044-2a70-4fbb-b048-a6c4751ef4f5","group_name":null,"recipient_id":null,"checkbox_ids":["CheckBox_29"],"validation":null,"required":false}],"conditional_rules":[],"conditional_logic_decisions":[]},"schema":{"$ref":"#/components/schemas/DocumentResponse"}}}},"400":{"description":"bad request - invalid delivery methods","content":{"application/json":{"example":{"errors":{"recipients":["must be a non-empty array"]}}}}},"404":{"description":"not found","content":{"application/json":{"example":{"message":"Not found","meta":{"error":"record_not_found","message":"Couldn't find the document requested","messages":["Couldn't find the document requested"]}}}}},"422":{"description":"unprocessable entity - invalid delivery methods","content":{"application/json":{"example":{"errors":{"recipients[0].passcode_delivery.methods":["contains unsupported delivery methods: sms"]}}}}},"429":{"description":"rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAuthenticationRequest"}}},"required":true}}},"/api/v1/documents/{id}/remind":{"post":{"summary":"Send Reminder","description":"Sends a reminder to recipients who have not signed yet. Each recipient is reminded through their delivery method (email, SMS, or both). SMS reminders are only sent to recipients whose delivery method includes SMS, and only when the workspace is eligible for SMS and has it enabled.","tags":["Document"],"security":[{"api_key":[]}],"operationId":"sendReminder","parameters":[{"name":"id","in":"path","schema":{"$ref":"#/components/schemas/DocumentId"},"required":true}],"responses":{"201":{"description":"created","content":{"application/json":{"example":{"id":"b58e25b8-a20f-4b06-b6b9-18b7993b33ea","archived":false,"created_at":"2026-09-29T15:21:50Z","decline_message":null,"embedded_edit_url":null,"error_message":null,"embedded_preview_url":"https://www.signwell.com/preview/document/b58e25b8-a20f-4b06-b6b9-18b7993b33ea/","language":"en","name":"vegetarian-twilight/dolor.ods","requester_email_address":"jr_morty_52@cummerata.example","status":"Sent","test_mode":false,"updated_at":"2026-09-29T15:21:50Z","cfr_part11":false,"cfr_part11_signing_mode":null,"allow_decline":false,"allow_reassign":true,"api_application_id":null,"custom_requester_email":"lane@goodwin.example","custom_requester_name":"Rune Haako","decline_redirect_url":"http://schuster.example/bennie_auer","embedded_signing":false,"expires_in":10,"metadata":{"dolores":"deserunt","necessitatibus":"ipsam"},"redirect_url":"http://wintheiser-adams.example/bruno_little","reminders":false,"embedded":null,"apply_signing_order":false,"message":"<p>Hey there,</p><p>&nbsp;</p><p>Please review and complete this document. You can click on the document below to get started.</p>","subject":"Please complete vegetarian-twilight/dolor.ods","labels":[{"id":"a3ace7dd-1ea7-4b35-9234-fa19f692abd7","name":"Wilbur Feest"},{"id":"b93e1b81-540c-4e1f-ae06-e39f289b0d16","name":"Milan Roob"}],"fields":[[{"api_id":"CheckBox_41","height":"13.0","page":1,"required":true,"type":"checkbox","value":null,"width":"13.0","x":1.1,"y":1.1,"name":null,"recipient_id":null,"signing_elements_group_id":"bcf5889e-113c-45c3-afd3-0e0325138797"},{"api_id":"CheckBox_42","height":"13.0","page":1,"required":true,"type":"checkbox","value":null,"width":"13.0","x":1.1,"y":1.1,"name":null,"recipient_id":null},{"api_id":"Signature_40","height":"32.0","page":1,"required":true,"type":"signature","value":null,"width":"112.0","x":1.1,"y":1.1,"recipient_id":"dde32e2c-8f11-4593-93e9-4b0c3d95fca6"}]],"files":[{"name":"laudantium.xlsx","pages_number":1}],"copied_contacts":[{"name":"Odell Buckridge","email":"angelo@mraz.example"}],"recipients":[{"delivery_method":"email","email":"almeta@dietrich.test","id":"dde32e2c-8f11-4593-93e9-4b0c3d95fca6","message":null,"name":"Tyesha Smitham","passcode":null,"send_email":null,"send_email_delay":null,"status":null,"subject":null,"signing_order":40,"signing_url":"https://www.signwell.com/docs/5c6ac39ea6/","bounced":null,"bounced_details":null,"passcode_delivery":{"enabled":false,"methods":null,"expire_after_access":false},"attachment_requests":[{"name":"marine_vegetarian/provident.tiff","required":true,"url":"https://www.signwell.com/document_attachments/7alyA5DyjBtrdZXO3yoPIZLaPNz/?access=22ee52e6-05c2-45a3-b593-7c8637555edd"}]},{"delivery_method":"email","email":"jeri.leannon@windler.example","id":"55b16e47-1945-4e77-8bff-c3e2b692f352","message":null,"name":"Sen. Katharina Koelpin","passcode":null,"send_email":null,"send_email_delay":null,"status":null,"subject":null,"signing_order":41,"signing_url":"https://www.signwell.com/docs/dc03d7ab6a/","bounced":null,"bounced_details":null,"passcode_delivery":{"enabled":false,"methods":null,"expire_after_access":false},"attachment_requests":[]}],"checkbox_groups":[{"id":"bcf5889e-113c-45c3-afd3-0e0325138797","group_name":null,"recipient_id":null,"checkbox_ids":["CheckBox_41"],"validation":null,"required":false}],"conditional_rules":[],"conditional_logic_decisions":[]}}}},"404":{"description":"not found","content":{"application/json":{"example":{"message":"Not found","meta":{"error":"record_not_found","message":"Couldn't find the document requested","messages":["Couldn't find the document requested"]}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"example":{"errors":{"document":"The document is in a status that cannot be reminded"}},"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReminderRequest"}}},"required":true},"x-readme":{"code-samples":[{"language":"ruby","name":"Ruby SDK","install":"gem install signwell_sdk","code":"require 'signwell_sdk'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\napi = SignWell::Resources::DocumentApi.new\n\n# Reminds all recipients that have not signed yet\napi.send_reminder('document_id', SignWell::Models::SendReminderRequest.new)\n\n# Or remind specific recipients only\nrequest = SignWell::Models::SendReminderRequest.new(\n  recipients: [\n    SignWell::Models::ReminderRecipientsInner.new(email: 'jane@example.com')\n  ]\n)\napi.send_reminder('document_id', request)"}]}}},"/api/v1/documents/{id}/completed_pdf":{"get":{"summary":"Completed PDF","description":"Gets a completed document PDF or ZIP file. Supply the unique document ID from either a document creation request or document page URL.","tags":["Document"],"security":[{"api_key":[]}],"operationId":"getCompletedPdf","parameters":[{"name":"id","in":"path","schema":{"$ref":"#/components/schemas/CompletedDocumentId"},"required":true},{"name":"url_only","in":"query","schema":{"$ref":"#/components/schemas/UrlOnly"}},{"name":"audit_page","in":"query","schema":{"$ref":"#/components/schemas/IncludeAuditPage"}},{"name":"file_format","in":"query","schema":{"$ref":"#/components/schemas/FileFormat"}}],"responses":{"200":{"description":"successful, returns the final completed PDF, or if url_only is set to true, a JSON object is returned. When url_only=false (default), the response is the raw PDF or ZIP binary data.","content":{"application/json":{"example":{"file_url":"https://www.signwell.com/signed/D0dDgQgOMGuR4lXBabLKTbYjER9.pdf?audit_page=true"},"schema":{"$ref":"#/components/schemas/CompletedPdfResponse"}}}},"404":{"description":"not_found","content":{"application/json":{"example":{"message":"Not found","meta":{"error":"record_not_found","message":"Couldn't find the document requested","messages":["Couldn't find the document requested"]}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}}},"x-readme":{"code-samples":[{"language":"ruby","name":"Ruby SDK","install":"gem install signwell_sdk","code":"require 'signwell_sdk'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\napi = SignWell::Resources::DocumentApi.new\n\n# Get a download URL for the completed PDF\nresponse = api.get_completed_pdf('document_id', { url_only: true })\nputs response.file_url"}]}}},"/api/v1/document_templates":{"post":{"summary":"Create Template","description":"Creates a new template.","tags":["Template"],"security":[{"api_key":[]}],"operationId":"createTemplate","parameters":[],"responses":{"201":{"description":"created","content":{"application/json":{"example":{"id":"d8012784-8934-4de3-ac16-ae131a42eab9","archived":false,"created_at":"2026-09-29T15:21:56Z","embedded_edit_url":"https://www.signwell.com/edit/template/a6d987c8-4a02-4ef6-9672-b5a886bc9168/","language":"en","name":"Agreement","requester_email_address":"eyeholes_96_man@mann-kuvalis.test","status":"Created","template_link":"https://www.signwell.com/new_doc/CBnxWrg8U3GVJVIx/","updated_at":"2026-09-29T15:21:56Z","allow_decline":true,"allow_reassign":null,"api_application_id":null,"decline_redirect_url":"https://www.domain.com/decline_path/","expires_in":365,"redirect_url":"https://www.domain.com/redirect_path/","reminders":true,"metadata":{"key1":"value1","key2":"value2"},"apply_signing_order":false,"message":"Normal Body","subject":"Normal subject","labels":[{"id":"d6933711-7938-4ab2-9fe2-3bc6a171f5a8","name":"My First Label"},{"id":"f4c208fc-4892-4b5d-ae4b-ccb82abf43ee","name":"My Second Label"},{"id":"45f73d1f-e5e3-4f95-8c07-302273abd2f0","name":"My Third Label"}],"fields":[[{"api_id":"DateField_1","height":"19.0","page":1,"required":true,"type":"date","value":"2021/05/06","width":"86.0","x":230,"y":60,"date_format":"YYYY/MM/DD","formula":"","lock_sign_date":true,"placeholder_name":"Placeholder One"}],[{"api_id":"Signature_2","height":"32.0","page":1,"required":true,"type":"signature","value":null,"width":"112.0","x":260,"y":80,"placeholder_name":"Placeholder 2"},{"api_id":"CheckBox_4","height":"13.0","page":1,"required":true,"type":"checkbox","value":"t","width":"13.0","x":270,"y":80,"name":null,"placeholder_name":"Placeholder 2"},{"api_id":"Initials_4","height":"32.0","page":1,"required":true,"type":"initials","value":null,"width":"44.0","x":260,"y":80,"placeholder_name":"Placeholder 2"},{"api_id":"TextField_5","height":"19.0","page":1,"required":true,"type":"text","value":"1","width":"86.0","x":260,"y":80,"fixed_width":true,"label":"label","validation":"numbers","placeholder_name":"Placeholder 2"},{"api_id":"CheckBox_3","height":"13.0","page":1,"required":false,"type":"checkbox","value":"t","width":"13.0","x":260,"y":80,"name":null,"placeholder_name":"Placeholder 2"}]],"files":[{"name":"filename1.pdf","pages_number":0},{"name":"filename2.pdf","pages_number":0}],"copied_placeholders":[{"id":"1","name":"Copied Placeholder 1","subject":null,"message":null},{"id":"2","name":"Copied Placeholder 2","subject":null,"message":null,"preassigned_recipient_name":"Nelson Copied 2","preassigned_recipient_email":"nelson+copied2@docsketch.com"}],"placeholders":[{"id":"placeholder_id_1","name":"Placeholder One","subject":null,"message":null,"preassigned_recipient_name":"recipient 1","preassigned_recipient_email":"recipient1@domain.com","signing_order":1,"passcode_delivery":{"enabled":false,"methods":null,"expire_after_access":false},"attachment_requests":[{"name":"normal name","required":true,"url":"https://www.signwell.com/document_attachments/Ln3wLePlMXTGRNZo1JNQuXD7NZZ/?access=676b2a8d-5569-42fc-9480-0ffde7c5a561"}]},{"id":"placeholder_id_2","name":"Placeholder 2","subject":null,"message":null,"signing_order":2,"passcode_delivery":{"enabled":false,"methods":null,"expire_after_access":false},"attachment_requests":[{"name":"Driver License","required":false,"url":"https://www.signwell.com/document_attachments/7GBeq13l1KHEp1qwlB5wuD5j4OM/?access=676b2a8d-5569-42fc-9480-0ffde7c5a561"}]}],"checkbox_groups":[{"id":"81f6567a-f83f-4e06-820b-2723188a36f8","group_name":"Group 1","recipient_id":null,"checkbox_ids":["CheckBox_3","CheckBox_4"],"validation":"minimum","required":true,"min_value":1}],"conditional_rules":[{"id":"da6cb765-a4da-4228-add4-b5e9bd14f02e","target_id":"TextField_5","action_type":"require","action_field_ids":["CheckBox_3"],"conditions":[{"condition_type":"any_of","status":"completed","join_operator":"and_operator","field_api_ids":["TextField_5"],"position":1}]}]},"schema":{"$ref":"#/components/schemas/DocumentTemplateResponse"}}}},"400":{"description":"bad request","content":{"application/json":{"example":{"errors":{"message":"The request contains invalid key values.","invalid_keys":["name"]}},"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"example":{"errors":{"decline_redirect_url":["is not a valid URL"],"redirect_url":["is not a valid URL"],"expires_in":["must be less than or equal to 365"],"metadata":["The key/value pairs must not exceed 50","Check the following keys: [qgtxtpsnyxjwzvbzhnmrjziscxsmgcugpqanuygve], length needs to be less than 40 characters","Check the value of the following keys: [ke50], length needs to be less than 500 characters and must be a string"],"api_application_id":["The provided API application id is invalid"],"message":["is too long (maximum is 4000 characters)"],"placeholders":{"duplicated_ids":"These ids are duplicated: placeholder_id_1.","placeholder_1":{"name":["is too long (maximum is 255 characters)"],"preassigned_recipient_email":["format is invalid."],"preassigned_recipient_name":["is too long (maximum is 255 characters)"]},"placeholder_2":{"preassigned_recipient_email":["format is invalid."]},"all_preassigned":"At least one placeholder should be left unassigned"},"attachment_requests":{"invalid_ids":"These placeholder ids are not present in the placeholders array: [placeholder_id_3]"},"fields":{"duplicated_api_ids":"These api ids are duplicated: CheckBox_2.","invalid_ids":"These placeholder ids are not present in the placeholders array: [placeholder_id_2, placeholder_id_3]","file_2":{"field_2":{"invalid_date_value":"DateField value must be in Iso8601 format.","date_format":["Allowed formats for date fields are: MM/DD/YYYY | DD/MM/YYYY | YYYY/MM/DD | Month DD, YYYY | MM/DD/YYYY hh:mm:ss a"]}}},"files":{"file_1":{"file_data":["At least one of file_url or file_base64 should be present"]},"file_2":{"file_data":["Only one of file_url or file_base64 should be present, not both"]},"file_3":{"file_url":["is not a valid URL"]},"file_4":{"file_base64":["the file type is unsupported, we support the following formats: application/msword, application/pdf, application/octet-stream, application/x-ole-storage, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/vnd.ms-powerpoint, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/x-iwork-keynote-sffkey, application/x-iwork-numbers-sffnumbers, application/x-iwork-pages-sffpages, image/jpeg, image/png, image/tiff, image/webp, text/html"]},"file_5":{"name":["The file extension is invalid."]},"file_6":{"name":["can't be blank"]}},"checkbox_groups":{"min_value_negative":"The min value must be greater than or equal to 0 in the checkbox group Group 1"}}},"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentTemplateRequest"}}},"required":true},"x-readme":{"code-samples":[{"language":"ruby","name":"Ruby SDK","install":"gem install signwell_sdk","code":"require 'signwell_sdk'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\napi = SignWell::Resources::TemplateApi.new\n\nrequest = SignWell::Models::DocumentTemplateRequest.new(\n  name: 'Contract Template',\n  subject: 'Please sign this contract',\n  message: 'Hi, please review and sign.',\n  files: [\n    SignWell::Models::FilesInner.new(file_url: 'https://example.com/contract.pdf', name: 'contract.pdf')\n  ],\n  placeholders: [\n    SignWell::Models::PlaceholdersInner.new(id: '1', name: 'Client')\n  ],\n  fields: [\n    [\n      SignWell::Models::TemplateFieldsInnerInner.new(\n        x: 20, y: 60, page: 1,\n        placeholder_id: '1',\n        type: 'signature',\n        required: true\n      )\n    ]\n  ]\n)\n\ntemplate = api.create_template(request)\nputs template.id"}]}}},"/api/v1/document_templates/{id}":{"get":{"summary":"Get Template","description":"Returns a template and all associated template data. Supply the unique template ID from either a Create Template request or template page URL.","tags":["Template"],"security":[{"api_key":[]}],"operationId":"getTemplate","parameters":[{"name":"id","in":"path","schema":{"$ref":"#/components/schemas/TemplateId"},"required":true}],"responses":{"200":{"description":"successful","content":{"application/json":{"example":{"id":"2851644b-8c61-4901-ab97-43fee9106bec","archived":false,"created_at":"2026-09-29T15:21:53Z","embedded_edit_url":"https://www.signwell.com/edit/template/139ab7e6-dc2a-45f5-8e6f-dc6813af03c5/","language":"en","name":"satisfaction_twilight/voluptatem.doc","requester_email_address":"70_loggins@stehr.example","status":"Available","template_link":"https://www.signwell.com/new_doc/twrqD66X4uZEf9cK/","updated_at":"2026-09-29T15:21:53Z","allow_decline":null,"allow_reassign":null,"api_application_id":null,"decline_redirect_url":null,"expires_in":null,"redirect_url":null,"reminders":null,"metadata":null,"apply_signing_order":true,"message":"Soluta quo quos sunt.","subject":"delectus","fields":[[{"api_id":"Signature_55","height":"32.0","page":1,"required":true,"type":"signature","value":null,"width":"112.0","x":1.1,"y":1.1,"placeholder_name":"Supah Metron 1"},{"api_id":"Signature_56","height":"32.0","page":2,"required":true,"type":"signature","value":null,"width":"112.0","x":1.1,"y":1.1,"placeholder_name":"Isis Ix 2"}]],"files":[{"name":"et.txt","pages_number":2}],"copied_placeholders":[{"id":"3","name":"General Storm 3","subject":null,"message":null},{"id":"4","name":"Mr Question 4","subject":null,"message":null,"preassigned_recipient_name":"Margarito Bechtelar","preassigned_recipient_email":"lianne@king.example"}],"placeholders":[{"id":"1","name":"Supah Metron 1","subject":null,"message":null,"preassigned_recipient_name":"Sanford Kerluke","preassigned_recipient_email":"virgil@stanton.test","signing_order":1,"passcode_delivery":{"enabled":false,"methods":null,"expire_after_access":false},"attachment_requests":[{"name":"fruit_distant/illum.odp","required":true,"url":"https://www.signwell.com/document_attachments/j05NK9qOp0IEE7XdARMecPyjRQ4/?access=36f868ae-dbee-4e81-b7dd-44d11e552c71"}]},{"id":"2","name":"Isis Ix 2","subject":null,"message":null,"signing_order":2,"passcode_delivery":{"enabled":false,"methods":null,"expire_after_access":false},"attachment_requests":[]}],"checkbox_groups":[{"id":"27e08385-38fa-4d1b-a029-fa85143ff962","group_name":null,"recipient_id":null,"checkbox_ids":["CheckBox_57"],"validation":null,"required":false}],"conditional_rules":[{"id":"c1cf2286-0591-4bfb-8035-4ccba4dc1364","target_id":"employment_status","action_type":"require","action_field_ids":["manager_name"],"conditions":[{"condition_type":"any_of","status":"completed","join_operator":"and_operator","field_api_ids":["employment_status"],"position":1}]}]},"schema":{"$ref":"#/components/schemas/DocumentTemplateResponse"}}}},"404":{"description":"not_found","content":{"application/json":{"example":{"message":"Not found","meta":{"error":"record_not_found","message":"Couldn't find the template requested","messages":["Couldn't find the template requested"]}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}}},"x-readme":{"code-samples":[{"language":"ruby","name":"Ruby SDK","install":"gem install signwell_sdk","code":"require 'signwell_sdk'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\napi = SignWell::Resources::TemplateApi.new\n\ntemplate = api.get_template('template_id')\nputs template.name"}]}},"put":{"summary":"Update Template","description":"Updates an existing template.","tags":["Template"],"security":[{"api_key":[]}],"operationId":"updateTemplate","parameters":[{"name":"id","in":"path","schema":{"$ref":"#/components/schemas/TemplateId"},"required":true}],"responses":{"200":{"description":"ok","content":{"application/json":{"example":{"id":"100cc5b2-0918-406d-98da-ee92facb01d8","archived":false,"created_at":"2026-09-29T15:21:57Z","embedded_edit_url":"https://www.signwell.com/edit/template/e08ea73b-b870-4041-be83-5f5c60307783/","language":"en","name":"Android 20","requester_email_address":"jellybean_king_99@von.test","status":"Available","template_link":"https://www.signwell.com/new_doc/UTK8gJ3VFHZXJeQg/","updated_at":"2026-09-29T15:21:58Z","allow_decline":true,"allow_reassign":true,"api_application_id":"c3a9a952-a32a-4dc1-8595-ca9218202e1e","decline_redirect_url":"http://zemlak.example/german","expires_in":1,"redirect_url":"http://bartoletti.example/leeanna_hahn","reminders":true,"metadata":{"some":"metadata"},"apply_signing_order":true,"message":"Quia veniam ea voluptate.","subject":"Beatae quas voluptatem dolore.","fields":[[{"api_id":"Signature_67","height":"32.0","page":1,"required":true,"type":"signature","value":null,"width":"112.0","x":1.1,"y":1.1,"placeholder_name":"Ultra Thundra The Hunter 13"},{"api_id":"Signature_68","height":"32.0","page":2,"required":true,"type":"signature","value":null,"width":"112.0","x":1.1,"y":1.1,"placeholder_name":"Vulcan 14"}]],"files":[{"name":"molestiae.xls","pages_number":2}],"copied_placeholders":[{"id":"3","name":"Blink Knight 15","subject":null,"message":null},{"id":"4","name":"Electro 16","subject":null,"message":null,"preassigned_recipient_name":"Cindy Hyatt","preassigned_recipient_email":"damon.christiansen@greenfelder-smith.test"}],"placeholders":[{"id":"1","name":"Ultra Thundra The Hunter 13","subject":null,"message":null,"preassigned_recipient_name":"Jaunita Kassulke","preassigned_recipient_email":"leif@auer-windler.example","signing_order":1,"passcode_delivery":{"enabled":false,"methods":null,"expire_after_access":false},"attachment_requests":[{"name":"award-figure/vel.tiff","required":true,"url":"https://www.signwell.com/document_attachments/Rrja8Qg0qOTkyydkAn7Rt72AZQNn/?access=5ff3142e-d1bd-473e-b623-f14ff84279b0"}]},{"id":"2","name":"Vulcan 14","subject":null,"message":null,"signing_order":2,"passcode_delivery":{"enabled":false,"methods":null,"expire_after_access":false},"attachment_requests":[]}],"checkbox_groups":[{"id":"29e9a904-a4a3-4fef-8721-39d6c15a8c0b","group_name":null,"recipient_id":null,"checkbox_ids":["CheckBox_69"],"validation":null,"required":false}],"conditional_rules":[]},"schema":{"$ref":"#/components/schemas/DocumentTemplateResponse"}}}},"400":{"description":"bad request","content":{"application/json":{"example":{"errors":{"message":"The request contains invalid key values.","invalid_keys":["name"]}},"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"example":{"errors":{"decline_redirect_url":["is not a valid URL"],"redirect_url":["is not a valid URL"],"expires_in":["must be less than or equal to 365"],"metadata":["The key/value pairs must not exceed 50","Check the following keys: [qgtxtpsnyxjwzvbzhnmrjziscxsmgcugpqanuygve], length needs to be less than 40 characters","Check the value of the following keys: [ke50], length needs to be less than 500 characters and must be a string"],"api_application_id":["The provided API application id is invalid"],"message":["is too long (maximum is 4000 characters)"]}},"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentTemplateUpdateRequest"}}},"required":true},"x-readme":{"code-samples":[{"language":"ruby","name":"Ruby SDK","install":"gem install signwell_sdk","code":"require 'signwell_sdk'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\napi = SignWell::Resources::TemplateApi.new\n\nrequest = SignWell::Models::DocumentTemplateUpdateRequest.new(\n  name: 'Updated Contract Template',\n  subject: 'Updated: Please sign this contract'\n)\n\ntemplate = api.update_template('template_id', request)\nputs template.name"}]}},"delete":{"summary":"Delete Template","description":"Deletes a template. Supply the unique template ID from either a Create Template request or template page URL.","tags":["Template"],"security":[{"api_key":[]}],"operationId":"deleteTemplate","parameters":[{"name":"id","in":"path","schema":{"$ref":"#/components/schemas/TemplateId"},"required":true}],"responses":{"204":{"description":"no content"},"404":{"description":"not found","content":{"application/json":{"example":{"message":"Not found","meta":{"error":"record_not_found","message":"Couldn't find the template requested","messages":["Couldn't find the template requested"]}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}}},"x-readme":{"code-samples":[{"language":"ruby","name":"Ruby SDK","install":"gem install signwell_sdk","code":"require 'signwell_sdk'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\napi = SignWell::Resources::TemplateApi.new\n\napi.delete_template('template_id')"}]}}},"/api/v1/api_applications/{id}":{"get":{"summary":"Get API Application","description":"Gets the details of a specific API Application within an account. Supply the unique Application ID from either the Create API Application response or the API Application edit page.","tags":["API Application"],"security":[{"api_key":[]}],"operationId":"getApiApplication","parameters":[{"name":"id","in":"path","schema":{"type":"string","format":"uuid","description":"Unique identifier for the API Application."},"required":true}],"responses":{"200":{"description":"successful","content":{"application/json":{"example":{"id":"fc1daccf-b38e-4e3d-a7be-94e099f4d4ef","callback_urls":[],"created_at":"2026-09-29T15:22:00Z","name":"Keylex","updated_at":"2026-09-29T15:22:00Z","owner":{"id":"e11a4d8f-35ca-458f-b8e6-ce353389aacc","account_id":"53e80f14-5ce0-481f-a0da-c8c6e781166d","name":"Krombopulos Michael","email":"125_michael_krombopulos@blick.test"},"preferences":{"button_text_color":"F6F6B6","buttons_border_radius":9,"custom_logo_file":"/Users/sardavend/Repos/Signwell/docsketch/.claude/worktrees/oauth-part6-account-api/tmp/test_files/files_number/api_application_preferences/logos/000/000/003/original.png","link_text_color":"E41111","primary_color":"4E4EA6"}},"schema":{"$ref":"#/components/schemas/ApiApplicationResponse"}}}},"404":{"description":"not_found","content":{"application/json":{"example":{"message":"Not found","meta":{"error":"record_not_found","message":"Couldn't find the api_application requested","messages":["Couldn't find the api_application requested"]}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}}},"x-readme":{"code-samples":[{"language":"ruby","name":"Ruby SDK","install":"gem install signwell_sdk","code":"require 'signwell_sdk'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\napi = SignWell::Resources::APIApplicationApi.new\n\napplication = api.get_api_application('api_application_id')\nputs application.name"}]}},"delete":{"summary":"Delete API Application","description":"Deletes an API Application from an account. Supply the unique Application ID from either the Create API Application response or the API Application edit page","tags":["API Application"],"security":[{"api_key":[]}],"operationId":"deleteApiApplication","parameters":[{"name":"id","in":"path","schema":{"type":"string","format":"uuid","description":"Unique identifier for the API Application."},"required":true}],"responses":{"204":{"description":"no content"},"404":{"description":"not found","content":{"application/json":{"example":{"message":"Not found","meta":{"error":"record_not_found","message":"Couldn't find the api_application requested","messages":["Couldn't find the api_application requested"]}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}}},"x-readme":{"code-samples":[{"language":"ruby","name":"Ruby SDK","install":"gem install signwell_sdk","code":"require 'signwell_sdk'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\napi = SignWell::Resources::APIApplicationApi.new\n\napi.delete_api_application('api_application_id')"}]}}},"/api/v1/hooks":{"get":{"summary":"List Webhooks","description":"List all the webhooks in the account.","tags":["Webhooks"],"security":[{"api_key":[]}],"operationId":"listWebhooks","responses":{"200":{"description":"ok","content":{"application/json":{"example":[{"id":"6ff542d5-590c-44b2-8131-7ae998e78c5b","callback_url":"http://mcdermott.test/emile.kessler"},{"id":"35826895-d91f-49d9-a397-39955b7a5ac9","callback_url":"http://padberg.example/tyrone.zboncak"},{"id":"513b123a-51cd-42ff-9826-670fafc23e70","callback_url":"http://dare.example/daniel_larkin"},{"id":"0117c06b-0646-4cfe-bbe9-014bf27aae47","callback_url":"http://ledner.example/stacey","api_application_id":"3fa54438-5bd9-405a-9d7f-89dd47c80dc4"},{"id":"6ad9e4e4-a6e8-424e-b20c-32edb269fd5d","callback_url":"http://vonrueden-collins.test/skye","api_application_id":"3fa54438-5bd9-405a-9d7f-89dd47c80dc4"},{"id":"0f133b56-7e28-43df-b7a2-98de587597e8","callback_url":"http://conn.test/jerrod.hyatt","api_application_id":"3fa54438-5bd9-405a-9d7f-89dd47c80dc4"},{"id":"73350078-9d47-488a-b134-9b9d154d52a5","callback_url":"http://cruickshank.example/aurea_predovic","api_application_id":"3fa54438-5bd9-405a-9d7f-89dd47c80dc4"},{"id":"11ea1193-9b95-4a50-8cb3-a67ff39a99f5","callback_url":"http://lynch-johnson.example/veronique_koepp","api_application_id":"3fa54438-5bd9-405a-9d7f-89dd47c80dc4"}],"schema":{"$ref":"#/components/schemas/WebhookListResponse"}}}},"429":{"description":"rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}}},"x-readme":{"code-samples":[{"language":"ruby","name":"Ruby SDK","install":"gem install signwell_sdk","code":"require 'signwell_sdk'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\napi = SignWell::Resources::WebhooksApi.new\n\nwebhooks = api.list_webhooks\nwebhooks.each do |webhook|\n  puts \"#{webhook.id}: #{webhook.callback_url}\"\nend"}]}},"post":{"summary":"Create Webhook","description":"Register a callback URL that we will post document and template events to. See [Events](https://developers.signwell.com/reference/events) for every event and when it is sent, and [Event Data](https://developers.signwell.com/reference/event-data) for the data each one carries. Note: a `document_signed` event is not emitted solely because a pre-signed template signature/initials was copied as document content, and `event.related_signer` only identifies a real recipient signing action.","tags":["Webhooks"],"security":[{"api_key":[]}],"operationId":"createWebhook","parameters":[],"responses":{"201":{"description":"created","content":{"application/json":{"example":{"id":"3ca1189b-ae29-4a9e-878d-5c53dee86987","callback_url":"http://von.test/vance"},"schema":{"$ref":"#/components/schemas/WebhookResponse"}}}},"400":{"description":"bad request","content":{"application/json":{"example":{"message":"Bad request (bad request data)","meta":{"error":"invalid_parameter","message":"Invalid parameter: callback_url must be present","messages":["Invalid parameter: callback_url must be present"]}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"callback_url":{"type":"string","format":"url","description":"URL that we will post document events to.","example":"https://example.com/webhook"},"api_application_id":{"type":"string","format":"uuid","description":"Unique identifier for the API Application."}},"required":["callback_url"]}}},"required":true},"x-readme":{"code-samples":[{"language":"ruby","name":"Ruby SDK","install":"gem install signwell_sdk","code":"require 'signwell_sdk'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\napi = SignWell::Resources::WebhooksApi.new\n\nrequest = SignWell::Models::CreateWebhookRequest.new(\n  callback_url: 'https://example.com/webhooks/signwell'\n)\n\nwebhook = api.create_webhook(request)\nputs webhook.id"}]}}},"/api/v1/hooks/{id}":{"delete":{"summary":"Delete Webhook","description":"Deletes a registered callback URL that we are posting document events to.","tags":["Webhooks"],"security":[{"api_key":[]}],"operationId":"deleteWebhook","parameters":[{"name":"id","in":"path","schema":{"type":"string","format":"uuid","description":"Unique identifier for a webhook."},"required":true}],"responses":{"204":{"description":"no content"},"404":{"description":"not found","content":{"application/json":{"example":{"message":"Not found","meta":{"error":"record_not_found","message":"Couldn't find the hook requested","messages":["Couldn't find the hook requested"]}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}}},"x-readme":{"code-samples":[{"language":"ruby","name":"Ruby SDK","install":"gem install signwell_sdk","code":"require 'signwell_sdk'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\napi = SignWell::Resources::WebhooksApi.new\n\napi.delete_webhook('webhook_id')"}]}}},"/api/v1/me":{"get":{"summary":"Get credentials","description":"Retrieves the account information associated with the API key being used.","tags":["Me"],"security":[{"api_key":[]}],"operationId":"getMe","responses":{"200":{"description":"successful","content":{"application/json":{"example":{"id":"20416474-02f7-4026-92a4-8b1b924107cc","role":"owner","archived":false,"user":{"id":"2226f52d-2503-4741-b4f1-4a4de21f61d8","name":"Tammy Gueterman","email":"gueterman.135.tammy@kohler-keebler.example","has_google_registration":false,"first_name":"Tammy"},"account":{"id":"e33a83af-f3fc-474e-9481-bf0cd733e270","name":"Wiza-Toy","plan_tier":"free","active_templates":0,"can_create_template":true,"can_create_tracking_document":true,"can_create_completion_document":true,"active_users":[{"id":"2226f52d-2503-4741-b4f1-4a4de21f61d8","name":"Tammy Gueterman","email":"gueterman.135.tammy@kohler-keebler.example","has_google_registration":false}]},"workspace":{"id":"e33a83af-f3fc-474e-9481-bf0cd733e270","name":"Wiza-Toy","plan_tier":"free","active_templates":0,"can_create_template":true,"can_create_tracking_document":true,"can_create_completion_document":true,"active_users":[{"id":"2226f52d-2503-4741-b4f1-4a4de21f61d8","name":"Tammy Gueterman","email":"gueterman.135.tammy@kohler-keebler.example","has_google_registration":false}]},"contact":{"id":"31461c71-b58b-4810-91e6-a57fd29499ed","email":"gueterman.135.tammy@kohler-keebler.example","name":"Tammy Gueterman","company_name":"Runte Group","phone_number":"370.516.8717","alt_phone_number":"540 951 3686","website":"http://huels.example/deandrea_franecki","initials":"TG","archived":false}},"schema":{"$ref":"#/components/schemas/MeResponse"}}}},"401":{"description":"unauthorized","content":{"application/json":{"example":{"message":"Missing or invalid authorization key","meta":{"error":"api_key_unauthorized_error","message":"Not valid authorization token","messages":["Not valid authorization token"]}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}}},"x-readme":{"code-samples":[{"language":"ruby","name":"Ruby SDK","install":"gem install signwell_sdk","code":"require 'signwell_sdk'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\napi = SignWell::Resources::MeApi.new\n\nme = api.get_me\nputs me.user.email"}]}}},"/api/v1/bulk_sends/{id}":{"get":{"summary":"Get Bulk Send","description":"Returns information about the Bulk Send.","parameters":[{"name":"id","in":"path","schema":{"$ref":"#/components/schemas/BulkSendId"},"required":true}],"tags":["Bulk Send"],"security":[{"api_key":[]}],"operationId":"getBulkSend","responses":{"200":{"description":"successful","content":{"application/json":{"example":{"id":"273c7fa2-e18e-4d2d-a917-352210c1711d","name":"Tol-in-Gaurhoth","api_application_id":null,"documents_count":0,"documents_completed":0,"documents_not_completed":0,"created_at":"2026-09-29T15:22:01Z","user_id":null,"status":"Created","templates":[{"id":"a954b52f-66be-46e7-9177-9e633ce7bbf7","name":"bless_glow/ut.xlsx"}]},"schema":{"$ref":"#/components/schemas/BulkSendResponse"}}}},"401":{"description":"unauthorized","content":{"application/json":{"example":{"message":"Missing or invalid authorization key","meta":{"error":"api_key_unauthorized_error","message":"Not valid authorization token","messages":["Not valid authorization token"]}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"not found","content":{"application/json":{"example":{"message":"Not found","meta":{"error":"record_not_found","message":"Couldn't find the bulk_send requested","messages":["Couldn't find the bulk_send requested"]}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}}},"x-readme":{"code-samples":[{"language":"ruby","name":"Ruby SDK","install":"gem install signwell_sdk","code":"require 'signwell_sdk'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\napi = SignWell::Resources::BulkSendApi.new\n\nbulk_send = api.get_bulk_send('bulk_send_id')\nputs bulk_send.to_hash"}]}}},"/api/v1/bulk_sends":{"get":{"summary":"List Bulk Sendings","description":"Returns information about the Bulk Send.","tags":["Bulk Send"],"security":[{"api_key":[]}],"operationId":"listBulkSends","parameters":[{"name":"user_email","in":"query","required":false,"schema":{"$ref":"#/components/schemas/UserEmail"}},{"name":"limit","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Limit"}},{"name":"page","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Page"}},{"name":"api_application_id","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ApiApplicationId"}}],"responses":{"200":{"description":"successful","content":{"application/json":{"example":{"bulk_sends":[{"id":"0090e310-c59c-4a3d-b36e-9973a8d151e5","name":"East Road","api_application_id":null,"documents_count":0,"documents_completed":0,"documents_not_completed":0,"created_at":"2026-09-29T15:22:02Z","user_id":null,"status":"Created","template_ids":["268dee01-2afa-4df2-8a2e-3c4e1986b794"]},{"id":"6997e519-ff8f-4411-ab4e-e11cf5c26c72","name":"Lothlorièn","api_application_id":null,"documents_count":0,"documents_completed":0,"documents_not_completed":0,"created_at":"2026-09-29T15:22:02Z","user_id":null,"status":"Created","template_ids":["268dee01-2afa-4df2-8a2e-3c4e1986b794"]},{"id":"f80eba24-b3a8-4b86-b357-1315910f216e","name":"Eithel Sirion","api_application_id":null,"documents_count":0,"documents_completed":0,"documents_not_completed":0,"created_at":"2026-09-29T15:22:02Z","user_id":null,"status":"Created","template_ids":["268dee01-2afa-4df2-8a2e-3c4e1986b794"]},{"id":"cfd9d64d-be5b-421d-b9d6-87e20831dbcf","name":"The Rivers and Beacon-Hills of Gondor","api_application_id":null,"documents_count":0,"documents_completed":0,"documents_not_completed":0,"created_at":"2026-09-29T15:22:02Z","user_id":null,"status":"Created","template_ids":["268dee01-2afa-4df2-8a2e-3c4e1986b794"]},{"id":"48d4c406-9446-49ce-8482-be7710cadd93","name":"Pelennor Fields","api_application_id":null,"documents_count":0,"documents_completed":0,"documents_not_completed":0,"created_at":"2026-09-29T15:22:02Z","user_id":null,"status":"Created","template_ids":["268dee01-2afa-4df2-8a2e-3c4e1986b794"]}],"current_page":1,"next_page":null,"previous_page":null,"total_count":5,"total_pages":1},"schema":{"$ref":"#/components/schemas/BulkSendListResponse"}}}},"401":{"description":"unauthorized","content":{"application/json":{"example":{"message":"Missing or invalid authorization key","meta":{"error":"api_key_unauthorized_error","message":"Not valid authorization token","messages":["Not valid authorization token"]}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}}},"x-readme":{"code-samples":[{"language":"ruby","name":"Ruby SDK","install":"gem install signwell_sdk","code":"require 'signwell_sdk'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\napi = SignWell::Resources::BulkSendApi.new\n\nresponse = api.list_bulk_sends({ page: 1, limit: 10 })\nresponse.bulk_sends.each do |bulk_send|\n  puts \"#{bulk_send.id}: #{bulk_send.name}\"\nend"}]}},"post":{"summary":"Create Bulk Send","description":"Creates a bulk send, and it validates the CSV file before creating the bulk send.","tags":["Bulk Send"],"security":[{"api_key":[]}],"operationId":"createBulkSend","parameters":[],"responses":{"201":{"description":"successful","content":{"application/json":{"example":{"id":"3644a9bb-250d-4e26-8732-3c77407dece2","template_ids":["4f5262fd-3238-4bc0-ad1c-6a83a600c8d2"],"api_application_id":"be59462d-1449-4e27-90b4-75b29c262c40","documents_count":0,"created_at":"2026-09-29T15:22:03Z","user_id":"21b71251-a863-4189-8975-5570a8e9ceab","status":"Enqueuing"},"schema":{"$ref":"#/components/schemas/BulkSendCreateResponse"}}}},"401":{"description":"unauthorized","content":{"application/json":{"example":{"message":"Missing or invalid authorization key","meta":{"error":"api_key_unauthorized_error","message":"Not valid authorization token","messages":["Not valid authorization token"]}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"example":{"errors":{"bulk_send_csv":[{"row":2,"data":{"document_sender_email":"not an email","document_sender_name":"email@signwell.com","document_sender_label":"Label","recipient_email":"recipient@signwell.com","recipient_name":"Recipient","recipient_label":"Recipient"},"errors":["The following columns have an email address invalid: document_sender_email."]}]}},"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBulkSendRequest"}}},"required":true},"x-readme":{"code-samples":[{"language":"ruby","name":"Ruby SDK","install":"gem install signwell_sdk","code":"require 'signwell_sdk'\nrequire 'base64'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\napi = SignWell::Resources::BulkSendApi.new\n\n# signers.csv columns must match the template's CSV headers —\n# download them with the Get Bulk Send CSV Template endpoint\ncsv = Base64.strict_encode64(File.read('signers.csv'))\n\nrequest = SignWell::Models::CreateBulkSendRequest.new(\n  template_ids: ['template_id'],\n  bulk_send_csv: csv,\n  name: 'Quarterly Contracts',\n  subject: 'Please sign this document',\n  message: 'Hi, please review and sign.'\n)\n\nbulk_send = api.create_bulk_send(request)\nputs bulk_send.id"}]}}},"/api/v1/bulk_sends/csv_template":{"get":{"summary":"Get Bulk Send CSV Template","description":"Fetches a CSV template that corresponds to the provided document template IDs. CSV templates are blank CSV files that have columns containing required and optional data that can be sent when creating a bulk send. Fields can be referenced by the field label. Example: [placeholder name]_[field label] could be something like customer_address or signer_company_name (if 'Customer' and 'Signer' were placeholder names for templates set up in SignWell).","parameters":[{"name":"template_ids[]","in":"query","required":true,"schema":{"$ref":"#/components/schemas/BulkSendTemplateIds"}},{"name":"base64","in":"query","schema":{"$ref":"#/components/schemas/Base64Flag"}}],"tags":["Bulk Send"],"security":[{"api_key":[]}],"operationId":"getBulkSendCsvTemplate","responses":{"200":{"description":"successful","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"},"example":"document_sender_email,document_sender_name\njr_morty_158@hegmann-west.test,Morty Jr.\n"},"application/json":{"example":{"data":"ZG9jdW1lbnRfc2VuZGVyX2VtYWlsLGRvY3VtZW50X3NlbmRlcl9uYW1lCjE2Ml90aW55X3JpY2tAd2lzb3prLmV4YW1wbGUsVGlueSBSaWNrCg=="},"schema":{"$ref":"#/components/schemas/BulkSendCsvTemplateResponse"}}}},"401":{"description":"unauthorized","content":{"application/json":{"example":{"message":"Missing or invalid authorization key","meta":{"error":"api_key_unauthorized_error","message":"Not valid authorization token","messages":["Not valid authorization token"]}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"not found","content":{"application/json":{"example":{"message":"Not found","meta":{"error":"record_not_found","message":"Couldn't find the template requested","messages":["Couldn't find the template requested"]}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}}},"x-readme":{"code-samples":[{"language":"ruby","name":"Ruby SDK","install":"gem install signwell_sdk","code":"require 'signwell_sdk'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\napi = SignWell::Resources::BulkSendApi.new\n\ncsv_file = api.get_bulk_send_csv_template(['template_id'])\nputs File.read(csv_file.path)"}]}}},"/api/v1/bulk_sends/validate_csv":{"post":{"summary":"Validate Bulk Send CSV","description":"Validates a Bulk Send CSV file before creating the Bulk Send. It will check the structure of the CSV and the data it contains, and return any errors found.","parameters":[],"tags":["Bulk Send"],"security":[{"api_key":[]}],"operationId":"validateBulkSendCsv","responses":{"200":{"description":"successful","content":{"application/json":{"example":{"bulk_send_csv":"IkRvY3VtZW50IFNlbmRlciBFbWFpbCIsJ0RvY3VtZW50IFNlbmRlciBOYW1lJywvXERvY3VtZW50LSBTZW5kZXIgPUxhYmVsLEBSZWNpcGllbnRfIEVtYWlsLFJlY2lwaWVudCAqTmFtZSxgUmVjaXBpZW50fiFAIyQlXiYqKCl7fVtdPD4uPyBMYWJlbGAKc2VuZGVyQHNpZ253ZWxsLmNvbSxTZW5kZXIsU2VuZGVyLHJlY2lwaWVudEBzaWdud2VsbC5jb20sUmVjaXBpZW50LFJlY2lwaWVudAplbWFpbEBzb21lLmNvbSwsLGVtYWlsMkBzb21lLmNvbQo=","template_ids":["fa25d311-7745-49ff-bfa9-79395ec4680e"],"skip_row_errors":false,"api_application_id":null,"name":"plain-seller/maiores.xls","subject":"Please complete plain-seller/maiores.xls","message":"<p>Hey there,</p><p>&nbsp;</p><p>Please review and complete this document. You can click on the document below to get started.</p>","apply_signing_order":false},"schema":{"$ref":"#/components/schemas/BulkSendValidateCsvResponse"}}}},"401":{"description":"unauthorized","content":{"application/json":{"example":{"message":"Missing or invalid authorization key","meta":{"error":"api_key_unauthorized_error","message":"Not valid authorization token","messages":["Not valid authorization token"]}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"example":{"errors":{"bulk_send_csv":[{"row":2,"data":{"document_sender_email":"not an email","document_sender_name":"email@signwell.com","document_sender_label":"Label","recipient_email":"recipient@signwell.com","recipient_name":"Recipient","recipient_label":"Recipient"},"errors":["The following columns have an email address invalid: document_sender_email."]}]}},"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkSendCsvRequest"}}},"required":true},"x-readme":{"code-samples":[{"language":"ruby","name":"Ruby SDK","install":"gem install signwell_sdk","code":"require 'signwell_sdk'\nrequire 'base64'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\napi = SignWell::Resources::BulkSendApi.new\n\n# signers.csv columns must match the template's CSV headers —\n# download them with the Get Bulk Send CSV Template endpoint\ncsv = Base64.strict_encode64(File.read('signers.csv'))\n\nrequest = SignWell::Models::BulkSendCsvRequest.new(\n  template_ids: ['template_id'],\n  bulk_send_csv: csv\n)\n\nvalidation = api.validate_bulk_send_csv(request)\nputs validation.to_hash"}]}}},"/api/v1/bulk_sends/{id}/documents":{"get":{"summary":"Get Bulk Send Documents","description":"Returns information about the Bulk Send.","tags":["Bulk Send"],"security":[{"api_key":[]}],"operationId":"getBulkSendDocuments","parameters":[{"name":"id","in":"path","schema":{"$ref":"#/components/schemas/BulkSendId"},"required":true},{"name":"limit","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Limit"}},{"name":"page","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Page"}}],"responses":{"200":{"description":"successful","content":{"application/json":{"example":{"id":"d3322756-02a9-4cc8-bc63-7518cef56726","name":"Elostirion","api_application_id":null,"created_at":"2026-09-29T15:22:07Z","user_id":null,"status":"Created","documents":[{"id":"d0189e78-fbbc-41fb-bce0-1576baa8d550","archived":false,"created_at":"2026-09-29T15:22:07Z","decline_message":null,"embedded_edit_url":"https://www.signwell.com/edit/document/f068313c-182d-4a68-a043-f05d6eb02db5/","error_message":null,"embedded_preview_url":null,"language":"en","name":"trivial-angel/necessitatibus.xls","requester_email_address":"jan.michael.vincent.178@romaguera.example","status":"Created","test_mode":false,"updated_at":"2026-09-29T15:22:07Z","cfr_part11":false,"cfr_part11_signing_mode":null,"allow_decline":true,"allow_reassign":true,"api_application_id":null,"custom_requester_email":"kayleen.schuppe@bailey.example","custom_requester_name":"Kanan Jarrus","decline_redirect_url":"http://mills.test/charleen","embedded_signing":false,"expires_in":10,"metadata":{"nisi":"repellendus","voluptatibus":"occaecati"},"redirect_url":"http://hermann-marquardt.example/adrianne","reminders":false,"embedded":null,"apply_signing_order":false,"message":"<p>Hey there,</p><p>&nbsp;</p><p>Please review and complete this document. You can click on the document below to get started.</p>","subject":"Please complete trivial-angel/necessitatibus.xls","labels":[{"id":"ba6cda51-759d-49f2-8f12-476e60de3373","name":"Fr. Mary Bashirian"},{"id":"9bf3ce02-5835-4a55-80dd-c91f3c5a04b5","name":"Rev. Josue Daniel"}],"fields":[[{"api_id":"Signature_82","height":"32.0","page":1,"required":true,"type":"signature","value":null,"width":"112.0","x":1.1,"y":1.1,"recipient_id":"2872891d-a1cd-464a-aa5d-b47bee581136"},{"api_id":"CheckBox_83","height":"13.0","page":1,"required":true,"type":"checkbox","value":null,"width":"13.0","x":1.1,"y":1.1,"name":null,"recipient_id":null,"signing_elements_group_id":"0727f7ea-e826-4afc-885b-19a6aa16b7b6"},{"api_id":"CheckBox_84","height":"13.0","page":1,"required":true,"type":"checkbox","value":null,"width":"13.0","x":1.1,"y":1.1,"name":null,"recipient_id":null}]],"files":[{"name":"magnam.html","pages_number":1}],"copied_contacts":[{"name":"Fr. Tabitha Osinski","email":"isa@abbott.test"}],"recipients":[{"delivery_method":"email","email":"norine_schultz@muller.test","id":"2872891d-a1cd-464a-aa5d-b47bee581136","message":null,"name":"Carolyn Thiel","passcode":null,"send_email":null,"send_email_delay":null,"status":"created","subject":null,"signing_order":58,"signing_url":"https://www.signwell.com/docs/e1025393e2/","bounced":null,"bounced_details":null,"passcode_delivery":{"enabled":false,"methods":null,"expire_after_access":false},"attachment_requests":[{"name":"seller-diagram/ratione.pptx","required":true,"url":"https://www.signwell.com/document_attachments/ZA5rWakB54Teq7QDZ2PYsX819EA/?access=e4d208f6-cbff-48ef-af1b-ac554867cfc8"}]},{"delivery_method":"email","email":"fallon@kreiger-grady.test","id":"ccc70612-4c0c-43e2-af2c-f9b17c9638ac","message":null,"name":"Mallie Wuckert","passcode":null,"send_email":null,"send_email_delay":null,"status":"created","subject":null,"signing_order":59,"signing_url":"https://www.signwell.com/docs/b893d68153/","bounced":null,"bounced_details":null,"passcode_delivery":{"enabled":false,"methods":null,"expire_after_access":false},"attachment_requests":[]}],"checkbox_groups":[{"id":"0727f7ea-e826-4afc-885b-19a6aa16b7b6","group_name":null,"recipient_id":null,"checkbox_ids":["CheckBox_83"],"validation":null,"required":false}],"conditional_rules":[],"conditional_logic_decisions":[]}],"current_page":1,"next_page":null,"previous_page":null,"total_count":1,"total_pages":1},"schema":{"$ref":"#/components/schemas/BulkSendDocumentsResponse"}}}},"401":{"description":"unauthorized","content":{"application/json":{"example":{"message":"Missing or invalid authorization key","meta":{"error":"api_key_unauthorized_error","message":"Not valid authorization token","messages":["Not valid authorization token"]}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"not found","content":{"application/json":{"example":{"message":"Not found","meta":{"error":"record_not_found","message":"Couldn't find the bulk_send requested","messages":["Couldn't find the bulk_send requested"]}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}}},"x-readme":{"code-samples":[{"language":"ruby","name":"Ruby SDK","install":"gem install signwell_sdk","code":"require 'signwell_sdk'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\napi = SignWell::Resources::BulkSendApi.new\n\nresponse = api.get_bulk_send_documents('bulk_send_id', { page: 1, limit: 10 })\nresponse.documents.each do |document|\n  puts \"#{document.id}: #{document.status}\"\nend"}]}}},"/api/v1/documents/{id}/nom151_certificate":{"get":{"summary":"MX – NOM-151 Certificate","description":"Download NOM-151 certificate for a completed document. Returns a ZIP file, download URL, or raw certificate data based on query parameters.","tags":["Regional"],"security":[{"api_key":[]}],"operationId":"getNom151Certificate","parameters":[{"name":"id","in":"path","schema":{"$ref":"#/components/schemas/CompletedDocumentId"},"required":true},{"name":"url_only","in":"query","schema":{"$ref":"#/components/schemas/UrlOnly"},"description":"If true, returns JSON with download URL instead of downloading the file"},{"name":"object_only","in":"query","schema":{"$ref":"#/components/schemas/ObjectOnly"}}],"responses":{"200":{"description":"successful","content":{"application/json":{"example":{"file_url":"https://www.signwell.com/completed_docs/agy20L7ONGcBeGoP36b7C1M3lqX/nom151_certificate/"},"schema":{"$ref":"#/components/schemas/Nom151UrlResponse"}}}},"404":{"description":"not_found","content":{"application/json":{"example":{"message":"Not found","meta":{"error":"record_not_found","message":"Couldn't find the document requested","messages":["Couldn't find the document requested"]}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"unprocessable_entity","content":{"application/json":{"example":{"errors":{"table":{"not_available":"NOM-151 certificate not available"}}},"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}}},"x-readme":{"code-samples":[{"language":"ruby","name":"Ruby SDK","install":"gem install signwell_sdk","code":"require 'signwell_sdk'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\napi = SignWell::Resources::RegionalApi.new\n\n# Get a download URL for the NOM-151 certificate ZIP file\nresponse = api.get_nom151_certificate('document_id', { url_only: true })\nputs response.file_url"}]}}},"/api/v1/account":{"get":{"summary":"Get Account","description":"Returns the name, logo, and default settings of the account associated with the credentials being used.","tags":["Account"],"security":[{"api_key":[]}],"operationId":"getAccount","responses":{"200":{"description":"successful","content":{"application/json":{"example":{"id":"24ea4862-d2e5-4201-ac34-b2dc5b423a09","name":"Labadie, Dach and Rowe","logo_url":null,"plan_tier":"free","preferences":{"date_format":"MM/DD/YYYY","days_until_links_expire":30,"disable_apply_everywhere":false,"disable_apply_everywhere_effective":false,"disable_drawn_signatures":false,"disable_typed_signatures":false,"disable_uploaded_signatures":false,"enable_redirect":false,"hide_document_id_in_audit":false,"mute_branding":false,"redirect_url":null,"separate_audit_pdf":false,"separate_completed_file":false,"enable_nom151_compliance":false,"time_zone":"UTC","recipient_language":null}},"schema":{"$ref":"#/components/schemas/AccountResponse"}}}},"401":{"description":"unauthorized","content":{"application/json":{"example":{"message":"Missing or invalid authorization key","meta":{"error":"api_key_unauthorized_error","message":"Not valid authorization token","messages":["Not valid authorization token"]}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}}}},"put":{"summary":"Update Account","description":"Updates the account name, logo, or default settings. Only the fields included in the request are changed.","tags":["Account"],"security":[{"api_key":[]}],"operationId":"updateAccount","parameters":[],"responses":{"200":{"description":"successful","content":{"application/json":{"example":{"id":"ef69296e-bac3-4681-b307-13ddeccac5f1","name":"Acme Corp","logo_url":null,"plan_tier":"free","preferences":{"date_format":"DD/MM/YYYY","days_until_links_expire":30,"disable_apply_everywhere":false,"disable_apply_everywhere_effective":false,"disable_drawn_signatures":false,"disable_typed_signatures":false,"disable_uploaded_signatures":false,"enable_redirect":false,"hide_document_id_in_audit":false,"mute_branding":false,"redirect_url":null,"separate_audit_pdf":false,"separate_completed_file":false,"enable_nom151_compliance":false,"time_zone":"America/New_York","recipient_language":null}},"schema":{"$ref":"#/components/schemas/AccountResponse"}}}},"400":{"description":"bad request","content":{"application/json":{"example":{"errors":{"message":"The request contains invalid key values.","invalid_keys":["email_from"]}},"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"401":{"description":"unauthorized","content":{"application/json":{"example":{"message":"Missing or invalid authorization key","meta":{"error":"api_key_unauthorized_error","message":"Not valid authorization token","messages":["Not valid authorization token"]}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"example":{"errors":{"time_zone":["is not included in the list"]}},"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountUpdateRequest"}}}}}}},"components":{"securitySchemes":{"api_key":{"type":"apiKey","name":"X-Api-Key","in":"header"}},"schemas":{"FieldType":{"type":"string","enum":["initials","signature","checkbox","date","select","text","dropdown","autofill_company","autofill_email","autofill_first_name","autofill_last_name","autofill_name","autofill_phone","autofill_title","autofill_date_signed"],"description":"Type of signing field"},"TextValidation":{"type":"string","enum":["no_text_validation","numbers","letters","email_address","us_phone_number","us_zip_code","us_ssn","us_age","alphanumeric","us_bank_routing_number","us_bank_account_number","custom"],"description":"Validation rule for text fields"},"ValidationRegex":{"type":"string","description":"Text fields with custom validation only: the regex pattern used to validate field values. Required when validation is set to custom."},"ValidationRegexErrorMessage":{"type":"string","description":"Text fields with custom validation only: the error message shown to the recipient when their input doesn't match the regex pattern. Required when validation is set to custom."},"DateFormat":{"type":"string","enum":["MM/DD/YYYY","DD/MM/YYYY","YYYY/MM/DD","Month DD, YYYY","MM/DD/YYYY hh:mm:ss a"],"description":"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"},"CheckboxValidation":{"type":"string","enum":["minimum","maximum","range","exact"],"description":"Validation rule for checkbox groups"},"FileInfo":{"type":"object","description":"File information","properties":{"name":{"type":"string","description":"File name"},"pages_number":{"type":"integer","description":"Number of pages in the file"}},"required":["name","pages_number"]},"LabelInfo":{"type":"object","description":"Label information","properties":{"id":{"type":"string","description":"Label ID"},"name":{"type":"string","description":"Label name"}}},"CopiedContactInfo":{"type":"object","description":"Copied contact information","properties":{"id":{"type":"string","description":"Contact ID"},"name":{"type":"string","description":"Contact name"},"email":{"type":"string","format":"email","description":"Contact email"}},"required":["email"]},"CheckboxGroupInfo":{"type":"object","description":"Checkbox group configuration","properties":{"id":{"type":"string","format":"uuid","description":"Checkbox group ID"},"group_name":{"type":"string","nullable":true,"description":"Name of the checkbox group"},"recipient_id":{"type":"string","nullable":true,"description":"Recipient ID associated with the group"},"checkbox_ids":{"type":"array","items":{"type":"string"},"description":"IDs of checkboxes in this group"},"validation":{"$ref":"#/components/schemas/CheckboxValidation","nullable":true},"required":{"type":"boolean","description":"Whether at least one checkbox must be checked"},"min_value":{"type":"integer","description":"Minimum number of checkboxes to check"},"max_value":{"type":"integer","description":"Maximum number of checkboxes to check"},"exact_value":{"type":"integer","description":"Exact number of checkboxes that must be checked"}},"required":["id","checkbox_ids","required"]},"AttachmentRequestInfo":{"type":"object","description":"Attachment request information","properties":{"name":{"type":"string","description":"Name of the attachment request"},"url":{"type":"string","format":"url","description":"URL of the uploaded attachment (when available)"},"required":{"type":"boolean","description":"Whether the attachment is required"}},"required":["name","required"]},"ConditionalRuleRequest":{"type":"object","description":"A conditional logic rule. Create requires target_id, action_type, action_field_ids and conditions; id and deleted are ignored on create. On an update (template update or document update-and-send) the rules are an incremental upsert keyed by id: send id + the fields to change to modify a rule, id + deleted: true to remove it, or omit id to add a new rule.","properties":{"id":{"type":"string","description":"The rule's persistent ID. Ignored on create (every rule is new). On an update (template update or document update-and-send) include it to modify an existing rule, or pair it with `deleted: true` to remove the rule; omit it to add a new rule."},"deleted":{"type":"boolean","description":"Only meaningful on an update (template update or document update-and-send): set to true together with the rule's `id` to remove that rule. Ignored on create — there is no existing rule to delete."},"target_id":{"type":"string","description":"api_id of the field that owns the rule, or the external_id of a checkbox group when the rule is owned by a group (groups have no api_id). Cannot also appear in action_field_ids (self-reference is forbidden)."},"action_type":{"type":"string","enum":["show","hide","require"],"description":"Action applied to action_field_ids when the conditions are met: `show`, `hide`, or `require`."},"action_field_ids":{"type":"array","items":{"type":"string"},"description":"api_ids of the fields the action applies to. List a checkbox group's member api_ids to target the whole group."},"conditions":{"type":"array","description":"The conditions that trigger the rule. At least 1, at most 5.","items":{"type":"object","properties":{"condition_type":{"type":"string","enum":["any_of","all_of","none_of","not_all_of"],"description":"How the field_api_ids combine within a condition: `any_of`, `all_of`, `none_of`, or `not_all_of`."},"status":{"type":"string","enum":["completed","not_completed"],"description":"The field state the condition tests for: `completed` or `not_completed`."},"join_operator":{"type":"string","enum":["and_operator","or_operator"],"description":"How this condition joins the next one in the rule: `and_operator` or `or_operator`. The first condition's value is ignored."},"field_api_ids":{"type":"array","items":{"type":"string"},"description":"api_ids of the trigger fields the condition watches."},"position":{"type":"integer","description":"1-indexed order of the condition within the rule."}},"required":["condition_type","status","field_api_ids"]}}}},"ConditionalRuleInfo":{"type":"object","description":"Conditional rule configuration","properties":{"id":{"type":"string","description":"Conditional rule ID"},"target_id":{"type":"string","description":"api_id of the field that owns the rule, or the external_id of a checkbox group when the rule is owned by a group (groups have no api_id)"},"action_type":{"type":"string","enum":["show","hide","require"],"description":"Action applied to action_field_ids when the conditions are met"},"action_field_ids":{"type":"array","items":{"type":"string"},"description":"api_ids of fields the rule affects when triggered"},"conditions":{"type":"array","items":{"type":"object","properties":{"condition_type":{"type":"string","enum":["any_of","all_of","none_of","not_all_of"],"description":"How field_api_ids combine within this condition"},"status":{"type":"string","enum":["completed","not_completed"],"description":"Field state that satisfies this condition"},"join_operator":{"type":"string","enum":["and_operator","or_operator"],"description":"How this condition joins with the next one in the rule"},"field_api_ids":{"type":"array","items":{"type":"string"},"description":"api_ids of fields evaluated by this condition"},"position":{"type":"integer","description":"Order of this condition within the rule"}}}}},"required":["id","target_id","action_type"]},"ConditionalLogicDecisionInfo":{"type":"object","description":"Audit record of a signer-side decision about a CL rule that fired against a completed field.","properties":{"rule_id":{"type":"string","description":"External ID of the conditional rule that fired"},"field_api_id":{"type":"string","description":"api_id of the field the decision applies to"},"decision_type":{"type":"string","enum":["kept_signature","cleared_value"],"description":"Whether the signer kept the existing signature or the value was cleared"},"decided_at":{"type":"string","format":"date-time","description":"When the decision was recorded"},"description":{"type":"string","description":"Human-readable summary of the decision"}},"required":["rule_id","field_api_id","decision_type","decided_at"]},"AdditionalFields":{"type":"array","description":"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 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.","items":{"type":"array","description":"Array of Fields you're adding to each file.","items":{"type":"object","properties":{"x":{"type":"number","format":"float","description":"Horizontal value in the coordinates of the field (in pixels). Coordinates are specific to the page where fields are located."},"y":{"type":"number","format":"float","description":"Vertical value in the coordinates of the field (in pixels). Coordinates are specific to the page where fields are located."},"page":{"type":"integer","description":"The page number within the file. If the page does not exist within the file then the field won't be created."},"recipient_id":{"type":"string","description":"Unique identifier of the recipient assigned to the field. Recipients assigned to fields will be the only ones that will see and be able to complete those fields."},"type":{"$ref":"#/components/schemas/FieldType","description":"Field type of the field. Valid field types: initials, signatures, checkbox, date, and text. To autofill fields with contact data, use an autofill field type. To group checkbox fields, enter an api_id for each checkbox and add the checkbox_groups parameter."},"required":{"type":"boolean","default":true,"description":"Whether the field must be completed by the recipient. Defaults to `true` except for checkbox type fields."},"label":{"type":"string","description":"Text and Date fields only: label that is displayed when the field is empty."},"value":{"oneOf":[{"type":"string"},{"type":"boolean"},{"type":"number"}],"description":"Varies according to the field type. Text fields accept strings or numbers. Date fields accept Iso8601 date strings. CheckBoxes accept booleans. Signature and Initials fields can't be signed through API requests. Autofill text fields accept strings or numbers."},"api_id":{"type":"string","description":"Unique identifier of the field. Useful when needing to reference specific field values or update a document and its fields."},"name":{"type":"string","description":"Checkbox fields only. At least 2 checkbox fields in an array of fields must be assigned to the same recipient and grouped with selection requirements."},"validation":{"$ref":"#/components/schemas/TextValidation","description":"Text fields only: optional validation for field values. Valid values: numbers, letters, email_address, us_phone_number, us_zip_code, us_ssn, us_age, alphanumeric, us_bank_routing_number, us_bank_account_number, custom. To set custom validation, enter a regex pattern and regex error message."},"validation_regex":{"$ref":"#/components/schemas/ValidationRegex"},"validation_regex_error_message":{"$ref":"#/components/schemas/ValidationRegexErrorMessage"},"fixed_width":{"type":"boolean","default":false,"description":"Text fields only: whether the field width will stay fixed and text will display in multiple lines, rather than one long line. If set to `false` the field width will automatically grow horizontally to fit text on one line. Defaults to `false`."},"lock_sign_date":{"type":"boolean","default":false,"description":"Date fields only: makes fields readonly and automatically populates with the date the recipient signed. Defaults to `false`."},"date_format":{"$ref":"#/components/schemas/DateFormat","description":"Date fields only: date format to use for the field. Valid values: MM/DD/YYYY, DD/MM/YYYY, YYYY/MM/DD, Month DD, YYYY, and MM/DD/YYYY hh:mm:ss a. Defaults to MM/DD/YYYY."},"formula":{"type":"string","description":"Date fields only (text field formulas coming soon): formulas are a way to prefill fields with calculated future or past dates. Addition, subtraction, and parentheses are allowed. Valid event dates are `created_date`, `sent_date`, and `signed_date`. Valid time periods are `day`, `days`, `week`, `weeks`, `month`, and `months`. Example: `formula: 'sent_date + 10 days'`. Use with `lock_sign_date` if you'd like to make the field readonly and prevent signers from choosing a different date."},"height":{"type":"number","format":"float","description":"Height of the field (in pixels). Maximum height varies by field type: Signature/Initials (200px), others (74px). When using text tags if the height is greater than the maximum height, the height will be set to the maximum height."},"width":{"type":"number","format":"float","description":"Width of the field (in pixels). For text fields, width will auto-grow unless `fixed_width` is true."},"options":{"type":"array","description":"Array of dropdown options (for dropdown/select fields only)","items":{"$ref":"#/components/schemas/DropdownOption"}},"default_option":{"type":"string","description":"Default selected option (for dropdown/select fields only)"},"allow_other":{"type":"boolean","description":"Whether to allow \"Other\" option with text input (for dropdown/select fields only)","default":false}},"required":["x","y","page","recipient_id","type"]}}},"AdditionalFiles":{"type":"array","items":{"type":"object","description":"Additional files to be appended to the document. Will not replace existing files from the template. 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, .docx, .jpg, .png, .ppt, .xls, .pages, and .txt.","properties":{"name":{"type":"string","description":"Name of the file that will be uploaded."},"file_url":{"type":"string","format":"url","description":"Publicly available URL of the file to be uploaded."},"file_base64":{"type":"string","format":"byte","description":"A RFC 4648 base64 string of the file to be uploaded."}},"required":["name"]}},"ApiApplicationId":{"type":"string","format":"uuid","description":"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"},"TemplateAttachmentRequests":{"type":"array","description":"Attachments that a recipient must upload to complete the signing process. Attachment requests are shown after all document fields have been completed.","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the requested attachment."},"placeholder_id":{"type":"string","description":"Unique identifier of the recipient that will view the attachment request."},"required":{"type":"boolean","default":true,"description":"Whether the recipient will need to upload the attachment to successfully complete/sign the document. Defaults to `true`."}},"required":["name","placeholder_id"]}},"AttachmentRequests":{"type":"array","description":"Attachments that a recipient must upload to complete the signing process. Attachment requests are shown after all document fields have been completed.","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the requested attachment."},"recipient_id":{"type":"string","description":"Unique identifier of the recipient that will view the attachment request."},"required":{"type":"boolean","default":true,"description":"Whether the recipient will need to upload the attachment to successfully complete/sign the document. Defaults to `true`."}},"required":["name","recipient_id"]}},"TemplateCheckboxGroups":{"type":"array","description":"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.","items":{"type":"object","properties":{"group_name":{"type":"string","description":"A unique identifier for the checkbox group."},"placeholder_id":{"type":"string","description":"The recipient ID associated with the checkbox group."},"checkbox_ids":{"type":"array","items":{"type":"string","description":"A unique identifier for each checkbox in a group. ID must match the api_id of the checkbox field."}},"validation":{"$ref":"#/components/schemas/CheckboxValidation","description":"Set requirements for the group of one or multiple selections by the recipient. Defaults to minimum. Validation values: minimum, maximum, exact, range."},"required":{"type":"boolean","default":false,"description":"Whether the group must be completed by the recipient. Defaults to false."},"min_value":{"type":"integer","description":"The minimum number of checkboxes that must be checked in the group. (Only for validation: minimum and range)"},"max_value":{"type":"integer","description":"The maximum number of checkboxes that can be checked in the group. (Only for validation: maximum and range)"},"exact_value":{"type":"integer","description":"The exact number of checkboxes that must be checked in the group. (Only for validation: exact)"}},"required":["group_name","placeholder_id","checkbox_ids"]}},"CheckboxGroups":{"type":"array","description":"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.","items":{"type":"object","properties":{"group_name":{"type":"string","description":"A unique identifier for the checkbox group."},"recipient_id":{"type":"string","description":"The recipient ID associated with the checkbox group."},"checkbox_ids":{"type":"array","items":{"type":"string","description":"A unique identifier for each checkbox in a group. ID must match the api_id of the checkbox field."}},"validation":{"$ref":"#/components/schemas/CheckboxValidation","description":"Set requirements for the group of one or multiple selections by the recipient. Defaults to minimum. Validation values: minimum, maximum, exact, range."},"required":{"type":"boolean","default":false,"description":"Whether the group must be completed by the recipient. Defaults to false."},"min_value":{"type":"integer","description":"The minimum number of checkboxes that must be checked in the group. (Only for validation: minimum and range)"},"max_value":{"type":"integer","description":"The maximum number of checkboxes that can be checked in the group. (Only for validation: maximum and range)"},"exact_value":{"type":"integer","description":"The exact number of checkboxes that must be checked in the group. (Only for validation: exact)"}},"required":["group_name","recipient_id","checkbox_ids"]}},"BulkSendCsv":{"type":"string","description":"A RFC 4648 base64 string of the template CSV file to be validated. While 21 CFR Part 11 is enabled, every recipient needs a name: the CSV must carry a name column next to each placeholder email column (for example `signer_name` alongside `signer_email`), and each row must fill that name in wherever it carries the matching email, otherwise it returns a 422. A row that leaves both the email and the name blank sends nothing to that placeholder, so no name is needed there."},"Base64Flag":{"type":"boolean","description":"When true, returns the CSV as a base64-encoded string in a JSON response instead of a binary file download."},"BulkSendCsvTemplateResponse":{"type":"object","description":"Base64-encoded CSV template","properties":{"data":{"type":"string","format":"byte","description":"Base64-encoded CSV content"}},"required":["data"]},"BulkSendId":{"type":"string","format":"uuid","description":"Unique identifier for a bulk send."},"BulkSendTemplateIds":{"type":"array","description":"Specify one or more templates to generate a single blank CSV file that will contain available columns for your recipient data. The template_ids[] parameter is an array of template IDs (e.g.,`/?template_ids[]=5a67dbd7-928a-4ea0-a7e2-e476a0eb045f&template_ids[]=d7315111-c671-4b15-8354-c9a19bbaefa0`). Each ID should be a separate parameter in the query string.","items":{"type":"string","format":"uuid"}},"CopiedContacts":{"type":"array","description":"Copied contacts are emailed the final document once it has been completed by all recipients.","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the copied contact."},"email":{"type":"string","format":"email","description":"Email for the copied contact."}},"required":["email"]}},"CopiedPlaceholders":{"type":"array","description":"Copied placeholders are emailed the final document once it has been completed by all recipients.","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the placeholder."},"preassigned_recipient_name":{"type":"string","description":"In some cases, it may be necessary to pre-fill the name and email for a placeholder because it will always be the same person for all documents created from this template. This sets the name. Every recipient on a 21 CFR Part 11 document needs a name, so leaving it unset means the name has to be supplied when the document is created."},"preassigned_recipient_email":{"type":"string","format":"email","description":"In some cases, it may be necessary to pre-fill the name and email for a placeholder because it will always be the same person for all documents created from this template. This sets the email."}},"required":["name"]}},"CompletedDocumentId":{"type":"string","format":"uuid","description":"Unique identifier for a completed document."},"DocumentId":{"type":"string","format":"uuid","description":"Unique identifier for a document."},"Recipients":{"type":"array","description":"Document recipients are people that must complete and/or sign a document.","items":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier that you will give to each recipient. We recommend numbering sequentially from 1 to X. IDs are required for associating recipients to fields and more."},"name":{"type":"string","description":"Name of the recipient. Required on 21 CFR Part 11 documents: a recipient without a name returns a 422."},"email":{"type":"string","format":"email","description":"Email address for the recipient. Required unless the recipient's `delivery_method` is `sms`.","example":"signer@example.com"},"passcode":{"type":"string","description":"If set, signers assigned with a passcode will be required to enter the passcode before they’re able to view and complete the document. On a 21 CFR Part 11 document SignWell generates the passcode, so a sender-defined passcode returns a 422."},"passcode_delivery":{"type":"object","description":"Passcode delivery settings. When enabled, the system delivers the passcode to the signer via email. Always on for 21 CFR Part 11 documents and cannot be disabled.","properties":{"enabled":{"type":"boolean","description":"Enable passcode delivery for this recipient. Cannot be set to `false` on a 21 CFR Part 11 document: it returns a 422."},"methods":{"type":"array","items":{"type":"string","enum":["email"]},"description":"Delivery methods for the passcode. Currently supports: email. Defaults to [\"email\"] when omitted."},"expire_after_access":{"type":"boolean","description":"When enabled, the passcode is cleared after successful authentication. If passcode_delivery is also enabled, a new passcode is auto-generated on the next send request. Otherwise the recipient will no longer need a passcode."}}},"subject":{"type":"string","description":"Email subject for the signature request that the recipient will see. Overrides the general subject for the document."},"message":{"type":"string","description":"Email message for the signature request that the recipient will see. Overrides the general message for the document."},"send_email":{"type":"boolean","default":false,"description":"Applies on when `embedded_signing` is `true`. By default, recipients are not notified through email to sign when doing embedded signing. Setting this to `true`  will send a notification email to the recipient. Default is `false`."},"send_email_delay":{"type":"integer","default":0,"description":"If `send_email` is `true` recipients will receive a new document notification immediately. In the case of embedded signing, you can delay this notification to only send if the document is not completed within a few minutes. The email notification will not go out if the document is completed before the delay time is over. Valid values are in minutes ranging from `0` to `60`. Defaults to `0`."},"delivery_method":{"type":"string","enum":["email","sms","email_and_sms"],"default":"email","description":"How the recipient is notified and receives the signing link: `email` (default), `sms`, or `email_and_sms`. SMS delivery is available only to workspaces that are eligible for SMS and have it enabled. `email` requires `email`, `sms` requires `phone_number`, and `email_and_sms` requires both. SMS content always uses fixed system templates; `subject` and `message` apply to email notifications only. A 21 CFR Part 11 document records one verified channel per recipient: `email` and `sms` are both accepted, while `email_and_sms` returns a 422."},"phone_number":{"type":"string","example":"+14155551234","description":"Recipient phone number in E.164 format (for example `+14155551234`). Required when `delivery_method` is `sms` or `email_and_sms`. Only phone numbers from the country codes currently enabled for SMS are accepted."},"send_sms":{"type":"boolean","default":false,"description":"Applies only when `embedded_signing` is `true` and the recipient's `delivery_method` includes SMS. By default, recipients are not notified through SMS when doing embedded signing. Setting this to `true` will send the SMS notification to the recipient. Default is `false`."},"send_sms_delay":{"type":"integer","default":0,"description":"If `send_sms` is `true` the recipient will receive the SMS notification immediately. In the case of embedded signing, you can delay this notification to only send if the document is not completed within a few minutes. The SMS will not go out if the document is completed before the delay time is over. Valid values are in minutes ranging from `0` to `60`. Defaults to `0`."}},"required":["id"]}},"Fields":{"type":"array","description":"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.","items":{"type":"array","description":"Array of Fields you're adding to each file.","items":{"type":"object","properties":{"x":{"type":"number","format":"float","description":"Horizontal value in the coordinates of the field (in pixels). Coordinates are specific to the page where fields are located."},"y":{"type":"number","format":"float","description":"Vertical value in the coordinates of the field (in pixels). Coordinates are specific to the page where fields are located."},"page":{"type":"integer","description":"The page number within the file. If the page does not exist within the file then the field won't be created."},"recipient_id":{"type":"string","description":"Unique identifier of the recipient assigned to the field. Recipients assigned to fields will be the only ones that will see and be able to complete those fields."},"type":{"$ref":"#/components/schemas/FieldType","description":"Field type of the field. Valid field types: initials, signatures, checkbox, date, and text. To autofill fields with contact data, use an autofill field type. To group checkbox fields, enter an api_id for each checkbox and add the checkbox_groups parameter."},"required":{"type":"boolean","default":true,"description":"Whether the field must be completed by the recipient. Defaults to `true` except for checkbox type fields."},"label":{"type":"string","description":"Text and Date fields only: label that is displayed when the field is empty."},"value":{"oneOf":[{"type":"string"},{"type":"boolean"},{"type":"number"}],"description":"Varies according to the field type. Text fields accept strings or numbers. Date fields accept Iso8601 date strings. CheckBoxes accept booleans. Signature and Initials fields can't be signed through API requests. Autofill text fields accept strings or numbers."},"api_id":{"type":"string","description":"Unique identifier of the field. Useful when needing to reference specific field values or update a document and its fields."},"name":{"type":"string","description":"Checkbox fields only. At least 2 checkbox fields in an array of fields must be assigned to the same recipient and grouped with selection requirements."},"validation":{"$ref":"#/components/schemas/TextValidation","description":"Text fields only: optional validation for field values. Valid values: numbers, letters, email_address, us_phone_number, us_zip_code, us_ssn, us_age, alphanumeric, us_bank_routing_number, us_bank_account_number, custom. To set custom validation, enter a regex pattern and regex error message."},"validation_regex":{"$ref":"#/components/schemas/ValidationRegex"},"validation_regex_error_message":{"$ref":"#/components/schemas/ValidationRegexErrorMessage"},"fixed_width":{"type":"boolean","default":false,"description":"Text fields only: whether the field width will stay fixed and text will display in multiple lines, rather than one long line. If set to `false` the field width will automatically grow horizontally to fit text on one line. Defaults to `false`."},"lock_sign_date":{"type":"boolean","default":false,"description":"Date fields only: makes fields readonly and automatically populates with the date the recipient signed. Defaults to `false`."},"date_format":{"$ref":"#/components/schemas/DateFormat","description":"Date fields only: date format to use for the field. Valid values: MM/DD/YYYY, DD/MM/YYYY, YYYY/MM/DD, Month DD, YYYY, and MM/DD/YYYY hh:mm:ss a. Defaults to MM/DD/YYYY."},"height":{"type":"number","format":"float","description":"Height of the field (in pixels). Maximum height varies by field type: Signature/Initials (200px), others (74px). When using text tags if the height is greater than the maximum height, the height will be set to the maximum height."},"width":{"type":"number","format":"float","description":"Width of the field (in pixels). For text fields, width will auto-grow unless `fixed_width` is true."},"options":{"type":"array","description":"Array of dropdown options (for dropdown/select fields only)","items":{"$ref":"#/components/schemas/DropdownOption"}},"default_option":{"type":"string","description":"Default selected option (for dropdown/select fields only)"},"allow_other":{"type":"boolean","description":"Whether to allow \"Other\" option with text input (for dropdown/select fields only)","default":false}},"required":["x","y","page","recipient_id","type"]}}},"TemplateFields":{"type":"array","description":"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.","items":{"type":"array","description":"Array of Fields you're adding to each file.","items":{"type":"object","properties":{"x":{"type":"number","format":"float","description":"Horizontal value in the coordinates of the field (in pixels). Coordinates are specific to the page where fields are located."},"y":{"type":"number","format":"float","description":"Vertical value in the coordinates of the field (in pixels). Coordinates are specific to the page where fields are located."},"page":{"type":"integer","description":"The page number within the file. If the page does not exist within the file then the field won't be created."},"placeholder_id":{"type":"string","description":"Unique identifier of the placeholder assigned to the field."},"type":{"$ref":"#/components/schemas/FieldType","description":"Field type of the field. Valid field types: initials, signatures, checkbox, date, and text. To autofill fields with contact data, use an autofill field type. To group checkbox fields, enter an api_id for each checkbox and add the checkbox_groups parameter."},"required":{"type":"boolean","default":true,"description":"Whether the field must be completed by the recipient. Defaults to `true` except for checkbox type fields."},"label":{"type":"string","description":"Text and Date fields only: label that is displayed when the field is empty."},"value":{"oneOf":[{"type":"string"},{"type":"boolean"},{"type":"number"}],"description":"Varies according to the field type. Text fields accept strings or numbers. Date fields accept Iso8601 date strings. CheckBoxes accept booleans. Signature and Initials fields can't be signed through API requests. Autofill text fields accept strings or numbers."},"api_id":{"type":"string","description":"Unique identifier of the field. Useful when needing to reference specific field values or update a document and its fields."},"name":{"type":"string","description":"Checkbox fields only. At least 2 checkbox fields in an array of fields must be assigned to the same recipient and grouped with selection requirements."},"validation":{"$ref":"#/components/schemas/TextValidation","description":"Text fields only: optional validation for field values. Valid values: numbers, letters, email_address, us_phone_number, us_zip_code, us_ssn, us_age, alphanumeric, us_bank_routing_number, us_bank_account_number, custom. To set custom validation, enter a regex pattern and regex error message."},"validation_regex":{"$ref":"#/components/schemas/ValidationRegex"},"validation_regex_error_message":{"$ref":"#/components/schemas/ValidationRegexErrorMessage"},"fixed_width":{"type":"boolean","default":false,"description":"Text fields only: whether the field width will stay fixed and text will display in multiple lines, rather than one long line. If set to `false` the field width will automatically grow horizontally to fit text on one line. Defaults to `false`."},"lock_sign_date":{"type":"boolean","default":false,"description":"Date fields only: makes fields readonly and automatically populates with the date the recipient signed. Defaults to `false`."},"date_format":{"$ref":"#/components/schemas/DateFormat","description":"Date fields only: date format to use for the field. Valid values: MM/DD/YYYY, DD/MM/YYYY, YYYY/MM/DD, Month DD, YYYY, and MM/DD/YYYY hh:mm:ss a. Defaults to MM/DD/YYYY."},"height":{"type":"number","format":"float","description":"Height of the field (in pixels). Maximum height varies by field type: Signature/Initials (200px), others (74px). When using text tags if the height is greater than the maximum height, the height will be set to the maximum height."},"width":{"type":"number","format":"float","description":"Width of the field (in pixels). For text fields, width will auto-grow unless `fixed_width` is true."},"options":{"type":"array","description":"Array of dropdown options (for dropdown/select fields only)","items":{"$ref":"#/components/schemas/DropdownOption"}},"default_option":{"type":"string","description":"Default selected option (for dropdown/select fields only)"},"allow_other":{"type":"boolean","description":"Whether to allow \"Other\" option with text input (for dropdown/select fields only)","default":false}},"required":["x","y","page","placeholder_id","type"]}}},"Files":{"type":"array","description":"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","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the file that will be uploaded."},"file_url":{"type":"string","format":"url","description":"Publicly available URL of the file to be uploaded."},"file_base64":{"type":"string","format":"byte","description":"A RFC 4648 base64 string of the file to be uploaded."}},"required":["name"]}},"Limit":{"type":"integer","minimum":1,"maximum":50,"default":10,"description":"The number of documents to fetch. Defaults to 10, max is 50."},"Page":{"type":"integer","minimum":1,"default":1,"description":"The page number for pagination. Defaults to the first page."},"Placeholders":{"type":"array","description":"Placeholders are generally job roles that must complete and/or sign the document. For example, a placeholder might be “Client” or “Legal Department”. When a document is created from the template, you assign a person to each placeholder.","items":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier that you will give to each placeholder. We recommend numbering sequentially from 1 to X. IDs are required for associating recipients to fields and more."},"name":{"type":"string","description":"Name of the placeholder."},"preassigned_recipient_name":{"type":"string","description":"In some cases, it may be necessary to pre-fill the name and email for a placeholder because it will always be the same person for all documents created from this template. This sets the name. Every recipient on a 21 CFR Part 11 document needs a name, so leaving it unset means the name has to be supplied when the document is created."},"preassigned_recipient_email":{"type":"string","format":"email","description":"In some cases, it may be necessary to pre-fill the name and email for a placeholder because it will always be the same person for all documents created from this template. This sets the email."},"passcode_delivery":{"type":"object","description":"Passcode delivery (OTP) settings for this placeholder. When enabled, documents created from this template inherit these settings for the corresponding recipient. While 21 CFR Part 11 is enabled for the workspace, a placeholder cannot disable passcode delivery: it returns a 422.","properties":{"enabled":{"type":"boolean","description":"Enable passcode delivery for this recipient. Cannot be set to `false` on a 21 CFR Part 11 document: it returns a 422."},"methods":{"type":"array","items":{"type":"string","enum":["email"]},"description":"Delivery methods for the passcode. Currently supports: email. Defaults to [\"email\"] when omitted."},"expire_after_access":{"type":"boolean","description":"Whether the passcode expires after the recipient accesses the document. Inherited by documents created from this template."}}}},"required":["id","name"]}},"ReminderRecipients":{"type":"array","description":"Optional list of recipients within the document to remind. If none are specified, all recipients that have not signed yet are reminded. Each recipient is reminded through their own delivery method: email-only recipients get a reminder email, SMS-only recipients get a reminder text, and email_and_sms recipients get both. If the workspace has insufficient SMS credit, only the SMS reminder is skipped and the sender is notified once; the email reminder (if applicable) still goes out.","items":{"type":"object","properties":{"name":{"type":"string","description":"Recipient's name (required if multiple recipients share the same email)."},"email":{"type":"string","format":"email","description":"Recipient's email address. Used to match the recipient to remind; not required for SMS-only recipients, who can be identified by name instead."}}}},"UpdateRecipients":{"type":"array","description":"List of recipients to update on the document.","items":{"type":"object","required":["id","name","email"],"properties":{"id":{"type":"string","description":"The recipient's unique identifier from the Get Document response."},"name":{"type":"string","description":"Updated name for the recipient."},"email":{"type":"string","format":"email","example":"jane@example.com","description":"Updated email address for the recipient."},"subject":{"type":"string","description":"Updated email subject for the signature request that this recipient will see."},"message":{"type":"string","description":"Updated email message for the signature request that this recipient will see."},"passcode":{"type":"string","description":"Updated passcode for the recipient. If set, the signer will be required to enter the passcode before viewing and completing the document. On a 21 CFR Part 11 document SignWell generates the passcode, so a sender-defined passcode returns a 422."},"passcode_delivery":{"type":"object","description":"Passcode delivery settings. Always on for 21 CFR Part 11 documents and cannot be disabled.","properties":{"enabled":{"type":"boolean","description":"Enable or disable passcode delivery. Cannot be set to `false` on a 21 CFR Part 11 document: it returns a 422."},"methods":{"type":"array","items":{"type":"string","enum":["email"]},"description":"Delivery methods. Defaults to [\"email\"]."},"expire_after_access":{"type":"boolean","description":"Clear passcode after successful authentication. If passcode_delivery is also enabled, a new passcode is auto-generated on the next send request. Otherwise the recipient will no longer need a passcode."}}}}}},"TemplateFieldValues":{"type":"array","description":"Fields of your template(s) that you can prepopulate with values. Signature and Initials fields cannot be signed through the API.","items":{"type":"object","properties":{"api_id":{"type":"string","description":"The API ID of the field in your template. This field is case sensitive."},"value":{"oneOf":[{"type":"string"},{"type":"boolean"},{"type":"number"}],"description":"TextField value must be a string or a number."}},"required":["api_id","value"]}},"TemplateId":{"type":"string","format":"uuid","description":"Unique identifier for a template. A template that carries a pre-applied signature or initials field cannot be used while 21 CFR Part 11 is enabled, which requires every signature to be signed by the recipient: it returns a 422."},"TemplateIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Unique identifiers for a list of templates. A template that carries a pre-applied signature or initials field cannot be used while 21 CFR Part 11 is enabled, which requires every signature to be signed by the recipient: it returns a 422."},"TemplateRecipients":{"type":"array","description":"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. Recipients will inherit all placeholder fields and settings.","items":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier that you will give to each recipient. We recommend numbering sequentially from 1 to X. IDs are required for associating recipients to fields and more."},"name":{"type":"string","description":"Name of the recipient. Required on 21 CFR Part 11 documents: a recipient without a name returns a 422."},"email":{"type":"string","format":"email","description":"Email address for the recipient. Required unless `delivery_method` is `sms`.","example":"signer@example.com"},"placeholder_name":{"type":"string","description":"The name of the placeholder you want this recipient assigned to."},"passcode":{"type":"string","description":"If set, signers assigned with a passcode will be required to enter the passcode before they’re able to view and complete the document. On a 21 CFR Part 11 document SignWell generates the passcode, so a sender-defined passcode returns a 422."},"passcode_delivery":{"type":"object","description":"Passcode delivery settings. When enabled, the system delivers the passcode to the signer via email. Always on for 21 CFR Part 11 documents and cannot be disabled.","properties":{"enabled":{"type":"boolean","description":"Enable passcode delivery for this recipient. Cannot be set to `false` on a 21 CFR Part 11 document: it returns a 422."},"methods":{"type":"array","items":{"type":"string","enum":["email"]},"description":"Delivery methods for the passcode. Currently supports: email. Defaults to [\"email\"] when omitted."},"expire_after_access":{"type":"boolean","description":"When enabled, the passcode is cleared after successful authentication. If passcode_delivery is also enabled, a new passcode is auto-generated on the next send request. Otherwise the recipient will no longer need a passcode."}}},"subject":{"type":"string","description":"Email subject for the signature request that the recipient will see. Overrides the general subject for the template."},"message":{"type":"string","description":"Email message for the signature request that the recipient will see. Overrides the general message for the template."},"send_email":{"type":"boolean","default":false,"description":"Applies on when `embedded_signing` is `true`. By default, recipients are not notified through email to sign when doing embedded signing. Setting this to `true`  will send a notification email to the recipient. Default is `false`."},"send_email_delay":{"type":"integer","default":0,"description":"If `send_email` is `true` recipients will receive a new document notification immediately. In the case of embedded signing, you can delay this notification to only send if the document is not completed within a few minutes. The email notification will not go out if the document is completed before the delay time is over. Valid values are in minutes ranging from `0` to `60`. Defaults to `0`."},"delivery_method":{"type":"string","enum":["email","sms","email_and_sms"],"default":"email","description":"How the recipient is notified and receives the signing link: `email` (default), `sms`, or `email_and_sms`. SMS delivery is available only to workspaces that are eligible for SMS and have it enabled. `email` requires `email`, `sms` requires `phone_number`, and `email_and_sms` requires both. SMS content always uses fixed system templates; `subject` and `message` apply to email notifications only. A 21 CFR Part 11 document records one verified channel per recipient: `email` and `sms` are both accepted, while `email_and_sms` returns a 422."},"phone_number":{"type":"string","example":"+14155551234","description":"Recipient phone number in E.164 format (for example `+14155551234`). Required when `delivery_method` is `sms` or `email_and_sms`. Only phone numbers from the country codes currently enabled for SMS are accepted."},"send_sms":{"type":"boolean","default":false,"description":"Applies only when `embedded_signing` is `true` and the recipient's `delivery_method` includes SMS. By default, recipients are not notified through SMS when doing embedded signing. Setting this to `true` will send the SMS notification to the recipient. Default is `false`."},"send_sms_delay":{"type":"integer","default":0,"description":"If `send_sms` is `true` the recipient will receive the SMS notification immediately. In the case of embedded signing, you can delay this notification to only send if the document is not completed within a few minutes. The SMS will not go out if the document is completed before the delay time is over. Valid values are in minutes ranging from `0` to `60`. Defaults to `0`."}},"required":["id"]}},"UrlOnly":{"type":"boolean","default":false,"description":"Whether to return the URL of the completed PDF or the actual PDF content. Defaults to `false`."},"ObjectOnly":{"type":"boolean","default":false,"description":"If true, returns raw NOM-151 constancia certificate object as JSON instead of a zip file or URL."},"TestModeHeader":{"type":"boolean","description":"Alternative to the `test_mode` body parameter. Set to `true` to enable Test Mode or `false` to disable it. Only lowercase `true` and `false` are supported. If both are provided, the header takes precedence.\n\nThis is a request header only and is not included in API responses."},"IncludeAuditPage":{"type":"boolean","default":true,"description":"Whether to include the audit page as part of the document. Defaults to `true`. Cannot be turned off on a 21 CFR Part 11 document: the audit page is part of the record and setting it to `false` returns a 422."},"FileFormat":{"type":"string","enum":["pdf","zip"],"description":"Format of the file to be downloaded. Supported formats are 'pdf' and 'zip'. `zip` is unavailable on a 21 CFR Part 11 document, whose completed PDF, E-Signature page and audit page stay together as one record."},"UserEmail":{"type":"string","format":"email","description":"The email address of the user that sent the Bulk Send. Must have the `admin` or `manager` role to view Bulk Sends of other users. Defaults to the user that the API key belongs to."},"Labels":{"type":"array","description":"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.","items":{"$ref":"#/components/schemas/LabelRequest"}},"LabelsUpdate":{"type":"array","description":"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. Updating labels on a document will replace any existing labels for that document.","items":{"$ref":"#/components/schemas/LabelRequest"}},"LabelsResponse":{"type":"array","description":"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. Updating labels on a document will replace any existing labels for that document.","items":{"$ref":"#/components/schemas/LabelResponse"}},"LabelResponse":{"type":"object","description":"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 be used to organize documents in a way that can make it easy to find using the document search in SignWell.","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["name"]},"LabelRequest":{"type":"object","description":"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 be used to organize documents in a way that can make it easy to find using the document search in SignWell.","properties":{"name":{"type":"string"}},"required":["name"]},"DropdownOption":{"oneOf":[{"type":"string","title":"SimpleOption","description":"Simple string option"},{"type":"object","title":"DetailedOption","description":"Detailed option object","properties":{"name":{"type":"string","description":"Option display name"},"api_id":{"type":"string","description":"Unique identifier for the option"},"is_other":{"type":"boolean","description":"Whether this is the special \"Other\" option","default":false}},"required":["name"]}],"description":"A dropdown option - either a simple string or a detailed object with name and optional api_id"},"AccountUpdateRequest":{"type":"object","description":"Only the fields included in the request are changed","properties":{"name":{"type":"string","description":"The name of the account.","example":"Acme Corp"},"logo":{"type":"string","description":"Logo shown in signature request emails and on the signing page. Provide a base64-encoded PNG or JPG (a data URI is accepted), or a publicly accessible URL. The decoded image must be smaller than 300 KB.","example":"https://acme.example/logo.png"},"time_zone":{"type":"string","description":"Time zone used for dates in the audit trail. Accepts the IANA time zone names SignWell supports (e.g. `America/New_York`) — a subset of the IANA database, so a few newer aliases are rejected: send `Europe/Kiev`, not `Europe/Kyiv`. Defaults to `UTC`.","example":"America/New_York"},"date_format":{"type":"string","enum":["MM/DD/YYYY","DD/MM/YYYY","YYYY/MM/DD","Month DD, YYYY","MM/DD/YYYY hh:mm:ss a"],"description":"Default 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. Defaults to MM/DD/YYYY.","example":"MM/DD/YYYY"},"recipient_language":{"type":"string","nullable":true,"enum":["en","fr","es","de","pl","pt","da","nl","it","ru","sv","ar","el","tr","sk",null],"description":"Default language for recipient emails and the signing page. Valid values: en, fr, es, de, pl, pt, da, nl, it, ru, sv, ar, el, tr, sk. Set to null to use the default (English).","example":"en"}}},"CreateBulkSendRequest":{"type":"object","properties":{"template_ids":{"type":"array","items":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"description":"Unique identifiers for a list of templates. A template that carries a pre-applied signature or initials field cannot be used while 21 CFR Part 11 is enabled, which requires every signature to be signed by the recipient: it returns a 422."},"bulk_send_csv":{"type":"string","description":"A RFC 4648 base64 string of the template CSV file to be validated. While 21 CFR Part 11 is enabled, every recipient needs a name: the CSV must carry a name column next to each placeholder email column (for example `signer_name` alongside `signer_email`), and each row must fill that name in wherever it carries the matching email, otherwise it returns a 422. A row that leaves both the email and the name blank sends nothing to that placeholder, so no name is needed there.","example":"bmFtZSxlbWFpbApUZXN0LHRlc3RAZXhhbXBsZS5jb20K"},"skip_row_errors":{"type":"boolean","default":false,"description":"Whether to skip errors in the rows. Defaults to `false`."},"api_application_id":{"type":"string","format":"uuid","description":"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"},"name":{"type":"string","description":"The name of the Bulk Send. Will be used as the document name for each of the documents."},"subject":{"type":"string","description":"Email subject for the signature request that recipients will see. Defaults to the default system subject or a template subject."},"message":{"type":"string","description":"Email message for the signature request that recipients will see. Defaults to the default system message or a template message."},"apply_signing_order":{"type":"boolean","default":false,"description":"When set to `true` recipients will sign one at a time in the order of the `recipients` collection of this request."},"custom_requester_name":{"type":"string","description":"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."},"custom_requester_email":{"type":"string","format":"email","description":"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."}},"required":["template_ids","bulk_send_csv"]},"BulkSendCsvRequest":{"type":"object","properties":{"template_ids":{"type":"array","description":"Specify one or more templates to generate a single blank CSV file that will contain available columns for your recipient data. The template_ids[] parameter is an array of template IDs (e.g.,`/?template_ids[]=5a67dbd7-928a-4ea0-a7e2-e476a0eb045f&template_ids[]=d7315111-c671-4b15-8354-c9a19bbaefa0`). Each ID should be a separate parameter in the query string.","items":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}},"bulk_send_csv":{"type":"string","description":"A RFC 4648 base64 string of the template CSV file to be validated. While 21 CFR Part 11 is enabled, every recipient needs a name: the CSV must carry a name column next to each placeholder email column (for example `signer_name` alongside `signer_email`), and each row must fill that name in wherever it carries the matching email, otherwise it returns a 422. A row that leaves both the email and the name blank sends nothing to that placeholder, so no name is needed there.","example":"bmFtZSxlbWFpbApUZXN0LHRlc3RAZXhhbXBsZS5jb20K"}},"required":["template_ids","bulk_send_csv"]},"DocumentRequest":{"type":"object","properties":{"test_mode":{"type":"boolean","default":false,"description":"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`"},"files":{"$ref":"#/components/schemas/Files"},"name":{"type":"string","description":"The name of the document."},"subject":{"type":"string","description":"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."},"message":{"type":"string","description":"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":{"$ref":"#/components/schemas/Recipients"},"draft":{"type":"boolean","default":false,"description":"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`."},"self_sign":{"type":"boolean","default":false,"description":"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. Unavailable on 21 CFR Part 11 documents, which require every signature to come from an authenticated signer: sending `true` returns a 422."},"with_signature_page":{"type":"boolean","default":false,"description":"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."},"expires_in":{"type":"integer","minimum":1,"description":"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)."},"reminders":{"type":"boolean","default":true,"description":"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`."},"apply_signing_order":{"type":"boolean","default":false,"description":"When set to `true` recipients will sign one at a time in the order of the `recipients` collection of this request."},"api_application_id":{"type":"string","format":"uuid","description":"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"},"embedded_signing":{"type":"boolean","default":false,"description":"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`."},"embedded_signing_notifications":{"type":"boolean","default":false,"description":"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`"},"embedded":{"$ref":"#/components/schemas/EmbeddedRequest"},"text_tags":{"type":"boolean","default":false,"description":"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."},"custom_requester_name":{"type":"string","description":"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."},"custom_requester_email":{"type":"string","format":"email","description":"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."},"redirect_url":{"type":"string","format":"url","description":"A URL that recipients are redirected to after successfully signing a document."},"allow_decline":{"type":"boolean","default":true,"description":"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."},"allow_reassign":{"type":"boolean","default":true,"description":"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. Unavailable on 21 CFR Part 11 documents: omit it and reassignment stays off, while sending `true` returns a 422."},"decline_redirect_url":{"type":"string","format":"url","description":"A URL that recipients are redirected to if the document is declined."},"language":{"type":"string","description":"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":{"type":"array","items":{"$ref":"#/components/schemas/ConditionalRuleRequest"},"description":"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."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Optional key-value data that can be associated with the document. If set, will be available every time the document data is returned."},"fields":{"$ref":"#/components/schemas/Fields"},"attachment_requests":{"$ref":"#/components/schemas/AttachmentRequests"},"copied_contacts":{"$ref":"#/components/schemas/CopiedContacts"},"labels":{"$ref":"#/components/schemas/Labels"},"checkbox_groups":{"$ref":"#/components/schemas/CheckboxGroups"},"sms_test_email":{"type":"boolean","default":false,"description":"Only applies when `test_mode` is `true`. When `true` and an SMS notification is scheduled for an SMS-only recipient, sends the document owner a preview email with a masked phone number. In embedded signing, the recipient's `send_sms` must be `true` to schedule that notification. Test mode delivers no SMS and uses no SMS credits. On newly created documents this setting defaults to `false`; omitting it in Update and Send preserves the stored setting."}},"required":["files","recipients"]},"DocumentFromTemplateRequest":{"type":"object","properties":{"test_mode":{"type":"boolean","default":false,"description":"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`"},"template_id":{"type":"string","format":"uuid","description":"Use when you have to create a document from a single template. Either :template_id or :template_ids must be present in the request, not both."},"template_ids":{"type":"array","description":"Use when you have to create a document from multiple templates. Either :template_id or :template_ids must be present in the request, not both.","items":{"type":"string"}},"name":{"type":"string","description":"The name of the document."},"subject":{"type":"string","description":"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."},"message":{"type":"string","description":"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":{"$ref":"#/components/schemas/TemplateRecipients"},"exclude_placeholders":{"type":"array","description":"Exclude one or more template placeholders when creating a document from a template. Any excluded placeholders (and their associated recipients and fields) will not be included on the created document. Values must match placeholder names on the template. You can't exclude all placeholders (at least one recipient must remain).","items":{"type":"string"}},"draft":{"type":"boolean","default":false,"description":"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`."},"with_signature_page":{"type":"boolean","default":false,"description":"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."},"expires_in":{"type":"integer","minimum":1,"description":"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)."},"reminders":{"type":"boolean","default":true,"description":"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`."},"apply_signing_order":{"type":"boolean","default":false,"description":"When set to `true` recipients will sign one at a time in the order of the `recipients` collection of this request."},"api_application_id":{"type":"string","format":"uuid","description":"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"},"embedded_signing":{"type":"boolean","default":false,"description":"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`."},"embedded_signing_notifications":{"type":"boolean","default":false,"description":"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`"},"embedded":{"$ref":"#/components/schemas/EmbeddedRequest"},"text_tags":{"type":"boolean","default":false,"description":"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."},"custom_requester_name":{"type":"string","description":"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."},"custom_requester_email":{"type":"string","format":"email","description":"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."},"redirect_url":{"type":"string","format":"url","description":"A URL that recipients are redirected to after successfully signing a document."},"allow_decline":{"type":"boolean","default":true,"description":"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."},"allow_reassign":{"type":"boolean","default":true,"description":"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. Unavailable on 21 CFR Part 11 documents: omit it and reassignment stays off, while sending `true` returns a 422."},"decline_redirect_url":{"type":"string","format":"url","description":"A URL that recipients are redirected to if the document is declined."},"language":{"type":"string","description":"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":{"type":"array","items":{"$ref":"#/components/schemas/ConditionalRuleRequest"},"description":"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_mode":{"type":"string","enum":["replace","append","none"],"description":"When creating a document from a template, controls how the conditional_rules in the request reconcile with the template's inherited rules: `replace` (drop inherited, use the body's rules), `append` (keep inherited, add the body's rules), or `none` (clear all rules). Required when sending conditional_rules that should not simply inherit."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Optional key-value data that can be associated with the document. If set, will be available every time the document data is returned."},"template_fields":{"$ref":"#/components/schemas/TemplateFieldValues"},"files":{"$ref":"#/components/schemas/AdditionalFiles"},"fields":{"$ref":"#/components/schemas/AdditionalFields"},"attachment_requests":{"$ref":"#/components/schemas/AttachmentRequests"},"copied_contacts":{"$ref":"#/components/schemas/CopiedContacts"},"labels":{"$ref":"#/components/schemas/LabelsUpdate"},"checkbox_groups":{"$ref":"#/components/schemas/CheckboxGroups"},"sms_test_email":{"type":"boolean","default":false,"description":"Only applies when `test_mode` is `true`. When `true` and an SMS notification is scheduled for an SMS-only recipient, sends the document owner a preview email with a masked phone number. In embedded signing, the recipient's `send_sms` must be `true` to schedule that notification. Test mode delivers no SMS and uses no SMS credits. On newly created documents this setting defaults to `false`; omitting it in Update and Send preserves the stored setting."}},"required":["recipients"]},"UpdateDocumentAndSendRequest":{"type":"object","properties":{"test_mode":{"type":"boolean","default":false,"description":"Set to `true` to enable Test Mode. Documents sent in Test Mode do not count towards API billing and are not legally binding. Defaults to `false`.\n\nTest Mode does not carry over from the draft. To send a draft in Test Mode, set `test_mode` to `true` or use the `X-TestMode-Enabled` header. Otherwise, the document is sent live."},"name":{"type":"string","description":"The name of the document."},"subject":{"type":"string","description":"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."},"message":{"type":"string","description":"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."},"expires_in":{"type":"integer","minimum":1,"description":"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)."},"reminders":{"type":"boolean","default":true,"description":"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`."},"apply_signing_order":{"type":"boolean","default":false,"description":"When set to `true` recipients will sign one at a time in the order of the `recipients` collection of this request."},"api_application_id":{"type":"string","format":"uuid","description":"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"},"embedded_signing":{"type":"boolean","default":false,"description":"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`."},"embedded_signing_notifications":{"type":"boolean","default":false,"description":"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`"},"embedded":{"$ref":"#/components/schemas/EmbeddedRequest"},"custom_requester_name":{"type":"string","description":"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."},"custom_requester_email":{"type":"string","format":"email","description":"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."},"redirect_url":{"type":"string","format":"url","description":"A URL that recipients are redirected to after successfully signing a document."},"allow_decline":{"type":"boolean","default":true,"description":"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."},"allow_reassign":{"type":"boolean","default":true,"description":"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. Unavailable on 21 CFR Part 11 documents: omit it and reassignment stays off, while sending `true` returns a 422."},"decline_redirect_url":{"type":"string","format":"url","description":"A URL that recipients are redirected to if the document is declined."},"conditional_rules":{"type":"array","items":{"$ref":"#/components/schemas/ConditionalRuleRequest"},"description":"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."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Optional key-value data that can be associated with the document. If set, will be available every time the document data is returned."},"labels":{"$ref":"#/components/schemas/LabelsUpdate"},"checkbox_groups":{"$ref":"#/components/schemas/CheckboxGroups"},"sms_test_email":{"type":"boolean","description":"Only applies when `test_mode` is `true`. When `true` and an SMS notification is scheduled for an SMS-only recipient, sends the document owner a preview email with a masked phone number. In embedded signing, the recipient's `send_sms` must be `true` to schedule that notification. Test mode delivers no SMS and uses no SMS credits. On newly created documents this setting defaults to `false`; omitting it in Update and Send preserves the stored setting."}}},"SendReminderRequest":{"type":"object","properties":{"recipients":{"$ref":"#/components/schemas/ReminderRecipients"}}},"UpdateRecipientsRequest":{"type":"object","properties":{"recipients":{"$ref":"#/components/schemas/UpdateRecipients"}},"required":["recipients"]},"UpdateAuthenticationRequest":{"type":"object","properties":{"recipients":{"type":"array","description":"Recipients whose authentication settings should be updated.","items":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier that you will give to each recipient. We recommend numbering sequentially from 1 to X. IDs are required for associating recipients to fields and more."},"passcode":{"type":"string","description":"Updated passcode for the recipient. If set, the signer will be required to enter the passcode before viewing and completing the document. On a 21 CFR Part 11 document SignWell generates the passcode, so a sender-defined passcode returns a 422."},"passcode_delivery":{"type":"object","description":"Passcode delivery settings. Always on for 21 CFR Part 11 documents and cannot be disabled.","properties":{"enabled":{"type":"boolean","description":"Enable or disable passcode delivery. Cannot be set to `false` on a 21 CFR Part 11 document: it returns a 422."},"methods":{"type":"array","items":{"type":"string","enum":["email"]},"description":"Delivery methods. Defaults to [\"email\"]."},"expire_after_access":{"type":"boolean","description":"Clear passcode after successful authentication. If passcode_delivery is also enabled, a new passcode is auto-generated on the next send request. Otherwise the recipient will no longer need a passcode."}}}},"required":["id"]}}},"required":["recipients"]},"DocumentTemplateRequest":{"type":"object","properties":{"files":{"$ref":"#/components/schemas/Files"},"name":{"type":"string","description":"The name of the template."},"subject":{"type":"string","description":"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."},"message":{"type":"string","description":"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."},"placeholders":{"$ref":"#/components/schemas/Placeholders"},"copied_placeholders":{"$ref":"#/components/schemas/CopiedPlaceholders"},"draft":{"type":"boolean","default":false,"description":"Whether the template can still be updated before it is ready for usage. If set to `false` the template is marked as `Available` and it will be ready for use. Defaults to `false`."},"expires_in":{"type":"integer","minimum":1,"description":"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)."},"reminders":{"type":"boolean","default":true,"description":"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`."},"apply_signing_order":{"type":"boolean","default":false,"description":"When set to `true` recipients will sign one at a time in the order of the `recipients` collection of this request."},"api_application_id":{"type":"string","format":"uuid","description":"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"},"text_tags":{"type":"boolean","default":false,"description":"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."},"redirect_url":{"type":"string","format":"url","description":"A URL that recipients are redirected to after successfully signing a document."},"allow_decline":{"type":"boolean","default":true,"description":"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."},"allow_reassign":{"type":"boolean","default":true,"description":"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. Unavailable on 21 CFR Part 11 documents: omit it and reassignment stays off, while sending `true` returns a 422."},"decline_redirect_url":{"type":"string","format":"url","description":"A URL that recipients are redirected to if the document is declined."},"language":{"type":"string","description":"Sets the language for the template and documents created from the template for 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. 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":{"type":"array","items":{"$ref":"#/components/schemas/ConditionalRuleRequest"},"description":"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."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Optional key-value data that can be associated with the document. If set, will be available every time the document data is returned."},"fields":{"$ref":"#/components/schemas/TemplateFields"},"attachment_requests":{"$ref":"#/components/schemas/TemplateAttachmentRequests"},"labels":{"$ref":"#/components/schemas/Labels"},"checkbox_groups":{"$ref":"#/components/schemas/TemplateCheckboxGroups"}},"required":["files","placeholders"]},"DocumentTemplateUpdateRequest":{"type":"object","properties":{"name":{"type":"string","description":"The name of the template."},"subject":{"type":"string","description":"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."},"message":{"type":"string","description":"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."},"draft":{"type":"boolean","default":false,"description":"Whether the template can still be updated before it is ready for usage. If set to `false` the template is marked as `Available` and it will be ready for use. Defaults to `false`."},"expires_in":{"type":"integer","minimum":1,"description":"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)."},"reminders":{"type":"boolean","default":true,"description":"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`."},"apply_signing_order":{"type":"boolean","default":false,"description":"When set to `true` recipients will sign one at a time in the order of the `recipients` collection of this request."},"api_application_id":{"type":"string","format":"uuid","description":"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"},"redirect_url":{"type":"string","format":"url","description":"A URL that recipients are redirected to after successfully signing a document."},"allow_decline":{"type":"boolean","default":true,"description":"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."},"allow_reassign":{"type":"boolean","default":true,"description":"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. Unavailable on 21 CFR Part 11 documents: omit it and reassignment stays off, while sending `true` returns a 422."},"decline_redirect_url":{"type":"string","format":"url","description":"A URL that recipients are redirected to if the document is declined."},"conditional_rules":{"type":"array","items":{"$ref":"#/components/schemas/ConditionalRuleRequest"},"description":"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."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Optional key-value data that can be associated with the document. If set, will be available every time the document data is returned."},"labels":{"$ref":"#/components/schemas/LabelsUpdate"},"checkbox_groups":{"$ref":"#/components/schemas/TemplateCheckboxGroups"}}},"CompletedPdfResponse":{"oneOf":[{"$ref":"#/components/schemas/JSON"},{"$ref":"#/components/schemas/PDF"},{"$ref":"#/components/schemas/ZIP"}]},"Nom151CertificateResponse":{"type":"object","description":"NOM-151 certificate data returned when object_only=true","properties":{"nom151":{"type":"object","properties":{"status":{"type":"string","description":"Certificate status (pending, issued, failed)"},"transactionId":{"type":"string","description":"RSA signature / Transaction ID"},"hash":{"type":"string","description":"Document digest (SHA-256 hash)"},"folio":{"type":"string","description":"Certificate number / Folio"},"issuedAt":{"type":"string","format":"date-time","description":"Certificate issuance timestamp"},"provider":{"type":"string","description":"Certificate provider (e.g., SeguriData)"},"validationUrl":{"type":"string","format":"url","description":"URL to validate the certificate"},"constancia":{"type":"string","description":"Base64-encoded certificate file"}},"required":["status","transactionId","hash","folio","issuedAt","provider","validationUrl","constancia"]}},"required":["nom151"]},"Nom151UrlResponse":{"type":"object","description":"NOM-151 download URL returned when url_only=true","properties":{"file_url":{"type":"string","format":"url","description":"Public URL to download the certificate ZIP file"}},"required":["file_url"]},"EmbeddedBrandingRequest":{"type":"object","nullable":true,"description":"Branding for this document's embedded requesting and signing experiences. Every property is optional and independent. A property you supply overrides the selected API Application; one you omit inherits from it, then from the SignWell default. `company_logo` has one extra step between those two: the account's Settings > Branding logo, which applies on paid plans only. The colors and the border radius have no account step — omitting one falls straight through to the SignWell default. On Update and Send Document the object is a patch: only the properties you send change, and a property sent as `null` clears your override so the value inherits again. Sending `branding` itself as `null` clears every property.","properties":{"company_logo":{"type":"object","nullable":true,"description":"Logo shown on this document's embedded pages. Supply either `file_url` or `file_base64`, never both — sending both returns a `422`. Sending `company_logo` replaces the logo outright, so whichever source you omit is cleared; sending it as `null` removes the logo. Recommended size is 300 x 60 px with a transparent background; these are recommendations, not validated. In responses this property is `\"provided\"` — the URL and the Base64 payload are never returned.","properties":{"file_url":{"type":"string","description":"Public `http` or `https` URL of the logo image. The value has to parse as one — anything else returns a `422`. SignWell never requests the URL when the document is created, so it is not checked for reachability or for what it points at. If the URL turns out to be unreachable, slow, or not a usable image when the page loads, the page falls back to the no-logo experience rather than erroring.","example":"https://example.com/customer-logo.png"},"file_base64":{"type":"string","description":"RFC 4648 Base64 string of the logo image. The 300 KB limit applies to the decoded image, not to the string you send, so a valid string runs about a third larger. The decoded image must be one of image/jpeg, image/png, image/gif, image/tiff, image/webp, image/svg+xml, image/heic, image/heif, image/avif. A payload that cannot be decoded, is not one of those formats, or is over the size limit returns a `422`. A payload that is accepted here but still fails to render when the page loads falls back to the no-logo experience."}}},"accent_color":{"type":"string","nullable":true,"description":"Accent color for this document's embedded pages, as a 6-digit HEX value. Returned normalized to `#RRGGBB`.","example":"#51B6C4"},"button_label_color":{"type":"string","nullable":true,"description":"Button label color for this document's embedded pages, as a 6-digit HEX value. Returned normalized to `#RRGGBB`.","example":"#FFFFFF"},"link_color":{"type":"string","nullable":true,"description":"Link color for this document's embedded pages, as a 6-digit HEX value. Returned normalized to `#RRGGBB`.","example":"#1A0DAB"},"button_border_radius":{"type":"integer","nullable":true,"minimum":0,"maximum":25,"description":"Corner radius of buttons on this document's embedded pages, in pixels. Must be between 0 and 25.","example":25}}},"EmbeddedRequest":{"type":"object","description":"Optional container for embedded settings. Purely additive: requests that omit it behave exactly as before, and the existing top-level `api_application_id`, `embedded_signing` and `embedded_signing_notifications` parameters are unchanged. Not supported on template endpoints, which return a `422` if it is present.","properties":{"branding":{"$ref":"#/components/schemas/EmbeddedBrandingRequest"}}},"EmbeddedBranding":{"type":"object","nullable":true,"description":"The branding the caller set on THIS document, echoed back. Null when the caller set none: the document then renders with the API Application, workspace or system branding, and that resolved branding is deliberately not reported here.","properties":{"branding":{"type":"object","description":"Only the properties actually set on the document. Every one is optional: an unset property is absent rather than null, because null is how a request clears one.","properties":{"company_logo":{"type":"string","enum":["provided"],"description":"Write-only. Reports only that a logo was set, never its URL or Base64 payload."},"accent_color":{"type":"string","description":"Hex, as #RRGGBB."},"button_label_color":{"type":"string","description":"Hex, as #RRGGBB."},"link_color":{"type":"string","description":"Hex, as #RRGGBB."},"button_border_radius":{"type":"integer","description":"Pixels, 0 to 25."}}}},"required":["branding"]},"DocumentResponse":{"type":"object","properties":{"cfr_part11":{"type":"boolean","description":"Whether 21 CFR Part 11 controls apply to this document. Read-only: the value is taken from the workspace setting when the document is created and never changes afterwards."},"cfr_part11_signing_mode":{"type":"string","enum":["streamlined","per_signature"],"nullable":true,"description":"The signing mode of a 21 CFR Part 11 document: streamlined (one final authentication) or per_signature (authentication at every signature and initials field). Null when Part 11 does not apply."},"test_mode":{"type":"boolean"},"id":{"type":"string"},"api_application_id":{"type":"string","format":"uuid","nullable":true},"requester_email_address":{"type":"string","format":"email"},"custom_requester_name":{"type":"string","nullable":true},"custom_requester_email":{"type":"string","format":"email","nullable":true},"name":{"type":"string"},"subject":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"recipients":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"body":{"type":"string"},"message":{"type":"string","nullable":true},"subject":{"type":"string","nullable":true},"send_email":{"type":"boolean","nullable":true},"send_email_delay":{"type":"integer","nullable":true},"delivery_method":{"type":"string","enum":["email","sms","email_and_sms"],"description":"How the recipient is notified: email (default), sms, or email_and_sms."},"sms":{"type":"object","description":"SMS delivery metadata. Only present when delivery_method includes SMS.","properties":{"phone_number_masked":{"type":"string","nullable":true,"description":"Masked phone number; the full number never leaves the API."},"send_sms":{"type":"boolean","nullable":true},"send_sms_delay":{"type":"integer","nullable":true},"delivery_status":{"type":"string","nullable":true},"message_type":{"type":"string","nullable":true},"failed":{"type":"boolean","nullable":true},"failed_details":{"type":"string","nullable":true}}},"signing_order":{"type":"integer"},"signing_url":{"type":"string","format":"url","nullable":true},"embedded_signing_url":{"type":"string","format":"url","nullable":true},"bounced":{"type":"boolean","nullable":true},"bounced_details":{"type":"string","nullable":true},"attachment_requests":{"type":"array","items":{"$ref":"#/components/schemas/AttachmentRequestInfo"}},"passcode":{"type":"string","nullable":true},"passcode_delivery":{"type":"object","properties":{"enabled":{"type":"boolean"},"methods":{"type":"array","items":{"type":"string"},"nullable":true},"expire_after_access":{"type":"boolean"}}},"status":{"type":"string","nullable":true}},"required":["name","email"]}},"status":{"type":"string","description":"Possible values: Draft, Created, Sending, Sent, Pending, Viewed, Completed, Manually completed, Declined, Canceled, Bounced, Blocked, Error, Expired"},"reminders":{"type":"boolean"},"archived":{"type":"boolean"},"embedded":{"$ref":"#/components/schemas/EmbeddedBranding"},"embedded_signing":{"type":"boolean"},"embedded_edit_url":{"type":"string","format":"url","nullable":true},"embedded_preview_url":{"type":"string","format":"url","nullable":true},"apply_signing_order":{"type":"boolean"},"redirect_url":{"type":"string","format":"url","nullable":true},"decline_redirect_url":{"type":"string","format":"url","nullable":true},"language":{"type":"string"},"expires_in":{"type":"integer"},"decline_message":{"type":"string","nullable":true},"error_message":{"type":"string","nullable":true},"template_id":{"type":"string","nullable":true},"template_ids":{"type":"array","items":{"type":"string"}},"embedded_signing_notifications":{"type":"boolean"},"attachment_requests":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"recipient_id":{"type":"string"},"required":{"type":"boolean"}},"required":["name","recipient_id"]}},"files":{"type":"array","items":{"$ref":"#/components/schemas/FileInfo"}},"copied_contacts":{"type":"array","items":{"$ref":"#/components/schemas/CopiedContactInfo"}},"fields":{"type":"array","items":{"type":"array","items":{"type":"object","properties":{"x":{"type":"number","format":"float"},"y":{"type":"number","format":"float"},"page":{"type":"integer"},"recipient":{"type":"object","properties":{"email":{"type":"string","format":"email"},"name":{"type":"string"}},"required":["email","name"]},"api_id":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"date_format":{"$ref":"#/components/schemas/DateFormat"},"fixed_width":{"type":"boolean"},"formula":{"type":"string"},"label":{"type":"string"},"lock_sign_date":{"type":"boolean"},"required":{"type":"boolean"},"type":{"$ref":"#/components/schemas/FieldType"},"validation":{"$ref":"#/components/schemas/TextValidation"},"validation_regex":{"$ref":"#/components/schemas/ValidationRegex"},"validation_regex_error_message":{"$ref":"#/components/schemas/ValidationRegexErrorMessage"},"value":{"oneOf":[{"type":"string"},{"type":"boolean"},{"type":"number"}],"nullable":true},"height":{"type":"string"},"width":{"type":"string"},"recipient_id":{"type":"string","nullable":true},"signing_elements_group_id":{"type":"string","format":"uuid"},"placeholder_name":{"type":"string"},"options":{"type":"array","description":"Dropdown options (for dropdown/select fields)","items":{"type":"object","properties":{"name":{"type":"string"},"api_id":{"type":"string"},"is_other":{"type":"boolean"}}}},"default_option":{"type":"string","description":"Default selected option"},"allow_other":{"type":"boolean","description":"Whether \"Other\" option is allowed"}},"required":["x","y","page"]}}},"allow_decline":{"type":"boolean","nullable":true},"allow_reassign":{"type":"boolean","nullable":true},"labels":{"type":"array","items":{"$ref":"#/components/schemas/LabelInfo"}},"checkbox_groups":{"type":"array","items":{"$ref":"#/components/schemas/CheckboxGroupInfo"}},"conditional_rules":{"type":"array","items":{"$ref":"#/components/schemas/ConditionalRuleInfo"}},"conditional_logic_decisions":{"type":"array","items":{"$ref":"#/components/schemas/ConditionalLogicDecisionInfo"}}},"required":["id","test_mode"]},"DocumentTemplateResponse":{"type":"object","properties":{"id":{"type":"string"},"api_application_id":{"type":"string","format":"uuid","nullable":true},"requester_email_address":{"type":"string","format":"email"},"custom_requester_name":{"type":"string","nullable":true},"custom_requester_email":{"type":"string","format":"email","nullable":true},"name":{"type":"string"},"subject":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","nullable":true,"additionalProperties":{"type":"string"}},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"placeholders":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"subject":{"type":"string","nullable":true},"message":{"type":"string","nullable":true},"preassigned_recipient_name":{"type":"string"},"preassigned_recipient_email":{"type":"string"},"signing_order":{"type":"integer"},"attachment_requests":{"type":"array","items":{"$ref":"#/components/schemas/AttachmentRequestInfo"}},"passcode_delivery":{"type":"object","properties":{"enabled":{"type":"boolean"},"methods":{"type":"array","items":{"type":"string"},"nullable":true},"expire_after_access":{"type":"boolean"}}}},"required":["name"]}},"copied_placeholders":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"placeholder_id":{"type":"string"},"name":{"type":"string"},"subject":{"type":"string","nullable":true},"message":{"type":"string","nullable":true},"preassigned_recipient_name":{"type":"string"},"preassigned_recipient_email":{"type":"string"}},"required":["name"]}},"status":{"type":"string"},"reminders":{"type":"boolean","nullable":true},"archived":{"type":"boolean"},"embedded_edit_url":{"type":"string","format":"url","nullable":true},"template_link":{"type":"string","format":"url"},"template_id":{"type":"string","nullable":true},"apply_signing_order":{"type":"boolean"},"redirect_url":{"type":"string","format":"url","nullable":true},"decline_redirect_url":{"type":"string","format":"url","nullable":true},"language":{"type":"string"},"expires_in":{"type":"integer","nullable":true},"files":{"type":"array","items":{"$ref":"#/components/schemas/FileInfo"}},"fields":{"type":"array","items":{"type":"array","items":{"type":"object","properties":{"x":{"type":"number","format":"float"},"y":{"type":"number","format":"float"},"page":{"type":"integer"},"recipient":{"type":"object","properties":{"email":{"type":"string","format":"email"},"name":{"type":"string"}},"required":["email","name"]},"api_id":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"date_format":{"$ref":"#/components/schemas/DateFormat"},"fixed_width":{"type":"boolean"},"formula":{"type":"string"},"label":{"type":"string"},"lock_sign_date":{"type":"boolean"},"required":{"type":"boolean"},"type":{"$ref":"#/components/schemas/FieldType"},"validation":{"$ref":"#/components/schemas/TextValidation"},"validation_regex":{"$ref":"#/components/schemas/ValidationRegex"},"validation_regex_error_message":{"$ref":"#/components/schemas/ValidationRegexErrorMessage"},"value":{"oneOf":[{"type":"string"},{"type":"boolean"},{"type":"number"}],"nullable":true},"height":{"type":"string"},"width":{"type":"string"},"recipient_id":{"type":"string","nullable":true},"signing_elements_group_id":{"type":"string","format":"uuid"},"placeholder_name":{"type":"string"},"options":{"type":"array","description":"Dropdown options (for dropdown/select fields)","items":{"type":"object","properties":{"name":{"type":"string"},"api_id":{"type":"string"},"is_other":{"type":"boolean"}}}},"default_option":{"type":"string","description":"Default selected option"},"allow_other":{"type":"boolean","description":"Whether \"Other\" option is allowed"}},"required":["x","y","page"]}}},"allow_decline":{"type":"boolean","nullable":true},"allow_reassign":{"type":"boolean","nullable":true},"labels":{"type":"array","items":{"$ref":"#/components/schemas/LabelInfo"}},"checkbox_groups":{"type":"array","items":{"$ref":"#/components/schemas/CheckboxGroupInfo"}},"conditional_rules":{"type":"array","items":{"$ref":"#/components/schemas/ConditionalRuleInfo"}}},"required":["id"]},"DocumentFromTemplateResponse":{"type":"object","properties":{"cfr_part11":{"type":"boolean","description":"Whether 21 CFR Part 11 controls apply to this document. Read-only: the value is taken from the workspace setting when the document is created and never changes afterwards."},"cfr_part11_signing_mode":{"type":"string","enum":["streamlined","per_signature"],"nullable":true,"description":"The signing mode of a 21 CFR Part 11 document: streamlined (one final authentication) or per_signature (authentication at every signature and initials field). Null when Part 11 does not apply."},"test_mode":{"type":"boolean"},"id":{"type":"string"},"template_id":{"type":"string"},"template_ids":{"type":"array","items":{"type":"string"}},"api_application_id":{"type":"string","format":"uuid","nullable":true},"requester_email_address":{"type":"string","format":"email"},"custom_requester_name":{"type":"string","nullable":true},"custom_requester_email":{"type":"string","format":"email","nullable":true},"name":{"type":"string"},"subject":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"recipients":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"role":{"type":"string"},"message":{"type":"string","nullable":true},"subject":{"type":"string","nullable":true},"send_email":{"type":"boolean","nullable":true},"send_email_delay":{"type":"integer","nullable":true},"delivery_method":{"type":"string","enum":["email","sms","email_and_sms"],"description":"How the recipient is notified: email (default), sms, or email_and_sms."},"sms":{"type":"object","description":"SMS delivery metadata. Only present when delivery_method includes SMS.","properties":{"phone_number_masked":{"type":"string","nullable":true,"description":"Masked phone number; the full number never leaves the API."},"send_sms":{"type":"boolean","nullable":true},"send_sms_delay":{"type":"integer","nullable":true},"delivery_status":{"type":"string","nullable":true},"message_type":{"type":"string","nullable":true},"failed":{"type":"boolean","nullable":true},"failed_details":{"type":"string","nullable":true}}},"signing_order":{"type":"integer"},"signing_url":{"type":"string","format":"url","nullable":true},"embedded_signing_url":{"type":"string","format":"url","nullable":true},"bounced":{"type":"boolean","nullable":true},"bounced_details":{"type":"string","nullable":true},"attachment_requests":{"type":"array","items":{"$ref":"#/components/schemas/AttachmentRequestInfo"}},"passcode":{"type":"string","nullable":true},"passcode_delivery":{"type":"object","properties":{"enabled":{"type":"boolean"},"methods":{"type":"array","items":{"type":"string"},"nullable":true},"expire_after_access":{"type":"boolean"}}},"status":{"type":"string"},"placeholder_name":{"type":"string"}},"required":["email"]}},"status":{"type":"string","description":"Possible values: Draft, Created, Sending, Sent, Pending, Viewed, Completed, Manually completed, Declined, Canceled, Bounced, Blocked, Error, Expired"},"reminders":{"type":"boolean"},"archived":{"type":"boolean"},"embedded":{"$ref":"#/components/schemas/EmbeddedBranding"},"embedded_signing":{"type":"boolean"},"embedded_edit_url":{"type":"string","format":"url"},"embedded_preview_url":{"type":"string","format":"url","nullable":true},"apply_signing_order":{"type":"boolean"},"redirect_url":{"type":"string","format":"url","nullable":true},"decline_redirect_url":{"type":"string","format":"url","nullable":true},"language":{"type":"string"},"expires_in":{"type":"integer"},"decline_message":{"type":"string","nullable":true},"error_message":{"type":"string","nullable":true},"embedded_signing_notifications":{"type":"boolean"},"attachment_requests":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"recipient_id":{"type":"string"},"required":{"type":"boolean"}},"required":["name","recipient_id"]}},"files":{"type":"array","items":{"$ref":"#/components/schemas/FileInfo"}},"copied_contacts":{"type":"array","items":{"$ref":"#/components/schemas/CopiedContactInfo"}},"fields":{"type":"array","items":{"type":"array","items":{"type":"object","properties":{"x":{"type":"number","format":"float"},"y":{"type":"number","format":"float"},"page":{"type":"integer"},"recipient":{"type":"object","properties":{"email":{"type":"string","format":"email"},"name":{"type":"string"},"role":{"type":"string"}},"required":["email","name"]},"api_id":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"date_format":{"$ref":"#/components/schemas/DateFormat"},"fixed_width":{"type":"boolean"},"formula":{"type":"string"},"label":{"type":"string"},"lock_sign_date":{"type":"boolean"},"required":{"type":"boolean"},"type":{"$ref":"#/components/schemas/FieldType"},"validation":{"$ref":"#/components/schemas/TextValidation"},"validation_regex":{"$ref":"#/components/schemas/ValidationRegex"},"validation_regex_error_message":{"$ref":"#/components/schemas/ValidationRegexErrorMessage"},"value":{"oneOf":[{"type":"string"},{"type":"boolean"},{"type":"number"}],"nullable":true},"height":{"type":"string"},"width":{"type":"string"},"recipient_id":{"type":"string","nullable":true},"signing_elements_group_id":{"type":"string","format":"uuid"},"placeholder_name":{"type":"string"},"options":{"type":"array","description":"Dropdown options (for dropdown/select fields)","items":{"type":"object","properties":{"name":{"type":"string"},"api_id":{"type":"string"},"is_other":{"type":"boolean"}}}},"default_option":{"type":"string","description":"Default selected option"},"allow_other":{"type":"boolean","description":"Whether \"Other\" option is allowed"}},"required":["x","y","page"]}}},"allow_decline":{"type":"boolean","nullable":true},"allow_reassign":{"type":"boolean","nullable":true},"labels":{"type":"array","items":{"$ref":"#/components/schemas/LabelInfo"}},"checkbox_groups":{"type":"array","items":{"$ref":"#/components/schemas/CheckboxGroupInfo"}},"conditional_rules":{"type":"array","items":{"$ref":"#/components/schemas/ConditionalRuleInfo"}},"conditional_logic_decisions":{"type":"array","items":{"$ref":"#/components/schemas/ConditionalLogicDecisionInfo"}}},"required":["id","test_mode"]},"PaginationMeta":{"type":"object","description":"Pagination metadata for list responses","properties":{"current_page":{"type":"integer","description":"Current page number"},"next_page":{"type":"integer","nullable":true,"description":"Next page number, null if on last page"},"previous_page":{"type":"integer","nullable":true,"description":"Previous page number, null if on first page"},"total_count":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}},"required":["current_page","total_count","total_pages"]},"DocumentListResponse":{"type":"object","description":"List of documents with pagination","properties":{"documents":{"type":"array","items":{"$ref":"#/components/schemas/DocumentResponse"}},"current_page":{"type":"integer"},"next_page":{"type":"integer","nullable":true},"previous_page":{"type":"integer","nullable":true},"total_count":{"type":"integer"},"total_pages":{"type":"integer"}},"required":["documents","current_page","total_count","total_pages"]},"DocumentTemplateListResponse":{"type":"object","description":"List of templates with pagination","properties":{"templates":{"type":"array","items":{"$ref":"#/components/schemas/DocumentTemplateResponse"}},"current_page":{"type":"integer"},"next_page":{"type":"integer","nullable":true},"previous_page":{"type":"integer","nullable":true},"total_count":{"type":"integer"},"total_pages":{"type":"integer"}},"required":["templates","current_page","total_count","total_pages"]},"BulkSendListItem":{"type":"object","description":"Bulk send summary in list responses","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"api_application_id":{"type":"string","format":"uuid","nullable":true},"documents_count":{"type":"integer"},"documents_completed":{"type":"integer"},"documents_not_completed":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"user_id":{"type":"string","format":"uuid","nullable":true},"status":{"type":"string"},"template_ids":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["id","name","documents_count","documents_completed","documents_not_completed","created_at","status","template_ids"]},"BulkSendListResponse":{"type":"object","description":"List of bulk sends with pagination","properties":{"bulk_sends":{"type":"array","items":{"$ref":"#/components/schemas/BulkSendListItem"}},"current_page":{"type":"integer"},"next_page":{"type":"integer","nullable":true},"previous_page":{"type":"integer","nullable":true},"total_count":{"type":"integer"},"total_pages":{"type":"integer"}},"required":["bulk_sends","current_page","total_count","total_pages"]},"AccountPreferencesResponse":{"type":"object","properties":{"date_format":{"type":"string"},"days_until_links_expire":{"type":"integer"},"disable_apply_everywhere":{"type":"boolean"},"disable_apply_everywhere_effective":{"type":"boolean"},"disable_drawn_signatures":{"type":"boolean"},"disable_typed_signatures":{"type":"boolean"},"disable_uploaded_signatures":{"type":"boolean"},"enable_redirect":{"type":"boolean"},"hide_document_id_in_audit":{"type":"boolean"},"mute_branding":{"type":"boolean"},"redirect_url":{"type":"string","nullable":true},"separate_audit_pdf":{"type":"boolean"},"separate_completed_file":{"type":"boolean"},"enable_nom151_compliance":{"type":"boolean"},"time_zone":{"type":"string"},"recipient_language":{"type":"string","nullable":true}}},"AccountResponse":{"type":"object","description":"The account behind the credentials: name, logo and default settings","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","description":"The name of the account."},"logo_url":{"type":"string","nullable":true,"description":"URL of the account's logo, or null when none is set."},"plan_tier":{"type":"string","description":"Plan tier of the account."},"preferences":{"$ref":"#/components/schemas/AccountPreferencesResponse"}},"required":["id","name","plan_tier","preferences"]},"AccountSetupResponse":{"type":"object","description":"Onboarding answers, dashboard checklist and suggested values for assistant-led setup","properties":{"onboarding":{"type":"object","nullable":true,"properties":{"needs_today":{"type":"string","nullable":true},"organization_size":{"type":"string","nullable":true},"industry":{"type":"string","nullable":true},"role":{"type":"string","nullable":true},"important_features":{"type":"array","items":{"type":"string"}},"first_action":{"type":"string","nullable":true},"signup_source":{"type":"string","nullable":true},"other_details":{"type":"string","nullable":true},"monthly_documents":{"type":"string","nullable":true},"completed":{"type":"boolean"},"skipped":{"type":"boolean"},"completed_at":{"type":"string","format":"date-time","nullable":true}}},"checklist":{"type":"object","properties":{"show":{"type":"boolean"},"items":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"required":{"type":"boolean"},"completed":{"type":"boolean"}}}},"progress":{"type":"object","properties":{"completed":{"type":"integer"},"total":{"type":"integer"}}}}},"suggestions":{"type":"object","description":"Guesses, labeled with where they came from; confirm them with the user","properties":{"company_name":{"type":"string","nullable":true},"logo_url":{"type":"string","nullable":true},"brand_color":{"type":"string","nullable":true},"source":{"type":"string"}}}},"required":["checklist","suggestions"]},"AccountInfoResponse":{"type":"object","description":"Account or workspace information","properties":{"id":{"type":"string","format":"uuid"},"deletion_requested_at":{"type":"string","format":"date-time","nullable":true},"name":{"type":"string"},"plan_tier":{"type":"string"},"active_templates":{"type":"integer"},"can_create_template":{"type":"boolean"},"can_create_tracking_document":{"type":"boolean"},"can_create_completion_document":{"type":"boolean"},"active_users":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string","format":"email"},"has_google_registration":{"type":"boolean"}},"required":["id","name","email"]}}},"required":["id","name","plan_tier"]},"MeResponse":{"type":"object","description":"Account information associated with the API key","properties":{"id":{"type":"string","format":"uuid","description":"Membership ID"},"role":{"type":"string","description":"Role within the account (e.g. owner, admin, member)"},"archived":{"type":"boolean"},"user":{"type":"object","description":"The authenticated user","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string","format":"email"},"has_google_registration":{"type":"boolean"},"first_name":{"type":"string"},"preferences":{"type":"object","properties":{"sales_document":{"type":"boolean"},"time_zone":{"type":"string"},"smart_fields":{"type":"boolean"}}}},"required":["id","name","email"]},"account":{"$ref":"#/components/schemas/AccountInfoResponse"},"workspace":{"$ref":"#/components/schemas/AccountInfoResponse"},"contact":{"type":"object","description":"The contact record for the authenticated user","properties":{"id":{"type":"string","format":"uuid"},"email":{"type":"string","format":"email"},"name":{"type":"string"},"company_name":{"type":"string","nullable":true},"phone_number":{"type":"string","nullable":true},"alt_phone_number":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"initials":{"type":"string"},"archived":{"type":"boolean"}},"required":["id","email","name"]}},"required":["id","role","user","account","workspace","contact"]},"ApiApplicationResponse":{"type":"object","description":"API application details","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"callback_urls":{"type":"array","items":{"type":"string"},"nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"owner":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"account_id":{"type":"string","format":"uuid"},"name":{"type":"string"},"email":{"type":"string","format":"email"}},"required":["id","name","email"]},"preferences":{"type":"object","properties":{"button_text_color":{"type":"string","nullable":true},"buttons_border_radius":{"type":"integer"},"custom_logo_file":{"type":"string","nullable":true},"link_text_color":{"type":"string","nullable":true},"primary_color":{"type":"string","nullable":true}}}},"required":["id","name"]},"BulkSendResponse":{"type":"object","description":"Bulk send details","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"api_application_id":{"type":"string","format":"uuid","nullable":true},"documents_count":{"type":"integer"},"documents_completed":{"type":"integer"},"documents_not_completed":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"user_id":{"type":"string","format":"uuid","nullable":true},"status":{"type":"string"},"templates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"]}}},"required":["id","documents_count","created_at","status"]},"BulkSendCreateResponse":{"type":"object","description":"Bulk send creation response","properties":{"id":{"type":"string","format":"uuid"},"template_ids":{"type":"array","items":{"type":"string","format":"uuid"}},"api_application_id":{"type":"string","format":"uuid","nullable":true},"documents_count":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"user_id":{"type":"string","format":"uuid","nullable":true},"status":{"type":"string"}},"required":["id","template_ids","documents_count","created_at","status"]},"BulkSendDocumentsResponse":{"type":"object","description":"Paginated list of documents in a bulk send","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"api_application_id":{"type":"string","format":"uuid","nullable":true},"created_at":{"type":"string","format":"date-time"},"user_id":{"type":"string","format":"uuid","nullable":true},"status":{"type":"string"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/DocumentResponse"}},"current_page":{"type":"integer"},"next_page":{"type":"integer","nullable":true},"previous_page":{"type":"integer","nullable":true},"total_count":{"type":"integer"},"total_pages":{"type":"integer"}},"required":["id","documents","current_page","total_count","total_pages"]},"BulkSendValidateCsvResponse":{"type":"object","description":"Validated bulk send CSV response with defaults applied","properties":{"bulk_send_csv":{"type":"string","description":"Base64-encoded CSV content"},"template_ids":{"type":"array","items":{"type":"string","format":"uuid"}},"skip_row_errors":{"type":"boolean"},"api_application_id":{"type":"string","format":"uuid","nullable":true},"name":{"type":"string"},"subject":{"type":"string"},"message":{"type":"string"},"apply_signing_order":{"type":"boolean"}},"required":["bulk_send_csv","template_ids"]},"WebhookResponse":{"type":"object","description":"Webhook subscription","properties":{"id":{"type":"string","format":"uuid"},"callback_url":{"type":"string","format":"url"},"api_application_id":{"type":"string","format":"uuid","nullable":true}},"required":["id","callback_url"]},"WebhookListResponse":{"type":"array","description":"List of webhook subscriptions","items":{"$ref":"#/components/schemas/WebhookResponse"}},"ErrorResponse":{"type":"object","description":"Standard error response","properties":{"message":{"type":"string","description":"Human-readable error message"},"meta":{"type":"object","properties":{"error":{"type":"string","description":"Error code identifier"},"message":{"type":"string","description":"Detailed error message"},"messages":{"type":"array","items":{"type":"string"},"description":"List of error messages"}},"required":["error","message"]}}},"ValidationErrorResponse":{"type":"object","description":"Validation error response. The errors object contains field-specific error details with dynamic keys.","properties":{"errors":{"type":"object","additionalProperties":true,"description":"Field-specific validation errors. Keys are field names (e.g., recipients, fields, files). Values can be strings, arrays of strings, or nested objects with further field-specific errors."}},"required":["errors"]},"RateLimitErrorResponse":{"type":"object","description":"Rate limit exceeded error response (HTTP 429)","properties":{"error":{"type":"string","description":"Rate limit error message indicating the limit and reset time"}},"required":["error"]},"JSON":{"type":"object","description":"JSON response containing the URL to the completed PDF file (returned when url_only=true)","properties":{"file_url":{"type":"string","format":"url","description":"URL to download the completed document"}},"required":["file_url"]},"PDF":{"type":"string","format":"binary","description":"Raw PDF binary data (default response when url_only=false)"},"ZIP":{"type":"string","format":"binary","description":"ZIP file containing the completed PDF (returned when file_format=zip)"}}},"servers":[{"url":"https://www.signwell.com"}]}