signwell_sdk 0.1.2 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (291) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/ci.yml +3 -3
  3. data/.github/workflows/generator-ownership.yml +1 -1
  4. data/.github/workflows/manual-release.yml +1 -1
  5. data/.github/workflows/release.yml +1 -1
  6. data/.release-please-manifest.json +1 -1
  7. data/CHANGELOG.md +20 -0
  8. data/Gemfile.lock +16 -12
  9. data/README.md +11 -0
  10. data/docs/AdditionalFieldsInnerInner.md +4 -0
  11. data/docs/BulkSendCsvRequest.md +1 -1
  12. data/docs/ConditionalLogicDecisionInfo.md +26 -0
  13. data/docs/ConditionalRuleInfo.md +26 -0
  14. data/docs/ConditionalRuleInfoConditionsInner.md +26 -0
  15. data/docs/ConditionalRuleRequest.md +28 -0
  16. data/docs/ConditionalRuleRequestConditionsInner.md +26 -0
  17. data/docs/CopiedPlaceholdersInner.md +1 -1
  18. data/docs/CreateBulkSendRequest.md +2 -2
  19. data/docs/DocumentApi.md +82 -8
  20. data/docs/DocumentFromTemplateRequest.md +11 -3
  21. data/docs/DocumentFromTemplateResponse.md +11 -1
  22. data/docs/DocumentFromTemplateResponseFieldsInnerInner.md +4 -0
  23. data/docs/DocumentFromTemplateResponseRecipientsInner.md +6 -0
  24. data/docs/DocumentRequest.md +10 -4
  25. data/docs/DocumentResponse.md +11 -1
  26. data/docs/DocumentResponseFieldsInnerInner.md +4 -0
  27. data/docs/DocumentResponseRecipientsInner.md +6 -0
  28. data/docs/DocumentResponseRecipientsInnerPasscodeDelivery.md +22 -0
  29. data/docs/DocumentResponseRecipientsInnerSms.md +30 -0
  30. data/docs/DocumentTemplateRequest.md +5 -3
  31. data/docs/DocumentTemplateResponse.md +3 -1
  32. data/docs/DocumentTemplateResponsePlaceholdersInner.md +3 -1
  33. data/docs/DocumentTemplateUpdateRequest.md +5 -3
  34. data/docs/EmbeddedBranding.md +18 -0
  35. data/docs/EmbeddedBrandingBranding.md +26 -0
  36. data/docs/EmbeddedBrandingRequest.md +26 -0
  37. data/docs/EmbeddedBrandingRequestCompanyLogo.md +20 -0
  38. data/docs/EmbeddedRequest.md +18 -0
  39. data/docs/FieldsInnerInner.md +4 -0
  40. data/docs/PlaceholdersInner.md +4 -2
  41. data/docs/PlaceholdersInnerPasscodeDelivery.md +22 -0
  42. data/docs/RecipientsInner.md +14 -4
  43. data/docs/RecipientsInnerPasscodeDelivery.md +22 -0
  44. data/docs/ReminderRecipientsInner.md +1 -1
  45. data/docs/SendReminderRequest.md +1 -1
  46. data/docs/TemplateFieldsInnerInner.md +4 -0
  47. data/docs/TemplateRecipientsInner.md +14 -4
  48. data/docs/UpdateAuthenticationRequest.md +18 -0
  49. data/docs/UpdateAuthenticationRequestRecipientsInner.md +22 -0
  50. data/docs/UpdateDocumentAndSendRequest.md +9 -3
  51. data/docs/UpdateRecipientsMapInner.md +4 -2
  52. data/docs/UpdateRecipientsMapInnerPasscodeDelivery.md +22 -0
  53. data/docs/WebhooksApi.md +1 -1
  54. data/lib/signwell_sdk/api/api_application_api.rb +1 -2
  55. data/lib/signwell_sdk/api/bulk_send_api.rb +1 -2
  56. data/lib/signwell_sdk/api/document_api.rb +87 -14
  57. data/lib/signwell_sdk/api/me_api.rb +1 -2
  58. data/lib/signwell_sdk/api/regional_api.rb +1 -2
  59. data/lib/signwell_sdk/api/template_api.rb +1 -2
  60. data/lib/signwell_sdk/api/webhooks_api.rb +3 -4
  61. data/lib/signwell_sdk/api_client.rb +26 -6
  62. data/lib/signwell_sdk/api_error.rb +1 -2
  63. data/lib/signwell_sdk/api_model_base.rb +88 -0
  64. data/lib/signwell_sdk/configuration.rb +1 -1
  65. data/lib/signwell_sdk/extras/rate_limit.rb +17 -0
  66. data/lib/signwell_sdk/models/account_info_response.rb +1 -2
  67. data/lib/signwell_sdk/models/account_info_response_active_users_inner.rb +1 -2
  68. data/lib/signwell_sdk/models/account_info_response_preferences.rb +1 -2
  69. data/lib/signwell_sdk/models/additional_fields_inner_inner.rb +24 -3
  70. data/lib/signwell_sdk/models/additional_fields_inner_inner_value.rb +3 -4
  71. data/lib/signwell_sdk/models/additional_files_inner.rb +1 -2
  72. data/lib/signwell_sdk/models/api_application_response.rb +1 -2
  73. data/lib/signwell_sdk/models/api_application_response_owner.rb +1 -2
  74. data/lib/signwell_sdk/models/api_application_response_preferences.rb +1 -2
  75. data/lib/signwell_sdk/models/attachment_request_info.rb +1 -2
  76. data/lib/signwell_sdk/models/attachment_requests_inner.rb +1 -2
  77. data/lib/signwell_sdk/models/bulk_send_create_response.rb +1 -2
  78. data/lib/signwell_sdk/models/bulk_send_csv_request.rb +2 -3
  79. data/lib/signwell_sdk/models/bulk_send_csv_template_response.rb +1 -2
  80. data/lib/signwell_sdk/models/bulk_send_documents_response.rb +1 -2
  81. data/lib/signwell_sdk/models/bulk_send_list_item.rb +1 -2
  82. data/lib/signwell_sdk/models/bulk_send_list_response.rb +1 -2
  83. data/lib/signwell_sdk/models/bulk_send_response.rb +1 -2
  84. data/lib/signwell_sdk/models/bulk_send_response_templates_inner.rb +1 -2
  85. data/lib/signwell_sdk/models/bulk_send_validate_csv_response.rb +1 -2
  86. data/lib/signwell_sdk/models/checkbox_group_info.rb +1 -2
  87. data/lib/signwell_sdk/models/checkbox_groups_inner.rb +1 -2
  88. data/lib/signwell_sdk/models/checkbox_validation.rb +4 -3
  89. data/lib/signwell_sdk/models/completed_pdf_response.rb +3 -4
  90. data/lib/signwell_sdk/models/completed_pdf_url_response.rb +1 -2
  91. data/lib/signwell_sdk/models/conditional_logic_decision_info.rb +365 -0
  92. data/lib/signwell_sdk/models/conditional_rule_info.rb +351 -0
  93. data/lib/signwell_sdk/models/conditional_rule_info_conditions_inner.rb +340 -0
  94. data/lib/signwell_sdk/models/conditional_rule_request.rb +322 -0
  95. data/lib/signwell_sdk/models/conditional_rule_request_conditions_inner.rb +371 -0
  96. data/lib/signwell_sdk/models/copied_contact_info.rb +1 -2
  97. data/lib/signwell_sdk/models/copied_contacts_inner.rb +1 -2
  98. data/lib/signwell_sdk/models/copied_placeholders_inner.rb +2 -3
  99. data/lib/signwell_sdk/models/create_bulk_send_request.rb +3 -4
  100. data/lib/signwell_sdk/models/create_webhook_request.rb +1 -2
  101. data/lib/signwell_sdk/models/date_format.rb +4 -3
  102. data/lib/signwell_sdk/models/detailed_option.rb +1 -2
  103. data/lib/signwell_sdk/models/document_from_template_request.rb +90 -6
  104. data/lib/signwell_sdk/models/document_from_template_response.rb +101 -6
  105. data/lib/signwell_sdk/models/document_from_template_response_fields_inner_inner.rb +24 -3
  106. data/lib/signwell_sdk/models/document_from_template_response_fields_inner_inner_recipient.rb +1 -2
  107. data/lib/signwell_sdk/models/document_from_template_response_recipients_inner.rb +71 -3
  108. data/lib/signwell_sdk/models/document_list_response.rb +1 -2
  109. data/lib/signwell_sdk/models/document_request.rb +42 -7
  110. data/lib/signwell_sdk/models/document_response.rb +101 -6
  111. data/lib/signwell_sdk/models/document_response_attachment_requests_inner.rb +1 -2
  112. data/lib/signwell_sdk/models/document_response_fields_inner_inner.rb +24 -3
  113. data/lib/signwell_sdk/models/document_response_fields_inner_inner_options_inner.rb +1 -2
  114. data/lib/signwell_sdk/models/document_response_fields_inner_inner_recipient.rb +1 -2
  115. data/lib/signwell_sdk/models/document_response_fields_inner_inner_value.rb +3 -4
  116. data/lib/signwell_sdk/models/document_response_recipients_inner.rb +71 -3
  117. data/lib/signwell_sdk/models/document_response_recipients_inner_passcode_delivery.rb +246 -0
  118. data/lib/signwell_sdk/models/document_response_recipients_inner_sms.rb +292 -0
  119. data/lib/signwell_sdk/models/document_template_list_response.rb +1 -2
  120. data/lib/signwell_sdk/models/document_template_request.rb +18 -6
  121. data/lib/signwell_sdk/models/document_template_response.rb +17 -6
  122. data/lib/signwell_sdk/models/document_template_response_copied_placeholders_inner.rb +1 -2
  123. data/lib/signwell_sdk/models/document_template_response_placeholders_inner.rb +15 -6
  124. data/lib/signwell_sdk/models/document_template_update_request.rb +18 -6
  125. data/lib/signwell_sdk/models/dropdown_option.rb +3 -4
  126. data/lib/signwell_sdk/models/embedded_branding.rb +241 -0
  127. data/lib/signwell_sdk/models/embedded_branding_branding.rb +307 -0
  128. data/lib/signwell_sdk/models/embedded_branding_request.rb +297 -0
  129. data/lib/signwell_sdk/models/embedded_branding_request_company_logo.rb +236 -0
  130. data/lib/signwell_sdk/models/embedded_request.rb +225 -0
  131. data/lib/signwell_sdk/models/error_response.rb +1 -2
  132. data/lib/signwell_sdk/models/error_response_meta.rb +1 -2
  133. data/lib/signwell_sdk/models/field_type.rb +4 -3
  134. data/lib/signwell_sdk/models/fields_inner_inner.rb +24 -3
  135. data/lib/signwell_sdk/models/file_format.rb +4 -3
  136. data/lib/signwell_sdk/models/file_info.rb +1 -2
  137. data/lib/signwell_sdk/models/files_inner.rb +1 -2
  138. data/lib/signwell_sdk/models/label_info.rb +1 -2
  139. data/lib/signwell_sdk/models/label_request.rb +1 -2
  140. data/lib/signwell_sdk/models/label_response.rb +1 -2
  141. data/lib/signwell_sdk/models/me_response.rb +1 -2
  142. data/lib/signwell_sdk/models/me_response_contact.rb +1 -2
  143. data/lib/signwell_sdk/models/me_response_user.rb +1 -2
  144. data/lib/signwell_sdk/models/me_response_user_preferences.rb +1 -2
  145. data/lib/signwell_sdk/models/nom151_certificate_response.rb +1 -2
  146. data/lib/signwell_sdk/models/nom151_certificate_response_nom151.rb +1 -2
  147. data/lib/signwell_sdk/models/nom151_url_response.rb +1 -2
  148. data/lib/signwell_sdk/models/pagination_meta.rb +1 -2
  149. data/lib/signwell_sdk/models/placeholders_inner.rb +16 -7
  150. data/lib/signwell_sdk/models/placeholders_inner_passcode_delivery.rb +271 -0
  151. data/lib/signwell_sdk/models/rate_limit_error_response.rb +1 -2
  152. data/lib/signwell_sdk/models/recipients_inner.rb +103 -23
  153. data/lib/signwell_sdk/models/recipients_inner_passcode_delivery.rb +271 -0
  154. data/lib/signwell_sdk/models/reminder_recipients_inner.rb +2 -3
  155. data/lib/signwell_sdk/models/send_reminder_request.rb +2 -3
  156. data/lib/signwell_sdk/models/template_attachment_requests_inner.rb +1 -2
  157. data/lib/signwell_sdk/models/template_checkbox_groups_inner.rb +1 -2
  158. data/lib/signwell_sdk/models/template_field_values_inner.rb +1 -2
  159. data/lib/signwell_sdk/models/template_field_values_inner_value.rb +3 -4
  160. data/lib/signwell_sdk/models/template_fields_inner_inner.rb +24 -3
  161. data/lib/signwell_sdk/models/template_recipients_inner.rb +103 -23
  162. data/lib/signwell_sdk/models/text_validation.rb +5 -3
  163. data/lib/signwell_sdk/models/update_authentication_request.rb +243 -0
  164. data/lib/signwell_sdk/models/update_authentication_request_recipients_inner.rb +262 -0
  165. data/lib/signwell_sdk/models/update_document_and_send_request.rb +41 -6
  166. data/lib/signwell_sdk/models/update_recipients_map_inner.rb +16 -7
  167. data/lib/signwell_sdk/models/update_recipients_map_inner_passcode_delivery.rb +271 -0
  168. data/lib/signwell_sdk/models/update_recipients_request.rb +1 -2
  169. data/lib/signwell_sdk/models/validation_error_response.rb +1 -2
  170. data/lib/signwell_sdk/models/webhook_response.rb +1 -2
  171. data/lib/signwell_sdk/version.rb +4 -4
  172. data/lib/signwell_sdk.rb +19 -2
  173. data/openapi.yaml +2231 -972
  174. data/package-lock.json +542 -136
  175. data/package.json +4 -1
  176. data/signwell_sdk.gemspec +1 -2
  177. data/spec/api/api_application_api_spec.rb +1 -2
  178. data/spec/api/bulk_send_api_spec.rb +1 -2
  179. data/spec/api/document_api_spec.rb +11 -4
  180. data/spec/api/me_api_spec.rb +1 -2
  181. data/spec/api/regional_api_spec.rb +1 -2
  182. data/spec/api/template_api_spec.rb +1 -2
  183. data/spec/api/webhooks_api_spec.rb +1 -2
  184. data/spec/models/account_info_response_active_users_inner_spec.rb +1 -2
  185. data/spec/models/account_info_response_preferences_spec.rb +1 -2
  186. data/spec/models/account_info_response_spec.rb +1 -2
  187. data/spec/models/additional_fields_inner_inner_spec.rb +13 -2
  188. data/spec/models/additional_fields_inner_inner_value_spec.rb +1 -2
  189. data/spec/models/additional_files_inner_spec.rb +1 -2
  190. data/spec/models/api_application_response_owner_spec.rb +1 -2
  191. data/spec/models/api_application_response_preferences_spec.rb +1 -2
  192. data/spec/models/api_application_response_spec.rb +1 -2
  193. data/spec/models/attachment_request_info_spec.rb +1 -2
  194. data/spec/models/attachment_requests_inner_spec.rb +1 -2
  195. data/spec/models/bulk_send_create_response_spec.rb +1 -2
  196. data/spec/models/bulk_send_csv_request_spec.rb +1 -2
  197. data/spec/models/bulk_send_csv_template_response_spec.rb +1 -2
  198. data/spec/models/bulk_send_documents_response_spec.rb +1 -2
  199. data/spec/models/bulk_send_list_item_spec.rb +1 -2
  200. data/spec/models/bulk_send_list_response_spec.rb +1 -2
  201. data/spec/models/bulk_send_response_spec.rb +1 -2
  202. data/spec/models/bulk_send_response_templates_inner_spec.rb +1 -2
  203. data/spec/models/bulk_send_validate_csv_response_spec.rb +1 -2
  204. data/spec/models/checkbox_group_info_spec.rb +1 -2
  205. data/spec/models/checkbox_groups_inner_spec.rb +1 -2
  206. data/spec/models/checkbox_validation_spec.rb +1 -2
  207. data/spec/models/completed_pdf_response_spec.rb +1 -2
  208. data/spec/models/completed_pdf_url_response_spec.rb +1 -2
  209. data/spec/models/conditional_logic_decision_info_spec.rb +58 -0
  210. data/spec/models/conditional_rule_info_conditions_inner_spec.rb +58 -0
  211. data/spec/models/conditional_rule_info_spec.rb +58 -0
  212. data/spec/models/conditional_rule_request_conditions_inner_spec.rb +58 -0
  213. data/spec/models/conditional_rule_request_spec.rb +64 -0
  214. data/spec/models/copied_contact_info_spec.rb +1 -2
  215. data/spec/models/copied_contacts_inner_spec.rb +1 -2
  216. data/spec/models/copied_placeholders_inner_spec.rb +1 -2
  217. data/spec/models/create_bulk_send_request_spec.rb +1 -2
  218. data/spec/models/create_webhook_request_spec.rb +1 -2
  219. data/spec/models/date_format_spec.rb +1 -2
  220. data/spec/models/detailed_option_spec.rb +1 -2
  221. data/spec/models/document_from_template_request_spec.rb +25 -2
  222. data/spec/models/document_from_template_response_fields_inner_inner_recipient_spec.rb +1 -2
  223. data/spec/models/document_from_template_response_fields_inner_inner_spec.rb +13 -2
  224. data/spec/models/document_from_template_response_recipients_inner_spec.rb +19 -2
  225. data/spec/models/document_from_template_response_spec.rb +31 -2
  226. data/spec/models/document_list_response_spec.rb +1 -2
  227. data/spec/models/document_request_spec.rb +19 -2
  228. data/spec/models/document_response_attachment_requests_inner_spec.rb +1 -2
  229. data/spec/models/document_response_fields_inner_inner_options_inner_spec.rb +1 -2
  230. data/spec/models/document_response_fields_inner_inner_recipient_spec.rb +1 -2
  231. data/spec/models/document_response_fields_inner_inner_spec.rb +13 -2
  232. data/spec/models/document_response_fields_inner_inner_value_spec.rb +1 -2
  233. data/spec/models/document_response_recipients_inner_passcode_delivery_spec.rb +46 -0
  234. data/spec/models/document_response_recipients_inner_sms_spec.rb +70 -0
  235. data/spec/models/document_response_recipients_inner_spec.rb +19 -2
  236. data/spec/models/document_response_spec.rb +31 -2
  237. data/spec/models/document_template_list_response_spec.rb +1 -2
  238. data/spec/models/document_template_request_spec.rb +7 -2
  239. data/spec/models/document_template_response_copied_placeholders_inner_spec.rb +1 -2
  240. data/spec/models/document_template_response_placeholders_inner_spec.rb +7 -2
  241. data/spec/models/document_template_response_spec.rb +7 -2
  242. data/spec/models/document_template_update_request_spec.rb +7 -2
  243. data/spec/models/dropdown_option_spec.rb +1 -2
  244. data/spec/models/embedded_branding_branding_spec.rb +58 -0
  245. data/spec/models/embedded_branding_request_company_logo_spec.rb +40 -0
  246. data/spec/models/embedded_branding_request_spec.rb +58 -0
  247. data/spec/models/embedded_branding_spec.rb +34 -0
  248. data/spec/models/embedded_request_spec.rb +34 -0
  249. data/spec/models/error_response_meta_spec.rb +1 -2
  250. data/spec/models/error_response_spec.rb +1 -2
  251. data/spec/models/field_type_spec.rb +1 -2
  252. data/spec/models/fields_inner_inner_spec.rb +13 -2
  253. data/spec/models/file_format_spec.rb +1 -2
  254. data/spec/models/file_info_spec.rb +1 -2
  255. data/spec/models/files_inner_spec.rb +1 -2
  256. data/spec/models/label_info_spec.rb +1 -2
  257. data/spec/models/label_request_spec.rb +1 -2
  258. data/spec/models/label_response_spec.rb +1 -2
  259. data/spec/models/me_response_contact_spec.rb +1 -2
  260. data/spec/models/me_response_spec.rb +1 -2
  261. data/spec/models/me_response_user_preferences_spec.rb +1 -2
  262. data/spec/models/me_response_user_spec.rb +1 -2
  263. data/spec/models/nom151_certificate_response_nom151_spec.rb +1 -2
  264. data/spec/models/nom151_certificate_response_spec.rb +1 -2
  265. data/spec/models/nom151_url_response_spec.rb +1 -2
  266. data/spec/models/pagination_meta_spec.rb +1 -2
  267. data/spec/models/placeholders_inner_passcode_delivery_spec.rb +46 -0
  268. data/spec/models/placeholders_inner_spec.rb +7 -2
  269. data/spec/models/rate_limit_error_response_spec.rb +1 -2
  270. data/spec/models/recipients_inner_passcode_delivery_spec.rb +46 -0
  271. data/spec/models/recipients_inner_spec.rb +31 -2
  272. data/spec/models/reminder_recipients_inner_spec.rb +1 -2
  273. data/spec/models/send_reminder_request_spec.rb +1 -2
  274. data/spec/models/template_attachment_requests_inner_spec.rb +1 -2
  275. data/spec/models/template_checkbox_groups_inner_spec.rb +1 -2
  276. data/spec/models/template_field_values_inner_spec.rb +1 -2
  277. data/spec/models/template_field_values_inner_value_spec.rb +1 -2
  278. data/spec/models/template_fields_inner_inner_spec.rb +13 -2
  279. data/spec/models/template_recipients_inner_spec.rb +31 -2
  280. data/spec/models/text_validation_spec.rb +1 -2
  281. data/spec/models/update_authentication_request_recipients_inner_spec.rb +46 -0
  282. data/spec/models/update_authentication_request_spec.rb +34 -0
  283. data/spec/models/update_document_and_send_request_spec.rb +19 -2
  284. data/spec/models/update_recipients_map_inner_passcode_delivery_spec.rb +46 -0
  285. data/spec/models/update_recipients_map_inner_spec.rb +7 -2
  286. data/spec/models/update_recipients_request_spec.rb +1 -2
  287. data/spec/models/validation_error_response_spec.rb +1 -2
  288. data/spec/models/webhook_response_spec.rb +1 -2
  289. data/spec/regressions/api_client_spec.rb +56 -1
  290. data/spec/spec_helper.rb +1 -2
  291. metadata +73 -3
data/openapi.yaml CHANGED
@@ -24,165 +24,13 @@ tags:
24
24
  description: Access region-specific endpoints for data residency compliance.
25
25
  paths:
26
26
  "/api/v1/documents":
27
- get:
28
- summary: List Documents
29
- description: Returns a paginated list of documents for the authenticated account.
30
- tags:
31
- - Document
32
- security:
33
- - api_key: []
34
- operationId: listDocuments
35
- x-internal: true
36
- parameters:
37
- - name: page
38
- in: query
39
- schema:
40
- "$ref": "#/components/schemas/Page"
41
- required: false
42
- - name: limit
43
- in: query
44
- schema:
45
- "$ref": "#/components/schemas/Limit"
46
- required: false
47
- responses:
48
- '200':
49
- description: successful
50
- content:
51
- application/json:
52
- example:
53
- documents:
54
- - id: a83ff091-11fc-4091-8111-6dd2ee8e3393
55
- archived: false
56
- created_at: '2026-03-31T15:46:45Z'
57
- decline_message:
58
- embedded_edit_url: https://www.signwell.com/edit/document/cb858cfc-3bd0-41a8-9b29-abb1da693aac/
59
- error_message:
60
- embedded_preview_url:
61
- language: en
62
- name: miscarriage-relationship/omnis.mp3
63
- requester_email_address: 1_scary_terry@keeling-bahringer.example
64
- status: Created
65
- test_mode: false
66
- updated_at: '2026-03-31T15:46:45Z'
67
- allow_decline: true
68
- allow_reassign: true
69
- api_application_id:
70
- custom_requester_email:
71
- custom_requester_name:
72
- decline_redirect_url:
73
- embedded_signing: false
74
- expires_in: 30
75
- metadata: {}
76
- redirect_url:
77
- reminders: true
78
- apply_signing_order: false
79
- message: "<p>Hey there,</p><p>&nbsp;</p><p>Please review and complete
80
- this document. You can click on the document below to get started.</p>"
81
- subject: Please complete miscarriage-relationship/omnis.mp3
82
- labels: []
83
- fields: []
84
- files: []
85
- copied_contacts: []
86
- recipients: []
87
- checkbox_groups: []
88
- - id: f9bce8ff-2f98-4959-92e4-c895a1367341
89
- archived: false
90
- created_at: '2026-03-31T15:46:45Z'
91
- decline_message:
92
- embedded_edit_url: https://www.signwell.com/edit/document/302e3717-2a9d-4126-a5f1-b7143b21a018/
93
- error_message:
94
- embedded_preview_url:
95
- language: en
96
- name: miscarriage-linger/et.mp4
97
- requester_email_address: 1_scary_terry@keeling-bahringer.example
98
- status: Created
99
- test_mode: false
100
- updated_at: '2026-03-31T15:46:45Z'
101
- allow_decline: true
102
- allow_reassign: true
103
- api_application_id:
104
- custom_requester_email:
105
- custom_requester_name:
106
- decline_redirect_url:
107
- embedded_signing: false
108
- expires_in: 30
109
- metadata: {}
110
- redirect_url:
111
- reminders: true
112
- apply_signing_order: false
113
- message: "<p>Hey there,</p><p>&nbsp;</p><p>Please review and complete
114
- this document. You can click on the document below to get started.</p>"
115
- subject: Please complete miscarriage-linger/et.mp4
116
- labels: []
117
- fields: []
118
- files: []
119
- copied_contacts: []
120
- recipients: []
121
- checkbox_groups: []
122
- - id: 1b03215e-f3cc-446b-a9dc-293af294c988
123
- archived: false
124
- created_at: '2026-03-31T15:46:45Z'
125
- decline_message:
126
- embedded_edit_url: https://www.signwell.com/edit/document/28e9b87a-88dd-4f08-a1a2-633649ccfa3c/
127
- error_message:
128
- embedded_preview_url:
129
- language: en
130
- name: dictate_publish/error.avi
131
- requester_email_address: 1_scary_terry@keeling-bahringer.example
132
- status: Created
133
- test_mode: false
134
- updated_at: '2026-03-31T15:46:45Z'
135
- allow_decline: true
136
- allow_reassign: true
137
- api_application_id:
138
- custom_requester_email:
139
- custom_requester_name:
140
- decline_redirect_url:
141
- embedded_signing: false
142
- expires_in: 30
143
- metadata: {}
144
- redirect_url:
145
- reminders: true
146
- apply_signing_order: false
147
- message: "<p>Hey there,</p><p>&nbsp;</p><p>Please review and complete
148
- this document. You can click on the document below to get started.</p>"
149
- subject: Please complete dictate_publish/error.avi
150
- labels: []
151
- fields: []
152
- files: []
153
- copied_contacts: []
154
- recipients: []
155
- checkbox_groups: []
156
- current_page: 1
157
- next_page:
158
- previous_page:
159
- total_count: 3
160
- total_pages: 1
161
- schema:
162
- "$ref": "#/components/schemas/DocumentListResponse"
163
- '401':
164
- description: unauthorized
165
- content:
166
- application/json:
167
- example:
168
- message: Missing or invalid authorization key
169
- meta:
170
- error: api_key_unauthorized_error
171
- message: Not valid authorization token
172
- messages:
173
- - Not valid authorization token
174
- schema:
175
- "$ref": "#/components/schemas/ErrorResponse"
176
- '429':
177
- description: rate limit exceeded
178
- content:
179
- application/json:
180
- schema:
181
- "$ref": "#/components/schemas/RateLimitErrorResponse"
182
27
  post:
183
28
  summary: Create Document
184
29
  description: Creates and optionally sends a new document for signing. If `draft`
185
- is set to true the document will not be sent.
30
+ is set to true the document will not be sent. Recipients are notified by email,
31
+ SMS, or both based on each recipient's `delivery_method`. SMS delivery is
32
+ available only to workspaces that are eligible for SMS and have it enabled,
33
+ and requires a `phone_number` in E.164 format.
186
34
  tags:
187
35
  - Document
188
36
  security:
@@ -195,11 +43,11 @@ paths:
195
43
  content:
196
44
  application/json:
197
45
  example:
198
- id: 6a8b63de-1885-4ab8-bf0a-77ebd3686c00
46
+ id: 5d99cd46-223b-4c7c-acbd-4c585fceca3d
199
47
  archived: false
200
- created_at: '2026-03-31T15:46:47Z'
48
+ created_at: '2026-09-09T14:04:18Z'
201
49
  decline_message:
