From 93e07302101e0cd378ef3828c841dc26156bbe26 Mon Sep 17 00:00:00 2001 From: Alex Turchyn Date: Mon, 29 Jun 2026 23:48:06 +0300 Subject: [PATCH] update docs --- docs/api/csharp.md | 538 ++-- docs/api/go.md | 538 ++-- docs/api/java.md | 538 ++-- docs/api/javascript.md | 538 ++-- docs/api/nodejs.md | 538 ++-- docs/api/php.md | 538 ++-- docs/api/python.md | 538 ++-- docs/api/ruby.md | 538 ++-- docs/api/shell.md | 538 ++-- docs/api/typescript.md | 538 ++-- docs/embedding/form-builder-angular.md | 31 +- docs/embedding/form-builder-javascript.md | 31 +- docs/embedding/form-builder-react.md | 31 +- docs/embedding/form-builder-vue.md | 31 +- docs/embedding/signing-form-angular.md | 16 +- docs/embedding/signing-form-javascript.md | 14 +- docs/embedding/signing-form-react.md | 14 +- docs/embedding/signing-form-vue.md | 14 +- docs/openapi.json | 2731 +++++++++++++++++---- docs/webhooks/form-webhook.md | 43 +- docs/webhooks/submission-webhook.md | 95 +- docs/webhooks/template-webhook.md | 61 +- 22 files changed, 6422 insertions(+), 2070 deletions(-) diff --git a/docs/api/csharp.md b/docs/api/csharp.md index a5668413..cf72c0d9 100644 --- a/docs/api/csharp.md +++ b/docs/api/csharp.md @@ -53,7 +53,7 @@ var response = client.Execute(request); "schema": { "type": "string" }, - "description": "Filter submissions based on submitters name, email or phone partial match." + "description": "Filter submissions based on submitter's name, email or phone partial match." }, { "name": "slug", @@ -185,6 +185,17 @@ var response = client.Execute(request); }, "description": "The unique identifier of the submission.", "example": 1001 + }, + { + "name": "merge", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false + }, + "description": "When `true`, merges all documents into a single PDF.", + "example": false } ] } @@ -230,7 +241,9 @@ var response = client.Execute(request); "template_id": { "type": "integer", "description": "The unique identifier of the template. Document template forms can be created via the Web UI, PDF and DOCX API, or HTML API.", - "example": 1000001 + "examples": [ + 1000001 + ] }, "send_email": { "type": "boolean", @@ -266,10 +279,22 @@ var response = client.Execute(request); "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] + }, + "variables": { + "type": "object", + "description": "Dynamic content variables object. Variable values can be strings, numbers, arrays, objects, or HTML content used to generate styled text, paragraphs, and tables in dynamic template documents.", + "examples": [ + { + "variable_name": "value" + } + ] }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -286,9 +311,6 @@ var response = client.Execute(request); "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -297,18 +319,24 @@ var response = client.Execute(request); "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -325,7 +353,9 @@ var response = client.Execute(request); "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -361,6 +391,7 @@ var response = client.Execute(request); }, "message": { "type": "object", + "description": "Custom signature request email message for the submitter.", "properties": { "subject": { "type": "string", @@ -384,7 +415,9 @@ var response = client.Execute(request); "name": { "type": "string", "description": "Document template field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -415,7 +448,9 @@ var response = client.Execute(request); } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -436,11 +471,14 @@ var response = client.Execute(request); }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -476,11 +514,14 @@ var response = client.Execute(request); }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -542,12 +583,16 @@ var response = client.Execute(request); "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -644,7 +689,9 @@ var response = client.Execute(request); "name": { "type": "string", "description": "Name of the document submission.", - "example": "Test Submission Document" + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -680,7 +727,9 @@ var response = client.Execute(request); "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -692,6 +741,7 @@ var response = client.Execute(request); }, "documents": { "type": "array", + "description": "An array of PDF documents to create a submission.", "items": { "type": "object", "required": [ @@ -704,7 +754,9 @@ var response = client.Execute(request); "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF file or downloadable file URL." @@ -740,6 +792,7 @@ var response = client.Execute(request); "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -761,6 +814,7 @@ var response = client.Execute(request); }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "required": [ @@ -790,7 +844,9 @@ var response = client.Execute(request); "page": { "type": "integer", "description": "Page number of the field area. Starts from 1.", - "example": 1 + "examples": [ + 1 + ] }, "option": { "type": "string", @@ -805,9 +861,11 @@ var response = client.Execute(request); "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] } } @@ -825,9 +883,6 @@ var response = client.Execute(request); "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -836,18 +891,24 @@ var response = client.Execute(request); "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -864,7 +925,9 @@ var response = client.Execute(request); "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -914,7 +977,9 @@ var response = client.Execute(request); "name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -945,7 +1010,9 @@ var response = client.Execute(request); } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -966,11 +1033,14 @@ var response = client.Execute(request); }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -1006,11 +1076,14 @@ var response = client.Execute(request); }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -1072,12 +1145,16 @@ var response = client.Execute(request); "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -1127,6 +1204,7 @@ var response = client.Execute(request); }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -1163,7 +1241,7 @@ var response = client.Execute(request); ### Create a submission from DOCX -The API endpoint provides functionality to create a one-off submission request from a DOCX file with dynamic content variables. Use [[variable_name]] text tags to define dynamic content variables in the document. See https://www.docuseal.com/examples/demo_template.docx for the specific text variable syntax, including dynamic content tables and list. You can also use the {{signature}} field syntax to define fillable fields, as in a PDF.
Related Guides
Use dynamic content variables in DOCX to create personalized documents +The API endpoint provides functionality to create a one-off submission request from a DOCX file with dynamic content variables. Use [[variable_name]] text tags to define dynamic content variables in the document. See https://www.docuseal.com/examples/demo_template.docx for the specific text variable syntax, including dynamic content tables and lists. You can also use the {{signature}} field syntax to define fillable fields, as in a PDF.
Related Guides
Use dynamic content variables in DOCX to create personalized documents ```csharp var client = new RestClient("https://api.docuseal.com/submissions/docx"); @@ -1201,7 +1279,9 @@ var response = client.Execute(request); "name": { "type": "string", "description": "Name of the document submission.", - "example": "Test Submission Document" + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -1216,9 +1296,11 @@ var response = client.Execute(request); "variables": { "type": "object", "description": "Dynamic content variables object. Variable values can be strings, numbers, arrays, objects, or HTML content used to generate styled text, paragraphs, and tables in DOCX.", - "example": { - "variable_name": "value" - } + "examples": [ + { + "variable_name": "value" + } + ] }, "order": { "type": "string", @@ -1244,7 +1326,9 @@ var response = client.Execute(request); "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -1256,6 +1340,7 @@ var response = client.Execute(request); }, "documents": { "type": "array", + "description": "An array of DOCX documents to create a submission.", "items": { "type": "object", "required": [ @@ -1268,7 +1353,9 @@ var response = client.Execute(request); "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF or DOCX file or downloadable file URL." @@ -1285,9 +1372,6 @@ var response = client.Execute(request); "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -1296,18 +1380,24 @@ var response = client.Execute(request); "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -1324,7 +1414,9 @@ var response = client.Execute(request); "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -1374,7 +1466,9 @@ var response = client.Execute(request); "name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -1405,7 +1499,9 @@ var response = client.Execute(request); } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -1426,11 +1522,14 @@ var response = client.Execute(request); }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -1466,11 +1565,14 @@ var response = client.Execute(request); }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -1532,12 +1634,16 @@ var response = client.Execute(request); "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -1587,6 +1693,7 @@ var response = client.Execute(request); }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -1605,7 +1712,7 @@ var response = client.Execute(request); }, "remove_tags": { "type": "boolean", - "description": "Pass `false` to disable the removal of {{text}} tags from the PDF. This can be used along with transparent text tags for faster and more robust PDF processing.", + "description": "Pass `false` to disable the removal of {{text}} tags from the document. This can be used along with transparent text tags for faster and more robust document processing.", "default": true } } @@ -1655,8 +1762,10 @@ var response = client.Execute(request); "properties": { "name": { "type": "string", - "description": "Name of the document submission", - "example": "Test Submission Document" + "description": "Name of the document submission.", + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -1692,7 +1801,9 @@ var response = client.Execute(request); "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -1714,12 +1825,16 @@ var response = client.Execute(request); "name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Document" + "examples": [ + "Test Document" + ] }, "html": { "type": "string", "description": "HTML document content with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "html_header": { "type": "string", @@ -1746,7 +1861,9 @@ var response = client.Execute(request); "A5", "A6" ], - "example": "A4" + "examples": [ + "A4" + ] }, "position": { "type": "integer", @@ -1760,9 +1877,6 @@ var response = client.Execute(request); "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -1771,18 +1885,24 @@ var response = client.Execute(request); "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -1799,7 +1919,9 @@ var response = client.Execute(request); "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -1849,7 +1971,9 @@ var response = client.Execute(request); "name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -1880,7 +2004,9 @@ var response = client.Execute(request); } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -1901,11 +2027,14 @@ var response = client.Execute(request); }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -1941,11 +2070,14 @@ var response = client.Execute(request); }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -2007,12 +2139,16 @@ var response = client.Execute(request); "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -2062,6 +2198,7 @@ var response = client.Execute(request); }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -2205,7 +2342,7 @@ var response = client.Execute(request); "schema": { "type": "string" }, - "description": "The unique applications-specific identifier provided for a submitter when initializing a signature request. It allows you to receive only submitters with a specified external id." + "description": "The unique application-specific identifier provided for a submitter when initializing a signature request. It allows you to receive only submitters with a specified external ID." }, { "name": "limit", @@ -2223,7 +2360,7 @@ var response = client.Execute(request); "schema": { "type": "integer" }, - "description": "The unique identifier of the submitter to start the list from. It allows you to receive only submitters with id greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of submitters." + "description": "The unique identifier of the submitter to start the list from. It allows you to receive only submitters with an ID greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of submitters." }, { "name": "before", @@ -2232,7 +2369,7 @@ var response = client.Execute(request); "schema": { "type": "integer" }, - "description": "The unique identifier of the submitter to end the list with. It allows you to receive only submitters with id less than the specified value." + "description": "The unique identifier of the submitter to end the list with. It allows you to receive only submitters with an ID less than the specified value." } ] } @@ -2328,12 +2465,16 @@ var response = client.Execute(request); "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -2363,7 +2504,9 @@ var response = client.Execute(request); "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "completed_redirect_url": { "type": "string", @@ -2374,8 +2517,14 @@ var response = client.Execute(request); "description": "Set to `true` to require phone 2FA verification via a one-time code sent to the phone number in order to access the documents.", "default": false }, + "require_email_2fa": { + "type": "boolean", + "description": "Set to `true` to require email 2FA verification via a one-time code sent to the email address in order to access the documents.", + "default": false + }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -2399,7 +2548,9 @@ var response = client.Execute(request); "name": { "type": "string", "description": "Document template field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -2430,7 +2581,9 @@ var response = client.Execute(request); } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -2443,11 +2596,14 @@ var response = client.Execute(request); }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -2483,11 +2639,14 @@ var response = client.Execute(request); }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -2549,12 +2708,16 @@ var response = client.Execute(request); "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -2650,7 +2813,7 @@ var response = client.Execute(request); "schema": { "type": "string" }, - "description": "The unique applications-specific identifier provided for the template via API or Embedded template form builder. It allows you to receive only templates with your specified external id." + "description": "The unique application-specific identifier provided for the template via API or Embedded template form builder. It allows you to receive only templates with your specified external ID." }, { "name": "folder", @@ -2686,7 +2849,7 @@ var response = client.Execute(request); "schema": { "type": "integer" }, - "description": "The unique identifier of the template to start the list from. It allows you to receive only templates with id greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of templates." + "description": "The unique identifier of the template to start the list from. It allows you to receive only templates with an ID greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of templates." }, { "name": "before", @@ -2695,7 +2858,7 @@ var response = client.Execute(request); "schema": { "type": "integer" }, - "description": "The unique identifier of the template to end the list with. It allows you to receive only templates with id less than the specified value." + "description": "The unique identifier of the template to end the list with. It allows you to receive only templates with an ID less than the specified value." } ] } @@ -2778,25 +2941,30 @@ var response = client.Execute(request); "properties": { "name": { "type": "string", - "description": "Name of the template", - "example": "Test PDF" + "description": "Name of the template.", + "examples": [ + "Test PDF" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new PDF.", - "example": "unique-key" + "examples": [ + "unique-key" + ] }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { "type": "array", + "description": "An array of PDF documents to create a template.", "items": { "type": "object", "required": [ @@ -2809,7 +2977,9 @@ var response = client.Execute(request); "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF file or downloadable file URL." @@ -2845,6 +3015,7 @@ var response = client.Execute(request); "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -2866,6 +3037,7 @@ var response = client.Execute(request); }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "required": [ @@ -2895,7 +3067,9 @@ var response = client.Execute(request); "page": { "type": "integer", "description": "Page number of the field area. Starts from 1.", - "example": 1 + "examples": [ + 1 + ] }, "option": { "type": "string", @@ -2910,18 +3084,23 @@ var response = client.Execute(request); "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -2957,11 +3136,14 @@ var response = client.Execute(request); }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -3023,12 +3205,16 @@ var response = client.Execute(request); "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -3089,7 +3275,7 @@ var response = client.Execute(request); ### Create a template from Word DOCX -The API endpoint provides the functionality to create a fillable document template for existing Microsoft Word document. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See https://www.docuseal.com/examples/fieldtags.docx for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.
Related Guides
Use embedded text field tags to create a fillable form +The API endpoint provides the functionality to create a fillable document template for an existing Microsoft Word document. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See https://www.docuseal.com/examples/fieldtags.docx for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.
Related Guides
Use embedded text field tags to create a fillable form ```csharp @@ -3126,25 +3312,30 @@ var response = client.Execute(request); "properties": { "name": { "type": "string", - "description": "Name of the template", - "example": "Test DOCX" + "description": "Name of the template.", + "examples": [ + "Test DOCX" + ] }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new document.", - "example": "unique-key" + "examples": [ + "unique-key" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { "type": "array", + "description": "An array of DOCX documents to create a template.", "items": { "type": "object", "required": [ @@ -3158,9 +3349,16 @@ var response = client.Execute(request); }, "file": { "type": "string", - "example": "base64", + "examples": [ + "base64" + ], "format": "base64", - "description": "Base64-encoded content of the DOCX file or downloadable file URL" + "description": "Base64-encoded content of the DOCX file or downloadable file URL." + }, + "dynamic": { + "type": "boolean", + "description": "Set to `true` to make the document dynamic. When enabled, the DOCX document content can be edited or use [[variables]] in the template editor.", + "default": false }, "fields": { "description": "Fields are optional if you use {{...}} text tags to define fields in the document.", @@ -3193,6 +3391,7 @@ var response = client.Execute(request); "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -3214,6 +3413,7 @@ var response = client.Execute(request); }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "properties": { @@ -3250,18 +3450,23 @@ var response = client.Execute(request); "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -3297,11 +3502,14 @@ var response = client.Execute(request); }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -3363,12 +3571,16 @@ var response = client.Execute(request); "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -3456,7 +3668,9 @@ var response = client.Execute(request); "html": { "type": "string", "description": "HTML template with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "html_header": { "type": "string", @@ -3469,7 +3683,9 @@ var response = client.Execute(request); "name": { "type": "string", "description": "Template name. Random uuid will be assigned when not specified.", - "example": "Test Template" + "examples": [ + "Test Template" + ] }, "size": { "type": "string", @@ -3488,20 +3704,24 @@ var response = client.Execute(request); "A5", "A6" ], - "example": "A4" + "examples": [ + "A4" + ] }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new HTML.", - "example": "714d974e-83d8-11ee-b962-0242ac120002" + "examples": [ + "714d974e-83d8-11ee-b962-0242ac120002" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { @@ -3516,12 +3736,16 @@ var response = client.Execute(request); "html": { "type": "string", "description": "HTML template with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Document" + "examples": [ + "Test Document" + ] } } } @@ -3536,7 +3760,7 @@ var response = client.Execute(request); ### Clone a template -The API endpoint allows you to clone existing template into a new template. +The API endpoint allows you to clone an existing template into a new template. ```csharp var client = new RestClient("https://api.docuseal.com/templates/1000001/clone"); @@ -3567,7 +3791,7 @@ var response = client.Execute(request); "schema": { "type": "integer" }, - "description": "The unique identifier of the documents template.", + "description": "The unique identifier of the document template.", "example": 1000001 } ], @@ -3581,7 +3805,9 @@ var response = client.Execute(request); "name": { "type": "string", "description": "Template name. Existing name with (Clone) suffix will be used if not specified.", - "example": "Cloned Template" + "examples": [ + "Cloned Template" + ] }, "folder_name": { "type": "string", @@ -3641,15 +3867,19 @@ var response = client.Execute(request); "items": { "type": "integer" }, - "example": [ - 321, - 432 + "examples": [ + [ + 321, + 432 + ] ] }, "name": { "type": "string", "description": "Template name. Existing name with (Merged) suffix will be used if not specified.", - "example": "Merged Template" + "examples": [ + "Merged Template" + ] }, "folder_name": { "type": "string", @@ -3661,7 +3891,7 @@ var response = client.Execute(request); }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "roles": { @@ -3670,9 +3900,11 @@ var response = client.Execute(request); "items": { "type": "string" }, - "example": [ - "Agent", - "Customer" + "examples": [ + [ + "Agent", + "Customer" + ] ] } } @@ -3729,13 +3961,17 @@ var response = client.Execute(request); "properties": { "name": { "type": "string", - "description": "The name of the template", - "example": "New Document Name" + "description": "The name of the template.", + "examples": [ + "New Document Name" + ] }, "folder_name": { "type": "string", "description": "The folder's name to which the template should be moved.", - "example": "New Folder" + "examples": [ + "New Folder" + ] }, "roles": { "type": "array", @@ -3743,9 +3979,11 @@ var response = client.Execute(request); "items": { "type": "string" }, - "example": [ - "Agent", - "Customer" + "examples": [ + [ + "Agent", + "Customer" + ] ] }, "archived": { @@ -3793,7 +4031,7 @@ var response = client.Execute(request); "schema": { "type": "integer" }, - "description": "The unique identifier of the documents template.", + "description": "The unique identifier of the document template.", "example": 1000001 } ], @@ -3813,7 +4051,9 @@ var response = client.Execute(request); "name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Template" + "examples": [ + "Test Template" + ] }, "file": { "type": "string", @@ -3827,7 +4067,9 @@ var response = client.Execute(request); "position": { "type": "integer", "description": "Position of the document. By default will be added as the last document in the template.", - "example": 0 + "examples": [ + 0 + ] }, "replace": { "type": "boolean", diff --git a/docs/api/go.md b/docs/api/go.md index a141ac3a..ed373e64 100644 --- a/docs/api/go.md +++ b/docs/api/go.md @@ -74,7 +74,7 @@ func main() { "schema": { "type": "string" }, - "description": "Filter submissions based on submitters name, email or phone partial match." + "description": "Filter submissions based on submitter's name, email or phone partial match." }, { "name": "slug", @@ -248,6 +248,17 @@ func main() { }, "description": "The unique identifier of the submission.", "example": 1001 + }, + { + "name": "merge", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false + }, + "description": "When `true`, merges all documents into a single PDF.", + "example": false } ] } @@ -316,7 +327,9 @@ func main() { "template_id": { "type": "integer", "description": "The unique identifier of the template. Document template forms can be created via the Web UI, PDF and DOCX API, or HTML API.", - "example": 1000001 + "examples": [ + 1000001 + ] }, "send_email": { "type": "boolean", @@ -352,10 +365,22 @@ func main() { "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] + }, + "variables": { + "type": "object", + "description": "Dynamic content variables object. Variable values can be strings, numbers, arrays, objects, or HTML content used to generate styled text, paragraphs, and tables in dynamic template documents.", + "examples": [ + { + "variable_name": "value" + } + ] }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -372,9 +397,6 @@ func main() { "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -383,18 +405,24 @@ func main() { "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -411,7 +439,9 @@ func main() { "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -447,6 +477,7 @@ func main() { }, "message": { "type": "object", + "description": "Custom signature request email message for the submitter.", "properties": { "subject": { "type": "string", @@ -470,7 +501,9 @@ func main() { "name": { "type": "string", "description": "Document template field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -501,7 +534,9 @@ func main() { } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -522,11 +557,14 @@ func main() { }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -562,11 +600,14 @@ func main() { }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -628,12 +669,16 @@ func main() { "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -753,7 +798,9 @@ func main() { "name": { "type": "string", "description": "Name of the document submission.", - "example": "Test Submission Document" + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -789,7 +836,9 @@ func main() { "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -801,6 +850,7 @@ func main() { }, "documents": { "type": "array", + "description": "An array of PDF documents to create a submission.", "items": { "type": "object", "required": [ @@ -813,7 +863,9 @@ func main() { "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF file or downloadable file URL." @@ -849,6 +901,7 @@ func main() { "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -870,6 +923,7 @@ func main() { }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "required": [ @@ -899,7 +953,9 @@ func main() { "page": { "type": "integer", "description": "Page number of the field area. Starts from 1.", - "example": 1 + "examples": [ + 1 + ] }, "option": { "type": "string", @@ -914,9 +970,11 @@ func main() { "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] } } @@ -934,9 +992,6 @@ func main() { "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -945,18 +1000,24 @@ func main() { "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -973,7 +1034,9 @@ func main() { "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -1023,7 +1086,9 @@ func main() { "name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -1054,7 +1119,9 @@ func main() { } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -1075,11 +1142,14 @@ func main() { }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -1115,11 +1185,14 @@ func main() { }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -1181,12 +1254,16 @@ func main() { "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -1236,6 +1313,7 @@ func main() { }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -1272,7 +1350,7 @@ func main() { ### Create a submission from DOCX -The API endpoint provides functionality to create a one-off submission request from a DOCX file with dynamic content variables. Use [[variable_name]] text tags to define dynamic content variables in the document. See https://www.docuseal.com/examples/demo_template.docx for the specific text variable syntax, including dynamic content tables and list. You can also use the {{signature}} field syntax to define fillable fields, as in a PDF.
Related Guides
Use dynamic content variables in DOCX to create personalized documents +The API endpoint provides functionality to create a one-off submission request from a DOCX file with dynamic content variables. Use [[variable_name]] text tags to define dynamic content variables in the document. See https://www.docuseal.com/examples/demo_template.docx for the specific text variable syntax, including dynamic content tables and lists. You can also use the {{signature}} field syntax to define fillable fields, as in a PDF.
Related Guides
Use dynamic content variables in DOCX to create personalized documents ```go package main @@ -1333,7 +1411,9 @@ func main() { "name": { "type": "string", "description": "Name of the document submission.", - "example": "Test Submission Document" + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -1348,9 +1428,11 @@ func main() { "variables": { "type": "object", "description": "Dynamic content variables object. Variable values can be strings, numbers, arrays, objects, or HTML content used to generate styled text, paragraphs, and tables in DOCX.", - "example": { - "variable_name": "value" - } + "examples": [ + { + "variable_name": "value" + } + ] }, "order": { "type": "string", @@ -1376,7 +1458,9 @@ func main() { "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -1388,6 +1472,7 @@ func main() { }, "documents": { "type": "array", + "description": "An array of DOCX documents to create a submission.", "items": { "type": "object", "required": [ @@ -1400,7 +1485,9 @@ func main() { "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF or DOCX file or downloadable file URL." @@ -1417,9 +1504,6 @@ func main() { "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -1428,18 +1512,24 @@ func main() { "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -1456,7 +1546,9 @@ func main() { "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -1506,7 +1598,9 @@ func main() { "name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -1537,7 +1631,9 @@ func main() { } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -1558,11 +1654,14 @@ func main() { }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -1598,11 +1697,14 @@ func main() { }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -1664,12 +1766,16 @@ func main() { "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -1719,6 +1825,7 @@ func main() { }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -1737,7 +1844,7 @@ func main() { }, "remove_tags": { "type": "boolean", - "description": "Pass `false` to disable the removal of {{text}} tags from the PDF. This can be used along with transparent text tags for faster and more robust PDF processing.", + "description": "Pass `false` to disable the removal of {{text}} tags from the document. This can be used along with transparent text tags for faster and more robust document processing.", "default": true } } @@ -1810,8 +1917,10 @@ func main() { "properties": { "name": { "type": "string", - "description": "Name of the document submission", - "example": "Test Submission Document" + "description": "Name of the document submission.", + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -1847,7 +1956,9 @@ func main() { "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -1869,12 +1980,16 @@ func main() { "name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Document" + "examples": [ + "Test Document" + ] }, "html": { "type": "string", "description": "HTML document content with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "html_header": { "type": "string", @@ -1901,7 +2016,9 @@ func main() { "A5", "A6" ], - "example": "A4" + "examples": [ + "A4" + ] }, "position": { "type": "integer", @@ -1915,9 +2032,6 @@ func main() { "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -1926,18 +2040,24 @@ func main() { "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -1954,7 +2074,9 @@ func main() { "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -2004,7 +2126,9 @@ func main() { "name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -2035,7 +2159,9 @@ func main() { } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -2056,11 +2182,14 @@ func main() { }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -2096,11 +2225,14 @@ func main() { }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -2162,12 +2294,16 @@ func main() { "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -2217,6 +2353,7 @@ func main() { }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -2402,7 +2539,7 @@ func main() { "schema": { "type": "string" }, - "description": "The unique applications-specific identifier provided for a submitter when initializing a signature request. It allows you to receive only submitters with a specified external id." + "description": "The unique application-specific identifier provided for a submitter when initializing a signature request. It allows you to receive only submitters with a specified external ID." }, { "name": "limit", @@ -2420,7 +2557,7 @@ func main() { "schema": { "type": "integer" }, - "description": "The unique identifier of the submitter to start the list from. It allows you to receive only submitters with id greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of submitters." + "description": "The unique identifier of the submitter to start the list from. It allows you to receive only submitters with an ID greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of submitters." }, { "name": "before", @@ -2429,7 +2566,7 @@ func main() { "schema": { "type": "integer" }, - "description": "The unique identifier of the submitter to end the list with. It allows you to receive only submitters with id less than the specified value." + "description": "The unique identifier of the submitter to end the list with. It allows you to receive only submitters with an ID less than the specified value." } ] } @@ -2569,12 +2706,16 @@ func main() { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -2604,7 +2745,9 @@ func main() { "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "completed_redirect_url": { "type": "string", @@ -2615,8 +2758,14 @@ func main() { "description": "Set to `true` to require phone 2FA verification via a one-time code sent to the phone number in order to access the documents.", "default": false }, + "require_email_2fa": { + "type": "boolean", + "description": "Set to `true` to require email 2FA verification via a one-time code sent to the email address in order to access the documents.", + "default": false + }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -2640,7 +2789,9 @@ func main() { "name": { "type": "string", "description": "Document template field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -2671,7 +2822,9 @@ func main() { } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -2684,11 +2837,14 @@ func main() { }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -2724,11 +2880,14 @@ func main() { }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -2790,12 +2949,16 @@ func main() { "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -2912,7 +3075,7 @@ func main() { "schema": { "type": "string" }, - "description": "The unique applications-specific identifier provided for the template via API or Embedded template form builder. It allows you to receive only templates with your specified external id." + "description": "The unique application-specific identifier provided for the template via API or Embedded template form builder. It allows you to receive only templates with your specified external ID." }, { "name": "folder", @@ -2948,7 +3111,7 @@ func main() { "schema": { "type": "integer" }, - "description": "The unique identifier of the template to start the list from. It allows you to receive only templates with id greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of templates." + "description": "The unique identifier of the template to start the list from. It allows you to receive only templates with an ID greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of templates." }, { "name": "before", @@ -2957,7 +3120,7 @@ func main() { "schema": { "type": "integer" }, - "description": "The unique identifier of the template to end the list with. It allows you to receive only templates with id less than the specified value." + "description": "The unique identifier of the template to end the list with. It allows you to receive only templates with an ID less than the specified value." } ] } @@ -3084,25 +3247,30 @@ func main() { "properties": { "name": { "type": "string", - "description": "Name of the template", - "example": "Test PDF" + "description": "Name of the template.", + "examples": [ + "Test PDF" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new PDF.", - "example": "unique-key" + "examples": [ + "unique-key" + ] }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { "type": "array", + "description": "An array of PDF documents to create a template.", "items": { "type": "object", "required": [ @@ -3115,7 +3283,9 @@ func main() { "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF file or downloadable file URL." @@ -3151,6 +3321,7 @@ func main() { "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -3172,6 +3343,7 @@ func main() { }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "required": [ @@ -3201,7 +3373,9 @@ func main() { "page": { "type": "integer", "description": "Page number of the field area. Starts from 1.", - "example": 1 + "examples": [ + 1 + ] }, "option": { "type": "string", @@ -3216,18 +3390,23 @@ func main() { "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -3263,11 +3442,14 @@ func main() { }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -3329,12 +3511,16 @@ func main() { "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -3395,7 +3581,7 @@ func main() { ### Create a template from Word DOCX -The API endpoint provides the functionality to create a fillable document template for existing Microsoft Word document. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See https://www.docuseal.com/examples/fieldtags.docx for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.
Related Guides
Use embedded text field tags to create a fillable form +The API endpoint provides the functionality to create a fillable document template for an existing Microsoft Word document. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See https://www.docuseal.com/examples/fieldtags.docx for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.
Related Guides
Use embedded text field tags to create a fillable form ```go @@ -3455,25 +3641,30 @@ func main() { "properties": { "name": { "type": "string", - "description": "Name of the template", - "example": "Test DOCX" + "description": "Name of the template.", + "examples": [ + "Test DOCX" + ] }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new document.", - "example": "unique-key" + "examples": [ + "unique-key" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { "type": "array", + "description": "An array of DOCX documents to create a template.", "items": { "type": "object", "required": [ @@ -3487,9 +3678,16 @@ func main() { }, "file": { "type": "string", - "example": "base64", + "examples": [ + "base64" + ], "format": "base64", - "description": "Base64-encoded content of the DOCX file or downloadable file URL" + "description": "Base64-encoded content of the DOCX file or downloadable file URL." + }, + "dynamic": { + "type": "boolean", + "description": "Set to `true` to make the document dynamic. When enabled, the DOCX document content can be edited or use [[variables]] in the template editor.", + "default": false }, "fields": { "description": "Fields are optional if you use {{...}} text tags to define fields in the document.", @@ -3522,6 +3720,7 @@ func main() { "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -3543,6 +3742,7 @@ func main() { }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "properties": { @@ -3579,18 +3779,23 @@ func main() { "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -3626,11 +3831,14 @@ func main() { }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -3692,12 +3900,16 @@ func main() { "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -3808,7 +4020,9 @@ func main() { "html": { "type": "string", "description": "HTML template with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "html_header": { "type": "string", @@ -3821,7 +4035,9 @@ func main() { "name": { "type": "string", "description": "Template name. Random uuid will be assigned when not specified.", - "example": "Test Template" + "examples": [ + "Test Template" + ] }, "size": { "type": "string", @@ -3840,20 +4056,24 @@ func main() { "A5", "A6" ], - "example": "A4" + "examples": [ + "A4" + ] }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new HTML.", - "example": "714d974e-83d8-11ee-b962-0242ac120002" + "examples": [ + "714d974e-83d8-11ee-b962-0242ac120002" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { @@ -3868,12 +4088,16 @@ func main() { "html": { "type": "string", "description": "HTML template with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Document" + "examples": [ + "Test Document" + ] } } } @@ -3888,7 +4112,7 @@ func main() { ### Clone a template -The API endpoint allows you to clone existing template into a new template. +The API endpoint allows you to clone an existing template into a new template. ```go package main @@ -3942,7 +4166,7 @@ func main() { "schema": { "type": "integer" }, - "description": "The unique identifier of the documents template.", + "description": "The unique identifier of the document template.", "example": 1000001 } ], @@ -3956,7 +4180,9 @@ func main() { "name": { "type": "string", "description": "Template name. Existing name with (Clone) suffix will be used if not specified.", - "example": "Cloned Template" + "examples": [ + "Cloned Template" + ] }, "folder_name": { "type": "string", @@ -4039,15 +4265,19 @@ func main() { "items": { "type": "integer" }, - "example": [ - 321, - 432 + "examples": [ + [ + 321, + 432 + ] ] }, "name": { "type": "string", "description": "Template name. Existing name with (Merged) suffix will be used if not specified.", - "example": "Merged Template" + "examples": [ + "Merged Template" + ] }, "folder_name": { "type": "string", @@ -4059,7 +4289,7 @@ func main() { }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "roles": { @@ -4068,9 +4298,11 @@ func main() { "items": { "type": "string" }, - "example": [ - "Agent", - "Customer" + "examples": [ + [ + "Agent", + "Customer" + ] ] } } @@ -4150,13 +4382,17 @@ func main() { "properties": { "name": { "type": "string", - "description": "The name of the template", - "example": "New Document Name" + "description": "The name of the template.", + "examples": [ + "New Document Name" + ] }, "folder_name": { "type": "string", "description": "The folder's name to which the template should be moved.", - "example": "New Folder" + "examples": [ + "New Folder" + ] }, "roles": { "type": "array", @@ -4164,9 +4400,11 @@ func main() { "items": { "type": "string" }, - "example": [ - "Agent", - "Customer" + "examples": [ + [ + "Agent", + "Customer" + ] ] }, "archived": { @@ -4237,7 +4475,7 @@ func main() { "schema": { "type": "integer" }, - "description": "The unique identifier of the documents template.", + "description": "The unique identifier of the document template.", "example": 1000001 } ], @@ -4257,7 +4495,9 @@ func main() { "name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Template" + "examples": [ + "Test Template" + ] }, "file": { "type": "string", @@ -4271,7 +4511,9 @@ func main() { "position": { "type": "integer", "description": "Position of the document. By default will be added as the last document in the template.", - "example": 0 + "examples": [ + 0 + ] }, "replace": { "type": "boolean", diff --git a/docs/api/java.md b/docs/api/java.md index 59b55aad..78ef67b9 100644 --- a/docs/api/java.md +++ b/docs/api/java.md @@ -52,7 +52,7 @@ HttpResponse response = Unirest.get("https://api.docuseal.com/submission "schema": { "type": "string" }, - "description": "Filter submissions based on submitters name, email or phone partial match." + "description": "Filter submissions based on submitter's name, email or phone partial match." }, { "name": "slug", @@ -182,6 +182,17 @@ HttpResponse response = Unirest.get("https://api.docuseal.com/submission }, "description": "The unique identifier of the submission.", "example": 1001 + }, + { + "name": "merge", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false + }, + "description": "When `true`, merges all documents into a single PDF.", + "example": false } ] } @@ -226,7 +237,9 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "template_id": { "type": "integer", "description": "The unique identifier of the template. Document template forms can be created via the Web UI, PDF and DOCX API, or HTML API.", - "example": 1000001 + "examples": [ + 1000001 + ] }, "send_email": { "type": "boolean", @@ -262,10 +275,22 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] + }, + "variables": { + "type": "object", + "description": "Dynamic content variables object. Variable values can be strings, numbers, arrays, objects, or HTML content used to generate styled text, paragraphs, and tables in dynamic template documents.", + "examples": [ + { + "variable_name": "value" + } + ] }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -282,9 +307,6 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -293,18 +315,24 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -321,7 +349,9 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -357,6 +387,7 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio }, "message": { "type": "object", + "description": "Custom signature request email message for the submitter.", "properties": { "subject": { "type": "string", @@ -380,7 +411,9 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "name": { "type": "string", "description": "Document template field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -411,7 +444,9 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -432,11 +467,14 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -472,11 +510,14 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -538,12 +579,16 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -639,7 +684,9 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "name": { "type": "string", "description": "Name of the document submission.", - "example": "Test Submission Document" + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -675,7 +722,9 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -687,6 +736,7 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio }, "documents": { "type": "array", + "description": "An array of PDF documents to create a submission.", "items": { "type": "object", "required": [ @@ -699,7 +749,9 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF file or downloadable file URL." @@ -735,6 +787,7 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -756,6 +809,7 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "required": [ @@ -785,7 +839,9 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "page": { "type": "integer", "description": "Page number of the field area. Starts from 1.", - "example": 1 + "examples": [ + 1 + ] }, "option": { "type": "string", @@ -800,9 +856,11 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] } } @@ -820,9 +878,6 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -831,18 +886,24 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -859,7 +920,9 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -909,7 +972,9 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -940,7 +1005,9 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -961,11 +1028,14 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -1001,11 +1071,14 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -1067,12 +1140,16 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -1122,6 +1199,7 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -1158,7 +1236,7 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio ### Create a submission from DOCX -The API endpoint provides functionality to create a one-off submission request from a DOCX file with dynamic content variables. Use [[variable_name]] text tags to define dynamic content variables in the document. See https://www.docuseal.com/examples/demo_template.docx for the specific text variable syntax, including dynamic content tables and list. You can also use the {{signature}} field syntax to define fillable fields, as in a PDF.
Related Guides
Use dynamic content variables in DOCX to create personalized documents +The API endpoint provides functionality to create a one-off submission request from a DOCX file with dynamic content variables. Use [[variable_name]] text tags to define dynamic content variables in the document. See https://www.docuseal.com/examples/demo_template.docx for the specific text variable syntax, including dynamic content tables and lists. You can also use the {{signature}} field syntax to define fillable fields, as in a PDF.
Related Guides
Use dynamic content variables in DOCX to create personalized documents ```java HttpResponse response = Unirest.post("https://api.docuseal.com/submissions/docx") @@ -1195,7 +1273,9 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "name": { "type": "string", "description": "Name of the document submission.", - "example": "Test Submission Document" + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -1210,9 +1290,11 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "variables": { "type": "object", "description": "Dynamic content variables object. Variable values can be strings, numbers, arrays, objects, or HTML content used to generate styled text, paragraphs, and tables in DOCX.", - "example": { - "variable_name": "value" - } + "examples": [ + { + "variable_name": "value" + } + ] }, "order": { "type": "string", @@ -1238,7 +1320,9 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -1250,6 +1334,7 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio }, "documents": { "type": "array", + "description": "An array of DOCX documents to create a submission.", "items": { "type": "object", "required": [ @@ -1262,7 +1347,9 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF or DOCX file or downloadable file URL." @@ -1279,9 +1366,6 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -1290,18 +1374,24 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -1318,7 +1408,9 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -1368,7 +1460,9 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -1399,7 +1493,9 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -1420,11 +1516,14 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -1460,11 +1559,14 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -1526,12 +1628,16 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -1581,6 +1687,7 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -1599,7 +1706,7 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio }, "remove_tags": { "type": "boolean", - "description": "Pass `false` to disable the removal of {{text}} tags from the PDF. This can be used along with transparent text tags for faster and more robust PDF processing.", + "description": "Pass `false` to disable the removal of {{text}} tags from the document. This can be used along with transparent text tags for faster and more robust document processing.", "default": true } } @@ -1648,8 +1755,10 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "properties": { "name": { "type": "string", - "description": "Name of the document submission", - "example": "Test Submission Document" + "description": "Name of the document submission.", + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -1685,7 +1794,9 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -1707,12 +1818,16 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Document" + "examples": [ + "Test Document" + ] }, "html": { "type": "string", "description": "HTML document content with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "html_header": { "type": "string", @@ -1739,7 +1854,9 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "A5", "A6" ], - "example": "A4" + "examples": [ + "A4" + ] }, "position": { "type": "integer", @@ -1753,9 +1870,6 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -1764,18 +1878,24 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -1792,7 +1912,9 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -1842,7 +1964,9 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -1873,7 +1997,9 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -1894,11 +2020,14 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -1934,11 +2063,14 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -2000,12 +2132,16 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -2055,6 +2191,7 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/submissio }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -2196,7 +2333,7 @@ HttpResponse response = Unirest.get("https://api.docuseal.com/submitters "schema": { "type": "string" }, - "description": "The unique applications-specific identifier provided for a submitter when initializing a signature request. It allows you to receive only submitters with a specified external id." + "description": "The unique application-specific identifier provided for a submitter when initializing a signature request. It allows you to receive only submitters with a specified external ID." }, { "name": "limit", @@ -2214,7 +2351,7 @@ HttpResponse response = Unirest.get("https://api.docuseal.com/submitters "schema": { "type": "integer" }, - "description": "The unique identifier of the submitter to start the list from. It allows you to receive only submitters with id greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of submitters." + "description": "The unique identifier of the submitter to start the list from. It allows you to receive only submitters with an ID greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of submitters." }, { "name": "before", @@ -2223,7 +2360,7 @@ HttpResponse response = Unirest.get("https://api.docuseal.com/submitters "schema": { "type": "integer" }, - "description": "The unique identifier of the submitter to end the list with. It allows you to receive only submitters with id less than the specified value." + "description": "The unique identifier of the submitter to end the list with. It allows you to receive only submitters with an ID less than the specified value." } ] } @@ -2317,12 +2454,16 @@ HttpResponse response = Unirest.put("https://api.docuseal.com/submitters "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -2352,7 +2493,9 @@ HttpResponse response = Unirest.put("https://api.docuseal.com/submitters "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "completed_redirect_url": { "type": "string", @@ -2363,8 +2506,14 @@ HttpResponse response = Unirest.put("https://api.docuseal.com/submitters "description": "Set to `true` to require phone 2FA verification via a one-time code sent to the phone number in order to access the documents.", "default": false }, + "require_email_2fa": { + "type": "boolean", + "description": "Set to `true` to require email 2FA verification via a one-time code sent to the email address in order to access the documents.", + "default": false + }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -2388,7 +2537,9 @@ HttpResponse response = Unirest.put("https://api.docuseal.com/submitters "name": { "type": "string", "description": "Document template field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -2419,7 +2570,9 @@ HttpResponse response = Unirest.put("https://api.docuseal.com/submitters } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -2432,11 +2585,14 @@ HttpResponse response = Unirest.put("https://api.docuseal.com/submitters }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -2472,11 +2628,14 @@ HttpResponse response = Unirest.put("https://api.docuseal.com/submitters }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -2538,12 +2697,16 @@ HttpResponse response = Unirest.put("https://api.docuseal.com/submitters "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -2638,7 +2801,7 @@ HttpResponse response = Unirest.get("https://api.docuseal.com/templates" "schema": { "type": "string" }, - "description": "The unique applications-specific identifier provided for the template via API or Embedded template form builder. It allows you to receive only templates with your specified external id." + "description": "The unique application-specific identifier provided for the template via API or Embedded template form builder. It allows you to receive only templates with your specified external ID." }, { "name": "folder", @@ -2674,7 +2837,7 @@ HttpResponse response = Unirest.get("https://api.docuseal.com/templates" "schema": { "type": "integer" }, - "description": "The unique identifier of the template to start the list from. It allows you to receive only templates with id greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of templates." + "description": "The unique identifier of the template to start the list from. It allows you to receive only templates with an ID greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of templates." }, { "name": "before", @@ -2683,7 +2846,7 @@ HttpResponse response = Unirest.get("https://api.docuseal.com/templates" "schema": { "type": "integer" }, - "description": "The unique identifier of the template to end the list with. It allows you to receive only templates with id less than the specified value." + "description": "The unique identifier of the template to end the list with. It allows you to receive only templates with an ID less than the specified value." } ] } @@ -2764,25 +2927,30 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/templates "properties": { "name": { "type": "string", - "description": "Name of the template", - "example": "Test PDF" + "description": "Name of the template.", + "examples": [ + "Test PDF" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new PDF.", - "example": "unique-key" + "examples": [ + "unique-key" + ] }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { "type": "array", + "description": "An array of PDF documents to create a template.", "items": { "type": "object", "required": [ @@ -2795,7 +2963,9 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/templates "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF file or downloadable file URL." @@ -2831,6 +3001,7 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/templates "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -2852,6 +3023,7 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/templates }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "required": [ @@ -2881,7 +3053,9 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/templates "page": { "type": "integer", "description": "Page number of the field area. Starts from 1.", - "example": 1 + "examples": [ + 1 + ] }, "option": { "type": "string", @@ -2896,18 +3070,23 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/templates "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -2943,11 +3122,14 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/templates }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -3009,12 +3191,16 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/templates "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -3075,7 +3261,7 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/templates ### Create a template from Word DOCX -The API endpoint provides the functionality to create a fillable document template for existing Microsoft Word document. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See https://www.docuseal.com/examples/fieldtags.docx for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.
Related Guides
Use embedded text field tags to create a fillable form +The API endpoint provides the functionality to create a fillable document template for an existing Microsoft Word document. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See https://www.docuseal.com/examples/fieldtags.docx for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.
Related Guides
Use embedded text field tags to create a fillable form ```java @@ -3111,25 +3297,30 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/templates "properties": { "name": { "type": "string", - "description": "Name of the template", - "example": "Test DOCX" + "description": "Name of the template.", + "examples": [ + "Test DOCX" + ] }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new document.", - "example": "unique-key" + "examples": [ + "unique-key" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { "type": "array", + "description": "An array of DOCX documents to create a template.", "items": { "type": "object", "required": [ @@ -3143,9 +3334,16 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/templates }, "file": { "type": "string", - "example": "base64", + "examples": [ + "base64" + ], "format": "base64", - "description": "Base64-encoded content of the DOCX file or downloadable file URL" + "description": "Base64-encoded content of the DOCX file or downloadable file URL." + }, + "dynamic": { + "type": "boolean", + "description": "Set to `true` to make the document dynamic. When enabled, the DOCX document content can be edited or use [[variables]] in the template editor.", + "default": false }, "fields": { "description": "Fields are optional if you use {{...}} text tags to define fields in the document.", @@ -3178,6 +3376,7 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/templates "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -3199,6 +3398,7 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/templates }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "properties": { @@ -3235,18 +3435,23 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/templates "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -3282,11 +3487,14 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/templates }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -3348,12 +3556,16 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/templates "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -3440,7 +3652,9 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/templates "html": { "type": "string", "description": "HTML template with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "html_header": { "type": "string", @@ -3453,7 +3667,9 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/templates "name": { "type": "string", "description": "Template name. Random uuid will be assigned when not specified.", - "example": "Test Template" + "examples": [ + "Test Template" + ] }, "size": { "type": "string", @@ -3472,20 +3688,24 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/templates "A5", "A6" ], - "example": "A4" + "examples": [ + "A4" + ] }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new HTML.", - "example": "714d974e-83d8-11ee-b962-0242ac120002" + "examples": [ + "714d974e-83d8-11ee-b962-0242ac120002" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { @@ -3500,12 +3720,16 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/templates "html": { "type": "string", "description": "HTML template with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Document" + "examples": [ + "Test Document" + ] } } } @@ -3520,7 +3744,7 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/templates ### Clone a template -The API endpoint allows you to clone existing template into a new template. +The API endpoint allows you to clone an existing template into a new template. ```java HttpResponse response = Unirest.post("https://api.docuseal.com/templates/1000001/clone") @@ -3550,7 +3774,7 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/templates "schema": { "type": "integer" }, - "description": "The unique identifier of the documents template.", + "description": "The unique identifier of the document template.", "example": 1000001 } ], @@ -3564,7 +3788,9 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/templates "name": { "type": "string", "description": "Template name. Existing name with (Clone) suffix will be used if not specified.", - "example": "Cloned Template" + "examples": [ + "Cloned Template" + ] }, "folder_name": { "type": "string", @@ -3623,15 +3849,19 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/templates "items": { "type": "integer" }, - "example": [ - 321, - 432 + "examples": [ + [ + 321, + 432 + ] ] }, "name": { "type": "string", "description": "Template name. Existing name with (Merged) suffix will be used if not specified.", - "example": "Merged Template" + "examples": [ + "Merged Template" + ] }, "folder_name": { "type": "string", @@ -3643,7 +3873,7 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/templates }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "roles": { @@ -3652,9 +3882,11 @@ HttpResponse response = Unirest.post("https://api.docuseal.com/templates "items": { "type": "string" }, - "example": [ - "Agent", - "Customer" + "examples": [ + [ + "Agent", + "Customer" + ] ] } } @@ -3710,13 +3942,17 @@ HttpResponse response = Unirest.put("https://api.docuseal.com/templates/ "properties": { "name": { "type": "string", - "description": "The name of the template", - "example": "New Document Name" + "description": "The name of the template.", + "examples": [ + "New Document Name" + ] }, "folder_name": { "type": "string", "description": "The folder's name to which the template should be moved.", - "example": "New Folder" + "examples": [ + "New Folder" + ] }, "roles": { "type": "array", @@ -3724,9 +3960,11 @@ HttpResponse response = Unirest.put("https://api.docuseal.com/templates/ "items": { "type": "string" }, - "example": [ - "Agent", - "Customer" + "examples": [ + [ + "Agent", + "Customer" + ] ] }, "archived": { @@ -3773,7 +4011,7 @@ HttpResponse response = Unirest.put("https://api.docuseal.com/templates/ "schema": { "type": "integer" }, - "description": "The unique identifier of the documents template.", + "description": "The unique identifier of the document template.", "example": 1000001 } ], @@ -3793,7 +4031,9 @@ HttpResponse response = Unirest.put("https://api.docuseal.com/templates/ "name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Template" + "examples": [ + "Test Template" + ] }, "file": { "type": "string", @@ -3807,7 +4047,9 @@ HttpResponse response = Unirest.put("https://api.docuseal.com/templates/ "position": { "type": "integer", "description": "Position of the document. By default will be added as the last document in the template.", - "example": 0 + "examples": [ + 0 + ] }, "replace": { "type": "boolean", diff --git a/docs/api/javascript.md b/docs/api/javascript.md index 297f4c4c..78a2a6df 100644 --- a/docs/api/javascript.md +++ b/docs/api/javascript.md @@ -54,7 +54,7 @@ const { data, pagination } = await docuseal.listSubmissions({ limit: 10 }); "schema": { "type": "string" }, - "description": "Filter submissions based on submitters name, email or phone partial match." + "description": "Filter submissions based on submitter's name, email or phone partial match." }, { "name": "slug", @@ -188,6 +188,17 @@ const submission = await docuseal.getSubmissionDocuments(1001); }, "description": "The unique identifier of the submission.", "example": 1001 + }, + { + "name": "merge", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false + }, + "description": "When `true`, merges all documents into a single PDF.", + "example": false } ] } @@ -241,7 +252,9 @@ const submission = await docuseal.createSubmission({ "template_id": { "type": "integer", "description": "The unique identifier of the template. Document template forms can be created via the Web UI, PDF and DOCX API, or HTML API.", - "example": 1000001 + "examples": [ + 1000001 + ] }, "send_email": { "type": "boolean", @@ -277,10 +290,22 @@ const submission = await docuseal.createSubmission({ "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] + }, + "variables": { + "type": "object", + "description": "Dynamic content variables object. Variable values can be strings, numbers, arrays, objects, or HTML content used to generate styled text, paragraphs, and tables in dynamic template documents.", + "examples": [ + { + "variable_name": "value" + } + ] }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -297,9 +322,6 @@ const submission = await docuseal.createSubmission({ "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -308,18 +330,24 @@ const submission = await docuseal.createSubmission({ "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -336,7 +364,9 @@ const submission = await docuseal.createSubmission({ "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -372,6 +402,7 @@ const submission = await docuseal.createSubmission({ }, "message": { "type": "object", + "description": "Custom signature request email message for the submitter.", "properties": { "subject": { "type": "string", @@ -395,7 +426,9 @@ const submission = await docuseal.createSubmission({ "name": { "type": "string", "description": "Document template field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -426,7 +459,9 @@ const submission = await docuseal.createSubmission({ } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -447,11 +482,14 @@ const submission = await docuseal.createSubmission({ }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -487,11 +525,14 @@ const submission = await docuseal.createSubmission({ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -553,12 +594,16 @@ const submission = await docuseal.createSubmission({ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -682,7 +727,9 @@ const submission = await docuseal.createSubmissionFromPdf({ "name": { "type": "string", "description": "Name of the document submission.", - "example": "Test Submission Document" + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -718,7 +765,9 @@ const submission = await docuseal.createSubmissionFromPdf({ "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -730,6 +779,7 @@ const submission = await docuseal.createSubmissionFromPdf({ }, "documents": { "type": "array", + "description": "An array of PDF documents to create a submission.", "items": { "type": "object", "required": [ @@ -742,7 +792,9 @@ const submission = await docuseal.createSubmissionFromPdf({ "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF file or downloadable file URL." @@ -778,6 +830,7 @@ const submission = await docuseal.createSubmissionFromPdf({ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -799,6 +852,7 @@ const submission = await docuseal.createSubmissionFromPdf({ }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "required": [ @@ -828,7 +882,9 @@ const submission = await docuseal.createSubmissionFromPdf({ "page": { "type": "integer", "description": "Page number of the field area. Starts from 1.", - "example": 1 + "examples": [ + 1 + ] }, "option": { "type": "string", @@ -843,9 +899,11 @@ const submission = await docuseal.createSubmissionFromPdf({ "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] } } @@ -863,9 +921,6 @@ const submission = await docuseal.createSubmissionFromPdf({ "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -874,18 +929,24 @@ const submission = await docuseal.createSubmissionFromPdf({ "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -902,7 +963,9 @@ const submission = await docuseal.createSubmissionFromPdf({ "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -952,7 +1015,9 @@ const submission = await docuseal.createSubmissionFromPdf({ "name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -983,7 +1048,9 @@ const submission = await docuseal.createSubmissionFromPdf({ } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -1004,11 +1071,14 @@ const submission = await docuseal.createSubmissionFromPdf({ }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -1044,11 +1114,14 @@ const submission = await docuseal.createSubmissionFromPdf({ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -1110,12 +1183,16 @@ const submission = await docuseal.createSubmissionFromPdf({ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -1165,6 +1242,7 @@ const submission = await docuseal.createSubmissionFromPdf({ }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -1201,7 +1279,7 @@ const submission = await docuseal.createSubmissionFromPdf({ ### Create a submission from DOCX -The API endpoint provides functionality to create a one-off submission request from a DOCX file with dynamic content variables. Use [[variable_name]] text tags to define dynamic content variables in the document. See https://www.docuseal.com/examples/demo_template.docx for the specific text variable syntax, including dynamic content tables and list. You can also use the {{signature}} field syntax to define fillable fields, as in a PDF.
Related Guides
Use dynamic content variables in DOCX to create personalized documents +The API endpoint provides functionality to create a one-off submission request from a DOCX file with dynamic content variables. Use [[variable_name]] text tags to define dynamic content variables in the document. See https://www.docuseal.com/examples/demo_template.docx for the specific text variable syntax, including dynamic content tables and lists. You can also use the {{signature}} field syntax to define fillable fields, as in a PDF.
Related Guides
Use dynamic content variables in DOCX to create personalized documents ```javascript const docuseal = require("@docuseal/api"); @@ -1255,7 +1333,9 @@ const submission = await docuseal.createSubmissionFromDocx({ "name": { "type": "string", "description": "Name of the document submission.", - "example": "Test Submission Document" + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -1270,9 +1350,11 @@ const submission = await docuseal.createSubmissionFromDocx({ "variables": { "type": "object", "description": "Dynamic content variables object. Variable values can be strings, numbers, arrays, objects, or HTML content used to generate styled text, paragraphs, and tables in DOCX.", - "example": { - "variable_name": "value" - } + "examples": [ + { + "variable_name": "value" + } + ] }, "order": { "type": "string", @@ -1298,7 +1380,9 @@ const submission = await docuseal.createSubmissionFromDocx({ "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -1310,6 +1394,7 @@ const submission = await docuseal.createSubmissionFromDocx({ }, "documents": { "type": "array", + "description": "An array of DOCX documents to create a submission.", "items": { "type": "object", "required": [ @@ -1322,7 +1407,9 @@ const submission = await docuseal.createSubmissionFromDocx({ "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF or DOCX file or downloadable file URL." @@ -1339,9 +1426,6 @@ const submission = await docuseal.createSubmissionFromDocx({ "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -1350,18 +1434,24 @@ const submission = await docuseal.createSubmissionFromDocx({ "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -1378,7 +1468,9 @@ const submission = await docuseal.createSubmissionFromDocx({ "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -1428,7 +1520,9 @@ const submission = await docuseal.createSubmissionFromDocx({ "name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -1459,7 +1553,9 @@ const submission = await docuseal.createSubmissionFromDocx({ } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -1480,11 +1576,14 @@ const submission = await docuseal.createSubmissionFromDocx({ }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -1520,11 +1619,14 @@ const submission = await docuseal.createSubmissionFromDocx({ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -1586,12 +1688,16 @@ const submission = await docuseal.createSubmissionFromDocx({ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -1641,6 +1747,7 @@ const submission = await docuseal.createSubmissionFromDocx({ }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -1659,7 +1766,7 @@ const submission = await docuseal.createSubmissionFromDocx({ }, "remove_tags": { "type": "boolean", - "description": "Pass `false` to disable the removal of {{text}} tags from the PDF. This can be used along with transparent text tags for faster and more robust PDF processing.", + "description": "Pass `false` to disable the removal of {{text}} tags from the document. This can be used along with transparent text tags for faster and more robust document processing.", "default": true } } @@ -1730,8 +1837,10 @@ and typesetting industry

"properties": { "name": { "type": "string", - "description": "Name of the document submission", - "example": "Test Submission Document" + "description": "Name of the document submission.", + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -1767,7 +1876,9 @@ and typesetting industry

"expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -1789,12 +1900,16 @@ and typesetting industry

"name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Document" + "examples": [ + "Test Document" + ] }, "html": { "type": "string", "description": "HTML document content with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "html_header": { "type": "string", @@ -1821,7 +1936,9 @@ and typesetting industry

"A5", "A6" ], - "example": "A4" + "examples": [ + "A4" + ] }, "position": { "type": "integer", @@ -1835,9 +1952,6 @@ and typesetting industry

"description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -1846,18 +1960,24 @@ and typesetting industry

"role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -1874,7 +1994,9 @@ and typesetting industry

"metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -1924,7 +2046,9 @@ and typesetting industry

"name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -1955,7 +2079,9 @@ and typesetting industry

} ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -1976,11 +2102,14 @@ and typesetting industry

}, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -2016,11 +2145,14 @@ and typesetting industry

}, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -2082,12 +2214,16 @@ and typesetting industry

"format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -2137,6 +2273,7 @@ and typesetting industry

}, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -2282,7 +2419,7 @@ const { data, pagination } = await docuseal.listSubmitters({ limit: 10 }); "schema": { "type": "string" }, - "description": "The unique applications-specific identifier provided for a submitter when initializing a signature request. It allows you to receive only submitters with a specified external id." + "description": "The unique application-specific identifier provided for a submitter when initializing a signature request. It allows you to receive only submitters with a specified external ID." }, { "name": "limit", @@ -2300,7 +2437,7 @@ const { data, pagination } = await docuseal.listSubmitters({ limit: 10 }); "schema": { "type": "integer" }, - "description": "The unique identifier of the submitter to start the list from. It allows you to receive only submitters with id greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of submitters." + "description": "The unique identifier of the submitter to start the list from. It allows you to receive only submitters with an ID greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of submitters." }, { "name": "before", @@ -2309,7 +2446,7 @@ const { data, pagination } = await docuseal.listSubmitters({ limit: 10 }); "schema": { "type": "integer" }, - "description": "The unique identifier of the submitter to end the list with. It allows you to receive only submitters with id less than the specified value." + "description": "The unique identifier of the submitter to end the list with. It allows you to receive only submitters with an ID less than the specified value." } ] } @@ -2413,12 +2550,16 @@ const submitter = await docuseal.updateSubmitter(500001, { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -2448,7 +2589,9 @@ const submitter = await docuseal.updateSubmitter(500001, { "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "completed_redirect_url": { "type": "string", @@ -2459,8 +2602,14 @@ const submitter = await docuseal.updateSubmitter(500001, { "description": "Set to `true` to require phone 2FA verification via a one-time code sent to the phone number in order to access the documents.", "default": false }, + "require_email_2fa": { + "type": "boolean", + "description": "Set to `true` to require email 2FA verification via a one-time code sent to the email address in order to access the documents.", + "default": false + }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -2484,7 +2633,9 @@ const submitter = await docuseal.updateSubmitter(500001, { "name": { "type": "string", "description": "Document template field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -2515,7 +2666,9 @@ const submitter = await docuseal.updateSubmitter(500001, { } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -2528,11 +2681,14 @@ const submitter = await docuseal.updateSubmitter(500001, { }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -2568,11 +2724,14 @@ const submitter = await docuseal.updateSubmitter(500001, { }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -2634,12 +2793,16 @@ const submitter = await docuseal.updateSubmitter(500001, { "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -2736,7 +2899,7 @@ const { data, pagination } = await docuseal.listTemplates({ limit: 10 }); "schema": { "type": "string" }, - "description": "The unique applications-specific identifier provided for the template via API or Embedded template form builder. It allows you to receive only templates with your specified external id." + "description": "The unique application-specific identifier provided for the template via API or Embedded template form builder. It allows you to receive only templates with your specified external ID." }, { "name": "folder", @@ -2772,7 +2935,7 @@ const { data, pagination } = await docuseal.listTemplates({ limit: 10 }); "schema": { "type": "integer" }, - "description": "The unique identifier of the template to start the list from. It allows you to receive only templates with id greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of templates." + "description": "The unique identifier of the template to start the list from. It allows you to receive only templates with an ID greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of templates." }, { "name": "before", @@ -2781,7 +2944,7 @@ const { data, pagination } = await docuseal.listTemplates({ limit: 10 }); "schema": { "type": "integer" }, - "description": "The unique identifier of the template to end the list with. It allows you to receive only templates with id less than the specified value." + "description": "The unique identifier of the template to end the list with. It allows you to receive only templates with an ID less than the specified value." } ] } @@ -2886,25 +3049,30 @@ const template = await docuseal.createTemplateFromPdf({ "properties": { "name": { "type": "string", - "description": "Name of the template", - "example": "Test PDF" + "description": "Name of the template.", + "examples": [ + "Test PDF" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new PDF.", - "example": "unique-key" + "examples": [ + "unique-key" + ] }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { "type": "array", + "description": "An array of PDF documents to create a template.", "items": { "type": "object", "required": [ @@ -2917,7 +3085,9 @@ const template = await docuseal.createTemplateFromPdf({ "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF file or downloadable file URL." @@ -2953,6 +3123,7 @@ const template = await docuseal.createTemplateFromPdf({ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -2974,6 +3145,7 @@ const template = await docuseal.createTemplateFromPdf({ }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "required": [ @@ -3003,7 +3175,9 @@ const template = await docuseal.createTemplateFromPdf({ "page": { "type": "integer", "description": "Page number of the field area. Starts from 1.", - "example": 1 + "examples": [ + 1 + ] }, "option": { "type": "string", @@ -3018,18 +3192,23 @@ const template = await docuseal.createTemplateFromPdf({ "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -3065,11 +3244,14 @@ const template = await docuseal.createTemplateFromPdf({ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -3131,12 +3313,16 @@ const template = await docuseal.createTemplateFromPdf({ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -3197,7 +3383,7 @@ const template = await docuseal.createTemplateFromPdf({ ### Create a template from Word DOCX -The API endpoint provides the functionality to create a fillable document template for existing Microsoft Word document. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See https://www.docuseal.com/examples/fieldtags.docx for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.
Related Guides
Use embedded text field tags to create a fillable form +The API endpoint provides the functionality to create a fillable document template for an existing Microsoft Word document. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See https://www.docuseal.com/examples/fieldtags.docx for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.
Related Guides
Use embedded text field tags to create a fillable form ```javascript @@ -3241,25 +3427,30 @@ const template = await docuseal.createTemplateFromDocx({ "properties": { "name": { "type": "string", - "description": "Name of the template", - "example": "Test DOCX" + "description": "Name of the template.", + "examples": [ + "Test DOCX" + ] }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new document.", - "example": "unique-key" + "examples": [ + "unique-key" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { "type": "array", + "description": "An array of DOCX documents to create a template.", "items": { "type": "object", "required": [ @@ -3273,9 +3464,16 @@ const template = await docuseal.createTemplateFromDocx({ }, "file": { "type": "string", - "example": "base64", + "examples": [ + "base64" + ], "format": "base64", - "description": "Base64-encoded content of the DOCX file or downloadable file URL" + "description": "Base64-encoded content of the DOCX file or downloadable file URL." + }, + "dynamic": { + "type": "boolean", + "description": "Set to `true` to make the document dynamic. When enabled, the DOCX document content can be edited or use [[variables]] in the template editor.", + "default": false }, "fields": { "description": "Fields are optional if you use {{...}} text tags to define fields in the document.", @@ -3308,6 +3506,7 @@ const template = await docuseal.createTemplateFromDocx({ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -3329,6 +3528,7 @@ const template = await docuseal.createTemplateFromDocx({ }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "properties": { @@ -3365,18 +3565,23 @@ const template = await docuseal.createTemplateFromDocx({ "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -3412,11 +3617,14 @@ const template = await docuseal.createTemplateFromDocx({ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -3478,12 +3686,16 @@ const template = await docuseal.createTemplateFromDocx({ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -3581,7 +3793,9 @@ and typesetting industry

"html": { "type": "string", "description": "HTML template with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "html_header": { "type": "string", @@ -3594,7 +3808,9 @@ and typesetting industry

"name": { "type": "string", "description": "Template name. Random uuid will be assigned when not specified.", - "example": "Test Template" + "examples": [ + "Test Template" + ] }, "size": { "type": "string", @@ -3613,20 +3829,24 @@ and typesetting industry

"A5", "A6" ], - "example": "A4" + "examples": [ + "A4" + ] }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new HTML.", - "example": "714d974e-83d8-11ee-b962-0242ac120002" + "examples": [ + "714d974e-83d8-11ee-b962-0242ac120002" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { @@ -3641,12 +3861,16 @@ and typesetting industry

"html": { "type": "string", "description": "HTML template with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Document" + "examples": [ + "Test Document" + ] } } } @@ -3661,7 +3885,7 @@ and typesetting industry

### Clone a template -The API endpoint allows you to clone existing template into a new template. +The API endpoint allows you to clone an existing template into a new template. ```javascript const docuseal = require("@docuseal/api"); @@ -3693,7 +3917,7 @@ const template = await docuseal.cloneTemplate(1000001, { "schema": { "type": "integer" }, - "description": "The unique identifier of the documents template.", + "description": "The unique identifier of the document template.", "example": 1000001 } ], @@ -3707,7 +3931,9 @@ const template = await docuseal.cloneTemplate(1000001, { "name": { "type": "string", "description": "Template name. Existing name with (Clone) suffix will be used if not specified.", - "example": "Cloned Template" + "examples": [ + "Cloned Template" + ] }, "folder_name": { "type": "string", @@ -3772,15 +3998,19 @@ const template = await docuseal.mergeTemplates({ "items": { "type": "integer" }, - "example": [ - 321, - 432 + "examples": [ + [ + 321, + 432 + ] ] }, "name": { "type": "string", "description": "Template name. Existing name with (Merged) suffix will be used if not specified.", - "example": "Merged Template" + "examples": [ + "Merged Template" + ] }, "folder_name": { "type": "string", @@ -3792,7 +4022,7 @@ const template = await docuseal.mergeTemplates({ }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "roles": { @@ -3801,9 +4031,11 @@ const template = await docuseal.mergeTemplates({ "items": { "type": "string" }, - "example": [ - "Agent", - "Customer" + "examples": [ + [ + "Agent", + "Customer" + ] ] } } @@ -3862,13 +4094,17 @@ const template = await docuseal.updateTemplate(1000001, { "properties": { "name": { "type": "string", - "description": "The name of the template", - "example": "New Document Name" + "description": "The name of the template.", + "examples": [ + "New Document Name" + ] }, "folder_name": { "type": "string", "description": "The folder's name to which the template should be moved.", - "example": "New Folder" + "examples": [ + "New Folder" + ] }, "roles": { "type": "array", @@ -3876,9 +4112,11 @@ const template = await docuseal.updateTemplate(1000001, { "items": { "type": "string" }, - "example": [ - "Agent", - "Customer" + "examples": [ + [ + "Agent", + "Customer" + ] ] }, "archived": { @@ -3931,7 +4169,7 @@ const template = await docuseal.updateTemplateDocuments(1000001, { "schema": { "type": "integer" }, - "description": "The unique identifier of the documents template.", + "description": "The unique identifier of the document template.", "example": 1000001 } ], @@ -3951,7 +4189,9 @@ const template = await docuseal.updateTemplateDocuments(1000001, { "name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Template" + "examples": [ + "Test Template" + ] }, "file": { "type": "string", @@ -3965,7 +4205,9 @@ const template = await docuseal.updateTemplateDocuments(1000001, { "position": { "type": "integer", "description": "Position of the document. By default will be added as the last document in the template.", - "example": 0 + "examples": [ + 0 + ] }, "replace": { "type": "boolean", diff --git a/docs/api/nodejs.md b/docs/api/nodejs.md index c1e00c63..15ee15ce 100644 --- a/docs/api/nodejs.md +++ b/docs/api/nodejs.md @@ -59,7 +59,7 @@ const { data, pagination } = await resp.json(); "schema": { "type": "string" }, - "description": "Filter submissions based on submitters name, email or phone partial match." + "description": "Filter submissions based on submitter's name, email or phone partial match." }, { "name": "slug", @@ -203,6 +203,17 @@ const submission = await resp.json(); }, "description": "The unique identifier of the submission.", "example": 1001 + }, + { + "name": "merge", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false + }, + "description": "When `true`, merges all documents into a single PDF.", + "example": false } ] } @@ -262,7 +273,9 @@ const submitters = await resp.json(); "template_id": { "type": "integer", "description": "The unique identifier of the template. Document template forms can be created via the Web UI, PDF and DOCX API, or HTML API.", - "example": 1000001 + "examples": [ + 1000001 + ] }, "send_email": { "type": "boolean", @@ -298,10 +311,22 @@ const submitters = await resp.json(); "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] + }, + "variables": { + "type": "object", + "description": "Dynamic content variables object. Variable values can be strings, numbers, arrays, objects, or HTML content used to generate styled text, paragraphs, and tables in dynamic template documents.", + "examples": [ + { + "variable_name": "value" + } + ] }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -318,9 +343,6 @@ const submitters = await resp.json(); "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -329,18 +351,24 @@ const submitters = await resp.json(); "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -357,7 +385,9 @@ const submitters = await resp.json(); "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -393,6 +423,7 @@ const submitters = await resp.json(); }, "message": { "type": "object", + "description": "Custom signature request email message for the submitter.", "properties": { "subject": { "type": "string", @@ -416,7 +447,9 @@ const submitters = await resp.json(); "name": { "type": "string", "description": "Document template field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -447,7 +480,9 @@ const submitters = await resp.json(); } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -468,11 +503,14 @@ const submitters = await resp.json(); }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -508,11 +546,14 @@ const submitters = await resp.json(); }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -574,12 +615,16 @@ const submitters = await resp.json(); "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -709,7 +754,9 @@ const submission = await resp.json(); "name": { "type": "string", "description": "Name of the document submission.", - "example": "Test Submission Document" + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -745,7 +792,9 @@ const submission = await resp.json(); "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -757,6 +806,7 @@ const submission = await resp.json(); }, "documents": { "type": "array", + "description": "An array of PDF documents to create a submission.", "items": { "type": "object", "required": [ @@ -769,7 +819,9 @@ const submission = await resp.json(); "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF file or downloadable file URL." @@ -805,6 +857,7 @@ const submission = await resp.json(); "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -826,6 +879,7 @@ const submission = await resp.json(); }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "required": [ @@ -855,7 +909,9 @@ const submission = await resp.json(); "page": { "type": "integer", "description": "Page number of the field area. Starts from 1.", - "example": 1 + "examples": [ + 1 + ] }, "option": { "type": "string", @@ -870,9 +926,11 @@ const submission = await resp.json(); "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] } } @@ -890,9 +948,6 @@ const submission = await resp.json(); "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -901,18 +956,24 @@ const submission = await resp.json(); "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -929,7 +990,9 @@ const submission = await resp.json(); "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -979,7 +1042,9 @@ const submission = await resp.json(); "name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -1010,7 +1075,9 @@ const submission = await resp.json(); } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -1031,11 +1098,14 @@ const submission = await resp.json(); }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -1071,11 +1141,14 @@ const submission = await resp.json(); }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -1137,12 +1210,16 @@ const submission = await resp.json(); "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -1192,6 +1269,7 @@ const submission = await resp.json(); }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -1228,7 +1306,7 @@ const submission = await resp.json(); ### Create a submission from DOCX -The API endpoint provides functionality to create a one-off submission request from a DOCX file with dynamic content variables. Use [[variable_name]] text tags to define dynamic content variables in the document. See https://www.docuseal.com/examples/demo_template.docx for the specific text variable syntax, including dynamic content tables and list. You can also use the {{signature}} field syntax to define fillable fields, as in a PDF.
Related Guides
Use dynamic content variables in DOCX to create personalized documents +The API endpoint provides functionality to create a one-off submission request from a DOCX file with dynamic content variables. Use [[variable_name]] text tags to define dynamic content variables in the document. See https://www.docuseal.com/examples/demo_template.docx for the specific text variable syntax, including dynamic content tables and lists. You can also use the {{signature}} field syntax to define fillable fields, as in a PDF.
Related Guides
Use dynamic content variables in DOCX to create personalized documents ```nodejs const fetch = require("node-fetch"); @@ -1288,7 +1366,9 @@ const submitters = await resp.json(); "name": { "type": "string", "description": "Name of the document submission.", - "example": "Test Submission Document" + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -1303,9 +1383,11 @@ const submitters = await resp.json(); "variables": { "type": "object", "description": "Dynamic content variables object. Variable values can be strings, numbers, arrays, objects, or HTML content used to generate styled text, paragraphs, and tables in DOCX.", - "example": { - "variable_name": "value" - } + "examples": [ + { + "variable_name": "value" + } + ] }, "order": { "type": "string", @@ -1331,7 +1413,9 @@ const submitters = await resp.json(); "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -1343,6 +1427,7 @@ const submitters = await resp.json(); }, "documents": { "type": "array", + "description": "An array of DOCX documents to create a submission.", "items": { "type": "object", "required": [ @@ -1355,7 +1440,9 @@ const submitters = await resp.json(); "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF or DOCX file or downloadable file URL." @@ -1372,9 +1459,6 @@ const submitters = await resp.json(); "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -1383,18 +1467,24 @@ const submitters = await resp.json(); "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -1411,7 +1501,9 @@ const submitters = await resp.json(); "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -1461,7 +1553,9 @@ const submitters = await resp.json(); "name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -1492,7 +1586,9 @@ const submitters = await resp.json(); } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -1513,11 +1609,14 @@ const submitters = await resp.json(); }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -1553,11 +1652,14 @@ const submitters = await resp.json(); }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -1619,12 +1721,16 @@ const submitters = await resp.json(); "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -1674,6 +1780,7 @@ const submitters = await resp.json(); }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -1692,7 +1799,7 @@ const submitters = await resp.json(); }, "remove_tags": { "type": "boolean", - "description": "Pass `false` to disable the removal of {{text}} tags from the PDF. This can be used along with transparent text tags for faster and more robust PDF processing.", + "description": "Pass `false` to disable the removal of {{text}} tags from the document. This can be used along with transparent text tags for faster and more robust document processing.", "default": true } } @@ -1769,8 +1876,10 @@ const submission = await resp.json(); "properties": { "name": { "type": "string", - "description": "Name of the document submission", - "example": "Test Submission Document" + "description": "Name of the document submission.", + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -1806,7 +1915,9 @@ const submission = await resp.json(); "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -1828,12 +1939,16 @@ const submission = await resp.json(); "name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Document" + "examples": [ + "Test Document" + ] }, "html": { "type": "string", "description": "HTML document content with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "html_header": { "type": "string", @@ -1860,7 +1975,9 @@ const submission = await resp.json(); "A5", "A6" ], - "example": "A4" + "examples": [ + "A4" + ] }, "position": { "type": "integer", @@ -1874,9 +1991,6 @@ const submission = await resp.json(); "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -1885,18 +1999,24 @@ const submission = await resp.json(); "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -1913,7 +2033,9 @@ const submission = await resp.json(); "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -1963,7 +2085,9 @@ const submission = await resp.json(); "name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -1994,7 +2118,9 @@ const submission = await resp.json(); } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -2015,11 +2141,14 @@ const submission = await resp.json(); }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -2055,11 +2184,14 @@ const submission = await resp.json(); }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -2121,12 +2253,16 @@ const submission = await resp.json(); "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -2176,6 +2312,7 @@ const submission = await resp.json(); }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -2331,7 +2468,7 @@ const { data, pagination } = await resp.json(); "schema": { "type": "string" }, - "description": "The unique applications-specific identifier provided for a submitter when initializing a signature request. It allows you to receive only submitters with a specified external id." + "description": "The unique application-specific identifier provided for a submitter when initializing a signature request. It allows you to receive only submitters with a specified external ID." }, { "name": "limit", @@ -2349,7 +2486,7 @@ const { data, pagination } = await resp.json(); "schema": { "type": "integer" }, - "description": "The unique identifier of the submitter to start the list from. It allows you to receive only submitters with id greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of submitters." + "description": "The unique identifier of the submitter to start the list from. It allows you to receive only submitters with an ID greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of submitters." }, { "name": "before", @@ -2358,7 +2495,7 @@ const { data, pagination } = await resp.json(); "schema": { "type": "integer" }, - "description": "The unique identifier of the submitter to end the list with. It allows you to receive only submitters with id less than the specified value." + "description": "The unique identifier of the submitter to end the list with. It allows you to receive only submitters with an ID less than the specified value." } ] } @@ -2473,12 +2610,16 @@ const submitter = await resp.json(); "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -2508,7 +2649,9 @@ const submitter = await resp.json(); "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "completed_redirect_url": { "type": "string", @@ -2519,8 +2662,14 @@ const submitter = await resp.json(); "description": "Set to `true` to require phone 2FA verification via a one-time code sent to the phone number in order to access the documents.", "default": false }, + "require_email_2fa": { + "type": "boolean", + "description": "Set to `true` to require email 2FA verification via a one-time code sent to the email address in order to access the documents.", + "default": false + }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -2544,7 +2693,9 @@ const submitter = await resp.json(); "name": { "type": "string", "description": "Document template field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -2575,7 +2726,9 @@ const submitter = await resp.json(); } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -2588,11 +2741,14 @@ const submitter = await resp.json(); }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -2628,11 +2784,14 @@ const submitter = await resp.json(); }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -2694,12 +2853,16 @@ const submitter = await resp.json(); "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -2801,7 +2964,7 @@ const { data, pagination } = await resp.json(); "schema": { "type": "string" }, - "description": "The unique applications-specific identifier provided for the template via API or Embedded template form builder. It allows you to receive only templates with your specified external id." + "description": "The unique application-specific identifier provided for the template via API or Embedded template form builder. It allows you to receive only templates with your specified external ID." }, { "name": "folder", @@ -2837,7 +3000,7 @@ const { data, pagination } = await resp.json(); "schema": { "type": "integer" }, - "description": "The unique identifier of the template to start the list from. It allows you to receive only templates with id greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of templates." + "description": "The unique identifier of the template to start the list from. It allows you to receive only templates with an ID greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of templates." }, { "name": "before", @@ -2846,7 +3009,7 @@ const { data, pagination } = await resp.json(); "schema": { "type": "integer" }, - "description": "The unique identifier of the template to end the list with. It allows you to receive only templates with id less than the specified value." + "description": "The unique identifier of the template to end the list with. It allows you to receive only templates with an ID less than the specified value." } ] } @@ -2962,25 +3125,30 @@ const template = await resp.json(); "properties": { "name": { "type": "string", - "description": "Name of the template", - "example": "Test PDF" + "description": "Name of the template.", + "examples": [ + "Test PDF" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new PDF.", - "example": "unique-key" + "examples": [ + "unique-key" + ] }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { "type": "array", + "description": "An array of PDF documents to create a template.", "items": { "type": "object", "required": [ @@ -2993,7 +3161,9 @@ const template = await resp.json(); "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF file or downloadable file URL." @@ -3029,6 +3199,7 @@ const template = await resp.json(); "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -3050,6 +3221,7 @@ const template = await resp.json(); }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "required": [ @@ -3079,7 +3251,9 @@ const template = await resp.json(); "page": { "type": "integer", "description": "Page number of the field area. Starts from 1.", - "example": 1 + "examples": [ + 1 + ] }, "option": { "type": "string", @@ -3094,18 +3268,23 @@ const template = await resp.json(); "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -3141,11 +3320,14 @@ const template = await resp.json(); }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -3207,12 +3389,16 @@ const template = await resp.json(); "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -3273,7 +3459,7 @@ const template = await resp.json(); ### Create a template from Word DOCX -The API endpoint provides the functionality to create a fillable document template for existing Microsoft Word document. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See https://www.docuseal.com/examples/fieldtags.docx for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.
Related Guides
Use embedded text field tags to create a fillable form +The API endpoint provides the functionality to create a fillable document template for an existing Microsoft Word document. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See https://www.docuseal.com/examples/fieldtags.docx for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.
Related Guides
Use embedded text field tags to create a fillable form ```nodejs @@ -3323,25 +3509,30 @@ const template = await resp.json(); "properties": { "name": { "type": "string", - "description": "Name of the template", - "example": "Test DOCX" + "description": "Name of the template.", + "examples": [ + "Test DOCX" + ] }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new document.", - "example": "unique-key" + "examples": [ + "unique-key" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { "type": "array", + "description": "An array of DOCX documents to create a template.", "items": { "type": "object", "required": [ @@ -3355,9 +3546,16 @@ const template = await resp.json(); }, "file": { "type": "string", - "example": "base64", + "examples": [ + "base64" + ], "format": "base64", - "description": "Base64-encoded content of the DOCX file or downloadable file URL" + "description": "Base64-encoded content of the DOCX file or downloadable file URL." + }, + "dynamic": { + "type": "boolean", + "description": "Set to `true` to make the document dynamic. When enabled, the DOCX document content can be edited or use [[variables]] in the template editor.", + "default": false }, "fields": { "description": "Fields are optional if you use {{...}} text tags to define fields in the document.", @@ -3390,6 +3588,7 @@ const template = await resp.json(); "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -3411,6 +3610,7 @@ const template = await resp.json(); }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "properties": { @@ -3447,18 +3647,23 @@ const template = await resp.json(); "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -3494,11 +3699,14 @@ const template = await resp.json(); }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -3560,12 +3768,16 @@ const template = await resp.json(); "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -3669,7 +3881,9 @@ const template = await resp.json(); "html": { "type": "string", "description": "HTML template with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "html_header": { "type": "string", @@ -3682,7 +3896,9 @@ const template = await resp.json(); "name": { "type": "string", "description": "Template name. Random uuid will be assigned when not specified.", - "example": "Test Template" + "examples": [ + "Test Template" + ] }, "size": { "type": "string", @@ -3701,20 +3917,24 @@ const template = await resp.json(); "A5", "A6" ], - "example": "A4" + "examples": [ + "A4" + ] }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new HTML.", - "example": "714d974e-83d8-11ee-b962-0242ac120002" + "examples": [ + "714d974e-83d8-11ee-b962-0242ac120002" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { @@ -3729,12 +3949,16 @@ const template = await resp.json(); "html": { "type": "string", "description": "HTML template with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Document" + "examples": [ + "Test Document" + ] } } } @@ -3749,7 +3973,7 @@ const template = await resp.json(); ### Clone a template -The API endpoint allows you to clone existing template into a new template. +The API endpoint allows you to clone an existing template into a new template. ```nodejs const fetch = require("node-fetch"); @@ -3787,7 +4011,7 @@ const template = await resp.json(); "schema": { "type": "integer" }, - "description": "The unique identifier of the documents template.", + "description": "The unique identifier of the document template.", "example": 1000001 } ], @@ -3801,7 +4025,9 @@ const template = await resp.json(); "name": { "type": "string", "description": "Template name. Existing name with (Clone) suffix will be used if not specified.", - "example": "Cloned Template" + "examples": [ + "Cloned Template" + ] }, "folder_name": { "type": "string", @@ -3872,15 +4098,19 @@ const template = await resp.json(); "items": { "type": "integer" }, - "example": [ - 321, - 432 + "examples": [ + [ + 321, + 432 + ] ] }, "name": { "type": "string", "description": "Template name. Existing name with (Merged) suffix will be used if not specified.", - "example": "Merged Template" + "examples": [ + "Merged Template" + ] }, "folder_name": { "type": "string", @@ -3892,7 +4122,7 @@ const template = await resp.json(); }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "roles": { @@ -3901,9 +4131,11 @@ const template = await resp.json(); "items": { "type": "string" }, - "example": [ - "Agent", - "Customer" + "examples": [ + [ + "Agent", + "Customer" + ] ] } } @@ -3968,13 +4200,17 @@ const template = await resp.json(); "properties": { "name": { "type": "string", - "description": "The name of the template", - "example": "New Document Name" + "description": "The name of the template.", + "examples": [ + "New Document Name" + ] }, "folder_name": { "type": "string", "description": "The folder's name to which the template should be moved.", - "example": "New Folder" + "examples": [ + "New Folder" + ] }, "roles": { "type": "array", @@ -3982,9 +4218,11 @@ const template = await resp.json(); "items": { "type": "string" }, - "example": [ - "Agent", - "Customer" + "examples": [ + [ + "Agent", + "Customer" + ] ] }, "archived": { @@ -4043,7 +4281,7 @@ const template = await resp.json(); "schema": { "type": "integer" }, - "description": "The unique identifier of the documents template.", + "description": "The unique identifier of the document template.", "example": 1000001 } ], @@ -4063,7 +4301,9 @@ const template = await resp.json(); "name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Template" + "examples": [ + "Test Template" + ] }, "file": { "type": "string", @@ -4077,7 +4317,9 @@ const template = await resp.json(); "position": { "type": "integer", "description": "Position of the document. By default will be added as the last document in the template.", - "example": 0 + "examples": [ + 0 + ] }, "replace": { "type": "boolean", diff --git a/docs/api/php.md b/docs/api/php.md index a56fe2ca..9888f45d 100644 --- a/docs/api/php.md +++ b/docs/api/php.md @@ -52,7 +52,7 @@ $docuseal->listSubmissions(['limit' => 10]); "schema": { "type": "string" }, - "description": "Filter submissions based on submitters name, email or phone partial match." + "description": "Filter submissions based on submitter's name, email or phone partial match." }, { "name": "slug", @@ -182,6 +182,17 @@ $docuseal->getSubmissionDocuments(1001); }, "description": "The unique identifier of the submission.", "example": 1001 + }, + { + "name": "merge", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false + }, + "description": "When `true`, merges all documents into a single PDF.", + "example": false } ] } @@ -233,7 +244,9 @@ $docuseal->createSubmission([ "template_id": { "type": "integer", "description": "The unique identifier of the template. Document template forms can be created via the Web UI, PDF and DOCX API, or HTML API.", - "example": 1000001 + "examples": [ + 1000001 + ] }, "send_email": { "type": "boolean", @@ -269,10 +282,22 @@ $docuseal->createSubmission([ "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] + }, + "variables": { + "type": "object", + "description": "Dynamic content variables object. Variable values can be strings, numbers, arrays, objects, or HTML content used to generate styled text, paragraphs, and tables in dynamic template documents.", + "examples": [ + { + "variable_name": "value" + } + ] }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -289,9 +314,6 @@ $docuseal->createSubmission([ "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -300,18 +322,24 @@ $docuseal->createSubmission([ "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -328,7 +356,9 @@ $docuseal->createSubmission([ "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -364,6 +394,7 @@ $docuseal->createSubmission([ }, "message": { "type": "object", + "description": "Custom signature request email message for the submitter.", "properties": { "subject": { "type": "string", @@ -387,7 +418,9 @@ $docuseal->createSubmission([ "name": { "type": "string", "description": "Document template field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -418,7 +451,9 @@ $docuseal->createSubmission([ } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -439,11 +474,14 @@ $docuseal->createSubmission([ }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -479,11 +517,14 @@ $docuseal->createSubmission([ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -545,12 +586,16 @@ $docuseal->createSubmission([ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -672,7 +717,9 @@ $docuseal->createSubmissionFromPdf([ "name": { "type": "string", "description": "Name of the document submission.", - "example": "Test Submission Document" + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -708,7 +755,9 @@ $docuseal->createSubmissionFromPdf([ "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -720,6 +769,7 @@ $docuseal->createSubmissionFromPdf([ }, "documents": { "type": "array", + "description": "An array of PDF documents to create a submission.", "items": { "type": "object", "required": [ @@ -732,7 +782,9 @@ $docuseal->createSubmissionFromPdf([ "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF file or downloadable file URL." @@ -768,6 +820,7 @@ $docuseal->createSubmissionFromPdf([ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -789,6 +842,7 @@ $docuseal->createSubmissionFromPdf([ }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "required": [ @@ -818,7 +872,9 @@ $docuseal->createSubmissionFromPdf([ "page": { "type": "integer", "description": "Page number of the field area. Starts from 1.", - "example": 1 + "examples": [ + 1 + ] }, "option": { "type": "string", @@ -833,9 +889,11 @@ $docuseal->createSubmissionFromPdf([ "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] } } @@ -853,9 +911,6 @@ $docuseal->createSubmissionFromPdf([ "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -864,18 +919,24 @@ $docuseal->createSubmissionFromPdf([ "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -892,7 +953,9 @@ $docuseal->createSubmissionFromPdf([ "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -942,7 +1005,9 @@ $docuseal->createSubmissionFromPdf([ "name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -973,7 +1038,9 @@ $docuseal->createSubmissionFromPdf([ } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -994,11 +1061,14 @@ $docuseal->createSubmissionFromPdf([ }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -1034,11 +1104,14 @@ $docuseal->createSubmissionFromPdf([ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -1100,12 +1173,16 @@ $docuseal->createSubmissionFromPdf([ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -1155,6 +1232,7 @@ $docuseal->createSubmissionFromPdf([ }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -1191,7 +1269,7 @@ $docuseal->createSubmissionFromPdf([ ### Create a submission from DOCX -The API endpoint provides functionality to create a one-off submission request from a DOCX file with dynamic content variables. Use [[variable_name]] text tags to define dynamic content variables in the document. See https://www.docuseal.com/examples/demo_template.docx for the specific text variable syntax, including dynamic content tables and list. You can also use the {{signature}} field syntax to define fillable fields, as in a PDF.
Related Guides
Use dynamic content variables in DOCX to create personalized documents +The API endpoint provides functionality to create a one-off submission request from a DOCX file with dynamic content variables. Use [[variable_name]] text tags to define dynamic content variables in the document. See https://www.docuseal.com/examples/demo_template.docx for the specific text variable syntax, including dynamic content tables and lists. You can also use the {{signature}} field syntax to define fillable fields, as in a PDF.
Related Guides
Use dynamic content variables in DOCX to create personalized documents ```php $docuseal = new \Docuseal\Api('API_KEY', 'https://api.docuseal.com'); @@ -1243,7 +1321,9 @@ $docuseal->createSubmissionFromDocx([ "name": { "type": "string", "description": "Name of the document submission.", - "example": "Test Submission Document" + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -1258,9 +1338,11 @@ $docuseal->createSubmissionFromDocx([ "variables": { "type": "object", "description": "Dynamic content variables object. Variable values can be strings, numbers, arrays, objects, or HTML content used to generate styled text, paragraphs, and tables in DOCX.", - "example": { - "variable_name": "value" - } + "examples": [ + { + "variable_name": "value" + } + ] }, "order": { "type": "string", @@ -1286,7 +1368,9 @@ $docuseal->createSubmissionFromDocx([ "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -1298,6 +1382,7 @@ $docuseal->createSubmissionFromDocx([ }, "documents": { "type": "array", + "description": "An array of DOCX documents to create a submission.", "items": { "type": "object", "required": [ @@ -1310,7 +1395,9 @@ $docuseal->createSubmissionFromDocx([ "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF or DOCX file or downloadable file URL." @@ -1327,9 +1414,6 @@ $docuseal->createSubmissionFromDocx([ "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -1338,18 +1422,24 @@ $docuseal->createSubmissionFromDocx([ "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -1366,7 +1456,9 @@ $docuseal->createSubmissionFromDocx([ "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -1416,7 +1508,9 @@ $docuseal->createSubmissionFromDocx([ "name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -1447,7 +1541,9 @@ $docuseal->createSubmissionFromDocx([ } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -1468,11 +1564,14 @@ $docuseal->createSubmissionFromDocx([ }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -1508,11 +1607,14 @@ $docuseal->createSubmissionFromDocx([ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -1574,12 +1676,16 @@ $docuseal->createSubmissionFromDocx([ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -1629,6 +1735,7 @@ $docuseal->createSubmissionFromDocx([ }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -1647,7 +1754,7 @@ $docuseal->createSubmissionFromDocx([ }, "remove_tags": { "type": "boolean", - "description": "Pass `false` to disable the removal of {{text}} tags from the PDF. This can be used along with transparent text tags for faster and more robust PDF processing.", + "description": "Pass `false` to disable the removal of {{text}} tags from the document. This can be used along with transparent text tags for faster and more robust document processing.", "default": true } } @@ -1716,8 +1823,10 @@ and typesetting industry

"properties": { "name": { "type": "string", - "description": "Name of the document submission", - "example": "Test Submission Document" + "description": "Name of the document submission.", + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -1753,7 +1862,9 @@ and typesetting industry

"expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -1775,12 +1886,16 @@ and typesetting industry

"name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Document" + "examples": [ + "Test Document" + ] }, "html": { "type": "string", "description": "HTML document content with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "html_header": { "type": "string", @@ -1807,7 +1922,9 @@ and typesetting industry

"A5", "A6" ], - "example": "A4" + "examples": [ + "A4" + ] }, "position": { "type": "integer", @@ -1821,9 +1938,6 @@ and typesetting industry

"description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -1832,18 +1946,24 @@ and typesetting industry

"role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -1860,7 +1980,9 @@ and typesetting industry

"metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -1910,7 +2032,9 @@ and typesetting industry

"name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -1941,7 +2065,9 @@ and typesetting industry

} ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -1962,11 +2088,14 @@ and typesetting industry

}, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -2002,11 +2131,14 @@ and typesetting industry

}, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -2068,12 +2200,16 @@ and typesetting industry

"format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -2123,6 +2259,7 @@ and typesetting industry

}, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -2264,7 +2401,7 @@ $docuseal->listSubmitters(['limit' => 10]); "schema": { "type": "string" }, - "description": "The unique applications-specific identifier provided for a submitter when initializing a signature request. It allows you to receive only submitters with a specified external id." + "description": "The unique application-specific identifier provided for a submitter when initializing a signature request. It allows you to receive only submitters with a specified external ID." }, { "name": "limit", @@ -2282,7 +2419,7 @@ $docuseal->listSubmitters(['limit' => 10]); "schema": { "type": "integer" }, - "description": "The unique identifier of the submitter to start the list from. It allows you to receive only submitters with id greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of submitters." + "description": "The unique identifier of the submitter to start the list from. It allows you to receive only submitters with an ID greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of submitters." }, { "name": "before", @@ -2291,7 +2428,7 @@ $docuseal->listSubmitters(['limit' => 10]); "schema": { "type": "integer" }, - "description": "The unique identifier of the submitter to end the list with. It allows you to receive only submitters with id less than the specified value." + "description": "The unique identifier of the submitter to end the list with. It allows you to receive only submitters with an ID less than the specified value." } ] } @@ -2391,12 +2528,16 @@ $docuseal->updateSubmitter(500001, [ "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -2426,7 +2567,9 @@ $docuseal->updateSubmitter(500001, [ "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "completed_redirect_url": { "type": "string", @@ -2437,8 +2580,14 @@ $docuseal->updateSubmitter(500001, [ "description": "Set to `true` to require phone 2FA verification via a one-time code sent to the phone number in order to access the documents.", "default": false }, + "require_email_2fa": { + "type": "boolean", + "description": "Set to `true` to require email 2FA verification via a one-time code sent to the email address in order to access the documents.", + "default": false + }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -2462,7 +2611,9 @@ $docuseal->updateSubmitter(500001, [ "name": { "type": "string", "description": "Document template field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -2493,7 +2644,9 @@ $docuseal->updateSubmitter(500001, [ } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -2506,11 +2659,14 @@ $docuseal->updateSubmitter(500001, [ }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -2546,11 +2702,14 @@ $docuseal->updateSubmitter(500001, [ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -2612,12 +2771,16 @@ $docuseal->updateSubmitter(500001, [ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -2712,7 +2875,7 @@ $docuseal->listTemplates(['limit' => 10]); "schema": { "type": "string" }, - "description": "The unique applications-specific identifier provided for the template via API or Embedded template form builder. It allows you to receive only templates with your specified external id." + "description": "The unique application-specific identifier provided for the template via API or Embedded template form builder. It allows you to receive only templates with your specified external ID." }, { "name": "folder", @@ -2748,7 +2911,7 @@ $docuseal->listTemplates(['limit' => 10]); "schema": { "type": "integer" }, - "description": "The unique identifier of the template to start the list from. It allows you to receive only templates with id greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of templates." + "description": "The unique identifier of the template to start the list from. It allows you to receive only templates with an ID greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of templates." }, { "name": "before", @@ -2757,7 +2920,7 @@ $docuseal->listTemplates(['limit' => 10]); "schema": { "type": "integer" }, - "description": "The unique identifier of the template to end the list with. It allows you to receive only templates with id less than the specified value." + "description": "The unique identifier of the template to end the list with. It allows you to receive only templates with an ID less than the specified value." } ] } @@ -2858,25 +3021,30 @@ $docuseal->createTemplateFromPdf([ "properties": { "name": { "type": "string", - "description": "Name of the template", - "example": "Test PDF" + "description": "Name of the template.", + "examples": [ + "Test PDF" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new PDF.", - "example": "unique-key" + "examples": [ + "unique-key" + ] }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { "type": "array", + "description": "An array of PDF documents to create a template.", "items": { "type": "object", "required": [ @@ -2889,7 +3057,9 @@ $docuseal->createTemplateFromPdf([ "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF file or downloadable file URL." @@ -2925,6 +3095,7 @@ $docuseal->createTemplateFromPdf([ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -2946,6 +3117,7 @@ $docuseal->createTemplateFromPdf([ }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "required": [ @@ -2975,7 +3147,9 @@ $docuseal->createTemplateFromPdf([ "page": { "type": "integer", "description": "Page number of the field area. Starts from 1.", - "example": 1 + "examples": [ + 1 + ] }, "option": { "type": "string", @@ -2990,18 +3164,23 @@ $docuseal->createTemplateFromPdf([ "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -3037,11 +3216,14 @@ $docuseal->createTemplateFromPdf([ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -3103,12 +3285,16 @@ $docuseal->createTemplateFromPdf([ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -3169,7 +3355,7 @@ $docuseal->createTemplateFromPdf([ ### Create a template from Word DOCX -The API endpoint provides the functionality to create a fillable document template for existing Microsoft Word document. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See https://www.docuseal.com/examples/fieldtags.docx for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.
Related Guides
Use embedded text field tags to create a fillable form +The API endpoint provides the functionality to create a fillable document template for an existing Microsoft Word document. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See https://www.docuseal.com/examples/fieldtags.docx for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.
Related Guides
Use embedded text field tags to create a fillable form ```php @@ -3211,25 +3397,30 @@ $docuseal->createTemplateFromDocx([ "properties": { "name": { "type": "string", - "description": "Name of the template", - "example": "Test DOCX" + "description": "Name of the template.", + "examples": [ + "Test DOCX" + ] }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new document.", - "example": "unique-key" + "examples": [ + "unique-key" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { "type": "array", + "description": "An array of DOCX documents to create a template.", "items": { "type": "object", "required": [ @@ -3243,9 +3434,16 @@ $docuseal->createTemplateFromDocx([ }, "file": { "type": "string", - "example": "base64", + "examples": [ + "base64" + ], "format": "base64", - "description": "Base64-encoded content of the DOCX file or downloadable file URL" + "description": "Base64-encoded content of the DOCX file or downloadable file URL." + }, + "dynamic": { + "type": "boolean", + "description": "Set to `true` to make the document dynamic. When enabled, the DOCX document content can be edited or use [[variables]] in the template editor.", + "default": false }, "fields": { "description": "Fields are optional if you use {{...}} text tags to define fields in the document.", @@ -3278,6 +3476,7 @@ $docuseal->createTemplateFromDocx([ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -3299,6 +3498,7 @@ $docuseal->createTemplateFromDocx([ }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "properties": { @@ -3335,18 +3535,23 @@ $docuseal->createTemplateFromDocx([ "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -3382,11 +3587,14 @@ $docuseal->createTemplateFromDocx([ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -3448,12 +3656,16 @@ $docuseal->createTemplateFromDocx([ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -3549,7 +3761,9 @@ and typesetting industry

"html": { "type": "string", "description": "HTML template with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "html_header": { "type": "string", @@ -3562,7 +3776,9 @@ and typesetting industry

"name": { "type": "string", "description": "Template name. Random uuid will be assigned when not specified.", - "example": "Test Template" + "examples": [ + "Test Template" + ] }, "size": { "type": "string", @@ -3581,20 +3797,24 @@ and typesetting industry

"A5", "A6" ], - "example": "A4" + "examples": [ + "A4" + ] }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new HTML.", - "example": "714d974e-83d8-11ee-b962-0242ac120002" + "examples": [ + "714d974e-83d8-11ee-b962-0242ac120002" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { @@ -3609,12 +3829,16 @@ and typesetting industry

"html": { "type": "string", "description": "HTML template with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Document" + "examples": [ + "Test Document" + ] } } } @@ -3629,7 +3853,7 @@ and typesetting industry

### Clone a template -The API endpoint allows you to clone existing template into a new template. +The API endpoint allows you to clone an existing template into a new template. ```php $docuseal = new \Docuseal\Api('API_KEY', 'https://api.docuseal.com'); @@ -3659,7 +3883,7 @@ $docuseal->cloneTemplate(1000001, [ "schema": { "type": "integer" }, - "description": "The unique identifier of the documents template.", + "description": "The unique identifier of the document template.", "example": 1000001 } ], @@ -3673,7 +3897,9 @@ $docuseal->cloneTemplate(1000001, [ "name": { "type": "string", "description": "Template name. Existing name with (Clone) suffix will be used if not specified.", - "example": "Cloned Template" + "examples": [ + "Cloned Template" + ] }, "folder_name": { "type": "string", @@ -3736,15 +3962,19 @@ $docuseal->mergeTemplates([ "items": { "type": "integer" }, - "example": [ - 321, - 432 + "examples": [ + [ + 321, + 432 + ] ] }, "name": { "type": "string", "description": "Template name. Existing name with (Merged) suffix will be used if not specified.", - "example": "Merged Template" + "examples": [ + "Merged Template" + ] }, "folder_name": { "type": "string", @@ -3756,7 +3986,7 @@ $docuseal->mergeTemplates([ }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "roles": { @@ -3765,9 +3995,11 @@ $docuseal->mergeTemplates([ "items": { "type": "string" }, - "example": [ - "Agent", - "Customer" + "examples": [ + [ + "Agent", + "Customer" + ] ] } } @@ -3824,13 +4056,17 @@ $docuseal->updateTemplate(1000001, [ "properties": { "name": { "type": "string", - "description": "The name of the template", - "example": "New Document Name" + "description": "The name of the template.", + "examples": [ + "New Document Name" + ] }, "folder_name": { "type": "string", "description": "The folder's name to which the template should be moved.", - "example": "New Folder" + "examples": [ + "New Folder" + ] }, "roles": { "type": "array", @@ -3838,9 +4074,11 @@ $docuseal->updateTemplate(1000001, [ "items": { "type": "string" }, - "example": [ - "Agent", - "Customer" + "examples": [ + [ + "Agent", + "Customer" + ] ] }, "archived": { @@ -3891,7 +4129,7 @@ $docuseal->updateTemplateDocuments(1000001, [ "schema": { "type": "integer" }, - "description": "The unique identifier of the documents template.", + "description": "The unique identifier of the document template.", "example": 1000001 } ], @@ -3911,7 +4149,9 @@ $docuseal->updateTemplateDocuments(1000001, [ "name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Template" + "examples": [ + "Test Template" + ] }, "file": { "type": "string", @@ -3925,7 +4165,9 @@ $docuseal->updateTemplateDocuments(1000001, [ "position": { "type": "integer", "description": "Position of the document. By default will be added as the last document in the template.", - "example": 0 + "examples": [ + 0 + ] }, "replace": { "type": "boolean", diff --git a/docs/api/python.md b/docs/api/python.md index 28940996..92504fdc 100644 --- a/docs/api/python.md +++ b/docs/api/python.md @@ -55,7 +55,7 @@ docuseal.list_submissions({ "limit": 10 }) "schema": { "type": "string" }, - "description": "Filter submissions based on submitters name, email or phone partial match." + "description": "Filter submissions based on submitter's name, email or phone partial match." }, { "name": "slug", @@ -191,6 +191,17 @@ docuseal.get_submission_documents(1001) }, "description": "The unique identifier of the submission.", "example": 1001 + }, + { + "name": "merge", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false + }, + "description": "When `true`, merges all documents into a single PDF.", + "example": false } ] } @@ -245,7 +256,9 @@ docuseal.create_submission({ "template_id": { "type": "integer", "description": "The unique identifier of the template. Document template forms can be created via the Web UI, PDF and DOCX API, or HTML API.", - "example": 1000001 + "examples": [ + 1000001 + ] }, "send_email": { "type": "boolean", @@ -281,10 +294,22 @@ docuseal.create_submission({ "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] + }, + "variables": { + "type": "object", + "description": "Dynamic content variables object. Variable values can be strings, numbers, arrays, objects, or HTML content used to generate styled text, paragraphs, and tables in dynamic template documents.", + "examples": [ + { + "variable_name": "value" + } + ] }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -301,9 +326,6 @@ docuseal.create_submission({ "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -312,18 +334,24 @@ docuseal.create_submission({ "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -340,7 +368,9 @@ docuseal.create_submission({ "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -376,6 +406,7 @@ docuseal.create_submission({ }, "message": { "type": "object", + "description": "Custom signature request email message for the submitter.", "properties": { "subject": { "type": "string", @@ -399,7 +430,9 @@ docuseal.create_submission({ "name": { "type": "string", "description": "Document template field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -430,7 +463,9 @@ docuseal.create_submission({ } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -451,11 +486,14 @@ docuseal.create_submission({ }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -491,11 +529,14 @@ docuseal.create_submission({ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -557,12 +598,16 @@ docuseal.create_submission({ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -687,7 +732,9 @@ docuseal.create_submission_from_pdf({ "name": { "type": "string", "description": "Name of the document submission.", - "example": "Test Submission Document" + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -723,7 +770,9 @@ docuseal.create_submission_from_pdf({ "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -735,6 +784,7 @@ docuseal.create_submission_from_pdf({ }, "documents": { "type": "array", + "description": "An array of PDF documents to create a submission.", "items": { "type": "object", "required": [ @@ -747,7 +797,9 @@ docuseal.create_submission_from_pdf({ "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF file or downloadable file URL." @@ -783,6 +835,7 @@ docuseal.create_submission_from_pdf({ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -804,6 +857,7 @@ docuseal.create_submission_from_pdf({ }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "required": [ @@ -833,7 +887,9 @@ docuseal.create_submission_from_pdf({ "page": { "type": "integer", "description": "Page number of the field area. Starts from 1.", - "example": 1 + "examples": [ + 1 + ] }, "option": { "type": "string", @@ -848,9 +904,11 @@ docuseal.create_submission_from_pdf({ "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] } } @@ -868,9 +926,6 @@ docuseal.create_submission_from_pdf({ "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -879,18 +934,24 @@ docuseal.create_submission_from_pdf({ "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -907,7 +968,9 @@ docuseal.create_submission_from_pdf({ "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -957,7 +1020,9 @@ docuseal.create_submission_from_pdf({ "name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -988,7 +1053,9 @@ docuseal.create_submission_from_pdf({ } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -1009,11 +1076,14 @@ docuseal.create_submission_from_pdf({ }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -1049,11 +1119,14 @@ docuseal.create_submission_from_pdf({ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -1115,12 +1188,16 @@ docuseal.create_submission_from_pdf({ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -1170,6 +1247,7 @@ docuseal.create_submission_from_pdf({ }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -1206,7 +1284,7 @@ docuseal.create_submission_from_pdf({ ### Create a submission from DOCX -The API endpoint provides functionality to create a one-off submission request from a DOCX file with dynamic content variables. Use [[variable_name]] text tags to define dynamic content variables in the document. See https://www.docuseal.com/examples/demo_template.docx for the specific text variable syntax, including dynamic content tables and list. You can also use the {{signature}} field syntax to define fillable fields, as in a PDF.
Related Guides
Use dynamic content variables in DOCX to create personalized documents +The API endpoint provides functionality to create a one-off submission request from a DOCX file with dynamic content variables. Use [[variable_name]] text tags to define dynamic content variables in the document. See https://www.docuseal.com/examples/demo_template.docx for the specific text variable syntax, including dynamic content tables and lists. You can also use the {{signature}} field syntax to define fillable fields, as in a PDF.
Related Guides
Use dynamic content variables in DOCX to create personalized documents ```python from docuseal import docuseal @@ -1261,7 +1339,9 @@ docuseal.create_submission_from_docx({ "name": { "type": "string", "description": "Name of the document submission.", - "example": "Test Submission Document" + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -1276,9 +1356,11 @@ docuseal.create_submission_from_docx({ "variables": { "type": "object", "description": "Dynamic content variables object. Variable values can be strings, numbers, arrays, objects, or HTML content used to generate styled text, paragraphs, and tables in DOCX.", - "example": { - "variable_name": "value" - } + "examples": [ + { + "variable_name": "value" + } + ] }, "order": { "type": "string", @@ -1304,7 +1386,9 @@ docuseal.create_submission_from_docx({ "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -1316,6 +1400,7 @@ docuseal.create_submission_from_docx({ }, "documents": { "type": "array", + "description": "An array of DOCX documents to create a submission.", "items": { "type": "object", "required": [ @@ -1328,7 +1413,9 @@ docuseal.create_submission_from_docx({ "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF or DOCX file or downloadable file URL." @@ -1345,9 +1432,6 @@ docuseal.create_submission_from_docx({ "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -1356,18 +1440,24 @@ docuseal.create_submission_from_docx({ "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -1384,7 +1474,9 @@ docuseal.create_submission_from_docx({ "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -1434,7 +1526,9 @@ docuseal.create_submission_from_docx({ "name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -1465,7 +1559,9 @@ docuseal.create_submission_from_docx({ } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -1486,11 +1582,14 @@ docuseal.create_submission_from_docx({ }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -1526,11 +1625,14 @@ docuseal.create_submission_from_docx({ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -1592,12 +1694,16 @@ docuseal.create_submission_from_docx({ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -1647,6 +1753,7 @@ docuseal.create_submission_from_docx({ }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -1665,7 +1772,7 @@ docuseal.create_submission_from_docx({ }, "remove_tags": { "type": "boolean", - "description": "Pass `false` to disable the removal of {{text}} tags from the PDF. This can be used along with transparent text tags for faster and more robust PDF processing.", + "description": "Pass `false` to disable the removal of {{text}} tags from the document. This can be used along with transparent text tags for faster and more robust document processing.", "default": true } } @@ -1737,8 +1844,10 @@ and typesetting industry

"properties": { "name": { "type": "string", - "description": "Name of the document submission", - "example": "Test Submission Document" + "description": "Name of the document submission.", + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -1774,7 +1883,9 @@ and typesetting industry

"expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -1796,12 +1907,16 @@ and typesetting industry

"name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Document" + "examples": [ + "Test Document" + ] }, "html": { "type": "string", "description": "HTML document content with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "html_header": { "type": "string", @@ -1828,7 +1943,9 @@ and typesetting industry

"A5", "A6" ], - "example": "A4" + "examples": [ + "A4" + ] }, "position": { "type": "integer", @@ -1842,9 +1959,6 @@ and typesetting industry

"description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -1853,18 +1967,24 @@ and typesetting industry

"role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -1881,7 +2001,9 @@ and typesetting industry

"metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -1931,7 +2053,9 @@ and typesetting industry

"name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -1962,7 +2086,9 @@ and typesetting industry

} ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -1983,11 +2109,14 @@ and typesetting industry

}, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -2023,11 +2152,14 @@ and typesetting industry

}, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -2089,12 +2221,16 @@ and typesetting industry

"format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -2144,6 +2280,7 @@ and typesetting industry

}, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -2291,7 +2428,7 @@ docuseal.list_submissions({ "limit": 10 }) "schema": { "type": "string" }, - "description": "The unique applications-specific identifier provided for a submitter when initializing a signature request. It allows you to receive only submitters with a specified external id." + "description": "The unique application-specific identifier provided for a submitter when initializing a signature request. It allows you to receive only submitters with a specified external ID." }, { "name": "limit", @@ -2309,7 +2446,7 @@ docuseal.list_submissions({ "limit": 10 }) "schema": { "type": "integer" }, - "description": "The unique identifier of the submitter to start the list from. It allows you to receive only submitters with id greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of submitters." + "description": "The unique identifier of the submitter to start the list from. It allows you to receive only submitters with an ID greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of submitters." }, { "name": "before", @@ -2318,7 +2455,7 @@ docuseal.list_submissions({ "limit": 10 }) "schema": { "type": "integer" }, - "description": "The unique identifier of the submitter to end the list with. It allows you to receive only submitters with id less than the specified value." + "description": "The unique identifier of the submitter to end the list with. It allows you to receive only submitters with an ID less than the specified value." } ] } @@ -2424,12 +2561,16 @@ docuseal.update_submitter(500001, { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -2459,7 +2600,9 @@ docuseal.update_submitter(500001, { "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "completed_redirect_url": { "type": "string", @@ -2470,8 +2613,14 @@ docuseal.update_submitter(500001, { "description": "Set to `true` to require phone 2FA verification via a one-time code sent to the phone number in order to access the documents.", "default": false }, + "require_email_2fa": { + "type": "boolean", + "description": "Set to `true` to require email 2FA verification via a one-time code sent to the email address in order to access the documents.", + "default": false + }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -2495,7 +2644,9 @@ docuseal.update_submitter(500001, { "name": { "type": "string", "description": "Document template field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -2526,7 +2677,9 @@ docuseal.update_submitter(500001, { } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -2539,11 +2692,14 @@ docuseal.update_submitter(500001, { }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -2579,11 +2735,14 @@ docuseal.update_submitter(500001, { }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -2645,12 +2804,16 @@ docuseal.update_submitter(500001, { "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -2748,7 +2911,7 @@ docuseal.list_submissions({ "limit": 10 }) "schema": { "type": "string" }, - "description": "The unique applications-specific identifier provided for the template via API or Embedded template form builder. It allows you to receive only templates with your specified external id." + "description": "The unique application-specific identifier provided for the template via API or Embedded template form builder. It allows you to receive only templates with your specified external ID." }, { "name": "folder", @@ -2784,7 +2947,7 @@ docuseal.list_submissions({ "limit": 10 }) "schema": { "type": "integer" }, - "description": "The unique identifier of the template to start the list from. It allows you to receive only templates with id greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of templates." + "description": "The unique identifier of the template to start the list from. It allows you to receive only templates with an ID greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of templates." }, { "name": "before", @@ -2793,7 +2956,7 @@ docuseal.list_submissions({ "limit": 10 }) "schema": { "type": "integer" }, - "description": "The unique identifier of the template to end the list with. It allows you to receive only templates with id less than the specified value." + "description": "The unique identifier of the template to end the list with. It allows you to receive only templates with an ID less than the specified value." } ] } @@ -2900,25 +3063,30 @@ docuseal.create_template_from_pdf({ "properties": { "name": { "type": "string", - "description": "Name of the template", - "example": "Test PDF" + "description": "Name of the template.", + "examples": [ + "Test PDF" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new PDF.", - "example": "unique-key" + "examples": [ + "unique-key" + ] }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { "type": "array", + "description": "An array of PDF documents to create a template.", "items": { "type": "object", "required": [ @@ -2931,7 +3099,9 @@ docuseal.create_template_from_pdf({ "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF file or downloadable file URL." @@ -2967,6 +3137,7 @@ docuseal.create_template_from_pdf({ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -2988,6 +3159,7 @@ docuseal.create_template_from_pdf({ }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "required": [ @@ -3017,7 +3189,9 @@ docuseal.create_template_from_pdf({ "page": { "type": "integer", "description": "Page number of the field area. Starts from 1.", - "example": 1 + "examples": [ + 1 + ] }, "option": { "type": "string", @@ -3032,18 +3206,23 @@ docuseal.create_template_from_pdf({ "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -3079,11 +3258,14 @@ docuseal.create_template_from_pdf({ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -3145,12 +3327,16 @@ docuseal.create_template_from_pdf({ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -3211,7 +3397,7 @@ docuseal.create_template_from_pdf({ ### Create a template from Word DOCX -The API endpoint provides the functionality to create a fillable document template for existing Microsoft Word document. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See https://www.docuseal.com/examples/fieldtags.docx for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.
Related Guides
Use embedded text field tags to create a fillable form +The API endpoint provides the functionality to create a fillable document template for an existing Microsoft Word document. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See https://www.docuseal.com/examples/fieldtags.docx for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.
Related Guides
Use embedded text field tags to create a fillable form ```python @@ -3256,25 +3442,30 @@ docuseal.create_template_from_docx({ "properties": { "name": { "type": "string", - "description": "Name of the template", - "example": "Test DOCX" + "description": "Name of the template.", + "examples": [ + "Test DOCX" + ] }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new document.", - "example": "unique-key" + "examples": [ + "unique-key" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { "type": "array", + "description": "An array of DOCX documents to create a template.", "items": { "type": "object", "required": [ @@ -3288,9 +3479,16 @@ docuseal.create_template_from_docx({ }, "file": { "type": "string", - "example": "base64", + "examples": [ + "base64" + ], "format": "base64", - "description": "Base64-encoded content of the DOCX file or downloadable file URL" + "description": "Base64-encoded content of the DOCX file or downloadable file URL." + }, + "dynamic": { + "type": "boolean", + "description": "Set to `true` to make the document dynamic. When enabled, the DOCX document content can be edited or use [[variables]] in the template editor.", + "default": false }, "fields": { "description": "Fields are optional if you use {{...}} text tags to define fields in the document.", @@ -3323,6 +3521,7 @@ docuseal.create_template_from_docx({ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -3344,6 +3543,7 @@ docuseal.create_template_from_docx({ }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "properties": { @@ -3380,18 +3580,23 @@ docuseal.create_template_from_docx({ "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -3427,11 +3632,14 @@ docuseal.create_template_from_docx({ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -3493,12 +3701,16 @@ docuseal.create_template_from_docx({ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -3597,7 +3809,9 @@ and typesetting industry

"html": { "type": "string", "description": "HTML template with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "html_header": { "type": "string", @@ -3610,7 +3824,9 @@ and typesetting industry

"name": { "type": "string", "description": "Template name. Random uuid will be assigned when not specified.", - "example": "Test Template" + "examples": [ + "Test Template" + ] }, "size": { "type": "string", @@ -3629,20 +3845,24 @@ and typesetting industry

"A5", "A6" ], - "example": "A4" + "examples": [ + "A4" + ] }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new HTML.", - "example": "714d974e-83d8-11ee-b962-0242ac120002" + "examples": [ + "714d974e-83d8-11ee-b962-0242ac120002" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { @@ -3657,12 +3877,16 @@ and typesetting industry

"html": { "type": "string", "description": "HTML template with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Document" + "examples": [ + "Test Document" + ] } } } @@ -3677,7 +3901,7 @@ and typesetting industry

### Clone a template -The API endpoint allows you to clone existing template into a new template. +The API endpoint allows you to clone an existing template into a new template. ```python from docuseal import docuseal @@ -3710,7 +3934,7 @@ docuseal.clone_template(1000001, { "schema": { "type": "integer" }, - "description": "The unique identifier of the documents template.", + "description": "The unique identifier of the document template.", "example": 1000001 } ], @@ -3724,7 +3948,9 @@ docuseal.clone_template(1000001, { "name": { "type": "string", "description": "Template name. Existing name with (Clone) suffix will be used if not specified.", - "example": "Cloned Template" + "examples": [ + "Cloned Template" + ] }, "folder_name": { "type": "string", @@ -3790,15 +4016,19 @@ docuseal.merge_templates({ "items": { "type": "integer" }, - "example": [ - 321, - 432 + "examples": [ + [ + 321, + 432 + ] ] }, "name": { "type": "string", "description": "Template name. Existing name with (Merged) suffix will be used if not specified.", - "example": "Merged Template" + "examples": [ + "Merged Template" + ] }, "folder_name": { "type": "string", @@ -3810,7 +4040,7 @@ docuseal.merge_templates({ }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "roles": { @@ -3819,9 +4049,11 @@ docuseal.merge_templates({ "items": { "type": "string" }, - "example": [ - "Agent", - "Customer" + "examples": [ + [ + "Agent", + "Customer" + ] ] } } @@ -3881,13 +4113,17 @@ docuseal.update_template(1000001, { "properties": { "name": { "type": "string", - "description": "The name of the template", - "example": "New Document Name" + "description": "The name of the template.", + "examples": [ + "New Document Name" + ] }, "folder_name": { "type": "string", "description": "The folder's name to which the template should be moved.", - "example": "New Folder" + "examples": [ + "New Folder" + ] }, "roles": { "type": "array", @@ -3895,9 +4131,11 @@ docuseal.update_template(1000001, { "items": { "type": "string" }, - "example": [ - "Agent", - "Customer" + "examples": [ + [ + "Agent", + "Customer" + ] ] }, "archived": { @@ -3951,7 +4189,7 @@ docuseal.update_template_documents(1000001, { "schema": { "type": "integer" }, - "description": "The unique identifier of the documents template.", + "description": "The unique identifier of the document template.", "example": 1000001 } ], @@ -3971,7 +4209,9 @@ docuseal.update_template_documents(1000001, { "name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Template" + "examples": [ + "Test Template" + ] }, "file": { "type": "string", @@ -3985,7 +4225,9 @@ docuseal.update_template_documents(1000001, { "position": { "type": "integer", "description": "Position of the document. By default will be added as the last document in the template.", - "example": 0 + "examples": [ + 0 + ] }, "replace": { "type": "boolean", diff --git a/docs/api/ruby.md b/docs/api/ruby.md index cb5a84aa..1f22d82c 100644 --- a/docs/api/ruby.md +++ b/docs/api/ruby.md @@ -55,7 +55,7 @@ Docuseal.list_submissions(limit: 10) "schema": { "type": "string" }, - "description": "Filter submissions based on submitters name, email or phone partial match." + "description": "Filter submissions based on submitter's name, email or phone partial match." }, { "name": "slug", @@ -191,6 +191,17 @@ Docuseal.get_submission_documents(1001) }, "description": "The unique identifier of the submission.", "example": 1001 + }, + { + "name": "merge", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false + }, + "description": "When `true`, merges all documents into a single PDF.", + "example": false } ] } @@ -245,7 +256,9 @@ Docuseal.create_submission({ "template_id": { "type": "integer", "description": "The unique identifier of the template. Document template forms can be created via the Web UI, PDF and DOCX API, or HTML API.", - "example": 1000001 + "examples": [ + 1000001 + ] }, "send_email": { "type": "boolean", @@ -281,10 +294,22 @@ Docuseal.create_submission({ "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] + }, + "variables": { + "type": "object", + "description": "Dynamic content variables object. Variable values can be strings, numbers, arrays, objects, or HTML content used to generate styled text, paragraphs, and tables in dynamic template documents.", + "examples": [ + { + "variable_name": "value" + } + ] }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -301,9 +326,6 @@ Docuseal.create_submission({ "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -312,18 +334,24 @@ Docuseal.create_submission({ "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -340,7 +368,9 @@ Docuseal.create_submission({ "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -376,6 +406,7 @@ Docuseal.create_submission({ }, "message": { "type": "object", + "description": "Custom signature request email message for the submitter.", "properties": { "subject": { "type": "string", @@ -399,7 +430,9 @@ Docuseal.create_submission({ "name": { "type": "string", "description": "Document template field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -430,7 +463,9 @@ Docuseal.create_submission({ } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -451,11 +486,14 @@ Docuseal.create_submission({ }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -491,11 +529,14 @@ Docuseal.create_submission({ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -557,12 +598,16 @@ Docuseal.create_submission({ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -687,7 +732,9 @@ Docuseal.create_submission_from_pdf({ "name": { "type": "string", "description": "Name of the document submission.", - "example": "Test Submission Document" + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -723,7 +770,9 @@ Docuseal.create_submission_from_pdf({ "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -735,6 +784,7 @@ Docuseal.create_submission_from_pdf({ }, "documents": { "type": "array", + "description": "An array of PDF documents to create a submission.", "items": { "type": "object", "required": [ @@ -747,7 +797,9 @@ Docuseal.create_submission_from_pdf({ "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF file or downloadable file URL." @@ -783,6 +835,7 @@ Docuseal.create_submission_from_pdf({ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -804,6 +857,7 @@ Docuseal.create_submission_from_pdf({ }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "required": [ @@ -833,7 +887,9 @@ Docuseal.create_submission_from_pdf({ "page": { "type": "integer", "description": "Page number of the field area. Starts from 1.", - "example": 1 + "examples": [ + 1 + ] }, "option": { "type": "string", @@ -848,9 +904,11 @@ Docuseal.create_submission_from_pdf({ "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] } } @@ -868,9 +926,6 @@ Docuseal.create_submission_from_pdf({ "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -879,18 +934,24 @@ Docuseal.create_submission_from_pdf({ "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -907,7 +968,9 @@ Docuseal.create_submission_from_pdf({ "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -957,7 +1020,9 @@ Docuseal.create_submission_from_pdf({ "name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -988,7 +1053,9 @@ Docuseal.create_submission_from_pdf({ } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -1009,11 +1076,14 @@ Docuseal.create_submission_from_pdf({ }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -1049,11 +1119,14 @@ Docuseal.create_submission_from_pdf({ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -1115,12 +1188,16 @@ Docuseal.create_submission_from_pdf({ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -1170,6 +1247,7 @@ Docuseal.create_submission_from_pdf({ }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -1206,7 +1284,7 @@ Docuseal.create_submission_from_pdf({ ### Create a submission from DOCX -The API endpoint provides functionality to create a one-off submission request from a DOCX file with dynamic content variables. Use [[variable_name]] text tags to define dynamic content variables in the document. See https://www.docuseal.com/examples/demo_template.docx for the specific text variable syntax, including dynamic content tables and list. You can also use the {{signature}} field syntax to define fillable fields, as in a PDF.
Related Guides
Use dynamic content variables in DOCX to create personalized documents +The API endpoint provides functionality to create a one-off submission request from a DOCX file with dynamic content variables. Use [[variable_name]] text tags to define dynamic content variables in the document. See https://www.docuseal.com/examples/demo_template.docx for the specific text variable syntax, including dynamic content tables and lists. You can also use the {{signature}} field syntax to define fillable fields, as in a PDF.
Related Guides
Use dynamic content variables in DOCX to create personalized documents ```ruby require "docuseal" @@ -1261,7 +1339,9 @@ Docuseal.create_submission_from_docx({ "name": { "type": "string", "description": "Name of the document submission.", - "example": "Test Submission Document" + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -1276,9 +1356,11 @@ Docuseal.create_submission_from_docx({ "variables": { "type": "object", "description": "Dynamic content variables object. Variable values can be strings, numbers, arrays, objects, or HTML content used to generate styled text, paragraphs, and tables in DOCX.", - "example": { - "variable_name": "value" - } + "examples": [ + { + "variable_name": "value" + } + ] }, "order": { "type": "string", @@ -1304,7 +1386,9 @@ Docuseal.create_submission_from_docx({ "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -1316,6 +1400,7 @@ Docuseal.create_submission_from_docx({ }, "documents": { "type": "array", + "description": "An array of DOCX documents to create a submission.", "items": { "type": "object", "required": [ @@ -1328,7 +1413,9 @@ Docuseal.create_submission_from_docx({ "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF or DOCX file or downloadable file URL." @@ -1345,9 +1432,6 @@ Docuseal.create_submission_from_docx({ "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -1356,18 +1440,24 @@ Docuseal.create_submission_from_docx({ "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -1384,7 +1474,9 @@ Docuseal.create_submission_from_docx({ "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -1434,7 +1526,9 @@ Docuseal.create_submission_from_docx({ "name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -1465,7 +1559,9 @@ Docuseal.create_submission_from_docx({ } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -1486,11 +1582,14 @@ Docuseal.create_submission_from_docx({ }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -1526,11 +1625,14 @@ Docuseal.create_submission_from_docx({ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -1592,12 +1694,16 @@ Docuseal.create_submission_from_docx({ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -1647,6 +1753,7 @@ Docuseal.create_submission_from_docx({ }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -1665,7 +1772,7 @@ Docuseal.create_submission_from_docx({ }, "remove_tags": { "type": "boolean", - "description": "Pass `false` to disable the removal of {{text}} tags from the PDF. This can be used along with transparent text tags for faster and more robust PDF processing.", + "description": "Pass `false` to disable the removal of {{text}} tags from the document. This can be used along with transparent text tags for faster and more robust document processing.", "default": true } } @@ -1737,8 +1844,10 @@ and typesetting industry

"properties": { "name": { "type": "string", - "description": "Name of the document submission", - "example": "Test Submission Document" + "description": "Name of the document submission.", + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -1774,7 +1883,9 @@ and typesetting industry

"expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -1796,12 +1907,16 @@ and typesetting industry

"name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Document" + "examples": [ + "Test Document" + ] }, "html": { "type": "string", "description": "HTML document content with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "html_header": { "type": "string", @@ -1828,7 +1943,9 @@ and typesetting industry

"A5", "A6" ], - "example": "A4" + "examples": [ + "A4" + ] }, "position": { "type": "integer", @@ -1842,9 +1959,6 @@ and typesetting industry

"description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -1853,18 +1967,24 @@ and typesetting industry

"role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -1881,7 +2001,9 @@ and typesetting industry

"metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -1931,7 +2053,9 @@ and typesetting industry

"name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -1962,7 +2086,9 @@ and typesetting industry

} ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -1983,11 +2109,14 @@ and typesetting industry

}, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -2023,11 +2152,14 @@ and typesetting industry

}, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -2089,12 +2221,16 @@ and typesetting industry

"format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -2144,6 +2280,7 @@ and typesetting industry

}, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -2291,7 +2428,7 @@ Docuseal.list_submitters(limit: 10) "schema": { "type": "string" }, - "description": "The unique applications-specific identifier provided for a submitter when initializing a signature request. It allows you to receive only submitters with a specified external id." + "description": "The unique application-specific identifier provided for a submitter when initializing a signature request. It allows you to receive only submitters with a specified external ID." }, { "name": "limit", @@ -2309,7 +2446,7 @@ Docuseal.list_submitters(limit: 10) "schema": { "type": "integer" }, - "description": "The unique identifier of the submitter to start the list from. It allows you to receive only submitters with id greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of submitters." + "description": "The unique identifier of the submitter to start the list from. It allows you to receive only submitters with an ID greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of submitters." }, { "name": "before", @@ -2318,7 +2455,7 @@ Docuseal.list_submitters(limit: 10) "schema": { "type": "integer" }, - "description": "The unique identifier of the submitter to end the list with. It allows you to receive only submitters with id less than the specified value." + "description": "The unique identifier of the submitter to end the list with. It allows you to receive only submitters with an ID less than the specified value." } ] } @@ -2424,12 +2561,16 @@ Docuseal.update_submitter(500001, { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -2459,7 +2600,9 @@ Docuseal.update_submitter(500001, { "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "completed_redirect_url": { "type": "string", @@ -2470,8 +2613,14 @@ Docuseal.update_submitter(500001, { "description": "Set to `true` to require phone 2FA verification via a one-time code sent to the phone number in order to access the documents.", "default": false }, + "require_email_2fa": { + "type": "boolean", + "description": "Set to `true` to require email 2FA verification via a one-time code sent to the email address in order to access the documents.", + "default": false + }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -2495,7 +2644,9 @@ Docuseal.update_submitter(500001, { "name": { "type": "string", "description": "Document template field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -2526,7 +2677,9 @@ Docuseal.update_submitter(500001, { } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -2539,11 +2692,14 @@ Docuseal.update_submitter(500001, { }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -2579,11 +2735,14 @@ Docuseal.update_submitter(500001, { }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -2645,12 +2804,16 @@ Docuseal.update_submitter(500001, { "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -2748,7 +2911,7 @@ Docuseal.list_templates(limit: 10) "schema": { "type": "string" }, - "description": "The unique applications-specific identifier provided for the template via API or Embedded template form builder. It allows you to receive only templates with your specified external id." + "description": "The unique application-specific identifier provided for the template via API or Embedded template form builder. It allows you to receive only templates with your specified external ID." }, { "name": "folder", @@ -2784,7 +2947,7 @@ Docuseal.list_templates(limit: 10) "schema": { "type": "integer" }, - "description": "The unique identifier of the template to start the list from. It allows you to receive only templates with id greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of templates." + "description": "The unique identifier of the template to start the list from. It allows you to receive only templates with an ID greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of templates." }, { "name": "before", @@ -2793,7 +2956,7 @@ Docuseal.list_templates(limit: 10) "schema": { "type": "integer" }, - "description": "The unique identifier of the template to end the list with. It allows you to receive only templates with id less than the specified value." + "description": "The unique identifier of the template to end the list with. It allows you to receive only templates with an ID less than the specified value." } ] } @@ -2900,25 +3063,30 @@ Docuseal.create_template_from_pdf({ "properties": { "name": { "type": "string", - "description": "Name of the template", - "example": "Test PDF" + "description": "Name of the template.", + "examples": [ + "Test PDF" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new PDF.", - "example": "unique-key" + "examples": [ + "unique-key" + ] }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { "type": "array", + "description": "An array of PDF documents to create a template.", "items": { "type": "object", "required": [ @@ -2931,7 +3099,9 @@ Docuseal.create_template_from_pdf({ "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF file or downloadable file URL." @@ -2967,6 +3137,7 @@ Docuseal.create_template_from_pdf({ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -2988,6 +3159,7 @@ Docuseal.create_template_from_pdf({ }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "required": [ @@ -3017,7 +3189,9 @@ Docuseal.create_template_from_pdf({ "page": { "type": "integer", "description": "Page number of the field area. Starts from 1.", - "example": 1 + "examples": [ + 1 + ] }, "option": { "type": "string", @@ -3032,18 +3206,23 @@ Docuseal.create_template_from_pdf({ "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -3079,11 +3258,14 @@ Docuseal.create_template_from_pdf({ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -3145,12 +3327,16 @@ Docuseal.create_template_from_pdf({ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -3211,7 +3397,7 @@ Docuseal.create_template_from_pdf({ ### Create a template from Word DOCX -The API endpoint provides the functionality to create a fillable document template for existing Microsoft Word document. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See https://www.docuseal.com/examples/fieldtags.docx for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.
Related Guides
Use embedded text field tags to create a fillable form +The API endpoint provides the functionality to create a fillable document template for an existing Microsoft Word document. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See https://www.docuseal.com/examples/fieldtags.docx for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.
Related Guides
Use embedded text field tags to create a fillable form ```ruby @@ -3256,25 +3442,30 @@ Docuseal.create_template_from_docx({ "properties": { "name": { "type": "string", - "description": "Name of the template", - "example": "Test DOCX" + "description": "Name of the template.", + "examples": [ + "Test DOCX" + ] }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new document.", - "example": "unique-key" + "examples": [ + "unique-key" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { "type": "array", + "description": "An array of DOCX documents to create a template.", "items": { "type": "object", "required": [ @@ -3288,9 +3479,16 @@ Docuseal.create_template_from_docx({ }, "file": { "type": "string", - "example": "base64", + "examples": [ + "base64" + ], "format": "base64", - "description": "Base64-encoded content of the DOCX file or downloadable file URL" + "description": "Base64-encoded content of the DOCX file or downloadable file URL." + }, + "dynamic": { + "type": "boolean", + "description": "Set to `true` to make the document dynamic. When enabled, the DOCX document content can be edited or use [[variables]] in the template editor.", + "default": false }, "fields": { "description": "Fields are optional if you use {{...}} text tags to define fields in the document.", @@ -3323,6 +3521,7 @@ Docuseal.create_template_from_docx({ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -3344,6 +3543,7 @@ Docuseal.create_template_from_docx({ }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "properties": { @@ -3380,18 +3580,23 @@ Docuseal.create_template_from_docx({ "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -3427,11 +3632,14 @@ Docuseal.create_template_from_docx({ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -3493,12 +3701,16 @@ Docuseal.create_template_from_docx({ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -3597,7 +3809,9 @@ and typesetting industry

"html": { "type": "string", "description": "HTML template with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "html_header": { "type": "string", @@ -3610,7 +3824,9 @@ and typesetting industry

"name": { "type": "string", "description": "Template name. Random uuid will be assigned when not specified.", - "example": "Test Template" + "examples": [ + "Test Template" + ] }, "size": { "type": "string", @@ -3629,20 +3845,24 @@ and typesetting industry

"A5", "A6" ], - "example": "A4" + "examples": [ + "A4" + ] }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new HTML.", - "example": "714d974e-83d8-11ee-b962-0242ac120002" + "examples": [ + "714d974e-83d8-11ee-b962-0242ac120002" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { @@ -3657,12 +3877,16 @@ and typesetting industry

"html": { "type": "string", "description": "HTML template with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Document" + "examples": [ + "Test Document" + ] } } } @@ -3677,7 +3901,7 @@ and typesetting industry

### Clone a template -The API endpoint allows you to clone existing template into a new template. +The API endpoint allows you to clone an existing template into a new template. ```ruby require "docuseal" @@ -3710,7 +3934,7 @@ Docuseal.clone_template(1000001, { "schema": { "type": "integer" }, - "description": "The unique identifier of the documents template.", + "description": "The unique identifier of the document template.", "example": 1000001 } ], @@ -3724,7 +3948,9 @@ Docuseal.clone_template(1000001, { "name": { "type": "string", "description": "Template name. Existing name with (Clone) suffix will be used if not specified.", - "example": "Cloned Template" + "examples": [ + "Cloned Template" + ] }, "folder_name": { "type": "string", @@ -3790,15 +4016,19 @@ Docuseal.merge_templates({ "items": { "type": "integer" }, - "example": [ - 321, - 432 + "examples": [ + [ + 321, + 432 + ] ] }, "name": { "type": "string", "description": "Template name. Existing name with (Merged) suffix will be used if not specified.", - "example": "Merged Template" + "examples": [ + "Merged Template" + ] }, "folder_name": { "type": "string", @@ -3810,7 +4040,7 @@ Docuseal.merge_templates({ }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "roles": { @@ -3819,9 +4049,11 @@ Docuseal.merge_templates({ "items": { "type": "string" }, - "example": [ - "Agent", - "Customer" + "examples": [ + [ + "Agent", + "Customer" + ] ] } } @@ -3881,13 +4113,17 @@ Docuseal.update_template(1000001, { "properties": { "name": { "type": "string", - "description": "The name of the template", - "example": "New Document Name" + "description": "The name of the template.", + "examples": [ + "New Document Name" + ] }, "folder_name": { "type": "string", "description": "The folder's name to which the template should be moved.", - "example": "New Folder" + "examples": [ + "New Folder" + ] }, "roles": { "type": "array", @@ -3895,9 +4131,11 @@ Docuseal.update_template(1000001, { "items": { "type": "string" }, - "example": [ - "Agent", - "Customer" + "examples": [ + [ + "Agent", + "Customer" + ] ] }, "archived": { @@ -3951,7 +4189,7 @@ Docuseal.update_template_documents(1000001, { "schema": { "type": "integer" }, - "description": "The unique identifier of the documents template.", + "description": "The unique identifier of the document template.", "example": 1000001 } ], @@ -3971,7 +4209,9 @@ Docuseal.update_template_documents(1000001, { "name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Template" + "examples": [ + "Test Template" + ] }, "file": { "type": "string", @@ -3985,7 +4225,9 @@ Docuseal.update_template_documents(1000001, { "position": { "type": "integer", "description": "Position of the document. By default will be added as the last document in the template.", - "example": 0 + "examples": [ + 0 + ] }, "replace": { "type": "boolean", diff --git a/docs/api/shell.md b/docs/api/shell.md index 1e0b6cf1..aff9efa1 100644 --- a/docs/api/shell.md +++ b/docs/api/shell.md @@ -52,7 +52,7 @@ curl --request GET \ "schema": { "type": "string" }, - "description": "Filter submissions based on submitters name, email or phone partial match." + "description": "Filter submissions based on submitter's name, email or phone partial match." }, { "name": "slug", @@ -182,6 +182,17 @@ curl --request GET \ }, "description": "The unique identifier of the submission.", "example": 1001 + }, + { + "name": "merge", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false + }, + "description": "When `true`, merges all documents into a single PDF.", + "example": false } ] } @@ -226,7 +237,9 @@ curl --request POST \ "template_id": { "type": "integer", "description": "The unique identifier of the template. Document template forms can be created via the Web UI, PDF and DOCX API, or HTML API.", - "example": 1000001 + "examples": [ + 1000001 + ] }, "send_email": { "type": "boolean", @@ -262,10 +275,22 @@ curl --request POST \ "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] + }, + "variables": { + "type": "object", + "description": "Dynamic content variables object. Variable values can be strings, numbers, arrays, objects, or HTML content used to generate styled text, paragraphs, and tables in dynamic template documents.", + "examples": [ + { + "variable_name": "value" + } + ] }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -282,9 +307,6 @@ curl --request POST \ "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -293,18 +315,24 @@ curl --request POST \ "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -321,7 +349,9 @@ curl --request POST \ "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -357,6 +387,7 @@ curl --request POST \ }, "message": { "type": "object", + "description": "Custom signature request email message for the submitter.", "properties": { "subject": { "type": "string", @@ -380,7 +411,9 @@ curl --request POST \ "name": { "type": "string", "description": "Document template field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -411,7 +444,9 @@ curl --request POST \ } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -432,11 +467,14 @@ curl --request POST \ }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -472,11 +510,14 @@ curl --request POST \ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -538,12 +579,16 @@ curl --request POST \ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -639,7 +684,9 @@ curl --request POST \ "name": { "type": "string", "description": "Name of the document submission.", - "example": "Test Submission Document" + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -675,7 +722,9 @@ curl --request POST \ "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -687,6 +736,7 @@ curl --request POST \ }, "documents": { "type": "array", + "description": "An array of PDF documents to create a submission.", "items": { "type": "object", "required": [ @@ -699,7 +749,9 @@ curl --request POST \ "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF file or downloadable file URL." @@ -735,6 +787,7 @@ curl --request POST \ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -756,6 +809,7 @@ curl --request POST \ }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "required": [ @@ -785,7 +839,9 @@ curl --request POST \ "page": { "type": "integer", "description": "Page number of the field area. Starts from 1.", - "example": 1 + "examples": [ + 1 + ] }, "option": { "type": "string", @@ -800,9 +856,11 @@ curl --request POST \ "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] } } @@ -820,9 +878,6 @@ curl --request POST \ "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -831,18 +886,24 @@ curl --request POST \ "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -859,7 +920,9 @@ curl --request POST \ "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -909,7 +972,9 @@ curl --request POST \ "name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -940,7 +1005,9 @@ curl --request POST \ } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -961,11 +1028,14 @@ curl --request POST \ }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -1001,11 +1071,14 @@ curl --request POST \ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -1067,12 +1140,16 @@ curl --request POST \ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -1122,6 +1199,7 @@ curl --request POST \ }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -1158,7 +1236,7 @@ curl --request POST \ ### Create a submission from DOCX -The API endpoint provides functionality to create a one-off submission request from a DOCX file with dynamic content variables. Use [[variable_name]] text tags to define dynamic content variables in the document. See https://www.docuseal.com/examples/demo_template.docx for the specific text variable syntax, including dynamic content tables and list. You can also use the {{signature}} field syntax to define fillable fields, as in a PDF.
Related Guides
Use dynamic content variables in DOCX to create personalized documents +The API endpoint provides functionality to create a one-off submission request from a DOCX file with dynamic content variables. Use [[variable_name]] text tags to define dynamic content variables in the document. See https://www.docuseal.com/examples/demo_template.docx for the specific text variable syntax, including dynamic content tables and lists. You can also use the {{signature}} field syntax to define fillable fields, as in a PDF.
Related Guides
Use dynamic content variables in DOCX to create personalized documents ```shell curl --request POST \ @@ -1195,7 +1273,9 @@ curl --request POST \ "name": { "type": "string", "description": "Name of the document submission.", - "example": "Test Submission Document" + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -1210,9 +1290,11 @@ curl --request POST \ "variables": { "type": "object", "description": "Dynamic content variables object. Variable values can be strings, numbers, arrays, objects, or HTML content used to generate styled text, paragraphs, and tables in DOCX.", - "example": { - "variable_name": "value" - } + "examples": [ + { + "variable_name": "value" + } + ] }, "order": { "type": "string", @@ -1238,7 +1320,9 @@ curl --request POST \ "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -1250,6 +1334,7 @@ curl --request POST \ }, "documents": { "type": "array", + "description": "An array of DOCX documents to create a submission.", "items": { "type": "object", "required": [ @@ -1262,7 +1347,9 @@ curl --request POST \ "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF or DOCX file or downloadable file URL." @@ -1279,9 +1366,6 @@ curl --request POST \ "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -1290,18 +1374,24 @@ curl --request POST \ "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -1318,7 +1408,9 @@ curl --request POST \ "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -1368,7 +1460,9 @@ curl --request POST \ "name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -1399,7 +1493,9 @@ curl --request POST \ } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -1420,11 +1516,14 @@ curl --request POST \ }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -1460,11 +1559,14 @@ curl --request POST \ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -1526,12 +1628,16 @@ curl --request POST \ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -1581,6 +1687,7 @@ curl --request POST \ }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -1599,7 +1706,7 @@ curl --request POST \ }, "remove_tags": { "type": "boolean", - "description": "Pass `false` to disable the removal of {{text}} tags from the PDF. This can be used along with transparent text tags for faster and more robust PDF processing.", + "description": "Pass `false` to disable the removal of {{text}} tags from the document. This can be used along with transparent text tags for faster and more robust document processing.", "default": true } } @@ -1648,8 +1755,10 @@ curl --request POST \ "properties": { "name": { "type": "string", - "description": "Name of the document submission", - "example": "Test Submission Document" + "description": "Name of the document submission.", + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -1685,7 +1794,9 @@ curl --request POST \ "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -1707,12 +1818,16 @@ curl --request POST \ "name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Document" + "examples": [ + "Test Document" + ] }, "html": { "type": "string", "description": "HTML document content with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "html_header": { "type": "string", @@ -1739,7 +1854,9 @@ curl --request POST \ "A5", "A6" ], - "example": "A4" + "examples": [ + "A4" + ] }, "position": { "type": "integer", @@ -1753,9 +1870,6 @@ curl --request POST \ "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -1764,18 +1878,24 @@ curl --request POST \ "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -1792,7 +1912,9 @@ curl --request POST \ "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -1842,7 +1964,9 @@ curl --request POST \ "name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -1873,7 +1997,9 @@ curl --request POST \ } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -1894,11 +2020,14 @@ curl --request POST \ }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -1934,11 +2063,14 @@ curl --request POST \ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -2000,12 +2132,16 @@ curl --request POST \ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -2055,6 +2191,7 @@ curl --request POST \ }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -2196,7 +2333,7 @@ curl --request GET \ "schema": { "type": "string" }, - "description": "The unique applications-specific identifier provided for a submitter when initializing a signature request. It allows you to receive only submitters with a specified external id." + "description": "The unique application-specific identifier provided for a submitter when initializing a signature request. It allows you to receive only submitters with a specified external ID." }, { "name": "limit", @@ -2214,7 +2351,7 @@ curl --request GET \ "schema": { "type": "integer" }, - "description": "The unique identifier of the submitter to start the list from. It allows you to receive only submitters with id greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of submitters." + "description": "The unique identifier of the submitter to start the list from. It allows you to receive only submitters with an ID greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of submitters." }, { "name": "before", @@ -2223,7 +2360,7 @@ curl --request GET \ "schema": { "type": "integer" }, - "description": "The unique identifier of the submitter to end the list with. It allows you to receive only submitters with id less than the specified value." + "description": "The unique identifier of the submitter to end the list with. It allows you to receive only submitters with an ID less than the specified value." } ] } @@ -2317,12 +2454,16 @@ curl --request PUT \ "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -2352,7 +2493,9 @@ curl --request PUT \ "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "completed_redirect_url": { "type": "string", @@ -2363,8 +2506,14 @@ curl --request PUT \ "description": "Set to `true` to require phone 2FA verification via a one-time code sent to the phone number in order to access the documents.", "default": false }, + "require_email_2fa": { + "type": "boolean", + "description": "Set to `true` to require email 2FA verification via a one-time code sent to the email address in order to access the documents.", + "default": false + }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -2388,7 +2537,9 @@ curl --request PUT \ "name": { "type": "string", "description": "Document template field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -2419,7 +2570,9 @@ curl --request PUT \ } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -2432,11 +2585,14 @@ curl --request PUT \ }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -2472,11 +2628,14 @@ curl --request PUT \ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -2538,12 +2697,16 @@ curl --request PUT \ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -2638,7 +2801,7 @@ curl --request GET \ "schema": { "type": "string" }, - "description": "The unique applications-specific identifier provided for the template via API or Embedded template form builder. It allows you to receive only templates with your specified external id." + "description": "The unique application-specific identifier provided for the template via API or Embedded template form builder. It allows you to receive only templates with your specified external ID." }, { "name": "folder", @@ -2674,7 +2837,7 @@ curl --request GET \ "schema": { "type": "integer" }, - "description": "The unique identifier of the template to start the list from. It allows you to receive only templates with id greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of templates." + "description": "The unique identifier of the template to start the list from. It allows you to receive only templates with an ID greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of templates." }, { "name": "before", @@ -2683,7 +2846,7 @@ curl --request GET \ "schema": { "type": "integer" }, - "description": "The unique identifier of the template to end the list with. It allows you to receive only templates with id less than the specified value." + "description": "The unique identifier of the template to end the list with. It allows you to receive only templates with an ID less than the specified value." } ] } @@ -2764,25 +2927,30 @@ curl --request POST \ "properties": { "name": { "type": "string", - "description": "Name of the template", - "example": "Test PDF" + "description": "Name of the template.", + "examples": [ + "Test PDF" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new PDF.", - "example": "unique-key" + "examples": [ + "unique-key" + ] }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { "type": "array", + "description": "An array of PDF documents to create a template.", "items": { "type": "object", "required": [ @@ -2795,7 +2963,9 @@ curl --request POST \ "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF file or downloadable file URL." @@ -2831,6 +3001,7 @@ curl --request POST \ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -2852,6 +3023,7 @@ curl --request POST \ }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "required": [ @@ -2881,7 +3053,9 @@ curl --request POST \ "page": { "type": "integer", "description": "Page number of the field area. Starts from 1.", - "example": 1 + "examples": [ + 1 + ] }, "option": { "type": "string", @@ -2896,18 +3070,23 @@ curl --request POST \ "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -2943,11 +3122,14 @@ curl --request POST \ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -3009,12 +3191,16 @@ curl --request POST \ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -3075,7 +3261,7 @@ curl --request POST \ ### Create a template from Word DOCX -The API endpoint provides the functionality to create a fillable document template for existing Microsoft Word document. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See https://www.docuseal.com/examples/fieldtags.docx for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.
Related Guides
Use embedded text field tags to create a fillable form +The API endpoint provides the functionality to create a fillable document template for an existing Microsoft Word document. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See https://www.docuseal.com/examples/fieldtags.docx for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.
Related Guides
Use embedded text field tags to create a fillable form ```shell @@ -3111,25 +3297,30 @@ curl --request POST \ "properties": { "name": { "type": "string", - "description": "Name of the template", - "example": "Test DOCX" + "description": "Name of the template.", + "examples": [ + "Test DOCX" + ] }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new document.", - "example": "unique-key" + "examples": [ + "unique-key" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { "type": "array", + "description": "An array of DOCX documents to create a template.", "items": { "type": "object", "required": [ @@ -3143,9 +3334,16 @@ curl --request POST \ }, "file": { "type": "string", - "example": "base64", + "examples": [ + "base64" + ], "format": "base64", - "description": "Base64-encoded content of the DOCX file or downloadable file URL" + "description": "Base64-encoded content of the DOCX file or downloadable file URL." + }, + "dynamic": { + "type": "boolean", + "description": "Set to `true` to make the document dynamic. When enabled, the DOCX document content can be edited or use [[variables]] in the template editor.", + "default": false }, "fields": { "description": "Fields are optional if you use {{...}} text tags to define fields in the document.", @@ -3178,6 +3376,7 @@ curl --request POST \ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -3199,6 +3398,7 @@ curl --request POST \ }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "properties": { @@ -3235,18 +3435,23 @@ curl --request POST \ "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -3282,11 +3487,14 @@ curl --request POST \ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -3348,12 +3556,16 @@ curl --request POST \ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -3440,7 +3652,9 @@ curl --request POST \ "html": { "type": "string", "description": "HTML template with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "html_header": { "type": "string", @@ -3453,7 +3667,9 @@ curl --request POST \ "name": { "type": "string", "description": "Template name. Random uuid will be assigned when not specified.", - "example": "Test Template" + "examples": [ + "Test Template" + ] }, "size": { "type": "string", @@ -3472,20 +3688,24 @@ curl --request POST \ "A5", "A6" ], - "example": "A4" + "examples": [ + "A4" + ] }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new HTML.", - "example": "714d974e-83d8-11ee-b962-0242ac120002" + "examples": [ + "714d974e-83d8-11ee-b962-0242ac120002" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { @@ -3500,12 +3720,16 @@ curl --request POST \ "html": { "type": "string", "description": "HTML template with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Document" + "examples": [ + "Test Document" + ] } } } @@ -3520,7 +3744,7 @@ curl --request POST \ ### Clone a template -The API endpoint allows you to clone existing template into a new template. +The API endpoint allows you to clone an existing template into a new template. ```shell curl --request POST \ @@ -3550,7 +3774,7 @@ curl --request POST \ "schema": { "type": "integer" }, - "description": "The unique identifier of the documents template.", + "description": "The unique identifier of the document template.", "example": 1000001 } ], @@ -3564,7 +3788,9 @@ curl --request POST \ "name": { "type": "string", "description": "Template name. Existing name with (Clone) suffix will be used if not specified.", - "example": "Cloned Template" + "examples": [ + "Cloned Template" + ] }, "folder_name": { "type": "string", @@ -3623,15 +3849,19 @@ curl --request POST \ "items": { "type": "integer" }, - "example": [ - 321, - 432 + "examples": [ + [ + 321, + 432 + ] ] }, "name": { "type": "string", "description": "Template name. Existing name with (Merged) suffix will be used if not specified.", - "example": "Merged Template" + "examples": [ + "Merged Template" + ] }, "folder_name": { "type": "string", @@ -3643,7 +3873,7 @@ curl --request POST \ }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "roles": { @@ -3652,9 +3882,11 @@ curl --request POST \ "items": { "type": "string" }, - "example": [ - "Agent", - "Customer" + "examples": [ + [ + "Agent", + "Customer" + ] ] } } @@ -3710,13 +3942,17 @@ curl --request PUT \ "properties": { "name": { "type": "string", - "description": "The name of the template", - "example": "New Document Name" + "description": "The name of the template.", + "examples": [ + "New Document Name" + ] }, "folder_name": { "type": "string", "description": "The folder's name to which the template should be moved.", - "example": "New Folder" + "examples": [ + "New Folder" + ] }, "roles": { "type": "array", @@ -3724,9 +3960,11 @@ curl --request PUT \ "items": { "type": "string" }, - "example": [ - "Agent", - "Customer" + "examples": [ + [ + "Agent", + "Customer" + ] ] }, "archived": { @@ -3773,7 +4011,7 @@ curl --request PUT \ "schema": { "type": "integer" }, - "description": "The unique identifier of the documents template.", + "description": "The unique identifier of the document template.", "example": 1000001 } ], @@ -3793,7 +4031,9 @@ curl --request PUT \ "name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Template" + "examples": [ + "Test Template" + ] }, "file": { "type": "string", @@ -3807,7 +4047,9 @@ curl --request PUT \ "position": { "type": "integer", "description": "Position of the document. By default will be added as the last document in the template.", - "example": 0 + "examples": [ + 0 + ] }, "replace": { "type": "boolean", diff --git a/docs/api/typescript.md b/docs/api/typescript.md index 997ed02d..4e88a4c1 100644 --- a/docs/api/typescript.md +++ b/docs/api/typescript.md @@ -54,7 +54,7 @@ const { data, pagination } = await docuseal.listSubmissions({ limit: 10 }); "schema": { "type": "string" }, - "description": "Filter submissions based on submitters name, email or phone partial match." + "description": "Filter submissions based on submitter's name, email or phone partial match." }, { "name": "slug", @@ -188,6 +188,17 @@ const submission = await docuseal.getSubmissionDocuments(1001); }, "description": "The unique identifier of the submission.", "example": 1001 + }, + { + "name": "merge", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false + }, + "description": "When `true`, merges all documents into a single PDF.", + "example": false } ] } @@ -241,7 +252,9 @@ const submission = await docuseal.createSubmission({ "template_id": { "type": "integer", "description": "The unique identifier of the template. Document template forms can be created via the Web UI, PDF and DOCX API, or HTML API.", - "example": 1000001 + "examples": [ + 1000001 + ] }, "send_email": { "type": "boolean", @@ -277,10 +290,22 @@ const submission = await docuseal.createSubmission({ "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] + }, + "variables": { + "type": "object", + "description": "Dynamic content variables object. Variable values can be strings, numbers, arrays, objects, or HTML content used to generate styled text, paragraphs, and tables in dynamic template documents.", + "examples": [ + { + "variable_name": "value" + } + ] }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -297,9 +322,6 @@ const submission = await docuseal.createSubmission({ "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -308,18 +330,24 @@ const submission = await docuseal.createSubmission({ "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -336,7 +364,9 @@ const submission = await docuseal.createSubmission({ "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -372,6 +402,7 @@ const submission = await docuseal.createSubmission({ }, "message": { "type": "object", + "description": "Custom signature request email message for the submitter.", "properties": { "subject": { "type": "string", @@ -395,7 +426,9 @@ const submission = await docuseal.createSubmission({ "name": { "type": "string", "description": "Document template field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -426,7 +459,9 @@ const submission = await docuseal.createSubmission({ } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -447,11 +482,14 @@ const submission = await docuseal.createSubmission({ }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -487,11 +525,14 @@ const submission = await docuseal.createSubmission({ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -553,12 +594,16 @@ const submission = await docuseal.createSubmission({ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -682,7 +727,9 @@ const submission = await docuseal.createSubmissionFromPdf({ "name": { "type": "string", "description": "Name of the document submission.", - "example": "Test Submission Document" + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -718,7 +765,9 @@ const submission = await docuseal.createSubmissionFromPdf({ "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -730,6 +779,7 @@ const submission = await docuseal.createSubmissionFromPdf({ }, "documents": { "type": "array", + "description": "An array of PDF documents to create a submission.", "items": { "type": "object", "required": [ @@ -742,7 +792,9 @@ const submission = await docuseal.createSubmissionFromPdf({ "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF file or downloadable file URL." @@ -778,6 +830,7 @@ const submission = await docuseal.createSubmissionFromPdf({ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -799,6 +852,7 @@ const submission = await docuseal.createSubmissionFromPdf({ }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "required": [ @@ -828,7 +882,9 @@ const submission = await docuseal.createSubmissionFromPdf({ "page": { "type": "integer", "description": "Page number of the field area. Starts from 1.", - "example": 1 + "examples": [ + 1 + ] }, "option": { "type": "string", @@ -843,9 +899,11 @@ const submission = await docuseal.createSubmissionFromPdf({ "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] } } @@ -863,9 +921,6 @@ const submission = await docuseal.createSubmissionFromPdf({ "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -874,18 +929,24 @@ const submission = await docuseal.createSubmissionFromPdf({ "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -902,7 +963,9 @@ const submission = await docuseal.createSubmissionFromPdf({ "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -952,7 +1015,9 @@ const submission = await docuseal.createSubmissionFromPdf({ "name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -983,7 +1048,9 @@ const submission = await docuseal.createSubmissionFromPdf({ } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -1004,11 +1071,14 @@ const submission = await docuseal.createSubmissionFromPdf({ }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -1044,11 +1114,14 @@ const submission = await docuseal.createSubmissionFromPdf({ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -1110,12 +1183,16 @@ const submission = await docuseal.createSubmissionFromPdf({ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -1165,6 +1242,7 @@ const submission = await docuseal.createSubmissionFromPdf({ }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -1201,7 +1279,7 @@ const submission = await docuseal.createSubmissionFromPdf({ ### Create a submission from DOCX -The API endpoint provides functionality to create a one-off submission request from a DOCX file with dynamic content variables. Use [[variable_name]] text tags to define dynamic content variables in the document. See https://www.docuseal.com/examples/demo_template.docx for the specific text variable syntax, including dynamic content tables and list. You can also use the {{signature}} field syntax to define fillable fields, as in a PDF.
Related Guides
Use dynamic content variables in DOCX to create personalized documents +The API endpoint provides functionality to create a one-off submission request from a DOCX file with dynamic content variables. Use [[variable_name]] text tags to define dynamic content variables in the document. See https://www.docuseal.com/examples/demo_template.docx for the specific text variable syntax, including dynamic content tables and lists. You can also use the {{signature}} field syntax to define fillable fields, as in a PDF.
Related Guides
Use dynamic content variables in DOCX to create personalized documents ```typescript import docuseal from "@docuseal/api"; @@ -1255,7 +1333,9 @@ const submission = await docuseal.createSubmissionFromDocx({ "name": { "type": "string", "description": "Name of the document submission.", - "example": "Test Submission Document" + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -1270,9 +1350,11 @@ const submission = await docuseal.createSubmissionFromDocx({ "variables": { "type": "object", "description": "Dynamic content variables object. Variable values can be strings, numbers, arrays, objects, or HTML content used to generate styled text, paragraphs, and tables in DOCX.", - "example": { - "variable_name": "value" - } + "examples": [ + { + "variable_name": "value" + } + ] }, "order": { "type": "string", @@ -1298,7 +1380,9 @@ const submission = await docuseal.createSubmissionFromDocx({ "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -1310,6 +1394,7 @@ const submission = await docuseal.createSubmissionFromDocx({ }, "documents": { "type": "array", + "description": "An array of DOCX documents to create a submission.", "items": { "type": "object", "required": [ @@ -1322,7 +1407,9 @@ const submission = await docuseal.createSubmissionFromDocx({ "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF or DOCX file or downloadable file URL." @@ -1339,9 +1426,6 @@ const submission = await docuseal.createSubmissionFromDocx({ "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -1350,18 +1434,24 @@ const submission = await docuseal.createSubmissionFromDocx({ "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -1378,7 +1468,9 @@ const submission = await docuseal.createSubmissionFromDocx({ "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -1428,7 +1520,9 @@ const submission = await docuseal.createSubmissionFromDocx({ "name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -1459,7 +1553,9 @@ const submission = await docuseal.createSubmissionFromDocx({ } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -1480,11 +1576,14 @@ const submission = await docuseal.createSubmissionFromDocx({ }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -1520,11 +1619,14 @@ const submission = await docuseal.createSubmissionFromDocx({ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -1586,12 +1688,16 @@ const submission = await docuseal.createSubmissionFromDocx({ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -1641,6 +1747,7 @@ const submission = await docuseal.createSubmissionFromDocx({ }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -1659,7 +1766,7 @@ const submission = await docuseal.createSubmissionFromDocx({ }, "remove_tags": { "type": "boolean", - "description": "Pass `false` to disable the removal of {{text}} tags from the PDF. This can be used along with transparent text tags for faster and more robust PDF processing.", + "description": "Pass `false` to disable the removal of {{text}} tags from the document. This can be used along with transparent text tags for faster and more robust document processing.", "default": true } } @@ -1730,8 +1837,10 @@ and typesetting industry

"properties": { "name": { "type": "string", - "description": "Name of the document submission", - "example": "Test Submission Document" + "description": "Name of the document submission.", + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -1767,7 +1876,9 @@ and typesetting industry

"expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -1789,12 +1900,16 @@ and typesetting industry

"name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Document" + "examples": [ + "Test Document" + ] }, "html": { "type": "string", "description": "HTML document content with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "html_header": { "type": "string", @@ -1821,7 +1936,9 @@ and typesetting industry

"A5", "A6" ], - "example": "A4" + "examples": [ + "A4" + ] }, "position": { "type": "integer", @@ -1835,9 +1952,6 @@ and typesetting industry

"description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -1846,18 +1960,24 @@ and typesetting industry

"role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -1874,7 +1994,9 @@ and typesetting industry

"metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -1924,7 +2046,9 @@ and typesetting industry

"name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -1955,7 +2079,9 @@ and typesetting industry

} ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -1976,11 +2102,14 @@ and typesetting industry

}, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -2016,11 +2145,14 @@ and typesetting industry

}, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -2082,12 +2214,16 @@ and typesetting industry

"format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -2137,6 +2273,7 @@ and typesetting industry

}, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -2282,7 +2419,7 @@ const { data, pagination } = await docuseal.listSubmitters({ limit: 10 }); "schema": { "type": "string" }, - "description": "The unique applications-specific identifier provided for a submitter when initializing a signature request. It allows you to receive only submitters with a specified external id." + "description": "The unique application-specific identifier provided for a submitter when initializing a signature request. It allows you to receive only submitters with a specified external ID." }, { "name": "limit", @@ -2300,7 +2437,7 @@ const { data, pagination } = await docuseal.listSubmitters({ limit: 10 }); "schema": { "type": "integer" }, - "description": "The unique identifier of the submitter to start the list from. It allows you to receive only submitters with id greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of submitters." + "description": "The unique identifier of the submitter to start the list from. It allows you to receive only submitters with an ID greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of submitters." }, { "name": "before", @@ -2309,7 +2446,7 @@ const { data, pagination } = await docuseal.listSubmitters({ limit: 10 }); "schema": { "type": "integer" }, - "description": "The unique identifier of the submitter to end the list with. It allows you to receive only submitters with id less than the specified value." + "description": "The unique identifier of the submitter to end the list with. It allows you to receive only submitters with an ID less than the specified value." } ] } @@ -2413,12 +2550,16 @@ const submitter = await docuseal.updateSubmitter(500001, { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -2448,7 +2589,9 @@ const submitter = await docuseal.updateSubmitter(500001, { "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "completed_redirect_url": { "type": "string", @@ -2459,8 +2602,14 @@ const submitter = await docuseal.updateSubmitter(500001, { "description": "Set to `true` to require phone 2FA verification via a one-time code sent to the phone number in order to access the documents.", "default": false }, + "require_email_2fa": { + "type": "boolean", + "description": "Set to `true` to require email 2FA verification via a one-time code sent to the email address in order to access the documents.", + "default": false + }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -2484,7 +2633,9 @@ const submitter = await docuseal.updateSubmitter(500001, { "name": { "type": "string", "description": "Document template field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -2515,7 +2666,9 @@ const submitter = await docuseal.updateSubmitter(500001, { } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -2528,11 +2681,14 @@ const submitter = await docuseal.updateSubmitter(500001, { }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -2568,11 +2724,14 @@ const submitter = await docuseal.updateSubmitter(500001, { }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -2634,12 +2793,16 @@ const submitter = await docuseal.updateSubmitter(500001, { "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -2736,7 +2899,7 @@ const { data, pagination } = await docuseal.listTemplates({ limit: 10 }); "schema": { "type": "string" }, - "description": "The unique applications-specific identifier provided for the template via API or Embedded template form builder. It allows you to receive only templates with your specified external id." + "description": "The unique application-specific identifier provided for the template via API or Embedded template form builder. It allows you to receive only templates with your specified external ID." }, { "name": "folder", @@ -2772,7 +2935,7 @@ const { data, pagination } = await docuseal.listTemplates({ limit: 10 }); "schema": { "type": "integer" }, - "description": "The unique identifier of the template to start the list from. It allows you to receive only templates with id greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of templates." + "description": "The unique identifier of the template to start the list from. It allows you to receive only templates with an ID greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of templates." }, { "name": "before", @@ -2781,7 +2944,7 @@ const { data, pagination } = await docuseal.listTemplates({ limit: 10 }); "schema": { "type": "integer" }, - "description": "The unique identifier of the template to end the list with. It allows you to receive only templates with id less than the specified value." + "description": "The unique identifier of the template to end the list with. It allows you to receive only templates with an ID less than the specified value." } ] } @@ -2886,25 +3049,30 @@ const template = await docuseal.createTemplateFromPdf({ "properties": { "name": { "type": "string", - "description": "Name of the template", - "example": "Test PDF" + "description": "Name of the template.", + "examples": [ + "Test PDF" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new PDF.", - "example": "unique-key" + "examples": [ + "unique-key" + ] }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { "type": "array", + "description": "An array of PDF documents to create a template.", "items": { "type": "object", "required": [ @@ -2917,7 +3085,9 @@ const template = await docuseal.createTemplateFromPdf({ "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF file or downloadable file URL." @@ -2953,6 +3123,7 @@ const template = await docuseal.createTemplateFromPdf({ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -2974,6 +3145,7 @@ const template = await docuseal.createTemplateFromPdf({ }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "required": [ @@ -3003,7 +3175,9 @@ const template = await docuseal.createTemplateFromPdf({ "page": { "type": "integer", "description": "Page number of the field area. Starts from 1.", - "example": 1 + "examples": [ + 1 + ] }, "option": { "type": "string", @@ -3018,18 +3192,23 @@ const template = await docuseal.createTemplateFromPdf({ "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -3065,11 +3244,14 @@ const template = await docuseal.createTemplateFromPdf({ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -3131,12 +3313,16 @@ const template = await docuseal.createTemplateFromPdf({ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -3197,7 +3383,7 @@ const template = await docuseal.createTemplateFromPdf({ ### Create a template from Word DOCX -The API endpoint provides the functionality to create a fillable document template for existing Microsoft Word document. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See https://www.docuseal.com/examples/fieldtags.docx for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.
Related Guides
Use embedded text field tags to create a fillable form +The API endpoint provides the functionality to create a fillable document template for an existing Microsoft Word document. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See https://www.docuseal.com/examples/fieldtags.docx for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.
Related Guides
Use embedded text field tags to create a fillable form ```typescript @@ -3241,25 +3427,30 @@ const template = await docuseal.createTemplateFromDocx({ "properties": { "name": { "type": "string", - "description": "Name of the template", - "example": "Test DOCX" + "description": "Name of the template.", + "examples": [ + "Test DOCX" + ] }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new document.", - "example": "unique-key" + "examples": [ + "unique-key" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { "type": "array", + "description": "An array of DOCX documents to create a template.", "items": { "type": "object", "required": [ @@ -3273,9 +3464,16 @@ const template = await docuseal.createTemplateFromDocx({ }, "file": { "type": "string", - "example": "base64", + "examples": [ + "base64" + ], "format": "base64", - "description": "Base64-encoded content of the DOCX file or downloadable file URL" + "description": "Base64-encoded content of the DOCX file or downloadable file URL." + }, + "dynamic": { + "type": "boolean", + "description": "Set to `true` to make the document dynamic. When enabled, the DOCX document content can be edited or use [[variables]] in the template editor.", + "default": false }, "fields": { "description": "Fields are optional if you use {{...}} text tags to define fields in the document.", @@ -3308,6 +3506,7 @@ const template = await docuseal.createTemplateFromDocx({ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -3329,6 +3528,7 @@ const template = await docuseal.createTemplateFromDocx({ }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "properties": { @@ -3365,18 +3565,23 @@ const template = await docuseal.createTemplateFromDocx({ "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -3412,11 +3617,14 @@ const template = await docuseal.createTemplateFromDocx({ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -3478,12 +3686,16 @@ const template = await docuseal.createTemplateFromDocx({ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -3581,7 +3793,9 @@ and typesetting industry

"html": { "type": "string", "description": "HTML template with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "html_header": { "type": "string", @@ -3594,7 +3808,9 @@ and typesetting industry

"name": { "type": "string", "description": "Template name. Random uuid will be assigned when not specified.", - "example": "Test Template" + "examples": [ + "Test Template" + ] }, "size": { "type": "string", @@ -3613,20 +3829,24 @@ and typesetting industry

"A5", "A6" ], - "example": "A4" + "examples": [ + "A4" + ] }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new HTML.", - "example": "714d974e-83d8-11ee-b962-0242ac120002" + "examples": [ + "714d974e-83d8-11ee-b962-0242ac120002" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { @@ -3641,12 +3861,16 @@ and typesetting industry

"html": { "type": "string", "description": "HTML template with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Document" + "examples": [ + "Test Document" + ] } } } @@ -3661,7 +3885,7 @@ and typesetting industry

### Clone a template -The API endpoint allows you to clone existing template into a new template. +The API endpoint allows you to clone an existing template into a new template. ```typescript import docuseal from "@docuseal/api"; @@ -3693,7 +3917,7 @@ const template = await docuseal.cloneTemplate(1000001, { "schema": { "type": "integer" }, - "description": "The unique identifier of the documents template.", + "description": "The unique identifier of the document template.", "example": 1000001 } ], @@ -3707,7 +3931,9 @@ const template = await docuseal.cloneTemplate(1000001, { "name": { "type": "string", "description": "Template name. Existing name with (Clone) suffix will be used if not specified.", - "example": "Cloned Template" + "examples": [ + "Cloned Template" + ] }, "folder_name": { "type": "string", @@ -3772,15 +3998,19 @@ const template = await docuseal.mergeTemplates({ "items": { "type": "integer" }, - "example": [ - 321, - 432 + "examples": [ + [ + 321, + 432 + ] ] }, "name": { "type": "string", "description": "Template name. Existing name with (Merged) suffix will be used if not specified.", - "example": "Merged Template" + "examples": [ + "Merged Template" + ] }, "folder_name": { "type": "string", @@ -3792,7 +4022,7 @@ const template = await docuseal.mergeTemplates({ }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "roles": { @@ -3801,9 +4031,11 @@ const template = await docuseal.mergeTemplates({ "items": { "type": "string" }, - "example": [ - "Agent", - "Customer" + "examples": [ + [ + "Agent", + "Customer" + ] ] } } @@ -3862,13 +4094,17 @@ const template = await docuseal.updateTemplate(1000001, { "properties": { "name": { "type": "string", - "description": "The name of the template", - "example": "New Document Name" + "description": "The name of the template.", + "examples": [ + "New Document Name" + ] }, "folder_name": { "type": "string", "description": "The folder's name to which the template should be moved.", - "example": "New Folder" + "examples": [ + "New Folder" + ] }, "roles": { "type": "array", @@ -3876,9 +4112,11 @@ const template = await docuseal.updateTemplate(1000001, { "items": { "type": "string" }, - "example": [ - "Agent", - "Customer" + "examples": [ + [ + "Agent", + "Customer" + ] ] }, "archived": { @@ -3931,7 +4169,7 @@ const template = await docuseal.updateTemplateDocuments(1000001, { "schema": { "type": "integer" }, - "description": "The unique identifier of the documents template.", + "description": "The unique identifier of the document template.", "example": 1000001 } ], @@ -3951,7 +4189,9 @@ const template = await docuseal.updateTemplateDocuments(1000001, { "name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Template" + "examples": [ + "Test Template" + ] }, "file": { "type": "string", @@ -3965,7 +4205,9 @@ const template = await docuseal.updateTemplateDocuments(1000001, { "position": { "type": "integer", "description": "Position of the document. By default will be added as the last document in the template.", - "example": 0 + "examples": [ + 0 + ] }, "replace": { "type": "boolean", diff --git a/docs/embedding/form-builder-angular.md b/docs/embedding/form-builder-angular.md index d4cf5a32..5cd76ff9 100644 --- a/docs/embedding/form-builder-angular.md +++ b/docs/embedding/form-builder-angular.md @@ -152,9 +152,16 @@ const token = jwt.sign({ "payment", "phone", "verification", + "kba", "strikethrough" ] }, + "dateFormats": { + "type": "array", + "required": false, + "description": "A list of formats to be used for the date field. Formats may include date ('YYYY', 'MM', 'DD'), time ('HH', 'hh', 'mm', 'ss', 'A') and timezone ('z') parts. The first format in the list is used as the default.", + "example": "[\"MM/DD/YYYY\", \"YYYY-MM-DD HH:mm:ss z\"]" + }, "drawFieldType": { "type": "string", "required": false, @@ -196,6 +203,7 @@ const token = jwt.sign({ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -324,6 +332,7 @@ const token = jwt.sign({ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -439,13 +448,19 @@ const token = jwt.sign({ "type": "boolean", "required": false, "default": true, - "description": "Set `false` to now show the documents list on the left. Documents list is displayed by default." + "description": "Set `false` to not show the documents list on the left. Documents list is displayed by default." + }, + "withDynamicDocuments": { + "type": "boolean", + "required": false, + "default": false, + "description": "Set `true` to allow converting DOCX files to editable dynamic documents." }, "withFieldsList": { "type": "boolean", "required": false, "default": true, - "description": "Set `false` to now show the fields list on the right. Fields list is displayed by default." + "description": "Set `false` to not show the fields list on the right. Fields list is displayed by default." }, "withFieldsDetection": { "type": "boolean", @@ -453,6 +468,12 @@ const token = jwt.sign({ "default": false, "description": "Display a button to automatically detect and add fields to the document with AI." }, + "withCustomFieldsTab": { + "type": "boolean", + "required": false, + "default": false, + "description": "Set `true` to display a separate \"Custom\" fields tab in the fields list. Custom fields can be configured using the `fields` or `requiredFields` prop." + }, "withFieldPlaceholder": { "type": "boolean", "required": false, @@ -464,6 +485,12 @@ const token = jwt.sign({ "required": false, "description": "Set to `true` to enable Signature ID by default for newly added fields. If set to `false`, the Signature ID toggle will be displayed under field settings, with the Signature ID turned off by default." }, + "withRevisions": { + "type": "boolean", + "required": false, + "default": false, + "description": "Set `true` to save revisions and display a dropdown next to the Save button that provides access to the template revisions history." + }, "onlyDefinedFields": { "type": "boolean", "required": false, diff --git a/docs/embedding/form-builder-javascript.md b/docs/embedding/form-builder-javascript.md index 9d863bd5..5e793026 100644 --- a/docs/embedding/form-builder-javascript.md +++ b/docs/embedding/form-builder-javascript.md @@ -119,6 +119,7 @@ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -251,6 +252,7 @@ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -339,9 +341,16 @@ "payment", "phone", "verification", + "kba", "strikethrough" ] }, + "data-date-formats": { + "type": "string", + "required": false, + "description": "Comma separated list of formats to be used for the date field. Formats may include date ('YYYY', 'MM', 'DD'), time ('HH', 'hh', 'mm', 'ss', 'A') and timezone ('z') parts. The first format in the list is used as the default.", + "example": "MM/DD/YYYY,YYYY-MM-DD HH:mm:ss z" + }, "data-draw-field-type": { "type": "string", "required": false, @@ -403,13 +412,19 @@ "type": "boolean", "required": false, "default": true, - "description": "Set `false` to now show the documents list on the left. Documents list is displayed by default." + "description": "Set `false` to not show the documents list on the left. Documents list is displayed by default." + }, + "data-with-dynamic-documents": { + "type": "boolean", + "required": false, + "default": false, + "description": "Set `true` to allow converting DOCX files to editable dynamic documents." }, "data-with-fields-list": { "type": "boolean", "required": false, "default": true, - "description": "Set `false` to now show the fields list on the right. Fields list is displayed by default." + "description": "Set `false` to not show the fields list on the right. Fields list is displayed by default." }, "data-with-fields-detection": { "type": "boolean", @@ -417,6 +432,12 @@ "default": false, "description": "Display a button to automatically detect and add fields to the document with AI." }, + "data-with-custom-fields-tab": { + "type": "boolean", + "required": false, + "default": false, + "description": "Set `true` to display a separate \"Custom\" fields tab in the fields list. Custom fields can be configured using the `data-fields` or `data-required-fields` attribute." + }, "data-with-field-placeholder": { "type": "boolean", "required": false, @@ -428,6 +449,12 @@ "required": false, "description": "Set to `true` to enable Signature ID by default for newly added fields. If set to `false`, the Signature ID toggle will be displayed under field settings, with the Signature ID turned off by default." }, + "data-with-revisions": { + "type": "boolean", + "required": false, + "default": false, + "description": "Set `true` to save revisions and display a dropdown next to the Save button that provides access to the template revisions history." + }, "data-preview": { "type": "boolean", "required": false, diff --git a/docs/embedding/form-builder-react.md b/docs/embedding/form-builder-react.md index e6dcac26..ad7488f6 100644 --- a/docs/embedding/form-builder-react.md +++ b/docs/embedding/form-builder-react.md @@ -143,9 +143,16 @@ const token = jwt.sign({ "payment", "phone", "verification", + "kba", "strikethrough" ] }, + "dateFormats": { + "type": "array", + "required": false, + "description": "A list of formats to be used for the date field. Formats may include date ('YYYY', 'MM', 'DD'), time ('HH', 'hh', 'mm', 'ss', 'A') and timezone ('z') parts. The first format in the list is used as the default.", + "example": "[\"MM/DD/YYYY\", \"YYYY-MM-DD HH:mm:ss z\"]" + }, "drawFieldType": { "type": "string", "required": false, @@ -187,6 +194,7 @@ const token = jwt.sign({ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -315,6 +323,7 @@ const token = jwt.sign({ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -430,13 +439,19 @@ const token = jwt.sign({ "type": "boolean", "required": false, "default": true, - "description": "Set `false` to now show the documents list on the left. Documents list is displayed by default." + "description": "Set `false` to not show the documents list on the left. Documents list is displayed by default." + }, + "withDynamicDocuments": { + "type": "boolean", + "required": false, + "default": false, + "description": "Set `true` to allow converting DOCX files to editable dynamic documents." }, "withFieldsList": { "type": "boolean", "required": false, "default": true, - "description": "Set `false` to now show the fields list on the right. Fields list is displayed by default." + "description": "Set `false` to not show the fields list on the right. Fields list is displayed by default." }, "withFieldsDetection": { "type": "boolean", @@ -444,6 +459,12 @@ const token = jwt.sign({ "default": false, "description": "Display a button to automatically detect and add fields to the document with AI." }, + "withCustomFieldsTab": { + "type": "boolean", + "required": false, + "default": false, + "description": "Set `true` to display a separate \"Custom\" fields tab in the fields list. Custom fields can be configured using the `fields` or `requiredFields` prop." + }, "withFieldPlaceholder": { "type": "boolean", "required": false, @@ -455,6 +476,12 @@ const token = jwt.sign({ "required": false, "description": "Set to `true` to enable Signature ID by default for newly added fields. If set to `false`, the Signature ID toggle will be displayed under field settings, with the Signature ID turned off by default." }, + "withRevisions": { + "type": "boolean", + "required": false, + "default": false, + "description": "Set `true` to save revisions and display a dropdown next to the Save button that provides access to the template revisions history." + }, "onlyDefinedFields": { "type": "boolean", "required": false, diff --git a/docs/embedding/form-builder-vue.md b/docs/embedding/form-builder-vue.md index ef5475fc..af320df6 100644 --- a/docs/embedding/form-builder-vue.md +++ b/docs/embedding/form-builder-vue.md @@ -164,9 +164,16 @@ const token = jwt.sign({ "payment", "phone", "verification", + "kba", "strikethrough" ] }, + "date-formats": { + "type": "array", + "required": false, + "description": "A list of formats to be used for the date field. Formats may include date ('YYYY', 'MM', 'DD'), time ('HH', 'hh', 'mm', 'ss', 'A') and timezone ('z') parts. The first format in the list is used as the default.", + "example": "[\"MM/DD/YYYY\", \"YYYY-MM-DD HH:mm:ss z\"]" + }, "draw-field-type": { "type": "string", "required": false, @@ -208,6 +215,7 @@ const token = jwt.sign({ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -336,6 +344,7 @@ const token = jwt.sign({ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -445,13 +454,19 @@ const token = jwt.sign({ "type": "boolean", "required": false, "default": true, - "description": "Set `false` to now show the documents list on the left. Documents list is displayed by default." + "description": "Set `false` to not show the documents list on the left. Documents list is displayed by default." + }, + "with-dynamic-documents": { + "type": "boolean", + "required": false, + "default": false, + "description": "Set `true` to allow converting DOCX files to editable dynamic documents." }, "with-fields-list": { "type": "boolean", "required": false, "default": true, - "description": "Set `false` to now show the fields list on the right. Fields list is displayed by default." + "description": "Set `false` to not show the fields list on the right. Fields list is displayed by default." }, "with-fields-detection": { "type": "boolean", @@ -459,6 +474,12 @@ const token = jwt.sign({ "default": false, "description": "Display a button to automatically detect and add fields to the document with AI." }, + "with-custom-fields-tab": { + "type": "boolean", + "required": false, + "default": false, + "description": "Set `true` to display a separate \"Custom\" fields tab in the fields list. Custom fields can be configured using the `:fields` or `:required-fields` prop." + }, "with-field-placeholder": { "type": "boolean", "required": false, @@ -470,6 +491,12 @@ const token = jwt.sign({ "required": false, "description": "Set to `true` to enable Signature ID by default for newly added fields. If set to `false`, the Signature ID toggle will be displayed under field settings, with the Signature ID turned off by default." }, + "with-revisions": { + "type": "boolean", + "required": false, + "default": false, + "description": "Set `true` to save revisions and display a dropdown next to the Save button that provides access to the template revisions history." + }, "autosave": { "type": "boolean", "required": false, diff --git a/docs/embedding/signing-form-angular.md b/docs/embedding/signing-form-angular.md index 16e47593..9707a79d 100644 --- a/docs/embedding/signing-form-angular.md +++ b/docs/embedding/signing-form-angular.md @@ -51,7 +51,7 @@ export class AppComponent {} "token": { "type": "string", "doc_type": "object", - "description": "JSON Web Token (JWT HS256) with a payload signed using the API key. JWT can be generated only on the backend..", + "description": "JSON Web Token (JWT HS256) with a payload signed using the API key. JWT can be generated only on the backend.", "required": false, "properties": { "slug": { @@ -109,7 +109,7 @@ export class AppComponent {} "language": { "type": "string", "required": false, - "description": "UI language: en, es, it, de, fr, nl, pl, uk, cs, pt, he, ar, kr, ja languages are available. Be default the form is displayed in the user browser language automatically." + "description": "UI language: en, es, it, de, fr, nl, pl, uk, cs, pt, he, ar, kr, ja languages are available. By default the form is displayed in the user browser language automatically." }, "i18n": { "type": "object", @@ -127,7 +127,7 @@ export class AppComponent {} "type": "boolean", "required": false, "default": true, - "description": "Set `false` to hide field name. Hidding field names can be useful for when they are not in the human readable format. Field names are displayed by default." + "description": "Set `false` to hide field name. Hiding field names can be useful for when they are not in the human readable format. Field names are displayed by default." }, "withFieldPlaceholder": { "type": "boolean", @@ -232,6 +232,12 @@ export class AppComponent {} "default": false, "description": "Set `true` to display the complete button in the form header." }, + "onlyRequiredFields": { + "type": "boolean", + "required": false, + "default": false, + "description": "Set to `true` to display only required fields in the step-by-step form, hiding all optional fields." + }, "allowToResubmit": { "type": "boolean", "required": false, @@ -241,7 +247,7 @@ export class AppComponent {} "signature": { "type": "string", "required": false, - "description": "Allows pre-filling signature fields. The value can be a base64 encoded image string, a public URL to an image, or plain text that will be rendered as a typed signature using a standard font." + "description": "Allows pre-filling signature fields. The value can be a base64 encoded data:image/ string, a public URL to an image, or plain text that will be rendered as a typed signature using a standard font." }, "rememberSignature": { "type": "boolean", @@ -311,7 +317,7 @@ export class AppComponent {} "onComplete": { "type": "event emitter", "required": false, - "description": "Event emitted the form completion.", + "description": "Event emitted on form completion.", "example": "handleComplete($event)" }, "onDecline": { diff --git a/docs/embedding/signing-form-javascript.md b/docs/embedding/signing-form-javascript.md index b0ccf4b9..126649f0 100644 --- a/docs/embedding/signing-form-javascript.md +++ b/docs/embedding/signing-form-javascript.md @@ -47,7 +47,7 @@ "data-token": { "type": "string", "doc_type": "object", - "description": "JSON Web Token (JWT HS256) with a payload signed using the API key. JWT can be generated only on the backend..", + "description": "JSON Web Token (JWT HS256) with a payload signed using the API key. JWT can be generated only on the backend.", "required": false, "properties": { "slug": { @@ -105,7 +105,7 @@ "data-language": { "type": "string", "required": false, - "description": "UI language: en, es, it, de, fr, nl, pl, uk, cs, pt, he, ar, kr, ja languages are available. Be default the form is displayed in the user browser language automatically." + "description": "UI language: en, es, it, de, fr, nl, pl, uk, cs, pt, he, ar, kr, ja languages are available. By default the form is displayed in the user browser language automatically." }, "data-i18n": { "type": "string", @@ -153,7 +153,7 @@ "type": "boolean", "required": false, "default": true, - "description": "Set `false` to hide field name. Hidding field names can be useful for when they are not in the human readable format. Field names are displayed by default." + "description": "Set `false` to hide field name. Hiding field names can be useful for when they are not in the human readable format. Field names are displayed by default." }, "data-with-field-placeholder": { "type": "boolean", @@ -179,6 +179,12 @@ "default": false, "description": "Set `true` to display the complete button in the form header." }, + "data-only-required-fields": { + "type": "boolean", + "required": false, + "default": false, + "description": "Set to `true` to display only required fields in the step-by-step form, hiding all optional fields." + }, "data-allow-to-resubmit": { "type": "boolean", "required": false, @@ -194,7 +200,7 @@ "data-signature": { "type": "string", "required": false, - "description": "Allows pre-filling signature fields. The value can be a base64 encoded image string, a public URL to an image, or plain text that will be rendered as a typed signature using a standard font." + "description": "Allows pre-filling signature fields. The value can be a base64 encoded data:image/ string, a public URL to an image, or plain text that will be rendered as a typed signature using a standard font." }, "data-remember-signature": { "type": "boolean", diff --git a/docs/embedding/signing-form-react.md b/docs/embedding/signing-form-react.md index 949adb43..1d6dcf74 100644 --- a/docs/embedding/signing-form-react.md +++ b/docs/embedding/signing-form-react.md @@ -48,7 +48,7 @@ export function App() { "token": { "type": "string", "doc_type": "object", - "description": "JSON Web Token (JWT HS256) with a payload signed using the API key. JWT can be generated only on the backend..", + "description": "JSON Web Token (JWT HS256) with a payload signed using the API key. JWT can be generated only on the backend.", "required": false, "properties": { "slug": { @@ -106,7 +106,7 @@ export function App() { "language": { "type": "string", "required": false, - "description": "UI language: en, es, it, de, fr, nl, pl, uk, cs, pt, he, ar, kr, ja languages are available. Be default the form is displayed in the user browser language automatically." + "description": "UI language: en, es, it, de, fr, nl, pl, uk, cs, pt, he, ar, kr, ja languages are available. By default the form is displayed in the user browser language automatically." }, "i18n": { "type": "object", @@ -124,7 +124,7 @@ export function App() { "type": "boolean", "required": false, "default": true, - "description": "Set `false` to hide field name. Hidding field names can be useful for when they are not in the human readable format. Field names are displayed by default." + "description": "Set `false` to hide field name. Hiding field names can be useful for when they are not in the human readable format. Field names are displayed by default." }, "withFieldPlaceholder": { "type": "boolean", @@ -229,6 +229,12 @@ export function App() { "default": false, "description": "Set `true` to display the complete button in the form header." }, + "onlyRequiredFields": { + "type": "boolean", + "required": false, + "default": false, + "description": "Set to `true` to display only required fields in the step-by-step form, hiding all optional fields." + }, "allowToResubmit": { "type": "boolean", "required": false, @@ -244,7 +250,7 @@ export function App() { "signature": { "type": "string", "required": false, - "description": "Allows pre-filling signature fields. The value can be a base64 encoded image string, a public URL to an image, or plain text that will be rendered as a typed signature using a standard font." + "description": "Allows pre-filling signature fields. The value can be a base64 encoded data:image/ string, a public URL to an image, or plain text that will be rendered as a typed signature using a standard font." }, "rememberSignature": { "type": "boolean", diff --git a/docs/embedding/signing-form-vue.md b/docs/embedding/signing-form-vue.md index 6014da83..e5ef4e43 100644 --- a/docs/embedding/signing-form-vue.md +++ b/docs/embedding/signing-form-vue.md @@ -57,7 +57,7 @@ export default { "token": { "type": "string", "doc_type": "object", - "description": "JSON Web Token (JWT HS256) with a payload signed using the API key. JWT can be generated only on the backend..", + "description": "JSON Web Token (JWT HS256) with a payload signed using the API key. JWT can be generated only on the backend.", "required": false, "properties": { "slug": { @@ -115,7 +115,7 @@ export default { "language": { "type": "string", "required": false, - "description": "UI language: en, es, it, de, fr, nl, pl, uk, cs, pt, he, ar, kr, ja languages are available. Be default the form is displayed in the user browser language automatically." + "description": "UI language: en, es, it, de, fr, nl, pl, uk, cs, pt, he, ar, kr, ja languages are available. By default the form is displayed in the user browser language automatically." }, "i18n": { "type": "object", @@ -145,7 +145,7 @@ export default { "type": "boolean", "required": false, "default": true, - "description": "Set `false` to hide field name. Hidding field names can be useful for when they are not in the human readable format. Field names are displayed by default." + "description": "Set `false` to hide field name. Hiding field names can be useful for when they are not in the human readable format. Field names are displayed by default." }, "with-field-placeholder": { "type": "boolean", @@ -195,6 +195,12 @@ export default { "default": false, "description": "Set `true` to display the complete button in the form header." }, + "only-required-fields": { + "type": "boolean", + "required": false, + "default": false, + "description": "Set to `true` to display only required fields in the step-by-step form, hiding all optional fields." + }, "allow-to-resubmit": { "type": "boolean", "required": false, @@ -204,7 +210,7 @@ export default { "signature": { "type": "string", "required": false, - "description": "Allows pre-filling signature fields. The value can be a base64 encoded image string, a public URL to an image, or plain text that will be rendered as a typed signature using a standard font." + "description": "Allows pre-filling signature fields. The value can be a base64 encoded data:image/ string, a public URL to an image, or plain text that will be rendered as a typed signature using a standard font." }, "remember-signature": { "type": "boolean", diff --git a/docs/openapi.json b/docs/openapi.json index 9afd740c..ffcdffe4 100644 --- a/docs/openapi.json +++ b/docs/openapi.json @@ -1,5 +1,5 @@ { - "openapi": "3.0.0", + "openapi": "3.1.0", "servers": [ { "url": "https://api.docuseal.com", @@ -84,7 +84,7 @@ "schema": { "type": "string" }, - "description": "The unique applications-specific identifier provided for the template via API or Embedded template form builder. It allows you to receive only templates with your specified external id." + "description": "The unique application-specific identifier provided for the template via API or Embedded template form builder. It allows you to receive only templates with your specified external ID." }, { "name": "folder", @@ -120,7 +120,7 @@ "schema": { "type": "integer" }, - "description": "The unique identifier of the template to start the list from. It allows you to receive only templates with id greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of templates." + "description": "The unique identifier of the template to start the list from. It allows you to receive only templates with an ID greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of templates." }, { "name": "before", @@ -129,7 +129,7 @@ "schema": { "type": "integer" }, - "description": "The unique identifier of the template to end the list with. It allows you to receive only templates with id less than the specified value." + "description": "The unique identifier of the template to end the list with. It allows you to receive only templates with an ID less than the specified value." } ], "responses": { @@ -178,7 +178,7 @@ }, "name": { "type": "string", - "description": "Name of the template." + "description": "The name of the template." }, "preferences": { "type": "object", @@ -196,7 +196,7 @@ "properties": { "attachment_uuid": { "type": "string", - "description": "Unique indentifier of attached document to the template." + "description": "Unique identifier of attached document to the template." }, "name": { "type": "string", @@ -252,6 +252,7 @@ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -261,6 +262,7 @@ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", @@ -361,6 +363,7 @@ }, "submitters": { "type": "array", + "description": "The list of submitters for the template.", "items": { "type": "object", "required": [ @@ -370,7 +373,7 @@ "properties": { "name": { "type": "string", - "description": "Submitter name." + "description": "The name of the submitter." }, "uuid": { "type": "string", @@ -384,17 +387,19 @@ "description": "Unique identifier of the author of the template." }, "archived_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "Date and time when the template was archived." }, "created_at": { "type": "string", - "description": "Date and time when the template was created." + "description": "The date and time when the template was created." }, "updated_at": { "type": "string", - "description": "Date and time when the template was updated." + "description": "The date and time when the template was last updated." }, "source": { "type": "string", @@ -406,17 +411,19 @@ ] }, "external_id": { - "type": "string", - "nullable": true, - "description": "Identifier of the template in the external system." + "type": [ + "string", + "null" + ], + "description": "Your application-specific unique string key to identify this template within your app." }, "folder_id": { "type": "integer", - "description": "Unique identifier of the folder where the template is placed." + "description": "Unique identifier of the folder where the template is located." }, "folder_name": { "type": "string", - "description": "Folder name where the template is placed." + "description": "Folder name where the template is located." }, "shared_link": { "type": "boolean", @@ -501,14 +508,18 @@ "description": "Templates count." }, "next": { - "type": "integer", - "nullable": true, - "description": "The ID of the tempate after which the next page starts." + "type": [ + "integer", + "null" + ], + "description": "The ID of the template after which the next page starts." }, "prev": { - "type": "integer", - "nullable": true, - "description": "The ID of the tempate before which the previous page ends." + "type": [ + "integer", + "null" + ], + "description": "The ID of the template before which the previous page ends." } } } @@ -653,7 +664,7 @@ }, "name": { "type": "string", - "description": "Name of the template." + "description": "The name of the template." }, "preferences": { "type": "object", @@ -671,7 +682,7 @@ "properties": { "attachment_uuid": { "type": "string", - "description": "Unique indentifier of attached document to the template." + "description": "Unique identifier of attached document to the template." }, "name": { "type": "string", @@ -727,6 +738,7 @@ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -736,6 +748,7 @@ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", @@ -836,6 +849,7 @@ }, "submitters": { "type": "array", + "description": "The list of submitters for the template.", "items": { "type": "object", "required": [ @@ -845,7 +859,7 @@ "properties": { "name": { "type": "string", - "description": "Submitter name." + "description": "The name of the submitter." }, "uuid": { "type": "string", @@ -859,17 +873,19 @@ "description": "Unique identifier of the author of the template." }, "archived_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "Date and time when the template was archived." }, "created_at": { "type": "string", - "description": "Date and time when the template was created." + "description": "The date and time when the template was created." }, "updated_at": { "type": "string", - "description": "Date and time when the template was updated." + "description": "The date and time when the template was last updated." }, "source": { "type": "string", @@ -881,17 +897,19 @@ ] }, "external_id": { - "type": "string", - "nullable": true, - "description": "Identifier of the template in the external system." + "type": [ + "string", + "null" + ], + "description": "Your application-specific unique string key to identify this template within your app." }, "folder_id": { "type": "integer", - "description": "Unique identifier of the folder where the template is placed." + "description": "Unique identifier of the folder where the template is located." }, "folder_name": { "type": "string", - "description": "Folder name where the template is placed." + "description": "Folder name where the template is located." }, "shared_link": { "type": "boolean", @@ -1070,8 +1088,10 @@ "description": "Template unique ID number." }, "archived_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "Date and time when the template was archived." } } @@ -1118,13 +1138,17 @@ "properties": { "name": { "type": "string", - "description": "The name of the template", - "example": "New Document Name" + "description": "The name of the template.", + "examples": [ + "New Document Name" + ] }, "folder_name": { "type": "string", "description": "The folder's name to which the template should be moved.", - "example": "New Folder" + "examples": [ + "New Folder" + ] }, "roles": { "type": "array", @@ -1132,9 +1156,11 @@ "items": { "type": "string" }, - "example": [ - "Agent", - "Customer" + "examples": [ + [ + "Agent", + "Customer" + ] ] }, "archived": { @@ -1223,7 +1249,7 @@ "schema": { "type": "string" }, - "description": "Filter submissions based on submitters name, email or phone partial match." + "description": "Filter submissions based on submitter's name, email or phone partial match." }, { "name": "slug", @@ -1317,8 +1343,10 @@ }, "name": { "type": "string", - "description": "Name of the document submission", - "example": "Test Submission Document" + "description": "Name of the document submission.", + "examples": [ + "Test Submission Document" + ] }, "source": { "type": "string", @@ -1354,18 +1382,24 @@ ] }, "audit_log_url": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "Audit log file URL." }, "combined_document_url": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "Combined PDF file URL with documents and Audit Log." }, "completed_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the submission was completed." }, "created_at": { @@ -1377,8 +1411,10 @@ "description": "The date and time when the submission was last updated." }, "archived_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the submission was archived." }, "submitters": { @@ -1408,19 +1444,21 @@ "properties": { "id": { "type": "integer", - "description": "Submission unique ID number." + "description": "Submitter unique ID number." }, "submission_id": { "type": "integer", - "description": "Submission ID number." + "description": "Submission unique ID number." }, "uuid": { "type": "string", "description": "Submitter UUID." }, "email": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The email address of the submitter." }, "slug": { @@ -1428,24 +1466,32 @@ "description": "Unique key to be used in the form signing link and embedded form." }, "sent_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the signing request was sent to the submitter." }, "opened_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the submitter opened the signing form." }, "completed_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the submitter completed the signing form." }, "declined_at": { - "type": "string", - "nullable": true, - "description": "The date and time when the submitter declined to complete the signing form." + "type": [ + "string", + "null" + ], + "description": "The date and time when the submitter declined the signing form." }, "created_at": { "type": "string", @@ -1456,18 +1502,24 @@ "description": "The date and time when the submitter was last updated." }, "name": { - "type": "string", - "nullable": true, - "description": "Submitter name." + "type": [ + "string", + "null" + ], + "description": "The name of the submitter." }, "phone": { - "type": "string", - "nullable": true, - "description": "Submitter phone number." + "type": [ + "string", + "null" + ], + "description": "The phone number of the submitter." }, "external_id": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "Your application-specific unique string key to identify this submitter within your app." }, "status": { @@ -1483,7 +1535,7 @@ }, "role": { "type": "string", - "description": "The role of the submitter." + "description": "The role of the submitter in the signing process." }, "metadata": { "type": "object", @@ -1491,7 +1543,7 @@ }, "preferences": { "type": "object", - "description": "Object with submitter preferences." + "description": "Submitter preferences." } } } @@ -1509,15 +1561,17 @@ "properties": { "id": { "type": "integer", - "description": "Template unique ID number." + "description": "Unique identifier of the document template." }, "name": { "type": "string", - "description": "The name of the submission template." + "description": "The name of the template." }, "external_id": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "Your application-specific unique string key to identify this template within your app." }, "folder_name": { @@ -1526,17 +1580,19 @@ }, "created_at": { "type": "string", - "description": "The date and time when the submission template was created." + "description": "The date and time when the template was created." }, "updated_at": { "type": "string", - "description": "The date and time when the submission template was last updated." + "description": "The date and time when the template was last updated." } } }, "created_by_user": { - "type": "object", - "nullable": true, + "type": [ + "object", + "null" + ], "required": [ "id", "first_name", @@ -1578,13 +1634,17 @@ "description": "Submissions count." }, "next": { - "type": "integer", - "nullable": true, + "type": [ + "integer", + "null" + ], "description": "The ID of the submission after which the next page starts." }, "prev": { - "type": "integer", - "nullable": true, + "type": [ + "integer", + "null" + ], "description": "The ID of the submission before which the previous page ends." } } @@ -1682,7 +1742,9 @@ "template_id": { "type": "integer", "description": "The unique identifier of the template. Document template forms can be created via the Web UI, PDF and DOCX API, or HTML API.", - "example": 1000001 + "examples": [ + 1000001 + ] }, "send_email": { "type": "boolean", @@ -1718,10 +1780,22 @@ "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] + }, + "variables": { + "type": "object", + "description": "Dynamic content variables object. Variable values can be strings, numbers, arrays, objects, or HTML content used to generate styled text, paragraphs, and tables in dynamic template documents.", + "examples": [ + { + "variable_name": "value" + } + ] }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -1738,9 +1812,6 @@ "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -1749,18 +1820,24 @@ "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -1777,7 +1854,9 @@ "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -1813,6 +1892,7 @@ }, "message": { "type": "object", + "description": "Custom signature request email message for the submitter.", "properties": { "subject": { "type": "string", @@ -1836,7 +1916,9 @@ "name": { "type": "string", "description": "Document template field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -1867,7 +1949,9 @@ } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -1888,11 +1972,14 @@ }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -1928,11 +2015,14 @@ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -1994,12 +2084,16 @@ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -2090,20 +2184,22 @@ }, "submission_id": { "type": "integer", - "description": "Submission UUID." + "description": "Submission unique ID number." }, "uuid": { "type": "string", "description": "Submitter UUID." }, "email": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The email address of the submitter." }, "slug": { "type": "string", - "description": "Unique key to be used in the signing form URL." + "description": "Unique key to be used in the form signing link and embedded form." }, "status": { "type": "string", @@ -2118,7 +2214,7 @@ }, "values": { "type": "array", - "description": "An array of pre-filled values for the submission.", + "description": "An array of pre-filled values for the submitter.", "items": { "type": "object", "required": [ @@ -2164,26 +2260,35 @@ } }, "metadata": { - "type": "object" + "type": "object", + "description": "Metadata object with additional submitter information." }, "sent_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the signing request was sent to the submitter." }, "opened_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the submitter opened the signing form." }, "completed_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the submitter completed the signing form." }, "declined_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the submitter declined the signing form." }, "created_at": { @@ -2195,22 +2300,29 @@ "description": "The date and time when the submitter was last updated." }, "name": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The name of the submitter." }, "phone": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The phone number of the submitter." }, "external_id": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "Your application-specific unique string key to identify this submitter within your app." }, "preferences": { "type": "object", + "description": "Submitter preferences.", "properties": { "send_email": { "type": "boolean", @@ -2330,8 +2442,10 @@ }, "name": { "type": "string", - "description": "Name of the document submission", - "example": "Test Submission Document" + "description": "Name of the document submission.", + "examples": [ + "Test Submission Document" + ] }, "slug": { "type": "string", @@ -2357,13 +2471,17 @@ ] }, "audit_log_url": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "Audit log file URL." }, "combined_document_url": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "Combined PDF file URL with documents and Audit Log." }, "created_at": { @@ -2375,8 +2493,10 @@ "description": "The date and time when the submission was last updated." }, "archived_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the submission was archived." }, "submitters": { @@ -2418,8 +2538,10 @@ "description": "Submitter UUID." }, "email": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The email address of the submitter." }, "slug": { @@ -2427,23 +2549,31 @@ "description": "Unique key to be used in the form signing link and embedded form." }, "sent_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the signing request was sent to the submitter." }, "opened_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the submitter opened the signing form." }, "completed_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the submitter completed the signing form." }, "declined_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the submitter declined the signing form." }, "created_at": { @@ -2455,18 +2585,24 @@ "description": "The date and time when the submitter was last updated." }, "name": { - "type": "string", - "nullable": true, - "description": "Submitter name." + "type": [ + "string", + "null" + ], + "description": "The name of the submitter." }, "phone": { - "type": "string", - "nullable": true, - "description": "Submitter phone number." + "type": [ + "string", + "null" + ], + "description": "The phone number of the submitter." }, "external_id": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "Your application-specific unique string key to identify this submitter within your app." }, "status": { @@ -2482,7 +2618,7 @@ }, "values": { "type": "array", - "description": "An array of field values for the submitter.", + "description": "An array of pre-filled values for the submitter.", "items": { "type": "object", "required": [ @@ -2568,15 +2704,17 @@ "properties": { "id": { "type": "integer", - "description": "Template unique ID number." + "description": "Unique identifier of the document template." }, "name": { "type": "string", - "description": "The name of the submission template." + "description": "The name of the template." }, "external_id": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "Your application-specific unique string key to identify this template within your app." }, "folder_name": { @@ -2585,17 +2723,19 @@ }, "created_at": { "type": "string", - "description": "The date and time when the submission template was created." + "description": "The date and time when the template was created." }, "updated_at": { "type": "string", - "description": "The date and time when the submission template was last updated." + "description": "The date and time when the template was last updated." } } }, "created_by_user": { - "type": "object", - "nullable": true, + "type": [ + "object", + "null" + ], "required": [ "id", "first_name", @@ -2623,6 +2763,7 @@ }, "submission_events": { "type": "array", + "description": "An array of events related to the submission.", "items": { "type": "object", "required": [ @@ -2711,9 +2852,11 @@ "description": "Object with custom metadata." }, "completed_at": { - "type": "string", - "nullable": true, - "description": "The date and time when the submission was fully completed." + "type": [ + "string", + "null" + ], + "description": "The date and time when the submission was completed." } } }, @@ -2840,8 +2983,10 @@ "description": "Submission unique ID number." }, "archived_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "Date and time when the submission was archived." } } @@ -2879,6 +3024,17 @@ }, "description": "The unique identifier of the submission.", "example": 1001 + }, + { + "name": "merge", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false + }, + "description": "When `true`, merges all documents into a single PDF.", + "example": false } ], "responses": { @@ -2899,6 +3055,7 @@ }, "documents": { "type": "array", + "description": "An array of completed or signed documents of the submission.", "items": { "type": "object", "required": [ @@ -2962,12 +3119,16 @@ "template_id": { "type": "integer", "description": "The unique identifier of the template.", - "example": 1000001 + "examples": [ + 1000001 + ] }, "emails": { "type": "string", "description": "A comma-separated list of email addresses to send the submission to.", - "example": "{{emails}}" + "examples": [ + "{{emails}}" + ] }, "send_email": { "type": "boolean", @@ -2976,6 +3137,7 @@ }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -3030,20 +3192,22 @@ }, "submission_id": { "type": "integer", - "description": "Submission UUID." + "description": "Submission unique ID number." }, "uuid": { "type": "string", "description": "Submitter UUID." }, "email": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The email address of the submitter." }, "slug": { "type": "string", - "description": "Unique key to be used in the signing form URL." + "description": "Unique key to be used in the form signing link and embedded form." }, "status": { "type": "string", @@ -3058,7 +3222,7 @@ }, "values": { "type": "array", - "description": "An array of pre-filled values for the submission.", + "description": "An array of pre-filled values for the submitter.", "items": { "type": "object", "required": [ @@ -3104,26 +3268,35 @@ } }, "metadata": { - "type": "object" + "type": "object", + "description": "Metadata object with additional submitter information." }, "sent_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the signing request was sent to the submitter." }, "opened_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the submitter opened the signing form." }, "completed_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the submitter completed the signing form." }, "declined_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the submitter declined the signing form." }, "created_at": { @@ -3135,22 +3308,29 @@ "description": "The date and time when the submitter was last updated." }, "name": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The name of the submitter." }, "phone": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The phone number of the submitter." }, "external_id": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "Your application-specific unique string key to identify this submitter within your app." }, "preferences": { "type": "object", + "description": "Submitter preferences.", "properties": { "send_email": { "type": "boolean", @@ -3273,7 +3453,9 @@ "name": { "type": "string", "description": "Name of the document submission.", - "example": "Test Submission Document" + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -3309,7 +3491,9 @@ "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -3321,6 +3505,7 @@ }, "documents": { "type": "array", + "description": "An array of PDF documents to create a submission.", "items": { "type": "object", "required": [ @@ -3333,7 +3518,9 @@ "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF file or downloadable file URL." @@ -3369,6 +3556,7 @@ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -3390,6 +3578,7 @@ }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "required": [ @@ -3419,7 +3608,9 @@ "page": { "type": "integer", "description": "Page number of the field area. Starts from 1.", - "example": 1 + "examples": [ + 1 + ] }, "option": { "type": "string", @@ -3434,9 +3625,11 @@ "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] } } @@ -3454,9 +3647,6 @@ "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -3465,18 +3655,24 @@ "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -3493,7 +3689,9 @@ "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -3543,7 +3741,9 @@ "name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -3574,7 +3774,9 @@ } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -3595,11 +3797,14 @@ }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -3635,11 +3840,14 @@ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -3701,12 +3909,16 @@ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -3756,6 +3968,7 @@ }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -3839,15 +4052,17 @@ "properties": { "id": { "type": "integer", - "description": "Submission unique ID number." + "description": "Submitter unique ID number." }, "uuid": { "type": "string", "description": "Submitter UUID." }, "email": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The email address of the submitter." }, "slug": { @@ -3855,24 +4070,32 @@ "description": "Unique key to be used in the form signing link and embedded form." }, "sent_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the signing request was sent to the submitter." }, "opened_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the submitter opened the signing form." }, "completed_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the submitter completed the signing form." }, "declined_at": { - "type": "string", - "nullable": true, - "description": "The date and time when the submitter declined to complete the signing form." + "type": [ + "string", + "null" + ], + "description": "The date and time when the submitter declined the signing form." }, "created_at": { "type": "string", @@ -3883,18 +4106,24 @@ "description": "The date and time when the submitter was last updated." }, "name": { - "type": "string", - "nullable": true, - "description": "Submitter name." + "type": [ + "string", + "null" + ], + "description": "The name of the submitter." }, "phone": { - "type": "string", - "nullable": true, - "description": "Submitter phone number." + "type": [ + "string", + "null" + ], + "description": "The phone number of the submitter." }, "external_id": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "Your application-specific unique string key to identify this submitter within your app." }, "status": { @@ -3957,7 +4186,7 @@ }, "role": { "type": "string", - "description": "The role of the submitter." + "description": "The role of the submitter in the signing process." }, "metadata": { "type": "object", @@ -3965,7 +4194,7 @@ }, "preferences": { "type": "object", - "description": "Object with submitter preferences." + "description": "Submitter preferences." }, "embed_src": { "type": "string", @@ -4067,6 +4296,7 @@ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -4076,6 +4306,7 @@ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", @@ -4177,7 +4408,9 @@ "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "created_at": { "type": "string", @@ -4271,7 +4504,7 @@ "Submissions" ], "summary": "Create a submission from DOCX", - "description": "The API endpoint provides functionality to create a one-off submission request from a DOCX file with dynamic content variables. Use [[variable_name]] text tags to define dynamic content variables in the document. See https://www.docuseal.com/examples/demo_template.docx for the specific text variable syntax, including dynamic content tables and list. You can also use the {{signature}} field syntax to define fillable fields, as in a PDF.
Related Guides
Use dynamic content variables in DOCX to create personalized documents", + "description": "The API endpoint provides functionality to create a one-off submission request from a DOCX file with dynamic content variables. Use [[variable_name]] text tags to define dynamic content variables in the document. See https://www.docuseal.com/examples/demo_template.docx for the specific text variable syntax, including dynamic content tables and lists. You can also use the {{signature}} field syntax to define fillable fields, as in a PDF.
Related Guides
Use dynamic content variables in DOCX to create personalized documents", "operationId": "createSubmissionFromDocx", "parameters": [], "requestBody": { @@ -4288,7 +4521,9 @@ "name": { "type": "string", "description": "Name of the document submission.", - "example": "Test Submission Document" + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -4303,9 +4538,11 @@ "variables": { "type": "object", "description": "Dynamic content variables object. Variable values can be strings, numbers, arrays, objects, or HTML content used to generate styled text, paragraphs, and tables in DOCX.", - "example": { - "variable_name": "value" - } + "examples": [ + { + "variable_name": "value" + } + ] }, "order": { "type": "string", @@ -4331,7 +4568,9 @@ "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -4343,6 +4582,7 @@ }, "documents": { "type": "array", + "description": "An array of DOCX documents to create a submission.", "items": { "type": "object", "required": [ @@ -4355,7 +4595,9 @@ "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF or DOCX file or downloadable file URL." @@ -4372,9 +4614,6 @@ "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -4383,18 +4622,24 @@ "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -4411,7 +4656,9 @@ "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -4461,7 +4708,9 @@ "name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -4492,7 +4741,9 @@ } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -4513,11 +4764,14 @@ }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -4553,11 +4807,14 @@ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -4619,12 +4876,16 @@ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -4674,6 +4935,7 @@ }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -4692,7 +4954,7 @@ }, "remove_tags": { "type": "boolean", - "description": "Pass `false` to disable the removal of {{text}} tags from the PDF. This can be used along with transparent text tags for faster and more robust PDF processing.", + "description": "Pass `false` to disable the removal of {{text}} tags from the document. This can be used along with transparent text tags for faster and more robust document processing.", "default": true } } @@ -4752,15 +5014,17 @@ "properties": { "id": { "type": "integer", - "description": "Submission unique ID number." + "description": "Submitter unique ID number." }, "uuid": { "type": "string", "description": "Submitter UUID." }, "email": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The email address of the submitter." }, "slug": { @@ -4768,24 +5032,32 @@ "description": "Unique key to be used in the form signing link and embedded form." }, "sent_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the signing request was sent to the submitter." }, "opened_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the submitter opened the signing form." }, "completed_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the submitter completed the signing form." }, "declined_at": { - "type": "string", - "nullable": true, - "description": "The date and time when the submitter declined to complete the signing form." + "type": [ + "string", + "null" + ], + "description": "The date and time when the submitter declined the signing form." }, "created_at": { "type": "string", @@ -4796,18 +5068,24 @@ "description": "The date and time when the submitter was last updated." }, "name": { - "type": "string", - "nullable": true, - "description": "Submitter name." + "type": [ + "string", + "null" + ], + "description": "The name of the submitter." }, "phone": { - "type": "string", - "nullable": true, - "description": "Submitter phone number." + "type": [ + "string", + "null" + ], + "description": "The phone number of the submitter." }, "external_id": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "Your application-specific unique string key to identify this submitter within your app." }, "status": { @@ -4870,7 +5148,7 @@ }, "role": { "type": "string", - "description": "The role of the submitter." + "description": "The role of the submitter in the signing process." }, "metadata": { "type": "object", @@ -4878,7 +5156,7 @@ }, "preferences": { "type": "object", - "description": "Object with submitter preferences." + "description": "Submitter preferences." }, "embed_src": { "type": "string", @@ -4980,6 +5258,7 @@ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -4989,6 +5268,7 @@ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", @@ -5090,7 +5370,9 @@ "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "created_at": { "type": "string", @@ -5200,8 +5482,10 @@ "properties": { "name": { "type": "string", - "description": "Name of the document submission", - "example": "Test Submission Document" + "description": "Name of the document submission.", + "examples": [ + "Test Submission Document" + ] }, "send_email": { "type": "boolean", @@ -5237,7 +5521,9 @@ "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "template_ids": { "type": "array", @@ -5259,12 +5545,16 @@ "name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Document" + "examples": [ + "Test Document" + ] }, "html": { "type": "string", "description": "HTML document content with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "html_header": { "type": "string", @@ -5291,7 +5581,9 @@ "A5", "A6" ], - "example": "A4" + "examples": [ + "A4" + ] }, "position": { "type": "integer", @@ -5305,9 +5597,6 @@ "description": "The list of submitters for the submission.", "items": { "type": "object", - "required": [ - "email" - ], "properties": { "name": { "type": "string", @@ -5316,18 +5605,24 @@ "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "email": { "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -5344,7 +5639,9 @@ "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "send_email": { "type": "boolean", @@ -5394,7 +5691,9 @@ "name": { "type": "string", "description": "Document field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -5425,7 +5724,9 @@ } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -5446,11 +5747,14 @@ }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -5486,11 +5790,14 @@ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -5552,12 +5859,16 @@ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -5607,6 +5918,7 @@ }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -5680,15 +5992,17 @@ "properties": { "id": { "type": "integer", - "description": "Submission unique ID number." + "description": "Submitter unique ID number." }, "uuid": { "type": "string", "description": "Submitter UUID." }, "email": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The email address of the submitter." }, "slug": { @@ -5696,24 +6010,32 @@ "description": "Unique key to be used in the form signing link and embedded form." }, "sent_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the signing request was sent to the submitter." }, "opened_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the submitter opened the signing form." }, "completed_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the submitter completed the signing form." }, "declined_at": { - "type": "string", - "nullable": true, - "description": "The date and time when the submitter declined to complete the signing form." + "type": [ + "string", + "null" + ], + "description": "The date and time when the submitter declined the signing form." }, "created_at": { "type": "string", @@ -5724,18 +6046,24 @@ "description": "The date and time when the submitter was last updated." }, "name": { - "type": "string", - "nullable": true, - "description": "Submitter name." + "type": [ + "string", + "null" + ], + "description": "The name of the submitter." }, "phone": { - "type": "string", - "nullable": true, - "description": "Submitter phone number." + "type": [ + "string", + "null" + ], + "description": "The phone number of the submitter." }, "external_id": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "Your application-specific unique string key to identify this submitter within your app." }, "status": { @@ -5798,7 +6126,7 @@ }, "role": { "type": "string", - "description": "The role of the submitter." + "description": "The role of the submitter in the signing process." }, "metadata": { "type": "object", @@ -5806,7 +6134,7 @@ }, "preferences": { "type": "object", - "description": "Object with submitter preferences." + "description": "Submitter preferences." }, "embed_src": { "type": "string", @@ -5908,6 +6236,7 @@ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -5917,6 +6246,7 @@ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", @@ -6018,7 +6348,9 @@ "expire_at": { "type": "string", "description": "Specify the expiration date and time after which the submission becomes unavailable for signature.", - "example": "2024-09-01 12:00:00 UTC" + "examples": [ + "2024-09-01 12:00:00 UTC" + ] }, "created_at": { "type": "string", @@ -6171,8 +6503,10 @@ "description": "Submitter UUID." }, "email": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The email address of the submitter." }, "slug": { @@ -6180,23 +6514,31 @@ "description": "Unique key to be used in the form signing link and embedded form." }, "sent_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the signing request was sent to the submitter." }, "opened_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the submitter opened the signing form." }, "completed_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the submitter completed the signing form." }, "declined_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the submitter declined the signing form." }, "created_at": { @@ -6208,18 +6550,22 @@ "description": "The date and time when the submitter was last updated." }, "name": { - "type": "string", - "nullable": true, - "description": "Submitter name." + "type": [ + "string", + "null" + ], + "description": "The name of the submitter." }, "phone": { - "type": "string", - "nullable": true, - "description": "Submitter phone number." + "type": [ + "string", + "null" + ], + "description": "The phone number of the submitter." }, "status": { "type": "string", - "description": "Submitter's submission status.", + "description": "The status of signing request for the submitter.", "enum": [ "completed", "declined", @@ -6229,9 +6575,11 @@ ] }, "external_id": { - "type": "string", - "nullable": true, - "description": "The unique applications-specific identifier" + "type": [ + "string", + "null" + ], + "description": "Your application-specific unique string key to identify this submitter within your app." }, "metadata": { "type": "object", @@ -6252,25 +6600,28 @@ "description": "Base template details.", "properties": { "id": { - "type": "number", - "description": "The template's unique identifier." + "type": "integer", + "description": "Unique identifier of the document template." }, "name": { "type": "string", - "description": "The template's name." + "description": "The name of the template." }, "created_at": { "type": "string", - "format": "date-time" + "format": "date-time", + "description": "The date and time when the template was created." }, "updated_at": { "type": "string", - "format": "date-time" + "format": "date-time", + "description": "The date and time when the template was last updated." } } }, "submission_events": { "type": "array", + "description": "An array of events related to the submission.", "items": { "type": "object", "required": [ @@ -6488,12 +6839,16 @@ "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "phone": { "type": "string", "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "values": { "type": "object", @@ -6523,7 +6878,9 @@ "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ \"customField\": \"value\" }" + "examples": [ + "{ \"customField\": \"value\" }" + ] }, "completed_redirect_url": { "type": "string", @@ -6534,8 +6891,14 @@ "description": "Set to `true` to require phone 2FA verification via a one-time code sent to the phone number in order to access the documents.", "default": false }, + "require_email_2fa": { + "type": "boolean", + "description": "Set to `true` to require email 2FA verification via a one-time code sent to the email address in order to access the documents.", + "default": false + }, "message": { "type": "object", + "description": "Custom signature request email message.", "properties": { "subject": { "type": "string", @@ -6559,7 +6922,9 @@ "name": { "type": "string", "description": "Document template field name.", - "example": "First Name" + "examples": [ + "First Name" + ] }, "default_value": { "oneOf": [ @@ -6590,7 +6955,9 @@ } ], "description": "Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.", - "example": "Acme" + "examples": [ + "Acme" + ] }, "readonly": { "type": "boolean", @@ -6603,11 +6970,14 @@ }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -6643,11 +7013,14 @@ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -6709,12 +7082,16 @@ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -6801,8 +7178,10 @@ "description": "Submitter UUID." }, "email": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The email address of the submitter." }, "slug": { @@ -6810,23 +7189,31 @@ "description": "Unique key to be used in the form signing link and embedded form." }, "sent_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the signing request was sent to the submitter." }, "opened_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the submitter opened the signing form." }, "completed_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the submitter completed the signing form." }, "declined_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the submitter declined the signing form." }, "created_at": { @@ -6838,18 +7225,22 @@ "description": "The date and time when the submitter was last updated." }, "name": { - "type": "string", - "nullable": true, - "description": "Submitter name." + "type": [ + "string", + "null" + ], + "description": "The name of the submitter." }, "phone": { - "type": "string", - "nullable": true, - "description": "Submitter phone number." + "type": [ + "string", + "null" + ], + "description": "The phone number of the submitter." }, "status": { "type": "string", - "description": "Submitter's submission status.", + "description": "The status of signing request for the submitter.", "enum": [ "completed", "declined", @@ -6859,9 +7250,11 @@ ] }, "external_id": { - "type": "string", - "nullable": true, - "description": "The unique applications-specific identifier" + "type": [ + "string", + "null" + ], + "description": "Your application-specific unique string key to identify this submitter within your app." }, "metadata": { "type": "object", @@ -7054,7 +7447,7 @@ "schema": { "type": "string" }, - "description": "The unique applications-specific identifier provided for a submitter when initializing a signature request. It allows you to receive only submitters with a specified external id." + "description": "The unique application-specific identifier provided for a submitter when initializing a signature request. It allows you to receive only submitters with a specified external ID." }, { "name": "limit", @@ -7072,7 +7465,7 @@ "schema": { "type": "integer" }, - "description": "The unique identifier of the submitter to start the list from. It allows you to receive only submitters with id greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of submitters." + "description": "The unique identifier of the submitter to start the list from. It allows you to receive only submitters with an ID greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of submitters." }, { "name": "before", @@ -7081,7 +7474,7 @@ "schema": { "type": "integer" }, - "description": "The unique identifier of the submitter to end the list with. It allows you to receive only submitters with id less than the specified value." + "description": "The unique identifier of the submitter to end the list with. It allows you to receive only submitters with an ID less than the specified value." } ], "responses": { @@ -7138,26 +7531,34 @@ }, "slug": { "type": "string", - "description": "Unique slug of the submitter form." + "description": "Unique key to be used in the form signing link and embedded form." }, "sent_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the signing request was sent to the submitter." }, "opened_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the submitter opened the signing form." }, "completed_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the submitter completed the signing form." }, "declined_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "The date and time when the submitter declined the signing form." }, "created_at": { @@ -7169,18 +7570,22 @@ "description": "The date and time when the submitter was last updated." }, "name": { - "type": "string", - "nullable": true, - "description": "Submitter name." + "type": [ + "string", + "null" + ], + "description": "The name of the submitter." }, "phone": { - "type": "string", - "nullable": true, - "description": "Submitter phone number." + "type": [ + "string", + "null" + ], + "description": "The phone number of the submitter." }, "status": { "type": "string", - "description": "Submitter's submission status.", + "description": "The status of signing request for the submitter.", "enum": [ "completed", "declined", @@ -7190,9 +7595,11 @@ ] }, "external_id": { - "type": "string", - "nullable": true, - "description": "The unique applications-specific identifier" + "type": [ + "string", + "null" + ], + "description": "Your application-specific unique string key to identify this submitter within your app." }, "preferences": { "type": "object", @@ -7204,6 +7611,7 @@ }, "submission_events": { "type": "array", + "description": "An array of events related to the submission.", "items": { "type": "object", "required": [ @@ -7215,7 +7623,7 @@ "properties": { "id": { "type": "integer", - "description": "Unique identifier of the submission event." + "description": "Submission event unique ID number." }, "submitter_id": { "type": "integer", @@ -7258,7 +7666,7 @@ }, "values": { "type": "array", - "description": "An array of pre-filled values for the submission.", + "description": "An array of pre-filled values for the submitter.", "items": { "type": "object", "required": [ @@ -7344,13 +7752,17 @@ "description": "Submitters count." }, "next": { - "type": "integer", - "nullable": true, + "type": [ + "integer", + "null" + ], "description": "The ID of the submitter after which the next page starts." }, "prev": { - "type": "integer", - "nullable": true, + "type": [ + "integer", + "null" + ], "description": "The ID of the submitter before which the previous page ends." } } @@ -7440,7 +7852,7 @@ "schema": { "type": "integer" }, - "description": "The unique identifier of the documents template.", + "description": "The unique identifier of the document template.", "example": 1000001 } ], @@ -7460,7 +7872,9 @@ "name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Template" + "examples": [ + "Test Template" + ] }, "file": { "type": "string", @@ -7474,7 +7888,9 @@ "position": { "type": "integer", "description": "Position of the document. By default will be added as the last document in the template.", - "example": 0 + "examples": [ + 0 + ] }, "replace": { "type": "boolean", @@ -7536,7 +7952,7 @@ }, "name": { "type": "string", - "description": "Name of the template." + "description": "The name of the template." }, "preferences": { "type": "object", @@ -7554,7 +7970,7 @@ "properties": { "attachment_uuid": { "type": "string", - "description": "Unique indentifier of attached document to the template." + "description": "Unique identifier of attached document to the template." }, "name": { "type": "string", @@ -7610,6 +8026,7 @@ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -7619,6 +8036,7 @@ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", @@ -7719,6 +8137,7 @@ }, "submitters": { "type": "array", + "description": "The list of submitters for the template.", "items": { "type": "object", "required": [ @@ -7728,7 +8147,7 @@ "properties": { "name": { "type": "string", - "description": "Submitter name." + "description": "The name of the submitter." }, "uuid": { "type": "string", @@ -7742,17 +8161,19 @@ "description": "Unique identifier of the author of the template." }, "archived_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "Date and time when the template was archived." }, "created_at": { "type": "string", - "description": "Date and time when the template was created." + "description": "The date and time when the template was created." }, "updated_at": { "type": "string", - "description": "Date and time when the template was updated." + "description": "The date and time when the template was last updated." }, "source": { "type": "string", @@ -7764,17 +8185,19 @@ ] }, "external_id": { - "type": "string", - "nullable": true, - "description": "Identifier of the template in the external system." + "type": [ + "string", + "null" + ], + "description": "Your application-specific unique string key to identify this template within your app." }, "folder_id": { "type": "integer", - "description": "Unique identifier of the folder where the template is placed." + "description": "Unique identifier of the folder where the template is located." }, "folder_name": { "type": "string", - "description": "Folder name where the template is placed." + "description": "Folder name where the template is located." }, "shared_link": { "type": "boolean", @@ -7919,7 +8342,7 @@ "Templates" ], "summary": "Clone a template", - "description": "The API endpoint allows you to clone existing template into a new template.", + "description": "The API endpoint allows you to clone an existing template into a new template.", "operationId": "cloneTemplate", "parameters": [ { @@ -7929,7 +8352,7 @@ "schema": { "type": "integer" }, - "description": "The unique identifier of the documents template.", + "description": "The unique identifier of the document template.", "example": 1000001 } ], @@ -7943,7 +8366,9 @@ "name": { "type": "string", "description": "Template name. Existing name with (Clone) suffix will be used if not specified.", - "example": "Cloned Template" + "examples": [ + "Cloned Template" + ] }, "folder_name": { "type": "string", @@ -7995,7 +8420,7 @@ }, "name": { "type": "string", - "description": "Name of the template." + "description": "The name of the template." }, "preferences": { "type": "object", @@ -8013,7 +8438,7 @@ "properties": { "attachment_uuid": { "type": "string", - "description": "Unique indentifier of attached document to the template." + "description": "Unique identifier of attached document to the template." }, "name": { "type": "string", @@ -8069,6 +8494,7 @@ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -8078,6 +8504,7 @@ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", @@ -8178,6 +8605,7 @@ }, "submitters": { "type": "array", + "description": "The list of submitters for the template.", "items": { "type": "object", "required": [ @@ -8187,7 +8615,7 @@ "properties": { "name": { "type": "string", - "description": "Submitter name." + "description": "The name of the submitter." }, "uuid": { "type": "string", @@ -8201,17 +8629,19 @@ "description": "Unique identifier of the author of the template." }, "archived_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "Date and time when the template was archived." }, "created_at": { "type": "string", - "description": "Date and time when the template was created." + "description": "The date and time when the template was created." }, "updated_at": { "type": "string", - "description": "Date and time when the template was updated." + "description": "The date and time when the template was last updated." }, "source": { "type": "string", @@ -8223,17 +8653,19 @@ ] }, "external_id": { - "type": "string", - "nullable": true, - "description": "Identifier of the template in the external system." + "type": [ + "string", + "null" + ], + "description": "Your application-specific unique string key to identify this template within your app." }, "folder_id": { "type": "integer", - "description": "Unique identifier of the folder where the template is placed." + "description": "Unique identifier of the folder where the template is located." }, "folder_name": { "type": "string", - "description": "Folder name where the template is placed." + "description": "Folder name where the template is located." }, "shared_link": { "type": "boolean", @@ -8396,7 +8828,9 @@ "html": { "type": "string", "description": "HTML template with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "html_header": { "type": "string", @@ -8409,7 +8843,9 @@ "name": { "type": "string", "description": "Template name. Random uuid will be assigned when not specified.", - "example": "Test Template" + "examples": [ + "Test Template" + ] }, "size": { "type": "string", @@ -8428,20 +8864,24 @@ "A5", "A6" ], - "example": "A4" + "examples": [ + "A4" + ] }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new HTML.", - "example": "714d974e-83d8-11ee-b962-0242ac120002" + "examples": [ + "714d974e-83d8-11ee-b962-0242ac120002" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { @@ -8456,12 +8896,16 @@ "html": { "type": "string", "description": "HTML template with field tags.", - "example": "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + "examples": [ + "

Lorem Ipsum is simply dummy text of the\n\n\nand typesetting industry

\n" + ] }, "name": { "type": "string", "description": "Document name. Random uuid will be assigned when not specified.", - "example": "Test Document" + "examples": [ + "Test Document" + ] } } } @@ -8508,7 +8952,7 @@ }, "name": { "type": "string", - "description": "Name of the template." + "description": "The name of the template." }, "preferences": { "type": "object", @@ -8526,7 +8970,7 @@ "properties": { "attachment_uuid": { "type": "string", - "description": "Unique indentifier of attached document to the template." + "description": "Unique identifier of attached document to the template." }, "name": { "type": "string", @@ -8582,6 +9026,7 @@ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -8591,6 +9036,7 @@ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", @@ -8691,6 +9137,7 @@ }, "submitters": { "type": "array", + "description": "The list of submitters for the template.", "items": { "type": "object", "required": [ @@ -8700,7 +9147,7 @@ "properties": { "name": { "type": "string", - "description": "Submitter name." + "description": "The name of the submitter." }, "uuid": { "type": "string", @@ -8714,17 +9161,19 @@ "description": "Unique identifier of the author of the template." }, "archived_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "Date and time when the template was archived." }, "created_at": { "type": "string", - "description": "Date and time when the template was created." + "description": "The date and time when the template was created." }, "updated_at": { "type": "string", - "description": "Date and time when the template was updated." + "description": "The date and time when the template was last updated." }, "source": { "type": "string", @@ -8736,17 +9185,19 @@ ] }, "external_id": { - "type": "string", - "nullable": true, - "description": "Identifier of the template in the external system." + "type": [ + "string", + "null" + ], + "description": "Your application-specific unique string key to identify this template within your app." }, "folder_id": { "type": "integer", - "description": "Unique identifier of the folder where the template is placed." + "description": "Unique identifier of the folder where the template is located." }, "folder_name": { "type": "string", - "description": "Folder name where the template is placed." + "description": "Folder name where the template is located." }, "shared_link": { "type": "boolean", @@ -8892,7 +9343,7 @@ "Templates" ], "summary": "Create a template from Word DOCX", - "description": "The API endpoint provides the functionality to create a fillable document template for existing Microsoft Word document. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See https://www.docuseal.com/examples/fieldtags.docx for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.
Related Guides
Use embedded text field tags to create a fillable form\n", + "description": "The API endpoint provides the functionality to create a fillable document template for an existing Microsoft Word document. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See https://www.docuseal.com/examples/fieldtags.docx for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.
Related Guides
Use embedded text field tags to create a fillable form\n", "operationId": "createTemplateFromDocx", "parameters": [], "requestBody": { @@ -8907,25 +9358,30 @@ "properties": { "name": { "type": "string", - "description": "Name of the template", - "example": "Test DOCX" + "description": "Name of the template.", + "examples": [ + "Test DOCX" + ] }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new document.", - "example": "unique-key" + "examples": [ + "unique-key" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { "type": "array", + "description": "An array of DOCX documents to create a template.", "items": { "type": "object", "required": [ @@ -8939,9 +9395,16 @@ }, "file": { "type": "string", - "example": "base64", + "examples": [ + "base64" + ], "format": "base64", - "description": "Base64-encoded content of the DOCX file or downloadable file URL" + "description": "Base64-encoded content of the DOCX file or downloadable file URL." + }, + "dynamic": { + "type": "boolean", + "description": "Set to `true` to make the document dynamic. When enabled, the DOCX document content can be edited or use [[variables]] in the template editor.", + "default": false }, "fields": { "description": "Fields are optional if you use {{...}} text tags to define fields in the document.", @@ -8974,6 +9437,7 @@ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -8995,6 +9459,7 @@ }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "properties": { @@ -9031,18 +9496,23 @@ "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -9078,11 +9548,14 @@ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -9144,12 +9617,16 @@ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -9232,7 +9709,7 @@ }, "name": { "type": "string", - "description": "Name of the template." + "description": "The name of the template." }, "preferences": { "type": "object", @@ -9250,7 +9727,7 @@ "properties": { "attachment_uuid": { "type": "string", - "description": "Unique indentifier of attached document to the template." + "description": "Unique identifier of attached document to the template." }, "name": { "type": "string", @@ -9306,6 +9783,7 @@ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -9315,6 +9793,7 @@ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", @@ -9415,6 +9894,7 @@ }, "submitters": { "type": "array", + "description": "The list of submitters for the template.", "items": { "type": "object", "required": [ @@ -9424,7 +9904,7 @@ "properties": { "name": { "type": "string", - "description": "Submitter name." + "description": "The name of the submitter." }, "uuid": { "type": "string", @@ -9438,17 +9918,19 @@ "description": "Unique identifier of the author of the template." }, "archived_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "Date and time when the template was archived." }, "created_at": { "type": "string", - "description": "Date and time when the template was created." + "description": "The date and time when the template was created." }, "updated_at": { "type": "string", - "description": "Date and time when the template was updated." + "description": "The date and time when the template was last updated." }, "source": { "type": "string", @@ -9460,17 +9942,19 @@ ] }, "external_id": { - "type": "string", - "nullable": true, - "description": "Identifier of the template in the external system." + "type": [ + "string", + "null" + ], + "description": "Your application-specific unique string key to identify this template within your app." }, "folder_id": { "type": "integer", - "description": "Unique identifier of the folder where the template is placed." + "description": "Unique identifier of the folder where the template is located." }, "folder_name": { "type": "string", - "description": "Folder name where the template is placed." + "description": "Folder name where the template is located." }, "shared_link": { "type": "boolean", @@ -9631,25 +10115,30 @@ "properties": { "name": { "type": "string", - "description": "Name of the template", - "example": "Test PDF" + "description": "Name of the template.", + "examples": [ + "Test PDF" + ] }, "folder_name": { "type": "string", - "description": "The folder's name to which the template should be created." + "description": "The folder's name in which the template should be created." }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new PDF.", - "example": "unique-key" + "examples": [ + "unique-key" + ] }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "documents": { "type": "array", + "description": "An array of PDF documents to create a template.", "items": { "type": "object", "required": [ @@ -9662,7 +10151,9 @@ "description": "Name of the document." }, "file": { - "example": "base64", + "examples": [ + "base64" + ], "type": "string", "format": "base64", "description": "Base64-encoded content of the PDF file or downloadable file URL." @@ -9698,6 +10189,7 @@ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -9719,6 +10211,7 @@ }, "areas": { "type": "array", + "description": "List of areas where the field is located in the document.", "items": { "type": "object", "required": [ @@ -9748,7 +10241,9 @@ "page": { "type": "integer", "description": "Page number of the field area. Starts from 1.", - "example": 1 + "examples": [ + 1 + ] }, "option": { "type": "string", @@ -9763,18 +10258,23 @@ "items": { "type": "string" }, - "example": [ - "Option A", - "Option B" + "examples": [ + [ + "Option A", + "Option B" + ] ] }, "validation": { "type": "object", + "description": "Field validation rules.", "properties": { "pattern": { "type": "string", "description": "HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.", - "example": "[A-Z]{4}" + "examples": [ + "[A-Z]{4}" + ] }, "message": { "type": "string", @@ -9810,11 +10310,14 @@ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", "description": "Font size of the field value in pixels.", - "example": 12 + "examples": [ + 12 + ] }, "font_type": { "type": "string", @@ -9876,12 +10379,16 @@ "format": { "type": "string", "description": "The data format for different field types.
- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).
- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.
- Number field: accepts currency formats such as usd, eur, gbp.", - "example": "DD/MM/YYYY" + "examples": [ + "DD/MM/YYYY" + ] }, "price": { "type": "number", "description": "Price value of the payment field. Only for payment fields.", - "example": 99.99 + "examples": [ + 99.99 + ] }, "currency": { "type": "string", @@ -9974,7 +10481,7 @@ }, "name": { "type": "string", - "description": "Name of the template." + "description": "The name of the template." }, "preferences": { "type": "object", @@ -9992,7 +10499,7 @@ "properties": { "attachment_uuid": { "type": "string", - "description": "Unique indentifier of attached document to the template." + "description": "Unique identifier of attached document to the template." }, "name": { "type": "string", @@ -10048,6 +10555,7 @@ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -10057,6 +10565,7 @@ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", @@ -10157,6 +10666,7 @@ }, "submitters": { "type": "array", + "description": "The list of submitters for the template.", "items": { "type": "object", "required": [ @@ -10166,7 +10676,7 @@ "properties": { "name": { "type": "string", - "description": "Submitter name." + "description": "The name of the submitter." }, "uuid": { "type": "string", @@ -10180,17 +10690,19 @@ "description": "Unique identifier of the author of the template." }, "archived_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "Date and time when the template was archived." }, "created_at": { "type": "string", - "description": "Date and time when the template was created." + "description": "The date and time when the template was created." }, "updated_at": { "type": "string", - "description": "Date and time when the template was updated." + "description": "The date and time when the template was last updated." }, "source": { "type": "string", @@ -10202,17 +10714,19 @@ ] }, "external_id": { - "type": "string", - "nullable": true, - "description": "Identifier of the template in the external system." + "type": [ + "string", + "null" + ], + "description": "Your application-specific unique string key to identify this template within your app." }, "folder_id": { "type": "integer", - "description": "Unique identifier of the folder where the template is placed." + "description": "Unique identifier of the folder where the template is located." }, "folder_name": { "type": "string", - "description": "Folder name where the template is placed." + "description": "Folder name where the template is located." }, "shared_link": { "type": "boolean", @@ -10377,15 +10891,19 @@ "items": { "type": "integer" }, - "example": [ - 321, - 432 + "examples": [ + [ + 321, + 432 + ] ] }, "name": { "type": "string", "description": "Template name. Existing name with (Merged) suffix will be used if not specified.", - "example": "Merged Template" + "examples": [ + "Merged Template" + ] }, "folder_name": { "type": "string", @@ -10397,7 +10915,7 @@ }, "shared_link": { "type": "boolean", - "description": "set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", + "description": "Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.", "default": true }, "roles": { @@ -10406,9 +10924,11 @@ "items": { "type": "string" }, - "example": [ - "Agent", - "Customer" + "examples": [ + [ + "Agent", + "Customer" + ] ] } } @@ -10453,7 +10973,7 @@ }, "name": { "type": "string", - "description": "Name of the template." + "description": "The name of the template." }, "preferences": { "type": "object", @@ -10471,7 +10991,7 @@ "properties": { "attachment_uuid": { "type": "string", - "description": "Unique indentifier of attached document to the template." + "description": "Unique identifier of attached document to the template." }, "name": { "type": "string", @@ -10527,6 +11047,7 @@ "payment", "phone", "verification", + "kba", "strikethrough" ] }, @@ -10536,6 +11057,7 @@ }, "preferences": { "type": "object", + "description": "Field display preferences.", "properties": { "font_size": { "type": "integer", @@ -10636,6 +11158,7 @@ }, "submitters": { "type": "array", + "description": "The list of submitters for the template.", "items": { "type": "object", "required": [ @@ -10645,7 +11168,7 @@ "properties": { "name": { "type": "string", - "description": "Submitter name." + "description": "The name of the submitter." }, "uuid": { "type": "string", @@ -10659,17 +11182,19 @@ "description": "Unique identifier of the author of the template." }, "archived_at": { - "type": "string", - "nullable": true, + "type": [ + "string", + "null" + ], "description": "Date and time when the template was archived." }, "created_at": { "type": "string", - "description": "Date and time when the template was created." + "description": "The date and time when the template was created." }, "updated_at": { "type": "string", - "description": "Date and time when the template was updated." + "description": "The date and time when the template was last updated." }, "source": { "type": "string", @@ -10681,17 +11206,19 @@ ] }, "external_id": { - "type": "string", - "nullable": true, - "description": "Identifier of the template in the external system." + "type": [ + "string", + "null" + ], + "description": "Your application-specific unique string key to identify this template within your app." }, "folder_id": { "type": "integer", - "description": "Unique identifier of the folder where the template is placed." + "description": "Unique identifier of the folder where the template is located." }, "folder_name": { "type": "string", - "description": "Folder name where the template is placed." + "description": "Folder name where the template is located." }, "shared_link": { "type": "boolean", @@ -10827,5 +11354,1171 @@ } } } + }, + "webhooks": { + "formWebhook": { + "post": { + "summary": "Form Webhook", + "description": "During the form filling and signing process, 4 types of events may occur and are dispatched at different stages:
  • 'form.viewed' event is triggered when the submitter first opens the form.
  • 'form.started' event is triggered when the submitter initiates filling out the form.
  • 'form.completed' event is triggered upon successful form completion and signing by one of the parties.
  • 'form.declined' event is triggered when a signer declines the submission.
It's important to note that each of these events contain information available at the time of dispatch, so some data may be missing or incomplete depending on the specific event. Failed webhook requests (4xx, 5xx) are automatically retried multiple times within 48 hours (every 2^attempt minutes) for all production accounts.
Related Guides
Download Signed Documents", + "operationId": "formWebhook", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "event_type": { + "type": "string", + "description": "The event type.", + "enum": [ + "form.viewed", + "form.started", + "form.completed", + "form.declined" + ] + }, + "timestamp": { + "type": "string", + "description": "The event timestamp.", + "examples": [ + "2023-09-24T11:20:42Z" + ], + "format": "date-time" + }, + "data": { + "type": "object", + "description": "Submitted data object.", + "properties": { + "id": { + "type": "number", + "description": "The submitter's unique identifier." + }, + "email": { + "type": "string", + "description": "The submitter's email address", + "format": "email", + "examples": [ + "john.doe@example.com" + ] + }, + "ua": { + "type": "string", + "description": "The user agent string that provides information about the submitter's web browser.", + "examples": [ + "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36" + ] + }, + "ip": { + "type": "string", + "description": "The submitter's IP address." + }, + "name": { + "type": "string", + "description": "The submitter's name." + }, + "phone": { + "type": "string", + "description": "The submitter's phone number, formatted according to the E.164 standard.", + "examples": [ + "+1234567890" + ] + }, + "role": { + "type": "string", + "description": "The submitter's role name or title.", + "examples": [ + "First Party" + ] + }, + "external_id": { + "type": "string", + "description": "Your application-specific unique string key to identify submitter within your app." + }, + "decline_reason": { + "type": "string", + "description": "Submitter provided decline message." + }, + "sent_at": { + "type": "string", + "description": "The date and time when the signing request was sent to the submitter.", + "format": "date-time" + }, + "status": { + "type": "string", + "description": "The submitter status.", + "enum": [ + "completed", + "declined", + "opened", + "sent", + "awaiting" + ] + }, + "opened_at": { + "type": "string", + "description": "The date and time when the submitter opened the signing form.", + "format": "date-time" + }, + "completed_at": { + "type": "string", + "description": "The date and time when the submitter completed the signing form.", + "format": "date-time" + }, + "declined_at": { + "type": "string", + "description": "The date and time when the submitter declined the signing form.", + "format": "date-time" + }, + "created_at": { + "type": "string", + "description": "The date and time when the submitter was created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The date and time when the submitter was last updated.", + "format": "date-time" + }, + "submission": { + "type": "object", + "description": "The submission details.", + "properties": { + "id": { + "type": "number", + "description": "The submission's unique identifier." + }, + "audit_log_url": { + "type": "string", + "description": "The audit log PDF URL. Available only if the submission was completed by all submitters." + }, + "combined_document_url": { + "type": "string", + "description": "The URL of the combined documents with audit log. Combined documents can be enabled via /settings/accounts." + }, + "status": { + "type": "string", + "description": "The submission status.", + "enum": [ + "completed", + "declined", + "expired", + "pending" + ] + }, + "url": { + "type": "string", + "description": "The submission URL." + }, + "variables": { + "type": "object", + "description": "Dynamic content variables object." + }, + "created_at": { + "type": "string", + "description": "The submission creation date.", + "format": "date-time" + } + } + }, + "template": { + "type": "object", + "description": "Base template details.", + "properties": { + "id": { + "type": "number", + "description": "The template's unique identifier." + }, + "name": { + "type": "string", + "description": "The template's name." + }, + "external_id": { + "type": "string", + "description": "Your application-specific unique string key to identify template within your app." + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "folder_name": { + "type": "string", + "description": "Template folder name." + } + } + }, + "preferences": { + "type": "object", + "description": "Submitter preferences for notifications.", + "properties": { + "send_email": { + "type": "boolean", + "description": "The flag indicating whether the submitter has opted to receive an email." + }, + "send_sms": { + "type": "boolean", + "description": "The flag indicating whether the submitter has opted to receive an SMS." + } + } + }, + "values": { + "type": "array", + "description": "List of the filled values passed by the submitter.", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "The field name." + }, + "value": { + "type": "string", + "description": "The field value." + } + } + } + }, + "metadata": { + "type": "object", + "description": "Metadata object with additional submitter information." + }, + "audit_log_url": { + "type": "string", + "description": "The audit log PDF URL. Available only if the submission was completed by all submitters." + }, + "submission_url": { + "type": "string", + "description": "The submission URL." + }, + "documents": { + "type": "array", + "description": "List of completed documents signed by the submitter.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The document file name." + }, + "url": { + "type": "string", + "description": "The document file URL." + } + } + } + } + } + } + } + }, + "example": { + "event_type": "form.completed", + "timestamp": "2023-09-24T13:48:36Z", + "data": { + "id": 1, + "email": "john.doe@example.com", + "ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36", + "ip": "132.216.88.83", + "sent_at": "2023-08-20T10:09:05.459Z", + "opened_at": "2023-08-20T10:10:00.451Z", + "completed_at": "2023-08-20T10:12:47.579Z", + "declined_at": null, + "created_at": "2023-08-20T10:09:02.459Z", + "updated_at": "2023-08-20T10:12:47.907Z", + "name": null, + "phone": null, + "role": "First Party", + "external_id": null, + "decline_reason": null, + "status": "completed", + "preferences": { + "send_email": true, + "send_sms": false + }, + "submission": { + "id": 12, + "audit_log_url": "https://docuseal.com/blobs/proxy/eyJfcmFpbHMiOnsib/audit-log.pdf", + "combined_document_url": "https://docuseal.com/blobs/proxy/eyJfcmFpbHMiOnsib/document.pdf", + "status": "completed", + "url": "https://docuseal.com/e/N5JsdkFGPeQF7J", + "variables": { + "custom_variable": "value" + }, + "created_at": "2023-08-20T10:09:05.258Z" + }, + "template": { + "id": 6, + "name": "Invoice", + "external_id": null, + "created_at": "2023-08-19T11:09:21.487Z", + "updated_at": "2023-08-19T11:11:47.804Z", + "folder_name": "Default" + }, + "values": [ + { + "field": "First Name", + "value": "John" + }, + { + "field": "Last Name", + "value": "Doe" + }, + { + "field": "Signature", + "value": "https://docuseal.com/blobs/proxy/eyJfcmFpbHMiOnsib/signature.png" + }, + { + "field": "Signature", + "value": "John Doe" + } + ], + "metadata": { + "customData": "custom value" + }, + "audit_log_url": "https://docuseal.com/blobs/proxy/eyJfcmFpbHMiOnsib/audit-log.pdf", + "submission_url": "https://docuseal.com/e/N5JsdkFGPeQF7J", + "documents": [ + { + "name": "sample-document", + "url": "https://docuseal.com/blobs/proxy/eyJfcmFpbHMiOnsib/sample-document.pdf" + } + ] + } + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 response to acknowledge successful receipt of the webhook event." + } + } + } + }, + "submissionWebhook": { + "post": { + "summary": "Submission Webhook", + "description": "Get submission creation, completion, expiration, and archiving notifications using these events:
  • 'submission.created' event is triggered when the submission is created.
  • 'submission.completed' event is triggered when the submission is completed by all signing parties.
  • 'submission.expired' event is triggered when the submission expires.
  • 'submission.archived' event is triggered when the submission is archived.
", + "operationId": "submissionWebhook", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "event_type": { + "type": "string", + "description": "The event type.", + "enum": [ + "submission.created", + "submission.completed", + "submission.expired", + "submission.archived" + ] + }, + "timestamp": { + "type": "string", + "description": "The event timestamp.", + "examples": [ + "2023-09-24T11:20:42Z" + ], + "format": "date-time" + }, + "data": { + "type": "object", + "description": "Submitted data object.", + "properties": { + "id": { + "type": "number", + "description": "The submission's unique identifier." + }, + "name": { + "type": "string", + "description": "Name of the document submission." + }, + "slug": { + "type": "string", + "description": "Unique slug of the submission." + }, + "expire_at": { + "type": [ + "string", + "null" + ], + "description": "The date and time when the submission will expire." + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "description": "The submission archive date." + }, + "created_at": { + "type": "string", + "description": "The submission creation date." + }, + "updated_at": { + "type": "string", + "description": "The submission update date." + }, + "source": { + "type": "string", + "description": "The submission source.", + "enum": [ + "invite", + "bulk", + "api", + "embed", + "link" + ] + }, + "submitters_order": { + "type": "string", + "description": "The submitters order.", + "enum": [ + "random", + "preserved" + ] + }, + "audit_log_url": { + "type": [ + "string", + "null" + ], + "description": "Audit log file URL." + }, + "combined_document_url": { + "type": [ + "string", + "null" + ], + "description": "Combined PDF file URL with documents and Audit Log." + }, + "submitters": { + "type": "array", + "description": "The list of submitters for the submission.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The submitter's unique identifier." + }, + "submission_id": { + "type": "number", + "description": "The unique submission identifier." + }, + "uuid": { + "type": "string", + "description": "The submitter UUID." + }, + "email": { + "type": "string", + "description": "The email address of the submitter.", + "format": "email", + "examples": [ + "john.doe@example.com" + ] + }, + "slug": { + "type": "string", + "description": "The unique slug of the document template." + }, + "sent_at": { + "type": [ + "string", + "null" + ], + "description": "The date and time when the signing request was sent to the submitter." + }, + "opened_at": { + "type": [ + "string", + "null" + ], + "description": "The date and time when the submitter opened the signing form." + }, + "completed_at": { + "type": [ + "string", + "null" + ], + "description": "The date and time when the submitter completed the signing form." + }, + "declined_at": { + "type": [ + "string", + "null" + ], + "description": "The date and time when the submitter declined the signing form." + }, + "created_at": { + "type": "string", + "description": "The date and time when the submitter was created." + }, + "updated_at": { + "type": "string", + "description": "The date and time when the submitter was last updated." + }, + "name": { + "type": [ + "string", + "null" + ], + "description": "The name of the submitter." + }, + "phone": { + "type": [ + "string", + "null" + ], + "description": "The phone number of the submitter, formatted according to the E.164 standard.", + "examples": [ + "+1234567890" + ] + }, + "role": { + "type": "string", + "description": "The role name or title of the submitter.", + "examples": [ + "First Party" + ] + }, + "external_id": { + "type": [ + "string", + "null" + ], + "description": "Your application-specific unique string key to identify this submitter within your app." + }, + "metadata": { + "type": "object", + "description": "Metadata object with additional submitter information.", + "examples": [ + "{ 'customField': 'value' }" + ] + }, + "status": { + "type": "string", + "description": "The submitter status.", + "enum": [ + "completed", + "declined", + "opened", + "sent", + "awaiting" + ] + }, + "values": { + "type": "object", + "description": "An object with pre-filled values for the submission. Use field names for keys of the object. For more configurations see `fields` param." + }, + "documents": { + "type": "array", + "description": "The list of documents for the submission.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The document file name." + }, + "url": { + "type": "string", + "description": "The document file URL." + } + } + } + }, + "preferences": { + "type": "object", + "description": "The submitter preferences." + } + } + } + }, + "template": { + "type": "object", + "description": "Base template details.", + "properties": { + "id": { + "type": "number", + "description": "The template's unique identifier." + }, + "name": { + "type": "string", + "description": "The template's name." + }, + "external_id": { + "type": "string", + "description": "Your application-specific unique string key to identify template within your app." + }, + "folder_name": { + "type": "string", + "description": "The folder name." + }, + "created_at": { + "type": "string", + "description": "The date and time when the template was created." + }, + "updated_at": { + "type": "string", + "description": "The date and time when the template was last updated." + } + } + }, + "variables": { + "type": "object", + "description": "Dynamic content variables object." + }, + "created_by_user": { + "type": "object", + "description": "User who created the submission.", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the user who created the submission." + }, + "first_name": { + "type": "string", + "description": "The first name of the user who created the submission." + }, + "last_name": { + "type": "string", + "description": "The last name of the user who created the submission." + }, + "email": { + "type": "string", + "description": "The email address of the user who created the submission." + } + } + }, + "submission_events": { + "type": "array", + "description": "List of submission events.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Submission event unique ID number." + }, + "submitter_id": { + "type": "integer", + "description": "Unique identifier of the submitter that triggered the event." + }, + "event_type": { + "type": "string", + "description": "Event type.", + "enum": [ + "send_email", + "bounce_email", + "complaint_email", + "send_reminder_email", + "send_sms", + "send_2fa_sms", + "open_email", + "click_email", + "click_sms", + "phone_verified", + "start_form", + "start_verification", + "complete_verification", + "view_form", + "invite_party", + "complete_form", + "decline_form", + "api_complete_form" + ] + }, + "event_timestamp": { + "type": "string", + "description": "Date and time when the event was triggered." + }, + "data": { + "type": "object", + "description": "Additional event details object." + } + } + } + }, + "documents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Document name." + }, + "url": { + "type": "string", + "description": "Document URL." + } + } + } + }, + "status": { + "type": "string", + "description": "The status of the submission.", + "enum": [ + "completed", + "declined", + "expired", + "pending" + ] + }, + "completed_at": { + "type": "string", + "description": "The date and time when the submission was fully completed." + } + } + } + } + }, + "example": { + "event_type": "submission.created", + "timestamp": "2024-05-26T17:32:33.518Z", + "data": { + "id": 1, + "name": "Sample Submission", + "slug": "VyL4szTwYoSvXq", + "expire_at": null, + "archived_at": null, + "created_at": "2024-05-26T17:32:33.447Z", + "updated_at": "2024-05-26T17:32:33.447Z", + "source": "invite", + "submitters_order": "random", + "audit_log_url": null, + "combined_document_url": null, + "submitters": [ + { + "id": 1, + "submission_id": 1, + "uuid": "6b92a2d0-b511-4678-bccf-1e8a131f5030", + "email": "mike@example.com", + "slug": "S6fWFYRZus6suW", + "sent_at": null, + "opened_at": null, + "completed_at": null, + "declined_at": null, + "created_at": "2024-05-26T17:32:33.466Z", + "updated_at": "2024-05-26T17:32:33.466Z", + "name": null, + "phone": null, + "external_id": null, + "metadata": {}, + "status": "awaiting", + "values": [], + "documents": [], + "preferences": {}, + "role": "First Party" + } + ], + "template": { + "id": 1, + "name": "Sample Document", + "created_at": "2024-05-26T16:57:28.092Z", + "updated_at": "2024-05-26T16:58:07.314Z", + "external_id": null, + "folder_name": "Default" + }, + "variables": { + "custom_variable": "value" + }, + "created_by_user": { + "id": 1, + "first_name": "John", + "last_name": "Doe", + "email": "john.doe@example.com" + }, + "submission_events": [], + "documents": [], + "status": "pending", + "completed_at": null + } + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 response to acknowledge successful receipt of the webhook event." + } + } + } + }, + "templateWebhook": { + "post": { + "summary": "Template Webhook", + "operationId": "templateWebhook", + "description": "Get template creation and update notifications using these events:
  • 'template.created' is triggered when the template is created.
  • 'template.updated' is triggered when the template is updated.
  • 'template.archived' is triggered when the template is archived.
", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "event_type": { + "type": "string", + "description": "The event type.", + "enum": [ + "template.created", + "template.updated", + "template.archived" + ] + }, + "timestamp": { + "type": "string", + "description": "The event timestamp.", + "examples": [ + "2023-09-24T11:20:42Z" + ], + "format": "date-time" + }, + "data": { + "type": "object", + "description": "Submitted data object.", + "properties": { + "id": { + "type": "number", + "description": "The template's unique identifier." + }, + "slug": { + "type": "string", + "description": "The template's unique slug." + }, + "name": { + "type": "string", + "description": "The template's name." + }, + "schema": { + "type": "array", + "description": "The template document files.", + "items": { + "type": "object", + "properties": { + "attachment_uuid": { + "type": "string", + "description": "The attachment UUID." + }, + "name": { + "type": "string", + "description": "The attachment name." + } + } + } + }, + "fields": { + "type": "array", + "description": "The template fields.", + "items": { + "type": "object", + "properties": { + "uuid": { + "type": "string", + "description": "The field UUID." + }, + "submitter_uuid": { + "type": "string", + "description": "The submitter role UUID." + }, + "name": { + "type": "string", + "description": "The field name." + }, + "type": { + "type": "string", + "description": "The field type.", + "enum": [ + "heading", + "text", + "signature", + "initials", + "date", + "number", + "image", + "checkbox", + "multiple", + "file", + "radio", + "select", + "cells", + "stamp", + "payment", + "phone", + "verification", + "kba", + "strikethrough" + ] + }, + "required": { + "type": "boolean", + "description": "The flag indicating whether the field is required." + }, + "preferences": { + "type": "object", + "description": "The field preferences." + }, + "areas": { + "type": "array", + "description": "List of areas where the field is located in the document.", + "items": { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "X coordinate of the area where the field is located in the document." + }, + "y": { + "type": "number", + "description": "Y coordinate of the area where the field is located in the document." + }, + "w": { + "type": "number", + "description": "Width of the area where the field is located in the document." + }, + "h": { + "type": "number", + "description": "Height of the area where the field is located in the document." + }, + "attachment_uuid": { + "type": "string", + "description": "Unique identifier of the attached document where the field is located." + }, + "page": { + "type": "integer", + "description": "Page number of the attached document where the field is located." + } + } + } + } + } + } + }, + "submitters": { + "type": "array", + "description": "List of submitter roles defined in the template.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Submitter name." + }, + "uuid": { + "type": "string", + "description": "Unique identifier of the submitter." + } + } + } + }, + "author_id": { + "type": "integer", + "description": "Unique identifier of the author of the template." + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "description": "Date and time when the template was archived." + }, + "created_at": { + "type": "string", + "description": "Date and time when the template was created." + }, + "updated_at": { + "type": "string", + "description": "Date and time when the template was updated." + }, + "source": { + "type": "string", + "description": "Source of the template.", + "enum": [ + "native", + "api", + "embed" + ] + }, + "external_id": { + "type": [ + "string", + "null" + ], + "description": "Identifier of the template in the external system." + }, + "folder_id": { + "type": "integer", + "description": "Unique identifier of the folder where the template is placed." + }, + "folder_name": { + "type": "string", + "description": "Folder name where the template is placed." + }, + "preferences": { + "type": "object", + "description": "Template preferences object." + }, + "shared_link": { + "type": "boolean", + "description": "Flag indicating whether the shared link is enabled for the template." + }, + "author": { + "type": "object", + "description": "Author of the template.", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the author." + }, + "first_name": { + "type": "string", + "description": "First name of the author." + }, + "last_name": { + "type": "string", + "description": "Last name of the author." + }, + "email": { + "type": "string", + "description": "Author email." + } + } + }, + "documents": { + "type": "array", + "description": "List of documents attached to the template.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the document." + }, + "uuid": { + "type": "string", + "description": "Unique identifier of the document." + }, + "url": { + "type": "string", + "description": "URL of the document." + }, + "preview_image_url": { + "type": "string", + "description": "Document preview image URL." + }, + "filename": { + "type": "string", + "description": "Document filename." + } + } + } + } + } + } + } + }, + "example": { + "event_type": "template.created", + "timestamp": "2024-05-26T16:59:47.237Z", + "data": { + "id": 1, + "slug": "UwRU9ir5dvhSRY", + "name": "Sample Document", + "schema": [ + { + "attachment_uuid": "84fa7c01-8b89-47e2-83f0-8623e7e4aa1c", + "name": "sample-document" + } + ], + "fields": [ + { + "uuid": "f86dbf07-2d84-490c-b372-1aaaaf0549c1", + "submitter_uuid": "6b92a2d0-b511-4678-bccf-1e8a131f5030", + "name": "First Name", + "type": "text", + "required": true, + "preferences": {}, + "areas": [ + { + "x": 0.2541666666666667, + "y": 0.2266854052667579, + "w": 0.3132975260416667, + "h": 0.04878270348837208, + "attachment_uuid": "84fa7c01-8b89-47e2-83f0-8623e7e4aa1c", + "page": 0 + } + ] + }, + { + "uuid": "1b41711b-f765-41c5-b2b9-000b88b96c6e", + "submitter_uuid": "6b92a2d0-b511-4678-bccf-1e8a131f5030", + "name": "Last Name", + "type": "text", + "required": true, + "preferences": {}, + "areas": [ + { + "x": 0.5419813368055556, + "y": 0.3057829599863201, + "w": 0.2188802083333333, + "h": 0.05516843365253077, + "attachment_uuid": "84fa7c01-8b89-47e2-83f0-8623e7e4aa1c", + "page": 0 + } + ] + } + ], + "submitters": [ + { + "name": "First Party", + "uuid": "6b92a2d0-b511-4678-bccf-1e8a131f5030" + } + ], + "author_id": 1, + "archived_at": null, + "created_at": "2024-05-26T16:57:28.092Z", + "updated_at": "2024-05-26T16:57:28.092Z", + "source": "native", + "folder_id": 1, + "external_id": null, + "preferences": {}, + "shared_link": false, + "folder_name": "Default", + "author": { + "id": 1, + "first_name": "John", + "last_name": "Doe", + "email": "john.doe@example.com" + }, + "documents": [ + { + "id": 12, + "uuid": "84fa7c01-8b89-47e2-83f0-8623e7e4aa1c", + "url": "https://docuseal.com/file/hash/sample-document.pdf", + "preview_image_url": "https://docuseal.com/file/hash/0.jpg", + "filename": "sample-document.pdf" + } + ] + } + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 response to acknowledge successful receipt of the webhook event." + } + } + } + } } } \ No newline at end of file diff --git a/docs/webhooks/form-webhook.md b/docs/webhooks/form-webhook.md index 32c0eb19..52c68a53 100644 --- a/docs/webhooks/form-webhook.md +++ b/docs/webhooks/form-webhook.md @@ -1,6 +1,6 @@ # Form Webhook -During the form filling and signing process, 3 types of events may occur and are dispatched at different stages: +During the form filling and signing process, 4 types of events may occur and are dispatched at different stages: - **'form.viewed'** event is triggered when the submitter first opens the form. - **'form.started'** event is triggered when the submitter initiates filling out the form. @@ -19,13 +19,16 @@ During the form filling and signing process, 3 types of events may occur and are "enum": [ "form.viewed", "form.started", - "form.completed" + "form.completed", + "form.declined" ] }, "timestamp": { "type": "string", "description": "The event timestamp.", - "example": "2023-09-24T11:20:42Z", + "examples": [ + "2023-09-24T11:20:42Z" + ], "format": "date-time" }, "data": { @@ -36,20 +39,20 @@ During the form filling and signing process, 3 types of events may occur and are "type": "number", "description": "The submitter's unique identifier." }, - "submission_id": { - "type": "number", - "description": "The unique submission identifier." - }, "email": { "type": "string", "description": "The submitter's email address", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "ua": { "type": "string", "description": "The user agent string that provides information about the submitter's web browser.", - "example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36" + "examples": [ + "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36" + ] }, "ip": { "type": "string", @@ -62,27 +65,28 @@ During the form filling and signing process, 3 types of events may occur and are "phone": { "type": "string", "description": "The submitter's phone number, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "role": { "type": "string", "description": "The submitter's role name or title.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "external_id": { "type": "string", "description": "Your application-specific unique string key to identify submitter within your app." }, - "application_key": { - "type": "string", - "description": "Your application-specific unique string key to identify submitter within your app. Backward compatibility with the previous version of the API. Use external_id instead." - }, "decline_reason": { "type": "string", "description": "Submitter provided decline message." }, "sent_at": { "type": "string", + "description": "The date and time when the signing request was sent to the submitter.", "format": "date-time" }, "status": { @@ -98,22 +102,27 @@ During the form filling and signing process, 3 types of events may occur and are }, "opened_at": { "type": "string", + "description": "The date and time when the submitter opened the signing form.", "format": "date-time" }, "completed_at": { "type": "string", + "description": "The date and time when the submitter completed the signing form.", "format": "date-time" }, "declined_at": { "type": "string", + "description": "The date and time when the submitter declined the signing form.", "format": "date-time" }, "created_at": { "type": "string", + "description": "The date and time when the submitter was created.", "format": "date-time" }, "updated_at": { "type": "string", + "description": "The date and time when the submitter was last updated.", "format": "date-time" }, "submission": { @@ -189,6 +198,7 @@ During the form filling and signing process, 3 types of events may occur and are }, "preferences": { "type": "object", + "description": "Submitter preferences for notifications.", "properties": { "send_email": { "type": "boolean", @@ -210,7 +220,7 @@ During the form filling and signing process, 3 types of events may occur and are "type": "string", "description": "The field name." }, - "values": { + "value": { "type": "string", "description": "The field value." } @@ -231,6 +241,7 @@ During the form filling and signing process, 3 types of events may occur and are }, "documents": { "type": "array", + "description": "List of completed documents signed by the submitter.", "items": { "type": "object", "properties": { diff --git a/docs/webhooks/submission-webhook.md b/docs/webhooks/submission-webhook.md index 8bed4a05..1eda4bb9 100644 --- a/docs/webhooks/submission-webhook.md +++ b/docs/webhooks/submission-webhook.md @@ -16,13 +16,17 @@ Get submission creation, completion, expiration, and archiving notifications usi "description": "The event type.", "enum": [ "submission.created", + "submission.completed", + "submission.expired", "submission.archived" ] }, "timestamp": { "type": "string", "description": "The event timestamp.", - "example": "2023-09-24T11:20:42Z", + "examples": [ + "2023-09-24T11:20:42Z" + ], "format": "date-time" }, "data": { @@ -33,8 +37,26 @@ Get submission creation, completion, expiration, and archiving notifications usi "type": "number", "description": "The submission's unique identifier." }, - "archived_at": { + "name": { + "type": "string", + "description": "Name of the document submission." + }, + "slug": { "type": "string", + "description": "Unique slug of the submission." + }, + "expire_at": { + "type": [ + "string", + "null" + ], + "description": "The date and time when the submission will expire." + }, + "archived_at": { + "type": [ + "string", + "null" + ], "description": "The submission archive date." }, "created_at": { @@ -65,9 +87,19 @@ Get submission creation, completion, expiration, and archiving notifications usi ] }, "audit_log_url": { - "type": "string", + "type": [ + "string", + "null" + ], "description": "Audit log file URL." }, + "combined_document_url": { + "type": [ + "string", + "null" + ], + "description": "Combined PDF file URL with documents and Audit Log." + }, "submitters": { "type": "array", "description": "The list of submitters for the submission.", @@ -90,26 +122,40 @@ Get submission creation, completion, expiration, and archiving notifications usi "type": "string", "description": "The email address of the submitter.", "format": "email", - "example": "john.doe@example.com" + "examples": [ + "john.doe@example.com" + ] }, "slug": { "type": "string", "description": "The unique slug of the document template." }, "sent_at": { - "type": "string", + "type": [ + "string", + "null" + ], "description": "The date and time when the signing request was sent to the submitter." }, "opened_at": { - "type": "string", + "type": [ + "string", + "null" + ], "description": "The date and time when the submitter opened the signing form." }, "completed_at": { - "type": "string", + "type": [ + "string", + "null" + ], "description": "The date and time when the submitter completed the signing form." }, "declined_at": { - "type": "string", + "type": [ + "string", + "null" + ], "description": "The date and time when the submitter declined the signing form." }, "created_at": { @@ -121,27 +167,42 @@ Get submission creation, completion, expiration, and archiving notifications usi "description": "The date and time when the submitter was last updated." }, "name": { - "type": "string", + "type": [ + "string", + "null" + ], "description": "The name of the submitter." }, "phone": { - "type": "string", + "type": [ + "string", + "null" + ], "description": "The phone number of the submitter, formatted according to the E.164 standard.", - "example": "+1234567890" + "examples": [ + "+1234567890" + ] }, "role": { "type": "string", "description": "The role name or title of the submitter.", - "example": "First Party" + "examples": [ + "First Party" + ] }, "external_id": { - "type": "string", + "type": [ + "string", + "null" + ], "description": "Your application-specific unique string key to identify this submitter within your app." }, "metadata": { "type": "object", "description": "Metadata object with additional submitter information.", - "example": "{ 'customField': 'value' }" + "examples": [ + "{ 'customField': 'value' }" + ] }, "status": { "type": "string", @@ -154,10 +215,6 @@ Get submission creation, completion, expiration, and archiving notifications usi "awaiting" ] }, - "application_key": { - "type": "string", - "description": "Your application-specific unique string key to identify this submitter within your app." - }, "values": { "type": "object", "description": "An object with pre-filled values for the submission. Use field names for keys of the object. For more configurations see `fields` param." @@ -222,6 +279,7 @@ Get submission creation, completion, expiration, and archiving notifications usi }, "created_by_user": { "type": "object", + "description": "User who created the submission.", "properties": { "id": { "type": "integer", @@ -243,6 +301,7 @@ Get submission creation, completion, expiration, and archiving notifications usi }, "submission_events": { "type": "array", + "description": "List of submission events.", "items": { "type": "object", "properties": { diff --git a/docs/webhooks/template-webhook.md b/docs/webhooks/template-webhook.md index b843a0ed..a1dc40cc 100644 --- a/docs/webhooks/template-webhook.md +++ b/docs/webhooks/template-webhook.md @@ -3,7 +3,8 @@ Get template creation and update notifications using these events: - **'template.created'** is triggered when the template is created. -- **'tempate.updated'** is triggered when the template is updated. +- **'template.updated'** is triggered when the template is updated. +- **'template.archived'** is triggered when the template is archived. @@ -14,13 +15,16 @@ Get template creation and update notifications using these events: "description": "The event type.", "enum": [ "template.created", - "template.updated" + "template.updated", + "template.archived" ] }, "timestamp": { "type": "string", "description": "The event timestamp.", - "example": "2023-09-24T11:20:42Z", + "examples": [ + "2023-09-24T11:20:42Z" + ], "format": "date-time" }, "data": { @@ -74,6 +78,31 @@ Get template creation and update notifications using these events: "type": "string", "description": "The field name." }, + "type": { + "type": "string", + "description": "The field type.", + "enum": [ + "heading", + "text", + "signature", + "initials", + "date", + "number", + "image", + "checkbox", + "multiple", + "file", + "radio", + "select", + "cells", + "stamp", + "payment", + "phone", + "verification", + "kba", + "strikethrough" + ] + }, "required": { "type": "boolean", "description": "The flag indicating whether the field is required." @@ -120,6 +149,7 @@ Get template creation and update notifications using these events: }, "submitters": { "type": "array", + "description": "List of submitter roles defined in the template.", "items": { "type": "object", "properties": { @@ -138,12 +168,11 @@ Get template creation and update notifications using these events: "type": "integer", "description": "Unique identifier of the author of the template." }, - "account_id": { - "type": "integer", - "description": "Unique identifier of the account of the template." - }, "archived_at": { - "type": "string", + "type": [ + "string", + "null" + ], "description": "Date and time when the template was archived." }, "created_at": { @@ -164,7 +193,10 @@ Get template creation and update notifications using these events: ] }, "external_id": { - "type": "string", + "type": [ + "string", + "null" + ], "description": "Identifier of the template in the external system." }, "folder_id": { @@ -175,12 +207,17 @@ Get template creation and update notifications using these events: "type": "string", "description": "Folder name where the template is placed." }, - "application_key": { - "type": "string", - "description": "Your application-specific unique string key to identify tempate_id within your app." + "preferences": { + "type": "object", + "description": "Template preferences object." + }, + "shared_link": { + "type": "boolean", + "description": "Flag indicating whether the shared link is enabled for the template." }, "author": { "type": "object", + "description": "Author of the template.", "properties": { "id": { "type": "integer",