Compare commits

...
Author SHA1 Message Date
prafull-opensignlabsandGitHub dfb5b1bb94 Add min_date and max_date to date configurations
1. Added notify_on_signatures, pen_colors parameter for document and template 
2. Addded 'min_date' and 'max_date' fields to date configurations in 
Updated examples and descriptions for clarity.
2025-12-22 09:59:48 +05:30
AmolandGitHub 0994f80891 Merge pull request #2057 from pravinOpenSign/patch-51 2025-12-19 21:46:03 +05:30
pravinandGitHub cb9f75bf2f Update Webhook.md
update the help document for webhook secret key
2025-12-19 21:43:47 +05:30
pravinandGitHub ee8525dac3 Update Webhook.md
update the image on the webhook page.
2025-12-17 17:54:05 +05:30
pravinandGitHub 8919a2b2e9 Update Webhook.md
Updated the document for webhook secret key
2025-12-17 16:39:53 +05:30
prafull-opensignlabsandGitHub efa5e2e491 Merge pull request #2052 from pravinOpenSign/patch-50
Patch 50
2025-12-10 17:49:21 +05:30
pravinandGitHub c58566ea1b Update manage-users.md
Updated the document to reflect the API credits functionality.
2025-12-10 17:00:05 +05:30
pravinandGitHub e1da69398c Update APIToken.md
Updated the help document for api credits
2025-12-10 16:52:40 +05:30
pravinandGitHub 3f4cffb157 Update manage-users.md
updated the help document to add api credits
2025-12-10 16:17:20 +05:30
prafull-opensignlabsandGitHub 3d91b8b12e Enhance 'cells' widget documentation in opensign.yaml
Added detailed specifications for 'cells' widget including options like 'cell_count', 'default', and 'hint'. Updated multiple sections to ensure consistency in widget definitions.
2025-12-08 17:11:57 +05:30
prafull-opensignlabsandGitHub 592f35f47f Update opensign.yaml 2025-12-01 18:42:13 +05:30
prafull-opensignlabsandGitHub ed9fe3c5f9 Merge pull request #2044 from pravinOpenSign/patch-49
Patch 49
2025-11-28 20:06:04 +05:30
pravinandGitHub c6e1593df5 Update completed.md
update the help document for view form data feature.
2025-11-28 19:31:18 +05:30
pravinandGitHub 900f929b53 Update in-progress.md
Update the help document for view data feature
2025-11-28 19:29:39 +05:30
pravinandGitHub e8093f1bf0 Update manage-templates.md
update the manage template help text for download all formdata
2025-11-28 19:24:31 +05:30
pravinandGitHub 97912d2432 Update request-signatures.md
update the  documents for Hide text with asterisks
2025-11-28 19:03:14 +05:30
pravinandGitHub 6fd6cd3eb8 Update create-template.md
update the help document for Hide text with asterisks feature.
2025-11-28 18:59:26 +05:30
pravinandGitHub 37465082e4 Update request-signatures.md
update the document with hide text with asterisk feature.
2025-11-28 18:49:07 +05:30
prafull-opensignlabsandGitHub d011edd3a1 Update sent_date example in opensign.yaml 2025-11-27 14:49:29 +05:30
prafull-opensignlabsandGitHub 694483aa2d Introduce hide_text_with_asterisks option for widgets
Added 'hide_text_with_asterisks' option for widgets.
2025-11-27 00:43:08 +05:30
prafull-opensignlabsandGitHub c6be12b16a Replace phone with ip_address in opensign.yaml 2025-11-26 23:26:39 +05:30
prafull-opensignlabsandGitHub 0213807732 Merge pull request #2040 from OpenSignLabs/prafull-opensignlabs-patch-8
Add API endpoints for signer IPs and form data
2025-11-26 22:09:14 +05:30
9 changed files with 630 additions and 75 deletions
+400 -63
View File
@@ -337,6 +337,7 @@ paths:
- **name:** Provides a different name for widgets if you are providing more than one widget.
- **color:** Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox.
- **fontsize:** Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox.
- **hide_text_with_asterisks:** When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans.
**List of all supported widgets:**
@@ -397,7 +398,8 @@ paths:
"required": true,
"name": "email",
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -415,7 +417,8 @@ paths:
"required": true,
"name": "name",
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -433,7 +436,8 @@ paths:
"required": true,
"name": "job title",
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -451,7 +455,8 @@ paths:
"required": true,
"name": "company",
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -471,7 +476,9 @@ paths:
"default": "04-15-2024",
"format": "mm-dd-yyyy",
"color": "black",
"fontsize": 12
"fontsize": 12,
"min_date": "",
"max_date": ""
}
}
```
@@ -488,7 +495,9 @@ paths:
- "dd mmmm, yyy",
- "dd/mm/yyyy",
- "dd.mm.yyyy".
- **min_date:** Provide the minimum restriction date. The date must be in **YYYY-MM-DD** format.
- **max_date:** Provide the maximum restriction date. The date must be in **YYYY-MM-DD** format.
9. **textbox**
```
{
@@ -506,7 +515,8 @@ paths:
"hint": "provide name",
"regularexpression": "",
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -580,13 +590,39 @@ paths:
"formula": "",
"decimalplaces": 2,
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
- **formula:** Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more [visit here](https://docs.opensignlabs.com/docs/help/New-Document/widgets) (optional).
- **default:** Provide a default number (Optional).
- **decimalplaces:** Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)
13. **cells**
```
{
"type": "cells",
"page": 1,
"x": 100,
"y": 100,
"w": 114,
"h": 50,
"options": {
"name": "cells",
"required": true,
"readonly": false,
"cell_count": 5,
"default": "",
"hint": "",
"regularexpression": "",
"color": "black",
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
- **cell_count:** Specify the number of cells that should be returned to the user.
operationId: selfsign
requestBody:
content:
@@ -637,6 +673,7 @@ paths:
- **name:** Provides a different name for widgets if you are providing more than one widget.
- **color:** Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown.
- **fontsize:** Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown.
- **hide_text_with_asterisks:** When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans.
**List of all supported widgets:**
@@ -697,7 +734,8 @@ paths:
"required": true,
"name": "email",
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -715,7 +753,8 @@ paths:
"required": true,
"name": "name",
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -733,7 +772,8 @@ paths:
"required": true,
"name": "job title",
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -751,7 +791,8 @@ paths:
"required": true,
"name": "company",
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -771,7 +812,9 @@ paths:
"default": "04-15-2024",
"format": "mm-dd-yyyy",
"color": "black",
"fontsize": 12
"fontsize": 12,
"min_date": "",
"max_date": ""
}
}
```
@@ -788,6 +831,8 @@ paths:
- "dd mmmm, yyy",
- "dd/mm/yyyy",
- "dd.mm.yyyy".
- **min_date:** Provide the minimum restriction date. The date must be in **YYYY-MM-DD** format.
- **max_date:** Provide the maximum restriction date. The date must be in **YYYY-MM-DD** format.
9. **textbox**
```
@@ -806,7 +851,8 @@ paths:
"hint": "provide name",
"regularexpression": "",
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -931,7 +977,8 @@ paths:
"formula": "",
"decimalplaces": 2,
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -941,6 +988,31 @@ paths:
- **readonly:** Set to true if you want to set the textbox as readonly. By default, it's false.
- **decimalplaces:** Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)
15. **cells**
```
{
"type": "cells",
"page": 1,
"x": 100,
"y": 100,
"w": 114,
"h": 50,
"options": {
"name": "cells",
"required": true,
"readonly": false,
"cell_count": 5,
"default": "",
"hint": "",
"regularexpression": "",
"color": "black",
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
- **cell_count:** Specify the number of cells that should be returned to the user.
**Prefill Widgets:** Prefill widgets are elements that are inserted into a document **before** it is shared with a user. Only the document creator has permission to add them.
**Note:** Responses for prefill widgets are **required**.
@@ -1114,6 +1186,7 @@ paths:
- **name:** Provides a different name for widgets if you are providing more than one widget.
- **color:** Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown.
- **fontsize:** Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown.
- **hide_text_with_asterisks:** When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans.
**List of all supported widgets:**
@@ -1174,7 +1247,8 @@ paths:
"required": true,
"name": "email",
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -1192,7 +1266,8 @@ paths:
"required": true,
"name": "name",
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -1210,7 +1285,8 @@ paths:
"required": true,
"name": "job title",
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -1228,7 +1304,8 @@ paths:
"required": true,
"name": "company",
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -1248,7 +1325,9 @@ paths:
"default": "04-15-2024",
"format": "mm-dd-yyyy",
"color": "black",
"fontsize": 12
"fontsize": 12,
"min_date": "",
"max_date": ""
}
}
```
@@ -1265,6 +1344,8 @@ paths:
- "dd mmmm, yyy",
- "dd/mm/yyyy",
- "dd.mm.yyyy".
- **min_date:** Provide the minimum restriction date. The date must be in **YYYY-MM-DD** format.
- **max_date:** Provide the maximum restriction date. The date must be in **YYYY-MM-DD** format.
9. **textbox**
```
@@ -1283,7 +1364,8 @@ paths:
"hint": "provide name",
"regularexpression": "",
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -1408,7 +1490,8 @@ paths:
"formula": "",
"decimalplaces": 2,
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -1417,7 +1500,32 @@ paths:
- **hint:** Provide a hint for the number (Optional).
- **readonly:** Set to true if you want to set the textbox as readonly. By default, it's false.
- **decimalplaces:** Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)
15. **cells**
```
{
"type": "cells",
"page": 1,
"x": 100,
"y": 100,
"w": 114,
"h": 50,
"options": {
"name": "cells",
"required": true,
"readonly": false,
"cell_count": 5,
"default": "",
"hint": "",
"regularexpression": "",
"color": "black",
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
- **cell_count:** Specify the number of cells that should be returned to the user.
**Prefill Widgets:** Prefill widgets are elements that are inserted into a document **before** it is shared with a user. Only the document creator has permission to add them.
**Note:** Responses for prefill widgets are **required**.
@@ -1579,12 +1687,16 @@ paths:
The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.
You can provide default value for all widgets based on their name all widgets support except signature, stamp, initials, image.
**hide_text_with_asterisks:** When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans.
1. **email**
```
{
"name": "email",
"readonly": false,
"default": "email@example.com"
"default": "email@example.com",
"hide_text_with_asterisks": false
}
```
@@ -1593,7 +1705,8 @@ paths:
{
"name": "name",
"readonly": false,
"default": "joe"
"default": "joe",
"hide_text_with_asterisks": false
}
```
@@ -1602,7 +1715,8 @@ paths:
{
"name": "job title",
"readonly": false,
"default": "ceo"
"default": "ceo",
"hide_text_with_asterisks": false
}
```
@@ -1611,7 +1725,8 @@ paths:
{
"name": "company",
"readonly": false,
"default": "example pvt ltd"
"default": "example pvt ltd",
"hide_text_with_asterisks": false
}
```
@@ -1620,16 +1735,21 @@ paths:
{
"name": "date",
"readonly": false,
"default": "11-05-2025"
"default": "11-05-2025",
"min_date": "",
"max_date": ""
}
```
- **min_date:** Provide the minimum restriction date. The date must be in **YYYY-MM-DD** format.
- **max_date:** Provide the maximum restriction date. The date must be in **YYYY-MM-DD** format.
6. **textbox**
```
{
"name": "textbox",
"readonly": false,
"default": "my text"
"default": "my text",
"hide_text_with_asterisks": false
}
```
@@ -1669,11 +1789,24 @@ paths:
"default": 0,
"formula": "",
"decimalplaces": 2,
"hide_text_with_asterisks": false
}
```
**Prefill Widgets:** Prefill widgets are elements that are inserted into a document before it is shared with a user. Only the document creator has permission to add them.
11. **cells**
```
{
"name": "cells",
"readonly": false,
"cell_count": 5,
"default": "",
"hide_text_with_asterisks": false
}
```
- **cell_count:** Specify the number of cells that should be returned to the user.
**response:** Provide the value that should replace the existing response.
**List of widgets supported in Prefill**
@@ -2212,6 +2345,7 @@ paths:
- **name:** Provides a different name for widgets if you are providing more than one widget.
- **color:** Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown.
- **fontsize:** Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown.
- **hide_text_with_asterisks:** When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans.
**List of all supported widgets:**
@@ -2272,7 +2406,8 @@ paths:
"required": true,
"name": "email",
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -2290,7 +2425,8 @@ paths:
"required": true,
"name": "name",
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -2308,7 +2444,8 @@ paths:
"required": true,
"name": "job title",
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -2326,7 +2463,8 @@ paths:
"required": true,
"name": "company",
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -2346,7 +2484,9 @@ paths:
"default": "04-15-2024",
"format": "mm-dd-yyyy",
"color": "black",
"fontsize": 12
"fontsize": 12,
"min_date": "",
"max_date": ""
}
}
```
@@ -2363,6 +2503,8 @@ paths:
- "dd mmmm, yyy",
- "dd/mm/yyyy",
- "dd.mm.yyyy".
- **min_date:** Provide the minimum restriction date. The date must be in **YYYY-MM-DD** format.
- **max_date:** Provide the maximum restriction date. The date must be in **YYYY-MM-DD** format.
9. **textbox**
```
@@ -2381,7 +2523,8 @@ paths:
"hint": "provide name",
"regularexpression": "",
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -2506,7 +2649,8 @@ paths:
"formula": "",
"decimalplaces": 2,
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -2516,7 +2660,31 @@ paths:
- **readonly:** Set to true if you want to set the textbox as readonly. By default, it's false.
- **decimalplaces:** Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)
15. **cells**
```
{
"type": "cells",
"page": 1,
"x": 100,
"y": 100,
"w": 114,
"h": 50,
"options": {
"name": "cells",
"required": true,
"readonly": false,
"cell_count": 5,
"default": "",
"hint": "",
"regularexpression": "",
"color": "black",
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
- **cell_count:** Specify the number of cells that should be returned to the user.
**Prefill Widgets:** Prefill widgets are elements that are inserted into a document **before** it is shared with a user. Only the document creator has permission to add them.
**Note:** Responses for prefill widgets are **required**.
@@ -2711,6 +2879,7 @@ paths:
- **name:** Provides a different name for widgets if you are providing more than one widget.
- **color:** Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown.
- **fontsize:** Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown.
- **hide_text_with_asterisks:** When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans.
**List of all supported widgets:**
@@ -2771,7 +2940,8 @@ paths:
"required": true,
"name": "email",
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -2789,7 +2959,8 @@ paths:
"required": true,
"name": "name",
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -2807,7 +2978,8 @@ paths:
"required": true,
"name": "job title",
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -2825,7 +2997,8 @@ paths:
"required": true,
"name": "company",
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -2845,7 +3018,9 @@ paths:
"default": "04-15-2024",
"format": "mm-dd-yyyy",
"color": "black",
"fontsize": 12
"fontsize": 12,
"min_date": "",
"max_date": ""
}
}
```
@@ -2862,6 +3037,8 @@ paths:
- "dd mmmm, yyy",
- "dd/mm/yyyy",
- "dd.mm.yyyy".
- **min_date:** Provide the minimum restriction date. The date must be in **YYYY-MM-DD** format.
- **max_date:** Provide the maximum restriction date. The date must be in **YYYY-MM-DD** format.
9. **textbox**
```
@@ -2880,7 +3057,8 @@ paths:
"hint": "provide name",
"regularexpression": "",
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -3005,7 +3183,8 @@ paths:
"formula": "",
"decimalplaces": 2,
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -3015,7 +3194,32 @@ paths:
- **readonly:** Set to true if you want to set the textbox as readonly. By default, it's false.
- **decimalplaces:** Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)
15. **cells**
```
{
"type": "cells",
"page": 1,
"x": 100,
"y": 100,
"w": 114,
"h": 50,
"options": {
"name": "cells",
"required": true,
"readonly": false,
"cell_count": 5,
"default": "",
"hint": "",
"regularexpression": "",
"color": "black",
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
- **cell_count:** Specify the number of cells that should be returned to the user.
**Prefill Widgets:** Prefill widgets are elements that are inserted into a document **before** it is shared with a user. Only the document creator has permission to add them.
**Note:** Responses for prefill widgets are **required**.
@@ -3209,6 +3413,7 @@ paths:
- **name:** Provides a different name for widgets if you are providing more than one widget.
- **color:** Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown.
- **fontsize:** Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown.
- **hide_text_with_asterisks:** When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans.
**List of all supported widgets:**
@@ -3269,7 +3474,8 @@ paths:
"required": true,
"name": "email",
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -3287,7 +3493,8 @@ paths:
"required": true,
"name": "name",
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -3305,7 +3512,8 @@ paths:
"required": true,
"name": "job title",
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -3323,7 +3531,8 @@ paths:
"required": true,
"name": "company",
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -3343,7 +3552,9 @@ paths:
"default": "04-15-2024",
"format": "mm-dd-yyyy",
"color": "black",
"fontsize": 12
"fontsize": 12,
"min_date": "",
"max_date": ""
}
}
```
@@ -3360,6 +3571,8 @@ paths:
- "dd mmmm, yyy",
- "dd/mm/yyyy",
- "dd.mm.yyyy".
- **min_date:** Provide the minimum restriction date. The date must be in **YYYY-MM-DD** format.
- **max_date:** Provide the maximum restriction date. The date must be in **YYYY-MM-DD** format.
9. **textbox**
```
@@ -3378,7 +3591,8 @@ paths:
"hint": "provide name",
"regularexpression": "",
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -3503,7 +3717,8 @@ paths:
"formula": "",
"decimalplaces": 2,
"color": "black",
"fontsize": 12
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
@@ -3513,6 +3728,30 @@ paths:
- **readonly:** Set to true if you want to set the textbox as readonly. By default, it's false.
- **decimalplaces:** Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)
15. **cells**
```
{
"type": "cells",
"page": 1,
"x": 100,
"y": 100,
"w": 114,
"h": 50,
"options": {
"name": "cells",
"required": true,
"readonly": false,
"cell_count": 5,
"default": "",
"hint": "",
"regularexpression": "",
"color": "black",
"fontsize": 12,
"hide_text_with_asterisks": false
}
}
```
- **cell_count:** Specify the number of cells that should be returned to the user.
**Prefill Widgets:** Prefill widgets are elements that are inserted into a document **before** it is shared with a user. Only the document creator has permission to add them.
@@ -4587,7 +4826,7 @@ components:
email:
type: string
example: joebee@example.com
phone:
ip_address:
type: string
example: "193.186.4.187"
xml:
@@ -4607,7 +4846,7 @@ components:
sent_date:
type: string
format: string
example: "26/11/2025"
example: "11/11/2025"
status:
type: string
format: string
@@ -4758,7 +4997,7 @@ components:
job_title:
type: string
format: string
example: dev
example: dev
folder_body:
required:
- foldername
@@ -4872,7 +5111,21 @@ components:
**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.
If nothing is set, it will use the owners preferences. If the owners preferences are also not set, it will default to false.
example: false
example: false
notify_on_signatures:
type: boolean
example: false
description: |
**true** - The document creator will receive an email notification whenever a signer signs the document.
**false** - The document creator will not receive an email notification whenever a signer signs the document.
Note: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on 'send_email' parameter.
pen_colors:
type: array
items:
type: string
example: ["blue", "red", "black"]
draftdocument_body:
required:
- file
@@ -4954,7 +5207,7 @@ components:
remind_once_in_every:
type: number
description: "Number of days between reminders. This is only applicable when auto_reminder is set to true."
example: 5,
example: 5
merge_certificate:
type: boolean
description: |
@@ -4964,6 +5217,20 @@ components:
If nothing is set, it will use the owners preferences. If the owners preferences are also not set, it will default to false.
example: false
notify_on_signatures:
type: boolean
example: false
description: |
**true** - The document creator will receive an email notification whenever a signer signs the document.
**false** - The document creator will not receive an email notification whenever a signer signs the document.
Note: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on 'send_email' parameter.
pen_colors:
type: array
items:
type: string
example: ["blue", "red", "black"]
prefill:
$ref: '#/components/schemas/prefill'
createdocument_body:
@@ -5057,7 +5324,21 @@ components:
**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.
If nothing is set, it will use the owners preferences. If the owners preferences are also not set, it will default to false.
example: false
example: false
notify_on_signatures:
type: boolean
example: false
description: |
**true** - The document creator will receive an email notification whenever a signer signs the document.
**false** - The document creator will not receive an email notification whenever a signer signs the document.
Note: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on 'send_email' parameter.
pen_colors:
type: array
items:
type: string
example: ["blue", "red", "black"]
prefill:
$ref: '#/components/schemas/prefill'
inline_response_200_1:
@@ -5197,7 +5478,7 @@ components:
remind_once_in_every:
type: number
description: "Number of days between reminders. This is only applicable when auto_reminder is set to true."
example: 5,
example: 5
merge_certificate:
type: boolean
description: |
@@ -5206,7 +5487,21 @@ components:
**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.
If nothing is set, it will use the owners preferences. If the owners preferences are also not set, it will default to false.
example: false
example: false
notify_on_signatures:
type: boolean
example: false
description: |
**true** - The document creator will receive an email notification whenever a signer signs the document.
**false** - The document creator will not receive an email notification whenever a signer signs the document.
Note: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on 'send_email' parameter.
pen_colors:
type: array
items:
type: string
example: ["blue", "red", "black"]
prefill:
type: object
properties:
@@ -5299,6 +5594,20 @@ components:
type: number
description: "Number of days between reminders. This is only applicable when auto_reminder is set to true."
example: 5
notify_on_signatures:
type: boolean
example: false
description: |
**true** - The document creator will receive an email notification whenever a signer signs the document.
**false** - The document creator will not receive an email notification whenever a signer signs the document.
Note: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on 'send_email' parameter.
pen_colors:
type: array
items:
type: string
example: ["blue", "red", "black"]
inline_response_200_3:
type: object
properties:
@@ -5397,7 +5706,7 @@ components:
remind_once_in_every:
type: number
description: "Number of days between reminders. This is only applicable when auto_reminder is set to true."
example: 5,
example: 5
merge_certificate:
type: boolean
description: |
@@ -5406,7 +5715,21 @@ components:
**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.
If nothing is set, it will use the owners preferences. If the owners preferences are also not set, it will default to false.
example: false
example: false
notify_on_signatures:
type: boolean
example: false
description: |
**true** - The document creator will receive an email notification whenever a signer signs the document.
**false** - The document creator will not receive an email notification whenever a signer signs the document.
Note: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on 'send_email' parameter.
pen_colors:
type: array
items:
type: string
example: ["blue", "red", "black"]
prefill:
$ref: '#/components/schemas/prefill'
inline_response_draft_200:
@@ -5491,7 +5814,21 @@ components:
remind_once_in_every:
type: number
description: "Number of days between reminders. This is only applicable when auto_reminder is set to true."
example: 5
example: 5
notify_on_signatures:
type: boolean
example: false
description: |
**true** - The document creator will receive an email notification whenever a signer signs the document.
**false** - The document creator will not receive an email notification whenever a signer signs the document.
Note: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on 'send_email' parameter.
pen_colors:
type: array
items:
type: string
example: ["blue", "red", "black"]
inline_response_404_7:
type: object
properties:
@@ -153,25 +153,27 @@ Use the option on the right side to add recipients if you need to include additi
- All pages but first: It will copy the initials widget to all pages except the first page.
- **Name**: The name widget allows signers to add their name or any other text, functioning like a text field during the signing process. After placing the name widget, you will see the options on the widget such as:
- Setting icon: By clicking on the option, you can set the color and font.
**Hide text with asterisks**: **"which masks the entered text (*) to protect sensitive information while filling out the document. The final embedded document will also display the text as asterisks, keeping the actual value hidden.
- Add Signer/Change Signer: Clicking the first icon on the Name widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
- Copy : Clicking on this you can duplicate the name widget.
- **Job title**: The Job title widget allows signers to add their Job title or any other text, functioning like a text field during the signing process. After placing the job title widget, you will see the options on the widget such as:
- Setting icon: By clicking on the option, you can set the color and font.
**Hide text with asterisks**: **"which masks the entered text (*) to protect sensitive information while filling out the document. The final embedded document will also display the text as asterisks, keeping the actual value hidden.
- Add Signer/Change Signer: Clicking the first icon on the Job title widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
- Copy : Clicking on this you can duplicate the job title widget.
- **Company**: The company widget allows signers to add their company or any other text, functioning like a text field during the signing process. After placing the company widget, you will see the options on the widget such as:
- Setting icon: By clicking on the option, you can set the color and font.
**Hide text with asterisks**: **"which masks the entered text (*) to protect sensitive information while filling out the document. The final embedded document will also display the text as asterisks, keeping the actual value hidden.
- Add Signer/Change Signer: Clicking the first icon on the Company widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
- Copy : Clicking on this you can duplicate the Company widget.
- **Date**: The date widget allows signers to add a date during the signing process. After placing the date widget, you will see the options on the widget such as:
- Setting icon: By clicking on the option, you can choose from various date formats.
- Add Signer/Change Signer: Clicking the first icon on the Date widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
- Copy : Clicking on this you can duplicate the date widget.
- **Text**: The text field functions as a label. Users can add and type text into this field, which will be embedded in the document when it's sent. This field is not editable by the signer. After placing the Text widget, you will see the options on the widget such as:
- Setting icon: By clicking on the option, you can set the color and font.
- Copy : Clicking on this you can duplicate the Text widget.
- **Text Input**: The text input field is used to collect input from the signer. Signers can type their responses directly into this field. After placing the Text Input widget, you will see the options on the widget such as:
- Setting : The widget settings panel provides additional customization options, including:
- Choosing a **font color**
@@ -179,6 +181,7 @@ Use the option on the right side to add recipients if you need to include additi
- Marking the field as **required** or **optional**
- Providing a **default value**
- Making the field **read-only**
- **Hide text with asterisks**: **"which masks the entered text (*) to protect sensitive information while filling out the document. The final embedded document will also display the text as asterisks, keeping the actual value hidden.
- Adding a **hint**, which will be displayed on the widget for better clarity
- **Custom Validations** are also supported, including:
- Predefined formats like **SSN**, **email**, or **numeric values**
@@ -206,6 +209,7 @@ Use the option on the right side to add recipients if you need to include additi
- Marking the field as **required** or **optional**
- Providing a **default value**
- Making the field **read-only**
- **Hide text with asterisks**: **"which masks the entered text (*) to protect sensitive information while filling out the document. The final embedded document will also display the text as asterisks, keeping the actual value hidden.
- Adding a **hint**, which will be displayed on the widget for better clarity
**Custom Validations** are also supported, including:
@@ -237,6 +241,9 @@ Use the option on the right side to add recipients if you need to include additi
- Copy : Clicking on this you can duplicate the image widget.
- **Email**: The email widget is used to enter an email address during the signing process. It only accepts input in a valid email format. If the signer enters invalid text, a validation error will occur, and the document cannot be completed until it's corrected. After placing the email widget, you will see the options on the widget such as:
- Setting icon: By clicking on the option, you can set the color and font.
**Hide text with asterisks**: **"which masks the entered text (*) to protect sensitive information while filling out the document. The final embedded document will also display the text as asterisks, keeping the actual value hidden.
- Add Signer/Change Signer: Clicking the first icon on the Email widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
- Copy : Clicking on this you can duplicate the email widget.
### 📄 Document Page Controls
+11
View File
@@ -47,6 +47,17 @@ The "Completed documents" report also includes several actions icons for each do
- **Save as template:** This option allows the user to save the current document as a reusable template. Upon clicking, a confirmation popup will appear. If the user selects Yes, the template will be created successfully. After that, the user will be presented with options to Use Template, Send in Bulk, or Edit the Template. The newly created template will also be available in the Manage Templates list.
- **View formdata**: Use this option to download all form data collected during the signing process. The exported file contains every input field and its corresponding value, making it easy to review, archive, or process externally.
You can download the data in Excel format using this option.
You can also print the form details if needed.
Fields marked with **Hide Text with Asterisks** will be exported in plain text (unmasked), showing the actual values entered.
**Note:** You cannot download form data if any widget names in the document are duplicated — each widget must have a unique name.
This feature is available only on the **Teams** and **Enterprise** plans.
- **Fix and resend:** This option allows the user to recreate a completed document.
It is useful when the completed document contains missing or incorrect information. Instead of starting from scratch, the user can use this feature to make the necessary edits and resend the document for signature.
+11
View File
@@ -66,6 +66,17 @@ The pop-up will display a list of email addresses of the intended recipients or
Upon clicking, a confirmation popup will appear. If the user selects Yes, the template will be created successfully. After that, the user will be presented with options to Use Template, Send in Bulk, or Edit the Template.
The newly created template will also be available in the Manage Templates list.
- **View formdata**: Use this option to download all form data collected during the signing process. The exported file contains every input field and its corresponding value, making it easy to review, archive, or process externally.
You can download the data in Excel format using this option.
You can also print the form details if needed.
Fields marked with **Hide Text with Asterisks** will be exported in plain text (unmasked), showing the actual values entered.
**Note:** You cannot download form data if any widget names in the document are duplicated — each widget must have a unique name.
This feature is available only on the **Teams** and **Enterprise** plans.
- **Delete :** If the document is outdated or was sent by mistake, you can permanently remove it from the list. Use this action cautiously, as deleted documents cannot be recovered.
If you require more help, feel free to reach out to our customer support on support@opensignlabs.com.
+29
View File
@@ -41,6 +41,35 @@ Youll also find the option to generate a **Sandbox API Token** on the same pa
<img width="436" alt="Sandbox api token" src="https://github.com/user-attachments/assets/f27d9e00-7989-4c01-b23e-cecaccce4be2" />
### 🧪 API Credits
**Premium Credits Available:**
Displays the total API credits available for your organisation.
**Your Credits Usage:**
- **Used Credits:** The number of credits you have consumed.
- **Remaining Credits:** The number of credits still available for you to use.
<img width="436" alt="API credit" src="https://github.com/user-attachments/assets/e0d87fb2-7391-4bad-b668-9ce2b558c52d" />
### Where API Credits Are Deducted
API credits are consumed whenever a document is created through the following actions:
- **Self Sign API:** Credits deducted when a document is created.
- **Draft Document API:** Deducted when drafting a document.
- **Create Document API:** Deducted on document creation.
- **Draft Template API:** Deducted when:
- Sending a document if signers are already assigned,
- Bulk sending,
- Creating documents using public templates (signer fills details and finish).
- **Create Document From Template API:** Deducted on document creation.
### In the OpenSign Application
- **Manage Templates → Bulk Send:** Credits are deducted for each document created.
- **Public Template Signing:** Credits are deducted when a document is created during public signing (when the signer enters details and completes the process).
### 🧪 Sandbox Cloud Account Login
OpenSign provides a **sandbox testing cloud environment**, which is a replica of the production environment. This allows users to test features without affecting live data.
+113 -2
View File
@@ -28,7 +28,7 @@ Suppose you're using OpenSign to collect eSignatures:
**Step 1:** Log in to your OpenSign account using your credentials.
**Step 2:** Navigate to **Settings → Webhook**.
![Navigate to Add Webhook](https://github.com/user-attachments/assets/6b069b6c-d2b7-408b-b7c9-7fbeb55d6c98)
<img width="861" height="407" alt="Navigate to Add Webhook" src="https://github.com/user-attachments/assets/883dc914-9316-42b0-b59c-10b168265b38" />
**Step 3:** Click **Add Webhook**.
@@ -36,10 +36,121 @@ Suppose you're using OpenSign to collect eSignatures:
> **Note:** To enable **Live Webhook** support, you must upgrade to a **paid plan** — either the **Professional** or **Teams** plan.
![Add Webhook](https://github.com/user-attachments/assets/ff68b255-a6e6-4a7d-9cef-6dd9e3b6d4e4)
---
## 🧭 How to Create a Webhook Security Key
A **Webhook Security Key** (also called a webhook secret) is a shared secret used to verify that webhook requests are genuinely sent by OpenSign and have not been tampered with.
### Steps to Create a Webhook Security Key
1. Log in to your **OpenSign** account.
2. Navigate to **Settings → Webhooks**.
3. Add or edit a webhook endpoint.
4. Generate a Security Key by clicking Enable Authentication, then click the Generate button.
The webhook security key has been generated.
- Example: `a50a904a2a329d761781dac27c984416a07396736ac5588b62c6fe226538fbca`
6. Save the webhook configuration.
<img width="861" height="600" alt="webhook security key" src="https://github.com/user-attachments/assets/6f61a23e-25a1-4785-b241-657af0c1eeb1" />
⚠️ **Important:** Store this key securely. Do not expose it in client-side code or public repositories.
---
## 🔐 How the Webhook Security Key Works
OpenSign signs every webhook request using your security key.
### High-level Flow
1. An event occurs (e.g. create document, document viewed, signed, completed, and declined).
2. OpenSign sends a webhook request to your configured endpoint.
3. OpenSign generates a signature using:
- The **raw request payload**
- Your **webhook security key**
- The **HMAC-SHA256** algorithm
4. The generated signature is sent in the request header:
```
x-webhook-signature
```
5. Your server recomputes the signature using the same payload and secret.
6. If both signatures match, the request is verified as authentic.
---
// Process webhook event
```
---
## 📦 Sample Webhook Payload
```json
const crypto = require("crypto");
function verifySignature(req, secret) {
const receivedSignature = req.headers["x-webhook-signature"];
const payload = req.body;
const expectedSignature = crypto
.createHmac("sha256", secret)
.update(JSON.stringify(payload))
.digest("hex");
return receivedSignature === expectedSignature;
}
console.log("Try programiz.pro", verifySignature({body: {
"event": "created",
"type": "request-sign",
"objectId": "SBEbnHwfrN",
"file": "https://legadratw3d.ams3.digitaloceanspaces.com/c3f0bc11b84a87e6265de6bf28e5015e_uoeksXXU6FI5Op2B.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=DO00QAPRB3CQRWHWQ8ZB%2F20251219%2Fus-west%2Fs3%2Faws4_request&X-Amz-Date=20251219T152806Z&X-Amz-Expires=900&X-Amz-Signature=9635dfb8ee8fde933f881905a97f869578ef7e99b337d4b21a0805b8317fd70d&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject",
"name": "Sample Test Doc Line Compressed",
"note": "Please review and sign this document",
"description": "",
"signers": [
{
"name": "Peter Mark",
"email": "peter.mark@opensignlabs.com"
},
{
"name": "kelvin bosch",
"email": "kelvin.bosch@opensignlabs.com"
}
],
"createdAt": "Sat, 20 Dec 2025 00:58:20 GMT+9:30"
}, headers:{"x-webhook-signature":"52958fd3900f19ba6485319eb2622ef0ec4cf5ddfe36509cbe95eb706ed6b8c2" }}, "0906e8cbc88da0d5a6fd78162eb8e5e57ba7bd99bdc472145dc089d7f82b0a4a"));
```
The corresponding signature is sent in the request header:
```
x-webhook-signature: bcf57b06dde0c030d9423639824bad17ab7dd09ea3bf0a743773b95254ecf78e
```
If the script returns true, it means the webhook is valid and has not been tampered with.
## ✅ Best Practices
- Always verify the webhook signature before processing the payload.
- Use the **raw request body** for signature calculation (avoid modifying it).
- Rotate your webhook security key periodically.
- Return a **2xx** HTTP status only after successful verification.
---
## 🧩 Common Issues
- **Signature mismatch**: Ensure the payload is stringified exactly as received.
- **Missing header**: Confirm `x-webhook-signature` is present in the request.
- **Wrong secret**: Verify the same security key is used on both sides.
---
This mechanism ensures webhook requests are secure, tamper-proof, and trustworthy.
## 🧪 Sandbox Webhook
- You can also add webhook for the **Sandbox** environment on the same page.
+34 -1
View File
@@ -73,7 +73,40 @@ To add a new user:
3. Enter the users email in the input box and click **Delete**.
- After deletion, the user (and all related data) will be permanently erased.
> ⚡ **Note:** Once a user is deleted, your **available user count will automatically increase**.
> ⚡ **Note:** Once a user is deleted, your **available user count will automatically increase**.
## 🔁 Change Password
- OpenSign allows **admins** to update a team user's password whenever required.
- **To change a users password:**
1. Navigate to **Settings → Users** and click the **Change Password** button next to the user whose password needs to be updated.
2. Enter the new password on the reset password screen and submit.
- The users password will be successfully updated, and they will no longer be able to log in using the old password.
## 🔁 Add API Credits
- OpenSign allows **admins to assign API credits** to team users. This feature helps control and limit how many API-based document operations a user can perform.
- A team user can only use the number of credits allocated by the admin.
- For example, if an admin assigns **100 API credits**, the user can perform API actions only until those 100 credits are consumed.
- Once credits are exhausted, the admin can add more.
- Example: If the admin wants to give the user 50 additional credits, they must enter the updated total — 150 credits. After updating, the user will have 50 usable credits remaining.
- **How to add API credits:**
1. Navigate to **Settings → Users** and click the **Add Credits** button next to the user who needs add API credits.
2. Enter the number of credits to allocate and submit.
- The user will now be able to use the assigned API credits up to the new limit.
> ⚡ **Note:** Credits can only be added if the selected user has an active API token.
**How to create an API token for a team user:**
1. Log in using the team user's email address.
2. Navigate to **Settings → API Token**.
3. Generate a live API token.
Once the API token is created, the admin can assign API credits to that user.
---
+12 -5
View File
@@ -148,17 +148,24 @@ After placing the Stamp widget, you will see the options on the widget such as:
- **Name**: The name widget allows signers to add their name or any other text, functioning like a text field during the signing process.
After placing the name widget, you will see the options on the widget such as:
- Setting icon: By clicking on the option, you can set the color and font.
**Hide text with asterisks**: **"which masks the entered text (*) to protect sensitive information while filling out the document. The final embedded document will also display the text as asterisks, keeping the actual value hidden.
- Add Signer/Change Signer: Clicking the first icon on the Name widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
- Copy : Clicking on this you can duplicate the name widget.
- **Job title**: The Job title widget allows signers to add their Job title or any other text, functioning like a text field during the signing process.
After placing the job title widget, you will see the options on the widget such as:
- Setting icon: By clicking on the option, you can set the color and font.
**Hide text with asterisks**: **"which masks the entered text (*) to protect sensitive information while filling out the document. The final embedded document will also display the text as asterisks, keeping the actual value hidden.
- Add Signer/Change Signer: Clicking the first icon on the Job title widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
- Copy : Clicking on this you can duplicate the job title widget.
- **Company**: The company widget allows signers to add their company or any other text, functioning like a text field during the signing process.
After placing the company widget, you will see the options on the widget such as:
- Setting icon: By clicking on the option, you can set the color and font.
**Hide text with asterisks**: **"which masks the entered text (*) to protect sensitive information while filling out the document. The final embedded document will also display the text as asterisks, keeping the actual value hidden.
- Add Signer/Change Signer: Clicking the first icon on the Company widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
- Copy : Clicking on this you can duplicate the Company widget.
- **Date**: The date widget allows signers to add a date during the signing process.
@@ -166,11 +173,7 @@ After placing the date widget, you will see the options on the widget such as:
- Setting icon: By clicking on the option, you can choose from various date formats.
- Add Signer/Change Signer: Clicking the first icon on the Date widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
- Copy : Clicking on this you can duplicate the date widget.
- **Text**: The text field functions as a label. Users can add and type text into this field, which will be embedded in the document when it's sent. This field is not editable by the signer.
After placing the Text widget, you will see the options on the widget such as:
- Setting icon: By clicking on the option, you can set the color and font.
- Copy : Clicking on this you can duplicate the Text widget.
- **Text Input**: The text input field is used to collect input from the signer. Signers can type their responses directly into this field.
After placing the Text Input widget, you will see the options on the widget such as:
- Setting icon: The widget settings panel provides additional customization options, including:
@@ -179,6 +182,7 @@ After placing the Text Input widget, you will see the options on the widget such
- Marking the field as **required** or **optional**
- Providing a **default value**
- Making the field **read-only**
- **Hide text with asterisks**: **"which masks the entered text (*) to protect sensitive information while filling out the document. The final embedded document will also display the text as asterisks, keeping the actual value hidden.
- Adding a **hint**, which will be displayed on the widget for better clarity
- **Custom Validations** are also supported, including:
- Predefined formats like **SSN**, **email**, or **numeric values**
@@ -207,6 +211,7 @@ After placing the Text Input widget, you will see the options on the widget such
- Marking the field as **required** or **optional**
- Providing a **default value**
- Making the field **read-only**
- **Hide text with asterisks**: **"which masks the entered text (*) to protect sensitive information while filling out the document. The final embedded document will also display the text as asterisks, keeping the actual value hidden.
- Adding a **hint**, which will be displayed on the widget for better clarity
- **Custom Validations** are also supported, including:
- Predefined formats like **SSN**, **email**, or **numeric values**
@@ -242,6 +247,8 @@ After placing the Image widget, you will see the options on the widget such as:
- **Email**: The email widget is used to enter an email address during the signing process. It only accepts input in a valid email format. If the signer enters invalid text, a validation error will occur, and the document cannot be completed until it's corrected.
After placing the email widget, you will see the options on the widget such as:
- Setting icon: By clicking on the option, you can set the color and font.
**Hide text with asterisks**: **"which masks the entered text (*) to protect sensitive information while filling out the document. The final embedded document will also display the text as asterisks, keeping the actual value hidden.
- Add Signer/Change Signer: Clicking the first icon on the Email widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
- Copy : Clicking on this you can duplicate the email widget.
### 📄 Edit Template
@@ -48,6 +48,15 @@ The selected user will be able to access the template and create documents from
<img width="828" alt="Manage Template" src="https://github.com/user-attachments/assets/89780622-dd0d-47b7-b3b2-a71d537d7967" />
<img width="828" alt="Manage Template" src="https://github.com/user-attachments/assets/fdc98efe-dc2d-4e53-bc66-be3aab07eef0" />
**Download all formdata**: Use this option to download all form data collected during the signing process. The exported file contains every input field and its corresponding value, making it easy to review, archive, or process externally.
You can download the data in Excel format using this template.
Fields marked with **Hide Text with Asterisks** will be exported in plain text (unmasked), showing the actual values entered.
**Note:** You cannot download form data if any widget names in the template are duplicated — each widget must have a unique name.
This feature is available only on the **Teams** and **Enterprise** plans.
**Embed**: The "Embed" option provides you with a code to embed the template into a website or other platforms, allowing users to interact with it directly from the external site.
Click "Embed" to generate the code that can be copied and pasted into your desired web location. We currently support React, HTML/JavaScript and Angular-based websites.