202
- embedded_edit_url: https://www.signwell.com/edit/document/3560287f-49f5-423e-a37a-37cd7403c1c8/
50
+ embedded_edit_url: https://www.signwell.com/edit/document/00983e8e-4d64-4517-94eb-373261549d95/
203
51
  error_message:
204
52
  embedded_preview_url:
205
53
  language: en
@@ -207,7 +55,9 @@ paths:
207
55
  requester_email_address: requester@domain.com
208
56
  status: Created
209
57
  test_mode: false
210
- updated_at: '2026-03-31T15:46:47Z'
58
+ updated_at: '2026-09-09T14:04:18Z'
59
+ cfr_part11: false
60
+ cfr_part11_signing_mode:
211
61
  allow_decline: true
212
62
  allow_reassign: true
213
63
  api_application_id:
@@ -221,15 +71,16 @@ paths:
221
71
  key2: value2
222
72
  redirect_url: https://www.domain.com/redirect_path/
223
73
  reminders: true
74
+ embedded:
224
75
  apply_signing_order: false
225
76
  message: Normal Body
226
77
  subject: Normal subject
227
78
  labels:
228
- - id: 7af3624f-fc72-4f69-bed6-de920ba4f72b
79
+ - id: f9eeef2d-818c-41bf-a7e6-42df87e01b03
229
80
  name: My First Label
230
- - id: 00f4b0c6-c24b-4320-9ebf-0a3b068cfc05
81
+ - id: 43273a52-5e50-4977-8062-9a87982fd90d
231
82
  name: My Second Label
232
- - id: bd7c048f-dc98-4a32-b84f-46e8a117839e
83
+ - id: 68367de2-fa18-423b-a125-513800eb2728
233
84
  name: My Third Label
234
85
  fields:
235
86
  - - api_id: DateField_1
@@ -239,8 +90,8 @@ paths:
239
90
  type: date
240
91
  value: 06/05/2021
241
92
  width: '86.0'
242
- x: 230.0
243
- "y": 60.0
93
+ x: 230
94
+ "y": 60
244
95
  date_format: DD/MM/YYYY
245
96
  formula: ''
246
97
  lock_sign_date: true
@@ -252,28 +103,28 @@ paths:
252
103
  type: autofill_date_signed
253
104
  value:
254
105
  width: '86.0'
255
- x: 260.0
256
- "y": 80.0
106
+ x: 260
107
+ "y": 80
257
108
  recipient_id: recipient_id_1
258
- - api_id: Company_1
109
+ - api_id: Email_1
259
110
  height: '19.0'
260
111
  page: 1
261
- required: true
262
- type: autofill_company
263
- value: Great Company
112
+ required: false
113
+ type: autofill_email
114
+ value:
264
115
  width: '86.0'
265
- x: 260.0
266
- "y": 80.0
116
+ x: 260
117
+ "y": 90
267
118
  recipient_id: recipient_id_1
268
- - api_id: Email_1
119
+ - api_id: Company_1
269
120
  height: '19.0'
270
121
  page: 1
271
122
  required: true
272
- type: autofill_email
273
- value: recipient1@domain.com
123
+ type: autofill_company
124
+ value: Great Company
274
125
  width: '86.0'
275
- x: 260.0
276
- "y": 90.0
126
+ x: 260
127
+ "y": 80
277
128
  recipient_id: recipient_id_1
278
129
  - api_id: Name_1
279
130
  height: '19.0'
@@ -282,8 +133,8 @@ paths:
282
133
  type: autofill_name
283
134
  value: Recipient One
284
135
  width: '86.0'
285
- x: 260.0
286
- "y": 80.0
136
+ x: 260
137
+ "y": 80
287
138
  recipient_id: recipient_id_1
288
139
  - api_id: FirstName_1
289
140
  height: '19.0'
@@ -292,8 +143,8 @@ paths:
292
143
  type: autofill_name
293
144
  value: Recipient
294
145
  width: '86.0'
295
- x: 260.0
296
- "y": 80.0
146
+ x: 260
147
+ "y": 80
297
148
  recipient_id: recipient_id_1
298
149
  - api_id: LastName_1
299
150
  height: '19.0'
@@ -302,8 +153,8 @@ paths:
302
153
  type: autofill_name
303
154
  value: One
304
155
  width: '86.0'
305
- x: 260.0
306
- "y": 80.0
156
+ x: 260
157
+ "y": 80
307
158
  recipient_id: recipient_id_1
308
159
  - api_id: Phone_1
309
160
  height: '19.0'
@@ -312,8 +163,8 @@ paths:
312
163
  type: autofill_phone
313
164
  value: '123456789'
314
165
  width: '86.0'
315
- x: 260.0
316
- "y": 100.0
166
+ x: 260
167
+ "y": 100
317
168
  recipient_id: recipient_id_1
318
169
  - api_id: Title_1
319
170
  height: '19.0'
@@ -322,8 +173,8 @@ paths:
322
173
  type: autofill_title
323
174
  value: Important Title
324
175
  width: '86.0'
325
- x: 260.0
326
- "y": 100.0
176
+ x: 260
177
+ "y": 100
327
178
  recipient_id: recipient_id_1
328
179
  - - api_id: DateField_2
329
180
  height: '2.0'
@@ -332,8 +183,8 @@ paths:
332
183
  type: date
333
184
  value: 05/06/2021
334
185
  width: '1.0'
335
- x: 260.0
336
- "y": 80.0
186
+ x: 260
187
+ "y": 80
337
188
  date_format: MM/DD/YYYY
338
189
  formula: ''
339
190
  lock_sign_date: false
@@ -345,8 +196,8 @@ paths:
345
196
  type: signature
346
197
  value:
347
198
  width: '112.0'
348
- x: 260.0
349
- "y": 80.0
199
+ x: 260
200
+ "y": 80
350
201
  recipient_id: recipient_id_2
351
202
  - api_id: Signature_2
352
203
  height: '2.0'
@@ -355,8 +206,8 @@ paths:
355
206
  type: signature
356
207
  value:
357
208
  width: '1.0'
358
- x: 260.0
359
- "y": 80.0
209
+ x: 260
210
+ "y": 80
360
211
  recipient_id: recipient_id_2
361
212
  - api_id: CheckBox_1
362
213
  height: '13.0'
@@ -365,8 +216,8 @@ paths:
365
216
  type: checkbox
366
217
  value: t
367
218
  width: '13.0'
368
- x: 260.0
369
- "y": 80.0
219
+ x: 260
220
+ "y": 80
370
221
  name:
371
222
  recipient_id: recipient_id_2
372
223
  - api_id: CheckBox_2
@@ -376,8 +227,8 @@ paths:
376
227
  type: checkbox
377
228
  value: t
378
229
  width: '1.0'
379
- x: 260.0
380
- "y": 80.0
230
+ x: 260
231
+ "y": 80
381
232
  name: Checkbox name
382
233
  recipient_id: recipient_id_2
383
234
  - api_id: Initials_1
@@ -387,8 +238,8 @@ paths:
387
238
  type: initials
388
239
  value:
389
240
  width: '44.0'
390
- x: 260.0
391
- "y": 80.0
241
+ x: 260
242
+ "y": 80
392
243
  recipient_id: recipient_id_2
393
244
  - api_id: Initials_2
394
245
  height: '2.0'
@@ -397,8 +248,8 @@ paths:
397
248
  type: initials
398
249
  value:
399
250
  width: '1.0'
400
- x: 260.0
401
- "y": 80.0
251
+ x: 260
252
+ "y": 80
402
253
  recipient_id: recipient_id_2
403
254
  - api_id: TextField_1
404
255
  height: '19.0'
@@ -407,8 +258,8 @@ paths:
407
258
  type: text
408
259
  value: '123456'
409
260
  width: '86.0'
410
- x: 260.0
411
- "y": 80.0
261
+ x: 260
262
+ "y": 80
412
263
  fixed_width: true
413
264
  label: label
414
265
  validation: numbers
@@ -420,8 +271,8 @@ paths:
420
271
  type: text
421
272
  value: '123456'
422
273
  width: '1.0'
423
- x: 260.0
424
- "y": 80.0
274
+ x: 260
275
+ "y": 80
425
276
  fixed_width: true
426
277
  label: label
427
278
  validation: numbers
@@ -433,8 +284,8 @@ paths:
433
284
  type: text
434
285
  value: '123456'
435
286
  width: '100.0'
436
- x: 260.0
437
- "y": 80.0
287
+ x: 260
288
+ "y": 80
438
289
  fixed_width: true
439
290
  label: label
440
291
  validation: numbers
@@ -446,8 +297,8 @@ paths:
446
297
  type: text
447
298
  value: '123456'
448
299
  width: '100.0'
449
- x: 260.0
450
- "y": 80.0
300
+ x: 260
301
+ "y": 80
451
302
  fixed_width: true
452
303
  label: label
453
304
  validation: numbers
@@ -459,8 +310,8 @@ paths:
459
310
  type: autofill_company
460
311
  value: Great Company
461
312
  width: '86.0'
462
- x: 260.0
463
- "y": 80.0
313
+ x: 260
314
+ "y": 80
464
315
  recipient_id: recipient_id_1
465
316
  - api_id: Email_2
466
317
  height: '19.0'
@@ -469,8 +320,8 @@ paths:
469
320
  type: autofill_email
470
321
  value: recipient1@domain.com
471
322
  width: '86.0'
472
- x: 260.0
473
- "y": 90.0
323
+ x: 260
324
+ "y": 90
474
325
  recipient_id: recipient_id_1
475
326
  - api_id: Name_2
476
327
  height: '19.0'
@@ -479,8 +330,8 @@ paths:
479
330
  type: autofill_name
480
331
  value: Recipient One
481
332
  width: '86.0'
482
- x: 260.0
483
- "y": 80.0
333
+ x: 260
334
+ "y": 80
484
335
  recipient_id: recipient_id_1
485
336
  - api_id: FirstName_2
486
337
  height: '19.0'
@@ -489,8 +340,8 @@ paths:
489
340
  type: autofill_name
490
341
  value: Recipient
491
342
  width: '86.0'
492
- x: 260.0
493
- "y": 80.0
343
+ x: 260
344
+ "y": 80
494
345
  recipient_id: recipient_id_1
495
346
  - api_id: LastName_2
496
347
  height: '19.0'
@@ -499,8 +350,8 @@ paths:
499
350
  type: autofill_name
500
351
  value: One
501
352
  width: '86.0'
502
- x: 260.0
503
- "y": 80.0
353
+ x: 260
354
+ "y": 80
504
355
  recipient_id: recipient_id_1
505
356
  - api_id: Phone_2
506
357
  height: '19.0'
@@ -509,8 +360,8 @@ paths:
509
360
  type: autofill_phone
510
361
  value: '123456789'
511
362
  width: '86.0'
512
- x: 260.0
513
- "y": 100.0
363
+ x: 260
364
+ "y": 100
514
365
  recipient_id: recipient_id_1
515
366
  - api_id: Title_2
516
367
  height: '19.0'
@@ -519,8 +370,8 @@ paths:
519
370
  type: autofill_title
520
371
  value: Important Title
521
372
  width: '86.0'
522
- x: 260.0
523
- "y": 100.0
373
+ x: 260
374
+ "y": 100
524
375
  recipient_id: recipient_id_1
525
376
  files:
526
377
  - name: filename1.pdf
@@ -531,7 +382,8 @@ paths:
531
382
  - name: CC one
532
383
  email: cc1@domain.com
533
384
  recipients:
534
- - email: recipient1@domain.com
385
+ - delivery_method: email
386
+ email: recipient1@domain.com
535
387
  id: recipient_id_1
536
388
  message: This is a message
537
389
  name: Recipient One
@@ -541,14 +393,19 @@ paths:
541
393
  status: created
542
394
  subject: Hi, please sign this contract
543
395
  signing_order: 1
544
- signing_url: https://www.signwell.com/docs/d549fd60a0/
396
+ signing_url: https://www.signwell.com/docs/6c4531d108/
545
397
  bounced:
546
398
  bounced_details:
399
+ passcode_delivery:
400
+ enabled: false
401
+ methods:
402
+ expire_after_access: false
547
403
  attachment_requests:
548
404
  - name: normal name
549
405
  required: true
550
- url: https://www.signwell.com/document_attachments/boe984aG7RUlK6YP2jZrInX6ywR/?access=2dd579d0-5e1d-4fd5-abd4-ebe5a228284d
551
- - email: recipient2@domain.com
406
+ url: https://www.signwell.com/document_attachments/0dwWK3b6kOHpq80Gbq3bHyL8DPrK/?access=e8d3f302-d259-4f20-ab4d-1d9bf0a7ae49
407
+ - delivery_method: email
408
+ email: recipient2@domain.com
552
409
  id: recipient_id_2
553
410
  message:
554
411
  name: Recipient 2
@@ -558,15 +415,19 @@ paths:
558
415
  status: created
559
416
  subject:
560
417
  signing_order: 2
561
- signing_url: https://www.signwell.com/docs/bf45f2dad5/
418
+ signing_url: https://www.signwell.com/docs/768a9e0ed6/
562
419
  bounced:
563
420
  bounced_details:
421
+ passcode_delivery:
422
+ enabled: false
423
+ methods:
424
+ expire_after_access: false
564
425
  attachment_requests:
565
426
  - name: Driver License
566
427
  required: false
567
- url: https://www.signwell.com/document_attachments/LgbPkXRrZDTdzzNRGLkXSplYMMJ/?access=2dd579d0-5e1d-4fd5-abd4-ebe5a228284d
428
+ url: https://www.signwell.com/document_attachments/ZXlywR3wN1TJd9a1y8gktDbqRy7/?access=e8d3f302-d259-4f20-ab4d-1d9bf0a7ae49
568
429
  checkbox_groups:
569
- - id: 6f69b18a-5fd7-4d74-8829-e7cc707a34f3
430
+ - id: 4749bbb9-93a0-464c-ab56-85769b552a06
570
431
  group_name: Group 1
571
432
  recipient_id:
572
433
  checkbox_ids:
@@ -575,6 +436,20 @@ paths:
575
436
  validation: minimum
576
437
  required: true
577
438
  min_value: 1
439
+ conditional_rules:
440
+ - id: 362ed9b5-debf-41d1-8e41-e246d2a96ebd
441
+ target_id: Name_1
442
+ action_type: require
443
+ action_field_ids:
444
+ - Email_1
445
+ conditions:
446
+ - condition_type: any_of
447
+ status: completed
448
+ join_operator: and_operator
449
+ field_api_ids:
450
+ - Name_1
451
+ position: 1
452
+ conditional_logic_decisions: []
578
453
  schema:
579
454
  "$ref": "#/components/schemas/DocumentResponse"
580
455
  '400':
@@ -739,144 +614,328 @@ paths:
739
614
  schema:
740
615
  "$ref": "#/components/schemas/DocumentRequest"
741
616
  required: true
742
- "/api/v1/documents/{id}":
743
617
  get:
744
- summary: Get Document
745
- description: Returns a document and all associated document data. Supply the
746
- unique document ID from either a document creation request or Document page
747
- URL.
618
+ summary: List Documents
619
+ description: Returns a paginated list of documents for the authenticated account.
748
620
  tags:
749
621
  - Document
750
622
  security:
751
623
  - api_key: []
752
- operationId: getDocument
624
+ operationId: listDocuments
625
+ x-internal: true
753
626
  parameters:
754
- - name: id
755
- in: path
627
+ - name: page
628
+ in: query
756
629
  schema:
757
- "$ref": "#/components/schemas/DocumentId"
758
- required: true
630
+ "$ref": "#/components/schemas/Page"
631
+ required: false
632
+ - name: limit
633
+ in: query
634
+ schema:
635
+ "$ref": "#/components/schemas/Limit"
636
+ required: false
759
637
  responses:
760
638
  '200':
761
639
  description: successful
762
640
  content:
763
641
  application/json:
764
642
  example:
765
- id: 2707ac1d-5dd3-4d95-8ae9-f0ac55f51203
766
- archived: false
767
- created_at: '2026-03-31T15:46:45Z'
768
- decline_message:
769
- embedded_edit_url: https://www.signwell.com/edit/document/bf0ff8a4-50ec-42d7-8167-72fb404a5276/
770
- error_message:
771
- embedded_preview_url:
772
- language: en
773
- name: diagram_arena/architecto.mp3
774
- requester_email_address: jerry.smith.2@yundt-weber.test
775
- status: Created
776
- test_mode: false
777
- updated_at: '2026-03-31T15:46:45Z'
778
- allow_decline: false
779
- allow_reassign: true
780
- api_application_id:
781
- custom_requester_email: rosalia_fisher@lehner.test
782
- custom_requester_name: Bendu
783
- decline_redirect_url: http://bosco.example/shani
784
- embedded_signing: false
785
- expires_in: 10
786
- metadata:
787
- ut: quam
788
- itaque: cumque
789
- redirect_url: http://bogan.example/eldora.kiehn
790
- reminders: false
791
- apply_signing_order: false
792
- message: "<p>Hey there,</p><p>&nbsp;</p><p>Please review and complete
793
- this document. You can click on the document below to get started.</p>"
794
- subject: Please complete diagram_arena/architecto.mp3
795
- labels:
796
- - id: 915b493e-8ba3-44aa-9e8b-ceb4044ac294
797
- name: Frances Goodwin
798
- - id: 9acee41c-ee12-452d-bf40-f6645ee4b6ce
799
- name: Gov. Roy Kohler
800
- fields:
801
- - - api_id: CheckBox_2
802
- height: '13.0'
803
- page: 1
804
- required: true
805
- type: checkbox
806
- value:
807
- width: '13.0'
808
- x: 1.1
809
- "y": 1.1
810
- name:
811
- recipient_id:
812
- signing_elements_group_id: 6cd1fb22-417c-48e9-8674-d95c9613ff73
813
- - api_id: CheckBox_3
814
- height: '13.0'
815
- page: 1
816
- required: true
817
- type: checkbox
818
- value:
819
- width: '13.0'
820
- x: 1.1
821
- "y": 1.1
822
- name:
823
- recipient_id:
824
- - api_id: Signature_1
825
- height: '32.0'
826
- page: 1
827
- required: true
828
- type: signature
829
- value:
830
- width: '112.0'
831
- x: 1.1
832
- "y": 1.1
833
- recipient_id: e052eeae-0706-4dd9-8ec2-68a918290223
834
- files:
835
- - name: velit.numbers
836
- pages_number: 1
837
- copied_contacts:
838
- - name: Jon Auer
839
- email: david@cummings-dicki.example
840
- recipients:
841
- - email: kimbery_kreiger@hoeger-littel.example
842
- id: e052eeae-0706-4dd9-8ec2-68a918290223
843
- message:
844
- name: Rodolfo Daniel
845
- passcode:
846
- send_email:
847
- send_email_delay:
848
- status: created
849
- subject:
850
- signing_order: 1
851
- signing_url: https://www.signwell.com/docs/05791040ca/
852
- bounced:
853
- bounced_details:
854
- attachment_requests:
855
- - name: introduction_premium/vitae.html
643
+ documents:
644
+ - id: a83ff091-11fc-4091-8111-6dd2ee8e3393
645
+ archived: false
646
+ created_at: '2026-03-31T15:46:45Z'
647
+ decline_message:
648
+ embedded_edit_url: https://www.signwell.com/edit/document/cb858cfc-3bd0-41a8-9b29-abb1da693aac/
649
+ error_message:
650
+ embedded_preview_url:
651
+ language: en
652
+ name: miscarriage-relationship/omnis.mp3
653
+ requester_email_address: 1_scary_terry@keeling-bahringer.example
654
+ status: Created
655
+ test_mode: false
656
+ updated_at: '2026-03-31T15:46:45Z'
657
+ allow_decline: true
658
+ allow_reassign: true
659
+ api_application_id:
660
+ custom_requester_email:
661
+ custom_requester_name:
662
+ decline_redirect_url:
663
+ embedded_signing: false
664
+ expires_in: 30
665
+ metadata: {}
666
+ redirect_url:
667
+ reminders: true
668
+ apply_signing_order: false
669
+ message: "<p>Hey there,</p><p>&nbsp;</p><p>Please review and complete
670
+ this document. You can click on the document below to get started.</p>"
671
+ subject: Please complete miscarriage-relationship/omnis.mp3
672
+ labels: []
673
+ fields: []
674
+ files: []
675
+ copied_contacts: []
676
+ recipients: []
677
+ checkbox_groups: []
678
+ - id: f9bce8ff-2f98-4959-92e4-c895a1367341
679
+ archived: false
680
+ created_at: '2026-03-31T15:46:45Z'
681
+ decline_message:
682
+ embedded_edit_url: https://www.signwell.com/edit/document/302e3717-2a9d-4126-a5f1-b7143b21a018/
683
+ error_message:
684
+ embedded_preview_url:
685
+ language: en
686
+ name: miscarriage-linger/et.mp4
687
+ requester_email_address: 1_scary_terry@keeling-bahringer.example
688
+ status: Created
689
+ test_mode: false
690
+ updated_at: '2026-03-31T15:46:45Z'
691
+ allow_decline: true
692
+ allow_reassign: true
693
+ api_application_id:
694
+ custom_requester_email:
695
+ custom_requester_name:
696
+ decline_redirect_url:
697
+ embedded_signing: false
698
+ expires_in: 30
699
+ metadata: {}
700
+ redirect_url:
701
+ reminders: true
702
+ apply_signing_order: false
703
+ message: "<p>Hey there,</p><p>&nbsp;</p><p>Please review and complete
704
+ this document. You can click on the document below to get started.</p>"
705
+ subject: Please complete miscarriage-linger/et.mp4
706
+ labels: []
707
+ fields: []
708
+ files: []
709
+ copied_contacts: []
710
+ recipients: []
711
+ checkbox_groups: []
712
+ - id: 1b03215e-f3cc-446b-a9dc-293af294c988
713
+ archived: false
714
+ created_at: '2026-03-31T15:46:45Z'
715
+ decline_message:
716
+ embedded_edit_url: https://www.signwell.com/edit/document/28e9b87a-88dd-4f08-a1a2-633649ccfa3c/
717
+ error_message:
718
+ embedded_preview_url:
719
+ language: en
720
+ name: dictate_publish/error.avi
721
+ requester_email_address: 1_scary_terry@keeling-bahringer.example
722
+ status: Created
723
+ test_mode: false
724
+ updated_at: '2026-03-31T15:46:45Z'
725
+ allow_decline: true
726
+ allow_reassign: true
727
+ api_application_id:
728
+ custom_requester_email:
729
+ custom_requester_name:
730
+ decline_redirect_url:
731
+ embedded_signing: false
732
+ expires_in: 30
733
+ metadata: {}
734
+ redirect_url:
735
+ reminders: true
736
+ apply_signing_order: false
737
+ message: "<p>Hey there,</p><p>&nbsp;</p><p>Please review and complete
738
+ this document. You can click on the document below to get started.</p>"
739
+ subject: Please complete dictate_publish/error.avi
740
+ labels: []
741
+ fields: []
742
+ files: []
743
+ copied_contacts: []
744
+ recipients: []
745
+ checkbox_groups: []
746
+ current_page: 1
747
+ next_page:
748
+ previous_page:
749
+ total_count: 3
750
+ total_pages: 1
751
+ schema:
752
+ "$ref": "#/components/schemas/DocumentListResponse"
753
+ '401':
754
+ description: unauthorized
755
+ content:
756
+ application/json:
757
+ example:
758
+ message: Missing or invalid authorization key
759
+ meta:
760
+ error: api_key_unauthorized_error
761
+ message: Not valid authorization token
762
+ messages:
763
+ - Not valid authorization token
764
+ schema:
765
+ "$ref": "#/components/schemas/ErrorResponse"
766
+ '429':
767
+ description: rate limit exceeded
768
+ content:
769
+ application/json:
770
+ schema:
771
+ "$ref": "#/components/schemas/RateLimitErrorResponse"
772
+ "/api/v1/documents/{id}":
773
+ get:
774
+ summary: Get Document
775
+ description: Returns a document and all associated document data. Supply the
776
+ unique document ID from either a document creation request or Document page
777
+ URL. Each recipient includes its `delivery_method`, and recipients whose delivery
778
+ includes SMS also include an `sms` object with the masked phone number and
779
+ SMS delivery status.
780
+ tags:
781
+ - Document
782
+ security:
783
+ - api_key: []
784
+ operationId: getDocument
785
+ parameters:
786
+ - name: id
787
+ in: path
788
+ schema:
789
+ "$ref": "#/components/schemas/DocumentId"
790
+ required: true
791
+ responses:
792
+ '200':
793
+ description: successful
794
+ content:
795
+ application/json:
796
+ example:
797
+ id: 045abad9-f39a-453c-ad3b-2ae0c2013532
798
+ archived: false
799
+ created_at: '2026-09-09T14:04:16Z'
800
+ decline_message:
801
+ embedded_edit_url: https://www.signwell.com/edit/document/ef6f7d4b-6856-47b6-aea5-15d15ed46ba2/
802
+ error_message:
803
+ embedded_preview_url:
804
+ language: en
805
+ name: linger-exhibition/et.numbers
806
+ requester_email_address: 2.unity@baumbach.example
807
+ status: Created
808
+ test_mode: false
809
+ updated_at: '2026-09-09T14:04:16Z'
810
+ cfr_part11: false
811
+ cfr_part11_signing_mode:
812
+ allow_decline: true
813
+ allow_reassign: true
814
+ api_application_id:
815
+ custom_requester_email: michele_schuppe@runte.example
816
+ custom_requester_name: Rey
817
+ decline_redirect_url: http://welch.example/aracelis
818
+ embedded_signing: false
819
+ expires_in: 10
820
+ metadata:
821
+ dolor: facilis
822
+ suscipit: commodi
823
+ redirect_url: http://kilback.test/marjory.boyle
824
+ reminders: false
825
+ embedded:
826
+ apply_signing_order: false
827
+ message: "<p>Hey there,</p><p>&nbsp;</p><p>Please review and complete
828
+ this document. You can click on the document below to get started.</p>"
829
+ subject: Please complete linger-exhibition/et.numbers
830
+ labels:
831
+ - id: 28bc77b1-8c7c-4794-89c3-867bb47bbe91
832
+ name: Sonny Corwin
833
+ - id: 0073be58-84d7-42b7-b702-29eba40babf5
834
+ name: Earnestine Schiller
835
+ fields:
836
+ - - api_id: CheckBox_2
837
+ height: '13.0'
838
+ page: 1
839
+ required: true
840
+ type: checkbox
841
+ value:
842
+ width: '13.0'
843
+ x: 1.1
844
+ "y": 1.1
845
+ name:
846
+ recipient_id:
847
+ signing_elements_group_id: 5c37a157-7cf4-4219-a58e-dab4abb5ec3e
848
+ - api_id: CheckBox_3
849
+ height: '13.0'
850
+ page: 1
851
+ required: true
852
+ type: checkbox
853
+ value:
854
+ width: '13.0'
855
+ x: 1.1
856
+ "y": 1.1
857
+ name:
858
+ recipient_id:
859
+ - api_id: Signature_1
860
+ height: '32.0'
861
+ page: 1
862
+ required: true
863
+ type: signature
864
+ value:
865
+ width: '112.0'
866
+ x: 1.1
867
+ "y": 1.1
868
+ recipient_id: ad660969-33d0-4cfb-b1d7-3fc842586f55
869
+ files:
870
+ - name: ipsum.webm
871
+ pages_number: 1
872
+ copied_contacts:
873
+ - name: Amb. Delia Cremin
874
+ email: korey@goyette.example
875
+ recipients:
876
+ - delivery_method: email
877
+ email: reva@runte.test
878
+ id: ad660969-33d0-4cfb-b1d7-3fc842586f55
879
+ message:
880
+ name: Arcelia Beer
881
+ passcode:
882
+ send_email:
883
+ send_email_delay:
884
+ status: created
885
+ subject:
886
+ signing_order: 1
887
+ signing_url: https://www.signwell.com/docs/242e0d67be/
888
+ bounced:
889
+ bounced_details:
890
+ passcode_delivery:
891
+ enabled: false
892
+ methods:
893
+ expire_after_access: false
894
+ attachment_requests:
895
+ - name: drill-cruelty/nihil.pdf
856
896
  required: true
857
- url: https://www.signwell.com/document_attachments/n4dXkq0XLoioY3K7Z9k4SX1ezWd/?access=3550e3ab-f2da-4193-897f-cfba53272548
858
- - email: ira@metz-dare.test
859
- id: 34e316a6-0f62-4751-81fe-145afa405f34
897
+ url: https://www.signwell.com/document_attachments/oQNlE9oen0SEdbK7MJYRIB16KJy/?access=061427d8-c295-40ea-b37c-db074965c3c3
898
+ - delivery_method: email
899
+ email: justin.wilkinson@crist.test
900
+ id: c77df4a1-f102-4fa8-9ff7-2bc203f783a1
860
901
  message:
