mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-03 08:18:50 +02:00
Compare commits
287
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
224741d2ec | ||
|
|
f0a8263aff | ||
|
|
a320835a73 | ||
|
|
805d0d1d84 | ||
|
|
b0d159462a | ||
|
|
84bdcfbcba | ||
|
|
e4a51b5390 | ||
|
|
891ff460a9 | ||
|
|
03c311ca7b | ||
|
|
620274e1eb | ||
|
|
dfb5b1bb94 | ||
|
|
0994f80891 | ||
|
|
cb9f75bf2f | ||
|
|
ee8525dac3 | ||
|
|
8919a2b2e9 | ||
|
|
efa5e2e491 | ||
|
|
c58566ea1b | ||
|
|
e1da69398c | ||
|
|
3f4cffb157 | ||
|
|
3d91b8b12e | ||
|
|
592f35f47f | ||
|
|
ed9fe3c5f9 | ||
|
|
c6e1593df5 | ||
|
|
900f929b53 | ||
|
|
e8093f1bf0 | ||
|
|
97912d2432 | ||
|
|
6fd6cd3eb8 | ||
|
|
37465082e4 | ||
|
|
d011edd3a1 | ||
|
|
694483aa2d | ||
|
|
c6be12b16a | ||
|
|
0213807732 | ||
|
|
d758062c07 | ||
|
|
cf698be79e | ||
|
|
c3298ccc6f | ||
|
|
eefa11d827 | ||
|
|
dadc79600f | ||
|
|
76d10d6ab9 | ||
|
|
c8733e6903 | ||
|
|
88ec854dbd | ||
|
|
717d2c0ddd | ||
|
|
8e2d463089 | ||
|
|
1344d8d12f | ||
|
|
51c8040d60 | ||
|
|
e505396e53 | ||
|
|
606bedd2ec | ||
|
|
dc82af0a0a | ||
|
|
8dfc61eeef | ||
|
|
2133a3a460 | ||
|
|
6f615db29d | ||
|
|
4141b3538c | ||
|
|
3bbb78b7b5 | ||
|
|
2caa231154 | ||
|
|
9ac382c188 | ||
|
|
852e109a52 | ||
|
|
d292b5bd6a | ||
|
|
d868fdf6f2 | ||
|
|
4145ce8c0c | ||
|
|
e093d7a5f4 | ||
|
|
3d4e43ede5 | ||
|
|
0bbfe5ae3d | ||
|
|
8538f0710a | ||
|
|
61be45cba2 | ||
|
|
162e07bacc | ||
|
|
806bb2e387 | ||
|
|
9de3331cd2 | ||
|
|
76699d7dc9 | ||
|
|
5888387dd0 | ||
|
|
83e9537176 | ||
|
|
d973a8fea4 | ||
|
|
ae6f727646 | ||
|
|
f9eb9201f0 | ||
|
|
0d884e2f4f | ||
|
|
1c70e4c059 | ||
|
|
e747d0d699 | ||
|
|
2edbafd520 | ||
|
|
14c57cceb3 | ||
|
|
6337f3057e | ||
|
|
537949b7c3 | ||
|
|
180e7c1435 | ||
|
|
9139422180 | ||
|
|
274d01b548 | ||
|
|
4d62048d36 | ||
|
|
921f7c89e9 | ||
|
|
6bfa3e61b5 | ||
|
|
840c7165ff | ||
|
|
9eeb1e9bc2 | ||
|
|
bc7f2d69cf | ||
|
|
34d9296c70 | ||
|
|
725b67e75e | ||
|
|
71bb6d6206 | ||
|
|
f271a113b6 | ||
|
|
71b254f69d | ||
|
|
28b6e9d4aa | ||
|
|
c6f57db04b | ||
|
|
5626b18ab0 | ||
|
|
5adf336119 | ||
|
|
ef1d4967d9 | ||
|
|
7680c8e140 | ||
|
|
0a14122cbf | ||
|
|
6587268f53 | ||
|
|
96d0db22c8 | ||
|
|
d35a03d588 | ||
|
|
7fd743f325 | ||
|
|
b81ff12ae5 | ||
|
|
65be6d1e20 | ||
|
|
9dfd1fb4f1 | ||
|
|
abbc0e91a9 | ||
|
|
1bf2f5622f | ||
|
|
8a1f2bc9a0 | ||
|
|
75518b3f6b | ||
|
|
53d874fd12 | ||
|
|
b7b61df983 | ||
|
|
20f1e68b13 | ||
|
|
e26fac8498 | ||
|
|
02dfec3a0f | ||
|
|
e6a04670b6 | ||
|
|
41aa91152d | ||
|
|
e69fb8eeba | ||
|
|
cb2dab8222 | ||
|
|
ad2672f205 | ||
|
|
e45314c1df | ||
|
|
34b0a1ca02 | ||
|
|
c05f541189 | ||
|
|
68cad8e10c | ||
|
|
2afad89b29 | ||
|
|
6c57ee6591 | ||
|
|
48bcaa5614 | ||
|
|
e595672e3c | ||
|
|
8fe31ee59b | ||
|
|
c6b139c456 | ||
|
|
10d99f12bb | ||
|
|
55ebdb5919 | ||
|
|
4b6712a0ff | ||
|
|
fcb983f68a | ||
|
|
f92ff170db | ||
|
|
c8b3f1fcbf | ||
|
|
936717fc6f | ||
|
|
be948ed4df | ||
|
|
5d8e7f738d | ||
|
|
128f6378cf | ||
|
|
1641217c43 | ||
|
|
63cc034b4a | ||
|
|
49a63eeb50 | ||
|
|
da45fcfc85 | ||
|
|
b73b0c6b2d | ||
|
|
c9fe580e44 | ||
|
|
b0556310dd | ||
|
|
9da13a23cc | ||
|
|
d727e16ef9 | ||
|
|
1508c63d0e | ||
|
|
8a198c1543 | ||
|
|
da0652d8ed | ||
|
|
59f1453176 | ||
|
|
ad748fbd03 | ||
|
|
2a1afca818 | ||
|
|
8e1cfd1ce5 | ||
|
|
6236353316 | ||
|
|
b5271017dc | ||
|
|
4b6b955fe5 | ||
|
|
a2b3761d5e | ||
|
|
2c5e311c7f | ||
|
|
98facb2f6d | ||
|
|
77618e57ea | ||
|
|
0bb8aa880d | ||
|
|
f97f2c1253 | ||
|
|
b76add3b2b | ||
|
|
07b14a0a47 | ||
|
|
aa7326a941 | ||
|
|
336d3424fe | ||
|
|
73ae7b1c06 | ||
|
|
ccfd7450d5 | ||
|
|
e23c04cf06 | ||
|
|
7bf661d584 | ||
|
|
98c18357cd | ||
|
|
8b7079bd8b | ||
|
|
9f0963d8a3 | ||
|
|
ebc79ddec7 | ||
|
|
24c6e9f5c0 | ||
|
|
475b2e09af | ||
|
|
05a922446a | ||
|
|
81a426b087 | ||
|
|
743b751b5a | ||
|
|
3d6e83b4af | ||
|
|
4f3e8ab95a | ||
|
|
cc00b35ac8 | ||
|
|
1c86caac1f | ||
|
|
20dd3c90d6 | ||
|
|
8b87a90e78 | ||
|
|
bd7937deb2 | ||
|
|
7b0dc4cf9a | ||
|
|
81c47190bf | ||
|
|
cecf22bb85 | ||
|
|
17eacfe86b | ||
|
|
8f5c9d1b40 | ||
|
|
f34e277657 | ||
|
|
7cc7e36f64 | ||
|
|
b340463ea7 | ||
|
|
9364bb7859 | ||
|
|
9f676c12e7 | ||
|
|
0077b71388 | ||
|
|
50af669bd2 | ||
|
|
45055b567f | ||
|
|
4a7fd118bb | ||
|
|
d27e8a43dc | ||
|
|
4d3635a5bd | ||
|
|
aeef6ca567 | ||
|
|
cc68dd109f | ||
|
|
7943f1444f | ||
|
|
876e04d815 | ||
|
|
43dbe71c99 | ||
|
|
73b36fafd7 | ||
|
|
095040713e | ||
|
|
ac884185b4 | ||
|
|
eede170d16 | ||
|
|
c4d6d8e442 | ||
|
|
14a2f6f78a | ||
|
|
dd28cefac8 | ||
|
|
00179f5415 | ||
|
|
7b465687ef | ||
|
|
e67fdfb134 | ||
|
|
ceee0e1089 | ||
|
|
1d184a69b0 | ||
|
|
8e09d7235b | ||
|
|
a39c01ef12 | ||
|
|
d96504bb30 | ||
|
|
0b8c4eac6e | ||
|
|
98f7de5e0c | ||
|
|
998a50412a | ||
|
|
e16c5e08a8 | ||
|
|
72a61bc621 | ||
|
|
f095629134 | ||
|
|
a0c1e08091 | ||
|
|
3583d7a549 | ||
|
|
69e679982a | ||
|
|
3303fcb895 | ||
|
|
6b5815f52a | ||
|
|
a01e361d14 | ||
|
|
c059e95fa9 | ||
|
|
70abddec3a | ||
|
|
ca8eaa492c | ||
|
|
94806c895f | ||
|
|
8b08995e7d | ||
|
|
de9c58e5fd | ||
|
|
6d914829e9 | ||
|
|
0193e4946f | ||
|
|
14c6b14c27 | ||
|
|
794365f6dc | ||
|
|
d0a0a28dec | ||
|
|
1385f12543 | ||
|
|
0d81ffe677 | ||
|
|
9d7376aedb | ||
|
|
5eb7d8ce13 | ||
|
|
4609bba4c1 | ||
|
|
de0de1973e | ||
|
|
16c48e9d23 | ||
|
|
344ccadfb1 | ||
|
|
eb1086e5b1 | ||
|
|
ae568a89d5 | ||
|
|
daa348c2e3 | ||
|
|
78532731da | ||
|
|
2e26d5687e | ||
|
|
4b8b7ed8d9 | ||
|
|
ac986af20f | ||
|
|
a96333bba5 | ||
|
|
78ca0d1fdb | ||
|
|
415760ba52 | ||
|
|
67bd246ef9 | ||
|
|
4963a7ad7f | ||
|
|
94b02105f3 | ||
|
|
6aaeeeeaf5 | ||
|
|
8039f5a744 | ||
|
|
a5ebd67967 | ||
|
|
266a4c5654 | ||
|
|
406a29054e | ||
|
|
57f8ba8a72 | ||
|
|
f1a70eac5a | ||
|
|
f228ae5ba8 | ||
|
|
2c1239dcf0 | ||
|
|
6ca9cbab16 | ||
|
|
9922f22ef7 | ||
|
|
84cc1d65fe | ||
|
|
7a5db1ca40 | ||
|
|
de79c9a4b3 | ||
|
|
7a7e1b506a | ||
|
|
fa2e66914d | ||
|
|
b0c65fe5f1 |
@@ -1,26 +1,9 @@
|
||||
# Overview
|
||||
---
|
||||
id: api-intro
|
||||
title: OpenSign APIs
|
||||
sidebar_label: Overview
|
||||
---
|
||||
|
||||
OpenSign™ API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures.
|
||||
|
||||
# Key Features
|
||||
|
||||
- **Document Creation**: Allows for the generation of digital documents directly through the API.
|
||||
- **Template Creation**: Supports the creation and management of document templates for consistent use across various applications.
|
||||
- **Electronic Signature Integration**: Provides capabilities for incorporating electronic signatures into documents.
|
||||
- **User Management**: Facilitates the management of user accounts, permissions, and roles within an application.
|
||||
- **Contacts Management**: Enables efficient handling of contact information and integration with document processes.
|
||||
- **Compliance and Security**: Ensures all operations adhere to global legal standards for electronic signatures and data security.
|
||||
- **Customization and Flexibility**: Offers highly customizable workflows, tailored to meet diverse organizational requirements.
|
||||
- **Cross-Platform Compatibility**: Assures seamless functionality across various platforms and devices.
|
||||
|
||||
# Target Audience
|
||||
|
||||
- **Developers and IT Professionals**: Implementing digital document management and electronic signature solutions.
|
||||
- **Businesses and Enterprises**: Seeking efficient and secure digital document workflows.
|
||||
- **Legal and Compliance Teams**: Requiring digital solutions compliant with legal standards for signatures and document management.
|
||||
|
||||
# Usage Scenarios
|
||||
|
||||
- Streamlining contract creation and signing processes in corporate environments.
|
||||
- Managing user permissions and contacts for large-scale document workflows.
|
||||
- Utilizing templates for standardized document processes in legal, financial, and governmental sectors.
|
||||
Welcome to the OpenSign API. Choose a version from the sidebar:
|
||||
- **v1** — stable baseline
|
||||
- **v1.1** — latest additions, backward-compatible with v1
|
||||
|
||||
@@ -1,10 +1,23 @@
|
||||
openapi: 3.0.3
|
||||
info:
|
||||
title: OpenSign API v1
|
||||
description: "Welcome to the OpenSign™ API documentation! Our powerful and flexible API allows you to seamlessly integrate digital signing capabilities into your applications. Whether you're a developer looking to automate document workflows, a business seeking to enhance security, or an enterprise aiming for efficient contract management, our API provides robust solutions to meet your needs. Dive into our detailed guides, code examples, and best practices to start leveraging the full potential of OpenSign™ and transform your digital document processes today. \n\nSome useful links:\n- [OpenSign Website](https://www.opensignlabs.com)\n- [OpenSign Github repo](https://github.com/opensignlabs/opensign)"
|
||||
termsOfService: http://www.opensignlabs.com/terms/
|
||||
description: |
|
||||
Welcome to the OpenSign™ API documentation!
|
||||
|
||||
Our powerful and flexible API empowers you to seamlessly integrate digital signing capabilities into your applications. Whether you're a developer automating document workflows, a business enhancing security, or an enterprise streamlining contract management, OpenSign™ delivers robust solutions tailored to your needs.
|
||||
|
||||
Explore our comprehensive guides, code samples, and best practices to unlock the full potential of OpenSign™ and transform your digital document processes.
|
||||
|
||||
**Useful Links:**
|
||||
- [OpenSign Website](https://www.opensignlabs.com)
|
||||
- [OpenSign GitHub Repository](https://github.com/opensignlabs/opensign)
|
||||
- [Generate x-api-token](https://docs.opensignlabs.com/docs/help/Settings/APIToken) – Learn how to securely generate and manage your API token for authenticating requests.
|
||||
|
||||
x-api-token:
|
||||
description: "refer docs to generate api token [APIToken help](https://docs.opensignlabs.com/docs/help/Settings/APIToken)"
|
||||
contact:
|
||||
email: api@opensignlabs.com
|
||||
termsOfService: http://www.opensignlabs.com/terms/
|
||||
license:
|
||||
name: AGPL v 3.0
|
||||
url: http://github.com/opensignlabs/opensign/LICENSE
|
||||
@@ -15,6 +28,7 @@ externalDocs:
|
||||
servers:
|
||||
- url: https://sandbox.opensignlabs.com/api/v1
|
||||
- url: https://app.opensignlabs.com/api/v1
|
||||
- url: https://eu-app.opensignlabs.com/api/v1
|
||||
- url: https://staging-app.opensignlabs.com/api/v1
|
||||
tags:
|
||||
- name: OpenSign
|
||||
@@ -405,7 +419,7 @@ paths:
|
||||
```
|
||||
- **default:** Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided.
|
||||
- **format:** Specify the date format of your choice from the options below.
|
||||
- "dd/MM/yyyy",
|
||||
- "mm/dd/yyyy",
|
||||
- "dd-mm-yyyy",
|
||||
- "yyyy-mm-dd",
|
||||
- "mm.dd.yyyy",
|
||||
@@ -413,8 +427,10 @@ paths:
|
||||
- "mmm dd, yyyy",
|
||||
- "mmmm dd, yyyy",
|
||||
- "dd mmm, yyyy",
|
||||
- "dd mmmm, yyy".
|
||||
|
||||
- "dd mmmm, yyy",
|
||||
- "dd/mm/yyyy",
|
||||
- "dd.mm.yyyy".
|
||||
|
||||
9. **textbox**
|
||||
```
|
||||
{
|
||||
@@ -438,7 +454,7 @@ paths:
|
||||
```
|
||||
- **default:** Provide a default value for the textbox (Optional).
|
||||
- **hint:** Provide a hint for the textbox (Optional).
|
||||
- **regularexpression:** Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional).
|
||||
- **regularexpression:** A custom regex pattern for validation - for example, /^\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. [help](https://www.w3schools.com/jsref/jsref_obj_regexp.asp) (Optional).
|
||||
- **readonly:** Set to true if you want to set the textbox as readonly. By default, it's false.
|
||||
|
||||
10. **checkbox**
|
||||
@@ -459,6 +475,7 @@ paths:
|
||||
"hidelabel": false,
|
||||
"color": "black",
|
||||
"fontsize": 12,
|
||||
"layout": "vertical",
|
||||
"validation": {
|
||||
"minselections": 0,
|
||||
"maxselections": 0
|
||||
@@ -677,7 +694,7 @@ paths:
|
||||
```
|
||||
- **default:** Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided.
|
||||
- **format:** Specify the date format of your choice from the options below.
|
||||
- "dd/MM/yyyy",
|
||||
- "mm/dd/yyyy",
|
||||
- "dd-mm-yyyy",
|
||||
- "yyyy-mm-dd",
|
||||
- "mm.dd.yyyy",
|
||||
@@ -685,7 +702,9 @@ paths:
|
||||
- "mmm dd, yyyy",
|
||||
- "mmmm dd, yyyy",
|
||||
- "dd mmm, yyyy",
|
||||
- "dd mmmm, yyy".
|
||||
- "dd mmmm, yyy",
|
||||
- "dd/mm/yyyy",
|
||||
- "dd.mm.yyyy".
|
||||
|
||||
9. **textbox**
|
||||
```
|
||||
@@ -710,7 +729,7 @@ paths:
|
||||
```
|
||||
- **default:** Provide a default value for the textbox (Optional).
|
||||
- **hint:** Provide a hint for the textbox (Optional).
|
||||
- **regularexpression:** Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional).
|
||||
- **regularexpression:** A custom regex pattern for validation - for example, /^\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. [help](https://www.w3schools.com/jsref/jsref_obj_regexp.asp) (Optional).
|
||||
- **readonly:** Set to true if you want to set the textbox as readonly. By default, it's false.
|
||||
|
||||
10. **checkbox**
|
||||
@@ -731,6 +750,7 @@ paths:
|
||||
"hidelabel": false,
|
||||
"color": "black",
|
||||
"fontsize": 12,
|
||||
"layout": "vertical",
|
||||
"validation": {
|
||||
"minselections": 0,
|
||||
"maxselections": 0
|
||||
@@ -785,7 +805,8 @@ paths:
|
||||
"values": ["male", "female", "other"],
|
||||
"default": "male",
|
||||
"color": "black",
|
||||
"fontsize": 12
|
||||
"fontsize": 12,
|
||||
"layout": "vertical"
|
||||
}
|
||||
}
|
||||
```
|
||||
@@ -997,7 +1018,7 @@ paths:
|
||||
```
|
||||
- **default:** Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided.
|
||||
- **format:** Specify the date format of your choice from the options below.
|
||||
- "dd/MM/yyyy",
|
||||
- "mm/dd/yyyy",
|
||||
- "dd-mm-yyyy",
|
||||
- "yyyy-mm-dd",
|
||||
- "mm.dd.yyyy",
|
||||
@@ -1005,7 +1026,9 @@ paths:
|
||||
- "mmm dd, yyyy",
|
||||
- "mmmm dd, yyyy",
|
||||
- "dd mmm, yyyy",
|
||||
- "dd mmmm, yyy".
|
||||
- "dd mmmm, yyy",
|
||||
- "dd/mm/yyyy",
|
||||
- "dd.mm.yyyy".
|
||||
|
||||
9. **textbox**
|
||||
```
|
||||
@@ -1030,7 +1053,7 @@ paths:
|
||||
```
|
||||
- **default:** Provide a default value for the textbox (Optional).
|
||||
- **hint:** Provide a hint for the textbox (Optional).
|
||||
- **regularexpression:** Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional).
|
||||
- **regularexpression:** A custom regex pattern for validation - for example, /^\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. [help](https://www.w3schools.com/jsref/jsref_obj_regexp.asp) (Optional).
|
||||
- **readonly:** Set to true if you want to set the textbox as readonly. By default, it's false.
|
||||
|
||||
10. **checkbox**
|
||||
@@ -1051,6 +1074,7 @@ paths:
|
||||
"hidelabel": false,
|
||||
"color": "black",
|
||||
"fontsize": 12,
|
||||
"layout": "vertical",
|
||||
"validation": {
|
||||
"minselections": 0,
|
||||
"maxselections": 0
|
||||
@@ -1105,7 +1129,8 @@ paths:
|
||||
"values": ["male", "female", "other"],
|
||||
"default": "male",
|
||||
"color": "black",
|
||||
"fontsize": 12
|
||||
"fontsize": 12,
|
||||
"layout": "vertical"
|
||||
}
|
||||
}
|
||||
```
|
||||
@@ -1162,7 +1187,7 @@ paths:
|
||||
- Documents
|
||||
summary: Create Document from Template
|
||||
description: |
|
||||
The Create Document 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.
|
||||
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.
|
||||
1. **email**
|
||||
@@ -1227,7 +1252,7 @@ paths:
|
||||
"default": ["option-2"]
|
||||
}
|
||||
```
|
||||
- **default:** You can one or more than one value that need to be selected by default.
|
||||
- **default:** You can have one or more than one value that needs to be selected by default.
|
||||
|
||||
8. **dropdown**
|
||||
```
|
||||
@@ -1238,7 +1263,7 @@ paths:
|
||||
}
|
||||
```
|
||||
|
||||
9. **dropdown**
|
||||
9. **radio button**
|
||||
```
|
||||
{
|
||||
"name": "radio",
|
||||
@@ -1775,7 +1800,7 @@ paths:
|
||||
```
|
||||
- **default:** Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided.
|
||||
- **format:** Specify the date format of your choice from the options below.
|
||||
- "dd/MM/yyyy",
|
||||
- "mm/dd/yyyy",
|
||||
- "dd-mm-yyyy",
|
||||
- "yyyy-mm-dd",
|
||||
- "mm.dd.yyyy",
|
||||
@@ -1783,7 +1808,9 @@ paths:
|
||||
- "mmm dd, yyyy",
|
||||
- "mmmm dd, yyyy",
|
||||
- "dd mmm, yyyy",
|
||||
- "dd mmmm, yyy".
|
||||
- "dd mmmm, yyy",
|
||||
- "dd/mm/yyyy",
|
||||
- "dd.mm.yyyy".
|
||||
|
||||
9. **textbox**
|
||||
```
|
||||
@@ -1808,7 +1835,7 @@ paths:
|
||||
```
|
||||
- **default:** Provide a default value for the textbox (Optional).
|
||||
- **hint:** Provide a hint for the textbox (Optional).
|
||||
- **regularexpression:** Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional).
|
||||
- **regularexpression:** A custom regex pattern for validation - for example, /^\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. [help](https://www.w3schools.com/jsref/jsref_obj_regexp.asp) (Optional).
|
||||
- **readonly:** Set to true if you want to set the textbox as readonly. By default, it's false.
|
||||
|
||||
10. **checkbox**
|
||||
@@ -1829,6 +1856,7 @@ paths:
|
||||
"hidelabel": false,
|
||||
"color": "black",
|
||||
"fontsize": 12,
|
||||
"layout": "vertical",
|
||||
"validation": {
|
||||
"minselections": 0,
|
||||
"maxselections": 0
|
||||
@@ -1883,7 +1911,8 @@ paths:
|
||||
"values": ["male", "female", "other"],
|
||||
"default": "male",
|
||||
"color": "black",
|
||||
"fontsize": 12
|
||||
"fontsize": 12,
|
||||
"layout": "vertical"
|
||||
}
|
||||
}
|
||||
```
|
||||
@@ -2095,7 +2124,7 @@ paths:
|
||||
```
|
||||
- **default:** Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided.
|
||||
- **format:** Specify the date format of your choice from the options below.
|
||||
- "dd/MM/yyyy",
|
||||
- "mm/dd/yyyy",
|
||||
- "dd-mm-yyyy",
|
||||
- "yyyy-mm-dd",
|
||||
- "mm.dd.yyyy",
|
||||
@@ -2103,7 +2132,9 @@ paths:
|
||||
- "mmm dd, yyyy",
|
||||
- "mmmm dd, yyyy",
|
||||
- "dd mmm, yyyy",
|
||||
- "dd mmmm, yyy".
|
||||
- "dd mmmm, yyy",
|
||||
- "dd/mm/yyyy",
|
||||
- "dd.mm.yyyy".
|
||||
|
||||
9. **textbox**
|
||||
```
|
||||
@@ -2128,7 +2159,7 @@ paths:
|
||||
```
|
||||
- **default:** Provide a default value for the textbox (Optional).
|
||||
- **hint:** Provide a hint for the textbox (Optional).
|
||||
- **regularexpression:** Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional).
|
||||
- **regularexpression:** A custom regex pattern for validation - for example, /^\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. [help](https://www.w3schools.com/jsref/jsref_obj_regexp.asp) (Optional).
|
||||
- **readonly:** Set to true if you want to set the textbox as readonly. By default, it's false.
|
||||
|
||||
10. **checkbox**
|
||||
@@ -2149,6 +2180,7 @@ paths:
|
||||
"hidelabel": false,
|
||||
"color": "black",
|
||||
"fontsize": 12,
|
||||
"layout": "vertical",
|
||||
"validation": {
|
||||
"minselections": 0,
|
||||
"maxselections": 0
|
||||
@@ -2203,7 +2235,8 @@ paths:
|
||||
"values": ["male", "female", "other"],
|
||||
"default": "male",
|
||||
"color": "black",
|
||||
"fontsize": 12
|
||||
"fontsize": 12,
|
||||
"layout": "vertical"
|
||||
}
|
||||
}
|
||||
```
|
||||
@@ -2950,6 +2983,12 @@ components:
|
||||
allow_modifications:
|
||||
type: boolean
|
||||
example: false
|
||||
auto_reminder:
|
||||
type: boolean
|
||||
example: false
|
||||
remind_once_in_every:
|
||||
type: number
|
||||
example: 0
|
||||
xml:
|
||||
name: template
|
||||
contact:
|
||||
@@ -3108,6 +3147,19 @@ components:
|
||||
allow_modifications:
|
||||
type: boolean
|
||||
example: false
|
||||
audit_trail:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/documentwithstatus_audit_trail'
|
||||
template_id:
|
||||
type: string
|
||||
example: template_id is only available when the document is created from a template.
|
||||
auto_reminder:
|
||||
type: boolean
|
||||
example: false
|
||||
remind_once_in_every:
|
||||
type: number
|
||||
example: 0
|
||||
xml:
|
||||
name: documentwithstatus
|
||||
document:
|
||||
@@ -3156,6 +3208,17 @@ components:
|
||||
allow_modifications:
|
||||
type: boolean
|
||||
example: false
|
||||
template_id:
|
||||
type: string
|
||||
example: template_id is only available when the document is created from a template.
|
||||
auto_reminder:
|
||||
type: boolean
|
||||
description: "Set to true to enable automatic reminders. Set to false to disable them (default behavior)."
|
||||
example: false
|
||||
remind_once_in_every:
|
||||
type: number
|
||||
description: "Number of days between reminders. This is only applicable when auto_reminder is set to true."
|
||||
example: 0
|
||||
xml:
|
||||
name: document
|
||||
invalidtoken:
|
||||
@@ -3293,12 +3356,12 @@ components:
|
||||
example: true
|
||||
email_subject:
|
||||
type: string
|
||||
description: "Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}."
|
||||
example: ""
|
||||
description: "Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}."
|
||||
example: "{{sender_name}} has requested you to sign {{document_title}}"
|
||||
email_body:
|
||||
type: string
|
||||
description: "Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}."
|
||||
example: ""
|
||||
description: "Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}."
|
||||
example: "<p>Hi {{receiver_name}},</p><p>We hope this email finds you well. <strong>{{sender_name}}</strong> has requested you to review and sign <strong>{{document_title}}</strong>.</p><p>Your signature is crucial to proceed with the next steps as it signifies your agreement and authorization.</p><p><a href='{{signing_url}}'>Sign here</a></p><p>If you have any questions or need further clarification, please contact the sender.</p><p>Thanks,<br>Team OpenSign™</p>"
|
||||
enableTour:
|
||||
type: boolean
|
||||
description: "true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience."
|
||||
@@ -3355,12 +3418,12 @@ components:
|
||||
example: true
|
||||
email_subject:
|
||||
type: string
|
||||
description: "Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}."
|
||||
example: ""
|
||||
description: "Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}."
|
||||
example: "{{sender_name}} has requested you to sign {{document_title}}"
|
||||
email_body:
|
||||
type: string
|
||||
description: "Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}."
|
||||
example: ""
|
||||
description: "Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}."
|
||||
example: "<p>Hi {{receiver_name}},</p><p>We hope this email finds you well. <strong>{{sender_name}}</strong> has requested you to review and sign <strong>{{document_title}}</strong>.</p><p>Your signature is crucial to proceed with the next steps as it signifies your agreement and authorization.</p><p><a href='{{signing_url}}'>Sign here</a></p><p>If you have any questions or need further clarification, please contact the sender.</p><p>Thanks,<br>Team OpenSign™</p>"
|
||||
sendInOrder:
|
||||
type: boolean
|
||||
description: "If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'."
|
||||
@@ -3389,6 +3452,14 @@ components:
|
||||
type: boolean
|
||||
description: "true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value."
|
||||
example: false
|
||||
auto_reminder:
|
||||
type: boolean
|
||||
description: "Set to true to enable automatic reminders. Set to false to disable them (default behavior)."
|
||||
example: false
|
||||
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
|
||||
createdocument_body:
|
||||
required:
|
||||
- file
|
||||
@@ -3430,12 +3501,12 @@ components:
|
||||
example: true
|
||||
email_subject:
|
||||
type: string
|
||||
description: "Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}."
|
||||
example: ""
|
||||
description: "Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}."
|
||||
example: "{{sender_name}} has requested you to sign {{document_title}}"
|
||||
email_body:
|
||||
type: string
|
||||
description: "Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}."
|
||||
example: ""
|
||||
description: "Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}."
|
||||
example: "<p>Hi {{receiver_name}},</p><p>We hope this email finds you well. <strong>{{sender_name}}</strong> has requested you to review and sign <strong>{{document_title}}</strong>.</p><p>Your signature is crucial to proceed with the next steps as it signifies your agreement and authorization.</p><p><a href='{{signing_url}}'>Sign here</a></p><p>If you have any questions or need further clarification, please contact the sender.</p><p>Thanks,<br>Team OpenSign™</p>"
|
||||
sendInOrder:
|
||||
type: boolean
|
||||
description: "If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'."
|
||||
@@ -3464,6 +3535,14 @@ components:
|
||||
type: boolean
|
||||
description: "true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value."
|
||||
example: false
|
||||
auto_reminder:
|
||||
type: boolean
|
||||
description: "Set to true to enable automatic reminders. Set to false to disable them (default behavior)."
|
||||
example: false
|
||||
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
|
||||
inline_response_200_1:
|
||||
type: object
|
||||
properties:
|
||||
@@ -3526,6 +3605,12 @@ components:
|
||||
- signers
|
||||
type: object
|
||||
properties:
|
||||
title:
|
||||
type: string
|
||||
format: string
|
||||
example: New document title
|
||||
description: |
|
||||
An optional parameter specifying the title for the newly created document. If omitted, the template’s title will be used by default.
|
||||
signers:
|
||||
type: array
|
||||
items:
|
||||
@@ -3540,12 +3625,12 @@ components:
|
||||
example: true
|
||||
email_subject:
|
||||
type: string
|
||||
description: "Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}."
|
||||
example: ""
|
||||
description: "Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}."
|
||||
example: "{{sender_name}} has requested you to sign {{document_title}}"
|
||||
email_body:
|
||||
type: string
|
||||
description: "Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}."
|
||||
example: ""
|
||||
description: "Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}."
|
||||
example: "<p>Hi {{receiver_name}},</p><p>We hope this email finds you well. <strong>{{sender_name}}</strong> has requested you to review and sign <strong>{{document_title}}</strong>.</p><p>Your signature is crucial to proceed with the next steps as it signifies your agreement and authorization.</p><p><a href='{{signing_url}}'>Sign here</a></p><p>If you have any questions or need further clarification, please contact the sender.</p><p>Thanks,<br>Team OpenSign™</p>"
|
||||
sendInOrder:
|
||||
type: boolean
|
||||
description: "If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'."
|
||||
@@ -3575,6 +3660,19 @@ components:
|
||||
type: boolean
|
||||
description: "true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value."
|
||||
example: false
|
||||
file:
|
||||
type: string
|
||||
description: You may provide the base64 encoded PDF file to replace the existing one
|
||||
format: base64
|
||||
example: ""
|
||||
auto_reminder:
|
||||
type: boolean
|
||||
description: "Set to true to enable automatic reminders. Set to false to disable them (default behavior)."
|
||||
example: false
|
||||
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
|
||||
revokedocument:
|
||||
type: object
|
||||
properties:
|
||||
@@ -3597,12 +3695,12 @@ components:
|
||||
example: user@example.com
|
||||
email_subject:
|
||||
type: string
|
||||
description: "Custom signature request email subject in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}."
|
||||
example: ""
|
||||
description: "Custom signature request email subject in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}."
|
||||
example: "{{sender_name}} has requested you to sign {{document_title}}"
|
||||
email_body:
|
||||
type: string
|
||||
description: "Custom signature request email body in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}."
|
||||
example: ""
|
||||
description: "Custom signature request email body in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}."
|
||||
example: "<p>Hi {{receiver_name}},</p><p>We hope this email finds you well. <strong>{{sender_name}}</strong> has requested you to review and sign <strong>{{document_title}}</strong>.</p><p>Your signature is crucial to proceed with the next steps as it signifies your agreement and authorization.</p><p><a href='{{signing_url}}'>Sign here</a></p><p>If you have any questions or need further clarification, please contact the sender.</p><p>Thanks,<br>Team OpenSign™</p>"
|
||||
inline_response_404_3:
|
||||
type: object
|
||||
properties:
|
||||
@@ -3639,6 +3737,18 @@ components:
|
||||
type: boolean
|
||||
description: "true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value."
|
||||
example: false
|
||||
redirect_url:
|
||||
type: string
|
||||
description: Specifies the URL where the signer will be redirected upon completing the document signing process.
|
||||
example: ""
|
||||
auto_reminder:
|
||||
type: boolean
|
||||
description: "Set to true to enable automatic reminders. Set to false to disable them (default behavior)."
|
||||
example: false
|
||||
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
|
||||
inline_response_200_3:
|
||||
type: object
|
||||
properties:
|
||||
@@ -3684,7 +3794,7 @@ components:
|
||||
file:
|
||||
type: string
|
||||
format: base64
|
||||
example: base64 encoded file
|
||||
example: base64 encoded pdf
|
||||
title:
|
||||
type: string
|
||||
format: string
|
||||
@@ -3730,6 +3840,14 @@ components:
|
||||
type: boolean
|
||||
description: "true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value."
|
||||
example: false
|
||||
auto_reminder:
|
||||
type: boolean
|
||||
description: "Set to true to enable automatic reminders. Set to false to disable them (default behavior)."
|
||||
example: false
|
||||
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
|
||||
inline_response_draft_200:
|
||||
type: object
|
||||
properties:
|
||||
@@ -3784,6 +3902,23 @@ components:
|
||||
type: boolean
|
||||
description: "true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value."
|
||||
example: false
|
||||
file:
|
||||
type: string
|
||||
description: You may provide the base64 encoded PDF file to replace the existing one
|
||||
format: base64
|
||||
example: ""
|
||||
redirect_url:
|
||||
type: string
|
||||
description: Specifies the URL where the signer will be redirected upon completing the document signing process.
|
||||
example: ""
|
||||
auto_reminder:
|
||||
type: boolean
|
||||
description: "Set to true to enable automatic reminders. Set to false to disable them (default behavior)."
|
||||
example: false
|
||||
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
|
||||
inline_response_404_7:
|
||||
type: object
|
||||
properties:
|
||||
@@ -3989,14 +4124,17 @@ components:
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
description: "Allowed values - signature, stamp."
|
||||
format: string
|
||||
example: signature
|
||||
example: textbox
|
||||
page:
|
||||
type: number
|
||||
format: number
|
||||
example: 1
|
||||
x:
|
||||
type: number
|
||||
format: number
|
||||
example: 244
|
||||
"y":
|
||||
y:
|
||||
type: number
|
||||
format: number
|
||||
example: 71
|
||||
@@ -4008,10 +4146,13 @@ components:
|
||||
type: number
|
||||
format: number
|
||||
example: 46
|
||||
page:
|
||||
type: number
|
||||
format: number
|
||||
example: 1
|
||||
options:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
format: string
|
||||
example: "textbox"
|
||||
inline_response_200_10:
|
||||
type: object
|
||||
properties:
|
||||
@@ -4122,6 +4263,16 @@ components:
|
||||
default:
|
||||
type: string
|
||||
example: my textbox
|
||||
documentwithstatus_audit_trail:
|
||||
type: object
|
||||
properties:
|
||||
email:
|
||||
type: string
|
||||
example: joebee@example.com
|
||||
viewed:
|
||||
$ref: '#/components/schemas/date'
|
||||
signed:
|
||||
$ref: '#/components/schemas/date'
|
||||
securitySchemes:
|
||||
x-api-token:
|
||||
type: apiKey
|
||||
|
||||
@@ -0,0 +1,26 @@
|
||||
# Overview
|
||||
|
||||
OpenSign™ API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures.
|
||||
|
||||
# Key Features
|
||||
|
||||
- **Document Creation**: Allows for the generation of digital documents directly through the API.
|
||||
- **Template Creation**: Supports the creation and management of document templates for consistent use across various applications.
|
||||
- **Electronic Signature Integration**: Provides capabilities for incorporating electronic signatures into documents.
|
||||
- **User Management**: Facilitates the management of user accounts, permissions, and roles within an application.
|
||||
- **Contacts Management**: Enables efficient handling of contact information and integration with document processes.
|
||||
- **Compliance and Security**: Ensures all operations adhere to global legal standards for electronic signatures and data security.
|
||||
- **Customization and Flexibility**: Offers highly customizable workflows, tailored to meet diverse organizational requirements.
|
||||
- **Cross-Platform Compatibility**: Assures seamless functionality across various platforms and devices.
|
||||
|
||||
# Target Audience
|
||||
|
||||
- **Developers and IT Professionals**: Implementing digital document management and electronic signature solutions.
|
||||
- **Businesses and Enterprises**: Seeking efficient and secure digital document workflows.
|
||||
- **Legal and Compliance Teams**: Requiring digital solutions compliant with legal standards for signatures and document management.
|
||||
|
||||
# Usage Scenarios
|
||||
|
||||
- Streamlining contract creation and signing processes in corporate environments.
|
||||
- Managing user permissions and contacts for large-scale document workflows.
|
||||
- Utilizing templates for standardized document processes in legal, financial, and governmental sectors.
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,26 @@
|
||||
# Overview
|
||||
|
||||
OpenSign™ API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures.
|
||||
|
||||
# Key Features
|
||||
|
||||
- **Document Creation**: Allows for the generation of digital documents directly through the API.
|
||||
- **Template Creation**: Supports the creation and management of document templates for consistent use across various applications.
|
||||
- **Electronic Signature Integration**: Provides capabilities for incorporating electronic signatures into documents.
|
||||
- **User Management**: Facilitates the management of user accounts, permissions, and roles within an application.
|
||||
- **Contacts Management**: Enables efficient handling of contact information and integration with document processes.
|
||||
- **Compliance and Security**: Ensures all operations adhere to global legal standards for electronic signatures and data security.
|
||||
- **Customization and Flexibility**: Offers highly customizable workflows, tailored to meet diverse organizational requirements.
|
||||
- **Cross-Platform Compatibility**: Assures seamless functionality across various platforms and devices.
|
||||
|
||||
# Target Audience
|
||||
|
||||
- **Developers and IT Professionals**: Implementing digital document management and electronic signature solutions.
|
||||
- **Businesses and Enterprises**: Seeking efficient and secure digital document workflows.
|
||||
- **Legal and Compliance Teams**: Requiring digital solutions compliant with legal standards for signatures and document management.
|
||||
|
||||
# Usage Scenarios
|
||||
|
||||
- Streamlining contract creation and signing processes in corporate environments.
|
||||
- Managing user permissions and contacts for large-scale document workflows.
|
||||
- Utilizing templates for standardized document processes in legal, financial, and governmental sectors.
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,25 @@
|
||||
### ❓ What is the default maximum file size that can be uploaded to OpenSign?
|
||||
|
||||
- **Self-Hosted Users:** Maximum file size is **80 MB**
|
||||
- **Cloud Users:** Maximum file size is **10 MB**
|
||||
*(Includes an additional +10 MB buffer to prevent signing failures when you add images during signing which increases the file size.)*
|
||||
|
||||
---
|
||||
|
||||
### ❓ Can the file size limit be increased?
|
||||
|
||||
- **Cloud Hosting:** Yes — on request, the limit can be increased **up to 90 MB for enterprise user**
|
||||
- **Self-Hosting:** No — the limit is fixed at **80 MB** and cannot be modified
|
||||
|
||||
> ⚠️ **Note:** There is a hard server-side limit of **100 MB**, which cannot be exceeded.
|
||||
|
||||
---
|
||||
|
||||
### ❓ What happens if a file exceeds the maximum size?
|
||||
|
||||
If a file exceeds the allowed limit:
|
||||
|
||||
- The upload is **rejected**
|
||||
- A **validation error message** is returned to the user
|
||||
|
||||
---
|
||||
@@ -0,0 +1,25 @@
|
||||
### ❓ Who can delete users?
|
||||
|
||||
Only users with the role of **Admin** or **Org Admin** can delete users, with some restrictions outlined below.
|
||||
|
||||
---
|
||||
|
||||
### ❓ What are the conditions for deleting a user?
|
||||
|
||||
1. **Admin Deletion Rules**
|
||||
- An **Admin** can delete **any user** in the system.
|
||||
- An Admin **can delete their account from user profile**.
|
||||
- Before deleting an Admin, ensure **no users are assigned under them**.
|
||||
|
||||
2. **Org Admin Deletion Rules**
|
||||
- An **Org Admin** can delete **any user** within their **own organization**, **except Admins**.
|
||||
- Org Admins **cannot delete themselves Only Admin can delete them**.
|
||||
|
||||
---
|
||||
|
||||
### ❓ What happens if a deletion condition is not met?
|
||||
|
||||
- The deletion will be **blocked**.
|
||||
- A **validation error message** will be shown, explaining the reason (e.g., "Admin has assigned users" or "Cannot delete own account").
|
||||
|
||||
---
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"label": "FAQs",
|
||||
"position": 6,
|
||||
"position": 7,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "FAQs on Utilizing Various Features of OpenSign™ - The World's Leading Free & Open Source Document Signing Platform."
|
||||
|
||||
@@ -0,0 +1,59 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
title: Editing Your Document Before Sending
|
||||
---
|
||||
|
||||
# How to edit a document before sending in OpenSign™?
|
||||
|
||||
OpenSign™ lets you polish your PDF before you send it out—whether you’re signing it yourself, requesting signatures, or saving it as a template. You get four core editing controls right in the preview:
|
||||
|
||||
<img width="918" alt="page controls" src="https://github.com/user-attachments/assets/915951f5-4938-4265-8067-950a35d59b7f" />
|
||||
|
||||
- **Add Pages**
|
||||
In the left-side panel, users will see an **"Add" button**. Clicking it allows users to select and merge new documents into the current one.
|
||||
|
||||
- **Delete Page**
|
||||
An option is available to **delete** any unwanted page from the document.
|
||||
|
||||
- **Reorder Pages**
|
||||
Users can reorder pages by clicking the **"Reorder" button**, which opens a popup displaying all pages. Use the **Up** and **Down** arrows to change the order. Click **Save** to apply the new page order.
|
||||
|
||||
<img width="918" alt="OpenSign_Widgets" src="https://github.com/user-attachments/assets/c700ee21-1696-4768-964f-9ca2792bf13a" />
|
||||
|
||||
- **Zoom In / Zoom Out**
|
||||
Controls are available to **zoom in** or **zoom out** of the document view.
|
||||
|
||||
- **Rotate Page**
|
||||
Options are provided to **rotate pages** in both **clockwise** and **counterclockwise** directions.
|
||||
|
||||
## Prefill widgets
|
||||
|
||||
Simply select the Prefill by Owner option from the right-side panel to view all available prefill widgets. Choose the desired widget and drag it into your document.
|
||||
The Prefill Widgets feature allows document creators to enter specific information in advance before sending a document for signatures. This helps ensure that essential details — such as names, dates, emails, images, checkboxes, radio buttons, or custom text — are already filled in when recipients receive the document. Prefilled data remains locked and cannot be modified by signers.
|
||||
|
||||
<img width="800" alt="Prfill" src="https://github.com/user-attachments/assets/4794b2a9-acc0-4ef8-8110-076f0d90cc57" />
|
||||
|
||||
---
|
||||
|
||||
**🛠️ How It Works**
|
||||
1. **Add Widgets to the Document**
|
||||
- Open the right-side panel, select **Prefill Widgets**, then drag and drop the required widgets (Text, Date, Checkbox, Dropdown, Image, etc.) onto the document.
|
||||
|
||||
2. **Enter Prefill Value**
|
||||
- Provide the default value (e.g., *"Company: OpenSign Labs"*, *Date: 30/09/2025*).
|
||||
- For option-based widgets (Dropdown, Radio, Checkbox), choose the option to be prefilled.
|
||||
|
||||
**📋 Supported Widgets for Prefill**
|
||||
- **Text Field** – Names, job titles, company names, contract IDs
|
||||
- **Date Field** – Default signing date or contract start date
|
||||
- **Dropdown** – Preselect an option
|
||||
- **Radio Button** – Prefill with a selected choice
|
||||
- **Checkbox** – Prefill as checked or unchecked
|
||||
- **Image** – Insert a default image (e.g., logo or stamp)
|
||||
|
||||
## Add Widgets for Signers
|
||||
Select the desired signer from the right-side panel, then drag and drop the widget onto the document.
|
||||
|
||||
📘 Learn more about [adding widgets for signers.](https://docs.opensignlabs.com/docs/help/New-Document/request-signatures/#add-widgets-for-signers)
|
||||
|
||||
|
||||
@@ -1,9 +0,0 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
title: Navigate between pages of a document
|
||||
---
|
||||
|
||||
# How to navigate between pages of a document in OpenSign™?
|
||||
|
||||
To navigate between pages of a document that you have uploaded either click on the 'prev' & 'next' buttons at the top or click on any of the page previews loaded on the left side -
|
||||

|
||||
@@ -14,44 +14,117 @@ The OpenSign™ Request signatures interface is designed to streamline the proce
|
||||
### Step 1: Begin New Document Creation
|
||||
|
||||
- **Navigate to Request Signatures form**: Start by navigating to 'Request Signatures' from the main menu to initiate the creation of a document for signatures.
|
||||
|
||||
<img width="800" alt="request signatures" src="https://github.com/user-attachments/assets/65087c2d-a1e4-4735-8420-759ea97b38aa" />
|
||||
|
||||
### Uploading Your Document
|
||||
|
||||
- **[1] Choose File**: Once the "Request signature" form opens, click "Choose file" button to select and upload the document file from your computer that needs to be signed. Currently you can upload only 1 file at a time but you can add additional documents by clicking "Add pages" in the next step.
|
||||
- **[2] Choose File from Dropbox**: Click the dropbox icon to select the document file from your dropbox account.
|
||||
|
||||
### Entering Document Details And Signers
|
||||
|
||||
- **[3] Title** *(Required)*: Input the title of your document. This identifier will be visible to signers and in your document management.
|
||||
- **[4] Signers**: Use the dropdown to select existing signers or use the addition button to add a new signer who needs to sign the document. (Here, add the signer's details such as name, email, and phone number).
|
||||
- **[5] Note**: Optionally add a note to give context or instructions regarding the document.
|
||||
|
||||
### Organizing Your Document
|
||||
|
||||
- **[6] Folder**: Select a folder where you want the document to be stored, or leave it to default to the 'Root' folder. You can browse your documents in a beautiful explorer view by navigating to "OpenSign™ Drive".
|
||||
|
||||
<img width="800" alt="request signatures" src="https://github.com/user-attachments/assets/94112aec-4581-46a5-8e09-b6fc42e9e72a" />
|
||||
### Set the sending order
|
||||
- **[7] Send in Order**
|
||||
|
||||
### Step 2: Uploading Your Document
|
||||
|
||||
- **[2] Choose File**: Once the "Request signature" page opens, click here to select and upload the document file from your computer that needs to be signed.
|
||||
- **[3] Choose File from Dropbox**: Click the dropbox icon to select the document file from your dropbox account.
|
||||
|
||||
### Step 3: Entering Document Details And Signers
|
||||
|
||||
- **[4] Title** *(Required)*: Input the title of your document. This identifier will be visible to signers and in your document management.
|
||||
- **[5] Signers**: Use the dropdown to select existing signers or use the addition button to add a new signer who needs to sign the document. (Here, add the signer's details such as name, email, and phone number).
|
||||
- **[6] Note**: Optionally add a note to give context or instructions regarding the document.
|
||||
|
||||
### Step 4: Organizing Your Document
|
||||
|
||||
- **[7] Folder**: Select a folder where you want the document to be stored, or leave it to default to the 'Root' folder. You can browse your documents in a beautiful explorer view by navigating to "OpenSign™ Drive".
|
||||
|
||||
### Step 5: Setting the Time Frame
|
||||
|
||||
- **[8] Time To Complete (Days)** *(Required)*: Specify the number of days the signers have to complete the signatures. After that, the document will no longer be available for signing.
|
||||
|
||||
### Step 6: Set the sending order
|
||||
- **[9] Send in Order**
|
||||
- **If you choose:**
|
||||
**If you choose:**
|
||||
- **Yes**: Selecting this option will send the signing request to the first signer initially. Once the first signer completes their part, the next signer in the sequence will receive the request. This process continues until all signers have signed the document. This method ensures that the document is signed in a specific order.
|
||||
- **No**: Selecting this option will send the signing links to all signers simultaneously. Every signer can sign the document at their convenience, regardless of whether other signers have completed their signatures. This method is faster but does not enforce any signing order among the participants.
|
||||
Select the option that best suits the needs of your document processing.
|
||||
### Step 7: Auto reminder (feature only avilable for the subscribed user)
|
||||
- **[10]** Once you enable the auto reminder, a text field will appear allowing you to set the reminder for a specific number of days.
|
||||
- **Remind once in every (Days)**: Here, you can set the number of days for the reminder.
|
||||
|
||||
### Setting the Time Frame
|
||||
- **[8] Time To Complete (Days)** *(Required)*: Specify the number of days the signers have to complete the signatures. After that, the document will no longer be available for signing.
|
||||
|
||||
### Step 8: Proceed to Document Creation Panel
|
||||
### Setting BCC
|
||||
- **[9] BCC**: The BCC (Blind Carbon Copy) feature allows users to receive document completion emails at specified email addresses.
|
||||
You can add multiple contacts in the BCC field to notify several recipients.
|
||||
You can either:
|
||||
Click "Add New" to enter a new email contact, or
|
||||
Select from existing contacts using the dropdown list.
|
||||
|
||||
### Auto reminder
|
||||
- **[10]** Once you enable the auto reminder, a text field will appear allowing you to set the reminder for a specific number of days.
|
||||
- **Remind once in every (Days)**: You can specify the reminder interval in days (e.g., every 1 or every 2 days).
|
||||
Note: You can set a maximum of 15 reminders. For example, if the document completion time is 16 days and you try to schedule a reminder every day, the system will not allow it, as the reminder limit would be exceeded.
|
||||
This feature only available for the paid users.
|
||||
|
||||
### Security Setting
|
||||
- **[11] Enable OTP Verification** :
|
||||
|
||||
- If set to "Yes," the signer will be required to complete email OTP verification before viewing and signing the document.
|
||||
- If "Enable OTP Verification" is set to "No," the signer will not be prompted for OTP verification during the signing process.
|
||||
|
||||
Note: This feature is available exclusively on paid plans.
|
||||
|
||||
### Enable tour:
|
||||
- **[12]** If set to "Yes," the signer will see the tour guide while signing the document. If your signer is familiar with OpenSign and you prefer not to display the tour guide, you can select "No," and the tour guide will not be shown to your signers.
|
||||
|
||||
### Notify on signatures:
|
||||
- **[13]** If set to "Yes," the document owner will receive an email notification each signer completes their signature.
|
||||
Note: This feature is available exclusively on paid plans.
|
||||
|
||||
### allow modifications:
|
||||
- **[14]** If set to Yes, the signer will be allowed to make modifications to the document during the signing process. However, they cannot edit or remove any fields that were already placed by the document owner. They can only add basic fields such as signature, stamp, initials, text, and cells.
|
||||
|
||||
If both Allow Modification and Enable OTP are set to Yes, the signer will still not be able to edit or delete existing fields, but will gain access to additional advanced fields to add during signing. These include: signature, stamp, initials, name, job title, company, text, cells, and email.
|
||||
|
||||
Note: This feature is available exclusively on paid plans.
|
||||
|
||||
### Redirect url:
|
||||
- **[15]** After signing the document and upon its completion, the signer will be redirected to the specified URL.
|
||||
|
||||
### Step 2: Proceed to Document Creation Panel
|
||||
- **Next**: Once all the necessary fields are filled, click this button to proceed to create the document for signing.
|
||||
- **Cancel**: If you need to start over or make changes, click this button to clear the form.
|
||||
### Step 9: Document creation
|
||||
|
||||
### Step 3: Document Creation
|
||||
### Prefill Widgets
|
||||
|
||||
<img width="800" alt="request signatures" src="https://github.com/user-attachments/assets/b4e6f257-e362-46a7-b809-546f0e5999fc" />
|
||||
The **Prefill Widgets** feature lets document creators prefill specific fields before sending a document for signature. This ensures that important details (such as date, name, email, images, checkboxes, radio buttons, or custom text) are already completed when recipients receive the document. By default, prefilled data cannot be edited by signers.
|
||||
|
||||
<img width="800" alt="Prfill" src="https://github.com/user-attachments/assets/4794b2a9-acc0-4ef8-8110-076f0d90cc57" />
|
||||
|
||||
---
|
||||
|
||||
**✨ Key Benefits**
|
||||
- ✅ Save time by auto-filling repetitive information.
|
||||
- ✅ Ensure accuracy for critical fields (e.g., company name, contract number).
|
||||
- ✅ Maintain consistency across multiple signers and templates.
|
||||
- ✅ Reduce signer effort for a smoother signing experience.
|
||||
|
||||
---
|
||||
|
||||
**🛠️ How It Works**
|
||||
1. **Add Widgets to the Document**
|
||||
- Open the right-side panel, select **Prefill Widgets**, then drag and drop the required widgets (Text, Date, Checkbox, Dropdown, Image, etc.) onto the document.
|
||||
|
||||
2. **Enter Prefill Value**
|
||||
- Provide the default value (e.g., *"Company: OpenSign Labs"*, *Date: 30/09/2025*).
|
||||
- For option-based widgets (Dropdown, Radio, Checkbox), choose the option to be prefilled.
|
||||
|
||||
---
|
||||
|
||||
**📋 Supported Widgets for Prefill**
|
||||
- **Text Field** – Names, job titles, company names, contract IDs
|
||||
- **Date Field** – Default signing date or contract start date
|
||||
- **Dropdown** – Preselect an option
|
||||
- **Radio Button** – Prefill with a selected choice
|
||||
- **Checkbox** – Prefill as checked or unchecked
|
||||
- **Image** – Insert a default image (e.g., logo or stamp)
|
||||
|
||||
---
|
||||
|
||||
### Add Widgets for Signers
|
||||
|
||||
<img width="800" alt="request signatures" src="https://github.com/user-attachments/assets/25997f4c-6fbf-4851-b8a8-a803c3343f87" />
|
||||
|
||||
- **[1] Add signature widget**: Once your document is loaded in the document creation panel, you'll need to add a signature widget for each signer. OpenSign provides an intuitive interface for this task. Select the signer from the right side panel, click on the signature widget, and position it where the signature is required.
|
||||
Use the option on the right side to add recipients if you need to include additional signers. You can place multiple signature widgets for each signer, as required.
|
||||
@@ -64,66 +137,165 @@ Use the option on the right side to add recipients if you need to include additi
|
||||
- All pages but first: It will copy the signature widget to all pages except the first page.
|
||||
|
||||
- **[2] Add other widgets**: Depending on your needs, you can include additional widgets such as:
|
||||
- **Stamp**: After placing the Stamp widget, you will see the options on the widget such as:
|
||||
- **Stamp**: The stamp widget allows signers to add a stamp to the document. Signers can upload their stamp during the signing process. After placing the Stamp widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can specify whether this widget is mandatory or optional during the document signing.
|
||||
- Add Signer/Change Signer: Clicking the second option on the stamp widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy Stamp: Clicking on this option reveals the following choices.
|
||||
- All pages : It will copy the stamp widget to all pages.
|
||||
- All pages but last: It will copy the stamp widget to all pages except the last page.
|
||||
- All pages but first: It will copy the stamp widget to all pages except the first page.
|
||||
- **Initials**: After placing the Initials widget, you will see the options on the widget such as:
|
||||
- **Initials**: The initials widget allows signers to add their initials to the document. During the signing process, signers can draw, upload, or type their initials. After placing the Initials widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can specify whether this widget is mandatory or optional during the document signing.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Initials widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy Initials: Clicking on this option reveals the following choices.
|
||||
- All pages : It will copy the stamp widget to all pages.
|
||||
- All pages but last: It will copy the stamp widget to all pages except the last page.
|
||||
- All pages but first: It will copy the stamp widget to all pages except the first page.
|
||||
- **Name**: After placing the name widget, you will see the options on the widget such as:
|
||||
- All pages : It will copy the initials widget to all pages.
|
||||
- All pages but last: It will copy the initials widget to all pages except the last page.
|
||||
- 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 ducplicate the name widget.
|
||||
- **Job title**: After placing the job title widget, you will see the options on the widget such as:
|
||||
- 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 ducplicate the job title widget.
|
||||
- Copy : Clicking on this you can duplicate the job title widget.
|
||||
|
||||
- **Company**: After placing the company widget, you will see the options on the widget such as:
|
||||
- **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 ducplicate the Company widget.
|
||||
- **Date**: 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 ducplicate the date widget.
|
||||
- **Text**: 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 ducplicate the Text widget.
|
||||
- Copy : Clicking on this you can duplicate the Company widget.
|
||||
|
||||
- **Date Widget**
|
||||
|
||||
The **Date widget** allows signers to enter a date while signing the document. Once the widget is placed, you can configure its behavior using the available settings in the **Widget Info** panel.
|
||||
|
||||
#### ⚙️ Widget Options
|
||||
|
||||
- **Date Format**: Choose the preferred date format (for example, `MM/dd/yyyy`, `dd-mm-yyyy`, or `dd/mm/yyyy`) from the Format dropdown. This determines how the date appears to the signer.
|
||||
- **Set Date**: This option allows the user to set a default date, which will be displayed while signing the document.
|
||||
- **Signing Date**: When selected, the date on which the signer signs the document will be automatically displayed in the Date widget.
|
||||
- **Clear**: Removes the selected date setting.
|
||||
|
||||
- **Date Range**
|
||||
- **Min Date**: Sets the earliest date the signer can select.
|
||||
- **Max Date**: Sets the latest date the signer can select.
|
||||
- Use **Clear** to remove the minimum or maximum date restrictions.
|
||||
|
||||
- **Required / Optional**
|
||||
Mark the widget as **Required** if the signer must fill it in before completing the signing, or **Optional** if it is not mandatory.
|
||||
|
||||
- **Font Settings**
|
||||
Customize the **font size** and **text color** to match the document’s style.
|
||||
|
||||
- **Read Only**
|
||||
Enable this option to display a date that cannot be edited by the signer.
|
||||
|
||||
- **Save**
|
||||
Click **Save** to apply all selected settings to the Date widget.
|
||||
|
||||
- **Text Input**: After placing the Text Input 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.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Text Input 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 ducplicate the Text Input widget.
|
||||
- **Checkbox**: Once you drop the checkbox widget, a popup will open where you can set the checkbox name and options. Additionally, there is few optiona available like you can set Minimum check, maximum check also whether this check box is readonly also hide label option.
|
||||
- **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**
|
||||
- Setting the **font size**
|
||||
- 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**
|
||||
- Custom JavaScript validations using regular expressions
|
||||
- For example:
|
||||
- `^\d+$` – allows only digits
|
||||
- `^[A-Z]+$` – allows only uppercase letters
|
||||
|
||||
You can enter your regex pattern in the **Validations** field of the widget.
|
||||
*(Optional reference: [JavaScript RegExp guide](https://www.w3schools.com/jsref/jsref_obj_regexp.asp))*
|
||||
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Text Input 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 Text Input widget.
|
||||
|
||||
- **Cells**
|
||||
The **Cells widget** is ideal for documents that require input in a structured, table-like format, allowing the signer to fill in details within individual cells. After dragging and dropping the widget onto the document, you can adjust the number of cells by moving the **blue marker**.
|
||||
|
||||
<img width="800" alt="Cells widget" src="https://github.com/user-attachments/assets/2a301776-5275-4daf-b361-fd48af2878fc" />
|
||||
|
||||
The widget settings panel provides additional customization options, including:
|
||||
- Manually entering the **number of cells**
|
||||
- Choosing a **font color**
|
||||
- Setting the **font size**
|
||||
- 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**
|
||||
- Custom JavaScript validations using regular expressions
|
||||
|
||||
For example:
|
||||
- `^\d+$` – allows only digits
|
||||
- `^[A-Z]+$` – allows only uppercase letters
|
||||
|
||||
You can enter your regex pattern in the **Validations** field of the widget.
|
||||
*(Optional reference: [JavaScript RegExp guide](https://www.w3schools.com/jsref/jsref_obj_regexp.asp))*
|
||||
|
||||
<img width="800" alt="request signatures" src="https://github.com/user-attachments/assets/dee17fe8-243b-4113-896a-00424d12ea8a" />
|
||||
|
||||
- **Checkbox**: The checkbox widget is used to capture input in the form of a checkbox selection. Once you drop the checkbox widget, a popup will open where you can set the checkbox name and options. Additionally, there are a few options available such as setting the minimum and maximum checks, making the checkbox read-only, and hiding the label.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the CheckBox 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 ducplicate the image widget.
|
||||
- **Dropdown**: Once you drop the dropdown widget, a popup will open where you can set the dropdown name and options. Additionally, there is few option available like you can set default value, also whether this dropdown is required or optional.
|
||||
- Copy : Clicking on this you can duplicate the Checkbox widget.
|
||||
- **Dropdown**: Once you drop the dropdown widget, a popup will open where you can set the dropdown name and options. Additionally, there are a few options available such as setting a default value and marking the dropdown as required or optional.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Dropdown 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 ducplicate the image widget.
|
||||
- **Radio button**: Once you drop the radio button widget, a popup will open where you can set the radio button name and options. Additionally, there is few option available like you can set default value, also whether this radio button is readonly also hide label option.
|
||||
- Copy : Clicking on this you can duplicate the dropdown widget.
|
||||
- **Radio button**: The radio button widget is used to capture input in the form of a radio button selection. Once you drop the radio button widget, a popup will open where you can set the radio button name and options. Additionally, there are a few options available such as setting a default value, making the radio button read-only, and hiding the label.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Radio button 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 ducplicate the image widget.
|
||||
- **Image**: After placing the Image widget, you will see the options on the widget such as:
|
||||
- Copy : Clicking on this you can duplicate the radio button widget.
|
||||
- **Image**: The image widget allows signers to upload an image during the signing process. After placing the Image widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can specify whether this widget is mandatory or optional during the document signing.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Image 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 ducplicate the image widget.
|
||||
- **Email**: After placing the email widget, you will see the options on the widget such as:
|
||||
- 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.
|
||||
### Step 10: Next:
|
||||
### 📄 Document Page Controls
|
||||
- **Navigating Between Pages in OpenSign™**
|
||||
To navigate between pages of a document that you have uploaded either click on the previous page ∧ & V next page buttons at the top or click on any of the page previews loaded on the left side.
|
||||
|
||||
<img width="918" alt="OpenSign Page controls" src="https://github.com/user-attachments/assets/c577e165-f8ac-45c7-bc6f-d499c710a7ed" />
|
||||
|
||||
- **Add Pages**
|
||||
In the left-side panel, users will see an **"Add" button**. Clicking it allows users to select and merge new documents into the current one.
|
||||
|
||||
- **Delete Page**
|
||||
An option is available to **delete** any unwanted page from the document.
|
||||
|
||||
- **Reorder Pages**
|
||||
Users can reorder pages by clicking the **"Reorder" button**, which opens a popup displaying all pages. Use the **Up** and **Down** arrows to change the order. Click **Save** to apply the new page order.
|
||||
|
||||
- **Zoom In / Zoom Out**
|
||||
Controls are available to **zoom in** or **zoom out** of the document view.
|
||||
|
||||
- **Rotate Page**
|
||||
Options are provided to **rotate pages** in both **clockwise** and **counterclockwise** directions.
|
||||
|
||||
### Step 4: Next:
|
||||
- **Next**: After adding the widgets and signatures, click the 'Next' button. The document will then be created.
|
||||
|
||||
### Step 11: Send Mail
|
||||
### Step 5: Send Mail
|
||||
After finishing the document creation, a 'Send Mail' popup will appear, offering options to Send Email, Customize Email, Copy Link, or Share the document.
|
||||
- Send Email: Click the 'Send' button to send the document for signing to all signers. If the sending order is set to 'Yes', it will send the document to the first signer.
|
||||
|
||||
@@ -136,7 +308,7 @@ After finishing the document creation, a 'Send Mail' popup will appear, offering
|
||||
<img width="800" alt="request signatures" src="https://github.com/user-attachments/assets/e2344479-daae-43ff-a61a-14ea98b237d6" />
|
||||
|
||||
## Signers Signing Process
|
||||
### Step 12: Email OTP verification
|
||||
### Step 6: Email OTP verification
|
||||
Once the email is received, the signer can click the 'Sign Here' button. This will open the email verification page. After clicking the 'Get Verification Code' button, an OTP (one-time password) will be sent to the signer’s email address. Enter the received OTP into the verification textbox and click the 'Verify' button.
|
||||
|
||||
<div>
|
||||
@@ -146,7 +318,7 @@ Once the email is received, the signer can click the 'Sign Here' button. This wi
|
||||
<img width="800" alt="OpenSign verify otp" src="https://github.com/user-attachments/assets/63cf4b75-9d47-4630-a83c-e916a5c13b3c" />
|
||||
</div>
|
||||
|
||||
### Step 13: Finalizing the Process:
|
||||
### Step 7: Finalizing the Process:
|
||||
|
||||
After verification, the signer will be redirected to the document signing page, where he can view the document received for signing. To sign, the signer simply clicks on the signature widget, which allows them to draw, upload a digitally scanned signature, or type the signature.
|
||||
|
||||
|
||||
@@ -17,7 +17,7 @@ After login, you will be directed to the OpenSign dashboard. From the left-side
|
||||
- **[1] Choose File**: Once the "Sign Yourself" page opens, click here to upload the document you want to sign from your computer.
|
||||
- **[2] Upload from Dropbox**: To upload a document directly from your Dropbox account, click the Dropbox icon. You may need to provide permissions to access the file when you do it for the first time.
|
||||
|
||||
```The maximum document size allowed is 20MB.```
|
||||
```The maximum document size allowed is 10MB.```
|
||||
|
||||
### Step 2: Document Information
|
||||
|
||||
@@ -33,6 +33,9 @@ After login, you will be directed to the OpenSign dashboard. From the left-side
|
||||
- **[3] Next**: After filling in all the required fields, click the "Next" button to proceed to the document creation panel.
|
||||
|
||||
### Step 4: Document creation and Signing
|
||||
|
||||
<img width="918" alt="sign yourself" src="https://github.com/user-attachments/assets/b0475066-d3e3-4c67-a242-08704e2d11ba" />
|
||||
|
||||
- **[1] Add signature widget**: Once your document is loaded in the document creation panel, you will need to add a signature widget. OpenSign provides an intuitive interface for this task. Click on the signature widget and position it where the signature is required. You can add multiple signature widgets if needed.
|
||||
After placing the Signature widget, a popup will appear for drawing the signature.
|
||||
In the "Draw Signature" popup, you have three options available:
|
||||
@@ -59,11 +62,36 @@ In the "Draw Signature" popup, you have three options available:
|
||||
- **Company**: Once you drop the company widget, you can edit the company name. Customization options such as setting the color or font are also provided. Additionally, there is a copy option available to duplicate the widget.
|
||||
- **Date** : Once you drop the date widget, you can choose from various date formats.
|
||||
- **Text**: Once you drop the text widget, you can write the text. Customization options such as setting the color or font are also provided. Additionally, there is a copy option available to duplicate the widget.
|
||||
- **Cells**: The Cells widget is ideal for documents that require input in a structured, table-like format, allowing the signer to fill in details within individual cells. After dragging and dropping the widget onto the document, a popup will appear allowing you to adjust the number of cells by moving the blue marker. This adjustment option is also available directly on the widget after it's placed. Additionally, the widget settings panel provides options to manually enter the number of cells, choose a color, and set the font size.
|
||||
|
||||
<img width="918" alt="cells widget" src="https://github.com/user-attachments/assets/7d124e00-2d7a-4045-9584-1397a84a882d" />
|
||||
|
||||
- **Checkbox**: After dropping the checkbox widget, a popup will open allowing you to set the checkbox name and options. Once you click save, the checkbox will be created on the document. Additionally, a copy option will be available to duplicate the widget.
|
||||
- **Image** : After dragging and dropping the image widget, the "Upload Image" popup will appear, allowing you to upload an image from your file explorer. Once the image is uploaded, it will be displayed on the document. Additionally, there is an option to duplicate the image.
|
||||
- **Email**: Once you drop the email widget, you can edit the email. Customization options such as setting the color or font are also provided. Additionally, there is a copy option available to duplicate the widget.
|
||||
|
||||
<img width="918" alt="OpenSign_Widgets" src="https://github.com/user-attachments/assets/b73ef535-245c-43c8-98eb-cb43e4720bc5" />
|
||||
### 📄 Document Page Controls
|
||||
- **Navigating Between Pages in OpenSign™**
|
||||
To navigate between pages of a document that you have uploaded either click on the previous page ∧ & V next page buttons at the top or click on any of the page previews loaded on the left side.
|
||||
|
||||
<img width="918" alt="OpenSign Page controls" src="https://github.com/user-attachments/assets/f0353d1a-c4ad-4d7c-af6b-2a5a368fad30" />
|
||||
|
||||
- **Add Pages**
|
||||
In the left-side panel, users will see an **"Add" button**. Clicking it allows users to select and merge new documents into the current one.
|
||||
|
||||
- **Delete Page**
|
||||
An option is available to **delete** any unwanted page from the document.
|
||||
|
||||
- **Reorder Pages**
|
||||
Users can reorder pages by clicking the **"Reorder" button**, which opens a popup displaying all pages. Use the **Up** and **Down** arrows to change the order. Click **Save** to apply the new page order.
|
||||
|
||||
- **Zoom In / Zoom Out**
|
||||
Controls are available to **zoom in** or **zoom out** of the document view.
|
||||
|
||||
- **Rotate Page**
|
||||
Options are provided to **rotate pages** in both **clockwise** and **counterclockwise** directions.
|
||||
|
||||
---
|
||||
|
||||
### Step 5: Finalizing the Process:
|
||||
- **Finish**: After adding the widgets and signatures, click the "Finish" button. This will create a digitally signed document.
|
||||
|
||||
@@ -0,0 +1,129 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
title: Widgets in OpenSign
|
||||
---
|
||||
|
||||
# 🧩 Understanding the Number Widget
|
||||
|
||||
Widgets in **OpenSign** are interactive fields that you can place on your documents to collect information, signatures, or confirmations from recipients during the signing process.
|
||||
|
||||
They make your documents dynamic — allowing signers to fill in details like names, dates, numbers, checkboxes, or digital signatures directly within the document.
|
||||
|
||||
**Widgets help you:**
|
||||
- Create fillable and interactive documents
|
||||
- Control the type of input signers can provide (text, date, number, etc.)
|
||||
- Ensure data consistency and validation
|
||||
- Streamline form completion and signing workflows
|
||||
|
||||
OpenSign offers various widget types such as **Signature**, **Initial**, **Text**, **Date**, **Checkbox**, **Stamp**, and the newly added **Number Widget** — each designed for specific use cases.
|
||||
|
||||
---
|
||||
|
||||
# 🧮 Number Widget
|
||||
|
||||
The **Number Widget** in **OpenSign** lets you collect numeric input from signers within your document.
|
||||
It can also perform **dynamic calculations** using values from other number widgets.
|
||||
|
||||
This widget ensures that only **numbers** are entered, helping maintain data accuracy and consistency across signed documents.
|
||||
|
||||
---
|
||||
|
||||
## 🔹 Purpose
|
||||
|
||||
Use the **Number Widget** when you need signers to input strictly numeric data during the signing process.
|
||||
It’s ideal for:
|
||||
|
||||
- Numeric IDs (e.g., Employee ID, Order Number)
|
||||
- Amounts or currency values
|
||||
- Quantity or item counts
|
||||
- Zip/Postal codes
|
||||
|
||||
---
|
||||
|
||||
## 🧭 How to Add a Number Widget
|
||||
|
||||
1. Upload the document and open the Create Document panel.
|
||||
2. From the **Widget Toolbar**, select **“Number”**.
|
||||
3. Click anywhere on the document where you want the number field to appear.
|
||||
4. Adjust its size and position as needed.
|
||||
5. Assign the widget to a **signer** (if the document has multiple signers).
|
||||
|
||||
---
|
||||
|
||||
## ⚙️ Widget Properties
|
||||
|
||||
You can configure the following options for the **Number Widget**:
|
||||
|
||||
| **Property** | **Description** |
|
||||
|---------------|-----------------|
|
||||
| **Name** | A unique identifier for this number widget. <br/>• Example: `number-1`, `number-2` <br/>• Must be unique within the document. <br/>• Used in formulas as `{{number-1}}`. <br/>🔸 *If you include a number widget in a formula, its name must be unique, since formulas rely on these identifiers.* |
|
||||
| **Default Value** | (Optional) Sets an initial numeric value for the widget. This value appears automatically unless changed by the signer or overridden by a formula. |
|
||||
| **Formula** | Defines a calculation using other number widgets.|
|
||||
| **Required / Optional** | Specifies whether the signer must complete the field before submission. |
|
||||
| **Placeholder** | Displays hint text before input (e.g., *12345*). |
|
||||
| **Font Size** | Controls the font size of the number displayed on the document. |
|
||||
| **Color** | Sets the font color for the number field. |
|
||||
|
||||
---
|
||||
|
||||
## ✍️ Signer Experience
|
||||
|
||||
When the document is opened for signing:
|
||||
|
||||
- The signer will see a **numeric input box** at the widget’s location.
|
||||
- Only **digits (0–9)** can be entered.
|
||||
- If marked as **Required**, the signer cannot finish signing without entering a number.
|
||||
- The entered value appears in the final signed PDF.
|
||||
|
||||
---
|
||||
|
||||
## 🔢 Using Formulas in the Number Field
|
||||
|
||||
You can use number widgets to perform **arithmetic and algebraic calculations** inside the **Formula** field.
|
||||
Assume you have four number widgets named:
|
||||
`number-1`, `number-2`, `number-3`, and `number-4`.
|
||||
|
||||
---
|
||||
|
||||
### 🧩 Basic Formulas
|
||||
|
||||
| **Formula** | **Description** | **Example Result** |
|
||||
|--------------|-----------------|--------------------|
|
||||
| `{{number-1}} + {{number-2}}` | Adds two numbers | 10 + 5 = **15** |
|
||||
| `{{number-1}} - {{number-3}}` | Subtracts one number from another | 20 - 4 = **16** |
|
||||
| `{{number-1}} * {{number-2}}` | Multiplies two numbers | 6 * 3 = **18** |
|
||||
| `{{number-1}} / {{number-2}}` | Divides one number by another | 25 / 5 = **5** |
|
||||
| `({{number-1}} + {{number-2}}) * {{number-3}}` | Groups values using parentheses | (4 + 6) * 2 = **20** |
|
||||
| `{{number-1}} + {{number-2}} - ({{number-3}} * {{number-4}})` | Combines multiple operations | 10 + 8 - (2 * 3) = **12** |
|
||||
|
||||
---
|
||||
|
||||
### 🧮 Advanced Formulas
|
||||
|
||||
| **Formula** | **Description** | **Example Result** |
|
||||
|--------------|-----------------|--------------------|
|
||||
| `({{number-1}} + {{number-2}} + {{number-3}}) / 3` | Calculates the average of three widgets | (10 + 20 + 30) / 3 = **20** |
|
||||
| `({{number-1}} * {{number-2}}) + ({{number-3}} / {{number-4}})` | Combines multiplication and division | (5 * 6) + (8 / 4) = 30 + 2 = **32** |
|
||||
| `({{number-1}} + {{number-2}}) * ({{number-3}} - {{number-4}})` | Multiplies a sum by a difference | (10 + 5) * (6 - 2) = 15 * 4 = **60** |
|
||||
| `({{number-1}} * {{number-2}} * {{number-3}}) / {{number-4}}` | Calculates a scaled ratio | (2 * 3 * 4) / 2 = 24 / 2 = **12** |
|
||||
| `({{number-1}} + {{number-2}} + {{number-3}} + {{number-4}}) / 4` | Finds the average of four widgets | (8 + 10 + 12 + 14) / 4 = **11** |
|
||||
| `{{number-1}} * ({{number-2}} + {{number-3}} - {{number-4}})` | Weighted total | 5 * (10 + 4 - 2) = 5 * 12 = **60** |
|
||||
| `({{number-1}} * {{number-2}} + {{number-3}}) * {{number-4}}` | Compound operation using addition and multiplication | (3 * 4 + 2) * 5 = (12 + 2) * 5 = **70** |
|
||||
|
||||
---
|
||||
|
||||
## 🧠 Tips
|
||||
|
||||
- Use **parentheses `( )`** to control calculation order.
|
||||
- Formulas follow **standard arithmetic precedence** (multiplication/division before addition/subtraction).
|
||||
- Only **number widgets (`{{number-x}}`)** can be used in formulas.
|
||||
- Non-numeric fields (like text or date) are **not supported** in formula expressions.
|
||||
- Ensure all widget names used in formulas exist in the same document.
|
||||
|
||||
---
|
||||
|
||||
## 📩 Need Help?
|
||||
|
||||
If you need further assistance, contact our support team at **support@opensignlabs.com**.
|
||||
|
||||
Happy Signing with **OpenSign™**!
|
||||
@@ -10,7 +10,7 @@ OpenSign Drive offers a streamlined way to manage, sign, and request signatures
|
||||
### 1. Accessing OpenSign Drive
|
||||
After logging into OpenSign, navigate to the left-hand sidebar and click on "OpenSign Drive." This will open the OpenSign Drive page where you can see all your stored files.
|
||||
|
||||
<img width="828" alt="OpenSign drive" src="https://github.com/user-attachments/assets/1159afaa-e7e4-4f6d-9087-e22ea7a0c840" />
|
||||
<img width="828" alt="OpenSign drive" src="https://github.com/user-attachments/assets/365cce22-899a-4162-a7a0-41a7b49504a3" />
|
||||
|
||||
### 2. Creating a New Folder
|
||||
Organizing your documents into folders helps you keep track of different categories of files.
|
||||
@@ -20,7 +20,7 @@ Organizing your documents into folders helps you keep track of different categor
|
||||
**Step 3:** A dialog box will prompt you to name your new folder. Enter a descriptive name and hit "Add."
|
||||
**Step 4:** Your new folder will appear in the main area of OpenSign Drive, ready to store your documents.
|
||||
|
||||
<img width="828" alt="Create new folder" src="https://github.com/user-attachments/assets/f0260329-d3b0-4c03-af1b-7231b4f2c6a4" />
|
||||
<img width="828" alt="Create new folder" src="https://github.com/user-attachments/assets/73dfb391-c184-45f6-8f06-e716ced258c0" />
|
||||
|
||||
### 3. Creating a New Document
|
||||
To create a document for self-signing or by requesting a signature, you can do so by selecting the appropriate option from OpenSign Drive.
|
||||
@@ -29,7 +29,7 @@ To create a document for self-signing or by requesting a signature, you can do s
|
||||
**Step 2:** This time, choose "Sign Yourself" or "Request Signatures" depending on whether you want to sign the document yourself or send it to others for their signatures.
|
||||
**Step 3:** When you select the "Sign Yourself" or "Request Signature" option, the document creation page will open, allowing you to enter details such as the document title, description, notes, and other necessary information. You can also choose an OpenSign Drive folder to store your document. Once you’ve selected the folder and created the document, it will be saved in that folder, making it easily accessible from your OpenSign Drive.
|
||||
|
||||
<img width="828" alt="Create new document" src="https://github.com/user-attachments/assets/97bd75ec-ea9d-4f1d-b514-b9e04ce856aa" />
|
||||
<img width="828" alt="Create new document" src="https://github.com/user-attachments/assets/8987b111-4fd3-4bbd-b8cb-32ee7959f05e" />
|
||||
|
||||
### 4. Organizing Documents
|
||||
After creating or uploading documents, it's crucial to organize them effectively. Here are some options available in OpenSign Drive for managing your documents:
|
||||
@@ -60,12 +60,12 @@ These indicators are represented by different icons on your documents, allowing
|
||||
- **Declined document (Red Exclamation Mark):** This icon highlights documents that require immediate action, indicating that the document has been declined.
|
||||
- **Expired (Gray Hourglass):** A gray hourglass indicates that the document is expired.
|
||||
|
||||
<img width="828" alt="Create new folder" src="https://github.com/user-attachments/assets/b488ef24-3db5-4323-a3b3-ed3c12a04291" />
|
||||
<img width="828" alt="Create new folder" src="https://github.com/user-attachments/assets/e56c01f8-2e9e-4acc-bd04-52a323303820" />
|
||||
|
||||
### 6. Filter and Sort Documents in OpenSign Drive
|
||||
OpenSign Drive provides a powerful and easy-to-use interface for managing your documents. To help you quickly find and organize your files, OpenSign Drive offers several sorting and filtering options, allowing you to arrange your documents by name or date, in either ascending or descending order.
|
||||
|
||||
<img width="861" alt="OpenSign filters" src="https://github.com/user-attachments/assets/af51e68a-730c-4203-8015-54b30da572f6" />
|
||||
<img width="861" alt="OpenSign filters" src="https://github.com/user-attachments/assets/1171d581-cb28-47bb-a5c9-632b6b458155" />
|
||||
|
||||
- **Sorting Documents by Name:**
|
||||
To sort your documents alphabetically:
|
||||
@@ -87,6 +87,17 @@ If you prefer to sort your documents based on when they were created or modified
|
||||
|
||||
These sorting features help you keep your documents organized, making it easier to locate specific files quickly, especially when you have a large number of documents stored in your OpenSign Drive.
|
||||
|
||||
### 7. Connect to google drive
|
||||
OpenSign provides the feature to store your signed and completed documents in your own Google Drive.
|
||||
- To use this feature, click the Drive icon located in the top-right corner. A popup will appear displaying the "Connect to Google Drive" button.
|
||||
- Click the button, then log in to your Gmail account and grant the necessary permissions. Once authorized, your OpenSign account will be connected to your Google Drive.
|
||||
|
||||
<img width="828" alt="Connect to gdrive" src="https://github.com/user-attachments/assets/66c1ca6a-40cb-4da9-90d3-b3880dfc8726" />
|
||||
|
||||
- After completing your first document, a folder named OpenSign™ will be created in your Google Drive. Your completed documents will be stored inside this folder.
|
||||
|
||||
<img width="828" alt="Gdrive opensign folder" src="https://github.com/user-attachments/assets/5248c443-682c-46d4-a9bc-cc09ef718c89" />
|
||||
|
||||
If you require more help, feel free to reach out to our customer support on support@opensignlabs.com.
|
||||
|
||||
Happy signing with OpenSign™!
|
||||
|
||||
@@ -3,7 +3,8 @@
|
||||
## Overview
|
||||
|
||||
This documentation provides an overview of the OpenSign™ Drive interface, detailing its key features, user interface elements and functionality.
|
||||

|
||||
|
||||
<img width="918" alt="OpenSign_Widgets" src="https://github.com/user-attachments/assets/625dac8f-7357-4f7e-9ab4-33c9f6732533" />
|
||||
|
||||
### Interface Elements
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
The OpenSign™ Drive interface allows users to rename their documents efficiently.
|
||||
|
||||

|
||||
<img width="918" alt="Rename folder" src="https://github.com/user-attachments/assets/0dfddc33-1724-4712-9335-f141247ffda4" />
|
||||
|
||||
## Overview of User Interface
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"label": "Reports",
|
||||
"label": "Documents",
|
||||
"position": 2,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
|
||||
@@ -12,14 +12,14 @@ The "Completed documents" report within OpenSign serves as a vital tool for mana
|
||||
### Navigating to the Completed documents report
|
||||
|
||||
1. Once logged into OpenSign, you'll see a navigation panel on the left side of your screen.
|
||||
2. Click on **"Reports"** to expand the available options.
|
||||
2. Click on **"Documents"** to expand the available options.
|
||||
3. Select **"Completed"** to view the list of documents that have been fully signed and processed.
|
||||
|
||||
### Understanding the Completed documents report
|
||||
|
||||
The "Completed documents" report is displayed in a tabular format, presenting key information about each finalized document. Below is a breakdown of each column and its purpose:
|
||||
|
||||
<img width="816" alt="OpenSign_Signyourself" src="https://github.com/user-attachments/assets/4694c9b3-ca2c-4f27-a9d9-8dca220a4124" />
|
||||
<img width="816" alt="OpenSign_Signyourself" src="https://github.com/user-attachments/assets/608ebc3c-e32b-4a2f-bc58-3c1b60108741" />
|
||||
|
||||
- **Sr.No:** This column displays the serial number for each document in the list, helping you quickly identify and reference documents.
|
||||
|
||||
@@ -43,6 +43,24 @@ The "Completed documents" report also includes several actions icons for each do
|
||||
|
||||
- **Delete Document:** The trash bin icon enables you to permanently delete a document from your completed list. Be cautious, as this action cannot be undone.
|
||||
|
||||
<img width="816" alt="OpenSign_Signyourself" src="https://github.com/user-attachments/assets/a83aa2b8-f4c9-4f42-b5be-ff2b9297ab40" />
|
||||
|
||||
- **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.
|
||||
|
||||
If you require more help, feel free to reach out to our customer support on support@opensignlabs.com.
|
||||
|
||||
Happy signing with OpenSign™!
|
||||
|
||||
@@ -13,9 +13,9 @@ To view your Contactbook:
|
||||
|
||||
1. Log in to your OpenSign account.
|
||||
2. Navigate to the left sidebar.
|
||||
3. Click on the `Contactbook` link under the reports section.
|
||||
|
||||
<img width="828" alt="Add contact" src="https://github.com/user-attachments/assets/80308df4-33a8-41ee-a240-801f775dcec0" />
|
||||
3. Click on the `Contactbook` link under the Documents section.
|
||||
|
||||
<img width="828" alt="Add contact" src="https://github.com/user-attachments/assets/7c42e4cd-8832-45fe-a714-a6c5fd3be986" />
|
||||
|
||||
## Understanding the Contactbook report
|
||||
### Adding a New Contact:
|
||||
@@ -29,10 +29,17 @@ The Contactbook page displays a list of contacts with the following columns:
|
||||
- **Name**: The contact's name.
|
||||
- **Email**: The contact’s email address.
|
||||
- **Phone**: The contact’s phone number (if available).
|
||||
|
||||
<img width="828" alt="contactbook" src="https://github.com/user-attachments/assets/524a7aa7-594e-412a-ad50-caebc125c1db" />
|
||||
|
||||
### Import contacts:
|
||||
OpenSign provides the feature to import contacts in bulk using an Excel or CSV file.
|
||||
Click the Import button located at the top-right corner. A popup will appear allowing you to upload your file. You can also download a sample file, add your contacts to it, and then upload it.
|
||||
Once imported, the contacts will be added to your list. Duplicate entries—based on email ID—will be skipped automatically.
|
||||
|
||||
<img width="828" alt="Improt contacts" src="https://github.com/user-attachments/assets/94edbbe8-3e03-4396-8ad7-37cf276873f5" />
|
||||
|
||||
### Action buttons
|
||||
|
||||
- **Edit**: To edit a contact, click the pencil icon next to the contact’s details. This will allow you to modify and update the contact information.
|
||||
-
|
||||
- **Delete**: To delete a contact, click on the trash icon located next to the contact’s details. This will remove the contact from your Contactbook. A confirmation prompt may appear to prevent accidental deletions.
|
||||
|
||||
|
||||
@@ -9,14 +9,14 @@ The "Declined documents" report within OpenSign serves as a vital tool for manag
|
||||
### Navigating to the Declined documents report
|
||||
|
||||
1. Once logged into OpenSign, you'll see a navigation panel on the left side of your screen.
|
||||
2. Click on **"Reports"** to expand the available options.
|
||||
2. Click on **"Documents"** to expand the available options.
|
||||
3. Select **"Declined"** to view the list of documents that have been fully signed and processed.
|
||||
|
||||
### Understanding the Declined documents report
|
||||
|
||||
The "Declined documents" report is displayed in a tabular format, presenting key information about each finalized document. Below is a breakdown of each column and its purpose:
|
||||
|
||||
<img width="816" alt="OpenSign_Signyourself" src="https://github.com/user-attachments/assets/dc55e678-52c0-4e75-a1d5-b5a94690bc33" />
|
||||
<img width="816" alt="OpenSign_Signyourself" src="https://github.com/user-attachments/assets/5aa4ffc6-e1aa-40c5-b6c2-3542f4611d8d" />
|
||||
|
||||
- **Sr.No:** This column displays the serial number for each document in the list, helping you quickly identify and reference documents.
|
||||
|
||||
@@ -38,6 +38,10 @@ The "Declined documents" report also includes several action icons for each docu
|
||||
|
||||
- **View Document:** The eye icon allows you to preview the document directly within OpenSign without needing to download it.
|
||||
- **Delete Document:** The trash bin icon enables you to permanently delete a document from your declined list. Be cautious, as this action cannot be undone.
|
||||
- **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.
|
||||
|
||||
- **Fix and resend:** This option allows the user to recreate a document that was previously declined.
|
||||
It is useful when the declined document has missing or incorrect information. Instead of creating a new one from scratch, the user can make the necessary edits and resend it for signature.
|
||||
|
||||
If you require more help, feel free to reach out to our customer support on support@opensignlabs.com.
|
||||
|
||||
|
||||
@@ -9,14 +9,14 @@ The Draft documents section in OpenSign helps you manage all your in-progress do
|
||||
### Navigating to the Draft documents report
|
||||
|
||||
1. Once logged into OpenSign, you'll see a navigation panel on the left side of your screen.
|
||||
2. Click on **"Reports"** to expand the available options.
|
||||
2. Click on **"Documents"** to expand the available options.
|
||||
3. Select **"Drafts"** under the Reports section. This will display all your saved draft documents.
|
||||
|
||||
### Understanding the Draft documents report
|
||||
|
||||
The Draft documents section provides an organized list of all documents that are saved as drafts. Each draft entry contains key details that help you quickly identify and manage your documents. Here’s a breakdown of the information available:
|
||||
|
||||
<img width="816" alt="Draft documents" src="https://github.com/user-attachments/assets/6f743287-6459-4e93-ad7d-064c1ed68da0" />
|
||||
<img width="816" alt="Draft documents" src="https://github.com/user-attachments/assets/03c1895f-c0c3-40a6-bb56-6b36bfe3b9f5" />
|
||||
|
||||
- **Sr.No:** This column displays the serial number for each document in the list, helping you quickly identify and reference documents.
|
||||
|
||||
@@ -39,7 +39,9 @@ The "Draft documents" report also includes several actions icons for each docume
|
||||
- **Edit:** If you need to make changes to your draft, click the edit (pencil) icon. This will open the document for you to make the necessary modifications before sending it for signatures.
|
||||
|
||||
- **Delete:** If a draft is no longer needed, click the trash icon to delete it. Be cautious when using this action as deleted drafts cannot be recovered.
|
||||
|
||||
|
||||
- **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.
|
||||
|
||||
If you require more help, feel free to reach out to our customer support on support@opensignlabs.com.
|
||||
|
||||
Happy signing with OpenSign™!
|
||||
|
||||
@@ -13,7 +13,7 @@ To view your expired documents:
|
||||
|
||||
1. Log in to your OpenSign account.
|
||||
2. Navigate to the left sidebar.
|
||||
3. Click on the `Expired` link under the Reports section.
|
||||
3. Click on the `Expired` link under the **Documents** section.
|
||||
|
||||
<img width="828" alt="Expired document" src="https://github.com/user-attachments/assets/01f3626f-d694-4d3b-82da-2f2b77693b76" />
|
||||
|
||||
@@ -32,9 +32,13 @@ The Expired documents report displays a list of documents that have not been sig
|
||||
|
||||
For each expired document, you can perform several actions:
|
||||
|
||||
<img width="828" alt="Expired document" src="https://github.com/user-attachments/assets/ca2a4185-6623-4ad9-838b-f18012878c9e" />
|
||||
|
||||
- **Delete**: Deletes the document from your OpenSign account.
|
||||
- **View**: Opens the document in a viewer within OpenSign, allowing you to review the details and contents of the document.
|
||||
|
||||
- **Extend expiry date**: This option allows the user to extend the document's expiration date, keeping it available for signing.
|
||||
- **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.
|
||||
|
||||
## Managing Expired documents
|
||||
|
||||
Managing your expired documents effectively can help ensure that no important document is overlooked. Consider the following tips:
|
||||
|
||||
@@ -8,16 +8,14 @@ The In-Progress documents report in OpenSign helps you monitor and manage docume
|
||||
### Navigating to the In-Progress documents report
|
||||
|
||||
1. Once logged into OpenSign, you'll see a navigation panel on the left side of your screen.
|
||||
2. Click on **"Reports"** to expand the available options.
|
||||
2. Click on **"Documents"** to expand the available options.
|
||||
3. Select **"In progress"** This will display all documents that are currently awaiting signatures or are otherwise in the signing process.
|
||||
|
||||
### Understanding the In-Progress documents report
|
||||
|
||||
The "In progress documents" report is displayed in a tabular format, presenting key information about each finalized document. Below is a breakdown of each column and its purpose:
|
||||
|
||||
<img width="816" alt="Inprogress documents" src="https://github.com/user-attachments/assets/60100998-1412-4331-8842-55fd9dd10307" />
|
||||
|
||||
- **Sr.No:** This column displays the serial number for each document in the list, helping you quickly identify and reference documents.
|
||||
<img width="816" alt="Inprogress documents" src="https://github.com/user-attachments/assets/d0ead0ca-0c13-4d94-bab5-1fe58118001a" />
|
||||
|
||||
- **Title:** The "Title" column displays the name of the document.
|
||||
|
||||
@@ -28,9 +26,8 @@ The "In progress documents" report is displayed in a tabular format, presenting
|
||||
- **File:** Here, you will find a **"Download"** link that allows you to directly download the In-progress document to your local device for review.
|
||||
|
||||
- **Status:** This column displays the current status of the document, indicating whether it has been viewed or signed by the signer. Once the signer has viewed or signed the document, the Owner of the document can click "View" to see the activity logs.
|
||||
|
||||
<img width="816" alt="Inprogress documents" src="https://github.com/user-attachments/assets/4eb43321-5eec-48ec-a3b6-75e932d31c6c" />
|
||||
|
||||
<img width="816" alt="Inprogress documents" src="https://github.com/user-attachments/assets/c2353510-571e-4081-b429-0a522dc1da0b" />
|
||||
|
||||
- **Signers:** The "Signers" column displays the names and email addresses of the signers assigned to that document for signature. Click the "View" button to see the signers.
|
||||
|
||||
@@ -40,7 +37,7 @@ The "In progress documents" report also includes several actions icons for each
|
||||
|
||||
- **Share Document:** The "Share" option in the In-Progress Documents report allows you to manually share the signing link of a document with signers or other recipients directly via email. This feature ensures that the signers can easily access the document, even if they have missed the initial notification.
|
||||
|
||||
<img width="816" alt="Inprogress documents" src="https://github.com/user-attachments/assets/7c632c2d-c784-4b51-9517-5c6817abd16f" />
|
||||
<img width="816" alt="Inprogress documents" src="https://github.com/user-attachments/assets/9fd83c72-17a1-49bd-b7a3-30b80ef5f0ed" />
|
||||
|
||||
Upon clicking the Share icon, a pop-up window titled Copy link will appear. This window provides multiple options to share the document link with designated recipients.
|
||||
|
||||
@@ -59,9 +56,26 @@ The pop-up will display a list of email addresses of the intended recipients or
|
||||
|
||||
<img width="816" alt="resend document" src="https://github.com/user-attachments/assets/c0cb3348-47ca-4d2e-a2d7-81cb3b18a0c6" />
|
||||
|
||||
- **Revoke:** If there’s a mistake or you need to cancel the document, revoking stops all signing actions immediately. This is useful when changes are needed before re-sending the document.
|
||||
- **Rename:** Allows the user to rename the document.
|
||||
|
||||
<img width="816" alt="resend document" src="https://github.com/user-attachments/assets/b2273768-ef81-44cd-95ea-92babee429b6" />
|
||||
- **Revoke:** If there’s a mistake or you need to cancel the document, revoking stops all signing actions immediately. This is useful when changes are needed before re-sending the document.
|
||||
|
||||
<img width="816" alt="resend document" src="https://github.com/user-attachments/assets/a9bfcfa9-b073-4111-a823-93d6a2e80c40" />
|
||||
|
||||
- **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.
|
||||
|
||||
- **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.
|
||||
|
||||
|
||||
@@ -9,12 +9,14 @@ The "Need your sign" feature in OpenSign is designed to simplify the process of
|
||||
## Accessing the "Need your sign" report
|
||||
|
||||
- **Login to OpenSign**: Start by logging into your OpenSign account.
|
||||
- **Navigate to "Need your sign"**: Once logged in, you will find a navigation panel on the left side of your screen. Under the "Reports" section, click on "Need your sign" to view all documents that require your signature.
|
||||
- **Navigate to "Need your sign"**: Once logged in, you will find a navigation panel on the left side of your screen. Under the "Documents" section, click on "Need your sign" to view all documents that require your signature.
|
||||
|
||||
## Understanding the "Need your sign" report
|
||||
|
||||
Upon clicking "Need your sign," you will be presented with a list of documents awaiting your signature. Here's a breakdown of the key elements within this interface:
|
||||
|
||||
<img width="816" alt="OpenSign_Signyourself" src="https://github.com/user-attachments/assets/1211e156-5e82-4979-9ee1-3ee4bcc86aa1" />
|
||||
|
||||
- **Sr.No**: This column provides a serial number for each document in the list, allowing for easy identification and reference.
|
||||
|
||||
- **Title**: The "Title" column displays the name of the document.
|
||||
|
||||
@@ -0,0 +1,114 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: API Token
|
||||
---
|
||||
|
||||
# 🔐 API Authentication – Setting Up Your `x-api-token`
|
||||
|
||||
To authenticate and use OpenSign API endpoints, you’ll need a valid API token (`x-api-token`).
|
||||
|
||||
Follow the steps below to generate one.
|
||||
|
||||
> **Note:** You can generate both **Live** and **Sandbox** API tokens from your OpenSign account.
|
||||
|
||||
---
|
||||
|
||||
## 🧭 Step-by-Step Guide to Generate Your API Token
|
||||
|
||||
**Step 1:** Log in to your OpenSign account using valid credentials.
|
||||
|
||||
**Step 2:** Navigate to the **Settings** section and click on **API Token**.
|
||||
|
||||
<img width="436" alt="Navigate-to-Api-token" src="https://github.com/user-attachments/assets/e0e05a23-f815-4805-a047-f08d3727ad98" />
|
||||
|
||||
**Step 3:** On the API Token page, click the **Generate Live API Token** button.
|
||||
|
||||
> **Note:** To generate a **Live API Token**, you must upgrade to a **paid plan** — either the **Professional** or **Teams** plan.
|
||||
|
||||
<img width="436" alt="Generate token" src="https://github.com/user-attachments/assets/f5a17744-cfce-464f-9b82-685570ed1e39" />
|
||||
|
||||
- Your `x-api-token` will now be generated and displayed.
|
||||
- **Copy this token** — you’ll need it to authenticate your OpenSign API requests.
|
||||
|
||||
---
|
||||
|
||||
### 🧪 Sandbox API Token
|
||||
|
||||
You’ll also find the option to generate a **Sandbox API Token** on the same page.
|
||||
|
||||
- **Sandbox API tokens** are available on all plans, including the **free plan**, and are intended for development and testing.
|
||||
- **Do not upload confidential data** to the Sandbox environment.
|
||||
|
||||
<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.
|
||||
|
||||
- ✅ Available in **all plans**, including the **free plan**.
|
||||
- 🧪 Ideal for **testing and development** purposes.
|
||||
|
||||
<img width="436" alt="login to sandbox" src="https://github.com/user-attachments/assets/3bc6bacd-9c15-4232-b9d7-6d0fb423cf57" />
|
||||
|
||||
#### 🔐 How to Access the Sandbox Environment
|
||||
|
||||
1. Go to the **Settings** menu.
|
||||
2. Click on **API Token**.
|
||||
3. On the API Token page, click **Login to Sandbox**.
|
||||
4. You will be automatically logged in to the sandbox environment using your existing account — **no need to enter your username or password**.
|
||||
|
||||
> ⚠️ **Important Note:**
|
||||
> Manually entering your username and password will **not work** for sandbox login. Always use the "Login to Sandbox" button for access.
|
||||
---
|
||||
### Buy the api credit
|
||||
User can buy the api credit using this feature
|
||||
On the click of the buy premium credits the
|
||||
|
||||
## 🧠 Frequently Asked Questions
|
||||
|
||||
**1. What is the OpenSign Sandbox environment?**
|
||||
The Sandbox is a testing environment designed for developers to safely experiment with OpenSign APIs and workflows. It mirrors the live environment but with certain limitations.
|
||||
|
||||
**2. Can I upload large documents to the Sandbox?**
|
||||
No. Please avoid uploading documents larger than **5MB** in the Sandbox. It is optimized for lightweight testing only.
|
||||
|
||||
**3. Can I use my Live API Token in the Sandbox?**
|
||||
No. **Live API Tokens do not work** in the Sandbox environment. You’ll need to generate a separate token specifically for Sandbox testing.
|
||||
|
||||
**4. Why can’t I use a live template in the Sandbox?**
|
||||
Live and Sandbox environments are **separate**. Templates created in the Live environment cannot be used in the Sandbox, and vice versa.
|
||||
|
||||
**5. Can I use the API in the free self-hosted environment?**
|
||||
No. The **free self-hosted version** does not support API token generation.
|
||||
To use OpenSign APIs in a self-hosted setup, you must upgrade to a **paid self-hosted plan**.
|
||||
|
||||
If you need additional assistance setting up OpenSign APIs, feel free to contact our support team at support@opensignlabs.com.
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
sidebar_position: 8
|
||||
title: Custom email templates
|
||||
---
|
||||
|
||||
# 📧 Email Templates
|
||||
|
||||
## 🚀 Steps to Set Up Custom Email Templates
|
||||
|
||||
**Step 1:** Log in to your OpenSign account using valid credentials.
|
||||
**Step 2:** Navigate to the **Settings** section and click on **Preferences**.
|
||||
**Step 3:** Click on the **Email** tab. Here, users can configure and edit custom email templates for different stages of the document lifecycle.
|
||||
|
||||
<img width="800" alt="add team" src="https://github.com/user-attachments/assets/dc1efaab-c7f9-4f82-abc4-1cafd587f7ce"></img>
|
||||
|
||||
---
|
||||
|
||||
## ✉️ Request Signature Email
|
||||
|
||||
This email is automatically sent to all signers when a document is shared with them for signing.
|
||||
|
||||
- Customize the subject line, greeting, message body, and footer to match your tone and branding.
|
||||
- Use dynamic placeholders like `{{document_title}}`, `{{receiver_name}}`, and `{{signing_url}}` to personalize each message.
|
||||
- Personalized messages improve open rates and help recipients understand the context of the request.
|
||||
|
||||
## 📩 Document Completion Email
|
||||
|
||||
This email is sent to all signers and the document owner once the signing process is complete.
|
||||
|
||||
- Includes a summary message along with the signed document and completion certificate as attachments.
|
||||
- Template customization allows teams to reinforce brand messaging post-signature.
|
||||
- Ideal for legal confirmations, audit trails, and archival communication.
|
||||
|
||||
### 🔄 Reset Template Text
|
||||
|
||||
Click the **Reset** button to restore the template content to its default version.
|
||||
Don’t forget to click **Save** afterward to apply the changes.
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Additional Notes
|
||||
|
||||
- All custom email templates support **rich text formatting** and **variables** for dynamic content.
|
||||
- Changes to templates take immediate effect and apply to all new documents created after the update.
|
||||
- Organizations can define a consistent template style across all teams to ensure compliance and branding.
|
||||
|
||||
> 💡 **Tip:** Preview your templates before saving to ensure correct formatting and placeholder usage.
|
||||
|
||||
For more assistance with OpenSign™ features or APIs, contact our support team at **[support@opensignlabs.com](mailto:support@opensignlabs.com)**.
|
||||
@@ -0,0 +1,306 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
title: Preferences
|
||||
---
|
||||
|
||||
# 🔧 Preferences
|
||||
|
||||
The **Preferences** page in **OpenSign™** allows users and administrators to tailor the signing experience to suit individual, team, or organizational needs. Below is a breakdown of all configurable options and what they control.
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Steps to Navigate to Preferences
|
||||
|
||||
**Step 1:** Log in to your OpenSign account using valid credentials.
|
||||
|
||||
**Step 2:** Navigate to the **Settings** section and click on **Preferences**.
|
||||
|
||||
---
|
||||
|
||||
## 📌 Signature Types Control
|
||||
|
||||
The **Allowed Signature Types** section defines which signature methods are available to signers:
|
||||
|
||||
- ✅ **Draw**: Create a handwritten signature using a mouse, stylus, or finger.
|
||||
- ✅ **Type**: Type your name and apply it using pre-set font styles.
|
||||
- ✅ **Upload**: Upload a scanned or saved image of your signature.
|
||||
- ✅ **Default**: Use the default signature stored under *My Signature* in settings.
|
||||
|
||||
⚙️ The options selected here determine what appears in the signature widget during document creation and signing. You can also change these preferences while creating a document.
|
||||
|
||||
---
|
||||
|
||||
## 🔄 Multi-Level Signature Type Control
|
||||
|
||||
**OpenSign™** introduces flexible control over signature options at three levels:
|
||||
|
||||
### 🏢 Organization-Level
|
||||
|
||||
Admins can enforce company-wide signing policies by restricting available signature methods platform-wide.
|
||||
|
||||
**Step 1:** Open the profile menu and select **Console Application** to launch the console.
|
||||
|
||||
**Step 2:** Once the Console Application loads, navigate to the **General** menu. Here, admins can configure the allowed signature types at the organization level.
|
||||
|
||||
All users created under your account will only see the signing methods you enable here in their **Preferences**. They will be restricted from using any methods you don't select.
|
||||
|
||||
**Example:**
|
||||
Adam, the administrator of your company account, disables the **Typed** signature option in the **Manage Signature Types** settings. As a result, Ursula, a team member, will no longer see the **Typed** signature option in her preferences.
|
||||
|
||||
Ursula can enable or disable any of the remaining three signature methods for each document she creates.
|
||||
|
||||
When she sends a document to Sofia, a signer, Sofia will only see the signature methods that Ursula selected during the document creation process.
|
||||
|
||||
**Note:** Managing **Signature Types** at the organization level is only available on the **Teams** plan. This feature is not included in the **Professional** or **Free** plans.
|
||||
|
||||

|
||||
|
||||
### 👤 User-Level
|
||||
|
||||
Navigate to **Settings > Preferences** to configure user-level signature types.
|
||||
|
||||
If a user sets preferred types here, only those will appear when adding signature or initial widgets during document creation.
|
||||
|
||||
<img width="861" height="480" alt="signatures" src="https://github.com/user-attachments/assets/69d0851c-57f2-42e5-af6e-419f6d8821c2" />
|
||||
|
||||
### 📄 Document-Level
|
||||
|
||||
While creating a document, users can specify allowed signature types.
|
||||
|
||||
Only these will be available to the signer—useful for legal or regulatory requirements.
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
## 🔔 Notify on Signatures
|
||||
|
||||
The document owner can choose to receive email notifications when a document is signed.
|
||||
|
||||
- **Yes** – Get notified each time a signer completes their part.
|
||||
- **No** – Turn off real-time signature notifications.
|
||||
|
||||
This setting can be adjusted while creating a document or template.
|
||||
|
||||
Regardless of this preference, a **final completion email**—including the signed document and completion certificate—is **always sent** to both the document owner and all signers.
|
||||
|
||||
**Note:** Notify on Signatures feature is only available on the **Professional** and higher plans—it is not included in the **Free** plan.
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
## 📬 Send in Order
|
||||
|
||||
Decide whether the document should be signed **sequentially** or **simultaneously** by multiple signers.
|
||||
|
||||
- **Yes** – Signers receive the document in a set order. The next signer gains access only after the previous one completes signing.
|
||||
- **No** – All signers receive the document at once and can sign independently.
|
||||
|
||||
> Users can change this option while creating the document or a template.
|
||||
|
||||
---
|
||||
|
||||
## 🚫 Enable Tour
|
||||
|
||||
The tour feature provides guidance for first-time users. You can turn this off for a cleaner, uninterrupted experience:
|
||||
|
||||
- **Yes** – Show onboarding tips. Enables guided tooltips for the signer during the signing process.
|
||||
- **No** – Disable tour prompts *(recommended for experienced users)*. Speeds up the signing experience.
|
||||
|
||||
> Users can change this option while creating the document or a template.
|
||||
|
||||
💡 **Tip**: Disable if your users are already familiar with OpenSign™.
|
||||
|
||||
---
|
||||
### 📧 Custom SMTP Configuration in OpenSign
|
||||
|
||||
OpenSign allows users to **send emails using their own SMTP settings**, including Gmail integration and third-party SMTP providers.
|
||||
|
||||
OpenSign now supports SMTP configuration at both the **organization level** and the **individual user level**.
|
||||
|
||||
To set up SMTP at the organization level, refer to the guide here:
|
||||
https://docs.opensignlabs.com/docs/help/User%20Menu/Console/globalSMTP
|
||||
|
||||
## 👤 SMTP at the User Level
|
||||
|
||||
Users can configure their own SMTP settings to send request-signature and completion emails using their personal mailbox.
|
||||
These user-level settings will override the organization-level SMTP only if the admin has **enabled individual SMTP customization** under Console → General.
|
||||
|
||||
Use this option if you prefer sending emails directly from your own email address.
|
||||
|
||||
### To set up and enable user-level SMTP:
|
||||
|
||||
1. Go to **Settings**
|
||||
2. Select **Preferences**
|
||||
3. Choose one of the available SMTP options.
|
||||
|
||||
Once a user selects and configures any SMTP option, all emails will be sent using the user-level SMTP.
|
||||
|
||||
<img width="861" height="409" alt="smtp at user level" src="https://github.com/user-attachments/assets/27c459f3-5ae6-41e8-966d-43785e67f192" />
|
||||
|
||||
---
|
||||
### 🔗 Connect to Gmail
|
||||
|
||||
Send request-signature emails directly from your **Gmail account**.
|
||||
|
||||
- Click **Connect to Gmail**
|
||||
- A popup will appear prompting you to sign in
|
||||
- Grant the required access permissions
|
||||
- Once authorized, OpenSign will send emails using your Gmail account
|
||||
|
||||
---
|
||||
|
||||
### ⚙️ Custom SMTP
|
||||
|
||||
Configure any third-party SMTP provider such as SMTP2GO or Mailgun.
|
||||
|
||||
- Click **Custom SMTP**
|
||||
- A popup will appear asking for your SMTP details:
|
||||
- **Host:** SMTP server host (e.g., `mail.smtp2go.com`)
|
||||
- **Port:** SMTP port (e.g., `2525`)
|
||||
- **Sender Email:** Email address configured in your SMTP account
|
||||
- **Username:** SMTP username
|
||||
- **Password:** SMTP password
|
||||
|
||||
<img width="820" alt="Custom smtp" src="https://github.com/user-attachments/assets/a3c33510-11b9-4a32-bd44-99614182b089"></img>
|
||||
|
||||
---
|
||||
|
||||
### 📤 OpenSign™ Default SMTP
|
||||
|
||||
If selected, all request-signature and completion emails will be sent using OpenSign’s built-in SMTP server.
|
||||
|
||||
---
|
||||
If the user does not configure any SMTP option, emails will be sent using the organization-level SMTP (when it is enabled by the admin).
|
||||
If the admin has configured a company-level SMTP, and the user has not set up their own SMTP, the user will still be connected to the default OpenSign SMTP, but all outgoing emails will be delivered using the organization-level SMTP.
|
||||
|
||||
---
|
||||
|
||||
> ⚠️ **Notes:**
|
||||
> - A green checkmark indicates the **active SMTP option**.
|
||||
> - Only one SMTP option can be active at a time.
|
||||
> - User-level SMTP is available only when permitted by the admin.
|
||||
> - Some SMTP features are limited to **Paid plans**.
|
||||
|
||||
|
||||
---
|
||||
## 🧭 Timezone & Date Format
|
||||
|
||||
Customize the **Timezone** and **Date Format** according to your regional preferences.
|
||||
These settings are reflected in:
|
||||
|
||||
- Document Completion Certificates
|
||||
- Signing Logs
|
||||
- Webhooks
|
||||
|
||||
### 📅 Date Format
|
||||
|
||||
- The selected date format will be applied by default to the date widget if no specific format is chosen during document creation.
|
||||
- This default format also applies in all API flows.
|
||||
|
||||
### 🕒 Time Format
|
||||
|
||||
- Supports **12-hour** and **24-hour** formats.
|
||||
- Affects timestamps in certificates, logs, and webhooks.
|
||||
|
||||
<img width="820" alt="Time zone" src="https://github.com/user-attachments/assets/bc1f29a2-565a-4ac2-96a4-9aa18b80b064"></img>
|
||||
|
||||
---
|
||||
|
||||
## 🧪 LTV-Enabled Signatures
|
||||
|
||||
**LTV (Long-Term Validation)** ensures that signatures remain valid and verifiable even after certificates expire or are revoked.
|
||||
|
||||
### 🔐 Key Features:
|
||||
|
||||
- Embeds certificate chain
|
||||
- Includes CRLs and OCSP responses
|
||||
- Enables offline verification
|
||||
- Complies with PDF standards like **PAdES**
|
||||
|
||||
### 📌 Why It Matters:
|
||||
|
||||
Even if a certificate becomes invalid in the future, the LTV-enabled signature remains verifiable.
|
||||
|
||||
### ✅ Use Cases:
|
||||
|
||||
- Legal Contracts
|
||||
- Financial or Medical Records
|
||||
- Long-term archiving requirements
|
||||
|
||||
---
|
||||
### **Merge Certificate to PDF**
|
||||
|
||||
You can access this option by navigating to **Settings → Preferences**.
|
||||
|
||||
**Yes:** Selecting **Yes** will attach the completion certificate directly to the signed document, creating a single combined PDF file.
|
||||
Please note that once merged, the certificate cannot be separated from the main document.
|
||||
|
||||
**No:** Selecting **No** will keep the completion certificate as a separate PDF file, which will be downloaded along with the signed document.
|
||||
|
||||
> **Note:** This feature is available only in the **paid plans** of OpenSign.
|
||||
|
||||
## 🔄 Multi-Level Custom Email Templates
|
||||
|
||||
**OpenSign™** offers flexible control over email templates at two different levels:
|
||||
|
||||
---
|
||||
|
||||
### 🏢 Organization Level
|
||||
|
||||
Admins can manage and enforce standardized email templates across the entire platform.
|
||||
|
||||
**Step 1:** Open the profile menu and select **Console Application** to access the admin console.
|
||||
**Step 2:** Once the Console Application opens, go to the **Mail** section. Here, administrators can configure email templates at the organization level.
|
||||
|
||||
All users created under your organization will automatically use these templates for sending request-signature and document completion emails **unless** they have permission to create templates at the individual level or have customized their own templates.
|
||||
|
||||
**Example:**
|
||||
Adam, the administrator of your company account, disables the **Allow email template customization for users individually** setting under **Console → General**. As a result, Ursula, a team member, cannot create or modify her own email templates.
|
||||
|
||||
When Ursula sends a document to Sofia for signing, Sofia will receive the organization-level email template.
|
||||
If Adam enables **Allow email template customization for users individually** but Ursula does not set up her own template, the signers will still receive emails based on the organization-level template.
|
||||
|
||||
**Note:** Organization-level email management is available only on **Paid** plans. This feature is **not** included in **Free** plans.
|
||||
|
||||
<img width="861" height="409" alt="Email_templates" src="https://github.com/user-attachments/assets/0b15e356-cfba-46d5-9e97-c73d32b879f4" />
|
||||
|
||||
---
|
||||
|
||||
### 👤 User Level
|
||||
|
||||
Users can configure their own email templates by navigating to **Settings → Preferences**.
|
||||
|
||||
If a user sets up templates here, those templates will be used for sending request-signature emails and document-completion emails.
|
||||
|
||||
<img width="861" height="480" alt="signatures" src="https://github.com/user-attachments/assets/dda05d4f-aa43-435d-bdb2-e68dca6f2b00" />
|
||||
|
||||
**Note:** Customize email management is only available on **Paid** plans. This feature is not included in **Free** plans.
|
||||
|
||||
### How Request-Signature and Completion Email Templates Work
|
||||
|
||||
- If the admin enables **Allow email template customization for users individually** and the user sets up their own custom templates, then both **request-signature emails** and **completion emails** will be sent using the **user-level templates**.
|
||||
|
||||
- If the user does **not** set up custom templates, and the admin has also **not** configured templates at the organization level, then the **default OpenSign templates** will be used.
|
||||
|
||||
---
|
||||
|
||||
## 🔒 Security
|
||||
|
||||
The **Security** tab in OpenSign (found under **Settings > Preferences > Security**) allows users to manage key authentication methods to protect their account access.
|
||||
|
||||
### 🧩 Features Available:
|
||||
|
||||
#### ✅ Two-Factor Authentication (2FA)
|
||||
|
||||
Enhance your account security by enabling 2FA. Once activated, you'll enter a time-based code from an authenticator app each time you log in.
|
||||
|
||||
#### 🛡️ Passkey Authentication
|
||||
|
||||
Passkeys offer a **passwordless**, **phishing-resistant** login experience using your device’s built-in security features such as fingerprint, Face ID, or PIN.
|
||||
|
||||
👉 For full details on setting up **Two-Factor Authentication (2FA)** and **Passkey Authentication**:
|
||||
[🔒 View Security Setup Guide](https://docs.opensignlabs.com/docs/help/Settings/SecurityManagement)
|
||||
|
||||
For more assistance with OpenSign™ features or APIs, contact our support team at **[support@opensignlabs.com](mailto:support@opensignlabs.com)**.
|
||||
@@ -0,0 +1,87 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
title: Security
|
||||
---
|
||||
import ReactPlayer from 'react-player';
|
||||
|
||||
### ✅ Two-Factor Authentication (2FA)
|
||||
|
||||
Two-Factor Authentication (2FA) adds a second layer of security to your account by requiring **not just your password, but also a time-sensitive code** from a trusted device.
|
||||
|
||||
#### 🔐 What is 2FA?
|
||||
|
||||
2FA combines **something you know** (your password) with **something you have** (like a smartphone or hardware token). This significantly reduces the risk of unauthorized access—even if someone has your password.
|
||||
|
||||
#### 🛡️ Benefits:
|
||||
|
||||
- Enhances account protection against phishing and brute-force attacks
|
||||
- Reduces the risk of unauthorized access from compromised credentials
|
||||
- Helps meet compliance requirements for security-conscious organizations
|
||||
- Only the account owner with access to the authenticator app can log in
|
||||
|
||||
#### 📲 How to Enable:
|
||||
|
||||
1. Go to **Settings > Preferences > Security**
|
||||
2. Click "Setup 2FA" button and scan the displayed QR code with an app like Google Authenticator, Authy, or Microsoft Authenticator.
|
||||
3. Save the recovery codes in a secure location (they allow access if you lose your phone)
|
||||
4. Enter the 6-digit verification code shown in your app to complete setup
|
||||
|
||||
> 🔁 The verification code refreshes every 30 seconds and is unique to your device.
|
||||
> 🔐 If 2FA is enabled, you will be prompted for a verification code every time you log in.
|
||||
|
||||
#### 📹 Watch the Setup Tutorial:
|
||||
|
||||
<div>
|
||||
<ReactPlayer playing controls url='https://www.youtube.com/watch?v=cgVBBetnbO8' />
|
||||
</div>
|
||||
|
||||
### 🛡️ Passkey Authentication
|
||||
|
||||
Passkeys offer **passwordless**, **phishing-resistant**, and **device-bound** sign-in using modern authentication standards.
|
||||
|
||||
#### 🔐 What Are Passkeys?
|
||||
|
||||
Passkeys are cryptographic credentials tied to your device and identity, replacing traditional passwords. They’re based on **FIDO2/WebAuthn** standards and work using **public-private key encryption**, making them highly secure.
|
||||
|
||||
- Instead of typing passwords, you authenticate using biometrics (like Face ID or fingerprint) or a device PIN.
|
||||
- A passkey is stored securely on your device and never shared—so even if attackers phish you, they can’t steal your login info.
|
||||
|
||||
#### 💡 Key Features:
|
||||
|
||||
- Use **fingerprint**, **Face ID**, or **device PIN**
|
||||
- **Passwordless** and **secure** authentication
|
||||
- Resistant to **phishing** and **credential stuffing**
|
||||
- Syncs across devices (when using platforms like iCloud Keychain or Google Password Manager)
|
||||
- Fast, one-tap login experience
|
||||
|
||||
#### 🛠 How to Register a Passkey:
|
||||
|
||||
1. Go to **Settings > Preferences > Security**
|
||||
2. Click **Register passkey**
|
||||
3. Your device prompts biometric or PIN-based authentication
|
||||
4. On success, the passkey is saved and listed under **Your Passkeys**
|
||||
|
||||
> 📌 A passkey is unique to each device/browser combination. You can register multiple passkeys for different environments.
|
||||
|
||||
#### 📹 Watch the Setup Tutorial:
|
||||
|
||||
<div>
|
||||
<ReactPlayer playing controls url='https://www.youtube.com/watch?v=lLfcu9oSbew' />
|
||||
</div>
|
||||
|
||||
#### 🧾 Managing Your Passkeys
|
||||
|
||||
##### ✏️ Rename:
|
||||
|
||||
Click the **pencil icon** to rename a passkey for easy identification.
|
||||
|
||||
##### 🗑 Delete:
|
||||
|
||||
Click the **trash icon** to remove a passkey.
|
||||
⚠️ This revokes access via that method and may require alternate login or re-registration.
|
||||
|
||||
> 🔐 Tip: Register multiple passkeys on different devices for redundancy and ease of access.
|
||||
|
||||
---
|
||||
|
||||
For more assistance with OpenSign™ features or APIs, contact our support team at **[support@opensignlabs.com](mailto:support@opensignlabs.com)**.
|
||||
@@ -0,0 +1,102 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
title: Manage Teams
|
||||
---
|
||||
|
||||
# 👥 Teams Management in OpenSign
|
||||
|
||||
The **Teams** feature in OpenSign allows you to organize your users into structured groups for easier management, permissions control, and streamlined workflow configuration.
|
||||
|
||||
---
|
||||
|
||||
## 🧭 How to Access the Teams Page
|
||||
|
||||
1. Log in to your OpenSign account.
|
||||
2. In the left-hand sidebar, navigate to **Settings → Teams**.
|
||||
|
||||
<img width="436" alt="Navigate-to-Teams" src="https://github.com/user-attachments/assets/2e292fc2-83b9-41b4-b133-451286744547"></img>
|
||||
|
||||
---
|
||||
|
||||
## 📋 Teams Overview
|
||||
|
||||
On the Teams page, you'll see a list of all existing teams. Each row includes:
|
||||
|
||||
| Column | Description |
|
||||
|----------------|------------------------------------------------------------------------------|
|
||||
| **Sr. No** | Serial number of the team in the list. |
|
||||
| **Name** | The name of the team. |
|
||||
| **Parent Team**| The parent team this team belongs to (useful for hierarchical grouping). |
|
||||
| **Active** | Toggle to activate or deactivate the team. |
|
||||
| **Edit** | Click the pencil icon to edit the team name or parent team. |
|
||||
|
||||
- 🟢 **Active** teams are currently usable across OpenSign modules.
|
||||
- ⚪ **Inactive** teams are hidden from functional views but not deleted.
|
||||
|
||||
---
|
||||
|
||||
## ➕ Adding a New Team
|
||||
|
||||
To create a new team:
|
||||
|
||||
1. Click the **➕ Add Team** button at the top-right of the page.
|
||||
2. A modal will appear titled **Add Team**.
|
||||
|
||||
**Fill in the following details:**
|
||||
|
||||
- **Name** (Required): Enter a name for the new team.
|
||||
- **Parent Team**: Choose a parent group (default is **All Users**).
|
||||
|
||||
<img width="436" alt="add team" src="https://github.com/user-attachments/assets/74c042b1-2c31-4d00-81f4-0abeaf0c985c"></img>
|
||||
|
||||
3. Click **Submit** to create the team or **Reset** to clear the form.
|
||||
|
||||
> 📝 **Tip:** Use parent teams to build a team hierarchy — for example, placing _Marketing_ under _HR_.
|
||||
|
||||
<img width="436" alt="New team" src="https://github.com/user-attachments/assets/7f69afeb-c96e-46d4-b5ee-5af9dd656d2a"></img>
|
||||
|
||||
---
|
||||
|
||||
## 🖊️ Editing an Existing Team
|
||||
|
||||
To edit a team:
|
||||
|
||||
1. Click the **pencil icon** next to the team name.
|
||||
2. Modify the team name or parent group.
|
||||
3. Save the changes.
|
||||
|
||||
---
|
||||
|
||||
## 🌐 Where You Can Use the Teams
|
||||
|
||||
1. **Active teams** are available when creating new users — you can select a team from the dropdown and add multiple users under one team.
|
||||
|
||||
<img width="436" alt="create new user" src="https://github.com/user-attachments/assets/3aea0ff3-5aa2-416c-b6cc-7148e7d694e6"></img>
|
||||
|
||||
2. You can also **share templates** with teams. Once a template is shared with a team, **all users in that team can access the template**.
|
||||
|
||||
<img width="436" alt="Share template" src="https://github.com/user-attachments/assets/22ddde66-7cd9-4e4b-a012-8e1e72043d20"></img>
|
||||
<img width="436" alt="Share template with team" src="https://github.com/user-attachments/assets/534556ce-1641-44c1-a794-54033ca01376"></img>
|
||||
|
||||
---
|
||||
|
||||
## 🚫 Deactivating a Team
|
||||
|
||||
To deactivate a team, toggle the **Active** switch off. This will:
|
||||
|
||||
- Prevent users in this team from logging into their OpenSign accounts.
|
||||
- Hide the team from the **Teams dropdown** when adding new users.
|
||||
- Prevent template sharing with deactivated teams.
|
||||
- Preserve team data for future reactivation and audit purposes.
|
||||
|
||||
---
|
||||
|
||||
## ℹ️ Notes
|
||||
|
||||
- The **All Users** team is the default root and **cannot be deleted**.
|
||||
- **Deactivated teams** can be re-enabled anytime using the toggle.
|
||||
- Only users with **administrative privileges** can access and manage the Teams page.
|
||||
|
||||
If you require more help, feel free to reach out to our customer support at **support@opensignlabs.com**.
|
||||
|
||||
**Happy signing with OpenSign™!**
|
||||
@@ -0,0 +1,327 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
title: Webhook
|
||||
---
|
||||
|
||||
# 🔁 Webhook
|
||||
|
||||
## 🔔 What is a Webhook?
|
||||
|
||||
A **webhook** allows one system (like OpenSign) to automatically send real-time data or notifications to another system (like your server) when a specific event occurs.
|
||||
|
||||
Think of it as a **push notification for your backend** — instead of continuously checking for updates (polling), a webhook pushes data to your endpoint **as soon as an event happens**.
|
||||
|
||||
---
|
||||
|
||||
## 🧠 Simple Example
|
||||
|
||||
Suppose you're using OpenSign to collect eSignatures:
|
||||
|
||||
- When someone **signs a document**, OpenSign triggers a **POST request** to your server.
|
||||
- The request includes data such as the document ID, signer email, and signature status.
|
||||
- Your server can then process this information — for example, update your CRM, trigger a workflow, or send a confirmation email.
|
||||
|
||||
---
|
||||
|
||||
## 🧭 How to Add a Webhook in OpenSign
|
||||
|
||||
**Step 1:** Log in to your OpenSign account using your credentials.
|
||||
**Step 2:** Navigate to **Settings → Webhook**.
|
||||
|
||||
<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**.
|
||||
|
||||
- A popup will appear. Enter your **Webhook URL** and click **Yes** to save it.
|
||||
|
||||
> **Note:** To enable **Live Webhook** support, you must upgrade to a **paid plan** — either the **Professional** or **Teams** plan.
|
||||
|
||||
---
|
||||
|
||||
## 🧭 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="407" 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.
|
||||
- **Sandbox webhook** are available on all plans, including the **Free** plan, and are ideal for development and testing.
|
||||
|
||||
> **Caution:** Avoid sending sensitive or confidential data to the Sandbox environment.
|
||||
|
||||
📘 **API Reference:**
|
||||
You can also manage your webhooks via our API.
|
||||
See the API documentation here: [Save/Update Webhook API](https://docs.opensignlabs.com/docs/API-docs/save-update-webhook)
|
||||
|
||||
---
|
||||
|
||||
## 📋 Supported Webhook Events
|
||||
|
||||
OpenSign sends event notifications to your configured webhook URL when any of the following actions occur:
|
||||
|
||||
- **Document Created** – A document is created.
|
||||
- **Document Viewed** – A signer viewed the document.
|
||||
- **Document Signed** – A signer signed the document.
|
||||
- **Document Completed** – All required signatures are completed.
|
||||
- **Document Revoked or Declined** – The document was revoked or declined.
|
||||
|
||||
Each notification is sent as a **POST request** with a **JSON payload** containing relevant event data.
|
||||
|
||||
---
|
||||
|
||||
### 🔍 Example Payload: `Document Created`
|
||||
|
||||
```json
|
||||
{
|
||||
"event": "created",
|
||||
"type": "request-sign",
|
||||
"objectId": "kpeg6Q2rO7",
|
||||
"file": "https://legadratw3d.ams3.digitaloceanspaces.com/851de61f62b60a1f62e03232464fa4bf_81wV17MTebsrRoov.pdf?...",
|
||||
"name": "Sample Test Doc",
|
||||
"note": "Please review and sign this document",
|
||||
"description": "",
|
||||
"signers": [
|
||||
{
|
||||
"name": "Peter Mark",
|
||||
"email": "peter.mark1093@gmail.com",
|
||||
"phone": "3556567789"
|
||||
}
|
||||
],
|
||||
"createdAt": "Fri, 16 May 2025 15:02:42 IST"
|
||||
}
|
||||
```
|
||||
### 🔍 Example Payload: `Document Viewed`
|
||||
|
||||
```json
|
||||
{
|
||||
"event": "viewed",
|
||||
"type": "request-sign",
|
||||
"objectId": "kpeg6Q2rO7",
|
||||
"file": "https://legadratw3d.ams3.digitaloceanspaces.com/851de61f62b60a1f62e03232464fa4bf_81wV17MTebsrRoov.pdf?...",
|
||||
"name": "Sample Test Doc",
|
||||
"note": "Please review and sign this document",
|
||||
"description": "",
|
||||
"signers": [
|
||||
{
|
||||
"name": "Peter Mark",
|
||||
"email": "peter.mark1093@gmail.com",
|
||||
"phone": "3556567789"
|
||||
}
|
||||
],
|
||||
"viewedBy": "peter.mark1093@gmail.com",
|
||||
"viewedAt": "Fri, 16 May 2025 16:18:16 IST",
|
||||
"createdAt": "Fri, 16 May 2025 15:02:28 IST"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 🔍 Example Payload: `Document Signed`
|
||||
|
||||
```json
|
||||
{
|
||||
"event": "signed",
|
||||
"type": "request-sign",
|
||||
"objectId": "kpeg6Q2rO7",
|
||||
"file": "https://legadratw3d.ams3.digitaloceanspaces.com/bc2eb56cc9d29a5f222e4a4b5dbbcfbf_signed_sample_test_doc_4858.pdf?...",
|
||||
"name": "Sample Test Doc",
|
||||
"note": "Please review and sign this document",
|
||||
"description": "",
|
||||
"signer": {
|
||||
"name": "Peter Mark",
|
||||
"email": "peter.mark1093@gmail.com",
|
||||
"phone": "3556567789"
|
||||
},
|
||||
"signedAt": "Fri, 16 May 2025 16:18:34 GMT+5:30",
|
||||
"createdAt": "Fri, 16 May 2025 15:02:28 GMT+5:30"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 🔍 Example Payload: `Document Completed`
|
||||
|
||||
```json
|
||||
{
|
||||
"event": "completed",
|
||||
"type": "request-sign",
|
||||
"objectId": "kpeg6Q2rO7",
|
||||
"file": "https://legadratw3d.ams3.digitaloceanspaces.com/bc2eb56cc9d29a5f222e4a4b5dbbcfbf_signed_sample_test_doc_4858.pdf?...",
|
||||
"certificate": "https://legadratw3d.ams3.digitaloceanspaces.com/9c954912f529acb7e4d065ec0521a63b_certificate.pdf?...",
|
||||
"name": "Sample Test Doc",
|
||||
"note": "Please review and sign this document",
|
||||
"description": "",
|
||||
"signers": [
|
||||
{
|
||||
"name": "Peter Mark",
|
||||
"email": "peter.mark1093@gmail.com",
|
||||
"phone": "3556567789"
|
||||
}
|
||||
],
|
||||
"completedAt": "Fri, 16 May 2025 16:18:35 GMT+5:30",
|
||||
"createdAt": "Fri, 16 May 2025 15:02:28 GMT+5:30"
|
||||
}
|
||||
```
|
||||
---
|
||||
|
||||
### 🔍 Example Payload: `Document Declined`
|
||||
|
||||
```json
|
||||
{
|
||||
"event": "declined",
|
||||
"type": "request-sign",
|
||||
"objectId": "1gtDMBHpEY",
|
||||
"file": "https://legadratw3d.ams3.digitaloceanspaces.com/e90c32a45351eb52eb00e0054ae50566_581ZmOn4CwAqnxSF.pdf?...",
|
||||
"name": "Sample Test Doc ",
|
||||
"note": "Please review and sign this document",
|
||||
"description": "",
|
||||
"signers": [
|
||||
{
|
||||
"name": "Peter Mark",
|
||||
"email": "peter.mark1093@gmail.com",
|
||||
"phone": "9283784545554"
|
||||
}
|
||||
],
|
||||
"declinedBy": "peter.mark1093@gmail.com",
|
||||
"declinedReason": "Invalid date format used.",
|
||||
"declinedAt": "Fri, 16 May 2025 16:25:38 IST",
|
||||
"createdAt": "Fri, 16 May 2025 16:24:28 IST"
|
||||
}
|
||||
```
|
||||
---
|
||||
|
||||
## ❓ Frequently Asked Questions
|
||||
|
||||
### 1. What is the OpenSign Sandbox environment?
|
||||
|
||||
The Sandbox is a testing environment designed for developers to safely experiment with OpenSign APIs and workflows. It mirrors the live environment but with testing limitations.
|
||||
|
||||
---
|
||||
|
||||
### 2. Can I use my Live Webhook in the Sandbox?
|
||||
|
||||
No. **Live Webhooks do not work** in the Sandbox environment. You must configure a separate webhook specifically for Sandbox testing.
|
||||
|
||||
---
|
||||
|
||||
### 3. Can I test all webhook events in the Sandbox?
|
||||
|
||||
Yes. The Sandbox environment supports all event types, including `created`, `viewed`, `signed`, `completed`, and `revoked/declined`.
|
||||
However, some behaviors may be simulated for testing purposes.
|
||||
|
||||
---
|
||||
|
||||
## 💬 Need Help?
|
||||
|
||||
If you need help testing your webhook or integrating it into your application, feel free to reach out to our support team at [support@opensignlabs.com](mailto:support@opensignlabs.com).
|
||||
|
||||
**Happy signing with OpenSign™!**
|
||||
@@ -1,17 +1,17 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
sidebar_position: 7
|
||||
title: Disable DocumentId
|
||||
---
|
||||
|
||||
# How to disable adding the OpenSign™ documentId to signed documents
|
||||
Whenever a document is signed by all parties, OpenSign™ adds a DocumentId at the top left corner of the digitally signed document.
|
||||
Using this id you can verifiy the authenticity of the document at a later date, hence we strongly recommend that you keep this id.
|
||||
Using this id you can verify the authenticity of the document at a later date, hence we strongly recommend that you keep this id.
|
||||
In case you want to disable adding this to your signed documents, turn the 'Disable DocumentId' switch on.
|
||||
|
||||
- Click the '⌄' symbol just beside your name on the top right corner
|
||||
- Click profile
|
||||
- Click the 'edit' button
|
||||
- Turn the 'Disable DocumentId' swith to on
|
||||
- Turn the 'Disable DocumentId' switch to on
|
||||
- Click 'save'
|
||||
|
||||
<img width="436" alt="image" src="https://github.com/OpenSignLabs/OpenSign/assets/5486116/ee4433c7-1af7-4b74-800d-500060c0642d"></img>
|
||||
|
||||
@@ -1,52 +1,183 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
sidebar_position: 6
|
||||
title: Manage users
|
||||
---
|
||||
|
||||
# User Management
|
||||
# 👤 User Management
|
||||
|
||||
The **User Management** feature allows administrators to add, edit, and manage users within the OpenSign application. This feature is available on self-hosted, teams, and enterprise plans. Only users with "Admin" & "OrgAdmin" role are allowed to manage users.
|
||||
The **User Management** feature in OpenSign allows administrators to add, edit, and manage users within the platform. This functionality is available on **Self-Hosted**, **Teams**, and **Enterprise** plans.
|
||||
|
||||
## Accessing User Management
|
||||
|
||||
1. **Navigate to User management**
|
||||
- Go to the **Menu**.
|
||||
- Select **Settings**.
|
||||
- Click on **Users**.
|
||||
- A list of existing users will be displayed.
|
||||
|
||||
## Adding a New User
|
||||
|
||||
To add a new user:
|
||||
|
||||
1. **Click the "+" Button**
|
||||
- Located in the upper right corner of the user list.
|
||||
|
||||
2. **Fill in the User Information**
|
||||
- **Name** (required): Enter the user's full name.
|
||||
- **Email** (required): Enter the user's email address.
|
||||
- **Password**: A password is generated automatically. Copy it as it will only be displayed once.
|
||||
- **Phone** (optional): Enter the user's phone number.
|
||||
- **Team** (required): Select the team the user belongs to from the dropdown. Teams can be created only on the Teams & Enterprise plans.
|
||||
- **Role** (required): Select the user's role from the dropdown - OrgAdmin(Has all permissions including user management), Editor(Has all permissions other than user management like creating & sharing templates with teams, User(cannot manager users & cannot share templates with teams but can use templates features for themselves).
|
||||
|
||||

|
||||
|
||||
3. **Submit or Cancel**
|
||||
- Click **Submit** to add the user.
|
||||
- Click **Cancel** to discard the changes.
|
||||
|
||||
## Managing User Status
|
||||
|
||||
- **Toggling Active Status**
|
||||
- Use the "active" switch next to each user to enable or disable their account.
|
||||
> ✅ Only users with the roles **Admin** or **OrgAdmin** have permission to access and manage users.
|
||||
|
||||
---
|
||||
|
||||
For more information, visit our social media channels:
|
||||
- [Twitter](https://twitter.com/OpenSignHQ)
|
||||
- [Website](http://www.opensignlabs.com)
|
||||
- [Facebook](https://www.facebook.com/profile.php?id=61551030403669)
|
||||
- [LinkedIn](https://www.linkedin.com/company/opensignhq/)
|
||||
- [YouTube](https://www.youtube.com/@opensignhq)
|
||||
## 🧭 Accessing User Management
|
||||
|
||||
To access the user management panel:
|
||||
|
||||
1. Log in to your OpenSign account.
|
||||
2. In the left-hand sidebar, navigate to **Settings → Users**.
|
||||
|
||||
<img width="436" alt="Navigate-to-users" src="https://github.com/user-attachments/assets/9f34201c-fda7-406b-9a78-49a5459269cd"></img>
|
||||
|
||||
A list of existing users will be displayed.
|
||||
|
||||
---
|
||||
|
||||
## ➕ Adding a New User
|
||||
|
||||
To add a new user:
|
||||
|
||||
1. **Click the ➕ Add User Button**
|
||||
|
||||
2. **Fill in the User Information**
|
||||
|
||||
| Field | Required | Description |
|
||||
|--------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **Name** | ✅ Yes | Enter the user's full name. |
|
||||
| **Email** | ✅ Yes | Enter a valid email address. |
|
||||
| **Password** | ✅ Yes | The system auto-generates a password. **Copy it immediately** as it will be shown only once. |
|
||||
| **Phone** | ❌ No | (Optional) Enter the user’s phone number. |
|
||||
| **Team** | ✅ Yes | Select the team the user belongs to from the dropdown.<br />_Note: Teams must be created beforehand under **Settings → Teams** (available in Teams & Enterprise plans)._ |
|
||||
| **Role** | ✅ Yes | Choose one of the following roles: |
|
||||
| | | - **OrgAdmin**: Full access, including user and team management. |
|
||||
| | | - **Editor**: Can create and share templates but **cannot manage users**. |
|
||||
| | | - **User**: Can use templates for signing but **cannot share** them or manage users. |
|
||||
|
||||
<img width="436" alt="Add-user-form" src="https://github.com/user-attachments/assets/c176dd4f-257d-42e2-be7f-a05a1f7e4094"></img>
|
||||
|
||||
3. **Submit or Cancel**
|
||||
- Click **Submit** to create the user.
|
||||
- Click **Cancel** to exit without saving.
|
||||
|
||||
> 🔒 **Note:** Once a user is created, the password will not be visible again. If needed, you can use the **"Forgot Password"** option on the login page to reset it.
|
||||
|
||||
<img width="436" alt="new user" src="https://github.com/user-attachments/assets/647c40d8-061d-4e0a-b62c-302296e83493"></img>
|
||||
|
||||
---
|
||||
|
||||
## 🔁 Managing User Status
|
||||
|
||||
- **Activate/Deactivate Users**
|
||||
- Use the toggle in the **Active** column to enable or disable a user’s account.
|
||||
- **Deactivated users** will not be able to log in to OpenSign until reactivated.
|
||||
|
||||
---
|
||||
## 🔁 Delete Users
|
||||
|
||||
- OpenSign allows **admins** to delete users when needed.
|
||||
- Once a user is deleted, their account and all associated data are **permanently removed**. OpenSign does **not** keep deleted user records and restoration is **not possible**.
|
||||
- To delete a user:
|
||||
1. Click the **Delete** button next to the user you want to remove.
|
||||
2. A confirmation popup will appear.
|
||||
3. Enter the user’s 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**.
|
||||
|
||||
## 🔁 Change Password
|
||||
|
||||
- OpenSign allows **admins** to update a team user's password whenever required.
|
||||
|
||||
- **To change a user’s 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 user’s 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.
|
||||
|
||||
---
|
||||
|
||||
## 🔐 Permissions by Role
|
||||
|
||||
| Role | Manage Users | Create Templates | Share Templates with Teams | Use Templates |
|
||||
|-------------|---------------|------------------|-----------------------------|---------------|
|
||||
| **OrgAdmin** | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
|
||||
| **Editor** | ❌ No | ✅ Yes | ✅ Yes | ✅ Yes |
|
||||
| **User** | ❌ No | ✅ Yes | ❌ No | ✅ Yes |
|
||||
|
||||
---
|
||||
|
||||
## 👥 Buy More Users (Buy Additional Seats)
|
||||
|
||||
OpenSign allows you to create users based on the number of seats included in your selected plan. For example, if your current plan includes **2 users**, you can only create **2 users** by default. To add a **third user**, you must **purchase additional seats**.
|
||||
|
||||
### Steps to Buy More Users
|
||||
|
||||
1. **Click "Buy more users"**
|
||||
2. A popup titled **Add Seats** will appear.
|
||||
3. **Enter Quantity** – specify how many additional users (seats) you want to purchase.
|
||||
4. The **cost** will be calculated automatically based on your plan rate (e.g., USD 100 per user).
|
||||
5. Click the **Proceed** button to finalize the purchase.
|
||||
6. The seats will be **immediately added** to your account.
|
||||
|
||||
<img width="436" alt="buy-more-seats" src="https://github.com/user-attachments/assets/2e093a64-1b75-4543-b4c4-1186d4c02b09"></img>
|
||||
|
||||
7. Once you’ve purchased additional seats, click the **"+" Add User** button to create the new user.
|
||||
|
||||
> 💡 **Tip:** You can also purchase additional seats in advance to avoid interruptions during user onboarding.
|
||||
|
||||
---
|
||||
|
||||
### 🔢 Understanding "Available Seats"
|
||||
|
||||
At the bottom-right of the **Users** page, you’ll see the **Available seats** status.
|
||||
|
||||
<img width="436" alt="seat-availability" src="https://github.com/user-attachments/assets/37c2a5c7-0d4b-4bd2-8fb1-11def9e65b42"></img>
|
||||
|
||||
**Example:**
|
||||
`Available seats: 2/3`
|
||||
|
||||
This means:
|
||||
- **2 seats** are currently available for creating new users.
|
||||
- **3** is the **total number of user seats** your organization has purchased.
|
||||
|
||||
If the available seats count is **0**, you must **buy more seats** before adding new users.
|
||||
|
||||
---
|
||||
|
||||
## 📌 Frequently Asked Questions (FAQ)
|
||||
|
||||
**Q: How do I pay for purchased add-on users?**
|
||||
**A:** After purchasing additional users (seats), your saved card will be charged automatically, and an invoice will be emailed to your registered address.
|
||||
If no card is on saved, a payment link will be sent to your email to complete the transaction.
|
||||
|
||||
---
|
||||
|
||||
## 📣 Need Help?
|
||||
|
||||
If you need further assistance, feel free to reach out to our customer support at **support@opensignlabs.com**.
|
||||
|
||||
For more support and updates, follow us on:
|
||||
|
||||
- 🌐 [Website](http://www.opensignlabs.com)
|
||||
- 🐦 [Twitter](https://twitter.com/OpenSignHQ)
|
||||
- 📘 [Facebook](https://www.facebook.com/profile.php?id=61551030403669)
|
||||
- 💼 [LinkedIn](https://www.linkedin.com/company/opensignhq/)
|
||||
- 📺 [YouTube](https://www.youtube.com/@opensignhq)
|
||||
|
||||
---
|
||||
|
||||
Happy signing with **OpenSign™**!
|
||||
|
||||
@@ -29,6 +29,12 @@ After you have drawn your signature and initials or uploaded your signature imag
|
||||
|
||||
Once saved, these can be applied with a single click whenever you need to sign a document within the OpenSign application, streamlining your workflow and ensuring consistency in your document signing process.
|
||||
|
||||
## Uploading a Stamp Image
|
||||
|
||||
Click the Upload Image button next to the Stamp option to upload your stamp image. Once uploaded, the image will appear in the stamp image box and is ready to be saved. The uploaded stamp will be displayed during the document signing process.
|
||||
|
||||
<img width="820" alt="upload stamp" src="https://github.com/user-attachments/assets/232e4dfd-d305-4b62-ba69-668225287efc"></img>
|
||||
|
||||
## Getting Started
|
||||
**try OpenSign on cloud** at **[OpenSignLabs](https://app.opensignlabs.com)**.
|
||||
|
||||
|
||||
@@ -14,12 +14,12 @@ Creating a template in OpenSign is straightforward and can significantly enhance
|
||||
|
||||
- **Navigate to New template form**: On the left sidebar, click on "Templates" to expand the menu. and Click on the "Create template" option.
|
||||
|
||||
<img width="828" alt="Create Template" src="https://github.com/user-attachments/assets/1cb7610f-c144-4774-85c2-ed7d70e0a73c" />
|
||||
<img width="828" alt="Create Template" src="https://github.com/user-attachments/assets/143a752c-1ee3-4424-afe4-65922b71ddbb" />
|
||||
|
||||
### Uploading Your Document
|
||||
|
||||
- **[1] Choose File**: Once the "New template" page opens, click here to select and upload the document file from your computer that needs to be signed. Supported formats include PDF, PNG, JPG, JPEG, and DOCX.
|
||||
- **[2] Choose File from Dropbox**: Click the dropbox icon to select the document file from your dropbox account.
|
||||
- **[2] Choose File from Dropbox**: Click the Dropbox icon to select the document file from your Dropbox account.
|
||||
|
||||
### Entering Template Details
|
||||
|
||||
@@ -33,15 +33,47 @@ Creating a template in OpenSign is straightforward and can significantly enhance
|
||||
- **Yes**: Selecting this option will send the signing request to the first signer initially. Once the first signer completes their part, the next signer in the sequence will receive the request. This process continues until all signers have signed the document. This method ensures that the document is signed in a specific order.
|
||||
- **No**: Selecting this option will send the signing links to all signers simultaneously. Every signer can sign the document at their convenience, regardless of whether other signers have completed their signatures. This method is faster but does not enforce any signing order among the participants.
|
||||
Select the option that best suits the needs of your document processing.
|
||||
### Auto reminder (feature only avilable for the subscribed user)
|
||||
### Auto reminder (feature only available for subscribed users)
|
||||
- **[7]** Once you enable the auto reminder, a text field will appear allowing you to set the reminder for a specific number of days.
|
||||
- **Remind once in every (Days)**: Here, you can set the number of days for the reminder.
|
||||
### Security Setting
|
||||
- **[8] Enable OTP Verfication** :
|
||||
If set to "Yes," the signer will be required to complete email OTP verification before viewing and signing the document. If "Enable OTP Verification" is set to "No," the signer will not be prompted for OTP verification during the signing process.
|
||||
- **Remind once in every (Days)**: Here, you can set the number of days for the reminder.
|
||||
|
||||
- **[9] Enable tour**:
|
||||
If set to "Yes," the signer will see the tour guide while signing the document. If your signer is familiar with OpenSign and you prefer not to display the tour guide, you can select "No," and the tour guide will not be shown to your signers.
|
||||
Note: You can set a maximum of 15 reminders. For example, if the document completion time is 16 days and you try to schedule a reminder every day, the system will not allow it, as the reminder limit would be exceeded.
|
||||
|
||||
### Time to complete (days)
|
||||
- **[8]** You can specify the number of days within which the document must be signed. For example, if you set the expiration period to 15 days, the created document will remain available for signing for 15 days from the date of creation. After this period, the document will expire, and the signer will no longer be able to sign it.
|
||||
|
||||
### BCC
|
||||
- **[9]** The BCC (Blind Carbon Copy) feature allows users to receive document completion emails at specified email addresses.
|
||||
You can add multiple contacts in the BCC field to notify several recipients.
|
||||
You can either:
|
||||
Click "Add New" to enter a new email contact, or
|
||||
Select from existing contacts using the dropdown list.
|
||||
|
||||
### Security Setting
|
||||
- **[10] Enable OTP Verification** :
|
||||
|
||||
If set to "Yes," the signer will be required to complete email OTP verification before viewing and signing the document. If "Enable OTP Verification" is set to "No," the signer will not be prompted for OTP verification during the signing process.
|
||||
Note: This feature is available exclusively on paid plans.
|
||||
|
||||
### Enable tour:
|
||||
|
||||
- **[11]** If set to "Yes," the signer will see the tour guide while signing the document. If your signer is familiar with OpenSign and you prefer not to display the tour guide, you can select "No," and the tour guide will not be shown to your signers.
|
||||
|
||||
### Notify on signatures:
|
||||
|
||||
- **[12]** If set to "Yes," the document owner will receive an email notification each signer completes their signature.
|
||||
Note: This feature is available exclusively on paid plans.
|
||||
|
||||
### Allow modifications:
|
||||
|
||||
- **[13]** If set to Yes, the signer will be allowed to make modifications to the document during the signing process. However, they cannot edit or remove any fields that were already placed by the document owner. They can only add basic fields such as signature, stamp, initials, text, and cells.
|
||||
|
||||
If both Allow Modification and Enable OTP are set to Yes, the signer will still not be able to edit or delete existing fields, but will gain access to additional advanced fields to add during signing. These include: signature, stamp, initials, name, job title, company, text, cells, and email.
|
||||
|
||||
Note: This feature is available exclusively on paid plans.
|
||||
|
||||
### Redirect url:
|
||||
- **[14]** After signing the document and upon its completion, the signer will be redirected to the specified URL.
|
||||
|
||||
### Proceed to Template Creation Panel
|
||||
- **Next**: Click the "Next" button to proceed to the next stage of template creation, where you can add widgets and finalize the template.
|
||||
@@ -49,12 +81,46 @@ If set to "Yes," the signer will see the tour guide while signing the document.
|
||||
## Step 2:
|
||||
### Template creation
|
||||
|
||||
<img width="828" alt="Create Template" src="https://github.com/user-attachments/assets/986a0068-e711-4367-91b6-349dc1db8c43" />
|
||||
### Prefill Widgets
|
||||
|
||||
- **[1] Define Roles**:
|
||||
- **Add Roles**: In the roles section on the right, click "+ Add role" to specify the roles involved in the document, such as Candidate, HR, and Manager.
|
||||
- **[2] Assign Widgets to Roles**: Click on each role to highlight it, then drag and drop the widget to assign it to that role.
|
||||
- **[1] Assign signature widget**: Select the Role from the right side panel, click on the signature widget, and position it where the signature is required. You can place multiple signature widgets for each Role, as required.
|
||||
The **Prefill Widgets** feature lets document creators prefill specific fields before sending a document for signature. This ensures that important details (such as date, name, email, images, checkboxes, radio buttons, or custom text) are already completed when recipients receive the document. By default, prefilled data cannot be edited by signers.
|
||||
|
||||
<img width="800" alt="Prefill" src="https://github.com/user-attachments/assets/6400469f-1c7e-4eda-b170-fa5b4ce9ebce" />
|
||||
|
||||
---
|
||||
|
||||
**✨ Key Benefits**
|
||||
- ✅ Save time by auto-filling repetitive information.
|
||||
- ✅ Ensure accuracy for critical fields (e.g., company name, contract number).
|
||||
- ✅ Maintain consistency across multiple signers and templates.
|
||||
- ✅ Reduce signer effort for a smoother signing experience.
|
||||
|
||||
**🛠️ How It Works**
|
||||
1. **Add Widgets to the Document**
|
||||
- Open the right-side panel, select **Prefill Widgets**, then drag and drop the required widgets (Text, Date, Checkbox, Dropdown, Image, etc.) onto the document.
|
||||
|
||||
2. **Enter Prefill Value**
|
||||
- Provide the default value (e.g., *"Company: OpenSign Labs"*, *Date: 30/09/2025*).
|
||||
- For option-based widgets (Dropdown, Radio, Checkbox), choose the option to be prefilled.
|
||||
|
||||
**📋 Supported Widgets for Prefill**
|
||||
- **Text Field** – Names, job titles, company names, contract IDs
|
||||
- **Date Field** – Default signing date or contract start date
|
||||
- **Dropdown** – Preselect an option
|
||||
- **Radio Button** – Prefill with a selected choice
|
||||
- **Checkbox** – Prefill as checked or unchecked
|
||||
- **Image** – Insert a default image (e.g., logo or stamp)
|
||||
|
||||
|
||||
### [1] Define roles and assign widgets:
|
||||
|
||||
<img width="828" alt="Create Template" src="https://github.com/user-attachments/assets/9305bf0b-02d4-4110-bbbf-6496c9fd6f65" />
|
||||
|
||||
**Add Roles**: In the roles section on the right, click "+ Add role" to specify the roles involved in the document, such as Candidate, HR, and Manager.
|
||||
**Assign Widgets to Roles**: Click on each role to highlight it, then drag and drop the widget to assign it to that role.
|
||||
- **[1] Assign signature widget**: The signature widget is used to add a signature to the document. Each role must have at least one signature widget assigned.
|
||||
|
||||
Select the Role from the right side panel, click on the signature widget, and position it where the signature is required. You can place multiple signature widgets for each Role, as required.
|
||||
|
||||
After placing the Signature widget, you will see the options on the widget such as:
|
||||
- **Add Signer/Change Signer**: Clicking the first icon on the signature widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
@@ -64,63 +130,195 @@ If set to "Yes," the signer will see the tour guide while signing the document.
|
||||
- All pages but first: It will copy the signature widget to all pages except the first page.
|
||||
|
||||
- **[2] Add other widgets**: Depending on your needs, you can include additional widgets such as:
|
||||
- **Stamp**: After placing the Stamp widget, you will see the options on the widget such as:
|
||||
- **Stamp**: The stamp widget allows signers to add a stamp to the document. Signers can upload their stamp during the signing process.
|
||||
After placing the Stamp widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can specify whether this widget is mandatory or optional during the document signing.
|
||||
- Add Signer/Change Signer: Clicking the second option on the stamp widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy Stamp: Clicking on this option reveals the following choices.
|
||||
- All pages : It will copy the stamp widget to all pages.
|
||||
- All pages but last: It will copy the stamp widget to all pages except the last page.
|
||||
- All pages but first: It will copy the stamp widget to all pages except the first page.
|
||||
- **Initials**: After placing the Initials widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can specify whether this widget is mandatory or optional during the document signing.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Initials widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy Initials: Clicking on this option reveals the following choices.
|
||||
- All pages : It will copy the stamp widget to all pages.
|
||||
- All pages but last: It will copy the stamp widget to all pages except the last page.
|
||||
- All pages but first: It will copy the stamp widget to all pages except the first page.
|
||||
- **Name**: After placing the name widget, you will see the options on the widget such as:
|
||||
- **Initials**: The initials widget allows signers to add their initials to the document. During the signing process, signers can draw, upload, or type their initials. After placing the Initials widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can specify whether this widget is mandatory or optional during the document signing.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Initials widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy Initials: Clicking on this option reveals the following choices.
|
||||
- All pages : It will copy the initials widget to all pages.
|
||||
- All pages but last: It will copy the initials widget to all pages except the last page.
|
||||
- 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 ducplicate the name widget.
|
||||
- **Job title**: After placing the job title widget, you will see the options on the widget such as:
|
||||
- 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 ducplicate the job title widget.
|
||||
- Copy : Clicking on this you can duplicate the job title widget.
|
||||
|
||||
- **Company**: After placing the company widget, you will see the options on the widget such as:
|
||||
- **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 ducplicate the Company widget.
|
||||
- **Date**: 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 ducplicate the date widget.
|
||||
- **Text**: 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 ducplicate the Text widget.
|
||||
- Copy : Clicking on this you can duplicate the Company widget.
|
||||
|
||||
- **Date Widget**
|
||||
|
||||
The **Date widget** allows signers to enter a date while signing the document. Once the widget is placed, you can configure its behavior using the available settings in the **Widget Info** panel.
|
||||
|
||||
#### ⚙️ Widget Options
|
||||
|
||||
- **Date Format**: Choose the preferred date format (for example, `MM/dd/yyyy`, `dd-mm-yyyy`, or `dd/mm/yyyy`) from the Format dropdown. This determines how the date appears to the signer.
|
||||
- **Set Date**: This option allows the user to set a default date, which will be displayed while signing the document.
|
||||
- **Signing Date**: When selected, the date on which the signer signs the document will be automatically displayed in the Date widget.
|
||||
- **Clear**: Removes the selected date setting.
|
||||
|
||||
- **Date Range**
|
||||
- **Min Date**: Sets the earliest date the signer can select.
|
||||
- **Max Date**: Sets the latest date the signer can select.
|
||||
- Use **Clear** to remove the minimum or maximum date restrictions.
|
||||
|
||||
- **Required / Optional**
|
||||
Mark the widget as **Required** if the signer must fill it in before completing the signing, or **Optional** if it is not mandatory.
|
||||
|
||||
- **Font Settings**
|
||||
Customize the **font size** and **text color** to match the document’s style.
|
||||
|
||||
- **Read Only**
|
||||
Enable this option to display a date that cannot be edited by the signer.
|
||||
|
||||
- **Save**
|
||||
Click **Save** to apply all selected settings to the Date widget.
|
||||
|
||||
- **Text Input**: After placing the Text Input 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.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Text Input 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 ducplicate the Text Input widget.
|
||||
- **Checkbox**: Once you drop the checkbox widget, a popup will open where you can set the checkbox name and options. Additionally, there is few optiona available like you can set Minimum check, maximum check also whether this check box is readonly also hide label option.
|
||||
- **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:
|
||||
- Choosing a **font color**
|
||||
- Setting the **font size**
|
||||
- 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**
|
||||
- Custom JavaScript validations using regular expressions
|
||||
For example:
|
||||
- `^\d+$` – allows only digits
|
||||
- `^[A-Z]+$` – allows only uppercase letters
|
||||
|
||||
You can enter your regex pattern in the **Validations** field of the widget.
|
||||
*(Optional reference: [JavaScript RegExp guide](https://www.w3schools.com/jsref/jsref_obj_regexp.asp))*
|
||||
|
||||
<img width="800" alt="Cells widget" src="https://github.com/user-attachments/assets/ce0c335b-b2bf-4d30-968c-c4c957f46014" />
|
||||
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Text Input 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 Text Input widget.
|
||||
|
||||
- **Cells**
|
||||
The **Cells widget** is ideal for documents that require input in a structured, table-like format, allowing the signer to fill in details within individual cells. After dragging and dropping the widget onto the document, you can adjust the number of cells by moving the **blue marker**.
|
||||
|
||||
<img width="800" alt="Cells widget" src="https://github.com/user-attachments/assets/20184017-2fa9-4acb-985f-fde18ee53246" />
|
||||
|
||||
- Setting icon: The widget settings panel provides additional customization options, including:
|
||||
- Manually entering the **number of cells**
|
||||
- Choosing a **font color**
|
||||
- Setting the **font size**
|
||||
- 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**
|
||||
- Custom JavaScript validations using regular expressions
|
||||
- For example:
|
||||
- `^\d+$` – allows only digits
|
||||
- `^[A-Z]+$` – allows only uppercase letters
|
||||
|
||||
You can enter your regex pattern in the **Validations** field of the widget.
|
||||
*(Optional reference: [JavaScript RegExp guide](https://www.w3schools.com/jsref/jsref_obj_regexp.asp))*
|
||||
|
||||
<img width="800" alt="request signatures" src="https://github.com/user-attachments/assets/100579af-a12f-4c90-8cad-1db697db1f1c" />
|
||||
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Cells 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 cells widget.
|
||||
|
||||
- **Checkbox**: The checkbox widget is used to capture input in the form of a checkbox selection.
|
||||
Once you drop the checkbox widget, a popup will open where you can set the checkbox name and options. Additionally, there are a few options available such as setting the minimum and maximum checks, making the checkbox read-only, and hiding the label.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the CheckBox 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 ducplicate the image widget.
|
||||
- **Dropdown**: Once you drop the dropdown widget, a popup will open where you can set the dropdown name and options. Additionally, there is few option available like you can set default value, also whether this dropdown is required or optional.
|
||||
- Copy : Clicking on this you can duplicate the dropdown widget.
|
||||
- **Dropdown**: Once you drop the dropdown widget, a popup will open where you can set the dropdown name and options. Additionally, there are a few options available such as setting a default value and marking the dropdown as required or optional.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Dropdown 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 ducplicate the image widget.
|
||||
- **Radio button**: Once you drop the radio button widget, a popup will open where you can set the radio button name and options. Additionally, there is few option available like you can set default value, also whether this radio button is readonly also hide label option.
|
||||
- Copy : Clicking on this you can duplicate the dropdown widget.
|
||||
- **Radio button**: The radio button widget is used to capture input in the form of a radio button selection.
|
||||
Once you drop the radio button widget, a popup will open where you can set the radio button name and options. Additionally, there are a few options available such as setting a default value, making the radio button read-only, and hiding the label.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Radio button 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 ducplicate the image widget.
|
||||
- **Image**: After placing the Image widget, you will see the options on the widget such as:
|
||||
- Copy : Clicking on this you can duplicate the radio button widget.
|
||||
- **Image**: The image widget allows signers to upload an image during the signing process.
|
||||
After placing the Image widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can specify whether this widget is mandatory or optional during the document signing.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Image 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 ducplicate the image widget.
|
||||
- **Email**: After placing the email widget, you will see the options on the widget such as:
|
||||
- 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.
|
||||
|
||||
### 📄 Edit Template
|
||||
At the top of the Create Template panel, you’ll find a settings (gear) icon. Clicking this icon opens the Edit Template Details panel, where you can modify various details of your template.
|
||||
|
||||
<img width="800" alt="edit template details" src="https://github.com/user-attachments/assets/161d41fd-bf07-485e-ab7b-5b33e0c500bf" />
|
||||
|
||||
- **🔁 File Replacement** : Users can replace the existing document by simply uploading a new file. However, certain conditions must be met:
|
||||
- The new document must have the same number of pages.
|
||||
- The page dimensions (width and height) must be identical to the original.
|
||||
|
||||
These conditions are enforced to ensure that, during template editing, the pre-placed widgets remain correctly aligned. If the new document's dimensions don’t match, widgets may shift or be positioned outside the visible area of the document.
|
||||
|
||||
<img width="800" alt="Edit template details" src="https://github.com/user-attachments/assets/f03b76d3-6480-4d4b-b310-9f3f4a3acf4c" />
|
||||
|
||||
You can also update the following template details:
|
||||
- **Template Title**
|
||||
- **Description**
|
||||
- **Note**
|
||||
- **Send in Order**
|
||||
- **Auto reminder**
|
||||
- **Enable OTP Verification** :
|
||||
- **Enable tour**:
|
||||
- **Notify on signatures**:
|
||||
- **BCC**:
|
||||
- **Redirect Url**
|
||||
- **Time to complete (Days)**
|
||||
Clik on the submit button to save the edits.
|
||||
|
||||
### 📄 Document Page Controls
|
||||
- **Add Pages**
|
||||
In the left-side panel, users will see an **"Add" button**. Clicking it allows users to select and merge new documents into the current one.
|
||||
|
||||
- **Delete Page**
|
||||
An option is available to **delete** any unwanted page from the document.
|
||||
|
||||
- **Reorder Pages**
|
||||
Users can reorder pages by clicking the **"Reorder" button**, which opens a popup displaying all pages. Use the **Up** and **Down** arrows to change the order. Click **Save** to apply the new page order.
|
||||
|
||||
- **Zoom In / Zoom Out**
|
||||
Controls are available to **zoom in** or **zoom out** of the document view.
|
||||
|
||||
- **Rotate Page**
|
||||
Options are provided to **rotate pages** in both **clockwise** and **counterclockwise** directions.
|
||||
|
||||
<img width="918" alt="page controls" src="https://github.com/user-attachments/assets/71e9873b-d8e1-4a01-b0a4-88f9a62b2be4" />
|
||||
|
||||
### Save Template
|
||||
**Next button**: Once you’ve organized your widgets and set their properties, simply click the “Next” button to save your template.
|
||||
|
||||
@@ -130,44 +328,13 @@ After doing so, a “Create document” popup will appear, prompting you with th
|
||||
|
||||
**If you select "No"**: You will be redirected to the Manage templates form.
|
||||
|
||||
## Step 3:
|
||||
### Viewing and Managing Templates
|
||||
## Step 3:
|
||||
### Viewing and Managing Templates
|
||||
|
||||
<img width="828" alt="Manage Template" src="https://github.com/user-attachments/assets/06b80221-5c42-451c-af03-44cc12e6aa2d" />
|
||||
The **Manage Templates** page displays all the templates you’ve created or have access to. Each template entry shows key details including the template title, file, owner, assigned signers, and its public/private status.
|
||||
|
||||
On the Manage templates page you will see a list of templates you have created or have access to. The list includes details such as the template title, file, owner, signers, and whether the template is public.
|
||||
|
||||
**Download Template**: If you need to download the template file, click on the "Download" link under the "File" column next to the respective template.
|
||||
|
||||
**View Signers**: This will display the roles or the list of signers along with their assigned roles, if assigned during template creation.
|
||||
|
||||
**Public/Private Toggle**: You can set your template to public or private by toggling the switch under the "Public" column. Public templates can be accessed by anyone via the public URL, allowing them to open and sign the document after registering.
|
||||
|
||||
**Use Template**: To use a template, click the "+ USE" button next to the desired template. This will open the template, enabling you to create a document for a signature request. Simply assign the signers and send it for signatures.
|
||||
|
||||
**Quick Send**: For faster processing, the Quick Send feature allows you to swiftly create and send a document to a signer using the selected template.
|
||||
|
||||
**Edit**: The "Edit" feature is crucial for keeping your document templates up-to-date and relevant. Whether you need to make minor tweaks or major changes, OpenSign's editing capabilities are user-friendly and efficient.
|
||||
Click on the three dots next to the template you want to edit.
|
||||
Select "Edit." Make the necessary changes and save them.
|
||||
|
||||
**Share With Team**: Collaboration is essential for any successful team, and OpenSign simplifies sharing document templates with your team. Here's how you can utilize the "Share With Team" feature:
|
||||
Click on the three dots next to the template you want to share.
|
||||
Select "Share With Team."
|
||||
|
||||
**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.
|
||||
|
||||
<img width="828" alt="Embed" src="https://github.com/user-attachments/assets/05dcaf5d-07b0-4069-bcd5-83e2daf71e29" />
|
||||
|
||||
**Copy template id**: This action copies the unique ID associated with the template, which is useful for embedding or sharing with public users when your template is set to public.
|
||||
|
||||
**Copy public URL**: This generates a public link for the template, allowing external users to access it without logging into OpenSign.
|
||||
Click "Copy Public URL" to generate the link, then share it as needed.
|
||||
|
||||
**Delete**: Sometimes, it's necessary to clean up your templates to keep your workspace organized. The "Delete" feature allows you to remove outdated or unnecessary templates with ease.
|
||||
Click on the three dots next to the template you want to delete.
|
||||
Select "Delete." Confirm the deletion.
|
||||
For a full walkthrough, check the detailed guide here:
|
||||
[Manage Templates](https://docs.opensignlabs.com/docs/help/Templates/manage-templates)
|
||||
|
||||
## Additional Information
|
||||
- The fields with an asterisk (*) are mandatory.
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
sidebar_position: 6
|
||||
title: Embedding OpenSign templates
|
||||
---
|
||||
import ReactPlayer from 'react-player';
|
||||
|
||||
@@ -0,0 +1,89 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: Manage Templates
|
||||
---
|
||||
|
||||
### Viewing and Managing Templates
|
||||
|
||||
On the Manage templates page you will see a list of templates you have created or have access to. The list includes details such as the template title, file, owner, signers, and whether the template is public.
|
||||
|
||||
<img width="828" alt="Manage Template" src="https://github.com/user-attachments/assets/06b80221-5c42-451c-af03-44cc12e6aa2d" />
|
||||
|
||||
**Download Template**: If you need to download the template file, click on the "Download" link under the "File" column next to the respective template.
|
||||
|
||||
**View Signers**: This will display the roles or the list of signers along with their assigned roles, if assigned during template creation.
|
||||
|
||||
**Public/Private Toggle**: You can set your template to public or private by toggling the switch under the "Public" column. Public templates can be accessed by anyone via the public URL, allowing them to open and sign the document after registering.
|
||||
|
||||
**Use Template**: To use a template, click the "+ USE" button next to the desired template. This will open the template, enabling you to create a document for a signature request. Simply assign the signers and send it for signatures.
|
||||
|
||||
**Bulk send**: This feature streamlines processing by allowing you to create and send multiple documents at once using a selected template. You can add multiple signers and generate all documents with a single click.
|
||||
|
||||
**Edit**: The "Edit" feature is crucial for keeping your document templates up-to-date and relevant. Whether you need to make minor tweaks or major changes, OpenSign's editing capabilities are user-friendly and efficient.
|
||||
Click on the three dots next to the template you want to edit.
|
||||
Select "Edit." Make the necessary changes and save them.
|
||||
|
||||
**Share With Team**: Collaboration is crucial for any successful workflow, and OpenSign makes it easy to share document templates with your team.
|
||||
- Click the three dots next to the template you wish to share.
|
||||
- Select "Share with Team" from the menu.
|
||||
- Choose the desired team from the list and click Submit.
|
||||
|
||||
The selected team members will now have access to the template and can use it to create documents.
|
||||
|
||||
Note: Team members will have view and usage-only access to the shared template — they cannot edit or delete it.
|
||||
This feature is available exclusively on Teams and Enterprise plans.
|
||||
|
||||
**Share With colleague**: OpenSign also allows you to share templates with individual colleagues for efficient collaboration.
|
||||
- Click the three dots next to the template you wish to share.
|
||||
|
||||
- Select "Share with Colleague" from the menu.
|
||||
|
||||
- Choose the user from the list and click Submit.
|
||||
|
||||
The selected user will be able to access the template and create documents from it.
|
||||
|
||||
Note: The user will have permission only to use the template. They cannot edit or delete it.
|
||||
This feature is available exclusively on Teams and Enterprise plans.
|
||||
|
||||
<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.
|
||||
|
||||
<img width="828" alt="Embed" src="https://github.com/user-attachments/assets/05dcaf5d-07b0-4069-bcd5-83e2daf71e29" />
|
||||
|
||||
**Copy template id**: This action copies the unique ID associated with the template, which is useful for embedding or sharing with public users when your template is set to public.
|
||||
|
||||
**Copy public URL**: This generates a public link for the template, allowing external users to access it without logging into OpenSign.
|
||||
Click "Copy Public URL" to generate the link, then share it as needed.
|
||||
|
||||
**Kiosk Mode**: Kiosk Mode offers a simplified and secure environment for signers to complete documents on a shared or public device. It's ideal for use cases like front-desk sign-ins, in-office document execution, or on-site registrations where multiple individuals need to sign documents one after another.
|
||||
|
||||
When you click the Kiosk Mode option along with a selected template, the document opens in a dedicated signing interface. Signers can then complete their portions sequentially on the same screen and device, ensuring a smooth and efficient signing flow without requiring individual logins.
|
||||
Note: This feature is available exclusively on Teams and Enterprise plans.
|
||||
|
||||
**Duplicate**: When you need to create a copy of an existing template, use the Duplicate option. This feature allows you to quickly generate an exact replica of the selected template, making it easy to reuse and modify without affecting the original.
|
||||
|
||||
**Delete**: Sometimes, it's necessary to clean up your templates to keep your workspace organized. The "Delete" feature allows you to remove outdated or unnecessary templates with ease.
|
||||
Click on the three dots next to the template you want to delete.
|
||||
Select "Delete." Confirm the deletion.
|
||||
|
||||
## Additional Information
|
||||
- The fields with an asterisk (*) are mandatory.
|
||||
- Make sure your document is in PDF, PNG, JPG, JPEG, or DOCX format.
|
||||
- You can access your signed documents in the folder you've selected by visiting OpenSign™ Drive anytime. You can also access the documents from reports section.
|
||||
|
||||
If you require more help, feel free to reach out to our customer support on support@opensignlabs.com.
|
||||
|
||||
Happy signing with OpenSign™!
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
sidebar_position: 5
|
||||
title: Setting up an OpenSign template for public signing
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
sidebar_position: 4
|
||||
title: Quickly Send the Document for Signature Using Template
|
||||
---
|
||||
|
||||
@@ -9,35 +9,74 @@ title: Quickly Send the Document for Signature Using Template
|
||||
|
||||
- **Navigate to New template form**: On the left sidebar, click on "Templates" to expand the menu. and Click on the "Create template" option.
|
||||
|
||||
<img width="828" alt="Create Template" src="https://github.com/user-attachments/assets/fe7b0bd0-bb45-4f64-8450-83ffb5c3d7fc" />
|
||||
<img width="828" alt="Create Template" src="https://github.com/user-attachments/assets/143a752c-1ee3-4424-afe4-65922b71ddbb" />
|
||||
|
||||
### Step 2: Uploading Your Document
|
||||
### Uploading Your Document
|
||||
|
||||
- **[1] Choose File**: Once the "New template" page opens, click here to select and upload the document file from your computer that needs to be signed. Supported formats include PDF, PNG, JPG, JPEG, and DOCX.
|
||||
- **[2] Choose File from Dropbox**: Click the dropbox icon to select the document file from your dropbox account.
|
||||
- **[2] Choose File from Dropbox**: Click the Dropbox icon to select the document file from your Dropbox account.
|
||||
|
||||
### Step 3: Entering Template Details
|
||||
### Entering Template Details
|
||||
|
||||
- **[3] Title** *(Required)*: Provide a title for your template. For example, "Demo Custom Template."
|
||||
- **[4] Description**: Optionally add a description to give context or instructions regarding the template.
|
||||
- **[5] Note**: Optionally add a note to give context or instructions regarding the document.
|
||||
|
||||
### Step 4: Set the sending order
|
||||
### Set the sending order
|
||||
- **[6] Send in Order**
|
||||
- **If you choose:**
|
||||
- **Yes**: Selecting this option will send the signing request to the first signer initially. Once the first signer completes their part, the next signer in the sequence will receive the request. This process continues until all signers have signed the document. This method ensures that the document is signed in a specific order.
|
||||
- **No**: Selecting this option will send the signing links to all signers simultaneously. Every signer can sign the document at their convenience, regardless of whether other signers have completed their signatures. This method is faster but does not enforce any signing order among the participants.
|
||||
Select the option that best suits the needs of your document processing.
|
||||
### Step 5: Auto reminder (feature only avilable for the subscribed user)
|
||||
### Auto reminder (feature only available for subscribed users)
|
||||
- **[7]** Once you enable the auto reminder, a text field will appear allowing you to set the reminder for a specific number of days.
|
||||
- **Remind once in every (Days)**: Here, you can set the number of days for the reminder.
|
||||
- **Remind once in every (Days)**: Here, you can set the number of days for the reminder.
|
||||
|
||||
Note: You can set a maximum of 15 reminders. For example, if the document completion time is 16 days and you try to schedule a reminder every day, the system will not allow it, as the reminder limit would be exceeded.
|
||||
|
||||
### Step 6: Proceed to Template Creation Panel
|
||||
### Time to complete (days)
|
||||
- **[8]** You can specify the number of days within which the document must be signed. For example, if you set the expiration period to 15 days, the created document will remain available for signing for 15 days from the date of creation. After this period, the document will expire, and the signer will no longer be able to sign it.
|
||||
|
||||
### BCC
|
||||
- **[9]** The BCC (Blind Carbon Copy) feature allows users to receive document completion emails at specified email addresses.
|
||||
You can add multiple contacts in the BCC field to notify several recipients.
|
||||
You can either:
|
||||
Click "Add New" to enter a new email contact, or
|
||||
Select from existing contacts using the dropdown list.
|
||||
|
||||
### Security Setting
|
||||
- **[10] Enable OTP Verification** :
|
||||
|
||||
If set to "Yes," the signer will be required to complete email OTP verification before viewing and signing the document. If "Enable OTP Verification" is set to "No," the signer will not be prompted for OTP verification during the signing process.
|
||||
Note: This feature is available exclusively on paid plans.
|
||||
|
||||
### Enable tour:
|
||||
|
||||
- **[11]** If set to "Yes," the signer will see the tour guide while signing the document. If your signer is familiar with OpenSign and you prefer not to display the tour guide, you can select "No," and the tour guide will not be shown to your signers.
|
||||
|
||||
### Notify on signatures:
|
||||
|
||||
- **[12]** If set to "Yes," the document owner will receive an email notification each signer completes their signature.
|
||||
Note: This feature is available exclusively on paid plans.
|
||||
|
||||
### Allow modifications:
|
||||
|
||||
- **[13]** If set to Yes, the signer will be allowed to make modifications to the document during the signing process. However, they cannot edit or remove any fields that were already placed by the document owner. They can only add basic fields such as signature, stamp, initials, text, and cells.
|
||||
|
||||
If both Allow Modification and Enable OTP are set to Yes, the signer will still not be able to edit or delete existing fields, but will gain access to additional advanced fields to add during signing. These include: signature, stamp, initials, name, job title, company, text, cells, and email.
|
||||
|
||||
Note: This feature is available exclusively on paid plans.
|
||||
|
||||
### Redirect url:
|
||||
- **[14]** After signing the document and upon its completion, the signer will be redirected to the specified URL.
|
||||
|
||||
### Proceed to Template Creation Panel
|
||||
- **Next**: Click the "Next" button to proceed to the next stage of template creation, where you can add widgets and finalize the template.
|
||||
- **Cancel**: If you need to start over or make changes, click Cancel button to clear the form.
|
||||
### Step 7: Template creation
|
||||
## Step 2:
|
||||
### Template creation
|
||||
|
||||
<img width="828" alt="Create Template" src="https://github.com/user-attachments/assets/986a0068-e711-4367-91b6-349dc1db8c43" />
|
||||
<img width="828" alt="Create Template" src="https://github.com/user-attachments/assets/cad2a0ee-c3be-4569-a5ae-d1114ea6a853" />
|
||||
|
||||
- **[1] Define Roles**:
|
||||
- **Add Roles**: In the roles section on the right, click "+ Add role" to specify the roles involved in the document, such as Candidate, HR, and Manager.
|
||||
@@ -53,26 +92,25 @@ Select the option that best suits the needs of your document processing.
|
||||
- **[2] Add other widgets**: Depending on your needs, you can include additional widgets such as:
|
||||
Stamps, Initials, Name, Date, Text, Checkbox, and more.
|
||||
|
||||
### Step 8: Save Template
|
||||
### Step 3: Save Template
|
||||
**Next button**: Once you’ve organized your widgets and set their properties, simply click the “Next” button to save your template.
|
||||
|
||||
After doing so, a “Create Document” popup will appear, prompting you with the question: “Do you want to create a document using the template you just created?” You’ll have the option to choose either “Yes” or “No.”
|
||||
**If you select "Yes"**: It will create a document using the template you just created.
|
||||
**If you select "No"**: You will be redirected to the Manage templates form.
|
||||
After creating a template, a “Create Document” popup will appear with the prompt:
|
||||
“What would you like to do with the template you just created?”
|
||||
|
||||
### Step 9: Viewing and Managing Templates
|
||||
You’ll be presented with the following options: Use Template, Bulk Send, Embed, and Copy Public URL.
|
||||
|
||||
<img width="828" alt="Manage Template" src="https://github.com/user-attachments/assets/86bf3628-987d-4ae2-89c3-b24ec1f6bdc2" />
|
||||
- Click Bulk Send to open a popup for selecting signers.
|
||||
- Assign signers to the roles displayed in the popup. You can create multiple documents by clicking the Add New button to add more signers. Once all signers are added, click Send.
|
||||
- Request signature emails will be sent to the respective signers, and the documents will be created and listed under the In Progress Documents report.
|
||||
|
||||
On the Manage Templates page, you'll see a list of templates you've created or have access to. This list provides details such as the template title, file, owner, signers, and whether the template is public. You’ll also find actions like "Use Template," "Quick Send," "Edit," "Delete," and more.
|
||||
### Step 4: Bulk Send from Manage Templates
|
||||
For faster processing, the Bulk Send feature allows you to swiftly create and send a document to a signer using the selected template.
|
||||
|
||||
### Step 10: Quick Send
|
||||
For faster processing, the Quick Send feature allows you to swiftly create and send a document to a signer using the selected template.
|
||||
|
||||
<img width="828" alt="Manage Template" src="https://github.com/user-attachments/assets/02334ff3-eab6-4a11-aba2-d95a5cba2935" />
|
||||
<img width="828" alt="Manage Template" src="https://github.com/user-attachments/assets/8eed5a30-8f67-4b58-bc3d-2a8fed9a1299" />
|
||||
|
||||
How to Send the Document:
|
||||
- Click the Quick Send button next to the template in the list.
|
||||
- Click the Bulk Send button next to the template in the list.
|
||||
|
||||
- A popup will open where you can assign signers to each role by simply adding their email addresses.
|
||||
|
||||
@@ -80,9 +118,18 @@ How to Send the Document:
|
||||
|
||||
After adding the signers, click the Send button. This will generate the document and send an email to the signers with a signature request.
|
||||
|
||||
## Signers Signing Process
|
||||
### Step 11: Email OTP verification
|
||||
Once the email is received, the signer can click the 'Sign Here' button. This will open the email verification page. After clicking the 'Get Verification Code' button, an OTP (one-time password) will be sent to the signer’s email address. Enter the received OTP into the verification textbox and click the 'Verify' button.
|
||||
### Step 5: Signers Signing Process
|
||||
|
||||
- Enable OTP Verification: No
|
||||
|
||||
If OTP verification is set to No, the signer can access and sign the document directly without email verification.
|
||||
Once the signer clicks the signature request link received via email, the document will load immediately, allowing them to sign without entering any OTP.
|
||||
|
||||
- Enable OTP Verification: Yes
|
||||
|
||||
If OTP verification is enabled, the signer must complete email verification before signing.
|
||||
After receiving the email, the signer should click the ‘Sign Here’ button. This will open the email verification screen.
|
||||
Click ‘Get Verification Code’ to receive an OTP via email. Enter the OTP into the textbox and click ‘Verify’. Once verified, the document will open and the signer can proceed to sign.
|
||||
|
||||
<div>
|
||||
<img width="800" alt="OpenSign send OTP" src="https://github.com/user-attachments/assets/b82c796a-98e3-4296-bde1-fe86b1b993ad" />
|
||||
@@ -91,20 +138,22 @@ Once the email is received, the signer can click the 'Sign Here' button. This wi
|
||||
<img width="800" alt="OpenSign verify otp" src="https://github.com/user-attachments/assets/63cf4b75-9d47-4630-a83c-e916a5c13b3c" />
|
||||
</div>
|
||||
|
||||
### Step 12: Finalizing the Process:
|
||||
### Step 6: Finalizing the Process:
|
||||
|
||||
After verification, the signer will be redirected to the document signing page, where he can view the document received for signing. To sign, the signer simply clicks on the signature widget, which allows them to draw, upload a digitally scanned signature, or type the signature.
|
||||
To sign the document, the signer simply clicks on the signature widget, which provides options to draw, upload a scanned signature, or type their name.
|
||||
|
||||
After filling out all assigned widgets, click the 'Finish' button. Once the document is finished,.
|
||||
- The signer has the option of downloading or printing the signed document. He will also obtain the completion certificate if he is the final signer.
|
||||
After completing all assigned fields, the signer should click the ‘Finish’ button.
|
||||
- If the signer is the final signer, they will have the option to download or print the signed document along with the completion certificate.
|
||||
|
||||
- If there are more than one signer, the document will be immediately sent to the next signer. Once all signers have finished their signatures, they can download and print the signed document as well as the completion certificate.
|
||||
- If there are multiple signers, the document will automatically be forwarded to the next signer. Once all signers have completed their signatures, each signer will be able to download and print the final signed document and completion certificate.
|
||||
|
||||
<img width="800" alt="OpenSignFinalStep" src="https://github.com/user-attachments/assets/f4783aa0-2879-4ec2-9ddc-16d59f3a1fc0" />
|
||||
|
||||
## Additional Information
|
||||
- All fields marked with an asterisk (*) must be completed before the document can be submitted.
|
||||
- Ensure that the document format is supported by OpenSign before uploading.
|
||||
- Signed documents can be accessed in the designated 'Root' folder or the one you have specified.
|
||||
- Bulk Send is available exclusively with paid plans.
|
||||
|
||||
If you require more help, feel free to reach out to our customer support on support@opensignlabs.com.
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
sidebar_position: 3
|
||||
title: Use template to create documents
|
||||
---
|
||||
# How to use template to create documents in OpenSign™
|
||||
@@ -27,7 +27,7 @@ title: Use template to create documents
|
||||
- **Yes**: Selecting this option will send the signing request to the first signer initially. Once the first signer completes their part, the next signer in the sequence will receive the request. This process continues until all signers have signed the document. This method ensures that the document is signed in a specific order.
|
||||
- **No**: Selecting this option will send the signing links to all signers simultaneously. Every signer can sign the document at their convenience, regardless of whether other signers have completed their signatures. This method is faster but does not enforce any signing order among the participants.
|
||||
Select the option that best suits the needs of your document processing.
|
||||
### Step 5: Auto reminder (feature only avilable for the subscribed user)
|
||||
### Step 5: Auto reminder (feature only available for the subscribed user)
|
||||
- **[7]** Once you enable the auto reminder, a text field will appear allowing you to set the reminder for a specific number of days.
|
||||
- **Remind once in every (Days)**: Here, you can set the number of days for the reminder.
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"label": "Console",
|
||||
"position": 2,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "The console application is accessible only to the admin; other users do not have access to it."
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,26 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: Analytics
|
||||
---
|
||||
|
||||
### **Documents Signed**
|
||||
Displays the total number of documents you have signed.
|
||||
|
||||
---
|
||||
|
||||
### **Templates Count**
|
||||
Shows the total number of templates you have created.
|
||||
|
||||
---
|
||||
|
||||
### **Emails Sent**
|
||||
Indicates the total number of emails you have sent.
|
||||
|
||||
---
|
||||
|
||||
### **Storage Used**
|
||||
Displays the total amount of storage space you have utilized.
|
||||
|
||||
---
|
||||
|
||||
If you need further assistance, please contact our support team at **support@opensignlabs.com**.
|
||||
@@ -0,0 +1,20 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
title: Branding
|
||||
---
|
||||
|
||||
# 🔧 Branding
|
||||
|
||||
## **Custom Subdomain**
|
||||
This page is accessible only to **Enterprise** users. Here, users can configure their own custom subdomain and access the OpenSign application directly through it.
|
||||
|
||||
---
|
||||
|
||||
## **App Name**
|
||||
Users can set a custom application name to reflect their brand identity.
|
||||
This name will appear in custom template page titles and other areas across the application, helping maintain consistent branding.
|
||||
|
||||
---
|
||||
|
||||
## **App Logo**
|
||||
Users can upload their own logo to display within the application instead of the default OpenSign logo, reinforcing their brand presence.
|
||||
@@ -0,0 +1,94 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
title: Custom File Storage
|
||||
---
|
||||
|
||||
# 💾 Custom File Storage
|
||||
|
||||
## 🌩️ Introduction to BYOC (Bring Your Own Cloud)
|
||||
|
||||
OpenSign supports **BYOC (Bring Your Own Cloud)** — allowing you to **store your documents in your own cloud storage** instead of OpenSign’s default storage.
|
||||
|
||||
With BYOC, organizations and users gain **greater control, privacy, and compliance flexibility** by connecting their preferred cloud providers such as **AWS S3** or **DigitalOcean Spaces**.
|
||||
|
||||
> 🧠 **Why BYOC?**
|
||||
> - Maintain complete ownership and control of your documents.
|
||||
> - Comply with internal, regional, or client-specific data policies.
|
||||
> - Choose your preferred cloud region or provider for better performance and compliance.
|
||||
|
||||
---
|
||||
|
||||
## 🚀 How to Access the Custom File Storage Setup
|
||||
|
||||
Follow the steps below to navigate to the **Custom File Storage** setup page in OpenSign:
|
||||
|
||||
1. Log in to your **OpenSign** account using an **Admin account**.
|
||||
2. Click on your **profile menu** (top-right corner) and select **Console**.
|
||||
3. In the **left sidebar**, go to **Storage**.
|
||||
|
||||
<img width="1722" height="814" alt="Custom file storage" src="https://github.com/user-attachments/assets/813f6685-3f36-40e4-aaaf-0d8b86bdc3b7" />
|
||||
|
||||
You will now be on the **Custom File Storage** setup page where you can configure your own storage provider.
|
||||
|
||||
> 🔒 **Note:** Access to Custom File Storage settings is available only to **Admin users**. Regular users will not see this option in their menu.
|
||||
|
||||
---
|
||||
|
||||
## 🔔 Set Up File Storage
|
||||
|
||||
By default, all users are connected to **OpenSign’s default file storage**.
|
||||
If you prefer to use your **own custom cloud storage (BYOC)**, you can easily configure it here.
|
||||
|
||||
You can set up an **AWS S3 bucket** or **DigitalOcean Space** to store your uploaded documents securely.
|
||||
To configure OpenSign with your cloud storage, refer to this detailed guide:
|
||||
👉 [Cloud Storage Setup Guide](https://docs.opensignlabs.com/docs/self-host/cloud-storage/s3)
|
||||
|
||||
---
|
||||
|
||||
### 🪣 Steps to Configure Custom Storage
|
||||
|
||||
1. Click the **Add New** button.
|
||||
|
||||
<img width="861" height="408" alt="Add new workspace" src="https://github.com/user-attachments/assets/0f734c6a-e2ac-445a-8194-746b9c202f0a" />
|
||||
|
||||
2. Fill in the following details:
|
||||
|
||||
- **Unique File Adapter Name:** Enter a unique name for your storage configuration.
|
||||
- **Storage Provider:** Choose your provider — currently, OpenSign supports **AWS S3** and **DigitalOcean Spaces**.
|
||||
- **Bucket Name:** Specify your storage bucket name.
|
||||
- **Region:** Enter the region where your bucket is hosted.
|
||||
- **Endpoint:** Provide the endpoint URL of your storage service.
|
||||
- **Base URL:** Enter the base URL used to access stored files.
|
||||
- **Access Key ID:** Enter your storage access key ID.
|
||||
- **Secret Access Key:** Enter your storage secret access key.
|
||||
|
||||
3. Once all details are filled, click **Save and Activate** to enable your custom file storage.
|
||||
|
||||
After activation:
|
||||
- All your documents will be stored in the configured **BYOC storage provider**.
|
||||
- You will be automatically logged out to clear any previous file adapter data from your local session.
|
||||
- Upon logging in again, your custom file storage will be active, and all future documents will be saved there.
|
||||
|
||||
<img width="861" height="408" alt="custom file storage" src="https://github.com/user-attachments/assets/1add417d-f745-4e00-8cf3-7dcd9798f4db" />
|
||||
|
||||
---
|
||||
|
||||
### ⚠️ Important Note
|
||||
|
||||
In some cases, documents stored in your **custom (BYOC)** file storage may not load in OpenSign due to **CORS (Cross-Origin Resource Sharing)** policy restrictions.
|
||||
If you’ve activated custom file storage, ensure your cloud configuration **allows OpenSign to access your documents** and does **not block requests** due to CORS errors.
|
||||
|
||||
👉 [Read the article to learn how to set up CORS policies](https://docs.opensignlabs.com/docs/self-host/cloud-storage/s3)
|
||||
|
||||
---
|
||||
|
||||
## 💬 Need Help?
|
||||
|
||||
If you need help setting up or testing your BYOC or custom file storage integration, contact our support team at
|
||||
📩 **[support@opensignlabs.com](mailto:support@opensignlabs.com)**
|
||||
|
||||
Or join our community for instant assistance:
|
||||
💬 [Join our Discord](https://discord.com/invite/xe9TDuyAyj)
|
||||
|
||||
**Happy Signing with OpenSign™!**
|
||||
|
||||
@@ -0,0 +1,64 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
title: Mail
|
||||
---
|
||||
|
||||
# 📧 Company Email Template Settings
|
||||
|
||||
This page allows the **admin user** to configure and manage customized email templates at the **organization level**.
|
||||
If you prefer not to grant users permission to set up their own email templates, you can define a single set of templates here that will apply to all users within your organization.
|
||||
|
||||
---
|
||||
|
||||
## 🧩 Set Up Custom Email Templates at the Organization Level
|
||||
|
||||
**Step 1:** Log in to your OpenSign account using valid credentials (**admin access required**).
|
||||
**Step 2:** Navigate to the **Profile Menu** and click on **Console**.
|
||||
**Step 3:** Go to the **Email** tab. Here, admin users can create, edit, and manage organization-level email templates.
|
||||
|
||||
<img width="800" alt="custom email templates" src="https://github.com/user-attachments/assets/b2fd3497-3e2b-4acc-b8a5-09bad8a5e5ba"></img>
|
||||
|
||||
To set up a custom email template at the user level, refer to the guide here:
|
||||
https://docs.opensignlabs.com/docs/help/Settings/Custom-email-templates
|
||||
|
||||
---
|
||||
|
||||
## ✉️ Request Signature Email
|
||||
|
||||
This email is automatically sent to all signers when a document is shared for signing.
|
||||
|
||||
- Customize the **subject line**, **greeting**, **message body**, and **footer** to match your brand’s tone and style.
|
||||
- Use dynamic placeholders like `{{document_title}}`, `{{receiver_name}}`, and `{{signing_url}}` for personalization.
|
||||
- Personalized messages increase open rates and help recipients clearly understand the signing request.
|
||||
|
||||
---
|
||||
|
||||
## 📩 Document Completion Email
|
||||
|
||||
This email is sent to all signers and the document owner once the signing process is successfully completed.
|
||||
|
||||
- Contains a summary message along with the **signed document** and **completion certificate** as attachments.
|
||||
- Customizing this template helps maintain brand consistency even in post-signature communications.
|
||||
- Ideal for sharing **legal confirmations**, **audit trails**, or **record-keeping** updates.
|
||||
|
||||
---
|
||||
|
||||
### 🔄 Reset Template Text
|
||||
|
||||
Click the **Reset** button to restore any modified email template back to its **default OpenSign version**.
|
||||
After resetting, make sure to click **Save** to apply the changes.
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Additional Notes
|
||||
|
||||
- All custom email templates support **rich text formatting** and **dynamic variables**.
|
||||
- Updates take effect immediately and apply to **all new documents** created after the change.
|
||||
- Organizations can enforce consistent branding and compliance across all user emails.
|
||||
- If no custom email template is configured, and users are not allowed to create individual templates, OpenSign will automatically use the **OpenSign default email templates**.
|
||||
|
||||
> 💡 **Tip:** Always preview your templates before saving to ensure correct formatting and placeholder usage.
|
||||
|
||||
---
|
||||
|
||||
For further assistance with OpenSign™ features or APIs, contact our support team at **[support@opensignlabs.com](mailto:support@opensignlabs.com)**.
|
||||
@@ -0,0 +1,66 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: General
|
||||
---
|
||||
|
||||
# General Settings
|
||||
|
||||
The **General Settings** section in OpenSign provides key administrative settings to help you manage and control the overall configuration of your OpenSign platform.
|
||||
|
||||
---
|
||||
|
||||
## 🚀 How to Access the General Settings Page
|
||||
|
||||
1. Log in to your **OpenSign** account using an **Admin account**.
|
||||
2. Click on your **profile menu** (top-right corner) and select **Console**.
|
||||
3. From the **left sidebar**, choose **General**.
|
||||
|
||||
You’ll now be on the **General Settings** page.
|
||||
|
||||
> 🔒 **Note:** The **General Settings** page is available only to **Admin users**. Regular users will not see this option in their menu.
|
||||
|
||||
---
|
||||
|
||||
## Enabled Signature Types
|
||||
|
||||
Admins can define which signature types are available across the organization.
|
||||
|
||||
All users under your account will only have access to the signature methods you enable here in their **Preferences**. Any disabled methods will be hidden from their options.
|
||||
|
||||
**Example:**
|
||||
If Adam, the admin of your organization, disables the **Typed** signature type in the **Manage Signature Types** section, Ursula (a team member) will no longer see the **Typed** signature option in her preferences.
|
||||
|
||||
However, Ursula can still enable or disable any of the remaining signature types for each document she creates.
|
||||
When she sends a document to Sofia (a signer), Sofia will only be able to use the signature methods that Ursula selected during the document setup.
|
||||
|
||||
> **Note:** Managing **Signature Types** at the organization level is available in the Teams and Enterprise plans.
|
||||
> This feature is not included in the **Professional** or **Free** plans.
|
||||
|
||||
<img width="918" alt="General settings" src="https://github.com/user-attachments/assets/60681095-6e53-4667-9f47-b3d4d38ab4b3" />
|
||||
|
||||
---
|
||||
|
||||
## Allow Indexing of Public Profile
|
||||
|
||||
When this option is enabled, user's public profiles will be indexed by search engines and may appear in search results.
|
||||
|
||||
---
|
||||
|
||||
## Email Template Customization
|
||||
|
||||
This setting determines whether team members can create and manage their own email templates.
|
||||
|
||||
- If **Disabled**: users **cannot** create or modify custom templates for signature requests or completion notifications.
|
||||
- If **Enabled**: users can design and manage their own personalized email templates.
|
||||
|
||||
### Enable Individual User SMTP Settings
|
||||
|
||||
This setting controls whether individual users are allowed to configure their own outgoing email servers (like connecting Gmail or using a custom SMTP).
|
||||
If **Disabled**: Users CANNOT connect Gmail or configure custom SMTP at their level.
|
||||
If **Enabled**: Users CAN connect Gmail or configure custom SMTP at their level.
|
||||
|
||||
Note: If users do not configure their own settings, all outgoing emails will be sent using the organization-level SMTP (if configured), or the OpenSign default SMTP if not.
|
||||
|
||||
---
|
||||
|
||||
Need help? [Join our Discord community](https://discord.com/invite/xe9TDuyAyj) for instant support.
|
||||
@@ -0,0 +1,60 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
title: Global SMTP
|
||||
---
|
||||
|
||||
## 🏢 SMTP at the Organization Level
|
||||
|
||||
Configure SMTP at the organization level to send all outgoing emails—such as request-signature and completion emails—using a company-configured SMTP server.
|
||||
When enabled, these settings apply to all users **unless individual SMTP customization is allowed and set up by the user**.
|
||||
|
||||
### How to Set Up SMTP at the Organization Level
|
||||
|
||||
Admins can manage and enforce SMTP settings across the entire platform.
|
||||
|
||||
**Step 1:** Open the profile menu and select **Console Application** to access the admin console.
|
||||
**Step 2:** In the Console, navigate to the **Global SMTP** section and configure your SMTP settings.
|
||||
|
||||
All users under your organization will automatically use the organization-level SMTP **unless** they are allowed to configure their own SMTP settings.
|
||||
|
||||
<img width="861" height="409" alt="Global SMTP" src="https://github.com/user-attachments/assets/fe9dc091-59dd-47f9-992a-811cecaac2f3" />
|
||||
|
||||
**Example:**
|
||||
Adam, the administrator, disables **Enable individual user SMTP settings** under **Console → General**.
|
||||
As a result, Ursula cannot configure her own SMTP.
|
||||
|
||||
When Ursula sends a document to Sofia for signing, Sofia receives emails sent through the **organization-level SMTP**.
|
||||
If Adam enables **Enable individual user SMTP settings**, but Ursula does not configure her own SMTP, emails will still be sent using the **organization-level SMTP**.
|
||||
|
||||
> **Note:** Organization-level SMTP configuration is available **only on Paid plans** and is not included in **Free** plans.
|
||||
|
||||
### 🔗 Connect to Gmail
|
||||
|
||||
Send request-signature emails directly from your **Gmail account**.
|
||||
|
||||
- Click **Connect to Gmail**
|
||||
- A popup will appear prompting you to sign in
|
||||
- Grant the required access permissions
|
||||
- Once authorized, OpenSign will send emails using your Gmail account
|
||||
|
||||
---
|
||||
|
||||
### ⚙️ Custom SMTP
|
||||
|
||||
Configure any third-party SMTP provider such as SMTP2GO or Mailgun.
|
||||
|
||||
- Click **Custom SMTP**
|
||||
- A popup will appear asking for your SMTP details:
|
||||
- **Host:** SMTP server host (e.g., `mail.smtp2go.com`)
|
||||
- **Port:** SMTP port (e.g., `2525`)
|
||||
- **Sender Email:** Email address configured in your SMTP account
|
||||
- **Username:** SMTP username
|
||||
- **Password:** SMTP password
|
||||
|
||||
<img width="820" alt="Custom smtp" src="https://github.com/user-attachments/assets/a3c33510-11b9-4a32-bd44-99614182b089"></img>
|
||||
|
||||
---
|
||||
|
||||
### 📤 OpenSign™ Default SMTP
|
||||
|
||||
If selected, all request-signature and completion emails will be sent using OpenSign’s built-in SMTP server.
|
||||
@@ -0,0 +1,106 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
title: Org Admins
|
||||
---
|
||||
|
||||
# 👥 Org Admins
|
||||
|
||||
The **Org Admins** section allows administrators to manage organization-level admin users within **OpenSign**.
|
||||
Org Admins are responsible for managing users, templates, and signing workflows for their organizations.
|
||||
|
||||
---
|
||||
|
||||
## 🚀 How to Access the Org Admins Page
|
||||
|
||||
1. Log in to your **OpenSign** account using an **Admin account**.
|
||||
2. Click on your **profile menu** (top-right corner) and select **Console**.
|
||||
3. From the **left sidebar**, expand the **Teams** menu.
|
||||
4. Click on **Org Admins**.
|
||||
|
||||
You’ll now see the **Org Admins Management Panel**, which displays all existing organization admins and seat usage.
|
||||
|
||||
> 🔒 **Note:** The **Org Admins** page is accessible only to **Admin users**. Regular users will not see this option in their menu.
|
||||
|
||||
---
|
||||
|
||||
## 🧾 Org Admins Overview
|
||||
|
||||
The **Org Admins** table lists all organization admins along with their key details:
|
||||
|
||||
- **Sr.No** — Serial number.
|
||||
- **Name** — Full name of the Org Admin.
|
||||
- **Email** — Registered email address.
|
||||
- **Organization** — Associated organization.
|
||||
- **IsActive** — Toggle to activate or deactivate an Org Admin.
|
||||
- **🗑️ Delete** — Remove an Org Admin permanently.
|
||||
|
||||
> ⚠️ **Caution:** Deactivating an Org Admin restricts their access without deleting their data.
|
||||
> Deleting permanently removes their access and data cannot be recovered.
|
||||
|
||||
---
|
||||
|
||||
## 🪙 Available Seats
|
||||
|
||||
At the bottom-right corner of the Org Admins page, you will find the **Available Seats** indicator.
|
||||
|
||||
|
||||
- **Example:** `Available seats: 2/5
|
||||
- **2** — Indicates the number of seats currently in use.
|
||||
- **5** — Represents the total number of seats purchased.
|
||||
|
||||
This helps you monitor how many Org Admin accounts can still be added under your current subscription.
|
||||
|
||||
> 💡 **Tip:** Once all available seats are used, you can purchase additional seats using the **Buy more users** option.
|
||||
|
||||
---
|
||||
|
||||
## ➕ Add a New Org Admin
|
||||
|
||||
To create a new organization admin:
|
||||
|
||||
1. Click the **➕ (Add)** icon at the top-right corner of the Org Admins page.
|
||||
2. The **Add User** popup will appear.
|
||||
|
||||
### 🧩 Add User Fields
|
||||
|
||||
- **Name** — Enter the Org Admin’s full name (Required).
|
||||
- **Email** — Enter a valid email address (Required).
|
||||
- **Password** — A random password will be auto-generated.
|
||||
- ⚠️ Copy and share it securely with the user — it will not be visible again.
|
||||
- **Phone** — Optional field.
|
||||
- **Organization** — Select the organization this user belongs to.
|
||||
- **Remaining Users** — Displays how many more admins can be added under your available seats.
|
||||
|
||||
Click **Submit** to create the Org Admin.
|
||||
|
||||
---
|
||||
|
||||
## 💳 Buy More Users (Add Seats)
|
||||
|
||||
If you’ve reached your seat limit, you can buy more user seats to add additional Org Admins.
|
||||
|
||||
1. Click on **Buy more users ➕** located at the top-right of the Org Admins page.
|
||||
2. The **Add Seats** popup will appear.
|
||||
|
||||
|
||||
### 🧾 Add Seats
|
||||
|
||||
- **Quantity of users** — Enter the number of additional seats you want to purchase. *(Required)*
|
||||
- **Price** — Automatically calculated based on the number of users selected (e.g., `1 * 20 = $ 20`).
|
||||
|
||||
Click **Proceed** to continue with the purchase.
|
||||
|
||||
### Add Seats
|
||||
|
||||
> - The price updates automatically based on the number of seats entered.
|
||||
> - Once payment is successful, your **Available Seats** count updates in real-time.
|
||||
> - You can then add new Org Admins under the increased seat capacity.
|
||||
|
||||
---
|
||||
|
||||
## 💬 Need Help?
|
||||
|
||||
If you face any issues while managing Org Admins or purchasing seats, feel free to reach out to our support team:
|
||||
📩 **[support@opensignlabs.com](mailto:support@opensignlabs.com)**
|
||||
|
||||
**Empower your organization’s admins with OpenSign™!**
|
||||
@@ -0,0 +1,76 @@
|
||||
---
|
||||
sidebar_position: 8
|
||||
title: Organizations
|
||||
---
|
||||
|
||||
# 🏢 Organizations
|
||||
|
||||
The **Organizations** section in **OpenSign** allows administrators to create and manage **separate groups** within a **Team or Enterprise account**.
|
||||
Each organization acts as an **independent workspace** with its **own users, teams, templates, and signing workflows**.
|
||||
|
||||
---
|
||||
|
||||
## 🧩 What Are Organizations in OpenSign?
|
||||
|
||||
An **Organization** represents a **distinct sub-account** under your main (team or enterprise) OpenSign account.
|
||||
Organizations are completely **isolated** from each other — meaning:
|
||||
|
||||
- Teams and users from one organization **cannot view or access** teams, documents, or users from another organization.
|
||||
- Each organization functions as its own **secure workspace** within your overall account.
|
||||
- You can manage multiple organizations from a **single admin console**, ensuring centralized control.
|
||||
|
||||
### 💼 Example Use Case
|
||||
|
||||
If your company manages multiple **clients or departments**, each with its own teams and sub-users, the **Organizations** feature is perfect for you.
|
||||
|
||||
For example:
|
||||
- An agency can create **individual sub-accounts** for each client (Client A, Client B, etc.).
|
||||
- Each client’s team members and workflows remain **private and independent**.
|
||||
- The **main admin (enterprise account holder)** retains full control and visibility from the console.
|
||||
|
||||
> 💰 **Billing:** All organizations under the same account are billed centrally by the **primary account holder**.
|
||||
> This ensures simplified management and unified subscription handling.
|
||||
|
||||
---
|
||||
|
||||
## 🚀 How to Set Up Organizations in OpenSign
|
||||
|
||||
1. Log in to your **OpenSign** account using an **Admin account**.
|
||||
2. Click on your **profile menu** (top-right corner) and select **Console**.
|
||||
3. Once the **Console app** opens, navigate to the left sidebar and expand the **Teams** menu.
|
||||
4. Click on **Organizations**.
|
||||
5. The **Organizations Management** panel will appear, displaying a list of existing organizations and the option to add new ones.
|
||||
|
||||
> 🔒 **Note:** The **Console** and **Organizations** pages are accessible only to **Admin users**.
|
||||
> Regular users will not see this option in their menu.
|
||||
|
||||
---
|
||||
|
||||
## ➕ Add a New Organization
|
||||
|
||||
To create a new organization:
|
||||
|
||||
1. Click the **➕ (Add)** icon at the top-right corner of the Organizations panel.
|
||||
2. In the **Add Organization** popup:
|
||||
- **Name** — Enter the name of your organization. *(Required)*
|
||||
3. Click **Submit** to save or **Reset** to clear the input.
|
||||
|
||||
> 💡 **Tip:** Use clear and descriptive names (e.g., *Client Alpha*, *Marketing Division*, *PS Inc.*)
|
||||
> for easier management and reporting.
|
||||
|
||||
---
|
||||
|
||||
## ⚙️ Manage Organizations
|
||||
|
||||
The **Organizations table** lists all existing organizations with the following details:
|
||||
|
||||
- **Sr.No** — Serial number of the organization.
|
||||
- **Name** — The registered name of the organization.
|
||||
- **IsActive** — Toggle to activate or deactivate the organization.
|
||||
|
||||
> ⚠️ **Note:** Deactivating an organization disables all its associated users and workflows until it is reactivated.
|
||||
|
||||
---
|
||||
If you require more help, feel free to reach out to our customer support on support@opensignlabs.com.
|
||||
|
||||
Happy signing with OpenSign™!
|
||||
@@ -0,0 +1,64 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
title: Custom Signing Certificate
|
||||
---
|
||||
|
||||
# 🔐 Custom Signing Certificate
|
||||
|
||||
The **Custom Signing Certificate** page allows you to upload and manage your own **digital signing certificate** (PFX format) for secure and verified document signing in OpenSign.
|
||||
|
||||
By default, OpenSign uses its **built-in signing certificate** to digitally sign documents.
|
||||
However, if your organization has its own **custom certificate (PFX or P12 format)**, you can upload and activate it here.
|
||||
<img width="1722" height="814" alt="pfx cerificate upload" src="https://github.com/user-attachments/assets/a5668f61-332d-49c5-ace2-5f0f92d3b68f" />
|
||||
|
||||
---
|
||||
|
||||
## 🪪 What is a PFX Certificate?
|
||||
|
||||
A **PFX** (or **P12**) certificate is a password-protected digital certificate file that contains:
|
||||
- A **private key** (used for signing documents securely)
|
||||
- A **public certificate** (used to verify the signature’s authenticity)
|
||||
|
||||
Using a custom certificate enhances trust and compliance by ensuring all signed documents carry your organization’s **digital identity**.
|
||||
|
||||
---
|
||||
|
||||
## ⚙️ How to Upload Your Custom Certificate
|
||||
|
||||
Follow these steps to set up your custom signing certificate:
|
||||
|
||||
1. **Log in** to your OpenSign account using your admin credentials.
|
||||
2. Navigate to the **Console → Signing Certificate** section.
|
||||
3. In the **Custom Signing Certificate** panel:
|
||||
- Click **Choose File** and upload your `.pfx` or `.p12` certificate file.
|
||||
- Enter your **certificate password** (required to unlock the private key).
|
||||
4. Click **Update** to save and activate your custom signing certificate.
|
||||
|
||||
> Once updated, all new documents signed using your OpenSign account will be digitally signed with your uploaded certificate.
|
||||
|
||||
---
|
||||
|
||||
## 🧾 Using the Default OpenSign Certificate
|
||||
|
||||
If you wish to revert to the standard OpenSign certificate:
|
||||
- Simply click **Use default OpenSign™ certificate**.
|
||||
- OpenSign will replace your custom certificate with its default one.
|
||||
<img width="861" height="408" alt="pfx_Certificate" src="https://github.com/user-attachments/assets/9063d927-c28f-4bb5-ac36-caeebc3845fc" />
|
||||
|
||||
---
|
||||
|
||||
## 🛡️ Security Notes
|
||||
|
||||
- OpenSign securely encrypts and stores your uploaded certificate.
|
||||
- Ensure that your PFX file and password are valid and belong to your organization.
|
||||
- Invalid or expired certificates may prevent successful document signing.
|
||||
- Use strong passwords for your certificate to maintain compliance and security.
|
||||
|
||||
---
|
||||
|
||||
## 💬 Need Help?
|
||||
|
||||
If you encounter any issues while uploading or activating your certificate, contact our support team at
|
||||
📩 **[support@opensignlabs.com](mailto:support@opensignlabs.com)**
|
||||
|
||||
**Empower your brand with trusted digital signatures — securely with OpenSign™.**
|
||||
@@ -0,0 +1,125 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: Profile
|
||||
---
|
||||
import ReactPlayer from 'react-player';
|
||||
|
||||
# 👤 Profile
|
||||
|
||||
The **Profile ** in OpenSign allows users to manage their personal and account-related details. You can update your information, verify your email, and set up a public profile.
|
||||
|
||||
<img width="861" alt="Profile Menu" src="https://github.com/user-attachments/assets/8bfff942-222a-4e16-ac2d-cc07df1429de" />
|
||||
|
||||
---
|
||||
|
||||
## 📌 Profile Information
|
||||
|
||||
<img width="1722" alt="Profile Information" src="https://github.com/user-attachments/assets/8745e89d-4faa-4921-9ada-57253a8d4293" />
|
||||
|
||||
### 🔐 Roles
|
||||
|
||||
- **Admin**
|
||||
- Role is displayed under your avatar.
|
||||
- Has access to all features, including **User Management** and **Billing**.
|
||||
|
||||
- **OrgAdmin**
|
||||
- Has the same access as Admin.
|
||||
- **Does not** have access to the **Console Application** or **Billing details**.
|
||||
|
||||
- **Editor/User**: Cannot access Console Application, Billing, and are restricted from creating Teams, sharing templates.
|
||||
---
|
||||
|
||||
### 👤 User Details
|
||||
|
||||
- **Name** – Displays the full name of the user.
|
||||
- **Phone** – Shows the registered phone number.
|
||||
- **Email** – Displays the user’s registered email address. This cannot be changed or updated. It is used for login and notifications.
|
||||
- **Company** – Shows the company name associated with the account.
|
||||
- **Job Title** – Displays the job title of the user.
|
||||
|
||||
---
|
||||
|
||||
## ✅ Email Verification
|
||||
|
||||
- **Is Email Verified:** Indicates whether your email is verified.
|
||||
- If **Not Verified**, click **Verify** to begin the verification process.
|
||||
- An OTP will be sent to your registered email address.
|
||||
- Enter the OTP to complete verification. This is a one-time process, and once verified, the status will update to Verified.
|
||||
|
||||
---
|
||||
|
||||
## 🌍 Public Profile
|
||||
|
||||
- **Public Profile Username**
|
||||
Set a unique username to create your **public profile**.
|
||||
|
||||
- **Share Templates Publicly**
|
||||
Your public profile allows you to share templates openly, enabling signers to sign documents easily.
|
||||
|
||||
- **Tagline**
|
||||
Add a short tagline to your profile by entering text in the **Tagline** field.
|
||||
This tagline will be displayed publicly as part of your profile information.
|
||||
|
||||
---
|
||||
|
||||
### 🔖 Disable DocumentId
|
||||
|
||||
Whenever a document is signed by all parties, **OpenSign™ automatically adds a unique DocumentId** at the top-left corner of the signed document.
|
||||
|
||||
This ID can be used later to **verify the authenticity of the document**, so we **strongly recommend keeping it enabled**.
|
||||
|
||||
If you prefer not to include the DocumentId in your signed documents, simply toggle the **Disable DocumentId** switch **ON**.
|
||||
|
||||
> **Note:** This feature is available only for paid users.
|
||||
|
||||
### Language
|
||||
|
||||
Users can set their preferred language for this account. Once a language is selected, it will be applied whenever the user logs in, and the application interface will automatically switch to the chosen language.
|
||||
|
||||
### Edit User Details
|
||||
|
||||
Click **Edit** to update user information, including:
|
||||
|
||||
- Profile avatar
|
||||
- Name
|
||||
- Phone number
|
||||
- Company
|
||||
- Job title
|
||||
- Public profile
|
||||
- Tagline
|
||||
- Enable/disable DocumentId
|
||||
|
||||
<img width="861" alt="Edit Personal information" src="https://github.com/user-attachments/assets/c8c93c33-193f-4e1d-bfba-a8d7447d1007" />
|
||||
|
||||
<img width="861" alt="Edit profile" src="https://github.com/user-attachments/assets/2f40254d-fd68-4a86-a018-7ac4f7ebf1f5" />
|
||||
|
||||
# ❌ Delete User (Admin Account)
|
||||
|
||||
Follow these steps to permanently delete an admin account from OpenSign.
|
||||
|
||||
### Steps to Delete Your Account
|
||||
|
||||
1. **Open Profile Menu** – Click the profile menu and select **Profile**.
|
||||
2. **Delete Account** – Scroll to the bottom and click **Delete Account**. Confirm by selecting **Yes**.
|
||||
3. **Confirm via Email** – Open the deletion email and click **Confirm Account Deletion**.
|
||||
4. **Send OTP** – On the next page, click **Send OTP**.
|
||||
5. **Enter OTP** – Check your email for the OTP and enter it.
|
||||
6. **Final Deletion** – Click **Delete Account**. All records and documents will be permanently removed.
|
||||
|
||||
<div>
|
||||
<ReactPlayer playing controls url='https://youtu.be/pY0T7U164Y4' />
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
### Cases When Account Deletion is Not Allowed
|
||||
|
||||
- **Team Users Exist**
|
||||
If you have team users added under your account, you must delete them first before deleting your own account.
|
||||
|
||||
- **Active Paid Plan**
|
||||
If you have an active paid plan, you cannot delete your account directly.
|
||||
To proceed with account deletion, please contact [support@opensignlabs.com](mailto:support@opensignlabs.com) for assistance.
|
||||
|
||||
---
|
||||
If you need additional assistance setting up OpenSign APIs, feel free to contact our support team at support@opensignlabs.com.
|
||||
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"label": "User Menu",
|
||||
"position": 6,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "5 minutes to learn everything about OpenSign™ User profile."
|
||||
}
|
||||
}
|
||||
@@ -3,7 +3,7 @@ title: Digital Ocean
|
||||
---
|
||||
# Digital Ocean
|
||||
|
||||
OpenSign application consistes of 3 components -
|
||||
OpenSign application consists of 3 components -
|
||||
- ReactJS frontend
|
||||
- NodeJS API
|
||||
- MongoDB database
|
||||
|
||||
@@ -14,7 +14,7 @@ title: AWS S3
|
||||

