Skip to content

Commit d7846f2

Browse files
Merge pull request #2136 from pravinOpenSign/patch-63
Patch 63
2 parents 67b7303 + aa6eec7 commit d7846f2

3 files changed

Lines changed: 56 additions & 9 deletions

File tree

docs/docs/help/Settings/APIToken.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ OpenSign provides a **sandbox testing cloud environment**, which is a replica of
9191
---
9292
### Buy the api credit
9393
User can buy the api credit using this feature
94-
On the click of the buy premium credits the
94+
On the click of the buy premium credits.
9595

9696
## 🧠 Frequently Asked Questions
9797

@@ -111,4 +111,43 @@ Live and Sandbox environments are **separate**. Templates created in the Live en
111111
No. The **free self-hosted version** does not support API token generation.
112112
To use OpenSign APIs in a self-hosted setup, you must upgrade to a **paid self-hosted plan**.
113113

114+
**6. When are Premium Credits deducted? Which actions use Premium Credits?**
115+
116+
Premium Credits are deducted whenever you use features that require premium access.
117+
118+
The following features consume Premium Credits:
119+
120+
- **API Signature** – Sending documents for signing via API
121+
- **Bulk Send** – Sending documents in bulk to multiple recipients
122+
- **Public Template Signing** – Sign documents using a public template.
123+
- **Kiosk Mode** – Using Kiosk Mode for in-person signing
124+
- **Embedded Signing** – Integrating OpenSign into your website or application for signing
125+
126+
---
127+
128+
**7. Do regular document sends consume Premium Credits?**
129+
130+
No. Standard document sending does **not** consume Premium Credits.
131+
132+
The following actions do not use Premium Credits:
133+
134+
1. **Sign Yourself** document signing
135+
2. **Request Signature** – Sending a single document for signature
136+
3. **Use Template** – Sending a document using a template
137+
4. Sharing or copying a document link
138+
5. Resending a document from the **In Progress** section
139+
6. Fix and Resend for completed document reports
140+
141+
---
142+
143+
**8. How can I track my Premium Credit usage?**
144+
145+
You can monitor your Premium Credit usage from:
146+
147+
**Account Settings → API Token page**
148+
149+
On this page, you can view:
150+
- Available Premium Credits
151+
- Your credit usage details
152+
114153
If you need additional assistance setting up OpenSign APIs, feel free to contact our support team at support@opensignlabs.com.

docs/docs/help/Templates/manage-templates.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ On the Manage templates page you will see a list of templates you have created o
1919

2020
**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.
2121

22+
Note: The API credit is deducted when the document is sent using the Bulk Send feature. Each document consumes 1 API credit.
23+
2224
**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.
2325
Click on the three dots next to the template you want to edit.
2426
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
6365

6466
<img width="828" alt="Embed" src="https://github.com/user-attachments/assets/05dcaf5d-07b0-4069-bcd5-83e2daf71e29" />
6567

68+
Note: The Premium api credit is deducted when the document is signed.
69+
6670
**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.
6771

6872
**Copy public URL**: This generates a public link for the template, allowing external users to access it without logging into OpenSign.
6973
Click "Copy Public URL" to generate the link, then share it as needed.
7074

75+
Note: The Premium api credit is deducted when the document is signed.
76+
7177
**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.
7278

7379
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.
80+
7481
Note: This feature is available exclusively on Teams and Enterprise plans.
7582

7683
**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.

docs/docs/help/Templates/quick-send.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
sidebar_position: 4
3-
title: Quickly Send the Document for Signature Using Template
3+
title: Bulk Document Send for Signature Using Template
44
---
55
## Overview
66
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.
77

8-
# How to use the OpenSign Quick Send feature to send a document for signature using a template
8+
# How to Use the OpenSign Bulk Document Send Feature to Send Documents for Signature Using a Template
99

1010
### Step 1: Begin New Template Creation
1111

@@ -92,15 +92,15 @@ When a template contains Prefill Widgets:
9292
- Entered values are automatically embedded into the document
9393
- Both **Required** and **Optional** Prefill fields are supported
9494

95-
<img width="828" alt="Bulk send panel" src="https://github.com/user-attachments/assets/91b908c8-3c24-4afc-9bd9-6b29cb778891" />
95+
<img width="828" alt="Bulk send panel" src="https://github.com/user-attachments/assets/0b8fb941-db29-4517-98d3-23bf58e5fa02" />
9696

9797
---
9898

9999
## Import Data Using CSV
100100

101101
You can upload a CSV file to automatically populate Prefill fields and signer details.
102102

103-
<img width="828" alt="bulk import from csv" src="https://github.com/user-attachments/assets/448a7a94-8685-47cc-86a7-dbd47e67c8f6" />
103+
<img width="828" alt="bulk import from csv" src="https://github.com/user-attachments/assets/5057d5a4-1409-4ec9-8a87-df4b54762b5b" />
104104

105105
### Steps to Import CSV
106106
1. Click **Download sample file**
@@ -184,13 +184,14 @@ Use:
184184

185185
## Bulk Send Limits
186186

187-
OpenSign allows sending up to **50 documents per Bulk Send**.
187+
OpenSign allows sending up to **1000 documents per Bulk Send**.
188188

189189
The number depends on signer roles:
190190

191-
- **1 Role in template → 50 documents** (This depends on the number of signers included in the Bulk Send request.)
192-
- **2 Roles in template → 48 documents**
191+
- **1 Role in template → 1000 documents** (This depends on the number of signers included in the Bulk Send request.)
192+
- **2 Roles in template → 500 documents**
193193
- More roles reduce total documents accordingly
194+
- Each document consumes 1 API credit. If you create 200 documents, then 200 premium credits will be deducted.(Premium credits)
194195
---
195196
## Sending Documents via Bulk Send
196197

@@ -205,7 +206,7 @@ Signature request emails will be sent to the respective signers, and the created
205206
### Step 4: Bulk Send from Manage Templates
206207
For faster processing, the Bulk Send feature allows you to swiftly create and send a document to a signer using the selected template.
207208

208-
<img width="828" alt="Manage Template" src="https://github.com/user-attachments/assets/a8737a76-0c92-4288-894d-65640a7757fe" />
209+
<img width="828" alt="Manage Template" src="https://github.com/user-attachments/assets/27b18a1d-6750-4631-b090-93644211ce68" />
209210

210211
How to Send the Document:
211212
- Click the Bulk Send button next to the template in the list.

0 commit comments

Comments
 (0)