mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-04 00:38:57 +02:00
Compare commits
16
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
27c1c7ecd3 | ||
|
|
c3cf0057e3 | ||
|
|
3c25b09bf4 | ||
|
|
afe753fc85 | ||
|
|
bc05ef669b | ||
|
|
465d5e217c | ||
|
|
d1019e3ef6 | ||
|
|
5c3949239e | ||
|
|
3e0fb1cf15 | ||
|
|
9ffde3b609 | ||
|
|
235665dca2 | ||
|
|
baa1579d1b | ||
|
|
d95c559d01 | ||
|
|
2b3ff7ba92 | ||
|
|
42802da227 | ||
|
|
232b1251fa |
@@ -6054,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
|
||||
@@ -6065,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
|
||||
@@ -6099,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
|
||||
@@ -6123,6 +6152,10 @@ 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:
|
||||
@@ -6134,7 +6167,9 @@ components:
|
||||
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.
|
||||
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:
|
||||
|
||||
@@ -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.
|
||||
### 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
|
||||
|
||||
|
||||
@@ -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:
|
||||
|
||||
Reference in New Issue
Block a user