Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 40 additions & 1 deletion docs/docs/help/Settings/APIToken.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ OpenSign provides a **sandbox testing cloud environment**, which is a replica of
---
### Buy the api credit
User can buy the api credit using this feature
On the click of the buy premium credits the
On the click of the buy premium credits.

## 🧠 Frequently Asked Questions

Expand All @@ -111,4 +111,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.
7 changes: 7 additions & 0 deletions docs/docs/help/Templates/manage-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
17 changes: 9 additions & 8 deletions docs/docs/help/Templates/quick-send.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -92,15 +92,15 @@ 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/0b8fb941-db29-4517-98d3-23bf58e5fa02" />

---

## Import Data Using CSV

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/5057d5a4-1409-4ec9-8a87-df4b54762b5b" />

### Steps to Import CSV
1. Click **Download sample file**
Expand Down Expand Up @@ -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

Expand All @@ -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/27b18a1d-6750-4631-b090-93644211ce68" />

How to Send the Document:
- Click the Bulk Send button next to the template in the list.
Expand Down