861
- name: Laurette Rohan
902
+ name: Violeta Ernser
862
903
  passcode:
863
904
  send_email:
864
905
  send_email_delay:
865
906
  status: created
866
907
  subject:
867
908
  signing_order: 2
868
- signing_url: https://www.signwell.com/docs/2eb80d8fb8/
909
+ signing_url: https://www.signwell.com/docs/8dc0983d8b/
869
910
  bounced:
870
911
  bounced_details:
912
+ passcode_delivery:
913
+ enabled: false
914
+ methods:
915
+ expire_after_access: false
871
916
  attachment_requests: []
872
917
  checkbox_groups:
873
- - id: 6cd1fb22-417c-48e9-8674-d95c9613ff73
918
+ - id: 5c37a157-7cf4-4219-a58e-dab4abb5ec3e
874
919
  group_name:
875
920
  recipient_id:
876
921
  checkbox_ids:
877
922
  - CheckBox_2
878
923
  validation:
879
924
  required: false
925
+ conditional_rules:
926
+ - id: e7a202b1-e8fd-450d-8833-d15429b1ae5b
927
+ target_id: employment_status
928
+ action_type: require
929
+ action_field_ids:
930
+ - manager_name
931
+ conditions:
932
+ - condition_type: any_of
933
+ status: completed
934
+ join_operator: and_operator
935
+ field_api_ids:
936
+ - employment_status
937
+ position: 1
938
+ conditional_logic_decisions: []
880
939
  schema:
881
940
  "$ref": "#/components/schemas/DocumentResponse"
882
941
  '404':
@@ -940,7 +999,17 @@ paths:
940
999
  post:
941
1000
  summary: Create Document from Template
942
1001
  description: Creates and optionally sends a new document for signing. If `draft`
943
- is set to true the document will not be sent.
1002
+ is set to true the document will not be sent. Pre-signed template signatures
1003
+ and initials are copied to the new document as document content — they remain
1004
+ visible on the document but do not generate a signing event, do not emit a
1005
+ `document_signed` webhook, and the recipient's status will not reflect them
1006
+ as a real signing action. If the template was pre-signed for a signer and
1007
+ the request adds new unsigned signature/initials fields for that same signer,
1008
+ the pre-applied ratifications are cleared silently so the signer is asked
1009
+ to sign once. Recipients are notified by email, SMS, or both based on each
1010
+ recipient's `delivery_method`. SMS delivery is available only to workspaces
1011
+ that are eligible for SMS and have it enabled, and requires a `phone_number`
1012
+ in E.164 format.
944
1013
  tags:
945
1014
  - Document
946
1015
  security:
@@ -953,11 +1022,11 @@ paths:
953
1022
  content:
954
1023
  application/json:
955
1024
  example:
956
- id: d30a5382-698d-4dfc-a5ac-fe89fbd74689
1025
+ id: 689fb1fb-668f-4737-b116-1983ef3207af
957
1026
  archived: false
958
- created_at: '2026-03-31T15:46:49Z'
1027
+ created_at: '2026-09-09T14:04:19Z'
959
1028
  decline_message:
960
- embedded_edit_url: https://www.signwell.com/edit/document/9cc6abb4-874c-48c3-920f-499c12b8d56a/
1029
+ embedded_edit_url: https://www.signwell.com/edit/document/61115d69-d9d9-4ad8-876f-f0723165be92/
961
1030
  error_message:
962
1031
  embedded_preview_url:
963
1032
  language: en
@@ -965,10 +1034,12 @@ paths:
965
1034
  requester_email_address: requester@domain.com
966
1035
  status: Created
967
1036
  test_mode: false
968
- updated_at: '2026-03-31T15:46:49Z'
1037
+ updated_at: '2026-09-09T14:04:20Z'
969
1038
  template_ids:
970
- - f3374520-a554-454c-ba90-d3d95f51212a
971
- - b44029f8-87a7-4f05-85d5-f343b0e5dbc1
1039
+ - f06872ba-0c59-4a62-90f5-d074b649a506
1040
+ - ba591ba4-c128-43fd-bbb9-4b2e43bfdfe5
1041
+ cfr_part11: false
1042
+ cfr_part11_signing_mode:
972
1043
  allow_decline: true
973
1044
  allow_reassign: true
974
1045
  api_application_id:
@@ -982,12 +1053,26 @@ paths:
982
1053
  key2: value2
983
1054
  redirect_url: https://www.domain.com/redirect_path/
984
1055
  reminders: true
1056
+ embedded:
985
1057
  apply_signing_order: false
986
1058
  message: Normal Body
987
1059
  subject: Normal subject
988
1060
  labels: []
989
1061
  fields:
990
- - - api_id: Signature_1
1062
+ - - api_id: DateField_2
1063
+ height: '19.0'
1064
+ page: 1
1065
+ required: false
1066
+ type: date
1067
+ value:
1068
+ width: '86.0'
1069
+ x: 1.1
1070
+ "y": 1.1
1071
+ date_format: MM/DD/YYYY
1072
+ formula: ''
1073
+ lock_sign_date: true
1074
+ recipient_id: recipient_1
1075
+ - api_id: Signature_1
991
1076
  height: '19.0'
992
1077
  page: 1
993
1078
  required: true
@@ -1023,19 +1108,6 @@ paths:
1023
1108
  formula: ''
1024
1109
  lock_sign_date: false
1025
1110
  recipient_id: recipient_1
1026
- - api_id: DateField_2
1027
- height: '19.0'
1028
- page: 1
1029
- required: true
1030
- type: date
1031
- value:
1032
- width: '86.0'
1033
- x: 1.1
1034
- "y": 1.1
1035
- date_format: MM/DD/YYYY
1036
- formula: ''
1037
- lock_sign_date: true
1038
- recipient_id: recipient_1
1039
1111
  - api_id: CheckBox_1
1040
1112
  height: '19.0'
1041
1113
  page: 1
@@ -1064,8 +1136,8 @@ paths:
1064
1136
  type: date
1065
1137
  value:
1066
1138
  width: '86.0'
1067
- x: 230.0
1068
- "y": 60.0
1139
+ x: 230
1140
+ "y": 60
1069
1141
  date_format: DD/MM/YYYY
1070
1142
  formula: ''
1071
1143
  lock_sign_date: true
@@ -1077,8 +1149,8 @@ paths:
1077
1149
  type: date
1078
1150
  value: 05/06/2021
1079
1151
  width: '86.0'
1080
- x: 230.0
1081
- "y": 120.0
1152
+ x: 230
1153
+ "y": 120
1082
1154
  date_format: MM/DD/YYYY
1083
1155
  formula: ''
1084
1156
  lock_sign_date: false
@@ -1090,8 +1162,8 @@ paths:
1090
1162
  type: signature
1091
1163
  value:
1092
1164
  width: '112.0'
1093
- x: 260.0
1094
- "y": 80.0
1165
+ x: 260
1166
+ "y": 80
1095
1167
  recipient_id: recipient_2
1096
1168
  - api_id: CheckBox_3
1097
1169
  height: '13.0'
@@ -1100,8 +1172,8 @@ paths:
1100
1172
  type: checkbox
1101
1173
  value: t
1102
1174
  width: '13.0'
1103
- x: 260.0
1104
- "y": 80.0
1175
+ x: 260
1176
+ "y": 80
1105
1177
  name:
1106
1178
  recipient_id: recipient_2
1107
1179
  - api_id: Initials_4
@@ -1111,8 +1183,8 @@ paths:
1111
1183
  type: initials
1112
1184
  value:
1113
1185
  width: '44.0'
1114
- x: 260.0
1115
- "y": 80.0
1186
+ x: 260
1187
+ "y": 80
1116
1188
  recipient_id: recipient_2
1117
1189
  - api_id: TextField_5
1118
1190
  height: '19.0'
@@ -1121,16 +1193,16 @@ paths:
1121
1193
  type: text
1122
1194
  value: '123456'
1123
1195
  width: '86.0'
1124
- x: 260.0
1125
- "y": 80.0
1196
+ x: 260
1197
+ "y": 80
1126
1198
  fixed_width: true
1127
1199
  label: label
1128
1200
  validation: numbers
1129
1201
  recipient_id: recipient_2
1130
1202
  files:
1131
- - name: inventore.wav
1203
+ - name: autem.pptx
1132
1204
  pages_number: 2
1133
- - name: consequatur.odp
1205
+ - name: explicabo.bmp
1134
1206
  pages_number: 2
1135
1207
  - name: filename1.pdf
1136
1208
  pages_number: 0
@@ -1142,7 +1214,8 @@ paths:
1142
1214
  - name: CC 2
1143
1215
  email: cc2@domain.com
1144
1216
  recipients:
1145
- - email: document_sender@domain.com
1217
+ - delivery_method: email
1218
+ email: document_sender@domain.com
1146
1219
  id: document_sender
1147
1220
  message:
1148
1221
  name: Recipient 0
@@ -1152,12 +1225,17 @@ paths:
1152
1225
  status: created
1153
1226
  subject:
1154
1227
  signing_order: 1
1155
- signing_url: https://www.signwell.com/docs/b073120ed1/
1228
+ signing_url: https://www.signwell.com/docs/b91ee16bcc/
1156
1229
  bounced:
1157
1230
  bounced_details:
1158
1231
  placeholder_name: Document Sender
1232
+ passcode_delivery:
1233
+ enabled: false
1234
+ methods:
1235
+ expire_after_access: false
1159
1236
  attachment_requests: []
1160
- - email: recipient_1@domain.com
1237
+ - delivery_method: email
1238
+ email: recipient_1@domain.com
1161
1239
  id: recipient_1
1162
1240
  message:
1163
1241
  name: Recipient 1
@@ -1167,15 +1245,20 @@ paths:
1167
1245
  status: created
1168
1246
  subject:
1169
1247
  signing_order: 2
1170
- signing_url: https://www.signwell.com/docs/4cd4755817/
1248
+ signing_url: https://www.signwell.com/docs/2771897646/
1171
1249
  bounced:
1172
1250
  bounced_details:
1173
1251
  placeholder_name: Placeholder 1
1252
+ passcode_delivery:
1253
+ enabled: false
1254
+ methods:
1255
+ expire_after_access: false
1174
1256
  attachment_requests:
1175
1257
  - name: normal name
1176
1258
  required: true
1177
- url: https://www.signwell.com/document_attachments/pW6aNG7REwIRRE3BGPpdFNwQDBY/?access=225a83c4-1f7f-4a6e-91e2-05cca38ade3e
1178
- - email: recipient_2@domain.com
1259
+ url: https://www.signwell.com/document_attachments/dR85jdjMQ3IlAjjLP4azcRbM6zlj/?access=e5042933-95c3-4ab5-b2aa-d2e23bb312e4
1260
+ - delivery_method: email
1261
+ email: recipient_2@domain.com
1179
1262
  id: recipient_2
1180
1263
  message:
1181
1264
  name: Recipient 2
@@ -1185,15 +1268,33 @@ paths:
1185
1268
  status: created
1186
1269
  subject:
1187
1270
  signing_order: 3
1188
- signing_url: https://www.signwell.com/docs/558335fef6/
1271
+ signing_url: https://www.signwell.com/docs/27c73140f4/
1189
1272
  bounced:
1190
1273
  bounced_details:
1191
1274
  placeholder_name: Placeholder 2
1275
+ passcode_delivery:
1276
+ enabled: false
1277
+ methods:
1278
+ expire_after_access: false
1192
1279
  attachment_requests:
1193
1280
  - name: Driver License
1194
1281
  required: false
1195
- url: https://www.signwell.com/document_attachments/bYYjEqk62ocW3BDrlYJrCbYb45K/?access=225a83c4-1f7f-4a6e-91e2-05cca38ade3e
1282
+ url: https://www.signwell.com/document_attachments/JdpzdWLy9aUnZdaQe6PWTz5w3BQ/?access=e5042933-95c3-4ab5-b2aa-d2e23bb312e4
1196
1283
  checkbox_groups: []
1284
+ conditional_rules:
1285
+ - id: cc3f1bbd-ae57-45dd-9949-37c7213eb1c3
1286
+ target_id: DateField_1
1287
+ action_type: require
1288
+ action_field_ids:
1289
+ - DateField_2
1290
+ conditions:
1291
+ - condition_type: any_of
1292
+ status: completed
1293
+ join_operator: and_operator
1294
+ field_api_ids:
1295
+ - DateField_1
1296
+ position: 1
1297
+ conditional_logic_decisions: []
1197
1298
  schema:
1198
1299
  "$ref": "#/components/schemas/DocumentFromTemplateResponse"
1199
1300
  '400':
@@ -1364,6 +1465,8 @@ paths:
1364
1465
  post:
1365
1466
  summary: Update and Send Document
1366
1467
  description: Updates a draft document and sends it to be signed by recipients.
1468
+ `subject` and `message` apply to email notifications only; SMS notifications
1469
+ always use fixed system templates.
1367
1470
  tags:
1368
1471
  - Document
1369
1472
  security:
@@ -1381,16 +1484,16 @@ paths:
1381
1484
  content:
1382
1485
  application/json:
1383
1486
  example:
1384
- id: deca430d-99eb-4f40-8042-a6b41624f19e
1487
+ id: 6d33510d-2360-4c38-bf06-26630751eb80
1385
1488
  archived: false
1386
1489
  copied_contacts:
1387
- - email: alleen@smitham.example
1388
- name: Joye Hills
1389
- created_at: '2026-03-31T15:46:51Z'
1390
- custom_requester_email: crystle.ohara@konopelski-boyer.test
1391
- custom_requester_name: Jango Fett
1490
+ - email: toney@willms.test
1491
+ name: Anne Walker
1492
+ created_at: '2026-09-09T14:04:20Z'
1493
+ custom_requester_email: trista@gulgowski.example
1494
+ custom_requester_name: Leia Organa
1392
1495
  decline_redirect_url: https://www.domain.com/decline_path/
1393
- embedded_edit_url: https://www.signwell.com/edit/document/c030b003-efc9-4462-a30f-333e4fb416c7/
1496
+ embedded_edit_url: https://www.signwell.com/edit/document/5ae10a22-e89a-4d2d-8a0f-3b37d076a759/
1394
1497
  embedded_preview_url:
1395
1498
  error_message:
1396
1499
  fields:
@@ -1425,13 +1528,13 @@ paths:
1425
1528
  x: 1.1
1426
1529
  "y": 1.1
1427
1530
  page: 1
1428
- recipient_id: b9bc58e7-a95c-4137-933c-7968aa9122cd
1531
+ recipient_id: 0e56f9e2-a20b-4796-b85c-eba7c7b7c386
1429
1532
  labels:
1430
- - id: 7388da56-d911-4b3a-b809-3b4a56e0ee5f
1533
+ - id: 046f75ee-4d1e-4d08-8f76-1eb4c7208e32
1431
1534
  name: My First Label
1432
- - id: c639eb49-f658-486b-9dbc-dd2ab79a3dda
1535
+ - id: 12fb9cb0-9d41-49e2-9ba3-2f81a036f729
1433
1536
  name: My Second Label
1434
- - id: 46557ebc-6d03-4a8e-a1a8-02b44e178c13
1537
+ - id: bc087dac-7f79-4ca6-8db4-36f2352d6abe
1435
1538
  name: My Third Label
1436
1539
  language: en
1437
1540
  metadata:
@@ -1439,11 +1542,11 @@ paths:
1439
1542
  key2: value2
1440
1543
  name: Agreement
1441
1544
  recipients:
1442
- - id: b9bc58e7-a95c-4137-933c-7968aa9122cd
1545
+ - id: 0e56f9e2-a20b-4796-b85c-eba7c7b7c386
1443
1546
  attachment_requests: []
1444
- email: enrique.kohler@price.test
1547
+ email: travis_vonrueden@beier.test
1445
1548
  message:
1446
- name: Clarinda Block CPA
1549
+ name: Emil Brakus
1447
1550
  passcode:
1448
1551
  send_email_delay:
1449
1552
  signing_order: 7
@@ -1452,12 +1555,13 @@ paths:
1452
1555
  bounced:
1453
1556
  bounced_details:
1454
1557
  send_email:
1455
- signing_url: https://www.signwell.com/docs/e9be3e29e7/
1456
- - id: 30ca2873-cf42-4fba-abaa-2aaaaac8e532
1558
+ signing_url: https://www.signwell.com/docs/034f4c9932/
1559
+ delivery_method: email
1560
+ - id: 7aa4aa3e-39d0-4d02-a622-acefcaa08d55
1457
1561
  attachment_requests: []
1458
- email: trent_pouros@pfeffer-runte.example
1562
+ email: carson_wiza@bins.example
1459
1563
  message:
1460
- name: Shandi Kuphal
1564
+ name: Xiao Okuneva
1461
1565
  passcode:
1462
1566
  send_email_delay:
1463
1567
  signing_order: 8
@@ -1466,12 +1570,16 @@ paths:
1466
1570
  bounced:
1467
1571
  bounced_details:
1468
1572
  send_email:
1469
- signing_url: https://www.signwell.com/docs/c3fe92b5c2/
1573
+ signing_url: https://www.signwell.com/docs/c097ceb15c/
1574
+ delivery_method: email
1470
1575
  subject: Normal subject
1471
1576
  test_mode: false
1472
- updated_at: '2026-03-31T15:46:51Z'
1577
+ updated_at: '2026-09-09T14:04:21Z'
1473
1578
  decline_message:
1474
1579
  api_application_id:
1580
+ cfr_part11: false
1581
+ cfr_part11_signing_mode:
1582
+ embedded:
1475
1583
  allow_decline: true
1476
1584
  allow_reassign: true
1477
1585
  apply_signing_order: false
@@ -1479,12 +1587,13 @@ paths:
1479
1587
  expires_in: 365
1480
1588
  message: Normal Body
1481
1589
  reminders: true
1482
- requester_email_address: poopybutthole_15_mr@runolfsson-nienow.example
1590
+ requester_email_address: mr.goldenfold.19@koss-barrows.test
1483
1591
  redirect_url: https://www.domain.com/redirect_path/
1484
1592
  status: Draft
1485
1593
  files:
1486
- - name: consectetur.jpeg
1594
+ - name: consectetur.pptx
1487
1595
  pages_number: 1
1596
+ conditional_rules: []
1488
1597
  schema:
1489
1598
  "$ref": "#/components/schemas/DocumentResponse"
1490
1599
  '422':
@@ -1531,7 +1640,9 @@ paths:
1531
1640
  IDs must be retrieved from the Get Document response. Allowed document statuses:
1532
1641
  sent, viewed, pending, bounced. For non-embedded documents, updated recipients
1533
1642
  will receive a new notification email. For embedded signing documents, email
1534
- behavior follows each recipient''s send_email setting.'
1643
+ behavior follows each recipient''s send_email setting. This endpoint does
1644
+ not support changing a recipient''s `delivery_method` or `phone_number`; SMS
1645
+ delivery settings are set when the document is created.'
1535
1646
  tags:
1536
1647
  - Document
1537
1648
  security:
@@ -1549,41 +1660,44 @@ paths:
1549
1660
  content:
1550
1661
  application/json:
1551
1662
  example:
1552
- id: 8e9b4d47-0648-44a0-a65c-20bba1a1f96b
1663
+ id: 9ce7d4a2-5fc7-4a04-900c-a1d331abea25
1553
1664
  archived: false
1554
- created_at: '2026-03-31T15:46:52Z'
1665
+ created_at: '2026-09-09T14:04:21Z'
1555
1666
  decline_message:
1556
1667
  embedded_edit_url:
1557
1668
  error_message:
1558
- embedded_preview_url: https://www.signwell.com/preview/document/8e9b4d47-0648-44a0-a65c-20bba1a1f96b/
1669
+ embedded_preview_url: https://www.signwell.com/preview/document/9ce7d4a2-5fc7-4a04-900c-a1d331abea25/
1559
1670
  language: en
1560
- name: cutting-relationship/cumque.odp
1561
- requester_email_address: abradolf_lincler_21@rohan.example
1671
+ name: hypothesis_branch/ut.avi
1672
+ requester_email_address: loggins_25@beer.test
1562
1673
  status: Sent
1563
1674
  test_mode: false
1564
- updated_at: '2026-03-31T15:46:53Z'
1675
+ updated_at: '2026-09-09T14:04:22Z'
1676
+ cfr_part11: false
1677
+ cfr_part11_signing_mode:
1565
1678
  allow_decline: true
1566
1679
  allow_reassign: true
1567
1680
  api_application_id:
1568
- custom_requester_email: hugh@larkin.test
1569
- custom_requester_name: Yoda
1570
- decline_redirect_url: http://tremblay.test/lorenzo_predovic
1681
+ custom_requester_email: glayds@stehr.example
1682
+ custom_requester_name: Sabine Wren
1683
+ decline_redirect_url: http://stamm.test/londa
1571
1684
  embedded_signing: false
1572
1685
  expires_in: 10
1573
1686
  metadata:
1574
- velit: occaecati
1575
- pariatur: ut
1576
- redirect_url: http://beier-schimmel.example/cornell.reichert
1687
+ nostrum: soluta
1688
+ quaerat: harum
1689
+ redirect_url: http://klein-shields.test/angla
1577
1690
  reminders: false
1691
+ embedded:
1578
1692
  apply_signing_order: false
1579
1693
  message: "<p>Hey there,</p><p>&nbsp;</p><p>Please review and complete
1580
1694
  this document. You can click on the document below to get started.</p>"
1581
- subject: Please complete cutting-relationship/cumque.odp
1695
+ subject: Please complete hypothesis_branch/ut.avi
1582
1696
  labels:
1583
- - id: f50f20b5-f669-4275-b6dc-59f1fd5e70f5
1584
- name: Curtis Cummerata
1585
- - id: 22a174fa-d60d-4ab8-ad87-f1b1d0c9e59c
1586
- name: Fr. Ike Grant
1697
+ - id: f57e2ef7-1d1d-430d-8b67-ef465f2c55bc
1698
+ name: Rep. Corrin Jacobi
1699
+ - id: f317b525-0a6e-4922-afc6-5730d1a5f2b8
1700
+ name: Gov. Olen Wiza
1587
1701
  fields:
1588
1702
  - - api_id: CheckBox_14
1589
1703
  height: '13.0'
@@ -1596,7 +1710,7 @@ paths:
1596
1710
  "y": 1.1
1597
1711
  name:
1598
1712
  recipient_id:
1599
- signing_elements_group_id: 2afe4442-28ce-4297-87fd-b4cc84dcb12e
1713
+ signing_elements_group_id: 063ef930-5a79-4de1-a964-ea318691b24b
1600
1714
  - api_id: CheckBox_15
1601
1715
  height: '13.0'
1602
1716
  page: 1
@@ -1617,16 +1731,17 @@ paths:
1617
1731
  width: '112.0'
1618
1732
  x: 1.1
1619
1733
  "y": 1.1
1620
- recipient_id: cb5cdf15-ba7e-439b-8805-1a2a93f124d4
1734
+ recipient_id: 813d0b79-f675-44f7-bdcf-72e845260797
1621
1735
  files:
1622
- - name: et.mov
1736
+ - name: odio.pdf
1623
1737
  pages_number: 1
1624
1738
  copied_contacts:
1625
- - name: Palmira Johnson
1626
- email: gerry_tremblay@casper-kuhic.example
1739
+ - name: Graig Johns
1740
+ email: homer@tremblay.example
1627
1741
  recipients:
1628
- - email: updated@example.com
1629
- id: cb5cdf15-ba7e-439b-8805-1a2a93f124d4
1742
+ - delivery_method: email
1743
+ email: updated@example.com
1744
+ id: 813d0b79-f675-44f7-bdcf-72e845260797
1630
1745
  message:
1631
1746
  name: Updated Name
1632
1747
  passcode:
@@ -1635,46 +1750,48 @@ paths:
1635
1750
  status:
1636
1751
  subject:
1637
1752
  signing_order: 13
1638
- signing_url: https://www.signwell.com/docs/4df237952f/
1753
+ signing_url: https://www.signwell.com/docs/5f707867c9/
1639
1754
  bounced:
1640
1755
  bounced_details:
1756
+ passcode_delivery:
1757
+ enabled: false
1758
+ methods:
1759
+ expire_after_access: false
1641
1760
  attachment_requests:
1642
- - name: stuff_exhibition/ea.jpeg
1761
+ - name: strap-diagram/ratione.pdf
1643
1762
  required: true
1644
- url: https://www.signwell.com/document_attachments/X1zKblna5Gf2QRnLKw1ohRBWZ71/?access=12f2922b-6ad7-47c3-9604-0fedf58ddb3b
1645
- - email: kacey.kautzer@kutch.test
1646
- id: d4aa0b84-f4d2-46d8-a6ac-9e42d9786789
1763
+ url: https://www.signwell.com/document_attachments/YPZ8wOaW97Ie54LRZGRbTNP7dQ3N/?access=77ad20f9-8ae9-4afa-b37a-631964e99a7f
1764
+ - delivery_method: email
1765
+ email: alfredo@oconner-schoen.example
1766
+ id: 72334ccd-5c38-4773-8d2a-18d0fbeaecf2
1647
1767
  message:
1648
- name: Exie Vandervort
1768
+ name: Loise Jenkins
1649
1769
  passcode:
1650
1770
  send_email:
1651
1771
  send_email_delay:
1652
1772
  status:
1653
1773
  subject:
1654
1774
  signing_order: 14
1655
- signing_url: https://www.signwell.com/docs/42f6910bae/
1775
+ signing_url: https://www.signwell.com/docs/0e32d703ab/
1656
1776
  bounced:
1657
1777
  bounced_details:
1778
+ passcode_delivery:
1779
+ enabled: false
1780
+ methods:
1781
+ expire_after_access: false
1658
1782
  attachment_requests: []
1659
1783
  checkbox_groups:
1660
- - id: 2afe4442-28ce-4297-87fd-b4cc84dcb12e
1784
+ - id: 063ef930-5a79-4de1-a964-ea318691b24b
1661
1785
  group_name:
1662
1786
  recipient_id:
1663
1787
  checkbox_ids:
1664
1788
  - CheckBox_14
1665
1789
  validation:
1666
1790
  required: false
1791
+ conditional_rules: []
1792
+ conditional_logic_decisions: []
1667
1793
  schema:
1668
1794
  "$ref": "#/components/schemas/DocumentResponse"
1669
- '409':
1670
- description: conflict - document not in eligible state
1671
- content:
1672
- application/json:
1673
- example:
1674
- errors:
1675
- base:
1676
- - Document in 'completed' status cannot have recipients managed.
1677
- Only sent, viewed, pending, or bounced documents are eligible.
1678
1795
  '400':
1679
1796
  description: bad request - invalid structure
1680
1797
  content:
@@ -1685,16 +1802,6 @@ paths:
1685
1802
  - recipients
1686
1803
  base:
1687
1804
  - The request contains invalid key values.
1688
- '422':
1689
- description: unprocessable entity - business rule violation
1690
- content:
1691
- application/json:
1692
- example:
1693
- errors:
1694
- recipients[59cc95d7-2c7e-44b7-8767-f9b0904e74ce]:
1695
- - Amb. Mitchel Gutkowski (fredric@kihn.test) has started signing
1696
- so you can't edit or replace them now. You can Update & Resend
1697
- if you need to change recipients who already started signing.
1698
1805
  '404':
1699
1806
  description: not found
1700
1807
  content:
@@ -1706,6 +1813,25 @@ paths:
1706
1813
  message: Couldn't find the document requested
1707
1814
  messages:
1708
1815
  - Couldn't find the document requested
1816
+ '409':
1817
+ description: conflict - document not in eligible state
1818
+ content:
1819
+ application/json:
1820
+ example:
1821
+ errors:
1822
+ base:
1823
+ - Document in 'completed' status cannot have recipients managed.
1824
+ Only sent, viewed, pending, or bounced documents are eligible.
1825
+ '422':
1826
+ description: unprocessable entity - business rule violation
1827
+ content:
1828
+ application/json:
1829
+ example:
1830
+ errors:
1831
+ recipients[a384fdbd-ba45-473d-8b3a-3d295ab3a06b]:
1832
+ - Earle Spinka (abby.ortiz@schoen.test) has started signing so you
1833
+ can't edit or replace them now. You can Update & Resend if you
1834
+ need to change recipients who already started signing.
1709
1835
  '429':
1710
1836
  description: rate limit exceeded
1711
1837
  content:
@@ -1718,15 +1844,16 @@ paths:
1718
1844
  schema:
1719
1845
  "$ref": "#/components/schemas/update_recipients_request"
1720
1846
  required: true
