OpenSignLabs

https://docs.opensignlabs.com/docs/
Admin
OpenSignLabs provides documentation for its software, guiding users through APIs, contributions, and...
Tokens:118,259
Snippets:1,171
Trust Score:8.1
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install Docker and Compose

Source: https://docs.opensignlabs.com/docs/self-host/guides/azure-vm-setup

Installs Docker and the Compose V2 CLI plugin on the Ubuntu instance.

```bash
sudo apt update && sudo apt install docker.io -y  
  
# Install Compose V2 (CLI plugin)  
mkdir -p ~/.docker/cli-plugins/  
curl -SL https://github.com/docker/compose/releases/download/v2.24.5/docker-compose-linux-x86_64 -o ~/.docker/cli-plugins/docker-compose  
chmod +x ~/.docker/cli-plugins/docker-compose  
  
# Enable Docker  
sudo systemctl enable docker  
```

--------------------------------

### Install project dependencies

Source: https://docs.opensignlabs.com/docs/contribute/INSTALLATION

Installs all required NPM packages for the frontend application.

```bash
npm install  
```

--------------------------------

### Start OpenSign Services

Source: https://docs.opensignlabs.com/docs/self-host/docker/upgrade-deployment

Command to start the updated containers in detached mode.

```bash
docker compose up -d  
```

--------------------------------

### C# HttpClient Request Example

Source: https://docs.opensignlabs.com/docs/API-docs/v1/get-template

Example implementation using C# HttpClient to fetch a template.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://sandbox.opensignlabs.com/api/v1/template/:template_id");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("x-api-token", "<x-api-token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Get Folder Request in C#

Source: https://docs.opensignlabs.com/docs/API-docs/v1/getfolder

Example implementation using HttpClient to fetch folder details.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://sandbox.opensignlabs.com/api/v1/folder/:folder_id");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("x-api-token", "<x-api-token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Get Document List Request (C#)

Source: https://docs.opensignlabs.com/docs/API-docs/v1/getdocumentlist

Example using HttpClient to fetch the document list.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://sandbox.opensignlabs.com/api/v1/documentlist/:doctype");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("x-api-token", "<x-api-token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Get Credits Request in C#

Source: https://docs.opensignlabs.com/docs/API-docs/v1.1/getcredits

Example implementation using HttpClient to retrieve credit information.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://sandbox.opensignlabs.com/api/v1.1/getcredits");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("x-api-token", "<x-api-token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Get Template Request using HttpClient

Source: https://docs.opensignlabs.com/docs/API-docs/v1.1/get-template

Example of performing a GET request to retrieve a template using C# HttpClient.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://sandbox.opensignlabs.com/api/v1.1/template/:template_id");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("x-api-token", "<x-api-token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### C# HttpClient Request Example

Source: https://docs.opensignlabs.com/docs/API-docs/v1.1/getsignerips

Example implementation using C# HttpClient to fetch signer IPs.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://sandbox.opensignlabs.com/api/v1.1/signerips/:document_id");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("x-api-token", "<x-api-token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Widget Configuration Examples

Source: https://docs.opensignlabs.com/docs/API-docs/v1/createdocumentwithtemplateid

JSON configurations for setting default values in document widgets.

```json
{
  "name": "email",
  "readonly": false,
  "default": "email@example.com"
}
```

```json
{
  "name": "name",
  "readonly": false,
  "default": "joe"
}
```

```json
{
  "name": "job title",
  "readonly": false,
  "default": "ceo"
}
```

```json
{
  "name": "company",
  "readonly": false,
  "default": "example pvt ltd"
}
```

```json
{
  "name": "date",
  "readonly": false,
  "default": "11-05-2025"
}
```

```json
{
  "name": "textbox",
  "readonly": false,
  "default": "my text"
}
```

```json
{
  "name": "checkbox",
  "readonly": false,
  "default": ["option-2"]
}
```

```json
{
  "name": "dropdown",
  "readonly": false,
  "default": "option1"
}
```

```json
{
  "name": "radio",
  "readonly": false,
  "default": "option1"
}
```

--------------------------------

### AND Condition Logic Example

Source: https://docs.opensignlabs.com/docs/help/New-Document/conditional_logic

Requires all specified conditions to be met before the action is triggered.