|
||||

|
||||
- Click on name of bucket from list which we have just created.
|
||||
- Now go to permission Tab and scroll down to botton.
|
||||
- Now go to permission Tab and scroll down to bottom.
|
||||

|
||||
- At the bottom you will see cross-origin resource sharign (cors) section click on "Edit" button.
|
||||

|
||||
|
||||
@@ -69,12 +69,11 @@ Once the deployment is successful, the application will be accessible at [https:
|
||||
## Information About ENV variables which are used to setup OpenSign™ with Docker on Localhost
|
||||
To set up OpenSign™ locally using Docker, the following prerequisites are required:
|
||||
|
||||
Add below Environment Varaibles to the ".env.prod" file that is automatically created in order to personalize your installation:
|
||||
Add below Environment Variables to the ".env.prod" file that is automatically created in order to personalize your installation:
|
||||
|
||||
| Environment Varibale | Value | Description |
|
||||
| Environment Variable | Value | Description |
|
||||
| ------------- | ------------- | ------------- |
|
||||
| PUBLIC_URL | https://localhost:3001 or https://opensign.yourdomain.com | Set it to the URL form where the app home page will be accessed |
|
||||
| APP_ID | opensign | A 12 character long random app identifier. |
|
||||
| MASTER_KEY | XnAadwKxxByMr | A 12 character long random secret key that allows access to all the data. It is used in Parse dashboard config to view all the data in the database. |
|
||||
| MONGODB_URI | mongodb://mongo-container:27017/OpenSignDB | Mongodb URI to connect to |
|
||||
| PARSE_MOUNT | /app | Path on which APIs should be mounted. Do not change this. This variable shall be removed & value hardcoded in the source code in coming versions. |
|
||||
@@ -97,6 +96,8 @@ Add below Environment Varaibles to the ".env.prod" file that is automatically cr
|
||||
| SMTP_PASS | password | Provide smtp password |
|
||||
| PFX_BASE64 | - | Base64 encoded PFX or p12 document signing certificate file. You can generate base64 encoded self sign certificate using the passphrase. |
|
||||
| PASS_PHRASE | opensign | Pass phrase of PFX or p12 document signing certificate file. |
|
||||
| APP_ID | opensign | (DEPRECATED) This should not be changed if provided; it should be 'opensign'. |
|
||||
|
||||
|
||||
# Steps to Generate Self Sign Certificate
|
||||
```
|
||||
|
||||
@@ -21,15 +21,15 @@ Run the following command to pull the latest OpenSign Docker images:
|
||||
## Running on a custom domain
|
||||
**linux/MacOS**
|
||||
```
|
||||
export HOST_URL=https://opensign.yourdomain.com && curl --remote-name-all https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml && docker compose pull
|
||||
export HOST_URL=https://opensign.yourdomain.com && curl --remote-name-all https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/Caddyfile && docker compose pull
|
||||
```
|
||||
**Windows** (Powershell)
|
||||
```
|
||||
$env:HOST_URL="https://opensign.yourdomain.com"; Invoke-WebRequest -Uri https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml -OutFile docker-compose.yml; docker compose pull
|
||||
$env:HOST_URL="https://opensign.yourdomain.com"; Invoke-WebRequest -Uri https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml -OutFile docker-compose.yml; Invoke-WebRequest -Uri https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/Caddyfile -OutFile Caddyfile; docker compose pull
|
||||
```
|
||||
**Windows** (Command Prompt)
|
||||
```
|
||||
set HOST_URL=https://opensign.yourdomain.com && curl -O https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml && docker compose pull
|
||||
set HOST_URL=https://opensign.yourdomain.com && curl -O https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml && curl -O https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/Caddyfile && docker compose pull
|
||||
```
|
||||
- This command will fetch the most recent versions of the Docker images required by OpenSign.
|
||||
- Wait for the pulling process to complete. You should see messages indicating the progress and completion of the download.
|
||||
@@ -37,15 +37,15 @@ set HOST_URL=https://opensign.yourdomain.com && curl -O https://raw.githubuserco
|
||||
## Running locally
|
||||
**linux/MacOS**
|
||||
```
|
||||
curl --remote-name-all https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml && docker compose pull
|
||||
curl --remote-name-all https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/Caddyfile && docker compose pull
|
||||
```
|
||||
**Windows** (Powershell)
|
||||
```
|
||||
Invoke-WebRequest -Uri https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml -OutFile docker-compose.yml; docker compose pull
|
||||
Invoke-WebRequest -Uri https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml -OutFile docker-compose.yml; Invoke-WebRequest -Uri https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/Caddyfile -OutFile Caddyfile; docker compose pull
|
||||
```
|
||||
**Windows** (Command Prompt)
|
||||
```
|
||||
curl -O https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml && docker compose pull
|
||||
curl -O https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml && curl -O https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/Caddyfile && docker compose pull
|
||||
```
|
||||
- This command will fetch the most recent versions of the Docker images required by OpenSign.
|
||||
- Wait for the pulling process to complete. You should see messages indicating the progress and completion of the download.
|
||||
@@ -63,19 +63,11 @@ docker compose up -d
|
||||
**Explanation:**
|
||||
- docker-compose up: This command starts the services defined in your docker-compose.yml file.
|
||||
- -d: The detached mode flag, which runs the containers in the background and frees up your terminal.
|
||||
- If you want to view the logs, avoid using the -d flag.
|
||||
|
||||
<img width="550" alt="Docker compose up" src="https://github.com/user-attachments/assets/c573baaf-f70d-468e-a531-75b85a275647" />
|
||||
|
||||
### OR
|
||||
If you have already run the above command, you do not need to execute this command.
|
||||
```
|
||||
docker compose up
|
||||
```
|
||||
- This command will recreate and start all the necessary containers with the updated images.
|
||||
- You should see logs indicating that the containers are being created or updated, and eventually, that they are up and running.
|
||||
|
||||
## Note:
|
||||
- The docker compose pull command ensures that you have the latest version of the Docker images, while the docker compose up command applies any updates and starts the containers.
|
||||
**Note**: The docker compose pull command ensures that you have the latest version of the Docker images, while the docker compose up command applies any updates and starts the containers.
|
||||
|
||||
## Troubleshooting:
|
||||
- If you encounter any errors, check Docker logs by running docker compose logs to get more details.
|
||||
|
||||
@@ -0,0 +1,197 @@
|
||||
---
|
||||
title: OpenSign Deployment Guide on Azure VM via command-line
|
||||
---
|
||||
|
||||
# 🚀 OpenSign Deployment Guide on Azure VM (Frontend + Backend + MongoDB + Caddy)
|
||||
|
||||
## 🧱 Prerequisites
|
||||
|
||||
- Azure CLI installed
|
||||
- A domain you control (e.g., `yourdomain.com`)
|
||||
- Subdomain pointing to your VM (e.g., `opensign.yourdomain.com`)
|
||||
- SSH access
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Step 1: Create an Azure VM
|
||||
|
||||
### 1.1 Create Resource Group
|
||||
```bash
|
||||
az group create --name OpenSignRG --location eastus
|
||||
```
|
||||
|
||||
### 1.2 Create Ubuntu VM
|
||||
```bash
|
||||
az vm create \
|
||||
--resource-group OpenSignRG \
|
||||
--name opensign-vm \
|
||||
--image Ubuntu2404 \
|
||||
--admin-username azureuser \
|
||||
--generate-ssh-keys \
|
||||
--size Standard_B1ms
|
||||
```
|
||||
|
||||
### 1.3 Get VM IP
|
||||
```bash
|
||||
az vm list-ip-addresses --name opensign-vm --resource-group OpenSignRG --output table
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔐 Step 2: Open Required Ports
|
||||
|
||||
Azure’s default port-opening approach conflicts if you use the same priorities. So instead, **add rules with increasing priorities** manually:
|
||||
|
||||
### 2.1 Get NSG name
|
||||
```bash
|
||||
az network nsg list --resource-group OpenSignRG --query "[].name"
|
||||
```
|
||||
|
||||
Assume it’s `opensign-vmNSG`. Then:
|
||||
|
||||
### 2.2 Add inbound port rules
|
||||
```bash
|
||||
az network nsg rule create \
|
||||
--resource-group OpenSignRG \
|
||||
--nsg-name opensign-vmNSG \
|
||||
--name Allow-HTTP \
|
||||
--priority 1001 \
|
||||
--direction Inbound \
|
||||
--protocol Tcp \
|
||||
--access Allow \
|
||||
--destination-port-ranges 80
|
||||
|
||||
az network nsg rule create \
|
||||
--resource-group OpenSignRG \
|
||||
--nsg-name opensign-vmNSG \
|
||||
--name Allow-HTTPS \
|
||||
--priority 1002 \
|
||||
--direction Inbound \
|
||||
--protocol Tcp \
|
||||
--access Allow \
|
||||
--destination-port-ranges 443
|
||||
|
||||
az network nsg rule create \
|
||||
--resource-group OpenSignRG \
|
||||
--nsg-name opensign-vmNSG \
|
||||
--name Allow-Caddy-Internal \
|
||||
--priority 1003 \
|
||||
--direction Inbound \
|
||||
--protocol Tcp \
|
||||
--access Allow \
|
||||
--destination-port-ranges 3001
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🌍 Step 3: Point Domain to VM
|
||||
|
||||
In your DNS provider (e.g., GoDaddy, Cloudflare):
|
||||
|
||||
- Add an **A record**:
|
||||
- Name: `opensign`
|
||||
- Value: `<your VM public IP>`
|
||||
- TTL: 1 min or Auto
|
||||
|
||||
Let it propagate (~5–10 mins).
|
||||
|
||||
---
|
||||
|
||||
## 📦 Step 4: SSH into the VM
|
||||
|
||||
```bash
|
||||
ssh azureuser@<your-vm-ip>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🐳 Step 5: Install Docker + Compose V2
|
||||
|
||||
```bash
|
||||
sudo apt update && sudo apt install docker.io -y
|
||||
|
||||
# Install Compose V2 (CLI plugin)
|
||||
mkdir -p ~/.docker/cli-plugins/
|
||||
curl -SL https://github.com/docker/compose/releases/download/v2.24.5/docker-compose-linux-x86_64 -o ~/.docker/cli-plugins/docker-compose
|
||||
chmod +x ~/.docker/cli-plugins/docker-compose
|
||||
|
||||
# Enable Docker
|
||||
sudo systemctl enable docker
|
||||
```
|
||||
|
||||
Verify:
|
||||
```bash
|
||||
docker compose version
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📁 Step 6: Set Up Project and Volumes
|
||||
|
||||
### 6.1 Create a working directory
|
||||
```bash
|
||||
mkdir opensign && cd opensign
|
||||
```
|
||||
|
||||
### 6.2 Download files
|
||||
```bash
|
||||
export HOST_URL=https://opensign.yourdomain.com
|
||||
|
||||
curl -O https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml
|
||||
curl -O https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/Caddyfile
|
||||
curl -O https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/.env.local_dev
|
||||
mv .env.local_dev .env.prod
|
||||
```
|
||||
Make sure that you update the SMTP settings by editing the .env.prod file in order to receive emails.
|
||||
---
|
||||
|
||||
|
||||
## ⚙️ Step 7: Start the Stack
|
||||
|
||||
Now boot the containers using Compose V2:
|
||||
|
||||
```bash
|
||||
docker compose up -d --force-recreate
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ✅ Step 8: Verify Everything
|
||||
|
||||
- `https://opensign.yourdomain.com` loads the app with HTTPS
|
||||
- Caddy fetched SSL certs automatically
|
||||
- Backend routes work at `/api/*`
|
||||
- MongoDB persists data
|
||||
- Uploaded files persist via `opensign-files` volume
|
||||
|
||||
Test:
|
||||
|
||||
```bash
|
||||
docker exec -it OpenSignServer-container ls /usr/src/app/files
|
||||
docker volume inspect opensign-files
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📦 Step 9: Auto-start on Reboot (optional)
|
||||
|
||||
```bash
|
||||
crontab -e
|
||||
```
|
||||
|
||||
Add:
|
||||
```bash
|
||||
@reboot cd /home/azureuser/opensign && docker compose up -d
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔄 Backups (optional)
|
||||
|
||||
```bash
|
||||
# Backup MongoDB volume
|
||||
docker run --rm -v opensign_data-volume:/data -v $(pwd):/backup ubuntu tar czvf /backup/mongo-backup.tar.gz /data
|
||||
|
||||
# Backup OpenSign files
|
||||
docker run --rm -v opensign_opensign-files:/data -v $(pwd):/backup ubuntu tar czvf /backup/files-backup.tar.gz /data
|
||||
```
|
||||
@@ -5,17 +5,16 @@ title: ENV variables which are used to setup OpenSign™ with Docker on Localhos
|
||||
## Information About ENV variables which are used to setup OpenSign™ with Docker on Localhost
|
||||
To set up OpenSign™ locally using Docker, the following prerequisites are required:
|
||||
|
||||
Environment Varaibles:
|
||||
Environment Variables:
|
||||
|
||||
[//]: # "| appName | open_sign_server | Name of the app. It will be visible in the verification emails sent out. |"
|
||||
[//]: # "| GENERATE_SOURCEMAP | false | Set it to true if you want to generate the Sourcemap for debugging |"
|
||||
[//]: # "| REACT_APP_SERVERURL | http://localhost:8080/app | Set it to the URL from where APIs will be accessible, for local development it should be localhost:8080/app (use your local port number instead) |"
|
||||
[//]: # "| REACT_APP_APPID | opensignstgn | A 12 character long random app identifier. The value of this should be same as APP_ID which is a variable used by backend API. |"
|
||||
|
||||
| Environment Varibale | Value | Description |
|
||||
| Environment Variable | Value | Description |
|
||||
| ------------- | ------------- | ------------- |
|
||||
| PUBLIC_URL | https://localhost:3001 | Set it to the URL form where the app home page will be accessed |
|
||||
| APP_ID | opensign | A 12 character long random app identifier. |
|
||||
| MASTER_KEY | XnAadwKxxByMr | A 12 character long random secret key that allows access to all the data. It is used in Parse dashboard config to view all the data in the database. |
|
||||
| MONGODB_URI | mongodb://mongo-container:27017/OpenSignDB | Mongodb URI to connect to |
|
||||
| PARSE_MOUNT | /app | Path on which APIs should be mounted. Do not change this. This variable shall be removed & value hardcoded in the source code in coming versions. |
|
||||
@@ -38,6 +37,7 @@ Environment Varaibles:
|
||||
| SMTP_PASS | password | Provide smtp password |
|
||||
| PFX_BASE64 | - | Base64 encoded PFX or p12 document signing certificate file. You can generate base64 encoded self sign certificate using the passphrase. |
|
||||
| PASS_PHRASE | opensign | Pass phrase of PFX or p12 document signing certificate file. |
|
||||
| APP_ID | opensign | (DEPRECATED) This should not be changed if provided; it should be 'opensign'. |
|
||||
|
||||
# Steps to generate self-signed document singing certificate
|
||||
```
|
||||
|
||||
+16
-11
@@ -65,19 +65,24 @@ const config = {
|
||||
plugins: [
|
||||
[
|
||||
"docusaurus-plugin-openapi-docs",
|
||||
{
|
||||
id: "openapi",
|
||||
docsPluginId: "default", // e.g. "classic" or the plugin-content-docs id
|
||||
config: {
|
||||
opensign: { // "petstore" is considered the <id> that you will reference in the CLI
|
||||
specPath: "docs/API-docs/opensign.yaml", // path or URL to the OpenAPI spec
|
||||
outputDir: "docs/API-docs", // output directory for generated *.mdx and sidebar.js files
|
||||
sidebarOptions: {
|
||||
groupPathsBy: "tag", // generate a sidebar.js slice that groups operations by tag
|
||||
{
|
||||
id: "openapi",
|
||||
docsPluginId: "default", // e.g. "classic" or the plugin-content-docs id
|
||||
config: {
|
||||
opensign_v1: {
|
||||
// OpenAPI v1
|
||||
specPath: "docs/API-docs/v1/opensign.yaml", // your v1 spec file
|
||||
outputDir: "docs/API-docs/v1", // generated mdx + sidebar.js
|
||||
sidebarOptions: { groupPathsBy: "tag" },
|
||||
},
|
||||
opensign_v1_1: {
|
||||
// OpenAPI v1.1
|
||||
specPath: "docs/API-docs/v1.1/opensign.yaml", // your v1.1 spec file
|
||||
outputDir: "docs/API-docs/v1.1", // generated mdx + sidebar.js
|
||||
sidebarOptions: { groupPathsBy: "tag" },
|
||||
}
|
||||
}
|
||||
},
|
||||
}
|
||||
]
|
||||
],
|
||||
themes: ["docusaurus-theme-openapi-docs"], // exports ApiItem and ApiDemoPanel
|
||||
@@ -150,7 +155,7 @@ const config = {
|
||||
},
|
||||
{
|
||||
label: 'APIs',
|
||||
to: '/docs/API-docs/opensign-api-v-1',
|
||||
to: '/docs/API-docs/v1.1',
|
||||
},
|
||||
{
|
||||
label: 'Contribute',
|
||||
|
||||
+23
-4
@@ -10,7 +10,9 @@
|
||||
*/
|
||||
|
||||
// @ts-check
|
||||
import apiSidebar from './docs/API-docs/sidebar.ts';
|
||||
// import apiSidebar from './docs/API-docs/sidebar.ts';
|
||||
import apiV1Sidebar from './docs/API-docs/v1/sidebar.ts';
|
||||
import apiV11Sidebar from './docs/API-docs/v1.1/sidebar.ts';
|
||||
|
||||
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
|
||||
const sidebars = {
|
||||
@@ -18,9 +20,26 @@ const sidebars = {
|
||||
tutorialSidebar: [{type: 'autogenerated', dirName: 'help'}],
|
||||
selfhostSidebar: [{type: 'autogenerated', dirName: 'self-host'}],
|
||||
contributeSidebar: [{type: 'autogenerated', dirName: 'contribute'}],
|
||||
apiSidebar: apiSidebar,
|
||||
|
||||
|
||||
// apiSidebar: apiSidebar,
|
||||
// Single API sidebar containing two top-level categories
|
||||
apiSidebar: [
|
||||
{
|
||||
type: 'category',
|
||||
label: 'v1.1',
|
||||
link: { type: 'generated-index', title: 'OpenSign API v1.1', slug: '/API-docs/v1.1' },
|
||||
collapsed: false,
|
||||
items: apiV11Sidebar,
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'v1',
|
||||
// Optional: clicking the category label goes to a “generated index”
|
||||
link: { type: 'generated-index', title: 'OpenSign API v1', slug: '/API-docs/v1' },
|
||||
collapsed: true,
|
||||
items: apiV1Sidebar,
|
||||
}
|
||||
],
|
||||
|
||||
// But you can create a sidebar manually
|
||||
/*
|
||||
tutorialSidebar: [
|
||||
|
||||
Reference in New Issue
Block a user