mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-04 00:38:57 +02:00
Compare commits
143
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 | ||
|
|
63cc034b4a | ||
|
|
da45fcfc85 |
@@ -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
|
||||
|
||||
+1037
-116
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."
|
||||
|
||||
@@ -25,3 +25,35 @@ OpenSign™ lets you polish your PDF before you send it out—whether you’re s
|
||||
|
||||
- **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 previous page `<<` & next page `>>` buttons at the top or click on any of the page previews loaded on the left side -
|
||||

|
||||
@@ -85,9 +85,46 @@ Note: This feature is available exclusively on paid plans.
|
||||
- **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 3: 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.
|
||||
@@ -116,24 +153,51 @@ Use the option on the right side to add recipients if you need to include additi
|
||||
- All pages but first: It will copy the initials widget to all pages except the first page.
|
||||
- **Name**: The name widget allows signers to add their name or any other text, functioning like a text field during the signing process. After placing the name widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can set the color and font.
|
||||
|
||||
**Hide text with asterisks**: **"which masks the entered text (*) to protect sensitive information while filling out the document. The final embedded document will also display the text as asterisks, keeping the actual value hidden.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Name widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy : Clicking on this you can duplicate the name widget.
|
||||
- **Job title**: The Job title widget allows signers to add their Job title or any other text, functioning like a text field during the signing process. After placing the job title widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can set the color and font.
|
||||
|
||||
**Hide text with asterisks**: **"which masks the entered text (*) to protect sensitive information while filling out the document. The final embedded document will also display the text as asterisks, keeping the actual value hidden.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Job title widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy : Clicking on this you can duplicate the job title widget.
|
||||
|
||||
- **Company**: The company widget allows signers to add their company or any other text, functioning like a text field during the signing process. After placing the company widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can set the color and font.
|
||||
|
||||
**Hide text with asterisks**: **"which masks the entered text (*) to protect sensitive information while filling out the document. The final embedded document will also display the text as asterisks, keeping the actual value hidden.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Company widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy : Clicking on this you can duplicate the Company widget.
|
||||
- **Date**: The date widget allows signers to add a date during the signing process. After placing the date widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can choose from various date formats.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Date widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy : Clicking on this you can duplicate the date widget.
|
||||
- **Text**: The text field functions as a label. Users can add and type text into this field, which will be embedded in the document when it's sent. This field is not editable by the signer. After placing the Text widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can set the color and font.
|
||||
- Copy : Clicking on this you can duplicate the Text widget.
|
||||
|
||||
- **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**: 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:
|
||||
@@ -142,6 +206,7 @@ Use the option on the right side to add recipients if you need to include additi
|
||||
- Marking the field as **required** or **optional**
|
||||
- Providing a **default value**
|
||||
- Making the field **read-only**
|
||||
- **Hide text with asterisks**: **"which masks the entered text (*) to protect sensitive information while filling out the document. The final embedded document will also display the text as asterisks, keeping the actual value hidden.
|
||||
- Adding a **hint**, which will be displayed on the widget for better clarity
|
||||
- **Custom Validations** are also supported, including:
|
||||
- Predefined formats like **SSN**, **email**, or **numeric values**
|
||||
@@ -169,6 +234,7 @@ Use the option on the right side to add recipients if you need to include additi
|
||||
- Marking the field as **required** or **optional**
|
||||
- Providing a **default value**
|
||||
- Making the field **read-only**
|
||||
- **Hide text with asterisks**: **"which masks the entered text (*) to protect sensitive information while filling out the document. The final embedded document will also display the text as asterisks, keeping the actual value hidden.
|
||||
- Adding a **hint**, which will be displayed on the widget for better clarity
|
||||
|
||||
**Custom Validations** are also supported, including:
|
||||
@@ -200,9 +266,17 @@ Use the option on the right side to add recipients if you need to include additi
|
||||
- Copy : Clicking on this you can duplicate the image widget.
|
||||
- **Email**: The email widget is used to enter an email address during the signing process. It only accepts input in a valid email format. If the signer enters invalid text, a validation error will occur, and the document cannot be completed until it's corrected. After placing the email widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can set the color and font.
|
||||
|
||||
**Hide text with asterisks**: **"which masks the entered text (*) to protect sensitive information while filling out the document. The final embedded document will also display the text as asterisks, keeping the actual value hidden.
|
||||
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Email widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy : Clicking on this you can duplicate the email widget.
|
||||
### 📄 Document Page Controls
|
||||
- **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.
|
||||
|
||||
@@ -217,8 +291,6 @@ Use the option on the right side to add recipients if you need to include additi
|
||||
|
||||
- **Rotate Page**
|
||||
Options are provided to **rotate pages** in both **clockwise** and **counterclockwise** directions.
|
||||
|
||||
<img width="918" alt="OpenSign_Widgets" src="https://github.com/user-attachments/assets/36651043-6646-4a43-9fe3-2650c133a21e" />
|
||||
|
||||
### Step 4: Next:
|
||||
- **Next**: After adding the widgets and signatures, click the 'Next' button. The document will then be created.
|
||||
|
||||
@@ -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:
|
||||
@@ -60,15 +63,19 @@ In the "Draw Signature" popup, you have three options available:
|
||||
- **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/039e2999-8c75-43b6-a742-bfb294aa52ee" />
|
||||
|
||||
<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/8f61a30d-8c65-4343-bdb9-ed7c004c16db" />
|
||||
|
||||
### 📄 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.
|
||||
|
||||
@@ -83,8 +90,6 @@ In the "Draw Signature" popup, you have three options available:
|
||||
|
||||
- **Rotate Page**
|
||||
Options are provided to **rotate pages** in both **clockwise** and **counterclockwise** directions.
|
||||
|
||||
<img width="918" alt="OpenSign_Widgets" src="https://github.com/user-attachments/assets/ae54ce3c-6373-49bf-b905-a4b734444a31" />
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -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™**!
|
||||
@@ -47,6 +47,17 @@ The "Completed documents" report also includes several actions icons for each do
|
||||
|
||||
- **Save as template:** This option allows the user to save the current document as a reusable template. Upon clicking, a confirmation popup will appear. If the user selects Yes, the template will be created successfully. After that, the user will be presented with options to Use Template, Send in Bulk, or Edit the Template. The newly created template will also be available in the Manage Templates list.
|
||||
|
||||
- **View formdata**: Use this option to download all form data collected during the signing process. The exported file contains every input field and its corresponding value, making it easy to review, archive, or process externally.
|
||||
|
||||
You can download the data in Excel format using this option.
|
||||
|
||||
You can also print the form details if needed.
|
||||
|
||||
Fields marked with **Hide Text with Asterisks** will be exported in plain text (unmasked), showing the actual values entered.
|
||||
|
||||
**Note:** You cannot download form data if any widget names in the document are duplicated — each widget must have a unique name.
|
||||
This feature is available only on the **Teams** and **Enterprise** plans.
|
||||
|
||||
- **Fix and resend:** This option allows the user to recreate a completed document.
|
||||
It is useful when the completed document contains missing or incorrect information. Instead of starting from scratch, the user can use this feature to make the necessary edits and resend the document for signature.
|
||||
|
||||
|
||||
@@ -66,6 +66,17 @@ The pop-up will display a list of email addresses of the intended recipients or
|
||||
Upon clicking, a confirmation popup will appear. If the user selects Yes, the template will be created successfully. After that, the user will be presented with options to Use Template, Send in Bulk, or Edit the Template.
|
||||
The newly created template will also be available in the Manage Templates list.
|
||||
|
||||
- **View formdata**: Use this option to download all form data collected during the signing process. The exported file contains every input field and its corresponding value, making it easy to review, archive, or process externally.
|
||||
|
||||
You can download the data in Excel format using this option.
|
||||
|
||||
You can also print the form details if needed.
|
||||
|
||||
Fields marked with **Hide Text with Asterisks** will be exported in plain text (unmasked), showing the actual values entered.
|
||||
|
||||
**Note:** You cannot download form data if any widget names in the document are duplicated — each widget must have a unique name.
|
||||
This feature is available only on the **Teams** and **Enterprise** plans.
|
||||
|
||||
- **Delete :** If the document is outdated or was sent by mistake, you can permanently remove it from the list. Use this action cautiously, as deleted documents cannot be recovered.
|
||||
|
||||
If you require more help, feel free to reach out to our customer support on support@opensignlabs.com.
|
||||
|
||||
@@ -41,6 +41,35 @@ You’ll also find the option to generate a **Sandbox API Token** on the same pa
|
||||
|
||||
<img width="436" alt="Sandbox api token" src="https://github.com/user-attachments/assets/f27d9e00-7989-4c01-b23e-cecaccce4be2" />
|
||||
|
||||
### 🧪 API Credits
|
||||
|
||||
**Premium Credits Available:**
|
||||
Displays the total API credits available for your organisation.
|
||||
|
||||
**Your Credits Usage:**
|
||||
- **Used Credits:** The number of credits you have consumed.
|
||||
- **Remaining Credits:** The number of credits still available for you to use.
|
||||
|
||||
<img width="436" alt="API credit" src="https://github.com/user-attachments/assets/e0d87fb2-7391-4bad-b668-9ce2b558c52d" />
|
||||
|
||||
### Where API Credits Are Deducted
|
||||
|
||||
API credits are consumed whenever a document is created through the following actions:
|
||||
|
||||
- **Self Sign API:** Credits deducted when a document is created.
|
||||
- **Draft Document API:** Deducted when drafting a document.
|
||||
- **Create Document API:** Deducted on document creation.
|
||||
- **Draft Template API:** Deducted when:
|
||||
- Sending a document if signers are already assigned,
|
||||
- Bulk sending,
|
||||
- Creating documents using public templates (signer fills details and finish).
|
||||
- **Create Document From Template API:** Deducted on document creation.
|
||||
|
||||
### In the OpenSign Application
|
||||
|
||||
- **Manage Templates → Bulk Send:** Credits are deducted for each document created.
|
||||
- **Public Template Signing:** Credits are deducted when a document is created during public signing (when the signer enters details and completes the process).
|
||||
|
||||
### 🧪 Sandbox Cloud Account Login
|
||||
|
||||
OpenSign provides a **sandbox testing cloud environment**, which is a replica of the production environment. This allows users to test features without affecting live data.
|
||||
|
||||
@@ -115,53 +115,74 @@ The tour feature provides guidance for first-time users. You can turn this off f
|
||||
---
|
||||
### 📧 Custom SMTP Configuration in OpenSign
|
||||
|
||||
OpenSign allows users to **send emails using their own SMTP configuration**. This includes options to connect with Gmail or use third-party SMTP providers.
|
||||
OpenSign allows users to **send emails using their own SMTP settings**, including Gmail integration and third-party SMTP providers.
|
||||
|
||||
To set up and enable custom SMTP:
|
||||
OpenSign now supports SMTP configuration at both the **organization level** and the **individual user level**.
|
||||
|
||||
1. Navigate to the **Settings** menu.
|
||||
2. Click on **Preferences**.
|
||||
3. Choose one of the available SMTP options below:
|
||||
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
|
||||
|
||||
---
|
||||
|
||||
#### 🔗 Connect to Gmail
|
||||
### ⚙️ Custom SMTP
|
||||
|
||||
OpenSign allows you to send request signature emails directly from your **Gmail account**.
|
||||
Configure any third-party SMTP provider such as SMTP2GO or Mailgun.
|
||||
|
||||
- Click the **Connect to Gmail** button.
|
||||
- A popup will appear prompting you to log in to your Gmail account.
|
||||
- Grant the required permissions.
|
||||
- Once authorized, your OpenSign account will be connected and ready to send emails using your Gmail.
|
||||
|
||||
---
|
||||
|
||||
#### ⚙️ Custom SMTP
|
||||
|
||||
You can also configure a **custom SMTP provider** such as SMTP2GO, Mailgun, etc.
|
||||
|
||||
- Click the **Custom SMTP** button.
|
||||
- A popup will appear asking for your SMTP credentials:
|
||||
- **Host:** SMTP host address (e.g., `mail.smtp2go.com`)
|
||||
- **Port:** SMTP port (e.g., `2525`)
|
||||
- **Sender Email:** Email address configured in your SMTP account
|
||||
- **Username:** SMTP username (can be the same as the sender email)
|
||||
- **Password:** SMTP password
|
||||
- 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
|
||||
### 📤 OpenSign™ Default SMTP
|
||||
|
||||
If you choose the **default SMTP**, all request signature emails will be sent via OpenSign’s built-in SMTP server.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
> ⚠️ **Note:**
|
||||
> - A green checkmark next to an option indicates the **currently active SMTP**.
|
||||
> - **Only one SMTP option can be active at a time.**
|
||||
> - This feature is available only on paid plans.
|
||||
> ⚠️ **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
|
||||
@@ -209,15 +230,59 @@ Even if a certificate becomes invalid in the future, the LTV-enabled signature r
|
||||
- Long-term archiving requirements
|
||||
|
||||
---
|
||||
### **Merge Certificate to PDF**
|
||||
|
||||
## 📧 Email Templates
|
||||
You can access this option by navigating to **Settings → Preferences**.
|
||||
|
||||
In the **Preferences > Email** tab, users can customize email templates to personalize communication with signers and stakeholders.
|
||||
This feature helps maintain brand consistency and enhances engagement throughout the signing workflow.
|
||||
**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.
|
||||
|
||||
👉 [📄 Step-by-step guide to setting up custom email templates](https://docs.opensignlabs.com/docs/help/Settings/Custom-email-templates)
|
||||
**No:** Selecting **No** will keep the completion certificate as a separate PDF file, which will be downloaded along with the signed document.
|
||||
|
||||
**Note:** The custom email templates feature is only available on the **Professional** and higher plans—it is not included in the **Free** plan.
|
||||
> **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.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -28,7 +28,7 @@ Suppose you're using OpenSign to collect eSignatures:
|
||||
**Step 1:** Log in to your OpenSign account using your credentials.
|
||||
**Step 2:** Navigate to **Settings → Webhook**.
|
||||
|
||||

|
||||
<img width="861" height="407" alt="Navigate to Add Webhook" src="https://github.com/user-attachments/assets/883dc914-9316-42b0-b59c-10b168265b38" />
|
||||
|
||||
**Step 3:** Click **Add Webhook**.
|
||||
|
||||
@@ -36,10 +36,121 @@ Suppose you're using OpenSign to collect eSignatures:
|
||||
|
||||
> **Note:** To enable **Live Webhook** support, you must upgrade to a **paid plan** — either the **Professional** or **Teams** plan.
|
||||
|
||||

|
||||
---
|
||||
|
||||
## 🧭 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.
|
||||
|
||||
@@ -62,6 +62,52 @@ To add a new user:
|
||||
- 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
|
||||
|
||||
@@ -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)**.
|
||||
|
||||
|
||||
@@ -81,11 +81,43 @@ Note: This feature is available exclusively on paid plans.
|
||||
## 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.
|
||||
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.
|
||||
@@ -116,28 +148,54 @@ After placing the Stamp widget, you will see the options on the widget such as:
|
||||
- **Name**: The name widget allows signers to add their name or any other text, functioning like a text field during the signing process.
|
||||
After placing the name widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can set the color and font.
|
||||
|
||||
**Hide text with asterisks**: **"which masks the entered text (*) to protect sensitive information while filling out the document. The final embedded document will also display the text as asterisks, keeping the actual value hidden.
|
||||
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Name widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy : Clicking on this you can duplicate the name widget.
|
||||
- **Job title**: The Job title widget allows signers to add their Job title or any other text, functioning like a text field during the signing process.
|
||||
After placing the job title widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can set the color and font.
|
||||
|
||||
**Hide text with asterisks**: **"which masks the entered text (*) to protect sensitive information while filling out the document. The final embedded document will also display the text as asterisks, keeping the actual value hidden.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Job title widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy : Clicking on this you can duplicate the job title widget.
|
||||
|
||||
- **Company**: The company widget allows signers to add their company or any other text, functioning like a text field during the signing process.
|
||||
After placing the company widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can set the color and font.
|
||||
|
||||
**Hide text with asterisks**: **"which masks the entered text (*) to protect sensitive information while filling out the document. The final embedded document will also display the text as asterisks, keeping the actual value hidden.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Company widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy : Clicking on this you can duplicate the Company widget.
|
||||
- **Date**: The date widget allows signers to add a date during the signing process.
|
||||
After placing the date widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can choose from various date formats.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Date widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy : Clicking on this you can duplicate the date widget.
|
||||
- **Text**: The text field functions as a label. Users can add and type text into this field, which will be embedded in the document when it's sent. This field is not editable by the signer.
|
||||
After placing the Text widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can set the color and font.
|
||||
- Copy : Clicking on this you can duplicate the Text widget.
|
||||
|
||||
- **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**: 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:
|
||||
@@ -147,6 +205,7 @@ After placing the Text Input widget, you will see the options on the widget such
|
||||
- Marking the field as **required** or **optional**
|
||||
- Providing a **default value**
|
||||
- Making the field **read-only**
|
||||
- **Hide text with asterisks**: **"which masks the entered text (*) to protect sensitive information while filling out the document. The final embedded document will also display the text as asterisks, keeping the actual value hidden.
|
||||
- Adding a **hint**, which will be displayed on the widget for better clarity
|
||||
- **Custom Validations** are also supported, including:
|
||||
- Predefined formats like **SSN**, **email**, or **numeric values**
|
||||
@@ -175,6 +234,7 @@ After placing the Text Input widget, you will see the options on the widget such
|
||||
- Marking the field as **required** or **optional**
|
||||
- Providing a **default value**
|
||||
- Making the field **read-only**
|
||||
- **Hide text with asterisks**: **"which masks the entered text (*) to protect sensitive information while filling out the document. The final embedded document will also display the text as asterisks, keeping the actual value hidden.
|
||||
- Adding a **hint**, which will be displayed on the widget for better clarity
|
||||
- **Custom Validations** are also supported, including:
|
||||
- Predefined formats like **SSN**, **email**, or **numeric values**
|
||||
@@ -210,6 +270,8 @@ After placing the Image widget, you will see the options on the widget such as:
|
||||
- **Email**: The email widget is used to enter an email address during the signing process. It only accepts input in a valid email format. If the signer enters invalid text, a validation error will occur, and the document cannot be completed until it's corrected.
|
||||
After placing the email widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can set the color and font.
|
||||
|
||||
**Hide text with asterisks**: **"which masks the entered text (*) to protect sensitive information while filling out the document. The final embedded document will also display the text as asterisks, keeping the actual value hidden.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Email widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy : Clicking on this you can duplicate the email widget.
|
||||
### 📄 Edit Template
|
||||
|
||||
@@ -48,6 +48,15 @@ The selected user will be able to access the template and create documents from
|
||||
<img width="828" alt="Manage Template" src="https://github.com/user-attachments/assets/89780622-dd0d-47b7-b3b2-a71d537d7967" />
|
||||
|
||||
<img width="828" alt="Manage Template" src="https://github.com/user-attachments/assets/fdc98efe-dc2d-4e53-bc66-be3aab07eef0" />
|
||||
|
||||
**Download all formdata**: Use this option to download all form data collected during the signing process. The exported file contains every input field and its corresponding value, making it easy to review, archive, or process externally.
|
||||
|
||||
You can download the data in Excel format using this template.
|
||||
|
||||
Fields marked with **Hide Text with Asterisks** will be exported in plain text (unmasked), showing the actual values entered.
|
||||
|
||||
**Note:** You cannot download form data if any widget names in the template are duplicated — each widget must have a unique name.
|
||||
This feature is available only on the **Teams** and **Enterprise** plans.
|
||||
|
||||
**Embed**: The "Embed" option provides you with a code to embed the template into a website or other platforms, allowing users to interact with it directly from the external site.
|
||||
Click "Embed" to generate the code that can be copied and pasted into your desired web location. We currently support React, HTML/JavaScript and Angular-based websites.
|
||||
|
||||
@@ -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."
|
||||
}
|
||||
}
|
||||
@@ -155,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