Latest dinesh

docs/API-Documentation/E-Signature.md

@@ -0,0 +1,213 @@
+# Send Document for Signature API
+
+## 1️⃣ **POST** — Send Document
+
+**Endpoint**
+
+```http
+POST https://api.doculan.ai/documents/{document_id}/send
+```
+
+---
+
+### **Path Parameters**
+
+| Field         | Type | Required | Description                                              |
+| ------------- | ---- | -------- | -------------------------------------------------------- |
+| `document_id` | UUID | Yes      | Unique identifier of the document to be sent for signing |
+
+---
+
+### **Request Body**
+
+### **Root Object**
+
+| Field                | Type     | Required | Description                                          |
+| -------------------- | -------- | -------- | ---------------------------------------------------- |
+| `document_id`        | UUID     | Yes      | Unique identifier of the document                    |
+| `validityDate`       | ISO 8601 | Yes      | Expiration date and time for signing the document    |
+| `remainder`          | Integer  | No       | Number of reminder emails to be sent                 |
+| `parties`            | Array    | Yes      | List of recipients required to sign the document     |
+| `email_response`     | Array    | Yes      | Email content sent to signers                        |
+| `cc_emails`          | Array    | No       | Email addresses to receive carbon copies             |
+| `client_info`        | Object   | Yes      | Metadata related to the sender’s device and location |
+| `holder`             | Object   | Yes      | Information about the document owner                 |
+| `scheduled_datetime` | ISO 8601 | No       | Scheduled date and time to send the document         |
+
+---
+
+### **parties[] Object**
+
+| Field      | Type    | Required | Description                                      |
+| ---------- | ------- | -------- | ------------------------------------------------ |
+| `id`       | String  | Yes      | Unique identifier of the signer                  |
+| `name`     | String  | Yes      | Full name of the signer                          |
+| `email`    | String  | Yes      | Email address of the signer                      |
+| `color`    | String  | No       | Highlight color assigned to the signer           |
+| `priority` | Integer | Yes      | Signing order priority (lower value signs first) |
+
+---
+
+### **email_response[] Object**
+
+| Field           | Type   | Required | Description                           |
+| --------------- | ------ | -------- | ------------------------------------- |
+| `email_subject` | String | Yes      | Subject line of the signing email     |
+| `email_body`    | String | Yes      | Email body content sent to the signer |
+
+---
+
+### **client_info Object**
+
+| Field        | Type     | Required | Description                                  |
+| ------------ | -------- | -------- | -------------------------------------------- |
+| `ip`         | String   | Yes      | IP address of the sender                     |
+| `city`       | String   | No       | City of the sender                           |
+| `region`     | String   | No       | Region or state                              |
+| `country`    | String   | No       | Country name                                 |
+| `timezone`   | String   | No       | Sender’s timezone                            |
+| `timestamp`  | ISO 8601 | Yes      | Time the request was initiated               |
+| `latitude`   | String   | No       | Latitude coordinate                          |
+| `longitude`  | String   | No       | Longitude coordinate                         |
+| `aws_region` | String   | No       | AWS region from which the request originated |
+| `browser`    | String   | No       | Browser used by the sender                   |
+| `device`     | String   | No       | Device type (e.g., PC/Laptop)                |
+| `os`         | String   | No       | Operating system of the sender               |
+
+---
+
+### **holder Object**
+
+| Field     | Type   | Required | Description                          |
+| --------- | ------ | -------- | ------------------------------------ |
+| `name`    | String | Yes      | Name of the document holder          |
+| `email`   | String | Yes      | Email address of the document holder |
+| `address` | String | No       | Physical address of the holder       |
+
+---
+
+### **Request Example**
+
+```json
+{
+  "document_id": "d7c2cd92-25c1-4301-a386-19996680b75c",
+  "validityDate": "2025-12-15T18:29:59.000Z",
+  "remainder": 0,
+  "parties": [
+    {
+      "id": "1",
+      "name": "Sarah Williams",
+      "email": "sarahwilliams@virtualansoftware.com",
+      "color": "hsl(196, 100%, 90%)",
+      "priority": 1
+    }
+  ],
+  "email_response": [
+    {
+      "email_subject": "Non-Disclosure Agreement for Your Review and Signature",
+      "email_body": "Hi [Fullname]..."
+    }
+  ],
+  "cc_emails": [],
+  "client_info": {
+    "ip": "276.15.39.1",
+    "timestamp": "2025-12-15T18:08:27.068Z",
+    "browser": "Chrome",
+    "device": "PC/Laptop",
+    "os": "Windows 10"
+  },
+  "holder": {
+    "name": "John Doe",
+    "email": "johndoe@virtualansoftware.com",
+    "address": null
+  },
+  "scheduled_datetime": null
+}
+```
+
+---
+
+### **Response**
+
+### **Response Fields**
+
+| Field         | Type   | Description                                      |
+| ------------- | ------ | ------------------------------------------------ |
+| `tracking_id` | UUID   | Unique tracking identifier for the sent document |
+| `status`      | String | Current status of the document                   |
+
+```json
+{
+  "tracking_id": "272f3791-6b00-47dc-96b9-c20e30de437d",
+  "status": "sent"
+}
+```
+
+---
+
+### Track Document Status API
+
+## 2️⃣ **GET** — Track Status
+
+**Endpoint**
+
+```http
+GET https://api.doculan.ai/documents/{tracking_id}/trackings-status
+```
+
+---
+
+### **Path Parameters**
+
+| Field         | Type | Required | Description                                     |
+| ------------- | ---- | -------- | ----------------------------------------------- |
+| `tracking_id` | UUID | Yes      | Tracking ID returned when the document was sent |
+
+---
+
+### **Response Structure**
+
+### **Party Status Object**
+
+| Field         | Type     | Description                                   |
+| ------------- | -------- | --------------------------------------------- |
+| `isSent`      | Boolean  | Indicates whether the document email was sent |
+| `dateTime`    | ISO 8601 | Date and time of the event                    |
+| `party_name`  | String   | Name of the signer                            |
+| `party_email` | String   | Email address of the signer                   |
+| `ip`          | String   | IP address used                               |
+| `browser`     | String   | Browser used                                  |
+| `os`          | String   | Operating system                              |
+| `device`      | String   | Device type                                   |
+| `location`    | Object   | Geographical metadata                         |
+
+---
+
+### **Tracking Response Example**
+
+```json
+{
+  "d7c2cd92-25c1-4301-a386-19996680b75c": {
+    "in_progress": {
+      "272f3791-6b00-47dc-96b9-c20e30de437d": {
+        "parties": [
+          {
+            "id": "1",
+            "name": "Sarah Williams",
+            "email": "sarahwilliams@virtualansoftware.com",
+            "status": {
+              "sent": [
+                {
+                  "isSent": true,
+                  "dateTime": "2025-12-16T09:57:22.191241+00:00"
+                }
+              ]
+            }
+          }
+        ],
+        "last_updated": "2025-12-16T09:57:22.191241+00:00"
+      }
+    }
+  }
+}
+```