1721
- "/api/v1/documents/{id}/remind":
1722
- post:
1723
- summary: Send Reminder
1724
- description: Sends a reminder email to recipients that have not signed yet.
1847
+ "/api/v1/documents/{id}/authentication":
1848
+ patch:
1849
+ summary: Update Authentication
1850
+ description: Update passcode delivery settings for recipients on a sent document.
1851
+ Only recipients who have not started signing can be updated.
1725
1852
  tags:
1726
1853
  - Document
1727
1854
  security:
1728
1855
  - api_key: []
1729
- operationId: sendReminder
1856
+ operationId: updateAuthentication
1730
1857
  parameters:
1731
1858
  - name: id
1732
1859
  in: path
@@ -1734,46 +1861,49 @@ paths:
1734
1861
  "$ref": "#/components/schemas/DocumentId"
1735
1862
  required: true
1736
1863
  responses:
1737
- '201':
1738
- description: created
1864
+ '200':
1865
+ description: successful
1739
1866
  content:
1740
1867
  application/json:
1741
1868
  example:
1742
- id: 55c90c31-54e1-48c0-8b01-a57324764f50
1869
+ id: d4d77ebd-3d6b-427f-8ec7-6b5831251171
1743
1870
  archived: false
1744
- created_at: '2026-03-31T15:46:56Z'
1871
+ created_at: '2026-09-09T14:04:23Z'
1745
1872
  decline_message:
1746
1873
  embedded_edit_url:
1747
1874
  error_message:
1748
- embedded_preview_url: https://www.signwell.com/preview/document/55c90c31-54e1-48c0-8b01-a57324764f50/
1875
+ embedded_preview_url: https://www.signwell.com/preview/document/d4d77ebd-3d6b-427f-8ec7-6b5831251171/
1749
1876
  language: en
1750
- name: cutting_confuse/et.avi
1751
- requester_email_address: 36.arthricia@damore.test
1877
+ name: patience-brown/ut.odt
1878
+ requester_email_address: birdperson_40@berge.test
1752
1879
  status: Sent
1753
1880
  test_mode: false
1754
- updated_at: '2026-03-31T15:46:57Z'
1881
+ updated_at: '2026-09-09T14:04:24Z'
1882
+ cfr_part11: false
1883
+ cfr_part11_signing_mode:
1755
1884
  allow_decline: true
1756
1885
  allow_reassign: true
1757
1886
  api_application_id:
1758
- custom_requester_email: bryce@bayer.example
1759
- custom_requester_name: Wedge Antilles
1760
- decline_redirect_url: http://orn-grady.test/eryn
1887
+ custom_requester_email: alfredo@bogisich-okeefe.example
1888
+ custom_requester_name: Sheev Palpatine
1889
+ decline_redirect_url: http://conn.test/nicolas
1761
1890
  embedded_signing: false
1762
1891
  expires_in: 10
1763
1892
  metadata:
1764
- est: quae
1765
- iure: perspiciatis
1766
- redirect_url: http://corkery.example/jared.reinger
1893
+ expedita: hic
1894
+ voluptatibus: tempore
1895
+ redirect_url: http://waelchi-feeney.example/holley.rice
1767
1896
  reminders: true
1897
+ embedded:
1768
1898
  apply_signing_order: false
1769
1899
  message: "<p>Hey there,</p><p>&nbsp;</p><p>Please review and complete
1770
1900
  this document. You can click on the document below to get started.</p>"
1771
- subject: Please complete cutting_confuse/et.avi
1901
+ subject: Please complete patience-brown/ut.odt
1772
1902
  labels:
1773
- - id: 2aab0d33-2ac9-4687-9b13-fcddb10f68ea
1774
- name: Chance Braun
1775
- - id: 20bdd21c-377c-40a2-a546-2902da2e2ac2
1776
- name: The Hon. Rico Koch
1903
+ - id: 0e7a217b-c17f-4e4b-ad4d-0d3cfcca6352
1904
+ name: Jenny Kuhlman
1905
+ - id: 655c01ed-ae93-467b-b98d-5350e32231f8
1906
+ name: Gay Muller
1777
1907
  fields:
1778
1908
  - - api_id: CheckBox_29
1779
1909
  height: '13.0'
@@ -1786,7 +1916,7 @@ paths:
1786
1916
  "y": 1.1
1787
1917
  name:
1788
1918
  recipient_id:
1789
- signing_elements_group_id: a2c21918-23b3-49aa-b387-be1a7fe6d0ba
1919
+ signing_elements_group_id: 25b9a0b9-db2a-412a-bf69-19b3ed50aa16
1790
1920
  - api_id: CheckBox_30
1791
1921
  height: '13.0'
1792
1922
  page: 1
@@ -1807,62 +1937,76 @@ paths:
1807
1937
  width: '112.0'
1808
1938
  x: 1.1
1809
1939
  "y": 1.1
1810
- recipient_id: c93c0059-57a2-4db3-9bc7-142ab408848a
1940
+ recipient_id: 5f93fb82-f089-4d79-acb6-5ee187572c58
1811
1941
  files:
1812
- - name: magni.png
1942
+ - name: qui.tiff
1813
1943
  pages_number: 1
1814
1944
  copied_contacts:
1815
- - name: Gov. Tanner Volkman
1816
- email: jonas_towne@cronin.test
1945
+ - name: Will Ruecker
1946
+ email: deonna@macejkovic-cole.example
1817
1947
  recipients:
1818
- - email: lowell@yost.example
1819
- id: c93c0059-57a2-4db3-9bc7-142ab408848a
1948
+ - delivery_method: email
1949
+ email: brynn_kassulke@pfannerstill.test
1950
+ id: 5f93fb82-f089-4d79-acb6-5ee187572c58
1820
1951
  message:
1821
- name: Lupe Padberg
1952
+ name: The Hon. Cordell Donnelly
1822
1953
  passcode:
1823
1954
  send_email:
1824
1955
  send_email_delay:
1825
1956
  status:
1826
1957
  subject:
1827
1958
  signing_order: 28
1828
- signing_url: https://www.signwell.com/docs/3bf8835bc7/
1959
+ signing_url: https://www.signwell.com/docs/94aed2faa7/
1829
1960
  bounced:
1830
1961
  bounced_details:
1962
+ passcode_delivery:
1963
+ enabled: true
1964
+ methods:
1965
+ - email
1966
+ expire_after_access: false
1831
1967
  attachment_requests:
1832
- - name: doctor_agree/perferendis.mov
1968
+ - name: distant-seller/iusto.jpeg
1833
1969
  required: true
1834
- url: https://www.signwell.com/document_attachments/8R3LMelr37iBjDYnq3onF88KaKg/?access=d0a14244-884b-4a00-b629-f11faad3e816
1835
- - email: elwanda@wuckert-wolf.test
1836
- id: 912aebe7-868a-414f-b553-9182641c4686
1970
+ url: https://www.signwell.com/document_attachments/A68YjKlQKBI7GgyzGl4QTgMeKPZ/?access=9fadae33-9f78-4112-970b-7c3a6b3f4299
1971
+ - delivery_method: email
1972
+ email: lauralee_parisian@reinger-ratke.test
1973
+ id: afb00a0e-b8bf-4244-935c-c477ec35227e
1837
1974
  message:
1838
- name: Pat Bergnaum Sr.
1975
+ name: Adam Bins
1839
1976
  passcode:
1840
1977
  send_email:
1841
1978
  send_email_delay:
1842
1979
  status:
1843
1980
  subject:
1844
1981
  signing_order: 29
1845
- signing_url: https://www.signwell.com/docs/a7bc69c79e/
1982
+ signing_url: https://www.signwell.com/docs/80792b2855/
1846
1983
  bounced:
1847
1984
  bounced_details:
1985
+ passcode_delivery:
1986
+ enabled: false
1987
+ methods:
1988
+ expire_after_access: false
1848
1989
  attachment_requests: []
1849
1990
  checkbox_groups:
1850
- - id: a2c21918-23b3-49aa-b387-be1a7fe6d0ba
1991
+ - id: 25b9a0b9-db2a-412a-bf69-19b3ed50aa16
1851
1992
  group_name:
1852
1993
  recipient_id:
1853
1994
  checkbox_ids:
1854
1995
  - CheckBox_29
1855
1996
  validation:
1856
1997
  required: false
1857
- '422':
1858
- description: unprocessable entity
1998
+ conditional_rules: []
1999
+ conditional_logic_decisions: []
2000
+ schema:
2001
+ "$ref": "#/components/schemas/DocumentResponse"
2002
+ '400':
2003
+ description: bad request - invalid delivery methods
1859
2004
  content:
1860
2005
  application/json:
1861
2006
  example:
1862
2007
  errors:
1863
- document: The document is in a status that cannot be reminded
1864
- schema:
1865
- "$ref": "#/components/schemas/ValidationErrorResponse"
2008
+ recipients:
2009
+ - must be a non-empty array
1866
2010
  '404':
1867
2011
  description: not found
1868
2012
  content:
@@ -1874,8 +2018,14 @@ paths:
1874
2018
  message: Couldn't find the document requested
1875
2019
  messages:
1876
2020
  - Couldn't find the document requested
1877
- schema:
1878
- "$ref": "#/components/schemas/ErrorResponse"
2021
+ '422':
2022
+ description: unprocessable entity - invalid delivery methods
2023
+ content:
2024
+ application/json:
2025
+ example:
2026
+ errors:
2027
+ recipients[0].passcode_delivery.methods:
2028
+ - 'contains unsupported delivery methods: sms'
1879
2029
  '429':
1880
2030
  description: rate limit exceeded
1881
2031
  content:
@@ -1886,49 +2036,164 @@ paths:
1886
2036
  content:
1887
2037
  application/json:
1888
2038
  schema:
1889
- "$ref": "#/components/schemas/SendReminderRequest"
2039
+ "$ref": "#/components/schemas/update_authentication_request"
1890
2040
  required: true
1891
- "/api/v1/documents/{id}/completed_pdf":
1892
- get:
1893
- summary: Completed PDF
1894
- description: Gets a completed document PDF or ZIP file. Supply the unique document
1895
- ID from either a document creation request or document page URL.
2041
+ "/api/v1/documents/{id}/remind":
2042
+ post:
2043
+ summary: Send Reminder
2044
+ description: Sends a reminder to recipients who have not signed yet. Each recipient
2045
+ is reminded through their delivery method (email, SMS, or both). SMS reminders
2046
+ are only sent to recipients whose delivery method includes SMS, and only when
2047
+ the workspace is eligible for SMS and has it enabled.
1896
2048
  tags:
1897
2049
  - Document
1898
2050
  security:
1899
2051
  - api_key: []
1900
- operationId: getCompletedPdf
2052
+ operationId: sendReminder
1901
2053
  parameters:
1902
2054
  - name: id
1903
2055
  in: path
1904
2056
  schema:
1905
- "$ref": "#/components/schemas/CompletedDocumentId"
2057
+ "$ref": "#/components/schemas/DocumentId"
1906
2058
  required: true
1907
- - name: url_only
1908
- in: query
1909
- schema:
1910
- "$ref": "#/components/schemas/UrlOnly"
1911
- - name: audit_page
1912
- in: query
1913
- schema:
1914
- "$ref": "#/components/schemas/IncludeAuditPage"
1915
- - name: file_format
1916
- in: query
1917
- schema:
1918
- "$ref": "#/components/schemas/FileFormat"
1919
2059
  responses:
1920
- '200':
1921
- description: successful, returns the final completed PDF, or if url_only
1922
- is set to true, a JSON object is returned. When url_only=false (default),
1923
- the response is the raw PDF or ZIP binary data.
2060
+ '201':
2061
+ description: created
1924
2062
  content:
1925
2063
  application/json:
1926
2064
  example:
1927
- file_url: https://www.signwell.com/signed/9rrKOB86EBc7ZMwwdYN8Ha63Wrl.pdf?audit_page=true
1928
- schema:
1929
- "$ref": "#/components/schemas/CompletedPdfResponse"
2065
+ id: 7ed1b1c6-a10f-4c36-aee4-59e2a98e69d8
2066
+ archived: false
2067
+ created_at: '2026-09-09T14:04:25Z'
2068
+ decline_message:
2069
+ embedded_edit_url:
2070
+ error_message:
2071
+ embedded_preview_url: https://www.signwell.com/preview/document/7ed1b1c6-a10f-4c36-aee4-59e2a98e69d8/
2072
+ language: en
2073
+ name: figure-strikebreaker/laborum.html
2074
+ requester_email_address: morty.jr.52@shields-parisian.example
2075
+ status: Sent
2076
+ test_mode: false
2077
+ updated_at: '2026-09-09T14:04:25Z'
2078
+ cfr_part11: false
2079
+ cfr_part11_signing_mode:
2080
+ allow_decline: false
2081
+ allow_reassign: true
2082
+ api_application_id:
2083
+ custom_requester_email: scottie@cassin.example
2084
+ custom_requester_name: Chirrut Imwe
2085
+ decline_redirect_url: http://osinski.example/chanell
2086
+ embedded_signing: false
2087
+ expires_in: 10
2088
+ metadata:
2089
+ ut: qui
2090
+ molestiae: soluta
2091
+ redirect_url: http://collins.test/devin
2092
+ reminders: true
2093
+ embedded:
2094
+ apply_signing_order: false
2095
+ message: "<p>Hey there,</p><p>&nbsp;</p><p>Please review and complete
2096
+ this document. You can click on the document below to get started.</p>"
2097
+ subject: Please complete figure-strikebreaker/laborum.html
2098
+ labels:
2099
+ - id: 8d65a497-8c4a-460b-9f8c-5378893f9c25
2100
+ name: Crista Wilkinson
2101
+ - id: e4e55389-fc80-40aa-bf93-48b6fc54b129
2102
+ name: Dr. Ezekiel Harber
2103
+ fields:
2104
+ - - api_id: CheckBox_41
2105
+ height: '13.0'
2106
+ page: 1
2107
+ required: true
2108
+ type: checkbox
2109
+ value:
2110
+ width: '13.0'
2111
+ x: 1.1
2112
+ "y": 1.1
2113
+ name:
2114
+ recipient_id:
2115
+ signing_elements_group_id: 1919a9fd-59ea-4499-8db3-7da4d73c1017
2116
+ - api_id: CheckBox_42
2117
+ height: '13.0'
2118
+ page: 1
2119
+ required: true
2120
+ type: checkbox
2121
+ value:
2122
+ width: '13.0'
2123
+ x: 1.1
2124
+ "y": 1.1
2125
+ name:
2126
+ recipient_id:
2127
+ - api_id: Signature_40
2128
+ height: '32.0'
2129
+ page: 1
2130
+ required: true
2131
+ type: signature
2132
+ value:
2133
+ width: '112.0'
2134
+ x: 1.1
2135
+ "y": 1.1
2136
+ recipient_id: 806f9e8a-7e95-4a39-8060-bae673910849
2137
+ files:
2138
+ - name: voluptatem.webm
2139
+ pages_number: 1
2140
+ copied_contacts:
2141
+ - name: Ms. Charlie Hermiston
2142
+ email: julius@pollich.example
2143
+ recipients:
2144
+ - delivery_method: email
2145
+ email: hilario_bahringer@lubowitz-pagac.example
2146
+ id: 806f9e8a-7e95-4a39-8060-bae673910849
2147
+ message:
2148
+ name: Russ O'Connell
2149
+ passcode:
2150
+ send_email:
2151
+ send_email_delay:
2152
+ status:
2153
+ subject:
2154
+ signing_order: 40
2155
+ signing_url: https://www.signwell.com/docs/8b815103b0/
2156
+ bounced:
2157
+ bounced_details:
2158
+ passcode_delivery:
2159
+ enabled: false
2160
+ methods:
2161
+ expire_after_access: false
2162
+ attachment_requests:
2163
+ - name: book-glow/aut.key
2164
+ required: true
2165
+ url: https://www.signwell.com/document_attachments/kJbZABg7JntY0L1kJb0WHYYJjE2/?access=ba1e35d4-92d0-4469-bbd8-b96280d6515a
2166
+ - delivery_method: email
2167
+ email: farrah_okuneva@batz.example
2168
+ id: d68e369f-2818-4aca-964f-a0f0eed3f3d8
2169
+ message:
2170
+ name: Wendell Zemlak
2171
+ passcode:
2172
+ send_email:
2173
+ send_email_delay:
2174
+ status:
2175
+ subject:
2176
+ signing_order: 41
2177
+ signing_url: https://www.signwell.com/docs/59f9355ce3/
2178
+ bounced:
2179
+ bounced_details:
2180
+ passcode_delivery:
2181
+ enabled: false
2182
+ methods:
2183
+ expire_after_access: false
2184
+ attachment_requests: []
2185
+ checkbox_groups:
2186
+ - id: 1919a9fd-59ea-4499-8db3-7da4d73c1017
2187
+ group_name:
2188
+ recipient_id:
2189
+ checkbox_ids:
2190
+ - CheckBox_41
2191
+ validation:
2192
+ required: false
2193
+ conditional_rules: []
2194
+ conditional_logic_decisions: []
1930
2195
  '404':
1931
- description: not_found
2196
+ description: not found
1932
2197
  content:
1933
2198
  application/json:
1934
2199
  example:
@@ -1940,127 +2205,77 @@ paths:
1940
2205
  - Couldn't find the document requested
1941
2206
  schema:
1942
2207
  "$ref": "#/components/schemas/ErrorResponse"
1943
- '429':
1944
- description: rate limit exceeded
1945
- content:
1946
- application/json:
1947
- schema:
1948
- "$ref": "#/components/schemas/RateLimitErrorResponse"
1949
- "/api/v1/document_templates":
1950
- get:
1951
- summary: List Templates
1952
- description: Returns a paginated list of templates for the authenticated account.
1953
- tags:
1954
- - Template
1955
- security:
1956
- - api_key: []
1957
- operationId: listTemplates
1958
- x-internal: true
1959
- parameters:
1960
- - name: page
1961
- in: query
1962
- schema:
1963
- "$ref": "#/components/schemas/Page"
1964
- required: false
1965
- - name: limit
1966
- in: query
1967
- schema:
1968
- "$ref": "#/components/schemas/Limit"
1969
- required: false
1970
- responses:
1971
- '200':
1972
- description: successful
2208
+ '422':
2209
+ description: unprocessable entity
1973
2210
  content:
1974
2211
  application/json:
1975
2212
  example:
1976
- templates:
1977
- - id: bb3c3fba-116f-4b76-8ad8-5469c435f990
1978
- archived: false
1979
- created_at: '2026-03-31T15:47:00Z'
1980
- embedded_edit_url: https://www.signwell.com/edit/template/33f4447c-bdb2-4d3e-87b1-f57126549715/
1981
- language: en
1982
- name: miscarriage_branch/pariatur.tiff
1983
- requester_email_address: 53.tiny.rick@towne.example
1984
- status: Created
1985
- template_link: https://www.signwell.com/new_doc/y8cjPd25fuSHMBvi/
1986
- updated_at: '2026-03-31T15:47:00Z'
1987
- allow_decline:
1988
- allow_reassign:
1989
- api_application_id:
1990
- decline_redirect_url:
1991
- expires_in:
1992
- redirect_url:
1993
- reminders:
1994
- metadata:
1995
- fields: []
1996
- files: []
1997
- copied_placeholders: []
1998
- placeholders: []
1999
- checkbox_groups: []
2000
- - id: 959e6f6a-8a95-47b1-9e86-eb8b1da5a8aa
2001
- archived: false
2002
- created_at: '2026-03-31T15:47:00Z'
2003
- embedded_edit_url: https://www.signwell.com/edit/template/d5f6572b-bcae-4c48-b187-540e577fb95a/
2004
- language: en
2005
- name: story_patience/eos.jpg
2006
- requester_email_address: 53.tiny.rick@towne.example
2007
- status: Created
2008
- template_link: https://www.signwell.com/new_doc/GfCKlbdBrLhLsHtX/
2009
- updated_at: '2026-03-31T15:47:00Z'
2010
- allow_decline:
2011
- allow_reassign:
2012
- api_application_id:
2013
- decline_redirect_url:
2014
- expires_in:
2015
- redirect_url:
2016
- reminders:
2017
- metadata:
2018
- fields: []
2019
- files: []
2020
- copied_placeholders: []
2021
- placeholders: []
2022
- checkbox_groups: []
2023
- - id: 2038bbde-3423-43b1-991b-89e93a679511
2024
- archived: false
2025
- created_at: '2026-03-31T15:47:00Z'
2026
- embedded_edit_url: https://www.signwell.com/edit/template/e15e7107-498a-49c7-a5b2-4b0815744da1/
2027
- language: en
2028
- name: book-notebook/iure.mov
2029
- requester_email_address: 53.tiny.rick@towne.example
2030
- status: Created
2031
- template_link: https://www.signwell.com/new_doc/Qz2nb9ZeTqpsoBId/
2032
- updated_at: '2026-03-31T15:47:00Z'
2033
- allow_decline:
2034
- allow_reassign:
2035
- api_application_id:
2036
- decline_redirect_url:
2037
- expires_in:
2038
- redirect_url:
2039
- reminders:
2040
- metadata:
2041
- fields: []
2042
- files: []
2043
- copied_placeholders: []
2044
- placeholders: []
2045
- checkbox_groups: []
2046
- current_page: 1
2047
- next_page:
2048
- previous_page:
2049
- total_count: 3
2050
- total_pages: 1
2213
+ errors:
2214
+ document: The document is in a status that cannot be reminded
2051
2215
  schema:
2052
- "$ref": "#/components/schemas/DocumentTemplateListResponse"
2053
- '401':
2054
- description: unauthorized
2216
+ "$ref": "#/components/schemas/ValidationErrorResponse"
2217
+ '429':
2218
+ description: rate limit exceeded
2219
+ content:
2220
+ application/json:
2221
+ schema:
2222
+ "$ref": "#/components/schemas/RateLimitErrorResponse"
2223
+ requestBody:
2224
+ content:
2225
+ application/json:
2226
+ schema:
2227
+ "$ref": "#/components/schemas/SendReminderRequest"
2228
+ required: true
2229
+ "/api/v1/documents/{id}/completed_pdf":
2230
+ get:
2231
+ summary: Completed PDF
2232
+ description: Gets a completed document PDF or ZIP file. Supply the unique document
2233
+ ID from either a document creation request or document page URL.
2234
+ tags:
2235
+ - Document
2236
+ security:
2237
+ - api_key: []
2238
+ operationId: getCompletedPdf
2239
+ parameters:
2240
+ - name: id
2241
+ in: path
2242
+ schema:
2243
+ "$ref": "#/components/schemas/CompletedDocumentId"
2244
+ required: true
2245
+ - name: url_only
2246
+ in: query
2247
+ schema:
2248
+ "$ref": "#/components/schemas/UrlOnly"
2249
+ - name: audit_page
2250
+ in: query
2251
+ schema:
2252
+ "$ref": "#/components/schemas/IncludeAuditPage"
2253
+ - name: file_format
2254
+ in: query
2255
+ schema:
2256
+ "$ref": "#/components/schemas/FileFormat"
2257
+ responses:
2258
+ '200':
2259
+ description: successful, returns the final completed PDF, or if url_only
2260
+ is set to true, a JSON object is returned. When url_only=false (default),
2261
+ the response is the raw PDF or ZIP binary data.
2055
2262
  content:
2056
2263
  application/json:
2057
2264
  example:
2058
- message: Missing or invalid authorization key
2265
+ file_url: https://www.signwell.com/signed/OMz04yD8ZAHa3dLRJGQZhKKnnqq.pdf?audit_page=true
2266
+ schema:
2267
+ "$ref": "#/components/schemas/CompletedPdfResponse"
2268
+ '404':
2269
+ description: not_found
2270
+ content:
2271
+ application/json:
2272
+ example:
2273
+ message: Not found
2059
2274
  meta:
2060
- error: api_key_unauthorized_error
2061
- message: Not valid authorization token
2275
+ error: record_not_found
2276
+ message: Couldn't find the document requested
2062
2277
  messages:
2063
- - Not valid authorization token
2278
+ - Couldn't find the document requested
2064
2279
  schema:
2065
2280
  "$ref": "#/components/schemas/ErrorResponse"
2066
2281
  '429':
@@ -2069,6 +2284,7 @@ paths:
2069
2284
  application/json:
2070
2285
  schema:
2071
2286
  "$ref": "#/components/schemas/RateLimitErrorResponse"
2287
+ "/api/v1/document_templates":
2072
2288
  post:
2073
2289
  summary: Create Template
2074
2290
  description: Creates a new template.
@@ -2084,16 +2300,16 @@ paths:
2084
2300
  content:
2085
2301
  application/json:
2086
2302
  example:
2087
- id: 751f9aae-cb96-4fbe-805b-0135232823c4
2303
+ id: 66842a8c-34a6-4b98-a121-78792792ff84
2088
2304
  archived: false
2089
- created_at: '2026-03-31T15:47:02Z'
2090
- embedded_edit_url: https://www.signwell.com/edit/template/4fe3455d-6434-429f-bcd5-521c76f660f9/
2305
+ created_at: '2026-09-09T14:04:30Z'
2306
+ embedded_edit_url: https://www.signwell.com/edit/template/6b124b65-3f13-48dc-a0e4-455a92a1aedd/
2091
2307
  language: en
2092
2308
  name: Agreement
2093
- requester_email_address: loggins_76@howe-hessel.test
2309
+ requester_email_address: 96_morty_jr@dickens-waters.example
2094
2310
  status: Created
2095
- template_link: https://www.signwell.com/new_doc/c60LSiR31AhpOqZN/
2096
- updated_at: '2026-03-31T15:47:02Z'
2311
+ template_link: https://www.signwell.com/new_doc/dHb2h0soq2Rv18IG/
2312
+ updated_at: '2026-09-09T14:04:30Z'
2097
2313
  allow_decline: true
2098
2314
  allow_reassign:
2099
2315
  api_application_id:
@@ -2108,11 +2324,11 @@ paths:
2108
2324
  message: Normal Body
2109
2325
  subject: Normal subject
2110
2326
  labels:
2111
- - id: 7409f919-0ad1-4b58-90b6-293177798f0a
2327
+ - id: 2ac9ba62-0c21-4d99-be5a-ad00cd90877c
2112
2328
  name: My First Label
2113
- - id: eff4718b-56b2-47e8-9ffa-8b4420937169
2329
+ - id: 10292924-6dc6-40e9-89b7-4bdfa0253148
2114
2330
  name: My Second Label
2115
- - id: 29039f21-4b22-44d1-8dfa-5ee0696c7040
2331
+ - id: a1ced837-6e27-4c31-b1b0-1c4848b43b04
2116
2332
  name: My Third Label
2117
2333
  fields:
2118
2334
  - - api_id: DateField_1
@@ -2122,8 +2338,8 @@ paths:
2122
2338
  type: date
2123
2339
  value: 2021/05/06
2124
2340
  width: '86.0'
2125
- x: 230.0
2126
- "y": 60.0
2341
+ x: 230
2342
+ "y": 60
2127
2343
  date_format: YYYY/MM/DD
2128
2344
  formula: ''
2129
2345
  lock_sign_date: true
@@ -2135,19 +2351,8 @@ paths:
2135
2351
  type: signature
2136
2352
  value:
2137
2353
  width: '112.0'
2138
- x: 260.0
2139
- "y": 80.0
2140
- placeholder_name: Placeholder 2
2141
- - api_id: CheckBox_3
2142
- height: '13.0'
2143
- page: 1
2144
- required: true
2145
- type: checkbox
2146
- value: t
2147
- width: '13.0'
2148
- x: 260.0
2149
- "y": 80.0
2150
- name:
2354
+ x: 260
2355
+ "y": 80
2151
2356
  placeholder_name: Placeholder 2
2152
2357
  - api_id: CheckBox_4
2153
2358
  height: '13.0'
@@ -2156,8 +2361,8 @@ paths:
2156
2361
  type: checkbox
2157
2362
  value: t
2158
2363
  width: '13.0'
2159
- x: 270.0
2160
- "y": 80.0
2364
+ x: 270
2365
+ "y": 80
2161
2366
  name:
2162
2367
  placeholder_name: Placeholder 2
2163
2368
  - api_id: Initials_4
@@ -2167,8 +2372,8 @@ paths:
2167
2372
  type: initials
2168
2373
  value:
2169
2374
  width: '44.0'
2170
- x: 260.0
2171
- "y": 80.0
2375
+ x: 260
2376
+ "y": 80
2172
2377
  placeholder_name: Placeholder 2
2173
2378
  - api_id: TextField_5
2174
2379
  height: '19.0'
@@ -2177,12 +2382,23 @@ paths:
2177
2382
  type: text
2178
2383
  value: '1'
2179
2384
  width: '86.0'
2180
- x: 260.0
2181
- "y": 80.0
2385
+ x: 260
2386
+ "y": 80
2182
2387
  fixed_width: true
2183
2388
  label: label