```text
Text Input = HR  
  
AND  
  
Number = 10  
  
AND  
  
Checkbox is Checked  
```

--------------------------------

### C# HttpClient Implementation

Source: https://docs.opensignlabs.com/docs/API-docs/v1/createfolder

Example implementation using C# HttpClient to create a folder.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://sandbox.opensignlabs.com/api/v1/createfolder");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("x-api-token", "<x-api-token>");
var content = new StringContent("{\n  \"folderName\": \"new folder\",\n  \"parentFolderId\": \"\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Start Docker Stack

Source: https://docs.opensignlabs.com/docs/self-host/guides/azure-vm-setup

Launches the application containers in detached mode.

```bash
docker compose up -d --force-recreate  
```

--------------------------------

### Prefill Widget Examples

Source: https://docs.opensignlabs.com/docs/API-docs/v1.1/createdocumentwithtemplateid

JSON structures for prefilling widget data before sharing a document.

```json
{
  "name":"textbox",
  "response":"andrew bee"
}
```

```json
{
  "name": "date",
  "response": "04/15/2024"
}
```

```json
{
  "name": "checkbox",
  "response": ["male", "female"]
}
```

```json
{
  "name": "radio button",
  "response": "male"
}
```

```json
{
  "name": "image",
  "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."
}
```

```json
{
  "name": "dropdown",
  "response": "female"
}
```

--------------------------------

### Success Response Example

Source: https://docs.opensignlabs.com/docs/API-docs/v1/createtemplate

JSON response returned upon successful template creation.

```json
{
  "objectId": "Bh2Hspnmch",
  "message": "Template created successfully!"
}
```

--------------------------------

### Request Body Example

Source: https://docs.opensignlabs.com/docs/API-docs/v1/createfolder

The required JSON body structure for the create folder request.

```json
{
  "folderName": "new folder",
  "parentFolderId": ""
}
```

--------------------------------

### Initialize Project Directory

Source: https://docs.opensignlabs.com/docs/self-host/guides/azure-vm-setup

Creates and enters the project working directory.

```bash
mkdir opensign && cd opensign  
```

--------------------------------

### Start the development server

Source: https://docs.opensignlabs.com/docs/contribute/INSTALLATION

Launches the application in development mode, typically accessible at http://localhost:3000.

```bash
npm run start-dev  
```

--------------------------------

### Download Deployment Files

Source: https://docs.opensignlabs.com/docs/self-host/guides/azure-vm-setup

Fetches the necessary configuration files and sets the host URL environment variable.

```bash
export HOST_URL=https://opensign.yourdomain.com  
  
curl -O https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml  
curl -O https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/Caddyfile  
curl -O https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/.env.local_dev  
mv .env.local_dev .env.prod  
```

--------------------------------

### C# HttpClient Request

Source: https://docs.opensignlabs.com/docs/API-docs/v1.2/contactlist

Example implementation using C# HttpClient to perform the GET request with authentication.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://sandbox.opensignlabs.com/api/v1.2/contactlist");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("x-api-token", "<x-api-token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Get Contact Request using HttpClient

Source: https://docs.opensignlabs.com/docs/API-docs/v1.1/getcontact

Example implementation for retrieving a contact using C# HttpClient.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://sandbox.opensignlabs.com/api/v1.1/contact/:contact_id");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("x-api-token", "<x-api-token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Run OpenSign™ on a custom domain

Source: https://docs.opensignlabs.com/docs/self-host/docker/run-locally

Commands to set the host URL, download configuration files, and start the Docker containers for a production-like environment.

```bash
export HOST_URL=https://opensign.yourdomain.com && curl --remote-name-all https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/Caddyfile https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/.env.local_dev && mv .env.local_dev .env.prod && docker compose up --force-recreate  
```

```powershell
$env:HOST_URL="https://opensign.yourdomain.com"; Invoke-WebRequest -Uri https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml -OutFile docker-compose.yml; Invoke-WebRequest -Uri https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/Caddyfile -OutFile Caddyfile; Invoke-WebRequest -Uri https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/.env.local_dev -OutFile .env.local_dev; Rename-Item -Path .env.local_dev -NewName .env.prod; docker compose up --force-recreate  
```

```cmd
set HOST_URL=https://opensign.yourdomain.com && curl -O https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml && curl -O https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/Caddyfile && curl -O https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/.env.local_dev && rename .env.local_dev .env.prod && docker compose up --force-recreate  
```

--------------------------------

### Configure AND Conditional Logic

Source: https://docs.opensignlabs.com/docs/help/New-Document/conditional_logic

Example of setting multiple conditions that must all be satisfied to trigger an action.

```text
Number = 10  
  
AND  
  
Dropdown = Manager  
  
AND  
  
Text Input = HR  
```

--------------------------------

### Example Webhook Signature Header Value

Source: https://docs.opensignlabs.com/docs/help/Settings/Webhook

An example of the signature value sent in the request header.

```text
x-webhook-signature: bcf57b06dde0c030d9423639824bad17ab7dd09ea3bf0a743773b95254ecf78e
```

--------------------------------

### Run OpenSign™ locally

Source: https://docs.opensignlabs.com/docs/self-host/docker/run-locally

Commands to download configuration files and start the Docker containers for local development access at localhost:3001.

```bash
curl --remote-name-all https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/Caddyfile https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/.env.local_dev && mv .env.local_dev .env.prod && docker compose up --force-recreate  
```

```powershell
Invoke-WebRequest -Uri https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml -OutFile docker-compose.yml; Invoke-WebRequest -Uri https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/Caddyfile -OutFile Caddyfile; Invoke-WebRequest -Uri https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/.env.local_dev -OutFile .env.local_dev; Rename-Item -Path .env.local_dev -NewName .env.prod; docker compose up --force-recreate  
```

```cmd
curl -O https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml && curl -O https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/Caddyfile && curl -O https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/.env.local_dev && rename .env.local_dev .env.prod && docker compose up --force-recreate  
```

--------------------------------

### Navigate to the project directory

Source: https://docs.opensignlabs.com/docs/contribute/INSTALLATION

Changes the current working directory to the newly cloned repository.

```bash
cd OpenSign  
```

--------------------------------

### Get Template List Endpoint

Source: https://docs.opensignlabs.com/docs/API-docs/v1.2/gettemplatelist

The endpoint URL for retrieving the template list via a GET request.

```http
GET 
## https://sandbox.opensignlabs.com/api/v1.2/templatelist
```

--------------------------------

### Navigate to the frontend application directory

Source: https://docs.opensignlabs.com/docs/contribute/INSTALLATION

Moves into the specific directory containing the frontend application code.

```bash
cd apps/OpenSign  
```

--------------------------------

### Get User API Endpoint

Source: https://docs.opensignlabs.com/docs/API-docs/v1/get-user

The base endpoint for retrieving account details via a GET request.

```http
GET 
## https://sandbox.opensignlabs.com/api/v1/getuser
```

--------------------------------

### Get Contact Endpoint URL

Source: https://docs.opensignlabs.com/docs/API-docs/v1/getcontact

The base endpoint for retrieving contact details via a GET request.

```http
GET 
## https://sandbox.opensignlabs.com/api/v1/contact/:contact_id
```

--------------------------------

### Widget Configuration Examples

Source: https://docs.opensignlabs.com/docs/API-docs/v1.1/createdocumentwithtemplateid

JSON configurations for various widget types supported by the template API.

```json
{
  "name": "email",
  "readonly": false,
  "default": "email@example.com",
  "hint": "Provide email",
  "hide_text_with_asterisks": false
}
```

```json
{
  "name": "name",
  "readonly": false,
  "default": "joe",
  "hint": "Provide name",
  "hide_text_with_asterisks": false
}
```

```json
{
  "name": "job title",
  "readonly": false,
  "default": "ceo",
  "hint": "Provide job title",
  "hide_text_with_asterisks": false
}
```

```json
{
  "name": "company",
  "readonly": false,
  "default": "example pvt ltd",
  "hint": "Provide company",
  "hide_text_with_asterisks": false
}
```

```json
{
  "name": "date",
  "readonly": false,
  "default": "11-05-2025",
  "min_date": "",
  "max_date": "",
  "signing_date": false,
  "hint": "Provide date"
}
```

```json
{
  "name": "textbox",
  "readonly": false,
  "default": "my text",
  "hint": "Provide text",
  "hide_text_with_asterisks": false
}
```

```json
{
  "name": "checkbox",
  "readonly": false,
  "default": ["option-2"]
}
```

```json
{
  "name": "dropdown",
  "readonly": false,
  "default": "option1"
}
```

```json
{
  "name": "radio",
  "readonly": false,
  "default": "option1"
}
```

```json
{
  "name": "number",
  "readonly": false,
  "default": 0,
  "formula": "",
  "decimalplaces": 2,
  "hint": "Provide number",
  "hide_text_with_asterisks": false
}
```

```json
{
  "name": "cells",
  "readonly": false,
  "cell_count": 5,
  "default": "",
  "hint": "",
  "hide_text_with_asterisks": false 
}
```

--------------------------------

### Provision Ubuntu VM

Source: https://docs.opensignlabs.com/docs/self-host/guides/azure-vm-setup

Creates an Ubuntu 24.04 VM with SSH key authentication.

```bash
az vm create \
  --resource-group OpenSignRG \
  --name opensign-vm \
  --image Ubuntu2404 \
  --admin-username azureuser \
  --generate-ssh-keys \
  --size Standard_B1ms  
```

--------------------------------

### CORS Policy Error Example

Source: https://docs.opensignlabs.com/docs/self-host/docker/run-locally

An example of a browser console error indicating a blocked request due to missing CORS headers when accessing S3-compatible storage.

```text
Access to fetch at 'https://foo.nyc3.digitaloceanspaces.com/exported_file_4627_0000-00-00T00%3A45%3A43.344Z.pdf'  
from origin 'http://localhost:3000' has been blocked by CORS policy: No 'Access-Control-Allow-Origin' header  
is present on the requested resource. If an opaque response serves your needs, set the request's mode to  
'no-cors' to fetch the resource with CORS disabled.  
```

--------------------------------

### GET /api/v1.1/template/:template_id

Source: https://docs.opensignlabs.com/docs/API-docs/v1.1/get-template

Retrieves a template by its unique ID.

```APIDOC
## GET /api/v1.1/template/:template_id

### Description
Retrieves the details of a specific template using its unique identifier.

### Method
GET

### Endpoint
https://sandbox.opensignlabs.com/api/v1.1/template/:template_id

### Parameters
#### Path Parameters
- **template_id** (string) - Required - The unique identifier of the template.

### Authorization
- **x-api-token** (apiKey) - Required - Header parameter for API authentication.

### Response
#### Success Response (200)
- Returns the template object.

#### Error Responses
- **400/404/401** (application/json)
- **error** (string) - Error message (e.g., "Template not found!", "Invalid API token!", "Something went wrong, please try again later!")
```

--------------------------------

### GET https://sandbox.opensignlabs.com/api/v1.1/templatelist

Source: https://docs.opensignlabs.com/docs/API-docs/v1.1/gettemplatelist

Retrieves a list of available templates.

```APIDOC
## GET https://sandbox.opensignlabs.com/api/v1.1/templatelist

### Description
The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.

### Method
GET

### Endpoint
https://sandbox.opensignlabs.com/api/v1.1/templatelist

### Parameters
#### Query Parameters
- **limit** (number) - Optional - Limit the number of results (<= 500).
- **skip** (number) - Optional - Number of records to skip.

### Response
#### Success Response (200)
- **result** (template[]) - List of templates.

#### Response Example
{
  "result": [
    {
      "objectId": "x1Hbnms2Pg",
      "title": "sample template",
      "note": "template note",
      "folder": {
        "objectId": "x1Hbnms2Pg",
        "name": "folder name"
      },
      "file": "https://templateuser.com",
      "owner": "template creator name",
      "signers": [
        {
          "role": "ceo",
          "name": "joe bee",
          "email": "joebee@example.com",
          "phone": "456213871",
          "widgets": [
            {
              "type": "textbox",
              "page": 1,
              "x": 244,
              "y": 71,
              "w": 38,
              "h": 46,
              "options": {
                "name": "textbox"
              }
            }
          ]
        }
      ],
      "sendInOrder": true,
      "createdAt": "2023-10-07T16:49:56.000Z",
      "updatedAt": "2023-10-07T16:49:56.000Z",
      "enableTour": true,
      "redirect_url": "",
      "allow_modifications": false,
      "auto_reminder": false,
      "remind_once_in_every": 0
    }
  ]
}
```

--------------------------------

### GET /api/v1.1/document/:document_id

Source: https://docs.opensignlabs.com/docs/API-docs/v1.1/getdocument

Retrieves a document by its unique identifier.

```APIDOC
## GET /api/v1.1/document/:document_id

### Description
Retrieves the details of a specific document using its unique document_id.

### Method
GET

### Endpoint
https://sandbox.opensignlabs.com/api/v1.1/document/:document_id

### Parameters
#### Path Parameters
- **document_id** (string) - Required - The unique identifier of the document to retrieve.

### Request Example
```http
GET /api/v1.1/document/12345 HTTP/1.1
Host: sandbox.opensignlabs.com
x-api-token: <x-api-token>
Accept: application/json
```
```

--------------------------------

### Configure Auto-start

Source: https://docs.opensignlabs.com/docs/self-host/guides/azure-vm-setup

Opens the crontab editor to schedule container startup on reboot.

```bash
crontab -e  
```

```bash
@reboot cd /home/azureuser/opensign && docker compose up -d  
```

--------------------------------

### Verify Docker Compose

Source: https://docs.opensignlabs.com/docs/self-host/guides/azure-vm-setup

Checks the installed version of Docker Compose.

```bash
docker compose version  
```

--------------------------------

### Generate a new Docusaurus site

Source: https://docs.opensignlabs.com/docs/intro

Initializes a new project using the classic template and installs required dependencies.

```bash
npm init docusaurus@latest my-website classic  
```

--------------------------------

### GET https://sandbox.opensignlabs.com/api/v1.2/webhook

Source: https://docs.opensignlabs.com/docs/API-docs/v1.2/get-webhook

Retrieves the webhook URL associated with the account.

```APIDOC
## GET https://sandbox.opensignlabs.com/api/v1.2/webhook

### Description
The Get Webhook API allows you to get the webhook URL.

### Method
GET

### Endpoint
https://sandbox.opensignlabs.com/api/v1.2/webhook

### Authorization
- **x-api-token** (header) - Required - API key for authentication.

### Response
#### Success Response (200)
- **webhook** (string) - The configured webhook URL.

#### Response Example
{
  "webhook": "https://your-webhook-url@example.com"
}

#### Error Response (404)
- **error** (string) - User not found!

#### Error Response (405)
- **error** (string) - Invalid API token!
```

--------------------------------

### Create Draft Document with C# HttpClient

Source: https://docs.opensignlabs.com/docs/API-docs/v1/draftdocument

Example of how to send a POST request to create a draft document using C#.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://sandbox.opensignlabs.com/api/v1/draftdocument");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("x-api-token", "<x-api-token>");
var content = new StringContent("{\n  \"file\": \"base64 encoded pdf\",\n  \"title\": \"sample document\",\n  \"note\": \"sample Note\",\n  \"description\": \"sample Description\",\n  \"timeToCompleteDays\": 15,\n  \"signers\": [\n    {\n      \"role\": \"ceo\",\n      \"email\": \"joebee@example.com\",\n      \"name\": \"joe bee\",\n      \"phone\": \"123121312\",\n      \"widgets\": [\n        {\n          \"type\": \"signature\",\n          \"page\": 1,\n          \"x\": 244,\n          \"y\": 71,\n          \"w\": 38,\n          \"h\": 46\n        }\n      ]\n    }\n  ],\n  \"folderId\": \"\",\n  \"send_email\": true,\n  \"email_subject\": \"{{sender_name}} has requested you to sign {{document_title}}\",\n  \"email_body\": \"<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>\",\n  \"sendInOrder\": true,\n  \"enableOTP\": false,\n  \"enableTour\": false,\n  \"redirect_url\": \"\",\n  \"sender_name\": \"opensign™\",\n  \"sender_email\": \"mailer@opensignlabs.com\",\n  \"allow_modifications\": false,\n  \"auto_reminder\": false,\n  \"remind_once_in_every\": 5\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### GET https://sandbox.opensignlabs.com/api/v1.2/getuser

Source: https://docs.opensignlabs.com/docs/API-docs/v1.2/get-user

Retrieves the account details for the authenticated user.

```APIDOC
## GET https://sandbox.opensignlabs.com/api/v1.2/getuser

### Description
The Get User API enables you to get your own account details.

### Method
GET

### Endpoint
https://sandbox.opensignlabs.com/api/v1.2/getuser

### Parameters
#### Headers
- **x-api-token** (apiKey) - Required - API token for authentication

### Response
#### Success Response (200)
- **objectId** (string) - Unique identifier
- **name** (string) - User name
- **email** (string) - User email
- **phone** (string) - User phone number
- **jobTitle** (string) - User job title
- **company** (string) - User company
- **createdAt** (string) - Creation timestamp
- **updatedAt** (string) - Last update timestamp

#### Response Example
{
  "objectId": "FGik23bhUJ",
  "name": "Joe Bee",
  "email": "joebee@example.com",
  "phone": "4567832123",
  "jobTitle": "dev",
  "company": "opensign",
  "createdAt": "2023-10-07T16:49:56.000Z",
  "updatedAt": "2023-10-07T16:49:56.000Z"
}
```

--------------------------------

### GET https://sandbox.opensignlabs.com/api/v1.1/webhook

Source: https://docs.opensignlabs.com/docs/API-docs/v1.1/get-webhook

Retrieves the webhook URL associated with the account.

```APIDOC
## GET https://sandbox.opensignlabs.com/api/v1.1/webhook

### Description
The Get Webhook API allows you to get the webhook URL.

### Method
GET

### Endpoint
https://sandbox.opensignlabs.com/api/v1.1/webhook

### Authorization
- **x-api-token** (header) - Required - API token for authentication.

### Response
#### Success Response (200)
- **webhook** (string) - The configured webhook URL.

#### Response Example
{
  "webhook": "https://your-webhook-url@example.com"
}

#### Error Response (404)
- **error** (string) - User not found!

#### Error Response (405)
- **error** (string) - Invalid API token!
```

--------------------------------

### Create Template using C# HttpClient

Source: https://docs.opensignlabs.com/docs/API-docs/v1.1/createtemplate

Example implementation for creating a template using the C# HttpClient library.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://sandbox.opensignlabs.com/api/v1.1/createtemplate");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("x-api-token", "<x-api-token>");
var content = new StringContent("{\n  \"file\": \"base64 encoded pdf\",\n  \"title\": \"sample template\",\n  \"note\": \"sample note\",\n  \"description\": \"sample description\",\n  \"signers\": [\n    {\n      \"role\": \"ceo\",\n      \"email\": \"\",\n      \"name\": \"\",\n      \"phone\": \"\",\n      \"company\": \"\",\n      \"job_title\": \"\",\n      \"widgets\": [\n        {\n          \"type\": \"signature\",\n          \"page\": 1,\n          \"x\": 244,\n          \"y\": 71,\n          \"w\": 38,\n          \"h\": 46\n        }\n      ]\n    }\n  ],\n  \"sendInOrder\": true,\n  \"enableOTP\": false,\n  \"enableTour\": false,\n  \"redirect_url\": \"\",\n  \"sender_name\": \"opensign™\",\n  \"sender_email\": \"mailer@opensignlabs.com\",\n  \"allow_modifications\": false,\n  \"auto_reminder\": false,\n  \"timeToCompleteDays\": 15,\n  \"remind_once_in_every\": 5,\n  \"merge_certificate\": false,\n  \"notify_on_signatures\": false,\n  \"pen_colors\": [\n    \"blue\",\n    \"red\",\n    \"black\"\n  ],\n  \"bcc\": [\n    \"user@example.com\",\n    \"user2@example.com\"\n  ],\n  \"prefill\": {\n    \"widgets\": [\n      {\n        \"type\": \"textbox\",\n        \"page\": 1,\n        \"x\": 100,\n        \"y\": 30,\n        \"w\": 40,\n        \"h\": 80,\n        \"options\": {\n          \"name\": \"textbox\",\n          \"response\": \"joe\",\n          \"color\": \"red\",\n          \"fontsize\": 12\n        }\n      }\n    ]\n  }\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### GET https://sandbox.opensignlabs.com/api/v1.1/getuser

Source: https://docs.opensignlabs.com/docs/API-docs/v1.1/get-user

Retrieves the account details for the authenticated user.

```APIDOC
## GET https://sandbox.opensignlabs.com/api/v1.1/getuser

### Description
The Get User API enables you to get your own account details.

### Method
GET

### Endpoint
https://sandbox.opensignlabs.com/api/v1.1/getuser

### Authorization
- **x-api-token** (header) - Required - API Key

### Response
#### Success Response (200)
- **objectId** (string) - Unique identifier for the user
- **name** (string) - User's full name
- **email** (string) - User's email address
- **phone** (string) - User's phone number
- **jobTitle** (string) - User's job title
- **company** (string) - User's company name
- **createdAt** (string) - Account creation timestamp
- **updatedAt** (string) - Account last updated timestamp

#### Response Example
{
  "objectId": "FGik23bhUJ",
  "name": "Joe Bee",
  "email": "joebee@example.com",
  "phone": "4567832123",
  "jobTitle": "dev",
  "company": "opensign",
  "createdAt": "2023-10-07T16:49:56.000Z",
  "updatedAt": "2023-10-07T16:49:56.000Z"
}
```

--------------------------------

### GET https://sandbox.opensignlabs.com/api/v1/getuser

Source: https://docs.opensignlabs.com/docs/API-docs/v1/get-user

Retrieves the account details for the authenticated user.

```APIDOC
## GET https://sandbox.opensignlabs.com/api/v1/getuser

### Description
The Get User API enables you to get your own account details.

### Method
GET

### Endpoint
https://sandbox.opensignlabs.com/api/v1/getuser

### Authorization
- **x-api-token** (apiKey) - Required - Header parameter for authentication.

### Response
#### Success Response (200)
- **objectId** (string) - Unique identifier for the user.
- **name** (string) - Full name of the user.
- **email** (string) - Email address of the user.
- **phone** (string) - Phone number of the user.
- **jobTitle** (string) - Job title of the user.
- **company** (string) - Company name associated with the user.
- **createdAt** (string) - Timestamp of account creation.
- **updatedAt** (string) - Timestamp of last account update.

#### Response Example
{
  "objectId": "FGik23bhUJ",
  "name": "Joe Bee",
  "email": "joebee@example.com",
  "phone": "4567832123",
  "jobTitle": "dev",
  "company": "opensign",
  "createdAt": "2023-10-07T16:49:56.000Z",
  "updatedAt": "2023-10-07T16:49:56.000Z"
}
```

--------------------------------

### Create Document Request in C#

Source: https://docs.opensignlabs.com/docs/API-docs/v1/createdocumentwithtemplateid

Example implementation using HttpClient to create a document from a template.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://sandbox.opensignlabs.com/api/v1/createdocument/:template_id");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("x-api-token", "<x-api-token>");
var content = new StringContent("{\n  \"title\": \"New document title\",\n  \"signers\": [\n    {\n      \"role\": \"Accoutnant\",\n      \"email\": \"joe@example.com\",\n      \"name\": \"joe bee\",\n      \"phone\": \"123123131\",\n      \"widgets\": [\n        {\n          \"name\": \"textbox_1\",\n          \"readonly\": false,\n          \"default\": \"my textbox\"\n        }\n      ]\n    }\n  ],\n  \"folderId\": \"\",\n  \"send_email\": true,\n  \"email_subject\": \"{{sender_name}} has requested you to sign {{document_title}}\",\n  \"email_body\": \"<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>\",\n  \"sendInOrder\": true,\n  \"timeToCompleteDays\": 15,\n  \"enableOTP\": false,\n  \"enableTour\": false,\n  \"sender_name\": \"opensign™\",\n  \"sender_email\": \"mailer@opensignlabs.com\",\n  \"allow_modifications\": false,\n  \"file\": \"\",\n  \"auto_reminder\": false,\n  \"remind_once_in_every\": 5\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### C# HttpClient Implementation

Source: https://docs.opensignlabs.com/docs/API-docs/v1/resendrequestmail

Example implementation using C# HttpClient to send the POST request.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Post, "https://sandbox.opensignlabs.com/api/v1/resendmail");  
request.Headers.Add("Accept", "application/json");  
request.Headers.Add("x-api-token", "<x-api-token>");  
var content = new StringContent("{\n  \"document_id\": \"provide document id\",\n  \"email\": \"user@example.com\",\n  \"email_subject\": \"{{sender_name}} has requested you to sign {{document_title}}\",\n  \"email_body\": \"<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>\"\n}", null, "application/json");  
request.Content = content;  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Request Body Example

Source: https://docs.opensignlabs.com/docs/API-docs/v1/resendrequestmail

The JSON payload required for the resend mail request.

```json
{
  "document_id": "provide document id",
  "email": "user@example.com",
  "email_subject": "{{sender_name}} has requested you to sign {{document_title}}",
  "email_body": "<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>"
}
```

--------------------------------

### Configure All Conditions (AND) Logic

Source: https://docs.opensignlabs.com/docs/help/New-Document/conditional_logic

Requires all specified conditions to be met before the action executes.

```text
Number = 10  
  
AND  
  
Dropdown = HR  
  
AND  
  
Checkbox is Checked  
```

--------------------------------

### Request Body Example

Source: https://docs.opensignlabs.com/docs/API-docs/v1/revokedocument

The JSON body required for the revoke document request.

```json
{
  "reason": ""
}
```

--------------------------------

### GET /api/v1.2/templatelist

Source: https://docs.opensignlabs.com/docs/API-docs/v1.2/gettemplatelist

Retrieves a list of templates. Requires an API token in the header.

```APIDOC
## GET /api/v1.2/templatelist

### Description
Retrieves a list of templates associated with the account.

### Method
GET

### Endpoint
https://sandbox.opensignlabs.com/api/v1.2/templatelist

### Parameters
#### Query Parameters
- **limit** (number) - Optional - The number of items to return.
- **skip** (number) - Optional - The number of items to skip.

### Request Headers
- **x-api-token** (string) - Required - API authentication token.

### Response
#### Success Response (200)
- **result** (array) - List of template objects.

#### Response Example
{
  "result": [
    {
      "objectId": "x1Hbnms2Pg",
      "title": "sample template",
      "note": "template note",
      "file": "https://templateuser.com",
      "owner": "template creator name",
      "signers": [
        {
          "role": "ceo",
          "name": "joe bee",
          "email": "joebee@example.com",
          "phone": "456213871"
        }
      ],
      "sendInOrder": true,
      "send_in_order_strict": false,
      "allow_offline_sign": false,
      "createdAt": "2023-10-07T16:49:56.000Z",
      "updatedAt": "2023-10-07T16:49:56.000Z",
      "enableTour": true,
      "redirect_url": "",
      "allow_modifications": false,
      "auto_reminder": false,
      "remind_once_in_every": 0,
      "prefill": {
        "widgets": [
          {
            "type": "textbox",
            "page": 1,
            "x": 100,
            "y": 30,
            "w": 40,
            "h": 80,
            "options": {
              "name": "textbox",
              "response": "joe",
              "color": "red",
              "fontsize": 12
            }
          }
        ]
      }
    }
  ]
}
```

--------------------------------

### GET https://sandbox.opensignlabs.com/api/v1.2/folder/:folder_id

Source: https://docs.opensignlabs.com/docs/API-docs/v1.2/getfolder

Retrieves details about a specific folder by its ID.

```APIDOC
## GET https://sandbox.opensignlabs.com/api/v1.2/folder/:folder_id

### Description
The Get Folder API allows you to retrieve details about a specific folder.

### Method
GET

### Endpoint
https://sandbox.opensignlabs.com/api/v1.2/folder/:folder_id

### Parameters
#### Path Parameters
- **folder_id** (string) - Required - objectId of folder

### Response
#### Success Response (200)
- **objectId** (string) - objectId of folder
- **folderName** (string) - Name of the folder
- **parentFolderId** (string) - ID of the parent folder
- **parentFolderName** (string) - Name of the parent folder
- **createdAt** (date) - Creation timestamp
- **updatedAt** (date) - Last update timestamp

#### Response Example
{
  "objectId": "ph1bhx2jp",
  "folderName": "new folder",
  "parentFolderId": "J2nas5kiPe",
  "parentFolderName": "new sub folder",
  "createdAt": "2023-10-07T16:49:56.000Z",
  "updatedAt": "2023-10-07T16:49:56.000Z"
}
```
Tokens:
Raw