docs/CNAME

@@ -0,0 +1 @@
+docs.doculan.ai

docs/Contacts/Contact-Delete.md

@@ -1,6 +1,13 @@
+# How to Delete Contact?
+
+This guide helps to **Delete a Contact in Doculan** helps you maintain a clean and accurate directory by removing unused or outdated entries. From the Contacts page, select the delete option next to the desired contact and confirm the action in the popup. Once confirmed, the contact is permanently removed from the system. This ensures your contact list stays organized and relevant.
+
+---
+
+
 #  Steps to Delete Contact
 
-1. Open the **Contacts** page to view all contacts.
+1. Navigate to **Contacts** page to view all contacts.
 2. Click the **Delete (trash icon)** next to the contact you want to remove.
 3. Confirm by clicking **Delete**.
 4. The contact will be deleted successfully.
@@ -13,35 +20,4 @@
 
 <img src="screenshots\Contacts\Contact-Delete2.png" alt="Step 2 — Delete Contact" style="border:2px solid black; border-radius:4px; width:100%; max-width:800px;">
 
----> The above **Screenshots** represent that how to **Delete Contact.**
-
-**Demo Video:**
-<!-- Inline HTML in Markdown file -->
-<style>
-.video-wrap {
-  border: 2px solid black;
-  border-radius: 4px;
-  width: 100%;
-  max-width: 800px;
-  overflow: hidden;
-  margin-bottom: 1rem;
-}
-.video-wrap video {                        
-  display: block;
-  width: 100%;
-  height: auto;
-}
-</style>
-
-<div class="video-wrap" role="region" aria-label="Demo: Creating a form">
-  <!-- Use a relative path like ./videos/demo.mp4 or an absolute URL -->
-  <video controls poster="screenshots\Thumbnail\DemoPics.png">
-    <source src="https://doculan-storage-public.s3.us-east-1.amazonaws.com/tutorials/Contact-Delete.mp4" type="video/mp4">
-    <source src="https://doculan-storage-public.s3.us-east-1.amazonaws.com/tutorials/Contact-Delete.webm" type="video/webm">
-    <!-- Fallback link if browser can't play video -->
-    Your browser does not support the video tag. 
-    <a href="https://doculan-storage-public.s3.us-east-1.amazonaws.com/tutorials/Contact-Delete.mp4" target="_blank" rel="noopener">Download / Open video</a>
-  </video>
-</div>
-
----> The above **Video** represent that how to **Delete Contact.**
+---> The above **Screenshots** represent that how to **Delete Contact.**

docs/Contacts/Contact-Update.md