2184
2389
  validation: numbers
2185
2390
  placeholder_name: Placeholder 2
2391
+ - api_id: CheckBox_3
2392
+ height: '13.0'
2393
+ page: 1
2394
+ required: false
2395
+ type: checkbox
2396
+ value: t
2397
+ width: '13.0'
2398
+ x: 260
2399
+ "y": 80
2400
+ name:
2401
+ placeholder_name: Placeholder 2
2186
2402
  files:
2187
2403
  - name: filename1.pdf
2188
2404
  pages_number: 0
@@ -2207,21 +2423,29 @@ paths:
2207
2423
  preassigned_recipient_name: recipient 1
2208
2424
  preassigned_recipient_email: recipient1@domain.com
2209
2425
  signing_order: 1
2426
+ passcode_delivery:
2427
+ enabled: false
2428
+ methods:
2429
+ expire_after_access: false
2210
2430
  attachment_requests:
2211
2431
  - name: normal name
2212
2432
  required: true
2213
- url: https://www.signwell.com/document_attachments/GRJPOMRKppHWdGeeXwbefy4EblMb/?access=fa3580f5-3914-447b-8b4c-c5c28b0bc8f2
2433
+ url: https://www.signwell.com/document_attachments/Wn822pe00GC5egjE1NgqFOL91XR/?access=44dedb8d-c4b1-49e8-b2a5-924491a482aa
2214
2434
  - id: placeholder_id_2
2215
2435
  name: Placeholder 2
2216
2436
  subject:
2217
2437
  message:
2218
2438
  signing_order: 2
2439
+ passcode_delivery:
2440
+ enabled: false
2441
+ methods:
2442
+ expire_after_access: false
2219
2443
  attachment_requests:
2220
2444
  - name: Driver License
2221
2445
  required: false
2222
- url: https://www.signwell.com/document_attachments/LRlW8OWw3pUGzP0jqa7Oi8kwJPY/?access=fa3580f5-3914-447b-8b4c-c5c28b0bc8f2
2446
+ url: https://www.signwell.com/document_attachments/oWLwNlk5qQCB6MMdzgqOCNeq6DO/?access=44dedb8d-c4b1-49e8-b2a5-924491a482aa
2223
2447
  checkbox_groups:
2224
- - id: 076c3f53-a7a3-4dfa-820b-22cd9c66382a
2448
+ - id: d7864adc-3126-43ad-937c-0315f1acbd12
2225
2449
  group_name: Group 1
2226
2450
  recipient_id:
2227
2451
  checkbox_ids:
@@ -2230,6 +2454,19 @@ paths:
2230
2454
  validation: minimum
2231
2455
  required: true
2232
2456
  min_value: 1
2457
+ conditional_rules:
2458
+ - id: 9a0cc870-d107-461d-9c6e-641f4e8e8502
2459
+ target_id: TextField_5
2460
+ action_type: require
2461
+ action_field_ids:
2462
+ - CheckBox_3
2463
+ conditions:
2464
+ - condition_type: any_of
2465
+ status: completed
2466
+ join_operator: and_operator
2467
+ field_api_ids:
2468
+ - TextField_5
2469
+ position: 1
2233
2470
  schema:
2234
2471
  "$ref": "#/components/schemas/DocumentTemplateResponse"
2235
2472
  '400':
@@ -2335,6 +2572,128 @@ paths:
2335
2572
  schema:
2336
2573
  "$ref": "#/components/schemas/DocumentTemplateRequest"
2337
2574
  required: true
2575
+ get:
2576
+ summary: List Templates
2577
+ description: Returns a paginated list of templates for the authenticated account.
2578
+ tags:
2579
+ - Template
2580
+ security:
2581
+ - api_key: []
2582
+ operationId: listTemplates
2583
+ x-internal: true
2584
+ parameters:
2585
+ - name: page
2586
+ in: query
2587
+ schema:
2588
+ "$ref": "#/components/schemas/Page"
2589
+ required: false
2590
+ - name: limit
2591
+ in: query
2592
+ schema:
2593
+ "$ref": "#/components/schemas/Limit"
2594
+ required: false
2595
+ responses:
2596
+ '200':
2597
+ description: successful
2598
+ content:
2599
+ application/json:
2600
+ example:
2601
+ templates:
2602
+ - id: bb3c3fba-116f-4b76-8ad8-5469c435f990
2603
+ archived: false
2604
+ created_at: '2026-03-31T15:47:00Z'
2605
+ embedded_edit_url: https://www.signwell.com/edit/template/33f4447c-bdb2-4d3e-87b1-f57126549715/
2606
+ language: en
2607
+ name: miscarriage_branch/pariatur.tiff
2608
+ requester_email_address: 53.tiny.rick@towne.example
2609
+ status: Created
2610
+ template_link: https://www.signwell.com/new_doc/y8cjPd25fuSHMBvi/
2611
+ updated_at: '2026-03-31T15:47:00Z'
2612
+ allow_decline:
2613
+ allow_reassign:
2614
+ api_application_id:
2615
+ decline_redirect_url:
2616
+ expires_in:
2617
+ redirect_url:
2618
+ reminders:
2619
+ metadata:
2620
+ fields: []
2621
+ files: []
2622
+ copied_placeholders: []
2623
+ placeholders: []
2624
+ checkbox_groups: []
2625
+ - id: 959e6f6a-8a95-47b1-9e86-eb8b1da5a8aa
2626
+ archived: false
2627
+ created_at: '2026-03-31T15:47:00Z'
2628
+ embedded_edit_url: https://www.signwell.com/edit/template/d5f6572b-bcae-4c48-b187-540e577fb95a/
2629
+ language: en
2630
+ name: story_patience/eos.jpg
2631
+ requester_email_address: 53.tiny.rick@towne.example
2632
+ status: Created
2633
+ template_link: https://www.signwell.com/new_doc/GfCKlbdBrLhLsHtX/
2634
+ updated_at: '2026-03-31T15:47:00Z'
2635
+ allow_decline:
2636
+ allow_reassign:
2637
+ api_application_id:
2638
+ decline_redirect_url:
2639
+ expires_in:
2640
+ redirect_url:
2641
+ reminders:
2642
+ metadata:
2643
+ fields: []
2644
+ files: []
2645
+ copied_placeholders: []
2646
+ placeholders: []
2647
+ checkbox_groups: []
2648
+ - id: 2038bbde-3423-43b1-991b-89e93a679511
2649
+ archived: false
2650
+ created_at: '2026-03-31T15:47:00Z'
2651
+ embedded_edit_url: https://www.signwell.com/edit/template/e15e7107-498a-49c7-a5b2-4b0815744da1/
2652
+ language: en
2653
+ name: book-notebook/iure.mov
2654
+ requester_email_address: 53.tiny.rick@towne.example
2655
+ status: Created
2656
+ template_link: https://www.signwell.com/new_doc/Qz2nb9ZeTqpsoBId/
2657
+ updated_at: '2026-03-31T15:47:00Z'
2658
+ allow_decline:
2659
+ allow_reassign:
2660
+ api_application_id:
2661
+ decline_redirect_url:
2662
+ expires_in:
2663
+ redirect_url:
2664
+ reminders:
2665
+ metadata:
2666
+ fields: []
2667
+ files: []
2668
+ copied_placeholders: []
2669
+ placeholders: []
2670
+ checkbox_groups: []
2671
+ current_page: 1
2672
+ next_page:
2673
+ previous_page:
2674
+ total_count: 3
2675
+ total_pages: 1
2676
+ schema:
2677
+ "$ref": "#/components/schemas/DocumentTemplateListResponse"
2678
+ '401':
2679
+ description: unauthorized
2680
+ content:
2681
+ application/json:
2682
+ example:
2683
+ message: Missing or invalid authorization key
2684
+ meta:
2685
+ error: api_key_unauthorized_error
2686
+ message: Not valid authorization token
2687
+ messages:
2688
+ - Not valid authorization token
2689
+ schema:
2690
+ "$ref": "#/components/schemas/ErrorResponse"
2691
+ '429':
2692
+ description: rate limit exceeded
2693
+ content:
2694
+ application/json:
2695
+ schema:
2696
+ "$ref": "#/components/schemas/RateLimitErrorResponse"
2338
2697
  "/api/v1/document_templates/{id}":
2339
2698
  get:
2340
2699
  summary: Get Template
@@ -2358,16 +2717,16 @@ paths:
2358
2717
  content:
2359
2718
  application/json:
2360
2719
  example:
2361
- id: 65564a6f-5582-4a3a-ada7-43ec1ceda89f
2720
+ id: d6450311-6922-4ad9-afc5-071168c04759
2362
2721
  archived: false
2363
- created_at: '2026-03-31T15:47:00Z'
2364
- embedded_edit_url: https://www.signwell.com/edit/template/ce591363-26ef-4e28-9261-4fb74ec9fca3/
2722
+ created_at: '2026-09-09T14:04:27Z'
2723
+ embedded_edit_url: https://www.signwell.com/edit/template/2ac8be1d-3f60-490e-9cf9-8e501f610391/
2365
2724
  language: en
2366
- name: conglomerate-glow/sint.mp4
2367
- requester_email_address: 54.birdperson@oberbrunner.test
2725
+ name: perception_corpse/a.mp3
2726
+ requester_email_address: rick.70.sanchez@considine.test
2368
2727
  status: Available
2369
- template_link: https://www.signwell.com/new_doc/04G5HrgwsXPPHFQv/
2370
- updated_at: '2026-03-31T15:47:00Z'
2728
+ template_link: https://www.signwell.com/new_doc/tHzLGdEkpnrGa1BF/
2729
+ updated_at: '2026-09-09T14:04:27Z'
2371
2730
  allow_decline:
2372
2731
  allow_reassign:
2373
2732
  api_application_id:
@@ -2377,10 +2736,10 @@ paths:
2377
2736
  reminders:
2378
2737
  metadata:
2379
2738
  apply_signing_order: false
2380
- message: Consequatur possimus delectus officia.
2381
- subject: aut
2739
+ message: Officiis vel possimus sint.
2740
+ subject: eligendi
2382
2741
  fields:
2383
- - - api_id: Signature_43
2742
+ - - api_id: Signature_55
2384
2743
  height: '32.0'
2385
2744
  page: 1
2386
2745
  required: true
@@ -2389,8 +2748,8 @@ paths:
2389
2748
  width: '112.0'
2390
2749
  x: 1.1
2391
2750
  "y": 1.1
2392
- placeholder_name: Dark Blob Girl 1
2393
- - api_id: Signature_44
2751
+ placeholder_name: Namorita 1
2752
+ - api_id: Signature_56
2394
2753
  height: '32.0'
2395
2754
  page: 2
2396
2755
  required: true
@@ -2399,47 +2758,68 @@ paths:
2399
2758
  width: '112.0'
2400
2759
  x: 1.1
2401
2760
  "y": 1.1
2402
- placeholder_name: Doctor Falcon Strange 2
2761
+ placeholder_name: Cyborg Sunspot 2
2403
2762
  files:
2404
- - name: cum.flac
2763
+ - name: et.json
2405
2764
  pages_number: 2
2406
2765
  copied_placeholders:
2407
2766
  - id: '3'
2408
- name: Penguin Iii 3
2767
+ name: The Titan Machine 3
2409
2768
  subject:
2410
2769
  message:
2411
2770
  - id: '4'
2412
- name: Red Monarch Skull 4
2771
+ name: Jolt 4
2413
2772
  subject:
2414
2773
  message:
2415
- preassigned_recipient_name: Audrie Romaguera
2416
- preassigned_recipient_email: freeman.doyle@kreiger-mclaughlin.example
2774
+ preassigned_recipient_name: Daniel Altenwerth
2775
+ preassigned_recipient_email: laverne_herzog@collins.test
2417
2776
  placeholders:
2418
2777
  - id: '1'
2419
- name: Dark Blob Girl 1
2778
+ name: Namorita 1
2420
2779
  subject:
2421
2780
  message:
2422
- preassigned_recipient_name: Chung Gerlach
2423
- preassigned_recipient_email: danyell_toy@hudson.example
2781
+ preassigned_recipient_name: Logan Will Ret.
2782
+ preassigned_recipient_email: lacy_nienow@lakin-hoppe.example
2424
2783
  signing_order: 1
2784
+ passcode_delivery:
2785
+ enabled: false
2786
+ methods:
2787
+ expire_after_access: false
2425
2788
  attachment_requests:
2426
- - name: distant_general/totam.xls
2789
+ - name: exhibition_deport/molestias.mov
2427
2790
  required: true
2428
- url: https://www.signwell.com/document_attachments/LG3l69ld2pIRQygpJK8oH56qQYp/?access=49fa240b-cb8b-48e0-ba0e-eda8808457d8
2791
+ url: https://www.signwell.com/document_attachments/27qZleO3Qks1ZDM4K6QWtOk1ykW/?access=d8d748fa-cd0d-45d2-90f7-75c87818c864
2429
2792
  - id: '2'
2430
- name: Doctor Falcon Strange 2
2793
+ name: Cyborg Sunspot 2
2431
2794
  subject:
2432
2795
  message:
2433
2796
  signing_order: 2
2797
+ passcode_delivery:
2798
+ enabled: false
2799
+ methods:
2800
+ expire_after_access: false
2434
2801
  attachment_requests: []
2435
2802
  checkbox_groups:
2436
- - id: 48cae2b3-c81d-4e53-a91c-b70def9c01af
2803
+ - id: 0ff5039c-d9e3-4c50-90ff-b892f7fb711f
2437
2804
  group_name:
2438
2805
  recipient_id:
2439
2806
  checkbox_ids:
2440
- - CheckBox_45
2807
+ - CheckBox_57
2441
2808
  validation:
2442
2809
  required: false
2810
+ conditional_rules:
2811
+ - id: 702ae23e-8426-4743-8e76-4df13200ffa0
2812
+ target_id: employment_status
2813
+ action_type: require
2814
+ action_field_ids:
2815
+ - manager_name
2816
+ conditions:
2817
+ - condition_type: any_of
2818
+ status: completed
2819
+ join_operator: and_operator
2820
+ field_api_ids:
2821
+ - employment_status
2822
+ position: 1
2443
2823
  schema:
2444
2824
  "$ref": "#/components/schemas/DocumentTemplateResponse"
2445
2825
  '404':
@@ -2481,30 +2861,30 @@ paths:
2481
2861
  content:
2482
2862
  application/json:
2483
2863
  example:
2484
- id: 2316597f-56b6-433f-a4a1-8f6356b2a5a5
2864
+ id: f7cfcd8d-5b2a-4c74-b3fe-aa6973e68d8a
2485
2865
  archived: false
2486
- created_at: '2026-03-31T15:47:03Z'
2487
- embedded_edit_url: https://www.signwell.com/edit/template/abbd8d88-9dfe-4a7f-9309-38cc7094a26d/
2866
+ created_at: '2026-09-09T14:04:30Z'
2867
+ embedded_edit_url: https://www.signwell.com/edit/template/3c5c3533-1345-459d-8d5c-93721f4eb82e/
2488
2868
  language: en
2489
- name: Broly
2490
- requester_email_address: michael_79_jan_vincent@murray-lockman.example
2869
+ name: Champa
2870
+ requester_email_address: needful_mr_99@fahey-volkman.test
2491
2871
  status: Available
2492
- template_link: https://www.signwell.com/new_doc/5p8G0m8DiJ0XwNWB/
2493
- updated_at: '2026-03-31T15:47:04Z'
2872
+ template_link: https://www.signwell.com/new_doc/iKoTr7loKoguoIjV/
2873
+ updated_at: '2026-09-09T14:04:31Z'
2494
2874
  allow_decline: true
2495
2875
  allow_reassign: true
2496
- api_application_id: cc86d352-f069-44e7-b23f-9a759209e2cd
2497
- decline_redirect_url: http://weissnat.example/holly
2876
+ api_application_id: 99a2e57b-3271-49d0-a293-d2c8d1a5664a
2877
+ decline_redirect_url: http://bernier-kuvalis.test/daron.purdy
2498
2878
  expires_in: 1
2499
- redirect_url: http://williamson.example/patricia.pfeffer
2879
+ redirect_url: http://orn.example/mora.feeney
2500
2880
  reminders: true
2501
2881
  metadata:
2502
2882
  some: metadata
2503
2883
  apply_signing_order: true
2504
- message: Nisi blanditiis aut ut.
2505
- subject: Rem recusandae placeat ut.
2884
+ message: Consequatur ducimus sunt iste.
2885
+ subject: Sint dolorem asperiores officiis.
2506
2886
  fields:
2507
- - - api_id: Signature_55
2887
+ - - api_id: Signature_67
2508
2888
  height: '32.0'
2509
2889
  page: 1
2510
2890
  required: true
@@ -2513,8 +2893,8 @@ paths:
2513
2893
  width: '112.0'
2514
2894
  x: 1.1
2515
2895
  "y": 1.1
2516
- placeholder_name: Blink Ix 13
2517
- - api_id: Signature_56
2896
+ placeholder_name: Magnificent Deadpool 13
2897
+ - api_id: Signature_68
2518
2898
  height: '32.0'
2519
2899
  page: 2
2520
2900
  required: true
@@ -2523,47 +2903,56 @@ paths:
2523
2903
  width: '112.0'
2524
2904
  x: 1.1
2525
2905
  "y": 1.1
2526
- placeholder_name: Arclight 14
2906
+ placeholder_name: Illustrious Sif X 14
2527
2907
  files:
2528
- - name: sunt.pptx
2908
+ - name: magni.mp4
2529
2909
  pages_number: 2
2530
2910
  copied_placeholders:
2531
2911
  - id: '3'
2532
- name: Bloodwraith 15
2912
+ name: Darkside 15
2533
2913
  subject:
2534
2914
  message:
2535
2915
  - id: '4'
2536
- name: Banshee 16
2916
+ name: Renata Soliz 16
2537
2917
  subject:
2538
2918
  message:
2539
- preassigned_recipient_name: Rev. Sammy Wiza
2540
- preassigned_recipient_email: marcus@von.test
2919
+ preassigned_recipient_name: Terrance Nicolas
2920
+ preassigned_recipient_email: barry.stroman@koss.example
2541
2921
  placeholders:
2542
2922
  - id: '1'
2543
- name: Blink Ix 13
2923
+ name: Magnificent Deadpool 13
2544
2924
  subject:
2545
2925
  message:
2546
- preassigned_recipient_name: Mikaela Legros
2547
- preassigned_recipient_email: dexter.hintz@dicki-oberbrunner.example
2926
+ preassigned_recipient_name: Arletha Aufderhar
2927
+ preassigned_recipient_email: kasey.mante@kassulke.example
2548
2928
  signing_order: 1
2929
+ passcode_delivery:
2930
+ enabled: false
2931
+ methods:
2932
+ expire_after_access: false
2549
2933
  attachment_requests:
2550
- - name: fruit-linger/non.js
2934
+ - name: strap_midnight/velit.xls
2551
2935
  required: true
2552
- url: https://www.signwell.com/document_attachments/5BO4O8z6DDHOqJ04on5OFzAa0e8/?access=ebfcdb81-ce6f-4e6e-b5eb-73495c0691c2
2936
+ url: https://www.signwell.com/document_attachments/Bqd0L9ga2aU2PjrkZQaNta0NJ4M/?access=f1fafcf1-6c6c-4c2c-8a69-3e66349bf7ae
2553
2937
  - id: '2'
2554
- name: Arclight 14
2938
+ name: Illustrious Sif X 14
2555
2939
  subject:
2556
2940
  message:
2557
2941
  signing_order: 2
2942
+ passcode_delivery:
2943
+ enabled: false
2944
+ methods:
2945
+ expire_after_access: false
2558
2946
  attachment_requests: []
2559
2947
  checkbox_groups:
2560
- - id: b5b92745-c30e-462a-80bb-60ae8dab9b2b
2948
+ - id: c0097d86-72a1-4fd0-951a-e457f6ef1155
2561
2949
  group_name:
2562
2950
  recipient_id:
2563
2951
  checkbox_ids:
2564
- - CheckBox_57
2952
+ - CheckBox_69
2565
2953
  validation:
2566
2954
  required: false
2955
+ conditional_rules: []
2567
2956
  schema:
2568
2957
  "$ref": "#/components/schemas/DocumentTemplateResponse"
2569
2958
  '400':
@@ -2675,22 +3064,22 @@ paths:
2675
3064
  content:
2676
3065
  application/json:
2677
3066
  example:
2678
- id: 86cbb357-7b1b-4c43-894a-d0e94b649126
3067
+ id: a2869fb1-996e-4aca-9b7d-651c68f85435
2679
3068
  callback_urls: []
2680
- created_at: '2026-03-31T15:47:06Z'
2681
- name: Opela
2682
- updated_at: '2026-03-31T15:47:06Z'
3069
+ created_at: '2026-09-09T14:04:32Z'
3070
+ name: Cardguard
3071
+ updated_at: '2026-09-09T14:04:32Z'
2683
3072
  owner:
2684
- id: ed63535c-75c0-4a72-875c-6426d9210b71
2685
- account_id: 43a98242-d533-4f82-bbfe-87cf8e983e73
2686
- name: Arthricia
2687
- email: arthricia_105@rohan.test
3073
+ id: dadcf643-6964-4f47-86da-d2dc599b7d86
3074
+ account_id: 69ebb53b-77f0-4e6f-8906-4d77f95aa647
3075
+ name: Mr. Goldenfold
3076
+ email: goldenfold_mr_125@borer.example
2688
3077
  preferences:
2689
- button_text_color: '610505'
2690
- buttons_border_radius: 10
2691
- custom_logo_file: "/Users/signwell/Code/docsketch/tmp/test_files/files_number/api_application_preferences/000/000/003/original.png"
2692
- link_text_color: BCBC80
2693
- primary_color: '898952'
3078
+ button_text_color: E472E4
3079
+ buttons_border_radius: 4
3080
+ custom_logo_file: "/Users/sardavend/Repos/Signwell/docsketch/.claude/worktrees/pr-4676/tmp/test_files/files_number/api_application_preferences/logos/000/000/003/original.png"
3081
+ link_text_color: B58C8C
3082
+ primary_color: C85151
2694
3083
  schema:
2695
3084
  "$ref": "#/components/schemas/ApiApplicationResponse"
2696
3085
  '404':
@@ -2767,27 +3156,27 @@ paths:
2767
3156
  content:
2768
3157
  application/json:
2769
3158
  example:
2770
- - id: a6b55a29-218d-4766-ad94-8d418c5bda98
2771
- callback_url: http://greenfelder.example/ngoc
2772
- - id: 1afbb05a-42e4-4304-8c11-ec3978c00056
2773
- callback_url: http://olson-ledner.example/mack
2774
- - id: b9b5527b-d2ce-4816-bde0-c0942b5c9d66
2775
- callback_url: http://wyman.test/quintin
2776
- - id: 2677e7fa-de5f-4de0-8e40-c4706923889f
2777
- callback_url: http://spinka.test/athena.gerlach
2778
- api_application_id: 5e544e05-56db-48f5-9b47-061dd985b2c6
2779
- - id: f6be99fa-1dac-487d-a352-994d48c8a158
2780
- callback_url: http://schmidt.example/nanci
2781
- api_application_id: 5e544e05-56db-48f5-9b47-061dd985b2c6
2782
- - id: 84491f67-989d-485d-b46c-44e022fac543
2783
- callback_url: http://cassin-walker.test/kaley
2784
- api_application_id: 5e544e05-56db-48f5-9b47-061dd985b2c6
2785
- - id: c2f3cbd5-7277-42c8-ba99-56436870e9f7
2786
- callback_url: http://schiller-sauer.test/sybil
2787
- api_application_id: 5e544e05-56db-48f5-9b47-061dd985b2c6
2788
- - id: af0e3552-8116-4fc6-80d1-beb8f8e13d1a
2789
- callback_url: http://greenfelder-conroy.example/carmelo.stokes
2790
- api_application_id: 5e544e05-56db-48f5-9b47-061dd985b2c6
3159
+ - id: 3c8e7dcc-fbba-4427-a566-915f78273dcf
3160
+ callback_url: http://ullrich-doyle.example/everette
3161
+ - id: b7b058d6-b21b-4376-8051-29bde7260eb6
3162
+ callback_url: http://stoltenberg.test/ramon.parker
3163
+ - id: a46c00e2-0fb5-4803-a9aa-54abe4209e5e
3164
+ callback_url: http://windler.test/chelsey_padberg
3165
+ - id: 756e3051-e76a-415d-a563-f508c6814054
3166
+ callback_url: http://heidenreich.example/georgeann.mcdermott
3167
+ api_application_id: fe4c53f0-b20b-4338-9f1b-ea74468a0799
3168
+ - id: b687b719-a312-41cf-ae4f-89b4c45c58a3
3169
+ callback_url: http://wisoky.example/ahmad.lakin
3170
+ api_application_id: fe4c53f0-b20b-4338-9f1b-ea74468a0799
3171
+ - id: 2da9e309-c78a-4242-9a72-1bbd092decaf
3172
+ callback_url: http://heathcote.example/nathaniel
3173
+ api_application_id: fe4c53f0-b20b-4338-9f1b-ea74468a0799
3174
+ - id: 49048dc7-a6a0-4936-9c1d-3d00bb661e0a
3175
+ callback_url: http://stracke.example/elroy
3176
+ api_application_id: fe4c53f0-b20b-4338-9f1b-ea74468a0799
3177
+ - id: 9c189768-628d-4873-a899-d12f599d8395
3178
+ callback_url: http://stoltenberg.example/domitila_hayes
3179
+ api_application_id: fe4c53f0-b20b-4338-9f1b-ea74468a0799
2791
3180
  schema:
2792
3181
  "$ref": "#/components/schemas/WebhookListResponse"
2793
3182
  '429':
@@ -2798,7 +3187,20 @@ paths:
2798
3187
  "$ref": "#/components/schemas/RateLimitErrorResponse"
2799
3188
  post:
2800
3189
  summary: Create Webhook
2801
- description: Register a callback URL that we will post document events to.
3190
+ description: 'Register a callback URL that we will post document events to.
3191
+ Note: a `document_signed` event is not emitted solely because a pre-signed
3192
+ template signature/initials was copied as document content, and `event.related_signer`
3193
+ only identifies a real recipient signing action. Two additional event types
3194
+ cover SMS delivery outcomes: `document_sms_failed` fires when an SMS reaches
3195
+ a terminal failure (undelivered or failed), and `document_sms_opted_out` fires
3196
+ when a phone number is newly added to the SMS suppression list. Both carry
3197
+ `event.related_recipient` (id, name, email when present, `phone_number_masked`,
3198
+ and `delivery_method`) instead of `event.related_signer`, and each recipient
3199
+ in `data.object.recipients[]` whose delivery method includes SMS carries a
3200
+ nested `sms` object (`phone_number_masked`, `send_sms`, `send_sms_delay`,
3201
+ `delivery_status`, `message_type`, `failed`, `failed_details`). Email-only
3202
+ recipients keep their existing payload shape unchanged. Only webhooks registered
3203
+ on API-type hooks receive these two events.'
2802
3204
  tags:
2803
3205
  - Webhooks
2804
3206
  security:
@@ -2811,8 +3213,8 @@ paths:
2811
3213
  content:
2812
3214
  application/json:
2813
3215
  example:
2814
- id: 782111c8-f182-4067-8fc0-d7ba8d3e87ae
2815
- callback_url: http://prohaska.test/della
3216
+ id: 90b28bf2-008f-4c3c-ba14-a3285cfd6ffa
3217
+ callback_url: http://franecki.example/ozell_mcglynn
2816
3218
  schema:
2817
3219
  "$ref": "#/components/schemas/WebhookResponse"
2818
3220
  '400':
@@ -2908,50 +3310,50 @@ paths:
2908
3310
  content:
2909
3311
  application/json:
2910
3312
  example:
2911
- id: 2efeb26c-f151-4ff7-9341-81d5741f5e28
3313
+ id: a01e51c4-bcb1-48b4-af63-a9d340a23db8
2912
3314
  role: owner
2913
3315
  archived: false
2914
3316
  user:
2915
- id: b4905391-fd3b-402c-a8ca-b3201a5549c0
2916
- name: Snuffles
2917
- email: snuffles_115@hoeger.test
3317
+ id: 0fb4747f-4d28-414f-95f6-be66ce867c59
3318
+ name: Gazorpazorpfield
3319
+ email: gazorpazorpfield.135@kuphal.example
2918
3320
  has_google_registration: false
2919
- first_name: Snuffles
3321
+ first_name: Gazorpazorpfield
2920
3322
  account:
2921
- id: 0bdaab15-ae90-4638-8b43-60b6ca3a5032
2922
- name: Gleichner, Kohler and Ruecker
3323
+ id: edce1d6e-7e88-429f-bdf3-53d1eae262aa
3324
+ name: Bechtelar, Bode and Stoltenberg
2923
3325
  plan_tier: free
