mirror of
https://github.com/docusealco/docuseal.git
synced 2026-08-07 07:14:43 +00:00
update docs
This commit is contained in:
Pete Matsyburka
+726
-37
@@ -653,6 +653,15 @@ func main() {
|
||||
"type": "string",
|
||||
"description": "Submitter specific URL to redirect to after the submission completion."
|
||||
},
|
||||
"order": {
|
||||
"type": "integer",
|
||||
"description": "The order of the submitter in the workflow (e.g., 0 for the first signer, 1 for the second, etc.). Use the same order number to create order groups. By default, submitters are ordered as in the submitters array."
|
||||
},
|
||||
"require_phone_2fa": {
|
||||
"type": "boolean",
|
||||
"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
|
||||
},
|
||||
"message": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -728,14 +737,45 @@ func main() {
|
||||
"type": "string",
|
||||
"description": "Field description displayed on the signing form. Supports Markdown."
|
||||
},
|
||||
"validation_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}"
|
||||
},
|
||||
"invalid_message": {
|
||||
"type": "string",
|
||||
"description": "A custom message to display on pattern validation failure."
|
||||
"validation": {
|
||||
"type": "object",
|
||||
"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}"
|
||||
},
|
||||
"message": {
|
||||
"type": "string",
|
||||
"description": "A custom error message to display on validation failure."
|
||||
},
|
||||
"min": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"description": "Minimum allowed number value or date depending on field type."
|
||||
},
|
||||
"max": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"description": "Maximum allowed number value or date depending on field type."
|
||||
},
|
||||
"step": {
|
||||
"type": "number",
|
||||
"description": "Increment step for number field. Pass 1 to accept only integers, or 0.01 to accept decimal currency."
|
||||
}
|
||||
}
|
||||
},
|
||||
"preferences": {
|
||||
"type": "object",
|
||||
@@ -1285,10 +1325,6 @@ func main() {
|
||||
"type": "string",
|
||||
"description": "Specify Reply-To address to use in the notification emails."
|
||||
},
|
||||
"completed_redirect_url": {
|
||||
"type": "string",
|
||||
"description": "Submitter specific URL to redirect to after the submission completion."
|
||||
},
|
||||
"completed": {
|
||||
"type": "boolean",
|
||||
"description": "Pass `true` to mark submitter as completed and auto-signed via API."
|
||||
@@ -1298,6 +1334,15 @@ func main() {
|
||||
"description": "Metadata object with additional submitter information.",
|
||||
"example": "{ \"customField\": \"value\" }"
|
||||
},
|
||||
"completed_redirect_url": {
|
||||
"type": "string",
|
||||
"description": "Submitter specific URL to redirect to after the submission completion."
|
||||
},
|
||||
"require_phone_2fa": {
|
||||
"type": "boolean",
|
||||
"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
|
||||
},
|
||||
"message": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -1365,14 +1410,45 @@ func main() {
|
||||
"type": "boolean",
|
||||
"description": "Set `true` to make the field required."
|
||||
},
|
||||
"validation_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}"
|
||||
},
|
||||
"invalid_message": {
|
||||
"type": "string",
|
||||
"description": "A custom message to display on pattern validation failure."
|
||||
"validation": {
|
||||
"type": "object",
|
||||
"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}"
|
||||
},
|
||||
"message": {
|
||||
"type": "string",
|
||||
"description": "A custom error message to display on validation failure."
|
||||
},
|
||||
"min": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"description": "Minimum allowed number value or date depending on field type."
|
||||
},
|
||||
"max": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"description": "Maximum allowed number value or date depending on field type."
|
||||
},
|
||||
"step": {
|
||||
"type": "number",
|
||||
"description": "Increment step for number field. Pass 1 to accept only integers, or 0.01 to accept decimal currency."
|
||||
}
|
||||
}
|
||||
},
|
||||
"preferences": {
|
||||
"type": "object",
|
||||
@@ -2148,6 +2224,46 @@ func main() {
|
||||
"Option B"
|
||||
]
|
||||
},
|
||||
"validation": {
|
||||
"type": "object",
|
||||
"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}"
|
||||
},
|
||||
"message": {
|
||||
"type": "string",
|
||||
"description": "A custom error message to display on validation failure."
|
||||
},
|
||||
"min": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"description": "Minimum allowed number value or date depending on field type."
|
||||
},
|
||||
"max": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"description": "Maximum allowed number value or date depending on field type."
|
||||
},
|
||||
"step": {
|
||||
"type": "number",
|
||||
"description": "Increment step for number field. Pass 1 to accept only integers, or 0.01 to accept decimal currency."
|
||||
}
|
||||
}
|
||||
},
|
||||
"preferences": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -2672,7 +2788,7 @@ func main() {
|
||||
|
||||
### Create a submission from PDF
|
||||
|
||||
The API endpoint provides the functionality to create one-off submission request from a PDF or DOCX file. Use <code>{{Field Name;role=Signer1;type=date}}</code> text tags to define fillable fields in the document. See <a href="https://www.docuseal.com/examples/fieldtags.pdf" target="_blank" class="link font-bold">https://www.docuseal.com/examples/fieldtags.pdf</a> for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.<br><b>Related Guides</b><br><a href="https://www.docuseal.com/guides/use-embedded-text-field-tags-in-the-pdf-to-create-a-fillable-form" class="link">Use embedded text field tags to create a fillable form</a>
|
||||
The API endpoint provides the functionality to create one-off submission request from a PDF. Use <code>{{Field Name;role=Signer1;type=date}}</code> text tags to define fillable fields in the document. See <a href="https://www.docuseal.com/examples/fieldtags.pdf" target="_blank" class="link font-bold">https://www.docuseal.com/examples/fieldtags.pdf</a> for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.<br><b>Related Guides</b><br><a href="https://www.docuseal.com/guides/use-embedded-text-field-tags-in-the-pdf-to-create-a-fillable-form" class="link">Use embedded text field tags to create a fillable form</a>
|
||||
|
||||
|
||||
```go
|
||||
@@ -2973,6 +3089,15 @@ func main() {
|
||||
"type": "string",
|
||||
"description": "Submitter specific URL to redirect to after the submission completion."
|
||||
},
|
||||
"order": {
|
||||
"type": "integer",
|
||||
"description": "The order of the submitter in the workflow (e.g., 0 for the first signer, 1 for the second, etc.). Use the same order number to create order groups. By default, submitters are ordered as in the submitters array."
|
||||
},
|
||||
"require_phone_2fa": {
|
||||
"type": "boolean",
|
||||
"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
|
||||
},
|
||||
"fields": {
|
||||
"type": "array",
|
||||
"description": "A list of configurations for document form fields.",
|
||||
@@ -3035,14 +3160,45 @@ func main() {
|
||||
"type": "string",
|
||||
"description": "Field description displayed on the signing form. Supports Markdown."
|
||||
},
|
||||
"validation_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}"
|
||||
},
|
||||
"invalid_message": {
|
||||
"type": "string",
|
||||
"description": "A custom message to display on pattern validation failure."
|
||||
"validation": {
|
||||
"type": "object",
|
||||
"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}"
|
||||
},
|
||||
"message": {
|
||||
"type": "string",
|
||||
"description": "A custom error message to display on validation failure."
|
||||
},
|
||||
"min": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"description": "Minimum allowed number value or date depending on field type."
|
||||
},
|
||||
"max": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"description": "Maximum allowed number value or date depending on field type."
|
||||
},
|
||||
"step": {
|
||||
"type": "number",
|
||||
"description": "Increment step for number field. Pass 1 to accept only integers, or 0.01 to accept decimal currency."
|
||||
}
|
||||
}
|
||||
},
|
||||
"preferences": {
|
||||
"type": "object",
|
||||
@@ -3411,6 +3567,15 @@ func main() {
|
||||
"type": "string",
|
||||
"description": "Submitter specific URL to redirect to after the submission completion."
|
||||
},
|
||||
"order": {
|
||||
"type": "integer",
|
||||
"description": "The order of the submitter in the workflow (e.g., 0 for the first signer, 1 for the second, etc.). Use the same order number to create order groups. By default, submitters are ordered as in the submitters array."
|
||||
},
|
||||
"require_phone_2fa": {
|
||||
"type": "boolean",
|
||||
"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
|
||||
},
|
||||
"fields": {
|
||||
"type": "array",
|
||||
"description": "A list of configurations for document form fields.",
|
||||
@@ -3473,14 +3638,45 @@ func main() {
|
||||
"type": "string",
|
||||
"description": "Field description displayed on the signing form. Supports Markdown."
|
||||
},
|
||||
"validation_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}"
|
||||
},
|
||||
"invalid_message": {
|
||||
"type": "string",
|
||||
"description": "A custom message to display on pattern validation failure."
|
||||
"validation": {
|
||||
"type": "object",
|
||||
"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}"
|
||||
},
|
||||
"message": {
|
||||
"type": "string",
|
||||
"description": "A custom error message to display on validation failure."
|
||||
},
|
||||
"min": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"description": "Minimum allowed number value or date depending on field type."
|
||||
},
|
||||
"max": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"description": "Maximum allowed number value or date depending on field type."
|
||||
},
|
||||
"step": {
|
||||
"type": "number",
|
||||
"description": "Increment step for number field. Pass 1 to accept only integers, or 0.01 to accept decimal currency."
|
||||
}
|
||||
}
|
||||
},
|
||||
"preferences": {
|
||||
"type": "object",
|
||||
@@ -3811,6 +4007,46 @@ func main() {
|
||||
"Option B"
|
||||
]
|
||||
},
|
||||
"validation": {
|
||||
"type": "object",
|
||||
"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}"
|
||||
},
|
||||
"message": {
|
||||
"type": "string",
|
||||
"description": "A custom error message to display on validation failure."
|
||||
},
|
||||
"min": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"description": "Minimum allowed number value or date depending on field type."
|
||||
},
|
||||
"max": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"description": "Maximum allowed number value or date depending on field type."
|
||||
},
|
||||
"step": {
|
||||
"type": "number",
|
||||
"description": "Increment step for number field. Pass 1 to accept only integers, or 0.01 to accept decimal currency."
|
||||
}
|
||||
}
|
||||
},
|
||||
"preferences": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -3927,3 +4163,456 @@ 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 <code>[[variable_name]]</code> text tags to define dynamic content variables in the document. See <a href="https://www.docuseal.com/examples/demo_template.docx" target="_blank" class="link font-bold">https://www.docuseal.com/examples/demo_template.docx</a> for the specific text variable syntax, including dynamic content tables and list. You can also use the <code>{{signature}}</code> fillable field syntax to define fillable fields, as in a PDF.<br><b>Related Guides</b><br><a href="https://www.docuseal.com/guides/use-embedded-text-field-tags-in-the-pdf-to-create-a-fillable-form" class="link">Use embedded text field tags to create a fillable form</a>
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strings"
|
||||
"net/http"
|
||||
"io"
|
||||
)
|
||||
|
||||
func main() {
|
||||
|
||||
url := "https://api.docuseal.com/submissions/docx"
|
||||
|
||||
payload := strings.NewReader("{\"name\":\"Test Submission Document\",\"variables\":{\"variable_name\":\"value\"},\"documents\":[{\"name\":\"string\",\"file\":\"base64\"}],\"submitters\":[{\"role\":\"First Party\",\"email\":\"john.doe@example.com\"}]}")
|
||||
|
||||
req, _ := http.NewRequest("POST", url, payload)
|
||||
|
||||
req.Header.Add("X-Auth-Token", "API_KEY")
|
||||
req.Header.Add("content-type", "application/json")
|
||||
|
||||
res, _ := http.DefaultClient.Do(req)
|
||||
|
||||
defer res.Body.Close()
|
||||
body, _ := io.ReadAll(res.Body)
|
||||
|
||||
fmt.Println(res)
|
||||
fmt.Println(string(body))
|
||||
|
||||
}
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"security": [
|
||||
{
|
||||
"AuthToken": []
|
||||
}
|
||||
],
|
||||
"tags": [
|
||||
"Submissions"
|
||||
],
|
||||
"summary": "Create a submission from DOCX",
|
||||
"operationId": "createSubmissionFromDocx",
|
||||
"parameters": [],
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"documents",
|
||||
"submitters"
|
||||
],
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "Name of the document submission.",
|
||||
"example": "Test Submission Document"
|
||||
},
|
||||
"send_email": {
|
||||
"type": "boolean",
|
||||
"description": "Set `false` to disable signature request emails sending.",
|
||||
"default": true
|
||||
},
|
||||
"send_sms": {
|
||||
"type": "boolean",
|
||||
"description": "Set `true` to send signature request via phone number and SMS.",
|
||||
"default": false
|
||||
},
|
||||
"variables": {
|
||||
"type": "object",
|
||||
"description": "Dynamic content variables object",
|
||||
"example": {
|
||||
"variable_name": "value"
|
||||
}
|
||||
},
|
||||
"order": {
|
||||
"type": "string",
|
||||
"description": "Pass 'random' to send signature request emails to all parties right away. The order is 'preserved' by default so the second party will receive a signature request email only after the document is signed by the first party.",
|
||||
"default": "preserved",
|
||||
"enum": [
|
||||
"preserved",
|
||||
"random"
|
||||
]
|
||||
},
|
||||
"completed_redirect_url": {
|
||||
"type": "string",
|
||||
"description": "Specify URL to redirect to after the submission completion."
|
||||
},
|
||||
"bcc_completed": {
|
||||
"type": "string",
|
||||
"description": "Specify BCC address to send signed documents to after the completion."
|
||||
},
|
||||
"reply_to": {
|
||||
"type": "string",
|
||||
"description": "Specify Reply-To address to use in the notification emails."
|
||||
},
|
||||
"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"
|
||||
},
|
||||
"template_ids": {
|
||||
"type": "array",
|
||||
"description": "An optional array of template IDs to use in the submission along with the provided documents. This can be used to create multi-document submissions when some of the required documents exist within templates.",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"description": "The ID of the template to use for the submission."
|
||||
}
|
||||
},
|
||||
"documents": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"name",
|
||||
"file"
|
||||
],
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "Name of the document."
|
||||
},
|
||||
"file": {
|
||||
"example": "base64",
|
||||
"type": "string",
|
||||
"format": "base64",
|
||||
"description": "Base64-encoded content of the PDF or DOCX file or downloadable file URL."
|
||||
},
|
||||
"position": {
|
||||
"type": "integer",
|
||||
"description": "Document position in the submission. If not specified, the document will be added in the order it appears in the documents array."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"submitters": {
|
||||
"type": "array",
|
||||
"description": "The list of submitters for the submission.",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"email"
|
||||
],
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The name of the submitter."
|
||||
},
|
||||
"role": {
|
||||
"type": "string",
|
||||
"description": "The role name or title of the submitter.",
|
||||
"example": "First Party"
|
||||
},
|
||||
"email": {
|
||||
"type": "string",
|
||||
"description": "The email address of the submitter.",
|
||||
"format": "email",
|
||||
"example": "john.doe@example.com"
|
||||
},
|
||||
"phone": {
|
||||
"type": "string",
|
||||
"description": "The phone number of the submitter, formatted according to the E.164 standard.",
|
||||
"example": "+1234567890"
|
||||
},
|
||||
"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."
|
||||
},
|
||||
"external_id": {
|
||||
"type": "string",
|
||||
"description": "Your application-specific unique string key to identify this submitter within your app."
|
||||
},
|
||||
"completed": {
|
||||
"type": "boolean",
|
||||
"description": "Pass `true` to mark submitter as completed and auto-signed via API."
|
||||
},
|
||||
"metadata": {
|
||||
"type": "object",
|
||||
"description": "Metadata object with additional submitter information.",
|
||||
"example": "{ \"customField\": \"value\" }"
|
||||
},
|
||||
"send_email": {
|
||||
"type": "boolean",
|
||||
"description": "Set `false` to disable signature request emails sending only for this submitter.",
|
||||
"default": true
|
||||
},
|
||||
"send_sms": {
|
||||
"type": "boolean",
|
||||
"description": "Set `true` to send signature request via phone number and SMS.",
|
||||
"default": false
|
||||
},
|
||||
"reply_to": {
|
||||
"type": "string",
|
||||
"description": "Specify Reply-To address to use in the notification emails for this submitter."
|
||||
},
|
||||
"completed_redirect_url": {
|
||||
"type": "string",
|
||||
"description": "Submitter specific URL to redirect to after the submission completion."
|
||||
},
|
||||
"order": {
|
||||
"type": "integer",
|
||||
"description": "The order of the submitter in the workflow (e.g., 0 for the first signer, 1 for the second, etc.). Use the same order number to create order groups. By default, submitters are ordered as in the submitters array."
|
||||
},
|
||||
"require_phone_2fa": {
|
||||
"type": "boolean",
|
||||
"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
|
||||
},
|
||||
"fields": {
|
||||
"type": "array",
|
||||
"description": "A list of configurations for document form fields.",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"name"
|
||||
],
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "Document field name.",
|
||||
"example": "First Name"
|
||||
},
|
||||
"default_value": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"type": "array",
|
||||
"items": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"type": "boolean"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
],
|
||||
"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"
|
||||
},
|
||||
"readonly": {
|
||||
"type": "boolean",
|
||||
"description": "Set `true` to make it impossible for the submitter to edit predefined field value.",
|
||||
"default": false
|
||||
},
|
||||
"required": {
|
||||
"type": "boolean",
|
||||
"description": "Set `true` to make the field required."
|
||||
},
|
||||
"title": {
|
||||
"type": "string",
|
||||
"description": "Field title displayed to the user instead of the name, shown on the signing form. Supports Markdown."
|
||||
},
|
||||
"description": {
|
||||
"type": "string",
|
||||
"description": "Field description displayed on the signing form. Supports Markdown."
|
||||
},
|
||||
"validation": {
|
||||
"type": "object",
|
||||
"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}"
|
||||
},
|
||||
"message": {
|
||||
"type": "string",
|
||||
"description": "A custom error message to display on validation failure."
|
||||
},
|
||||
"min": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"description": "Minimum allowed number value or date depending on field type."
|
||||
},
|
||||
"max": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"description": "Maximum allowed number value or date depending on field type."
|
||||
},
|
||||
"step": {
|
||||
"type": "number",
|
||||
"description": "Increment step for number field. Pass 1 to accept only integers, or 0.01 to accept decimal currency."
|
||||
}
|
||||
}
|
||||
},
|
||||
"preferences": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"font_size": {
|
||||
"type": "integer",
|
||||
"description": "Font size of the field value in pixels.",
|
||||
"example": 12
|
||||
},
|
||||
"font_type": {
|
||||
"type": "string",
|
||||
"description": "Font type of the field value.",
|
||||
"enum": [
|
||||
"bold",
|
||||
"italic",
|
||||
"bold_italic"
|
||||
]
|
||||
},
|
||||
"font": {
|
||||
"type": "string",
|
||||
"description": "Font family of the field value.",
|
||||
"enum": [
|
||||
"Times",
|
||||
"Helvetica",
|
||||
"Courier"
|
||||
]
|
||||
},
|
||||
"color": {
|
||||
"type": "string",
|
||||
"description": "Font color of the field value.",
|
||||
"enum": [
|
||||
"black",
|
||||
"white",
|
||||
"blue"
|
||||
],
|
||||
"default": "black"
|
||||
},
|
||||
"align": {
|
||||
"type": "string",
|
||||
"description": "Horizontal alignment of the field text value.",
|
||||
"enum": [
|
||||
"left",
|
||||
"center",
|
||||
"right"
|
||||
],
|
||||
"default": "left"
|
||||
},
|
||||
"valign": {
|
||||
"type": "string",
|
||||
"description": "Vertical alignment of the field text value.",
|
||||
"enum": [
|
||||
"top",
|
||||
"center",
|
||||
"bottom"
|
||||
],
|
||||
"default": "center"
|
||||
},
|
||||
"format": {
|
||||
"type": "string",
|
||||
"description": "The data format for different field types.<br>- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).<br>- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.<br>- Number field: accepts currency formats such as usd, eur, gbp.",
|
||||
"example": "DD/MM/YYYY"
|
||||
},
|
||||
"price": {
|
||||
"type": "number",
|
||||
"description": "Price value of the payment field. Only for payment fields.",
|
||||
"example": 99.99
|
||||
},
|
||||
"currency": {
|
||||
"type": "string",
|
||||
"description": "Currency value of the payment field. Only for payment fields.",
|
||||
"enum": [
|
||||
"USD",
|
||||
"EUR",
|
||||
"GBP",
|
||||
"CAD",
|
||||
"AUD"
|
||||
],
|
||||
"default": "USD"
|
||||
},
|
||||
"mask": {
|
||||
"description": "Set `true` to make sensitive data masked on the document.",
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "integer"
|
||||
},
|
||||
{
|
||||
"type": "boolean"
|
||||
}
|
||||
],
|
||||
"default": false
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"roles": {
|
||||
"type": "array",
|
||||
"description": "A list of roles for the submitter. Use this param to merge multiple roles into one submitter.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"message": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"subject": {
|
||||
"type": "string",
|
||||
"description": "Custom signature request email subject."
|
||||
},
|
||||
"body": {
|
||||
"type": "string",
|
||||
"description": "Custom signature request email body. Can include the following variables: {{submission.name}}, {{submitter.link}}, {{account.name}}."
|
||||
}
|
||||
}
|
||||
},
|
||||
"merge_documents": {
|
||||
"type": "boolean",
|
||||
"description": "Set `true` to merge the documents into a single PDF file.",
|
||||
"default": false
|
||||
},
|
||||
"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.",
|
||||
"default": true
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user