@@ -1,6 +1,12 @@
+# How to Update Contact?
+
+This guide helps to  **Update a contact in Doculan** allows you to keep recipient information accurate and up to date. From the Contacts page, select the edit option, modify the required details, and save the changes. The updated information is instantly reflected across all workflows where the contact is used. This ensures smooth communication and prevents errors caused by outdated data.
+
+---
+
 #  Steps to Update Contact
 
-1. Go to the **Contacts** page to view existing contacts.
+1. Navigate to **Contacts** page to view existing contacts.
 2. Click the **Edit (pen icon)** next to the contact you want to modify.
 3. Update the contact details (Name, Email, Phone Number, etc.).
 4. Click **Save Changes**.
@@ -14,35 +20,4 @@
 
 <img src="screenshots\Contacts\Contact-Update2.png" alt="Step 2 — Update Contact" style="border:2px solid black; border-radius:4px; width:100%; max-width:800px;">
 
----> The above **Screenshots** represent that how to **Update Contact.**
-
-**Demo Video:**
-<!-- Inline HTML in Markdown file -->
-<style>
-.video-wrap {
-  border: 2px solid black;
-  border-radius: 4px;
-  width: 100%;
-  max-width: 800px;
-  overflow: hidden;
-  margin-bottom: 1rem;
-}
-.video-wrap video {
-  display: block;
-  width: 100%;
-  height: auto;
-}
-</style>
-
-<div class="video-wrap" role="region" aria-label="Demo: Creating a form">
-  <!-- Use a relative path like ./videos/demo.mp4 or an absolute URL -->
-  <video controls poster="screenshots\Thumbnail\DemoPics.png">
-    <source src="https://doculan-storage-public.s3.us-east-1.amazonaws.com/tutorials/Contact-Update.mp4" type="video/mp4">
-    <source src="https://doculan-storage-public.s3.us-east-1.amazonaws.com/tutorials/Contact-Update.webm" type="video/webm">
-    <!-- Fallback link if browser can't play video -->
-    Your browser does not support the video tag. 
-    <a href="https://doculan-storage-public.s3.us-east-1.amazonaws.com/tutorials/Contact-Update.mp4" target="_blank" rel="noopener">Download / Open video</a>
-  </video>
-</div>
-
----> The above **Video** represent that how to **Update Contact.**
+---> The above **Screenshots** represent that how to **Update Contact.**

docs/Contacts/Contact_Create.md

@@ -1,14 +1,22 @@
+# How to Create Contact?
+
+This guide helps to **Creating a Contact in Doculan** allows you to store essential recipient information for quicker form assignment and communication. Simply navigate to the Contacts section and we have to add contact, and enter the required details such as name, email, and phone number. Once saved, the contact becomes instantly available for use across forms and workflows. This ensures efficient management of your recipient directory.
+
+---
+
+
+
 #  Steps to Create Contact
 
-1. Open the **Doculan Dashboard** and go to the **Contacts** section.
+1. Navigate to **Doculan Dashboard** and then Click **Contacts** section.
 2. Click on **Add Contact**.
 3. Fill in all required details such as:
    - Full Name  
    - Email Address  
    - Mobile Number  
    - Other optional fields  
 4. Click **Add Contact** to save.
-5. The contact will be successfully created and stored in the system.
+5. The contact will be **successfully created and stored in the Doculan Storage.**
 
 **Screenshot1:**
 
@@ -34,19 +42,15 @@
 }
 </style>
 
-
-
-
-
 <div class="video-wrap" role="region" aria-label="Demo: Creating a form">
   <!-- Use a relative path like ./videos/demo.mp4 or an absolute URL -->
-  <video controls poster="screenshots\Thumbnail\DemoPics.png">
-  <source src="https://doculan-storage-public.s3.us-east-1.amazonaws.com/tutorials/Contact-Create.mp4" type="video/mp4">
-    <source src="https://doculan-storage-public.s3.us-east-1.amazonaws.com/tutorials/Contact-Create.webm" type="video/webm">
+  <video controls poster="">
+  <source src="https://doculan-storage-public.s3.us-east-1.amazonaws.com/demo_video/Contact.mp4" type="video/mp4">
+    <source src="https://doculan-storage-public.s3.us-east-1.amazonaws.com/demo_video/Contact.webm" type="video/webm">
     <!-- Fallback link if browser can't play video -->
     Your browser does not support the video tag. 
-    <a href="https://doculan-storage-public.s3.us-east-1.amazonaws.com/tutorials/Contact-Create.mp4" target="_blank" rel="noopener">Download / Open video</a>
+    <a href="https://doculan-storage-public.s3.us-east-1.amazonaws.com/demo_video/Contact.mp4" target="_blank" rel="noopener">Download / Open video</a>
   </video>
 </div>
 
----> The above **Video** represent that how to **Create Contact.**
+---> The above **Video** represent that how to **Create,Update and Delete Contact.**