2924
3326
  active_templates: 0
2925
3327
  can_create_template: true
2926
3328
  can_create_tracking_document: true
2927
3329
  can_create_completion_document: true
2928
3330
  active_users:
2929
- - id: b4905391-fd3b-402c-a8ca-b3201a5549c0
2930
- name: Snuffles
2931
- email: snuffles_115@hoeger.test
3331
+ - id: 0fb4747f-4d28-414f-95f6-be66ce867c59
3332
+ name: Gazorpazorpfield
3333
+ email: gazorpazorpfield.135@kuphal.example
2932
3334
  has_google_registration: false
2933
3335
  workspace:
2934
- id: 0bdaab15-ae90-4638-8b43-60b6ca3a5032
2935
- name: Gleichner, Kohler and Ruecker
3336
+ id: edce1d6e-7e88-429f-bdf3-53d1eae262aa
3337
+ name: Bechtelar, Bode and Stoltenberg
2936
3338
  plan_tier: free
2937
3339
  active_templates: 0
2938
3340
  can_create_template: true
2939
3341
  can_create_tracking_document: true
2940
3342
  can_create_completion_document: true
2941
3343
  active_users:
2942
- - id: b4905391-fd3b-402c-a8ca-b3201a5549c0
2943
- name: Snuffles
2944
- email: snuffles_115@hoeger.test
3344
+ - id: 0fb4747f-4d28-414f-95f6-be66ce867c59
3345
+ name: Gazorpazorpfield
3346
+ email: gazorpazorpfield.135@kuphal.example
2945
3347
  has_google_registration: false
2946
3348
  contact:
2947
- id: bd5ebc93-bfb3-4a0b-ac31-545bd756236b
2948
- email: snuffles_115@hoeger.test
2949
- name: Snuffles
2950
- company_name: Koch Group
2951
- phone_number: "(956) 121-4217"
2952
- alt_phone_number: 464 603 7752
2953
- website: http://mann.test/lorriane
2954
- initials: SN
3349
+ id: 77387af1-9108-41ee-a975-5272ff59075f
3350
+ email: gazorpazorpfield.135@kuphal.example
3351
+ name: Gazorpazorpfield
3352
+ company_name: Becker Inc
3353
+ phone_number: 440-557-1112
3354
+ alt_phone_number: 711.399.8070
3355
+ website: http://marquardt-leuschke.example/lois
3356
+ initials: GA
2955
3357
  archived: false
2956
3358
  schema:
2957
3359
  "$ref": "#/components/schemas/MeResponse"
@@ -2995,18 +3397,18 @@ paths:
2995
3397
  content:
2996
3398
  application/json:
2997
3399
  example:
2998
- id: 3a337429-7411-4796-9d1c-bd68cfe0d256
2999
- name: Parth Galen
3400
+ id: 6faedcd6-1f17-4ac4-98da-2221284fa14e
3401
+ name: Pelennor Fields
3000
3402
  api_application_id:
3001
3403
  documents_count: 0
3002
3404
  documents_completed: 0
3003
3405
  documents_not_completed: 0
3004
- created_at: '2026-03-31T15:47:08Z'
3406
+ created_at: '2026-09-09T14:04:33Z'
3005
3407
  user_id:
3006
3408
  status: Created
3007
3409
  templates:
3008
- - id: b985f6f9-579a-485b-96c1-35d16dc8c8bf
3009
- name: scale_nursery/totam.key
3410
+ - id: 6ea626f8-c1fa-4bd7-bd3e-aa9c0dd74f0e
3411
+ name: strict-scale/perspiciatis.jpeg
3010
3412
  schema:
3011
3413
  "$ref": "#/components/schemas/BulkSendResponse"
3012
3414
  '401':
@@ -3078,61 +3480,61 @@ paths:
3078
3480
  application/json:
3079
3481
  example:
3080
3482
  bulk_sends:
3081
- - id: 81c057c3-8569-4b1d-9a7b-d46f584d815d
3082
- name: Argonath
3483
+ - id: 9a08a654-9136-4463-8609-e6eb574d88d2
3484
+ name: Vaiya
3083
3485
  api_application_id:
3084
3486
  documents_count: 0
3085
3487
  documents_completed: 0
3086
3488
  documents_not_completed: 0
3087
- created_at: '2026-03-31T15:47:09Z'
3489
+ created_at: '2026-09-09T14:04:34Z'
3088
3490
  user_id:
3089
3491
  status: Created
3090
3492
  template_ids:
3091
- - a3a6b56e-7d5c-4531-843a-047de9ae1a1e
3092
- - id: '087c6e94-528f-462c-9601-db6b1741a7e9'
3093
- name: Nargothrond
3493
+ - e96860cf-9c2e-4949-90fd-72381ecb6498
3494
+ - id: 3e6b1d24-2390-4152-abd4-896bf9670d0a
3495
+ name: Tol-in-Gaurhoth
3094
3496
  api_application_id:
3095
3497
  documents_count: 0
3096
3498
  documents_completed: 0
3097
3499
  documents_not_completed: 0
3098
- created_at: '2026-03-31T15:47:09Z'
3500
+ created_at: '2026-09-09T14:04:34Z'
3099
3501
  user_id:
3100
3502
  status: Created
3101
3503
  template_ids:
3102
- - a3a6b56e-7d5c-4531-843a-047de9ae1a1e
3103
- - id: 7544ffc3-6d1a-4328-9e97-c6882e6f2e6b
3104
- name: Luthany
3504
+ - e96860cf-9c2e-4949-90fd-72381ecb6498
3505
+ - id: 16d82d1d-1c7b-4c7f-b443-4cce53c62f48
3506
+ name: Ilmen
3105
3507
  api_application_id:
3106
3508
  documents_count: 0
3107
3509
  documents_completed: 0
3108
3510
  documents_not_completed: 0
3109
- created_at: '2026-03-31T15:47:09Z'
3511
+ created_at: '2026-09-09T14:04:34Z'
3110
3512
  user_id:
3111
3513
  status: Created
3112
3514
  template_ids:
3113
- - a3a6b56e-7d5c-4531-843a-047de9ae1a1e
3114
- - id: 5d9cbb3e-f517-4dea-b13f-351866a8f9e7
3115
- name: Tol-in-Gaurhoth
3515
+ - e96860cf-9c2e-4949-90fd-72381ecb6498
3516
+ - id: 6e836e2c-c02c-4677-9b7c-e786c825beb9
3517
+ name: Luthany
3116
3518
  api_application_id:
3117
3519
  documents_count: 0
3118
3520
  documents_completed: 0
3119
3521
  documents_not_completed: 0
3120
- created_at: '2026-03-31T15:47:09Z'
3522
+ created_at: '2026-09-09T14:04:34Z'
3121
3523
  user_id:
3122
3524
  status: Created
3123
3525
  template_ids:
3124
- - a3a6b56e-7d5c-4531-843a-047de9ae1a1e
3125
- - id: f515d01f-a50f-4633-b604-58a0cfd84ace
3126
- name: Marish
3526
+ - e96860cf-9c2e-4949-90fd-72381ecb6498
3527
+ - id: 671ed56c-eead-462f-a7c6-cd403449e4d1
3528
+ name: Ilmen
3127
3529
  api_application_id:
3128
3530
  documents_count: 0
3129
3531
  documents_completed: 0
3130
3532
  documents_not_completed: 0
3131
- created_at: '2026-03-31T15:47:09Z'
3533
+ created_at: '2026-09-09T14:04:34Z'
3132
3534
  user_id:
3133
3535
  status: Created
3134
3536
  template_ids:
3135
- - a3a6b56e-7d5c-4531-843a-047de9ae1a1e
3537
+ - e96860cf-9c2e-4949-90fd-72381ecb6498
3136
3538
  current_page: 1
3137
3539
  next_page:
3138
3540
  previous_page:
@@ -3175,16 +3577,29 @@ paths:
3175
3577
  content:
3176
3578
  application/json:
3177
3579
  example:
3178
- id: 6a287375-c151-435c-9bbe-856074348b25
3580
+ id: 5a8b6bd6-945a-4e4e-9fe0-4e9d8b82104a
3179
3581
  template_ids:
3180
- - 3f0cead6-c915-4119-99a1-06ad11f1f684
3181
- api_application_id: 38916d06-bdf2-4cf7-b97c-c2fb72b8c1a8
3582
+ - 3294f614-0279-4062-a27a-1f921fe659e4
3583
+ api_application_id: 4094dcd0-f84a-4cb2-8e38-6e7900529a8e
3182
3584
  documents_count: 0
3183
- created_at: '2026-03-31T15:47:10Z'
3184
- user_id: 810157d0-83c5-4309-8d75-830d4464379e
3585
+ created_at: '2026-09-09T14:04:35Z'
3586
+ user_id: acff27a9-2eb1-4d83-9ce9-edd95d8203db
3185
3587
  status: Enqueuing
3186
3588
  schema:
3187
3589
  "$ref": "#/components/schemas/BulkSendCreateResponse"
3590
+ '401':
3591
+ description: unauthorized
3592
+ content:
3593
+ application/json:
3594
+ example:
3595
+ message: Missing or invalid authorization key
3596
+ meta:
3597
+ error: api_key_unauthorized_error
3598
+ message: Not valid authorization token
3599
+ messages:
3600
+ - Not valid authorization token
3601
+ schema:
3602
+ "$ref": "#/components/schemas/ErrorResponse"
3188
3603
  '422':
3189
3604
  description: unprocessable entity
3190
3605
  content:
@@ -3204,19 +3619,6 @@ paths:
3204
3619
  - 'The following columns have an email address invalid: document_sender_email.'
3205
3620
  schema:
3206
3621
  "$ref": "#/components/schemas/ValidationErrorResponse"
3207
- '401':
3208
- description: unauthorized
3209
- content:
3210
- application/json:
3211
- example:
3212
- message: Missing or invalid authorization key
3213
- meta:
3214
- error: api_key_unauthorized_error
3215
- message: Not valid authorization token
3216
- messages:
3217
- - Not valid authorization token
3218
- schema:
3219
- "$ref": "#/components/schemas/ErrorResponse"
3220
3622
  '429':
3221
3623
  description: rate limit exceeded
3222
3624
  content:
@@ -3263,10 +3665,10 @@ paths:
3263
3665
  format: binary
3264
3666
  example: |
3265
3667
  document_sender_email,document_sender_name
3266
- fart_138@becker.test,Fart
3668
+ gazorpazorpfield.158@quitzon.example,Gazorpazorpfield
3267
3669
  application/json:
3268
3670
  example:
3269
- data: ZG9jdW1lbnRfc2VuZGVyX2VtYWlsLGRvY3VtZW50X3NlbmRlcl9uYW1lCnRlcnJ5X3NjYXJ5XzE0MkBuaWNvbGFzLnRlc3QsU2NhcnkgVGVycnkK
3671
+ data: ZG9jdW1lbnRfc2VuZGVyX2VtYWlsLGRvY3VtZW50X3NlbmRlcl9uYW1lCjE2Ml9tb3J0eV9zbWl0aEBrZXJsdWtlLnRlc3QsTW9ydHkgU21pdGgK
3270
3672
  schema:
3271
3673
  "$ref": "#/components/schemas/BulkSendCsvTemplateResponse"
3272
3674
  '401':
@@ -3321,16 +3723,29 @@ paths:
3321
3723
  example:
3322
3724
  bulk_send_csv: IkRvY3VtZW50IFNlbmRlciBFbWFpbCIsJ0RvY3VtZW50IFNlbmRlciBOYW1lJywvXERvY3VtZW50LSBTZW5kZXIgPUxhYmVsLEBSZWNpcGllbnRfIEVtYWlsLFJlY2lwaWVudCAqTmFtZSxgUmVjaXBpZW50fiFAIyQlXiYqKCl7fVtdPD4uPyBMYWJlbGAKc2VuZGVyQHNpZ253ZWxsLmNvbSxTZW5kZXIsU2VuZGVyLHJlY2lwaWVudEBzaWdud2VsbC5jb20sUmVjaXBpZW50LFJlY2lwaWVudAplbWFpbEBzb21lLmNvbSwsLGVtYWlsMkBzb21lLmNvbQo=
3323
3725
  template_ids:
3324
- - a80001a0-2936-44ae-b0a2-4eb4e70ef3ef
3726
+ - bf75dfe8-485e-43f1-8df4-36114e614593
3325
3727
  skip_row_errors: false
3326
3728
  api_application_id:
3327
- name: arena_linger/in.css
3328
- subject: Please complete arena_linger/in.css
3729
+ name: exaggerate-kidnap/qui.js
3730
+ subject: Please complete exaggerate-kidnap/qui.js
3329
3731
  message: "<p>Hey there,</p><p>&nbsp;</p><p>Please review and complete
3330
3732
  this document. You can click on the document below to get started.</p>"
3331
3733
  apply_signing_order: false
3332
3734
  schema:
3333
- "$ref": "#/components/schemas/BulkSendValidateCsvResponse"
3735
+ "$ref": "#/components/schemas/BulkSendValidateCsvResponse"
3736
+ '401':
3737
+ description: unauthorized
3738
+ content:
3739
+ application/json:
3740
+ example:
3741
+ message: Missing or invalid authorization key
3742
+ meta:
3743
+ error: api_key_unauthorized_error
3744
+ message: Not valid authorization token
3745
+ messages:
3746
+ - Not valid authorization token
3747
+ schema:
3748
+ "$ref": "#/components/schemas/ErrorResponse"
3334
3749
  '422':
3335
3750
  description: unprocessable entity
3336
3751
  content:
@@ -3350,19 +3765,6 @@ paths:
3350
3765
  - 'The following columns have an email address invalid: document_sender_email.'
3351
3766
  schema:
3352
3767
  "$ref": "#/components/schemas/ValidationErrorResponse"
3353
- '401':
3354
- description: unauthorized
3355
- content:
3356
- application/json:
3357
- example:
3358
- message: Missing or invalid authorization key
3359
- meta:
3360
- error: api_key_unauthorized_error
3361
- message: Not valid authorization token
3362
- messages:
3363
- - Not valid authorization token
3364
- schema:
3365
- "$ref": "#/components/schemas/ErrorResponse"
3366
3768
  '429':
3367
3769
  description: rate limit exceeded
3368
3770
  content:
@@ -3406,62 +3808,63 @@ paths:
3406
3808
  content:
3407
3809
  application/json:
3408
3810
  example:
3409
- id: 5d88cabc-9352-458a-b19c-80991c4a8255
3410
- name: Minas Tirith
3811
+ id: f47417d9-6a58-47b2-8141-be4ad205bb6d
3812
+ name: Regions of the Shire
3411
3813
  api_application_id:
3412
- created_at: '2026-03-31T15:47:14Z'
3814
+ created_at: '2026-09-09T14:04:38Z'
3413
3815
  user_id:
3414
3816
  status: Created
3415
3817
  documents:
3416
- - id: 66891ea4-616f-4ecc-ada9-80e5283273f6
3818
+ - id: 2f9a4adc-8629-4d11-9929-8acb1aa1026f
3417
3819
  archived: false
3418
- created_at: '2026-03-31T15:47:13Z'
3820
+ created_at: '2026-09-09T14:04:38Z'
3419
3821
  decline_message:
3420
- embedded_edit_url: https://www.signwell.com/edit/document/5153b085-19b0-4688-9694-100eff33b4e3/
3822
+ embedded_edit_url: https://www.signwell.com/edit/document/e8505dcd-56fd-4e89-8e9d-440446b9d500/
3421
3823
  error_message:
3422
3824
  embedded_preview_url:
3423
3825
  language: en
3424
- name: cruelty_notebook/sint.flac
3425
- requester_email_address: 158_terry_scary@von.example
3826
+ name: message-academy/ut.html
3827
+ requester_email_address: 178.tinkles@boyer.example
3426
3828
  status: Created
3427
3829
  test_mode: false
3428
- updated_at: '2026-03-31T15:47:13Z'
3830
+ updated_at: '2026-09-09T14:04:38Z'
3831
+ cfr_part11: false
3832
+ cfr_part11_signing_mode:
3429
3833
  allow_decline: true
3430
3834
  allow_reassign: true
3431
3835
  api_application_id:
3432
- custom_requester_email: carolynn_okuneva@predovic.test
3433
- custom_requester_name: Kylo Ren
3434
- decline_redirect_url: http://aufderhar-shanahan.test/mira
3836
+ custom_requester_email: kevin.nolan@kuvalis.example
3837
+ custom_requester_name: Darth Sidious
3838
+ decline_redirect_url: http://muller.test/kevin
3435
3839
  embedded_signing: false
3436
3840
  expires_in: 10
3437
3841
  metadata:
3438
- et: numquam
3439
- molestias: dolores
3440
- redirect_url: http://emard.example/preston_heathcote
3441
- reminders: false
3842
+ id: est
3843
+ natus: voluptatum
3844
+ redirect_url: http://bartoletti-nader.example/merlin
3845
+ reminders: true
3846
+ embedded:
3442
3847
  apply_signing_order: false
3443
3848
  message: "<p>Hey there,</p><p>&nbsp;</p><p>Please review and complete
3444
3849
  this document. You can click on the document below to get started.</p>"
3445
- subject: Please complete cruelty_notebook/sint.flac
3850
+ subject: Please complete message-academy/ut.html
3446
3851
  labels:
3447
- - id: e980859e-f839-404c-8f0d-b4808fec2821
3448
- name: Malcom Thompson
3449
- - id: ce0ee7ec-ceb4-43cc-881e-35bf56c5a901
3450
- name: Melony Stracke
3852
+ - id: 6629b825-3186-48a4-b23f-93c9b097c1a3
3853
+ name: Earnest Brown
3854
+ - id: b0424c67-3f04-4e8d-85f1-25d6408580d2
3855
+ name: Peggy Kautzer
3451
3856
  fields:
3452
- - - api_id: CheckBox_71
3453
- height: '13.0'
3857
+ - - api_id: Signature_82
3858
+ height: '32.0'
3454
3859
  page: 1
3455
3860
  required: true
3456
- type: checkbox
3861
+ type: signature
3457
3862
  value:
3458
- width: '13.0'
3863
+ width: '112.0'
3459
3864
  x: 1.1
3460
3865
  "y": 1.1
3461
- name:
3462
- recipient_id:
3463
- signing_elements_group_id: d6b47015-754d-417f-8c53-9ffa43cba00a
3464
- - api_id: CheckBox_72
3866
+ recipient_id: 0f38e229-2aaa-4fd0-b7b6-42c15bbe4d77
3867
+ - api_id: CheckBox_83
3465
3868
  height: '13.0'
3466
3869
  page: 1
3467
3870
  required: true
@@ -3472,62 +3875,76 @@ paths:
3472
3875
  "y": 1.1
3473
3876
  name:
3474
3877
  recipient_id:
3475
- - api_id: Signature_70
3476
- height: '32.0'
3878
+ signing_elements_group_id: a45c1301-3c8b-415d-b87c-fcd68a3dac32
3879
+ - api_id: CheckBox_84
3880
+ height: '13.0'
3477
3881
  page: 1
3478
3882
  required: true
3479
- type: signature
3883
+ type: checkbox
3480
3884
  value:
3481
- width: '112.0'
3885
+ width: '13.0'
3482
3886
  x: 1.1
3483
3887
  "y": 1.1
3484
- recipient_id: afc00701-d0db-4cad-9fee-f3f12e9d513e
3888
+ name:
3889
+ recipient_id:
3485
3890
  files:
3486
- - name: eveniet.doc
3891
+ - name: ut.numbers
3487
3892
  pages_number: 1
3488
3893
  copied_contacts:
3489
- - name: The Hon. Noel Schowalter
3490
- email: benjamin@turner-witting.example
3894
+ - name: Robby Williamson
3895
+ email: angel@hermiston.example
3491
3896
  recipients:
3492
- - email: lloyd@krajcik-gottlieb.test
3493
- id: afc00701-d0db-4cad-9fee-f3f12e9d513e
3897
+ - delivery_method: email
3898
+ email: mahalia@kihn.example
3899
+ id: 0f38e229-2aaa-4fd0-b7b6-42c15bbe4d77
3494
3900
  message:
3495
- name: Pres. Syreeta Kreiger
3901
+ name: Leann Sawayn
3496
3902
  passcode:
3497
3903
  send_email:
3498
3904
  send_email_delay:
3499
3905
  status: created
3500
3906
  subject:
3501
- signing_order: 46
3502
- signing_url: https://www.signwell.com/docs/ba8dcb6e10/
3907
+ signing_order: 58
3908
+ signing_url: https://www.signwell.com/docs/9d55763937/
3503
3909
  bounced:
3504
3910
  bounced_details:
3911
+ passcode_delivery:
3912
+ enabled: false
3913
+ methods:
3914
+ expire_after_access: false
3505
3915
  attachment_requests:
3506
- - name: arena-corn/nostrum.jpeg
3916
+ - name: plain_corpse/id.xlsx
3507
3917
  required: true
3508
- url: https://www.signwell.com/document_attachments/D98kY33DQZcn6N0OjW6Di615KBLw/?access=f5b4e237-bad0-46b1-864c-225debae311f
3509
- - email: caterina@lesch-rolfson.example
3510
- id: 65ef4984-18b1-4b19-9ca0-258c607c5acd
3918
+ url: https://www.signwell.com/document_attachments/e2yjK8e5jgiGjd6BWM81hXWed5y/?access=69042607-2bdf-43e1-8219-6d95fbef0241
3919
+ - delivery_method: email
3920
+ email: nubia.cremin@olson.example
3921
+ id: 6adddf1b-5975-43cc-a8af-06ccdde81884
3511
3922
  message:
3512
- name: Napoleon Schuster
3923
+ name: Maxwell Baumbach
3513
3924
  passcode:
3514
3925
  send_email:
3515
3926
  send_email_delay:
3516
3927
  status: created
3517
3928
  subject:
3518
- signing_order: 47
3519
- signing_url: https://www.signwell.com/docs/f82f345105/
3929
+ signing_order: 59
3930
+ signing_url: https://www.signwell.com/docs/97931f6292/
3520
3931
  bounced:
3521
3932
  bounced_details:
3933
+ passcode_delivery:
3934
+ enabled: false
3935
+ methods:
3936
+ expire_after_access: false
3522
3937
  attachment_requests: []
3523
3938
  checkbox_groups:
3524
- - id: d6b47015-754d-417f-8c53-9ffa43cba00a
3939
+ - id: a45c1301-3c8b-415d-b87c-fcd68a3dac32
3525
3940
  group_name:
3526
3941
  recipient_id:
3527
3942
  checkbox_ids:
3528
- - CheckBox_71
3943
+ - CheckBox_83
3529
3944
  validation:
3530
3945
  required: false
3946
+ conditional_rules: []
3947
+ conditional_logic_decisions: []
3531
3948
  current_page: 1
3532
3949
  next_page:
3533
3950
  previous_page:
@@ -3599,7 +4016,7 @@ paths:
3599
4016
  content:
3600
4017
  application/json:
3601
4018
  example:
3602
- file_url: https://www.signwell.com/completed_docs/yzQaZQykwATojZNwPdpyFAeyz9A/nom151_certificate/
4019
+ file_url: https://www.signwell.com/completed_docs/5pZeLDQAnbfGl8NNpRkntARP6bRZ/nom151_certificate/
3603
4020
  schema:
3604
4021
  "$ref": "#/components/schemas/Nom151UrlResponse"
3605
4022
  '404':
@@ -3621,7 +4038,8 @@ paths:
3621
4038
  application/json:
3622
4039
  example:
3623
4040
  errors:
3624
- not_available: NOM-151 certificate not available
4041
+ table:
4042
+ not_available: NOM-151 certificate not available
3625
4043
  schema:
3626
4044
  "$ref": "#/components/schemas/ValidationErrorResponse"
3627
4045
  '429':
@@ -3670,7 +4088,17 @@ components:
3670
4088
  - alphanumeric
3671
4089
  - us_bank_routing_number
3672
4090
  - us_bank_account_number
4091
+ - custom
3673
4092
  description: Validation rule for text fields
4093
+ ValidationRegex:
4094
+ type: string
4095
+ description: 'Text fields with custom validation only: the regex pattern used
4096
+ to validate field values. Required when validation is set to custom.'
4097
+ ValidationRegexErrorMessage:
4098
+ type: string
4099
+ description: 'Text fields with custom validation only: the error message shown
4100
+ to the recipient when their input doesn''t match the regex pattern. Required
4101
+ when validation is set to custom.'
3674
4102
  DateFormat:
3675
4103
  type: string
3676
4104
  enum:
@@ -3695,8 +4123,8 @@ components:
3695
4123
  properties:
3696
4124
  name:
3697
4125
  type: string
3698
- nullable: true
3699
4126
  description: File name
4127
+ nullable: true
3700
4128
  pages_number:
3701
4129
  type: integer
3702
4130
  description: Number of pages in the file
@@ -3785,6 +4213,177 @@ components:
3785
4213
  required:
3786
4214
  - name
3787
4215
  - required
4216
+ ConditionalRuleRequest:
4217
+ type: object
4218
+ description: 'A conditional logic rule. Create requires target_id, action_type,
4219
+ action_field_ids and conditions; id and deleted are ignored on create. On
4220
+ an update (template update or document update-and-send) the rules are an incremental
4221
+ upsert keyed by id: send id + the fields to change to modify a rule, id +
4222
+ deleted: true to remove it, or omit id to add a new rule.'
4223
+ properties:
4224
+ id:
4225
+ type: string
4226
+ description: 'The rule''s persistent ID. Ignored on create (every rule is
4227
+ new). On an update (template update or document update-and-send) include
4228
+ it to modify an existing rule, or pair it with `deleted: true` to remove
4229
+ the rule; omit it to add a new rule.'
4230
+ deleted:
4231
+ type: boolean
4232
+ description: 'Only meaningful on an update (template update or document
4233
+ update-and-send): set to true together with the rule''s `id` to remove
4234
+ that rule. Ignored on create — there is no existing rule to delete.'
4235
+ target_id:
4236
+ type: string
4237
+ description: api_id of the field that owns the rule, or the external_id
4238
+ of a checkbox group when the rule is owned by a group (groups have no
4239
+ api_id). Cannot also appear in action_field_ids (self-reference is forbidden).
4240
+ action_type:
4241
+ type: string
4242
+ enum:
4243
+ - show
4244
+ - hide
4245
+ - require
4246
+ description: 'Action applied to action_field_ids when the conditions are
4247
+ met: `show`, `hide`, or `require`.'
4248
+ action_field_ids:
4249
+ type: array
4250
+ items:
4251
+ type: string
4252
+ description: api_ids of the fields the action applies to. List a checkbox
4253
+ group's member api_ids to target the whole group.
4254
+ conditions:
4255
+ type: array
4256
+ description: The conditions that trigger the rule. At least 1, at most 5.
4257
+ items:
4258
+ type: object
4259
+ properties:
4260
+ condition_type:
4261
+ type: string
4262
+ enum:
4263
+ - any_of
4264
+ - all_of
4265
+ - none_of
4266
+ - not_all_of
4267
+ description: 'How the field_api_ids combine within a condition: `any_of`,
4268
+ `all_of`, `none_of`, or `not_all_of`.'
4269
+ status:
4270
+ type: string
4271
+ enum:
4272
+ - completed
4273
+ - not_completed
4274
+ description: 'The field state the condition tests for: `completed`
4275
+ or `not_completed`.'
4276
+ join_operator:
4277
+ type: string
4278
+ enum:
4279
+ - and_operator
4280
+ - or_operator
4281
+ description: 'How this condition joins the next one in the rule: `and_operator`
4282
+ or `or_operator`. The first condition''s value is ignored.'
4283
+ field_api_ids:
4284
+ type: array
4285
+ items:
4286
+ type: string
4287
+ description: api_ids of the trigger fields the condition watches.
4288
+ position:
4289
+ type: integer
4290
+ description: 1-indexed order of the condition within the rule.
4291
+ required:
4292
+ - condition_type
4293
+ - status
4294
+ - field_api_ids
4295
+ ConditionalRuleInfo:
4296
+ type: object
4297
+ description: Conditional rule configuration
4298
+ properties:
4299
+ id:
4300
+ type: string
4301
+ description: Conditional rule ID
4302
+ target_id:
4303
+ type: string
4304
+ description: api_id of the field that owns the rule, or the external_id
4305
+ of a checkbox group when the rule is owned by a group (groups have no
4306
+ api_id)
4307
+ action_type:
4308
+ type: string
4309
+ enum:
4310
+ - show
4311
+ - hide
4312
+ - require
4313
+ description: Action applied to action_field_ids when the conditions are
4314
+ met
4315
+ action_field_ids:
4316
+ type: array
4317
+ items:
4318
+ type: string
4319
+ description: api_ids of fields the rule affects when triggered
4320
+ conditions:
4321
+ type: array
4322
+ items:
4323
+ type: object
4324
+ properties:
4325
+ condition_type:
4326
+ type: string
4327
+ enum:
4328
+ - any_of
4329
+ - all_of
4330
+ - none_of
4331
+ - not_all_of
4332
+ description: How field_api_ids combine within this condition
4333
+ status:
4334
+ type: string
4335
+ enum:
4336
+ - completed
4337
+ - not_completed
4338
+ description: Field state that satisfies this condition
4339
+ join_operator:
4340
+ type: string
4341
+ enum:
4342
+ - and_operator
4343
+ - or_operator
4344
+ description: How this condition joins with the next one in the rule
4345
+ field_api_ids:
4346
+ type: array
4347
+ items:
4348
+ type: string
4349
+ description: api_ids of fields evaluated by this condition
4350
+ position:
4351
+ type: integer
4352
+ description: Order of this condition within the rule
4353
+ required:
4354
+ - id
4355
+ - target_id
4356
+ - action_type
4357
+ ConditionalLogicDecisionInfo:
4358
+ type: object
4359
+ description: Audit record of a signer-side decision about a CL rule that fired
4360
+ against a completed field.
4361
+ properties:
4362
+ rule_id:
4363
+ type: string
4364
+ description: External ID of the conditional rule that fired
4365
+ field_api_id:
4366
+ type: string
4367
+ description: api_id of the field the decision applies to
4368
+ decision_type:
4369
+ type: string
4370
+ enum:
4371
+ - kept_signature
4372
+ - cleared_value
4373
+ description: Whether the signer kept the existing signature or the value
4374
+ was cleared
4375
+ decided_at:
4376
+ type: string
4377
+ format: date-time
4378
+ description: When the decision was recorded
4379
+ description:
4380
+ type: string
4381
+ description: Human-readable summary of the decision
4382
+ required:
4383
+ - rule_id
4384
+ - field_api_id
4385
+ - decision_type
4386
+ - decided_at
3788
4387
  AdditionalFields:
3789
4388
  type: array
3790
4389
  description: Fields to be added to any appended files (not existing files).
@@ -3854,7 +4453,13 @@ components:
3854
4453
  "$ref": "#/components/schemas/TextValidation"
3855
4454
  description: 'Text fields only: optional validation for field values.
3856
4455
  Valid values: numbers, letters, email_address, us_phone_number, us_zip_code,
3857
- us_ssn, us_age, alphanumeric, us_bank_routing_number, us_bank_account.'
4456
+ us_ssn, us_age, alphanumeric, us_bank_routing_number, us_bank_account_number,
4457
+ custom. To set custom validation, enter a regex pattern and regex
4458
+ error message.'
4459
+ validation_regex:
4460
+ "$ref": "#/components/schemas/ValidationRegex"
4461
+ validation_regex_error_message:
4462
+ "$ref": "#/components/schemas/ValidationRegexErrorMessage"
3858
4463
  fixed_width:
3859
4464
  type: boolean
3860
4465
  default: false
@@ -4082,7 +4687,13 @@ components:
4082
4687
  - checkbox_ids
4083
4688
  BulkSendCsv:
4084
4689
  type: string
4085
- description: A RFC 4648 base64 string of the template CSV file to be validated.
4690
+ description: 'A RFC 4648 base64 string of the template CSV file to be validated.
4691
+ While 21 CFR Part 11 is enabled, every recipient needs a name: the CSV must
4692
+ carry a name column next to each placeholder email column (for example `signer_name`
4693
+ alongside `signer_email`), and each row must fill that name in wherever it
4694
+ carries the matching email, otherwise it returns a 422. A row that leaves
4695
+ both the email and the name blank sends nothing to that placeholder, so no
4696
+ name is needed there.'
4086
4697
  Base64Flag:
4087
4698
  type: boolean
4088
4699
  description: When true, returns the CSV as a base64-encoded string in a JSON
@@ -4140,7 +4751,9 @@ components:
4140
4751
  type: string
4141
4752
  description: In some cases, it may be necessary to pre-fill the name and
4142
4753
  email for a placeholder because it will always be the same person for
4143
- all documents created from this template. This sets the name.
4754
+ all documents created from this template. This sets the name. Every
4755
+ recipient on a 21 CFR Part 11 document needs a name, so leaving it unset
4756
+ means the name has to be supplied when the document is created.
4144
4757
  preassigned_recipient_email:
4145
4758
  type: string
4146
4759
  format: email
@@ -4171,16 +4784,44 @@ components:
4171
4784
  associating recipients to fields and more.
4172
4785
  name:
4173
4786
  type: string
4174
- description: Name of the recipient.
4787
+ description: 'Name of the recipient. Required on 21 CFR Part 11 documents:
4788
+ a recipient without a name returns a 422.'
4175
4789
  email:
4176
4790
  type: string
4177
4791
  format: email
4178
- description: Email address for the recipient.
4792
+ description: Email address for the recipient. Required unless the recipient's
4793
+ `delivery_method` is `sms`.
4179
4794
  example: signer@example.com
4180
4795
  passcode:
4181
4796
  type: string
4182
4797
  description: If set, signers assigned with a passcode will be required
4183
4798
  to enter the passcode before they’re able to view and complete the document.
4799
+ On a 21 CFR Part 11 document SignWell generates the passcode, so a sender-defined
4800
+ passcode returns a 422.
4801
+ passcode_delivery:
4802
+ type: object
4803
+ description: Passcode delivery settings. When enabled, the system delivers
4804
+ the passcode to the signer via email. Always on for 21 CFR Part 11 documents
4805
+ and cannot be disabled.
4806
+ properties:
4807
+ enabled:
4808
+ type: boolean
4809
+ description: 'Enable passcode delivery for this recipient. Cannot
4810
+ be set to `false` on a 21 CFR Part 11 document: it returns a 422.'
4811
+ methods:
4812
+ type: array
4813
+ items:
4814
+ type: string
4815
+ enum:
4816
+ - email
4817
+ description: 'Delivery methods for the passcode. Currently supports:
4818
+ email. Defaults to ["email"] when omitted.'
4819
+ expire_after_access:
4820
+ type: boolean
4821
+ description: When enabled, the passcode is cleared after successful
4822
+ authentication. If passcode_delivery is also enabled, a new passcode
4823
+ is auto-generated on the next send request. Otherwise the recipient
4824
+ will no longer need a passcode.
4184
4825
  subject:
4185
4826
  type: string
4186
4827
  description: Email subject for the signature request that the recipient
@@ -4205,9 +4846,45 @@ components:
4205
4846
  a few minutes. The email notification will not go out if the document
4206
4847
  is completed before the delay time is over. Valid values are in minutes
4207
4848
  ranging from `0` to `60`. Defaults to `0`.
4849
+ delivery_method:
4850
+ type: string
4851
+ enum:
4852
+ - email
4853
+ - sms
4854
+ - email_and_sms
4855
+ default: email
4856
+ description: 'How the recipient is notified and receives the signing link:
4857
+ `email` (default), `sms`, or `email_and_sms`. SMS delivery is available
4858
+ only to workspaces that are eligible for SMS and have it enabled. `email`
4859
+ requires `email`, `sms` requires `phone_number`, and `email_and_sms`
4860
+ requires both. SMS content always uses fixed system templates; `subject`
4861
+ and `message` apply to email notifications only. A 21 CFR Part 11 document
4862
+ records one verified channel per recipient: `email` and `sms` are both
4863
+ accepted, while `email_and_sms` returns a 422.'
4864
+ phone_number:
4865
+ type: string
4866
+ example: "+14155551234"
4867
+ description: Recipient phone number in E.164 format (for example `+14155551234`).
4868
+ Required when `delivery_method` is `sms` or `email_and_sms`. Only phone
4869
+ numbers from the country codes currently enabled for SMS are accepted.
4870
+ send_sms:
4871
+ type: boolean
4872
+ default: false
4873
+ description: Applies only when `embedded_signing` is `true` and the recipient's
4874
+ `delivery_method` includes SMS. By default, recipients are not notified
4875
+ through SMS when doing embedded signing. Setting this to `true` will
4876
+ send the SMS notification to the recipient. Default is `false`.
4877
+ send_sms_delay:
4878
+ type: integer
4879
+ default: 0
4880
+ description: If `send_sms` is `true` the recipient will receive the SMS
4881
+ notification immediately. In the case of embedded signing, you can delay
4882
+ this notification to only send if the document is not completed within
4883
+ a few minutes. The SMS will not go out if the document is completed
4884
+ before the delay time is over. Valid values are in minutes ranging from
4885
+ `0` to `60`. Defaults to `0`.
4208
4886
  required:
4209
4887
  - id
4210
- - email
4211
4888
  Fields:
4212
4889
  type: array
4213
4890
  description: Document fields placed on a document for collecting data or signatures
@@ -4278,7 +4955,13 @@ components:
4278
4955
  "$ref": "#/components/schemas/TextValidation"
4279
4956
  description: 'Text fields only: optional validation for field values.
4280
4957
  Valid values: numbers, letters, email_address, us_phone_number, us_zip_code,
4281
- us_ssn, us_age, alphanumeric, us_bank_routing_number, us_bank_account.'
4958
+ us_ssn, us_age, alphanumeric, us_bank_routing_number, us_bank_account_number,
4959
+ custom. To set custom validation, enter a regex pattern and regex
4960
+ error message.'
4961
+ validation_regex:
4962
+ "$ref": "#/components/schemas/ValidationRegex"
4963
+ validation_regex_error_message:
4964
+ "$ref": "#/components/schemas/ValidationRegexErrorMessage"
4282
4965
  fixed_width:
4283
4966
  type: boolean
4284
4967
  default: false
@@ -4395,7 +5078,13 @@ components:
4395
5078
  "$ref": "#/components/schemas/TextValidation"
4396
5079
  description: 'Text fields only: optional validation for field values.
4397
5080
  Valid values: numbers, letters, email_address, us_phone_number, us_zip_code,
4398
- us_ssn, us_age, alphanumeric, us_bank_routing_number, us_bank_account.'
5081
+ us_ssn, us_age, alphanumeric, us_bank_routing_number, us_bank_account_number,
5082
+ custom. To set custom validation, enter a regex pattern and regex
5083
+ error message.'
5084
+ validation_regex:
5085
+ "$ref": "#/components/schemas/ValidationRegex"
5086
+ validation_regex_error_message:
5087
+ "$ref": "#/components/schemas/ValidationRegexErrorMessage"
4399
5088
  fixed_width:
4400
5089
  type: boolean
4401
5090
  default: false
@@ -4498,21 +5187,51 @@ components:
4498
5187
  type: string
4499
5188
  description: In some cases, it may be necessary to pre-fill the name and
4500
5189
  email for a placeholder because it will always be the same person for
4501
- all documents created from this template. This sets the name.
5190
+ all documents created from this template. This sets the name. Every
5191
+ recipient on a 21 CFR Part 11 document needs a name, so leaving it unset
5192
+ means the name has to be supplied when the document is created.
4502
5193
  preassigned_recipient_email:
4503
5194
  type: string
4504
5195
  format: email
4505
5196
  description: In some cases, it may be necessary to pre-fill the name and
4506
5197
  email for a placeholder because it will always be the same person for
4507
5198
  all documents created from this template. This sets the email.
5199
+ passcode_delivery:
5200
+ type: object
5201
+ description: 'Passcode delivery (OTP) settings for this placeholder. When
5202
+ enabled, documents created from this template inherit these settings
5203
+ for the corresponding recipient. While 21 CFR Part 11 is enabled for
5204
+ the workspace, a placeholder cannot disable passcode delivery: it returns
5205
+ a 422.'
5206
+ properties:
5207
+ enabled:
5208
+ type: boolean
5209
+ description: 'Enable passcode delivery for this recipient. Cannot
5210
+ be set to `false` on a 21 CFR Part 11 document: it returns a 422.'
5211
+ methods:
5212
+ type: array
5213
+ items:
5214
+ type: string
5215
+ enum:
5216
+ - email
5217
+ description: 'Delivery methods for the passcode. Currently supports:
5218
+ email. Defaults to ["email"] when omitted.'
5219
+ expire_after_access:
5220
+ type: boolean
5221
+ description: Whether the passcode expires after the recipient accesses
5222
+ the document. Inherited by documents created from this template.
4508
5223
  required:
4509
5224
  - id
4510
5225
  - name
4511
5226
  ReminderRecipients:
4512
5227
  type: array
4513
- description: Optional list if recipients within the document to send a reminder
4514
- email to. If none are specified, all recipients that have not signed yet will
4515
- receive a reminder email.
5228
+ description: 'Optional list of recipients within the document to remind. If
5229
+ none are specified, all recipients that have not signed yet are reminded.
5230
+ Each recipient is reminded through their own delivery method: email-only recipients
5231
+ get a reminder email, SMS-only recipients get a reminder text, and email_and_sms
5232
+ recipients get both. If the workspace has insufficient SMS credit, only the
5233
+ SMS reminder is skipped and the sender is notified once; the email reminder
5234
+ (if applicable) still goes out.'
4516
5235
  items:
4517
5236
  type: object
4518
5237
  properties:
@@ -4523,7 +5242,9 @@ components:
4523
5242
  email:
4524
5243
  type: string
4525
5244
  format: email
4526
- description: Recipient's email address.
5245
+ description: Recipient's email address. Used to match the recipient to
5246
+ remind; not required for SMS-only recipients, who can be identified
5247
+ by name instead.
4527
5248
  update_recipients_map:
4528
5249
  type: array
4529
5250
  description: List of recipients to update on the document.
@@ -4557,7 +5278,29 @@ components:
4557
5278
  type: string
4558
5279
  description: Updated passcode for the recipient. If set, the signer will
4559
5280
  be required to enter the passcode before viewing and completing the
4560
- document.
5281
+ document. On a 21 CFR Part 11 document SignWell generates the passcode,
5282
+ so a sender-defined passcode returns a 422.
5283
+ passcode_delivery:
5284
+ type: object
5285
+ description: Passcode delivery settings. Always on for 21 CFR Part 11
5286
+ documents and cannot be disabled.
5287
+ properties:
5288
+ enabled:
5289
+ type: boolean
5290
+ description: 'Enable or disable passcode delivery. Cannot be set to
5291
+ `false` on a 21 CFR Part 11 document: it returns a 422.'
5292
+ methods:
5293
+ type: array
5294
+ items:
5295
+ type: string
5296
+ enum:
5297
+ - email
5298
+ description: Delivery methods. Defaults to ["email"].
5299
+ expire_after_access:
5300
+ type: boolean
5301
+ description: Clear passcode after successful authentication. If passcode_delivery
5302
+ is also enabled, a new passcode is auto-generated on the next send
5303
+ request. Otherwise the recipient will no longer need a passcode.
4561
5304
  TemplateFieldValues:
4562
5305
  type: array
4563
5306
  description: Fields of your template(s) that you can prepopulate with values.
@@ -4581,13 +5324,19 @@ components:
4581
5324
  TemplateId:
4582
5325
  type: string
4583
5326
  format: uuid
4584
- description: Unique identifier for a template.
5327
+ description: 'Unique identifier for a template. A template that carries a pre-applied
5328
+ signature or initials field cannot be used while 21 CFR Part 11 is enabled,
5329
+ which requires every signature to be signed by the recipient: it returns a
5330
+ 422.'
4585
5331
  TemplateIds:
4586
5332
  type: array
4587
5333
  items:
4588
5334
  type: string
4589
5335
  format: uuid
4590
- description: Unique identifiers for a list of templates.
5336
+ description: 'Unique identifiers for a list of templates. A template that carries
5337
+ a pre-applied signature or initials field cannot be used while 21 CFR Part
5338
+ 11 is enabled, which requires every signature to be signed by the recipient:
5339
+ it returns a 422.'
4591
5340
  TemplateRecipients:
4592
5341
  type: array
4593
5342
  description: Document recipients are people that must complete and/or sign a
@@ -4603,11 +5352,13 @@ components:
4603
5352
  associating recipients to fields and more.
4604
5353
  name:
4605
5354
  type: string
4606
- description: Name of the recipient.
5355
+ description: 'Name of the recipient. Required on 21 CFR Part 11 documents:
5356
+ a recipient without a name returns a 422.'
4607
5357
  email:
4608
5358
  type: string
4609
5359
  format: email
4610
- description: Email address for the recipient.
5360
+ description: Email address for the recipient. Required unless `delivery_method`
5361
+ is `sms`.
4611
5362
  example: signer@example.com
4612
5363
  placeholder_name:
4613
5364
  type: string
@@ -4617,6 +5368,32 @@ components:
4617
5368
  type: string
4618
5369
  description: If set, signers assigned with a passcode will be required
4619
5370
  to enter the passcode before they’re able to view and complete the document.
5371
+ On a 21 CFR Part 11 document SignWell generates the passcode, so a sender-defined
5372
+ passcode returns a 422.
5373
+ passcode_delivery:
5374
+ type: object
5375
+ description: Passcode delivery settings. When enabled, the system delivers
5376
+ the passcode to the signer via email. Always on for 21 CFR Part 11 documents
5377
+ and cannot be disabled.
5378
+ properties:
5379
+ enabled:
5380
+ type: boolean
5381
+ description: 'Enable passcode delivery for this recipient. Cannot
5382
+ be set to `false` on a 21 CFR Part 11 document: it returns a 422.'
5383
+ methods:
5384
+ type: array
5385
+ items:
5386
+ type: string
5387
+ enum:
5388
+ - email
5389
+ description: 'Delivery methods for the passcode. Currently supports:
5390
+ email. Defaults to ["email"] when omitted.'
5391
+ expire_after_access:
5392
+ type: boolean
5393
+ description: When enabled, the passcode is cleared after successful
5394
+ authentication. If passcode_delivery is also enabled, a new passcode
5395
+ is auto-generated on the next send request. Otherwise the recipient
5396
+ will no longer need a passcode.
4620
5397
  subject:
4621
5398
  type: string
4622
5399
  description: Email subject for the signature request that the recipient
@@ -4641,9 +5418,45 @@ components:
4641
5418
  a few minutes. The email notification will not go out if the document
4642
5419
  is completed before the delay time is over. Valid values are in minutes
4643
5420
  ranging from `0` to `60`. Defaults to `0`.
5421
+ delivery_method:
5422
+ type: string
5423
+ enum:
5424
+ - email
5425
+ - sms
5426
+ - email_and_sms
5427
+ default: email
5428
+ description: 'How the recipient is notified and receives the signing link:
5429
+ `email` (default), `sms`, or `email_and_sms`. SMS delivery is available
5430
+ only to workspaces that are eligible for SMS and have it enabled. `email`
5431
+ requires `email`, `sms` requires `phone_number`, and `email_and_sms`
5432
+ requires both. SMS content always uses fixed system templates; `subject`
5433
+ and `message` apply to email notifications only. A 21 CFR Part 11 document
5434
+ records one verified channel per recipient: `email` and `sms` are both
5435
+ accepted, while `email_and_sms` returns a 422.'
5436
+ phone_number:
5437
+ type: string
5438
+ example: "+14155551234"
5439
+ description: Recipient phone number in E.164 format (for example `+14155551234`).
5440
+ Required when `delivery_method` is `sms` or `email_and_sms`. Only phone
5441
+ numbers from the country codes currently enabled for SMS are accepted.
5442
+ send_sms:
5443
+ type: boolean
5444
+ default: false
5445
+ description: Applies only when `embedded_signing` is `true` and the recipient's
5446
+ `delivery_method` includes SMS. By default, recipients are not notified
5447
+ through SMS when doing embedded signing. Setting this to `true` will
5448
+ send the SMS notification to the recipient. Default is `false`.
5449
+ send_sms_delay:
5450
+ type: integer
5451
+ default: 0
5452
+ description: If `send_sms` is `true` the recipient will receive the SMS
5453
+ notification immediately. In the case of embedded signing, you can delay
5454
+ this notification to only send if the document is not completed within
5455
+ a few minutes. The SMS will not go out if the document is completed
5456
+ before the delay time is over. Valid values are in minutes ranging from
5457
+ `0` to `60`. Defaults to `0`.
4644
5458
  required:
4645
5459
  - id
4646
- - email
4647
5460
  UrlOnly:
4648
5461
  type: boolean
4649
5462
  default: false
@@ -4657,15 +5470,17 @@ components:
4657
5470
  IncludeAuditPage:
4658
5471
  type: boolean
4659
5472
  default: true
4660
- description: Whether to include the audit page as part of the document. Defaults
4661
- to `true`
5473
+ description: 'Whether to include the audit page as part of the document. Defaults
5474
+ to `true`. Cannot be turned off on a 21 CFR Part 11 document: the audit page
5475
+ is part of the record and setting it to `false` returns a 422.'
4662
5476
  FileFormat:
4663
5477
  type: string
4664
5478
  enum:
4665
5479
  - pdf
4666
5480
  - zip
4667
5481
  description: Format of the file to be downloaded. Supported formats are 'pdf'
4668
- and 'zip'.
5482
+ and 'zip'. `zip` is unavailable on a 21 CFR Part 11 document, whose completed
5483
+ PDF, E-Signature page and audit page stay together as one record.
4669
5484
  UserEmail:
4670
5485
  type: string
4671
5486
  format: email
@@ -4752,10 +5567,19 @@ components:
4752
5567
  type: string
4753
5568
  format: uuid
4754
5569
  example: 00000000-0000-0000-0000-000000000000
4755
- description: Unique identifiers for a list of templates.
5570
+ description: 'Unique identifiers for a list of templates. A template that
5571
+ carries a pre-applied signature or initials field cannot be used while
5572
+ 21 CFR Part 11 is enabled, which requires every signature to be signed
5573
+ by the recipient: it returns a 422.'
4756
5574
  bulk_send_csv:
4757
5575
  type: string
4758
- description: A RFC 4648 base64 string of the template CSV file to be validated.
5576
+ description: 'A RFC 4648 base64 string of the template CSV file to be validated.
5577
+ While 21 CFR Part 11 is enabled, every recipient needs a name: the CSV
5578
+ must carry a name column next to each placeholder email column (for example
5579
+ `signer_name` alongside `signer_email`), and each row must fill that name
5580
+ in wherever it carries the matching email, otherwise it returns a 422.
5581
+ A row that leaves both the email and the name blank sends nothing to that
5582
+ placeholder, so no name is needed there.'
4759
5583
  example: bmFtZSxlbWFpbApUZXN0LHRlc3RAZXhhbXBsZS5jb20K
4760
5584
  skip_row_errors:
4761
5585
  type: boolean
@@ -4813,7 +5637,13 @@ components:
4813
5637
  example: 00000000-0000-0000-0000-000000000000
4814
5638
  bulk_send_csv:
4815
5639
  type: string
4816
- description: A RFC 4648 base64 string of the template CSV file to be validated.
5640
+ description: 'A RFC 4648 base64 string of the template CSV file to be validated.
5641
+ While 21 CFR Part 11 is enabled, every recipient needs a name: the CSV
5642
+ must carry a name column next to each placeholder email column (for example
5643
+ `signer_name` alongside `signer_email`), and each row must fill that name
5644
+ in wherever it carries the matching email, otherwise it returns a 422.
5645
+ A row that leaves both the email and the name blank sends nothing to that
5646
+ placeholder, so no name is needed there.'
4817
5647
  example: bmFtZSxlbWFpbApUZXN0LHRlc3RAZXhhbXBsZS5jb20K
4818
5648
  required:
4819
5649
  - template_ids
@@ -4827,6 +5657,14 @@ components:
4827
5657
  description: Set to `true` to enable Test Mode. Documents created with Test
4828
5658
  Mode do not count towards API billing and are not legally binding. Defaults
4829
5659
  to `false`
5660
+ send_sms_test_preview_email:
5661
+ type: boolean
5662
+ default: false
5663
+ description: Only applies when `test_mode` is `true`. When `true`, and the
5664
+ document has an SMS-only recipient, sends the document owner a test-mode
5665
+ preview email (with a masked phone number) instead of the regular SMS
5666
+ sender-copy email. No SMS is sent and no credits are used, in test mode
5667
+ or otherwise. Defaults to `false`.
4830
5668
  files:
4831
5669
  "$ref": "#/components/schemas/Files"
4832
5670
  name:
@@ -4836,12 +5674,14 @@ components:
4836
5674
  type: string
4837
5675
  description: Email subject for the signature request that recipients will
4838
5676
  see. Defaults to the default system subject or a template subject (if
4839
- the document is created from a template).
5677
+ the document is created from a template). Applies to email notifications
5678
+ only; SMS notifications always use fixed system templates.
4840
5679
  message:
4841
5680
  type: string
4842
5681
  description: Email message for the signature request that recipients will
4843
5682
  see. Defaults to the default system message or a template message (if
4844
- the document is created from a template).
5683
+ the document is created from a template). Applies to email notifications
5684
+ only; SMS notifications always use fixed system templates.
4845
5685
  recipients:
4846
5686
  "$ref": "#/components/schemas/Recipients"
4847
5687
  draft:
@@ -4853,10 +5693,12 @@ components:
4853
5693
  self_sign:
4854
5694
  type: boolean
4855
5695
  default: false
4856
- description: When set to true the document will enter self-sign mode, which
5696
+ description: 'When set to true the document will enter self-sign mode, which
4857
5697
  allows the document creator to sign and complete a document without any
4858
5698
  field setup. Must use the embedded_edit_url in the response and (if embedding)
4859
- the embedded requesting workflow.
5699
+ the embedded requesting workflow. Unavailable on 21 CFR Part 11 documents,
5700
+ which require every signature to come from an authenticated signer: sending
5701
+ `true` returns a 422.'
4860
5702
  with_signature_page:
4861
5703
  type: boolean
4862
5704
  default: false
@@ -4898,6 +5740,8 @@ components:
4898
5740
  not get a notification email when documents have been completed. Setting
4899
5741
  this param to `true` will send out those final completed notifications.
4900
5742
  Default is `false`
5743
+ embedded:
5744
+ "$ref": "#/components/schemas/EmbeddedRequest"
4901
5745
  text_tags:
4902
5746
  type: boolean
4903
5747
  default: false
@@ -4931,9 +5775,11 @@ components:
4931
5775
  allow_reassign:
4932
5776
  type: boolean
4933
5777
  default: true
4934
- description: In some cases a signer is not the right person to sign and
5778
+ description: 'In some cases a signer is not the right person to sign and
4935
5779
  may need to reassign their signing responsibilities to another person.
4936
- This feature allows them to reassign the document to someone else.
5780
+ This feature allows them to reassign the document to someone else. Unavailable
5781
+ on 21 CFR Part 11 documents: omit it and reassignment stays off, while
5782
+ sending `true` returns a 422.'
4937
5783
  decline_redirect_url:
4938
5784
  type: string
4939
5785
  format: url
@@ -4948,6 +5794,13 @@ components:
4948
5794
  Türkçe, Slovenčina. Defaults to English. Language should be sent in ISO
4949
5795
  639-1 format: en, fr, es, de, pl, pt, da, nl, it, ru, sv, ar, el, tr,
4950
5796
  sk.'
5797
+ conditional_rules:
5798
+ type: array
5799
+ items:
5800
+ "$ref": "#/components/schemas/ConditionalRuleRequest"
5801
+ description: Conditional logic rules that show, hide, or require fields
5802
+ based on what a signer does to other fields. Every identifier is a field
5803
+ api_id. At most 10 rules per document or template.
4951
5804
  metadata:
4952
5805
  type: object
4953
5806
  additionalProperties:
@@ -4976,6 +5829,14 @@ components:
4976
5829
  description: Set to `true` to enable Test Mode. Documents created with Test
4977
5830
  Mode do not count towards API billing and are not legally binding. Defaults
4978
5831
  to `false`
5832
+ send_sms_test_preview_email:
5833
+ type: boolean
5834
+ default: false
5835
+ description: Only applies when `test_mode` is `true`. When `true`, and the
5836
+ document has an SMS-only recipient, sends the document owner a test-mode
5837
+ preview email (with a masked phone number) instead of the regular SMS
5838
+ sender-copy email. No SMS is sent and no credits are used, in test mode
5839
+ or otherwise. Defaults to `false`.
4979
5840
  template_id:
4980
5841
  type: string
4981
5842
  format: uuid
@@ -4996,12 +5857,14 @@ components:
4996
5857
  type: string
4997
5858
  description: Email subject for the signature request that recipients will
4998
5859
  see. Defaults to the default system subject or a template subject (if
4999
- the document is created from a template).
5860
+ the document is created from a template). Applies to email notifications
5861
+ only; SMS notifications always use fixed system templates.
5000
5862
  message:
5001
5863
  type: string
5002
5864
  description: Email message for the signature request that recipients will
