mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-04 00:38:57 +02:00
Compare commits
27
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
27c1c7ecd3 | ||
|
|
c3cf0057e3 | ||
|
|
3c25b09bf4 | ||
|
|
afe753fc85 | ||
|
|
bc05ef669b | ||
|
|
465d5e217c | ||
|
|
d1019e3ef6 | ||
|
|
5c3949239e | ||
|
|
3e0fb1cf15 | ||
|
|
9ffde3b609 | ||
|
|
235665dca2 | ||
|
|
baa1579d1b | ||
|
|
d95c559d01 | ||
|
|
2b3ff7ba92 | ||
|
|
42802da227 | ||
|
|
59c7440c61 | ||
|
|
047c43ecf4 | ||
|
|
a881fd6061 | ||
|
|
672bf237a8 | ||
|
|
1642955a4e | ||
|
|
232b1251fa | ||
|
|
d7846f299a | ||
|
|
aa6eec7a2c | ||
|
|
4c7094c0a5 | ||
|
|
6abdad8d84 | ||
|
|
67b7303c2b | ||
|
|
4ea968219b |
@@ -5214,8 +5214,13 @@ components:
|
||||
remind_once_in_every:
|
||||
type: number
|
||||
example: 0
|
||||
bcc:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
example: ["user@example.com","user2@example.com"]
|
||||
prefill:
|
||||
$ref: '#/components/schemas/prefill'
|
||||
$ref: '#/components/schemas/prefill'
|
||||
xml:
|
||||
name: template_details
|
||||
contact:
|
||||
@@ -5394,7 +5399,17 @@ components:
|
||||
example: false
|
||||
remind_once_in_every:
|
||||
type: number
|
||||
example: 0
|
||||
example: 0
|
||||
pen_colors:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
example: ["blue", "red", "black"]
|
||||
bcc:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
example: ["user@example.com","user2@example.com"]
|
||||
xml:
|
||||
name: documentwithstatus
|
||||
signerIpsResponse:
|
||||
@@ -5716,6 +5731,13 @@ components:
|
||||
items:
|
||||
type: string
|
||||
example: ["blue", "red", "black"]
|
||||
bcc:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
example: ["user@example.com","user2@example.com"]
|
||||
description: |
|
||||
bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.
|
||||
draftdocument_body:
|
||||
required:
|
||||
- file
|
||||
@@ -5821,6 +5843,13 @@ components:
|
||||
items:
|
||||
type: string
|
||||
example: ["blue", "red", "black"]
|
||||
bcc:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
example: ["user@example.com","user2@example.com"]
|
||||
description: |
|
||||
bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.
|
||||
prefill:
|
||||
$ref: '#/components/schemas/prefill'
|
||||
createdocument_body:
|
||||
@@ -5929,6 +5958,13 @@ components:
|
||||
items:
|
||||
type: string
|
||||
example: ["blue", "red", "black"]
|
||||
bcc:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
example: ["user@example.com","user2@example.com"]
|
||||
description: |
|
||||
bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.
|
||||
prefill:
|
||||
$ref: '#/components/schemas/prefill'
|
||||
inline_response_200_1:
|
||||
@@ -6018,6 +6054,8 @@ components:
|
||||
type: boolean
|
||||
description: |
|
||||
This parameter allows you to specify whether you want emails to be sent to signers. The default value is "true". If the value of this parameter is "true" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.
|
||||
|
||||
If the field is omitted or provided as an empty/invalid value, the template value is used.
|
||||
example: true
|
||||
email_subject:
|
||||
type: string
|
||||
@@ -6029,32 +6067,59 @@ components:
|
||||
example: "<p>Hi {{receiver_name}},</p><p>We hope this email finds you well. <strong>{{sender_name}}</strong> has requested you to review and sign <strong>{{document_title}}</strong>.</p><p>Your signature is crucial to proceed with the next steps as it signifies your agreement and authorization.</p><p><a href='{{signing_url}}'>Sign here</a></p><p>If you have any questions or need further clarification, please contact the sender.</p><p>Thanks,<br>Team OpenSign™</p>"
|
||||
sendInOrder:
|
||||
type: boolean
|
||||
description: "If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'."
|
||||
description: |
|
||||
**true** - Only the first signer receives the signature request email initially. Each subsequent signer is notified in sequence, only after the previous signer has completed their signing. This is the default behavior.
|
||||
|
||||
**false** - All signers receive the signature request email simultaneously.
|
||||
|
||||
If the field is omitted or provided as an empty/invalid value, the template value is used.
|
||||
example: true
|
||||
timeToCompleteDays:
|
||||
type: number
|
||||
description: time to complete days is used to calculate expiry date of your document
|
||||
description: time to complete days is used to calculate expiry date of your document. If this field is present in the request body, it overrides the template value, even when set to 0. If omitted, the template value is used.
|
||||
format: number
|
||||
example: 15
|
||||
enableOTP:
|
||||
type: boolean
|
||||
description: "true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps."
|
||||
description: |
|
||||
**true** - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document.
|
||||
|
||||
**false** - this option will disable OTP verification, allowing users to sign the document directly without additional steps.
|
||||
|
||||
If the field is omitted or provided as an empty/invalid value, the template value is used.
|
||||
example: false
|
||||
enableTour:
|
||||
type: boolean
|
||||
description: "true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience."
|
||||
description: |
|
||||
**true** - this option will enable a guided tour for signers, providing instructions during the signing process.
|
||||
|
||||
**false** - disable the guided tour, ensuring a faster, uninterrupted signing experience.
|
||||
|
||||
If the field is omitted or provided as an empty/invalid value, the template value is used.
|
||||
example: false
|
||||
sender_name:
|
||||
type: string
|
||||
description: The name of the person or organization on whose behalf the email is being sent.
|
||||
description: |
|
||||
The name of the person or organization on whose behalf the email is being sent. If this field is present in the request body, it overrides the template value, even when set to an empty string (""). If omitted, the template value is used.
|
||||
|
||||
If nothing is set, it will use the owner’s preferences. If the owner’s preferences are also not set, it will default to "".
|
||||
example: opensign™
|
||||
sender_email:
|
||||
type: string
|
||||
description: The email address of the person or organization that users can reply to.
|
||||
description: |
|
||||
The email address of the person or organization that users can reply to. If this field is present in the request body, it overrides the template value, even when set to an empty string (""). If omitted, the template value is used.
|
||||
|
||||
If nothing is set, it will use the owner’s preferences. If the owner’s preferences are also not set, it will default to "".
|
||||
|
||||
example: mailer@opensignlabs.com
|
||||
allow_modifications:
|
||||
type: boolean
|
||||
description: "true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value."
|
||||
description: |
|
||||
**true** - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document.
|
||||
|
||||
**false** - Restricts signers from adding any additional elements to the document. This is the default value.
|
||||
|
||||
If the field is omitted or provided as an empty/invalid value, the template value is used.
|
||||
example: false
|
||||
file:
|
||||
type: string
|
||||
@@ -6063,11 +6128,11 @@ components:
|
||||
example: ""
|
||||
auto_reminder:
|
||||
type: boolean
|
||||
description: "Set to true to enable automatic reminders. Set to false to disable them (default behavior)."
|
||||
description: Set to true to enable automatic reminders. Set to false to disable them (default behavior). If the field is omitted or provided as an empty/invalid value, the template value is used.
|
||||
example: false
|
||||
remind_once_in_every:
|
||||
type: number
|
||||
description: "Number of days between reminders. This is only applicable when auto_reminder is set to true."
|
||||
description: Number of days between reminders. This is only applicable when auto_reminder is set to true. If this field is present in the request body, it overrides the template value, even when set to 0. If omitted, the template value is used.
|
||||
example: 5
|
||||
merge_certificate:
|
||||
type: boolean
|
||||
@@ -6087,11 +6152,24 @@ components:
|
||||
**false** - The document creator will not receive an email notification whenever a signer signs the document.
|
||||
|
||||
Note: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on 'send_email' parameter.
|
||||
redirect_url:
|
||||
type: string
|
||||
description: Specifies the URL where the signer will be redirected upon completing the document signing process. If this field is present in the request body, it overrides the template value, even when set to an empty string (""). If omitted, the template value is used.
|
||||
example: ""
|
||||
pen_colors:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
example: ["blue", "red", "black"]
|
||||
example: ["blue", "red", "black"]
|
||||
bcc:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
example: ["user@example.com","user2@example.com"]
|
||||
description: |
|
||||
bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.
|
||||
If this field is present in the request body, it overrides the template value, even when provided as an empty array ([]).
|
||||
If omitted or provided empty string ("") the template value is used.
|
||||
prefill:
|
||||
type: object
|
||||
properties:
|
||||
@@ -6197,7 +6275,14 @@ components:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
example: ["blue", "red", "black"]
|
||||
example: ["blue", "red", "black"]
|
||||
bcc:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
example: ["user@example.com","user2@example.com"]
|
||||
description: |
|
||||
bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.
|
||||
inline_response_200_3:
|
||||
type: object
|
||||
properties:
|
||||
@@ -6324,9 +6409,16 @@ components:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
example: ["blue", "red", "black"]
|
||||
example: ["blue", "red", "black"]
|
||||
bcc:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
example: ["user@example.com","user2@example.com"]
|
||||
description: |
|
||||
bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.
|
||||
prefill:
|
||||
$ref: '#/components/schemas/prefill'
|
||||
$ref: '#/components/schemas/prefill'
|
||||
inline_response_draft_200:
|
||||
type: object
|
||||
properties:
|
||||
@@ -6423,7 +6515,14 @@ components:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
example: ["blue", "red", "black"]
|
||||
example: ["blue", "red", "black"]
|
||||
bcc:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
example: ["user@example.com","user2@example.com"]
|
||||
description: |
|
||||
bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.
|
||||
inline_response_404_7:
|
||||
type: object
|
||||
properties:
|
||||
|
||||
@@ -89,9 +89,28 @@ OpenSign provides a **sandbox testing cloud environment**, which is a replica of
|
||||
> ⚠️ **Important Note:**
|
||||
> Manually entering your username and password will **not work** for sandbox login. Always use the "Login to Sandbox" button for access.
|
||||
---
|
||||
### Buy the api credit
|
||||
User can buy the api credit using this feature
|
||||
On the click of the buy premium credits the
|
||||
### Buy API Credits
|
||||
|
||||
Follow these steps to purchase premium API credits:
|
||||
|
||||
1. **Navigate to the Purchase Page**
|
||||
Go to **Settings → API Token → Buy Premium Credits**.
|
||||
|
||||
<img width="436" alt="buy premium credits" src="https://github.com/user-attachments/assets/82d7c571-702f-4f7f-83eb-baa86a63b829" />
|
||||
|
||||
3. **Select the Number of Credits**
|
||||
Choose the number of credits you wish to purchase and click **Proceed**.
|
||||
|
||||
<img width="436" alt="buy premium credits" src="https://github.com/user-attachments/assets/da7f72e6-84be-481b-9f5d-36bffafb11ae" />
|
||||
|
||||
5. **Credits Added to Your Account**
|
||||
The selected credits are instantly added to your account. You can view the updated balance in the **Premium Credits Available** section.
|
||||
|
||||
6. **Payment and Invoice**
|
||||
A **payment link** and **invoice** will be sent to your registered email address.
|
||||
|
||||
7. **Complete the Payment**
|
||||
Open the email and click the **Buy Now** button to access the payment link and complete the transaction.
|
||||
|
||||
## 🧠 Frequently Asked Questions
|
||||
|
||||
@@ -111,4 +130,43 @@ Live and Sandbox environments are **separate**. Templates created in the Live en
|
||||
No. The **free self-hosted version** does not support API token generation.
|
||||
To use OpenSign APIs in a self-hosted setup, you must upgrade to a **paid self-hosted plan**.
|
||||
|
||||
**6. When are Premium Credits deducted? Which actions use Premium Credits?**
|
||||
|
||||
Premium Credits are deducted whenever you use features that require premium access.
|
||||
|
||||
The following features consume Premium Credits:
|
||||
|
||||
- **API Signature** – Sending documents for signing via API
|
||||
- **Bulk Send** – Sending documents in bulk to multiple recipients
|
||||
- **Public Template Signing** – Sign documents using a public template.
|
||||
- **Kiosk Mode** – Using Kiosk Mode for in-person signing
|
||||
- **Embedded Signing** – Integrating OpenSign into your website or application for signing
|
||||
|
||||
---
|
||||
|
||||
**7. Do regular document sends consume Premium Credits?**
|
||||
|
||||
No. Standard document sending does **not** consume Premium Credits.
|
||||
|
||||
The following actions do not use Premium Credits:
|
||||
|
||||
1. **Sign Yourself** document signing
|
||||
2. **Request Signature** – Sending a single document for signature
|
||||
3. **Use Template** – Sending a document using a template
|
||||
4. Sharing or copying a document link
|
||||
5. Resending a document from the **In Progress** section
|
||||
6. Fix and Resend for completed document reports
|
||||
|
||||
---
|
||||
|
||||
**8. How can I track my Premium Credit usage?**
|
||||
|
||||
You can monitor your Premium Credit usage from:
|
||||
|
||||
**Account Settings → API Token page**
|
||||
|
||||
On this page, you can view:
|
||||
- Available Premium Credits
|
||||
- Your credit usage details
|
||||
|
||||
If you need additional assistance setting up OpenSign APIs, feel free to contact our support team at support@opensignlabs.com.
|
||||
|
||||
@@ -101,7 +101,13 @@ Decide whether the document should be signed **sequentially** or **simultaneousl
|
||||
> Users can change this option while creating the document or a template.
|
||||
|
||||
---
|
||||
## ✉️ Use profile name as sender
|
||||
|
||||
- **On** – When this option is enabled, your profile name will be used as the sender name in Request Signature and Document Completion emails.
|
||||
|
||||
- **Off** – When it is disabled, your SMTP email ID will be used as the sender name.
|
||||
|
||||
---
|
||||
## 🚫 Enable Tour
|
||||
|
||||
The tour feature provides guidance for first-time users. You can turn this off for a cleaner, uninterrupted experience:
|
||||
|
||||
@@ -19,6 +19,8 @@ On the Manage templates page you will see a list of templates you have created o
|
||||
|
||||
**Bulk send**: This feature streamlines processing by allowing you to create and send multiple documents at once using a selected template. You can add multiple signers and generate all documents with a single click.
|
||||
|
||||
Note: The API credit is deducted when the document is sent using the Bulk Send feature. Each document consumes 1 API credit.
|
||||
|
||||
**Edit**: The "Edit" feature is crucial for keeping your document templates up-to-date and relevant. Whether you need to make minor tweaks or major changes, OpenSign's editing capabilities are user-friendly and efficient.
|
||||
Click on the three dots next to the template you want to edit.
|
||||
Select "Edit." Make the necessary changes and save them.
|
||||
@@ -63,14 +65,19 @@ Click "Embed" to generate the code that can be copied and pasted into your desir
|
||||
|
||||
<img width="828" alt="Embed" src="https://github.com/user-attachments/assets/05dcaf5d-07b0-4069-bcd5-83e2daf71e29" />
|
||||
|
||||
Note: The Premium api credit is deducted when the document is signed.
|
||||
|
||||
**Copy template id**: This action copies the unique ID associated with the template, which is useful for embedding or sharing with public users when your template is set to public.
|
||||
|
||||
**Copy public URL**: This generates a public link for the template, allowing external users to access it without logging into OpenSign.
|
||||
Click "Copy Public URL" to generate the link, then share it as needed.
|
||||
|
||||
Note: The Premium api credit is deducted when the document is signed.
|
||||
|
||||
**Kiosk Mode**: Kiosk Mode offers a simplified and secure environment for signers to complete documents on a shared or public device. It's ideal for use cases like front-desk sign-ins, in-office document execution, or on-site registrations where multiple individuals need to sign documents one after another.
|
||||
|
||||
When you click the Kiosk Mode option along with a selected template, the document opens in a dedicated signing interface. Signers can then complete their portions sequentially on the same screen and device, ensuring a smooth and efficient signing flow without requiring individual logins.
|
||||
|
||||
Note: This feature is available exclusively on Teams and Enterprise plans.
|
||||
|
||||
**Duplicate**: When you need to create a copy of an existing template, use the Duplicate option. This feature allows you to quickly generate an exact replica of the selected template, making it easy to reuse and modify without affecting the original.
|
||||
|
||||
@@ -52,8 +52,6 @@ The OpenSign Public profile feature offers the ultimate public document signing
|
||||
- **[2] Add other widgets**: Depending on your needs, you can include additional widgets such as:
|
||||
Stamps, Initials, Name, Date, Text, Checkbox, and more.
|
||||
|
||||
**Important**: Before proceeding, ensure that all roles have assigned signers, except for the public role, since we are making this template public.
|
||||
|
||||
### Save template
|
||||
- **Next button**: Once you’ve organized your widgets and set their properties, simply click the “Next” button to save your template.
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
title: Quickly Send the Document for Signature Using Template
|
||||
title: Bulk Document Send for Signature Using Template
|
||||
---
|
||||
## Overview
|
||||
Bulk Send allows you to send a document to multiple recipients at once using a template. You can prefill document data, signer details, and import information using a CSV file to automate large-scale document sending.
|
||||
|
||||
# How to use the OpenSign Quick Send feature to send a document for signature using a template
|
||||
# How to Use the OpenSign Bulk Document Send Feature to Send Documents for Signature Using a Template
|
||||
|
||||
### Step 1: Begin New Template Creation
|
||||
|
||||
@@ -92,7 +92,7 @@ When a template contains Prefill Widgets:
|
||||
- Entered values are automatically embedded into the document
|
||||
- Both **Required** and **Optional** Prefill fields are supported
|
||||
|
||||
<img width="828" alt="Bulk send panel" src="https://github.com/user-attachments/assets/91b908c8-3c24-4afc-9bd9-6b29cb778891" />
|
||||
<img width="828" alt="Bulk send panel" src="https://github.com/user-attachments/assets/567c4549-52aa-477d-8c94-a5acc6835ce6" />
|
||||
|
||||
---
|
||||
|
||||
@@ -100,7 +100,7 @@ When a template contains Prefill Widgets:
|
||||
|
||||
You can upload a CSV file to automatically populate Prefill fields and signer details.
|
||||
|
||||
<img width="828" alt="bulk import from csv" src="https://github.com/user-attachments/assets/448a7a94-8685-47cc-86a7-dbd47e67c8f6" />
|
||||
<img width="828" alt="bulk import from csv" src="https://github.com/user-attachments/assets/d4aa2fd0-80a9-4e6b-8261-4331f1c9fc17" />
|
||||
|
||||
### Steps to Import CSV
|
||||
1. Click **Download sample file**
|
||||
@@ -184,13 +184,14 @@ Use:
|
||||
|
||||
## Bulk Send Limits
|
||||
|
||||
OpenSign allows sending up to **50 documents per Bulk Send**.
|
||||
OpenSign allows sending up to **1000 documents per Bulk Send**.
|
||||
|
||||
The number depends on signer roles:
|
||||
|
||||
- **1 Role in template → 50 documents** (This depends on the number of signers included in the Bulk Send request.)
|
||||
- **2 Roles in template → 48 documents**
|
||||
- **1 Role in template → 1000 documents** (This depends on the number of signers included in the Bulk Send request.)
|
||||
- **2 Roles in template → 500 documents**
|
||||
- More roles reduce total documents accordingly
|
||||
- Each document consumes 1 API credit. If you create 200 documents, then 200 premium credits will be deducted.(Premium credits)
|
||||
---
|
||||
## Sending Documents via Bulk Send
|
||||
|
||||
@@ -205,7 +206,7 @@ Signature request emails will be sent to the respective signers, and the created
|
||||
### Step 4: Bulk Send from Manage Templates
|
||||
For faster processing, the Bulk Send feature allows you to swiftly create and send a document to a signer using the selected template.
|
||||
|
||||
<img width="828" alt="Manage Template" src="https://github.com/user-attachments/assets/a8737a76-0c92-4288-894d-65640a7757fe" />
|
||||
<img width="828" alt="Manage Template" src="https://github.com/user-attachments/assets/cb6f77ef-a542-49c9-a0ab-1cc568dc54df" />
|
||||
|
||||
How to Send the Document:
|
||||
- Click the Bulk Send button next to the template in the list.
|
||||
|
||||
@@ -38,6 +38,8 @@ Copy the command above, paste it into the terminal, and press Enter to pull and
|
||||
Make sure to replace the host URL with your subdomain where OpenSign will be accessible.
|
||||
|
||||
You will also need to point the subdomain to the server executing these commands by adding the correct A record to your DNS settings.
|
||||
|
||||
> ⚠️ **WARNING:** MAKE SURE THAT PORT **27017** IS NOT EXPOSED TO THE INTERNET, AS THE DEFAULT CONFIGURATION DOES NOT ENABLE MONGODB AUTHENTICATION.
|
||||
|
||||
### Running locally
|
||||
If instead want to run locally try out below commands.
|
||||
|
||||
Reference in New Issue
Block a user