Skip to main content

🔐 API Authentication – Setting Up Your x-api-token

To authenticate and use OpenSign API endpoints, you’ll need a valid API token (x-api-token).

Follow the steps below to generate one.

Note: You can generate both Live and Sandbox API tokens from your OpenSign account.

🧭 Step-by-Step Guide to Generate Your API Token​

Step 1: Log in to your OpenSign account using valid credentials.

Step 2: Navigate to the Settings section and click on API Token.

Navigate-to-Api-token

Step 3: On the API Token page, click the Generate Live API Token button.

Note: To generate a Live API Token, you must upgrade to a paid plan — either the Professional or Teams plan.

Generate token
  • Your x-api-token will now be generated and displayed.
  • Copy this token — you’ll need it to authenticate your OpenSign API requests.

🧪 Sandbox API Token​

You’ll also find the option to generate a Sandbox API Token on the same page.

  • Sandbox API tokens are available on all plans, including the free plan, and are intended for development and testing.

  • Do not upload confidential data to the Sandbox environment.

    Sandbox api token

🧪 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.
API credit

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.

  • ✅ Available in all plans, including the free plan.
  • 🧪 Ideal for testing and development purposes.
login to sandbox

🔐 How to Access the Sandbox Environment​

  1. Go to the Settings menu.
  2. Click on API Token.
  3. On the API Token page, click Login to Sandbox.
  4. You will be automatically logged in to the sandbox environment using your existing account — no need to enter your username or password.

⚠️ Important Note:
Manually entering your username and password will not work for sandbox login. Always use the "Login to Sandbox" button for access.

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.
buy premium credits

  1. Select the Number of Credits
    Choose the number of credits you wish to purchase and click Proceed.

    buy premium credits

  2. 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.

  3. Payment and Invoice
    A payment link and invoice will be sent to your registered email address.

  4. Complete the Payment
    Open the email and click the Buy Now button to access the payment link and complete the transaction.

🧠 Frequently Asked Questions​

1. What is the OpenSign Sandbox environment?
The Sandbox is a testing environment designed for developers to safely experiment with OpenSign APIs and workflows. It mirrors the live environment but with certain limitations.

2. Can I upload large documents to the Sandbox?
No. Please avoid uploading documents larger than 5MB in the Sandbox. It is optimized for lightweight testing only.

3. Can I use my Live API Token in the Sandbox?
No. Live API Tokens do not work in the Sandbox environment. You’ll need to generate a separate token specifically for Sandbox testing.

4. Why can’t I use a live template in the Sandbox?
Live and Sandbox environments are separate. Templates created in the Live environment cannot be used in the Sandbox, and vice versa.

5. Can I use the API in the free self-hosted environment?
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.