5003
5865
  see. Defaults to the default system message or a template message (if
5004
- the document is created from a template).
5866
+ the document is created from a template). Applies to email notifications
5867
+ only; SMS notifications always use fixed system templates.
5005
5868
  recipients:
5006
5869
  "$ref": "#/components/schemas/TemplateRecipients"
5007
5870
  exclude_placeholders:
@@ -5060,6 +5923,8 @@ components:
5060
5923
  not get a notification email when documents have been completed. Setting
5061
5924
  this param to `true` will send out those final completed notifications.
5062
5925
  Default is `false`
5926
+ embedded:
5927
+ "$ref": "#/components/schemas/EmbeddedRequest"
5063
5928
  text_tags:
5064
5929
  type: boolean
5065
5930
  default: false
@@ -5093,9 +5958,11 @@ components:
5093
5958
  allow_reassign:
5094
5959
  type: boolean
5095
5960
  default: true
5096
- description: In some cases a signer is not the right person to sign and
5961
+ description: 'In some cases a signer is not the right person to sign and
5097
5962
  may need to reassign their signing responsibilities to another person.
5098
- This feature allows them to reassign the document to someone else.
5963
+ This feature allows them to reassign the document to someone else. Unavailable
5964
+ on 21 CFR Part 11 documents: omit it and reassignment stays off, while
5965
+ sending `true` returns a 422.'
5099
5966
  decline_redirect_url:
5100
5967
  type: string
5101
5968
  format: url
@@ -5110,6 +5977,24 @@ components:
5110
5977
  Türkçe, Slovenčina. Defaults to English. Language should be sent in ISO
5111
5978
  639-1 format: en, fr, es, de, pl, pt, da, nl, it, ru, sv, ar, el, tr,
5112
5979
  sk.'
5980
+ conditional_rules:
5981
+ type: array
5982
+ items:
5983
+ "$ref": "#/components/schemas/ConditionalRuleRequest"
5984
+ description: Conditional logic rules that show, hide, or require fields
5985
+ based on what a signer does to other fields. Every identifier is a field
5986
+ api_id. At most 10 rules per document or template.
5987
+ conditional_rules_mode:
5988
+ type: string
5989
+ enum:
5990
+ - replace
5991
+ - append
5992
+ - none
5993
+ description: 'When creating a document from a template, controls how the
5994
+ conditional_rules in the request reconcile with the template''s inherited
5995
+ rules: `replace` (drop inherited, use the body''s rules), `append` (keep
5996
+ inherited, add the body''s rules), or `none` (clear all rules). Required
5997
+ when sending conditional_rules that should not simply inherit.'
5113
5998
  metadata:
5114
5999
  type: object
5115
6000
  additionalProperties:
@@ -5141,6 +6026,14 @@ components:
5141
6026
  description: Set to `true` to enable Test Mode. Documents created with Test
5142
6027
  Mode do not count towards API billing and are not legally binding. Defaults
5143
6028
  to `false`
6029
+ send_sms_test_preview_email:
6030
+ type: boolean
6031
+ default: false
6032
+ description: Only applies when `test_mode` is `true`. When `true`, and the
6033
+ document has an SMS-only recipient, sends the document owner a test-mode
6034
+ preview email (with a masked phone number) instead of the regular SMS
6035
+ sender-copy email. No SMS is sent and no credits are used, in test mode
6036
+ or otherwise. Defaults to `false`.
5144
6037
  name:
5145
6038
  type: string
5146
6039
  description: The name of the document.
@@ -5148,12 +6041,14 @@ components:
5148
6041
  type: string
5149
6042
  description: Email subject for the signature request that recipients will
5150
6043
  see. Defaults to the default system subject or a template subject (if
5151
- the document is created from a template).
6044
+ the document is created from a template). Applies to email notifications
6045
+ only; SMS notifications always use fixed system templates.
5152
6046
  message:
5153
6047
  type: string
5154
6048
  description: Email message for the signature request that recipients will
5155
6049
  see. Defaults to the default system message or a template message (if
5156
- the document is created from a template).
6050
+ the document is created from a template). Applies to email notifications
6051
+ only; SMS notifications always use fixed system templates.
5157
6052
  expires_in:
5158
6053
  type: integer
5159
6054
  minimum: 1
@@ -5189,6 +6084,8 @@ components:
5189
6084
  not get a notification email when documents have been completed. Setting
5190
6085
  this param to `true` will send out those final completed notifications.
5191
6086
  Default is `false`
6087
+ embedded:
6088
+ "$ref": "#/components/schemas/EmbeddedRequest"
5192
6089
  custom_requester_name:
5193
6090
  type: string
5194
6091
  description: Sets the custom requester name for the document. When set,
@@ -5214,14 +6111,23 @@ components:
5214
6111
  allow_reassign:
5215
6112
  type: boolean
5216
6113
  default: true
5217
- description: In some cases a signer is not the right person to sign and
6114
+ description: 'In some cases a signer is not the right person to sign and
5218
6115
  may need to reassign their signing responsibilities to another person.
5219
- This feature allows them to reassign the document to someone else.
6116
+ This feature allows them to reassign the document to someone else. Unavailable
6117
+ on 21 CFR Part 11 documents: omit it and reassignment stays off, while
6118
+ sending `true` returns a 422.'
5220
6119
  decline_redirect_url:
5221
6120
  type: string
5222
6121
  format: url
5223
6122
  description: A URL that recipients are redirected to if the document is
5224
6123
  declined.
6124
+ conditional_rules:
6125
+ type: array
6126
+ items:
6127
+ "$ref": "#/components/schemas/ConditionalRuleRequest"
6128
+ description: Conditional logic rules that show, hide, or require fields
6129
+ based on what a signer does to other fields. Every identifier is a field
6130
+ api_id. At most 10 rules per document or template.
5225
6131
  metadata:
5226
6132
  type: object
5227
6133
  additionalProperties:
@@ -5244,6 +6150,52 @@ components:
5244
6150
  "$ref": "#/components/schemas/update_recipients_map"
5245
6151
  required:
5246
6152
  - recipients
6153
+ update_authentication_request:
6154
+ type: object
6155
+ properties:
6156
+ recipients:
6157
+ type: array
6158
+ description: Recipients whose authentication settings should be updated.
6159
+ items:
6160
+ type: object
6161
+ properties:
6162
+ id:
6163
+ type: string
6164
+ description: A unique identifier that you will give to each recipient.
6165
+ We recommend numbering sequentially from 1 to X. IDs are required
6166
+ for associating recipients to fields and more.
6167
+ passcode:
6168
+ type: string
6169
+ description: Updated passcode for the recipient. If set, the signer
6170
+ will be required to enter the passcode before viewing and completing
6171
+ the document. On a 21 CFR Part 11 document SignWell generates the
6172
+ passcode, so a sender-defined passcode returns a 422.
6173
+ passcode_delivery:
6174
+ type: object
6175
+ description: Passcode delivery settings. Always on for 21 CFR Part
6176
+ 11 documents and cannot be disabled.
6177
+ properties:
6178
+ enabled:
6179
+ type: boolean
6180
+ description: 'Enable or disable passcode delivery. Cannot be set
6181
+ to `false` on a 21 CFR Part 11 document: it returns a 422.'
6182
+ methods:
6183
+ type: array
6184
+ items:
6185
+ type: string
6186
+ enum:
6187
+ - email
6188
+ description: Delivery methods. Defaults to ["email"].
6189
+ expire_after_access:
6190
+ type: boolean
6191
+ description: Clear passcode after successful authentication. If
6192
+ passcode_delivery is also enabled, a new passcode is auto-generated
6193
+ on the next send request. Otherwise the recipient will no longer
6194
+ need a passcode.
6195
+ required:
6196
+ - id
6197
+ required:
6198
+ - recipients
5247
6199
  DocumentTemplateRequest:
5248
6200
  type: object
5249
6201
  properties:
@@ -5256,12 +6208,14 @@ components:
5256
6208
  type: string
5257
6209
  description: Email subject for the signature request that recipients will
5258
6210
  see. Defaults to the default system subject or a template subject (if
5259
- the document is created from a template).
6211
+ the document is created from a template). Applies to email notifications
6212
+ only; SMS notifications always use fixed system templates.
5260
6213
  message:
5261
6214
  type: string
5262
6215
  description: Email message for the signature request that recipients will
5263
6216
  see. Defaults to the default system message or a template message (if
5264
- the document is created from a template).
6217
+ the document is created from a template). Applies to email notifications
6218
+ only; SMS notifications always use fixed system templates.
5265
6219
  placeholders:
5266
6220
  "$ref": "#/components/schemas/Placeholders"
5267
6221
  copied_placeholders:
@@ -5316,9 +6270,11 @@ components:
5316
6270
  allow_reassign:
5317
6271
  type: boolean
5318
6272
  default: true
5319
- description: In some cases a signer is not the right person to sign and
6273
+ description: 'In some cases a signer is not the right person to sign and
5320
6274
  may need to reassign their signing responsibilities to another person.
5321
- This feature allows them to reassign the document to someone else.
6275
+ This feature allows them to reassign the document to someone else. Unavailable
6276
+ on 21 CFR Part 11 documents: omit it and reassignment stays off, while
6277
+ sending `true` returns a 422.'
5322
6278
  decline_redirect_url:
5323
6279
  type: string
5324
6280
  format: url
@@ -5333,6 +6289,13 @@ components:
5333
6289
  Svenska, العربية, Ελληνικά, Türkçe, Slovenčina. Language should be sent
5334
6290
  in ISO 639-1 format: en, fr, es, de, pl, pt, da, nl, it, ru, sv, ar, el,
5335
6291
  tr, sk.'
6292
+ conditional_rules:
6293
+ type: array
6294
+ items:
6295
+ "$ref": "#/components/schemas/ConditionalRuleRequest"
6296
+ description: Conditional logic rules that show, hide, or require fields
6297
+ based on what a signer does to other fields. Every identifier is a field
6298
+ api_id. At most 10 rules per document or template.
5336
6299
  metadata:
5337
6300
  type: object
5338
6301
  additionalProperties:
@@ -5360,12 +6323,14 @@ components:
5360
6323
  type: string
5361
6324
  description: Email subject for the signature request that recipients will
5362
6325
  see. Defaults to the default system subject or a template subject (if
5363
- the document is created from a template).
6326
+ the document is created from a template). Applies to email notifications
6327
+ only; SMS notifications always use fixed system templates.
5364
6328
  message:
5365
6329
  type: string
5366
6330
  description: Email message for the signature request that recipients will
5367
6331
  see. Defaults to the default system message or a template message (if
5368
- the document is created from a template).
6332
+ the document is created from a template). Applies to email notifications
6333
+ only; SMS notifications always use fixed system templates.
5369
6334
  draft:
5370
6335
  type: boolean
5371
6336
  default: false
@@ -5408,14 +6373,23 @@ components:
5408
6373
  allow_reassign:
5409
6374
  type: boolean
5410
6375
  default: true
5411
- description: In some cases a signer is not the right person to sign and
6376
+ description: 'In some cases a signer is not the right person to sign and
5412
6377
  may need to reassign their signing responsibilities to another person.
5413
- This feature allows them to reassign the document to someone else.
6378
+ This feature allows them to reassign the document to someone else. Unavailable
6379
+ on 21 CFR Part 11 documents: omit it and reassignment stays off, while
6380
+ sending `true` returns a 422.'
5414
6381
  decline_redirect_url:
5415
6382
  type: string
5416
6383
  format: url
5417
6384
  description: A URL that recipients are redirected to if the document is
5418
6385
  declined.
6386
+ conditional_rules:
6387
+ type: array
6388
+ items:
6389
+ "$ref": "#/components/schemas/ConditionalRuleRequest"
6390
+ description: Conditional logic rules that show, hide, or require fields
6391
+ based on what a signer does to other fields. Every identifier is a field
6392
+ api_id. At most 10 rules per document or template.
5419
6393
  metadata:
5420
6394
  type: object
5421
6395
  additionalProperties:
@@ -5431,25 +6405,6 @@ components:
5431
6405
  - "$ref": "#/components/schemas/CompletedPdfUrlResponse"
5432
6406
  - "$ref": "#/components/schemas/CompletedPdfBinaryResponse"
5433
6407
  - "$ref": "#/components/schemas/CompletedPdfZipResponse"
5434
- CompletedPdfUrlResponse:
5435
- type: object
5436
- description: JSON response containing the URL to the completed PDF file (returned
5437
- when url_only=true)
5438
- properties:
5439
- file_url:
5440
- type: string
5441
- format: url
5442
- description: URL to download the completed document
5443
- required:
5444
- - file_url
5445
- CompletedPdfBinaryResponse:
5446
- type: string
5447
- format: binary
5448
- description: Raw PDF binary data (default response when url_only=false)
5449
- CompletedPdfZipResponse:
5450
- type: string
5451
- format: binary
5452
- description: ZIP file containing the completed PDF (returned when file_format=zip)
5453
6408
  Nom151CertificateResponse:
5454
6409
  type: object
5455
6410
  description: NOM-151 certificate data returned when object_only=true
@@ -5504,9 +6459,136 @@ components:
5504
6459
  description: Public URL to download the certificate ZIP file
5505
6460
  required:
5506
6461
  - file_url
6462
+ EmbeddedBrandingRequest:
6463
+ type: object
6464
+ nullable: true
6465
+ description: 'Branding for this document''s embedded requesting and signing
6466
+ experiences. Every property is optional and independent. A property you supply
6467
+ overrides the selected API Application; one you omit inherits from it, then
6468
+ from the SignWell default. `company_logo` has one extra step between those
6469
+ two: the account''s Settings > Branding logo, which applies on paid plans
6470
+ only. The colors and the border radius have no account step — omitting one
6471
+ falls straight through to the SignWell default. On Update and Send Document
6472
+ the object is a patch: only the properties you send change, and a property
6473
+ sent as `null` clears your override so the value inherits again. Sending `branding`
6474
+ itself as `null` clears every property.'
6475
+ properties:
6476
+ company_logo:
6477
+ type: object
6478
+ nullable: true
6479
+ description: Logo shown on this document's embedded pages. Supply either
6480
+ `file_url` or `file_base64`, never both — sending both returns a `422`.
6481
+ Sending `company_logo` replaces the logo outright, so whichever source
6482
+ you omit is cleared; sending it as `null` removes the logo. Recommended
6483
+ size is 300 x 60 px with a transparent background; these are recommendations,
6484
+ not validated. In responses this property is `"provided"` — the URL and
6485
+ the Base64 payload are never returned.
6486
+ properties:
6487
+ file_url:
6488
+ type: string
6489
+ description: Public `http` or `https` URL of the logo image. The value
6490
+ has to parse as one — anything else returns a `422`. SignWell never
6491
+ requests the URL when the document is created, so it is not checked
6492
+ for reachability or for what it points at. If the URL turns out to
6493
+ be unreachable, slow, or not a usable image when the page loads, the
6494
+ page falls back to the no-logo experience rather than erroring.
6495
+ example: https://example.com/customer-logo.png
6496
+ file_base64:
6497
+ type: string
6498
+ description: RFC 4648 Base64 string of the logo image. The 300 KB limit
6499
+ applies to the decoded image, not to the string you send, so a valid
6500
+ string runs about a third larger. The decoded image must be one of
6501
+ image/jpeg, image/png, image/gif, image/tiff, image/webp, image/svg+xml,
6502
+ image/heic, image/heif, image/avif. A payload that cannot be decoded,
6503
+ is not one of those formats, or is over the size limit returns a `422`.
6504
+ A payload that is accepted here but still fails to render when the
6505
+ page loads falls back to the no-logo experience.
6506
+ accent_color:
6507
+ type: string
6508
+ nullable: true
6509
+ description: Accent color for this document's embedded pages, as a 6-digit
6510
+ HEX value. Returned normalized to `#RRGGBB`.
6511
+ example: "#51B6C4"
6512
+ button_label_color:
6513
+ type: string
6514
+ nullable: true
6515
+ description: Button label color for this document's embedded pages, as a
6516
+ 6-digit HEX value. Returned normalized to `#RRGGBB`.
6517
+ example: "#FFFFFF"
6518
+ link_color:
6519
+ type: string
6520
+ nullable: true
6521
+ description: Link color for this document's embedded pages, as a 6-digit
6522
+ HEX value. Returned normalized to `#RRGGBB`.
6523
+ example: "#1A0DAB"
6524
+ button_border_radius:
6525
+ type: integer
6526
+ nullable: true
6527
+ minimum: 0
6528
+ maximum: 25
6529
+ description: Corner radius of buttons on this document's embedded pages,
6530
+ in pixels. Must be between 0 and 25.
6531
+ example: 25
6532
+ EmbeddedRequest:
6533
+ type: object
6534
+ description: 'Optional container for embedded settings. Purely additive: requests
6535
+ that omit it behave exactly as before, and the existing top-level `api_application_id`,
6536
+ `embedded_signing` and `embedded_signing_notifications` parameters are unchanged.
6537
+ Not supported on template endpoints, which return a `422` if it is present.'
6538
+ properties:
6539
+ branding:
6540
+ "$ref": "#/components/schemas/EmbeddedBrandingRequest"
6541
+ EmbeddedBranding:
6542
+ type: object
6543
+ nullable: true
6544
+ description: 'The branding the caller set on THIS document, echoed back. Null
6545
+ when the caller set none: the document then renders with the API Application,
6546
+ workspace or system branding, and that resolved branding is deliberately not
6547
+ reported here.'
6548
+ properties:
6549
+ branding:
6550
+ type: object
6551
+ description: 'Only the properties actually set on the document. Every one
6552
+ is optional: an unset property is absent rather than null, because null
6553
+ is how a request clears one.'
6554
+ properties:
6555
+ company_logo:
6556
+ type: string
6557
+ enum:
6558
+ - provided
6559
+ description: Write-only. Reports only that a logo was set, never its
6560
+ URL or Base64 payload.
6561
+ accent_color:
6562
+ type: string
6563
+ description: 'Hex, as #RRGGBB.'
6564
+ button_label_color:
6565
+ type: string
6566
+ description: 'Hex, as #RRGGBB.'
6567
+ link_color:
6568
+ type: string
6569
+ description: 'Hex, as #RRGGBB.'
6570
+ button_border_radius:
6571
+ type: integer
6572
+ description: Pixels, 0 to 25.
6573
+ required:
6574
+ - branding
5507
6575
  DocumentResponse:
5508
6576
  type: object
5509
6577
  properties:
6578
+ cfr_part11:
6579
+ type: boolean
6580
+ description: 'Whether 21 CFR Part 11 controls apply to this document. Read-only:
6581
+ the value is taken from the workspace setting when the document is created
6582
+ and never changes afterwards.'
6583
+ cfr_part11_signing_mode:
6584
+ type: string
6585
+ enum:
6586
+ - streamlined
6587
+ - per_signature
6588
+ nullable: true
6589
+ description: 'The signing mode of a 21 CFR Part 11 document: streamlined
6590
+ (one final authentication) or per_signature (authentication at every signature
6591
+ and initials field). Null when Part 11 does not apply.'
5510
6592
  test_mode:
5511
6593
  type: boolean
5512
6594
  id:
@@ -5567,6 +6649,42 @@ components:
5567
6649
  send_email_delay:
5568
6650
  type: integer
5569
6651
  nullable: true
6652
+ delivery_method:
6653
+ type: string
6654
+ enum:
6655
+ - email
6656
+ - sms
6657
+ - email_and_sms
6658
+ description: 'How the recipient is notified: email (default), sms,
6659
+ or email_and_sms.'
6660
+ sms:
6661
+ type: object
6662
+ description: SMS delivery metadata. Only present when delivery_method
6663
+ includes SMS.
6664
+ properties:
6665
+ phone_number_masked:
6666
+ type: string
6667
+ nullable: true
6668
+ description: Masked phone number; the full number never leaves
6669
+ the API.
6670
+ send_sms:
6671
+ type: boolean
6672
+ nullable: true
6673
+ send_sms_delay:
6674
+ type: integer
6675
+ nullable: true
6676
+ delivery_status:
6677
+ type: string
6678
+ nullable: true
6679
+ message_type:
6680
+ type: string
6681
+ nullable: true
6682
+ failed:
6683
+ type: boolean
6684
+ nullable: true
6685
+ failed_details:
6686
+ type: string
6687
+ nullable: true
5570
6688
  signing_order:
5571
6689
  type: integer
5572
6690
  signing_url:
@@ -5590,6 +6708,18 @@ components:
5590
6708
  passcode:
5591
6709
  type: string
5592
6710
  nullable: true
6711
+ passcode_delivery:
6712
+ type: object
6713
+ properties:
6714
+ enabled:
6715
+ type: boolean
6716
+ methods:
6717
+ type: array
6718
+ items:
6719
+ type: string
6720
+ nullable: true
6721
+ expire_after_access:
6722
+ type: boolean
5593
6723
  status:
5594
6724
  type: string
5595
6725
  nullable: true
@@ -5605,6 +6735,8 @@ components:
5605
6735
  type: boolean
5606
6736
  archived:
5607
6737
  type: boolean
6738
+ embedded:
6739
+ "$ref": "#/components/schemas/EmbeddedBranding"
5608
6740
  embedded_signing:
5609
6741
  type: boolean
5610
6742
  embedded_edit_url:
@@ -5714,6 +6846,10 @@ components:
5714
6846
  "$ref": "#/components/schemas/FieldType"
5715
6847
  validation:
5716
6848
  "$ref": "#/components/schemas/TextValidation"
6849
+ validation_regex:
6850
+ "$ref": "#/components/schemas/ValidationRegex"
6851
+ validation_regex_error_message:
6852
+ "$ref": "#/components/schemas/ValidationRegexErrorMessage"
5717
6853
  value:
5718
6854
  oneOf:
5719
6855
  - type: string
@@ -5768,6 +6904,14 @@ components:
5768
6904
  type: array
5769
6905
  items:
5770
6906
  "$ref": "#/components/schemas/CheckboxGroupInfo"
6907
+ conditional_rules:
6908
+ type: array
6909
+ items:
6910
+ "$ref": "#/components/schemas/ConditionalRuleInfo"
6911
+ conditional_logic_decisions:
6912
+ type: array
6913
+ items:
6914
+ "$ref": "#/components/schemas/ConditionalLogicDecisionInfo"
5771
6915
  required:
5772
6916
  - id
5773
6917
  - test_mode
@@ -5832,6 +6976,18 @@ components:
5832
6976
  type: array
5833
6977
  items:
5834
6978
  "$ref": "#/components/schemas/AttachmentRequestInfo"
6979
+ passcode_delivery:
6980
+ type: object
6981
+ properties:
6982
+ enabled:
6983
+ type: boolean
6984
+ methods:
6985
+ type: array
6986
+ items:
6987
+ type: string
6988
+ nullable: true
6989
+ expire_after_access:
6990
+ type: boolean
5835
6991
  required:
5836
6992
  - name
5837
6993
  copied_placeholders:
@@ -5941,6 +7097,10 @@ components:
5941
7097
  "$ref": "#/components/schemas/FieldType"
5942
7098
  validation:
5943
7099
  "$ref": "#/components/schemas/TextValidation"
7100
+ validation_regex:
7101
+ "$ref": "#/components/schemas/ValidationRegex"
7102
+ validation_regex_error_message:
7103
+ "$ref": "#/components/schemas/ValidationRegexErrorMessage"
5944
7104
  value:
5945
7105
  oneOf:
5946
7106
  - type: string
@@ -5995,11 +7155,29 @@ components:
5995
7155
  type: array
5996
7156
  items:
5997
7157
  "$ref": "#/components/schemas/CheckboxGroupInfo"
7158
+ conditional_rules:
7159
+ type: array
7160
+ items:
7161
+ "$ref": "#/components/schemas/ConditionalRuleInfo"
5998
7162
  required:
5999
7163
  - id
6000
7164
  DocumentFromTemplateResponse:
6001
7165
  type: object
6002
7166
  properties:
7167
+ cfr_part11:
7168
+ type: boolean
7169
+ description: 'Whether 21 CFR Part 11 controls apply to this document. Read-only:
7170
+ the value is taken from the workspace setting when the document is created
7171
+ and never changes afterwards.'
7172
+ cfr_part11_signing_mode:
7173
+ type: string
7174
+ enum:
7175
+ - streamlined
7176
+ - per_signature
7177
+ nullable: true
7178
+ description: 'The signing mode of a 21 CFR Part 11 document: streamlined
7179
+ (one final authentication) or per_signature (authentication at every signature
7180
+ and initials field). Null when Part 11 does not apply.'
6003
7181
  test_mode:
6004
7182
  type: boolean
6005
7183
  id:
@@ -6066,6 +7244,42 @@ components:
6066
7244
  send_email_delay:
6067
7245
  type: integer
6068
7246
  nullable: true
7247
+ delivery_method:
7248
+ type: string
7249
+ enum:
7250
+ - email
7251
+ - sms
7252
+ - email_and_sms
7253
+ description: 'How the recipient is notified: email (default), sms,
7254
+ or email_and_sms.'
7255
+ sms:
7256
+ type: object
7257
+ description: SMS delivery metadata. Only present when delivery_method
7258
+ includes SMS.
7259
+ properties:
7260
+ phone_number_masked:
7261
+ type: string
7262
+ nullable: true
7263
+ description: Masked phone number; the full number never leaves
7264
+ the API.
7265
+ send_sms:
7266
+ type: boolean
7267
+ nullable: true
7268
+ send_sms_delay:
7269
+ type: integer
7270
+ nullable: true
7271
+ delivery_status:
7272
+ type: string
7273
+ nullable: true
7274
+ message_type:
7275
+ type: string
7276
+ nullable: true
7277
+ failed:
7278
+ type: boolean
7279
+ nullable: true
7280
+ failed_details:
7281
+ type: string
7282
+ nullable: true
6069
7283
  signing_order:
6070
7284
  type: integer
6071
7285
  signing_url:
@@ -6089,6 +7303,18 @@ components:
6089
7303
  passcode:
6090
7304
  type: string
6091
7305
  nullable: true
7306
+ passcode_delivery:
7307
+ type: object
7308
+ properties:
7309
+ enabled:
7310
+ type: boolean
7311
+ methods:
7312
+ type: array
7313
+ items:
7314
+ type: string
7315
+ nullable: true
7316
+ expire_after_access:
7317
+ type: boolean
6092
7318
  status:
6093
7319
  type: string
6094
7320
  placeholder_name:
@@ -6104,6 +7330,8 @@ components:
6104
7330
  type: boolean
6105
7331
  archived:
6106
7332
  type: boolean
7333
+ embedded:
7334
+ "$ref": "#/components/schemas/EmbeddedBranding"
6107
7335
  embedded_signing:
6108
7336
  type: boolean
6109
7337
  embedded_edit_url:
@@ -6207,6 +7435,10 @@ components:
6207
7435
  "$ref": "#/components/schemas/FieldType"
6208
7436
  validation:
6209
7437
  "$ref": "#/components/schemas/TextValidation"
7438
+ validation_regex:
7439
+ "$ref": "#/components/schemas/ValidationRegex"
7440
+ validation_regex_error_message:
7441
+ "$ref": "#/components/schemas/ValidationRegexErrorMessage"
6210
7442
  value:
6211
7443
  oneOf:
6212
7444
  - type: string
@@ -6261,6 +7493,14 @@ components:
6261
7493
  type: array
6262
7494
  items:
6263
7495
  "$ref": "#/components/schemas/CheckboxGroupInfo"
7496
+ conditional_rules:
7497
+ type: array
7498
+ items:
7499
+ "$ref": "#/components/schemas/ConditionalRuleInfo"
7500
+ conditional_logic_decisions:
7501
+ type: array
7502
+ items:
7503
+ "$ref": "#/components/schemas/ConditionalLogicDecisionInfo"
6264
7504
  required:
6265
7505
  - id
6266
7506
  - test_mode
@@ -6841,5 +8081,24 @@ components:
6841
8081
  description: Rate limit error message indicating the limit and reset time
6842
8082
  required:
6843
8083
  - error
8084
+ CompletedPdfUrlResponse:
8085
+ type: object
8086
+ description: JSON response containing the URL to the completed PDF file (returned
8087
+ when url_only=true)
8088
+ properties:
8089
+ file_url:
8090
+ type: string
8091
+ format: url
8092
+ description: URL to download the completed document
8093
+ required:
8094
+ - file_url
8095
+ CompletedPdfBinaryResponse:
8096
+ type: string
8097
+ format: binary
8098
+ description: Raw PDF binary data (default response when url_only=false)
8099
+ CompletedPdfZipResponse:
8100
+ type: string
8101
+ format: binary
8102
+ description: ZIP file containing the completed PDF (returned when file_format=zip)
6844
8103
  servers:
6845
8104
  - url: https://www.signwell.com