diff --git a/404.html b/404.html index 87538d353..10812d127 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/0028a090.50bb866e.js b/assets/js/0028a090.50bb866e.js deleted file mode 100644 index d0dd59f29..000000000 --- a/assets/js/0028a090.50bb866e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7917],{58760:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>g,contentTitle:()=>u,default:()=>b,frontMatter:()=>m,metadata:()=>x,toc:()=>j});var i=s(85893),a=s(11151),t=s(58219),l=(s(62316),s(51039)),r=s.n(l),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),p=s(9472),h=s(85162);const m={id:"drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztO9ty27iSv9KHL5moKNlSHE+i2tpaT+LJKBNfNnbiJJYrgciWiJgEGAC0rKT0dr5kP22/ZKsBgqRk+ZJkao5PrV4Si2g0uhvoCxrd3wLDJjronwbHmOUpM6iDszCIUUeK54ZLEfSD4wTBD8NzxcaGiwnsHA4ABRulqKHQqDQYCZFCAooKbWTGv9IoGI85BI3qguYyDaO0wFxxYTSMpYIJClTMIo5lVGRIA1NuEsgVxjjmAmPQRhWRKRTqDrzJpQBdRBFqPS5StzKXAuQYWLVmCCZBS6pCUyihgUEh+JcCodWSo88YmUHcasEvMWo+EcxgTMT56R95/DCEacKjBCImYITEakyclgRjg9wRozEp7Jo6x4iPOQGXyDqwE8ecaGRpOguBQatVqLTVAq4hV/KCxxj71eR4TCJlVrTAhUE1ZhFaWSFhERO7jEcOTMQwZhFPuVkUI8RcG8VHBa3cGYqhOOZ5H97kqWQxzGSh4PD57zW4kUDfTlut5zgqJvBm0Gqd/ZIYk+v+xgbL847MUZC0UjbSnUhmGzEB5vHYygoVElYrL2SapzNgcQxTHk/QaLshAiKZzyCSUsVcuKORswmCKLIRKh1abjKpELgABgpZPGsb2S40wsujg30SQ8ZMBw7TQofVcjFXGJl05tCTeDxXD9zubG/RGeJiEkLGzklK3MCXgkfnxLZGYbe2PDKdoQAAGIpW64RoriTEdXnOYwCTcA1THCVSngNe0PCUpykYxScTVK2WRfLp0yeH7Jv7z+INLPgw6MMwKPENg7AJ4A/oMOgPg+cHz97s7e4ffxw8HwZNqDFP0WGpQN68frWESrBsGWh/Z293GUqaEuowRaYRFF5wnNrtoB137HpBLE1uGA2HY2mcEKDSNHZaf1+QyTKtR4MX+7uvr1Jayi9jPF0A3N3bGbxaAZknUiyiPPzjYH8VzkI1MA72XzhRNqHm9Y+zBf7KPdwpt/R4sLd7dLyzd+inz4fi06dP9jwdFXkuFR2gE6cWfTooQ/EbpnIKTKE9g5HMMikgZ4plaKyFTZixwwq/FFxh7EwkS1OvX31C04ZWy8xy7LdaMBAxj0jFnLmY5UgW0kF3HCipHoEelSbLgTYUkmyaM0ukaVPmrESekkEiUIVk7Qy/wEXElyHMCPFzpIPl0CZS8a9SGJbaU3WByvCIpU1jQARaE2qYsqYsl1wY/7VcAd6XSk82wap6aa2ItJjElXFhRzTCBUsL1CVV0xASouo15gq1tdwlXhKliCFBPkmuXY/FnwttFhBDob099lSUa/l9suJFK7YxSzUCHy/IMmPn2FgNZO78RAd+m0GMY1akJgROdsyoAjuwLw2wPE95ZH0suQXnwAqFbbvL5YEoCSGdIiIOnZ8hzxJz8jFksWjQoijneOropDnHROxZe2wSJkCKpY2OZCoVoV86Q/b7oiAhksKgMB3YuWA8tdQ7bjVwEaVFjDBKWXQe2hAhBEVOkbZlhmkqp6E78hbEumordCsg0JjSMZSCGBCyXJ7r2hl3jsmAVRpFY17Udg2um1ItfcFY0sIkAq9kYE1PaAUXwmc5AsNNiiGpbM7ELITYBR94aUbyMoQowejc/qVYzCWMCmOkcHzFSuaxnIpSlmMpjOZfV2ikH/l+gfZC2AphO4QnIXQ3Q+j2QuhuhdDdDqH7JITeZgi9Xgi9rRB6246s3pNS1KySb5OAbs8J2TSEC/dbumR5X3FtNZtMpq6s8HTBCg9FtwOtVqVP9rN14dZVDQPSL+uTK5BhEIIbI7M5DPrdEMoPl+QOHvV+9QAz+r1N0nW/p/S7S7vhfif0u9cdinm5aM8SY1iW30AIDf/1RPif5Xmij6W3HgbetNFHskkOdtF/l2TRwLxm6BExxAU3nKX6ep48xP1jq6ZsibMt4sye3uvZKqOW+8aTJ8uPWNvphqytbQx5M2AJ6S2J4HGn9jbXSMAtet8EUFL1s/xvE/+VzbpeCBXI/ZNEk7SfFcevHRseWLt9vTBKgPsnipqwnxXEExIE+a3rpUCj908EJVV+oIwF3NjmVrv7uN3b7G0tiIHu5g4gy9px3J7NZj8pQneDpvCoXN8Gm2Uw62JASoKMlcxW3FTsRaKGKsMn+7eP7vcoph9hlYehxMNiGsenHJoBuZExmz3QDpWfWsVxBF9HcbMGmXaI6LDplyiRPCqJJxgfvY3oNmizEG0SfLyxt7fREKX72M4yL1/wX+l324q++TXLOnHcWYZd2KHG1wziOIQV31cPxDFkWXbddzdA7nIonpIilKHb9bpQAvw96rDi1NfrX6sr9QCLpUjt+vZyt1pXlvxLwn3upzw3sASgcFKkTOEl3VK1S6o0cio/bomWtMgrUR3m20utvQ+6DKOVBPxyUIbyD8sDThwsIqAvt8+7wlgTicIJXlocLodMxPDYZnZDSvcmdOdj/sZAYq+ThvZXxHJOyYUUjbFf0USdVUS4TWtczGlTl+/lGs0CM0yDn7niam533140upvW75X3khscXwlx/8x+gzI/6JIdLn8XZKwMXYIx1n9Lk6AaBmfVHHclx7gxF1ZNhrMb9AlqpYkxZSNMr+ranbWhyU55shrCoYGMiyqTYEne9BTYUXa5NFoOzlfomWO7ecC9cfdq4uUMKdc+nbIotObsMt9k84AC3UvECMFPgFF1JH/6yFeE3e3MO4tQbs8tSxAcWMAq1+dXu2WFha1pCoZwZFzwrMiqpOW4wupFlpVevikvmkmPLH6F5vZeWYFd3rJC+Up0zQJD0bWpBZ+UsIYBVgeDJcj9swwNym53gT9iMxbc5o86vO/XRM9XUxNX+EkCdR6y0kJ9vRp24IC8EmVM3STKgUUR5obyZT+roxXJd9PRrk0lNXNk13umJtTffQavO0x3OZ1LdP9l57CE+7ngi6R2t8PYZOPf6EAukH3nYMklBDP3DHVdNjCzR+++GcOSrCXXH4SBzG09gxSDOOgHMVVN+Lf6ILSoUZvfZDwL+t+CMoVPf5YJcpq58VlT/cW3QEcJZoz+8iRRxQa9+wahf1YNwsDmbKh8g4QW9Mvn4yCkG0ZO72yoCYed1//modyDeBCW9/agH7iX8iAM8JJlOQGXnwBFJOlybFHM/Yo34aq+1Li0/aOqXCA89Dz4g2js1PlSycoPYWpimNdyrZExpdgsWK6O8e+C/hrn5lUPH+nM6wo3pBHVW5UFC8KAG8yaq1yza0p+v6QjlMSJTe1+71y7LSz77jVpnn1u/5GJ5TvMCpnfUUpu9OrCi1u2Q/dHjH003a6fTkOwTxad206Mh7fcsklzTRcbXlnz+Lon9cZLnk5kkcb0RoZMdezL9g+X4thqLJZGha0OqnzEAmcVqRVn3XkYXN7OzCVEsu3f6+GXFMcGijxHBZFUAtXDZibu3jDX29qah8HsdvZm/5bs/UqbN72duxNb6FAXgfwraH30ZB4Gye20/lGVYvwLid3ante+rizzqSoERzKeffR2a34boHcqBEflZgNxoGJUDUGMpEyRiSuSGIxdkCXhAcUiD8p0l31B50p7h+KqzxRGSNU4NoPtbRWUQYd7XofyEZNis136YGNGXYw0QQmPTzuEI/QVbVSG6SC4K2O0NQLIooTq54yjio3p+d9WEVEFmSy0Jy9h2j7jp0hhqUmQu8IVLiaLMWJDOraCo8l7p7k79IWcnC1FPTg+vIMsbQTbdsVszk87Lh0OODg+pLokPi7jsA680ZUkvGjZAghQXAQXnPnahcq2z1zSAYWViPRldHVpYqesCGrDVYJirldSFNYp0Kr09griuhyStkgWhuowy/pT0AZzvSBHS0UlyGNZ3OVU3iJJBpPCvqYYUllfpGTTsnVdEReurtfef+JC+VKq8lgQJBX51nLyUiGgBv4QUGg3ncGYaYMqpGJfkrwq6H5TocTLHBVHEeEKEdyswk7H6zi8PH5UAieFdlFIb3OT/lsKAHylrq8drYuX09k/gvDul4CbQyBfNLoqDKojmN+S3h86F1mUUAhTqJXxYQ1+s3ltXm42cPYyGb2I+AF/OXjzddDd5wM9EK8fR88G24Pz/N3bZy+fdnD2shv13s7e9d6a9yepHnyWPPrjZfJBvNWjZ4+L9+8+qPfvBur9yWvDTh7vjEQiRi9+59Hs8edRb5O/evZy88NJdzp68fvmh7dP8w8W+e+bH87PN6Ns/9lI7BBM/v7df/ODz7uP9r7uft073r3c+5o+7bD9L5+fXUZP9853t9sfBqq9dzD68/MXk79+HD/af8e3n+AenojjzVdR0DwNXKRc4Ee/1R8t3x9ps+f2UGyt2vYjmaFJbHmTLQ5WkqqPc1dea9QM2IRxASQ69ReeAlRKqpv39Psou0kQW5ubH7uVEB5fFcJA2GS7LcQ/luco/l5Om8sbtzyRepnZU+9uOQF3QHY8WGC2+d0xqTEqFDezoH/6Lbhss5y33Xj/9Gx+FgYkWEn3/lxqSzEzSdAPNpbTANQPYe+Yp9+cDlaKppmIKR1+RdlYzjcuusE8XJ6xUjWvhdaGTbiYtG+cdVZzekS74QS+wG99Ucv5n0g3tVKcTagw4HQKEmQU65AAaZNf1zmQXb9VPjuxMuFQ78lyCsFnEBaSAsu+asU1v3HLP/VXbHtrri7NQc1RUF1s6c/qqnpan7zqVugvhV17m+ptbdlrx69dG58/emJD363t+ZmTcCMMtGmmZizjEqALTtk7ai7G0m5AKZSDHMURBQF0zC+6V+N+TCOZVXWXHvx///k/doYPG6wW/gMOCgW5nKKi5hrbXJLiJSe3S8A2/NA2rWGzfyxLUWvKdQiDE9cXwyf2Idb73IjlbETtKVTOyoWRrvihofq6AycJUhaWhh4o9yZ9gSmpO6RS2o4NI4EVRmbN3huYSnU+JpKorWZE5dioKWhEPwVFwkREGVF3nkOQCqhDhaKDXHGNwHhGwLbDZjzmESfEZKQUiwxkTLAJ0mKhvX+QFHJfTK3kiII8LdPChTFU0o1oHIs2I9uB5xQ2WsbpY4yG8RRjF8Ho0EWQpc0qO2BGFK3ntDyPUNeVLCleoLL66+L/Ik0hl8bF5HRZau4tITKKCU03HEeQ35pKfGWIZdeI2awDlJYl/0DhJR2AlItz6i1ow2l1zE5wpLnB+u41nU6v2JKHi3NecJMUI1CYy3rexH60lqc5vfrxkDQfVaYPxkfUQBb5iOSaNTcs8EbpYlhkXYzXZ5bz/1qeQOY+5REKjQ2HsPPi8BVcwKPOZhA2rOcdCN54NXi2u3+0S3jJvjv963Y2O5s2YSS1yZhoLGWb6qoeu2XNbeSH17146168dS/euhdv3YsHsO7FW/firXvx1r146168dS/euhdv3Ys3XPfiDde9eOtevHUv3roXrxbDuhdv3Yu37sVb9+Kte/HWvXjrXrx1L966F2/di7fuxVv34q178da9eP9fevHK+iwKHDfylHHRqHl1pXmnSx16Z2GQUOle/zT49o1eq9+odD6nz18KVFT3dxYGF0xxyp7bqr/Ql7dRQdg5zoJ+8Mw9BrSPafnQHXtbgbJU7EjVeW7Gjt38G2Gb1YWHB0fHQRiMyi7CTMY0R7EpdRiyadAPyGbbZkQrUdtHxmyLSMrEpLA1aoHDS1V5rDDJYknfuS3pK/9olLoxMWtQuVjr51ihf4mxlRP+g6pA/sTZf1bgbuTaCaVsPTTt4Nl8Pv8/iWWU7w==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",source:"@site/docs/API-docs/drafttemplate.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/drafttemplate",permalink:"/docs/API-docs/drafttemplate",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztO9ty27iSv9KHL5moKNlSHE+i2tpaT+LJKBNfNnbiJJYrgciWiJgEGAC0rKT0dr5kP22/ZKsBgqRk+ZJkao5PrV4Si2g0uhvoCxrd3wLDJjronwbHmOUpM6iDszCIUUeK54ZLEfSD4wTBD8NzxcaGiwnsHA4ABRulqKHQqDQYCZFCAooKbWTGv9IoGI85BI3qguYyDaO0wFxxYTSMpYIJClTMIo5lVGRIA1NuEsgVxjjmAmPQRhWRKRTqDrzJpQBdRBFqPS5StzKXAuQYWLVmCCZBS6pCUyihgUEh+JcCodWSo88YmUHcasEvMWo+EcxgTMT56R95/DCEacKjBCImYITEakyclgRjg9wRozEp7Jo6x4iPOQGXyDqwE8ecaGRpOguBQatVqLTVAq4hV/KCxxj71eR4TCJlVrTAhUE1ZhFaWSFhERO7jEcOTMQwZhFPuVkUI8RcG8VHBa3cGYqhOOZ5H97kqWQxzGSh4PD57zW4kUDfTlut5zgqJvBm0Gqd/ZIYk+v+xgbL847MUZC0UjbSnUhmGzEB5vHYygoVElYrL2SapzNgcQxTHk/QaLshAiKZzyCSUsVcuKORswmCKLIRKh1abjKpELgABgpZPGsb2S40wsujg30SQ8ZMBw7TQofVcjFXGJl05tCTeDxXD9zubG/RGeJiEkLGzklK3MCXgkfnxLZGYbe2PDKdoQAAGIpW64RoriTEdXnOYwCTcA1THCVSngNe0PCUpykYxScTVK2WRfLp0yeH7Jv7z+INLPgw6MMwKPENg7AJ4A/oMOgPg+cHz97s7e4ffxw8HwZNqDFP0WGpQN68frWESrBsGWh/Z293GUqaEuowRaYRFF5wnNrtoB137HpBLE1uGA2HY2mcEKDSNHZaf1+QyTKtR4MX+7uvr1Jayi9jPF0A3N3bGbxaAZknUiyiPPzjYH8VzkI1MA72XzhRNqHm9Y+zBf7KPdwpt/R4sLd7dLyzd+inz4fi06dP9jwdFXkuFR2gE6cWfTooQ/EbpnIKTKE9g5HMMikgZ4plaKyFTZixwwq/FFxh7EwkS1OvX31C04ZWy8xy7LdaMBAxj0jFnLmY5UgW0kF3HCipHoEelSbLgTYUkmyaM0ukaVPmrESekkEiUIVk7Qy/wEXElyHMCPFzpIPl0CZS8a9SGJbaU3WByvCIpU1jQARaE2qYsqYsl1wY/7VcAd6XSk82wap6aa2ItJjElXFhRzTCBUsL1CVV0xASouo15gq1tdwlXhKliCFBPkmuXY/FnwttFhBDob099lSUa/l9suJFK7YxSzUCHy/IMmPn2FgNZO78RAd+m0GMY1akJgROdsyoAjuwLw2wPE95ZH0suQXnwAqFbbvL5YEoCSGdIiIOnZ8hzxJz8jFksWjQoijneOropDnHROxZe2wSJkCKpY2OZCoVoV86Q/b7oiAhksKgMB3YuWA8tdQ7bjVwEaVFjDBKWXQe2hAhBEVOkbZlhmkqp6E78hbEumordCsg0JjSMZSCGBCyXJ7r2hl3jsmAVRpFY17Udg2um1ItfcFY0sIkAq9kYE1PaAUXwmc5AsNNiiGpbM7ELITYBR94aUbyMoQowejc/qVYzCWMCmOkcHzFSuaxnIpSlmMpjOZfV2ikH/l+gfZC2AphO4QnIXQ3Q+j2QuhuhdDdDqH7JITeZgi9Xgi9rRB6246s3pNS1KySb5OAbs8J2TSEC/dbumR5X3FtNZtMpq6s8HTBCg9FtwOtVqVP9rN14dZVDQPSL+uTK5BhEIIbI7M5DPrdEMoPl+QOHvV+9QAz+r1N0nW/p/S7S7vhfif0u9cdinm5aM8SY1iW30AIDf/1RPif5Xmij6W3HgbetNFHskkOdtF/l2TRwLxm6BExxAU3nKX6ep48xP1jq6ZsibMt4sye3uvZKqOW+8aTJ8uPWNvphqytbQx5M2AJ6S2J4HGn9jbXSMAtet8EUFL1s/xvE/+VzbpeCBXI/ZNEk7SfFcevHRseWLt9vTBKgPsnipqwnxXEExIE+a3rpUCj908EJVV+oIwF3NjmVrv7uN3b7G0tiIHu5g4gy9px3J7NZj8pQneDpvCoXN8Gm2Uw62JASoKMlcxW3FTsRaKGKsMn+7eP7vcoph9hlYehxMNiGsenHJoBuZExmz3QDpWfWsVxBF9HcbMGmXaI6LDplyiRPCqJJxgfvY3oNmizEG0SfLyxt7fREKX72M4yL1/wX+l324q++TXLOnHcWYZd2KHG1wziOIQV31cPxDFkWXbddzdA7nIonpIilKHb9bpQAvw96rDi1NfrX6sr9QCLpUjt+vZyt1pXlvxLwn3upzw3sASgcFKkTOEl3VK1S6o0cio/bomWtMgrUR3m20utvQ+6DKOVBPxyUIbyD8sDThwsIqAvt8+7wlgTicIJXlocLodMxPDYZnZDSvcmdOdj/sZAYq+ThvZXxHJOyYUUjbFf0USdVUS4TWtczGlTl+/lGs0CM0yDn7niam533140upvW75X3khscXwlx/8x+gzI/6JIdLn8XZKwMXYIx1n9Lk6AaBmfVHHclx7gxF1ZNhrMb9AlqpYkxZSNMr+ranbWhyU55shrCoYGMiyqTYEne9BTYUXa5NFoOzlfomWO7ecC9cfdq4uUMKdc+nbIotObsMt9k84AC3UvECMFPgFF1JH/6yFeE3e3MO4tQbs8tSxAcWMAq1+dXu2WFha1pCoZwZFzwrMiqpOW4wupFlpVevikvmkmPLH6F5vZeWYFd3rJC+Up0zQJD0bWpBZ+UsIYBVgeDJcj9swwNym53gT9iMxbc5o86vO/XRM9XUxNX+EkCdR6y0kJ9vRp24IC8EmVM3STKgUUR5obyZT+roxXJd9PRrk0lNXNk13umJtTffQavO0x3OZ1LdP9l57CE+7ngi6R2t8PYZOPf6EAukH3nYMklBDP3DHVdNjCzR+++GcOSrCXXH4SBzG09gxSDOOgHMVVN+Lf6ILSoUZvfZDwL+t+CMoVPf5YJcpq58VlT/cW3QEcJZoz+8iRRxQa9+wahf1YNwsDmbKh8g4QW9Mvn4yCkG0ZO72yoCYed1//modyDeBCW9/agH7iX8iAM8JJlOQGXnwBFJOlybFHM/Yo34aq+1Li0/aOqXCA89Dz4g2js1PlSycoPYWpimNdyrZExpdgsWK6O8e+C/hrn5lUPH+nM6wo3pBHVW5UFC8KAG8yaq1yza0p+v6QjlMSJTe1+71y7LSz77jVpnn1u/5GJ5TvMCpnfUUpu9OrCi1u2Q/dHjH003a6fTkOwTxad206Mh7fcsklzTRcbXlnz+Lon9cZLnk5kkcb0RoZMdezL9g+X4thqLJZGha0OqnzEAmcVqRVn3XkYXN7OzCVEsu3f6+GXFMcGijxHBZFUAtXDZibu3jDX29qah8HsdvZm/5bs/UqbN72duxNb6FAXgfwraH30ZB4Gye20/lGVYvwLid3ante+rizzqSoERzKeffR2a34boHcqBEflZgNxoGJUDUGMpEyRiSuSGIxdkCXhAcUiD8p0l31B50p7h+KqzxRGSNU4NoPtbRWUQYd7XofyEZNis136YGNGXYw0QQmPTzuEI/QVbVSG6SC4K2O0NQLIooTq54yjio3p+d9WEVEFmSy0Jy9h2j7jp0hhqUmQu8IVLiaLMWJDOraCo8l7p7k79IWcnC1FPTg+vIMsbQTbdsVszk87Lh0OODg+pLokPi7jsA680ZUkvGjZAghQXAQXnPnahcq2z1zSAYWViPRldHVpYqesCGrDVYJirldSFNYp0Kr09griuhyStkgWhuowy/pT0AZzvSBHS0UlyGNZ3OVU3iJJBpPCvqYYUllfpGTTsnVdEReurtfef+JC+VKq8lgQJBX51nLyUiGgBv4QUGg3ncGYaYMqpGJfkrwq6H5TocTLHBVHEeEKEdyswk7H6zi8PH5UAieFdlFIb3OT/lsKAHylrq8drYuX09k/gvDul4CbQyBfNLoqDKojmN+S3h86F1mUUAhTqJXxYQ1+s3ltXm42cPYyGb2I+AF/OXjzddDd5wM9EK8fR88G24Pz/N3bZy+fdnD2shv13s7e9d6a9yepHnyWPPrjZfJBvNWjZ4+L9+8+qPfvBur9yWvDTh7vjEQiRi9+59Hs8edRb5O/evZy88NJdzp68fvmh7dP8w8W+e+bH87PN6Ns/9lI7BBM/v7df/ODz7uP9r7uft073r3c+5o+7bD9L5+fXUZP9853t9sfBqq9dzD68/MXk79+HD/af8e3n+AenojjzVdR0DwNXKRc4Ee/1R8t3x9ps+f2UGyt2vYjmaFJbHmTLQ5WkqqPc1dea9QM2IRxASQ69ReeAlRKqpv39Psou0kQW5ubH7uVEB5fFcJA2GS7LcQ/luco/l5Om8sbtzyRepnZU+9uOQF3QHY8WGC2+d0xqTEqFDezoH/6Lbhss5y33Xj/9Gx+FgYkWEn3/lxqSzEzSdAPNpbTANQPYe+Yp9+cDlaKppmIKR1+RdlYzjcuusE8XJ6xUjWvhdaGTbiYtG+cdVZzekS74QS+wG99Ucv5n0g3tVKcTagw4HQKEmQU65AAaZNf1zmQXb9VPjuxMuFQ78lyCsFnEBaSAsu+asU1v3HLP/VXbHtrri7NQc1RUF1s6c/qqnpan7zqVugvhV17m+ptbdlrx69dG58/emJD363t+ZmTcCMMtGmmZizjEqALTtk7ai7G0m5AKZSDHMURBQF0zC+6V+N+TCOZVXWXHvx///k/doYPG6wW/gMOCgW5nKKi5hrbXJLiJSe3S8A2/NA2rWGzfyxLUWvKdQiDE9cXwyf2Idb73IjlbETtKVTOyoWRrvihofq6AycJUhaWhh4o9yZ9gSmpO6RS2o4NI4EVRmbN3huYSnU+JpKorWZE5dioKWhEPwVFwkREGVF3nkOQCqhDhaKDXHGNwHhGwLbDZjzmESfEZKQUiwxkTLAJ0mKhvX+QFHJfTK3kiII8LdPChTFU0o1oHIs2I9uB5xQ2WsbpY4yG8RRjF8Ho0EWQpc0qO2BGFK3ntDyPUNeVLCleoLL66+L/Ik0hl8bF5HRZau4tITKKCU03HEeQ35pKfGWIZdeI2awDlJYl/0DhJR2AlItz6i1ow2l1zE5wpLnB+u41nU6v2JKHi3NecJMUI1CYy3rexH60lqc5vfrxkDQfVaYPxkfUQBb5iOSaNTcs8EbpYlhkXYzXZ5bz/1qeQOY+5REKjQ2HsPPi8BVcwKPOZhA2rOcdCN54NXi2u3+0S3jJvjv963Y2O5s2YSS1yZhoLGWb6qoeu2XNbeSH17146168dS/euhdv3YsHsO7FW/firXvx1r146168dS/euhdv3Ys3XPfiDde9eOtevHUv3roXrxbDuhdv3Yu37sVb9+Kte/HWvXjrXrx1L966F2/di7fuxVv34q178da9eP9fevHK+iwKHDfylHHRqHl1pXmnSx16Z2GQUOle/zT49o1eq9+odD6nz18KVFT3dxYGF0xxyp7bqr/Ql7dRQdg5zoJ+8Mw9BrSPafnQHXtbgbJU7EjVeW7Gjt38G2Gb1YWHB0fHQRiMyi7CTMY0R7EpdRiyadAPyGbbZkQrUdtHxmyLSMrEpLA1aoHDS1V5rDDJYknfuS3pK/9olLoxMWtQuVjr51ihf4mxlRP+g6pA/sTZf1bgbuTaCaVsPTTt4Nl8Pv8/iWWU7w==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Resend request mail",permalink:"/docs/API-docs/resendrequestmail"},next:{title:"Create Template",permalink:"/docs/API-docs/createtemplate"}},g={},j=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Draft Template"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/drafttemplate"}),"\n",(0,i.jsxs)(n.p,{children:["The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique ",(0,i.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,i.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"When document is created this webhook event will trigger"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:' {\n "event": "created",\n "objectId":"DOCUMENT_ID"\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n }\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified.This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": { \n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "readonly": false,\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"You can provide signer optionally if you it as default signer"})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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'.",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Template created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "url": "https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/0028a090.a94482e8.js b/assets/js/0028a090.a94482e8.js new file mode 100644 index 000000000..00f0e9502 --- /dev/null +++ b/assets/js/0028a090.a94482e8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7917],{58760:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>u,default:()=>y,frontMatter:()=>h,metadata:()=>x,toc:()=>g});var i=s(85893),a=s(11151),t=s(58219),r=(s(62316),s(51039)),l=s.n(r),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),p=s(85162);const h={id:"drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztO+1yGzmOr8LtPzOjasmW4ngyqqur8ySejDLxx8XO5MNyOVQ3JDHuJjsk27KS0r99kn20fZIrgGSrJUu2k0zteuv0J7GaIAiAAAiCwJfI8pGJumfRKeRFxi2Y6DyOUjCJFoUVSkbd6HQMLAyzZ5oPrZAjtnfcYyD5IAPDSgPaMKtYogGBktJYlYvPOMpswBwzA/oK53LDBlkJhRbSGjZUmo1AguaEOFVJmQMOTIQds0JDCkMhIWXG6jKxpQbTYq8LJZkpkwSMGZaZW1koydSQ8WrNmNkxEKkabKmlYZyVUnwqgTUaavAREttLGw32YwpGjCS3kCJxYfqFSH+K2WQskjFLuGQDQFZT5NQTDDVyBxzHlKQ1TQGJGAoE9shabC9NBdLIs2waM84ajVJnjQYThhVaXYkU0rCaGg5RpJxEy4S0oIc8AZIVIBY5omUCcsZlyoY8EZmwi2JkqTBWi0GJK7f6si9PRdFlr4tM8ZRNVanZ8bPf5uBWMfx21mg8g0E5Yq97jcb5j2NrC9Pd2uJF0VIFSJRWxgemlah8K0XAIh2SrEADYiV5ATcimzKepmwi0hFYQxsiWaKKKUuU0qmQTjUKPgImy3wA2sTETa40MCEZZxp4Om1a1SwNsBcnR4cohpzbFjvOShNXy6VCQ2KzqUOP4glc/eB2Z3cHdUjIUcxyfolSEpZ9KkVyiWwbkLS1XmVafckYY33ZaLxBmisJCeP1PGXMjoVhExiMlbpkcIXDE5FlzGoxGoFuNAjJhw8fHLIv7j/CGxF4P+qyfuTx9aO4DhAUtB91+9Gzo6evD/YPTy96z/pRHWooMnBYKpDXr14uoZI8XwY63DvYX4ZS1kMdZ8ANMA1XAia0Hbjjjt0giKXJNafhcCyNIwLQBsfO5t8XZLJM60nv+eH+q5uUevnlXGQLgPsHe72XKyCLsZKLKI9/PzpchbPUNYy9w+dOlHWo2fzH+QJ/fg/3/Jae9g72T073Do7D9FlffvjwgfTppCwKpVGB3jiz6KKi9OWvkKkJ4xpIBxOV50qygmuegyUPO+aWhjV8KoWG1LlInmXBvrqIpskaDTstoNtosJ5MRYIm5tzFtAD0kA665UDR9BD0xLssB1ozSPRpzi2hpU248xJFhg4JQTWgt7PiChYRX8dsioifASqWQztWWnxW0vKMtOoKtBUJz+rOAAkkF2q5JldWKCFt+OpXYO+80aNPIFP33gpJS1FcuZA0YoBd8awE46maxGyMVL2CQoMhz+3xoihlysYgRuO16/H0Y2nsAmJWmuCPAxV+rbBPJF4gsQ15ZoCJ4YIsc34JtdWYKtw50WK/TlkKQ15mNmYC/ZjVJbTYobKMF0UmEjpj8VhwB1ipoUm77BXCE4I2hUQcu3MGT5ZU4BmDHgsHCYWfE6hDTXMHE7JH/tiOuWRKLm10ojKlEf2SDtH3RUGyREkL0rbY3hUXGVHvuDVMyCQrU2CDjCeXMYUIMdN4KOK2TCHL1CR2Kk8gdFST0ElAzECGaqgkMiCVX16Y+WHcOkUHVlkUjgVR0xrC1KXqz4KhwoVRBMHIGLmemAQXs49qwKywGcRosgWX05ilLviAaztQ1zFLxpBc0l+ap0KxQWmtko6vVKsiVRPpZTlU0hrxeYVFhpGvF2gnZjsx243Zk5i1t2PW7sSsvROz9m7M2k9i1tmOWacTs85OzDq7jqzOEy9qXsm3TkC744Rsa8JlD1u66HlfCkOWjS7TVF54suCF+7LdYo1GZU/0mY5wOqr6EdoXnckVSD+KmRtDt9mPuu2Y+Q/XeBw86vwcAKb4exel635P8Hcbd8P9HuPvTrsvZ37RDhFjeV7cQggO//VEhJ9en/CjP637UXBt+BF9koNdPL89WTgwmzP0CBkSUljBM7OepwDx8NiaU7bE2Q5yRtq7ni0ftTw0ngJZYYR8pxsiX1sbCm6ACOksieBxa37arJGAW/ShCcBT9b387yL/lc9aL4QK5OFJok7a94rj5xaFB+S31wvDAzw8UcwJ+15BPEFB4Lm1Xgo4+vBE4KkKAz4WcGPbO83242Znu7OzIAa8mzuAPG+maXM6nX6nCN0NGsMjvz4Fmz6YdTEgJkGGWuUrbip0kZhD+fCJ/g7R/QHG9AOo8jCYeFhM44SUQz0gtyrl0x+MQxWmVnEcws+juGmNTBpCOij9koyVSDzxCBOitwHeBikL0UTBp1sHB1s1UbqPzTwP8mXhK/5ukujrX/O8laatZdiFHap9zVmaxmzF99UDacryPF/33Q3gcdmXv6Ah+NBtvS14gH+NOazQ+vn6a21lPsBTJTNany53q21l6XwZi5D78XrDlgA0jMqMa7jGW6pxSZVaTuXbPdGSFQUjmof5dKml+6DLMJIk2I9HPpT/ySs4crCIAL/cPe8GY3UkGkZwTThcDhmJESlldmNM947xzsfDjQHFPk8a0q+EFwKTCxlYS1/BJq1VRLhNq13McVOX7+UG7AIz3LAwc8XVnHafLhrtbTr3/L3kloPPQzw8t1+jLAy6ZIfL30U596FLNIT538qOQfej82qOu5JDWpvLVk1m57fYE5sbTQoZH0B209bubQ11drxm1YSDA7mQVSaBSN4OFNAov14a9YOzFXbm2K4reHDuwUyCnFkmTEinLAqtPtvnmygPKMG9RAyAhQlsUKnkd6t8Rdj9dN55BL89dyyBcIwAq1xfWO2OFRa2pi4YxJELKfIyr5KWwwprEFnuT/m6vHAmPrKEFerbe2MFfn3HCv6VaM0Cfdmm1EJISpBjYKuDQQ/y8DxDjbK7j8Bv8RkLx+a3Hnhfb4mBr7olrjgnEdSdkJUVmvVm2GJHeCphxtRNwhxYkkBhMV/2vTZakXw/G21TKqmeI1t/MtWh/tU6uE6Z7qOdS3T/ZXro4b4v+EKp3U8Z62z8BynkAtn3DpZcQjB3z1DrsoE5qd5Dc4aerKWjP4ojVVA9g5K9NOpGKVZNhLf6KCbUYOyvKp1G3S+RT+Hjnz5BjjO3Phqsv/gSmWQMOce/AklYsYHvvlEcnlWjOKKcDZZvoNCirn8+jmK8YRT4zgYGcdC87pcA5R7Eo9jf26Nu5F7KoziCa54XCOw/MZCJwssxoZiFFW/DVX2Z4zL0R1W5gHjwefAb0dDU2VLJyjdhqmOYzeU6R8a15tNouTomvAuGa5ybVz18ZNNgK8KiRVRvVQQWxZGwkNdXWbNrWn29pBNQyAmldr92Lm0Lz796TZxHz+3fMtG/w6yQ+T2l5EZvLry4ZXt4f4Q0RNPN+dNpzOjJonWXxgR44paP6mu62PDGmqfrntRrL3lmrMosxTcy4LpFL9vfXIpD1Vg8S0qqDqrOiAXOKlIrztqzOLq+m5lrlqhmeK9nP2YwtKwsCtAsUVqC/qmeiXswzHV2dmZxNL2bvel/JHs/4+ZN7ubuDRU6zItA/h20Pnoyi6Px3bT+XpVi/BuJ3dmdzc86X+ZTVQgOVDq9CH5rdhdgOFQQDsvNevJIp6BrghgolQGXNyTRG7ogS7EfMBb5wae76AVdaBMOFFd9piEBrMahDHbwVcwHHe55nflHTIzN9vEDxYymHBiEkgGfcQgHECrasAzTQQhXxkg1AsCTMdbPWUcVH+LzP1URYQWZKk0gb8wNPeNngGGpHYNwhStCjhZjxJp0qIKjznurvjv4BQ85KkU9Oj2+hywpgm26YjZ3TjsuHQ52dHqMdUli6OOwFnttKkkE0fIFEIZxEbsSPNQuVL596pIOIEkiKpTRzUsTW74iqMluEpQKs5KieJ4CrUpvbyCel0PiFqnSYh2mrz9lxkJhFuRIVFSCPFXlfbTyDklyNirpNcWiyYYiJUrLzuuKhHR1vXT/SUsdSqm8WiAkFvnO5RSkgkA1/DEDadx0zobcWNAxFvui5HWJ95sKJVwXoAXIBFaKQIMT3UWpV8ZNizJYLNJ5/eqlL4INPASjHKAFOsSQsrIgrSFLqIrHws4ts34jUCItu0AbAX2xLkxbJJOKvLB6mKzfp90K0AZrpjVTesSl+OxrqJ0mDWDMsyF53+pNDWvCcN1AM2JbpC+433/+/R9IKmnqRa7SSnvN/RXrGMv4rKmckVVUTAwZuJLr8CJQOTkTB8dmfCyHDwOaEvjEliqQH7gWxtZqjsJz302jfAUoz6RGA539aEqoaHJat6qKLl/bNEdHlVFisVytOnuWFPD2M8QdMvOLoPd/WIOppHFhcGd7G/9bikBDqXgoXp5Xz2fTv0Xx/W+ht8fgoWp5lUrOteTXced3U8g8GaOSrDG0Ofjt53v9dr0F0xfjwfNEHIkXvdefe+1D0TM9+epx8rS327ss3v759MUvLZi+aCedP6dvO3/ad28y0/uoRPL7i/F7+acZPH1cvnv7Xr9729Pv3ryy/M3jvYEcy8Hz30Qyffxx0NkWL5++2H7/pj0ZPP9t+/2fvxTvCflv2+8vL7eT/PDpQO4hTPHu7f+Ko4/7jw4+738+ON2/Pvic/dLih58+Pr1Ofjm43N9tvu/p5sHR4I+Pn2zx6nH66PCt2H0CB/BGnm6/TKK6NgiZCQkXYasviO8L3OwZKcXOqm0/UTnYMek6VadrheXvhavvtnrK+IgLyVB0+i/UAtBa6dv39Osou00QO9vbF+1KCI9vCqEn6bWHOkFO1SXIfy2n9eWtWx5Jvc5J653/joQDovFogdn6d8ekgaTUwk6j7tmX6LrJC9F0492z89l5HKFgFSaeCmWIYm7HUTfaWs5DYUMOJTnOvjgbrAzNcJnie8wNY+OF2LpqR7N4ecZK01wLbSwfCTlq3jrrfM7pCe6GE/gCv/NMQSH+AEwVeHHWoeJIoBaMgWOwjQLETX41T8Lth60K6bGVGa/5niznsEIKayErtXymrcgz1dJMZyHHQ2mbKmsTzTmKqswK/lnlSs7mmlelJUJWok3X+c7ODt17f27TBfHRE7p77ezOzp2Ea/cQynPWg2mXgV+ICv2nxSgpilZGJQvRwJpgIIRdQg4VbagX8lEB8gSjWjSbq/bNiyxkicqrQuIA/s+//4NmhMOXlvkbOyo1K9QENHaLUbdUBtcC40gEJsIMRTiUzuZ5BsZg8k5aGLlGLzGiyoIQnCW84APst8LQT0irXDVPzZWYFnszBnxWwKEftCuyuIIM3QfLlKIWJIxpSqvyejMZmyh9OUSSsE9sgP0FYPAWBGEKyDGXCcZizj4oysGWKwx3Cy0MMC5yBKaWseFQJAIRo9PTPLEs55KPKFyJ6UKNUihCd4BWA7y1GJWVLi7HHgUA61ikJ4YWe4b3IGIcP6ZgucggdSG5id2VyPtA39I1wOtngcuLBMy8NCuDK9DkD9yFtswyVijrLpkYr9X3FhFZzaXBK7sjKGxNJT4fONMaKZ+2GL4z4HmD9yVUgEzIS2yWabKzSs3ewMAIC/NkwmQyueGbflqc81zYcTlgGgo1nzeij+TJ6tOrHz+hJwGdm6PhCXZEJiHCWbPmFgFv+SOLJ3RkBf/AC/E/yxPw+MhEAtJA7YDZe378kl2xR63tKK5543sQvPWy93T/8GQf8eJ54eyv3dpubVMGVBmbc1lbirpEq6bRZcutPXhsmks3zaWb5tJNc+mmuZSxTXPpprl001y6aS7dNJdumks3zaWb5tL+prm0v2ku3TSXbppLN82lczFsmks3zaWb5tJNc+mmuXTTXLppLt00l26aSzfNpZvm0k1z6aa5dNNc+v+ludTXe2HguFVkXMhaDa0r9Ttbajk9j6MxlgJ2z6IvX/C1+rXOZjP8/KkEjXWE53F0xbXA7DlVEcahXA4LzC5hGnWjp+4xoHmKy8dO7akCZal4Eqv93Iw92vxbYevVisdHJ6dRHA18W2yuUpyj+QRbZvkk6kbos6m7tiokp+9foozLUUk1b5HDi1V+vLTjxRLBSyoR9H/USue4nNaoXKwddKzgv8jYygn/hVUgf8D0vytwN7J2gpdtgMYdPJ/NZv8HGPOZ6A==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",source:"@site/docs/API-docs/drafttemplate.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/drafttemplate",permalink:"/docs/API-docs/drafttemplate",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztO+1yGzmOr8LtPzOjasmW4ngyqqur8ySejDLxx8XO5MNyOVQ3JDHuJjsk27KS0r99kn20fZIrgGSrJUu2k0zteuv0J7GaIAiAAAiCwJfI8pGJumfRKeRFxi2Y6DyOUjCJFoUVSkbd6HQMLAyzZ5oPrZAjtnfcYyD5IAPDSgPaMKtYogGBktJYlYvPOMpswBwzA/oK53LDBlkJhRbSGjZUmo1AguaEOFVJmQMOTIQds0JDCkMhIWXG6jKxpQbTYq8LJZkpkwSMGZaZW1koydSQ8WrNmNkxEKkabKmlYZyVUnwqgTUaavAREttLGw32YwpGjCS3kCJxYfqFSH+K2WQskjFLuGQDQFZT5NQTDDVyBxzHlKQ1TQGJGAoE9shabC9NBdLIs2waM84ajVJnjQYThhVaXYkU0rCaGg5RpJxEy4S0oIc8AZIVIBY5omUCcsZlyoY8EZmwi2JkqTBWi0GJK7f6si9PRdFlr4tM8ZRNVanZ8bPf5uBWMfx21mg8g0E5Yq97jcb5j2NrC9Pd2uJF0VIFSJRWxgemlah8K0XAIh2SrEADYiV5ATcimzKepmwi0hFYQxsiWaKKKUuU0qmQTjUKPgImy3wA2sTETa40MCEZZxp4Om1a1SwNsBcnR4cohpzbFjvOShNXy6VCQ2KzqUOP4glc/eB2Z3cHdUjIUcxyfolSEpZ9KkVyiWwbkLS1XmVafckYY33ZaLxBmisJCeP1PGXMjoVhExiMlbpkcIXDE5FlzGoxGoFuNAjJhw8fHLIv7j/CGxF4P+qyfuTx9aO4DhAUtB91+9Gzo6evD/YPTy96z/pRHWooMnBYKpDXr14uoZI8XwY63DvYX4ZS1kMdZ8ANMA1XAia0Hbjjjt0giKXJNafhcCyNIwLQBsfO5t8XZLJM60nv+eH+q5uUevnlXGQLgPsHe72XKyCLsZKLKI9/PzpchbPUNYy9w+dOlHWo2fzH+QJ/fg/3/Jae9g72T073Do7D9FlffvjwgfTppCwKpVGB3jiz6KKi9OWvkKkJ4xpIBxOV50qygmuegyUPO+aWhjV8KoWG1LlInmXBvrqIpskaDTstoNtosJ5MRYIm5tzFtAD0kA665UDR9BD0xLssB1ozSPRpzi2hpU248xJFhg4JQTWgt7PiChYRX8dsioifASqWQztWWnxW0vKMtOoKtBUJz+rOAAkkF2q5JldWKCFt+OpXYO+80aNPIFP33gpJS1FcuZA0YoBd8awE46maxGyMVL2CQoMhz+3xoihlysYgRuO16/H0Y2nsAmJWmuCPAxV+rbBPJF4gsQ15ZoCJ4YIsc34JtdWYKtw50WK/TlkKQ15mNmYC/ZjVJbTYobKMF0UmEjpj8VhwB1ipoUm77BXCE4I2hUQcu3MGT5ZU4BmDHgsHCYWfE6hDTXMHE7JH/tiOuWRKLm10ojKlEf2SDtH3RUGyREkL0rbY3hUXGVHvuDVMyCQrU2CDjCeXMYUIMdN4KOK2TCHL1CR2Kk8gdFST0ElAzECGaqgkMiCVX16Y+WHcOkUHVlkUjgVR0xrC1KXqz4KhwoVRBMHIGLmemAQXs49qwKywGcRosgWX05ilLviAaztQ1zFLxpBc0l+ap0KxQWmtko6vVKsiVRPpZTlU0hrxeYVFhpGvF2gnZjsx243Zk5i1t2PW7sSsvROz9m7M2k9i1tmOWacTs85OzDq7jqzOEy9qXsm3TkC744Rsa8JlD1u66HlfCkOWjS7TVF54suCF+7LdYo1GZU/0mY5wOqr6EdoXnckVSD+KmRtDt9mPuu2Y+Q/XeBw86vwcAKb4exel635P8Hcbd8P9HuPvTrsvZ37RDhFjeV7cQggO//VEhJ9en/CjP637UXBt+BF9koNdPL89WTgwmzP0CBkSUljBM7OepwDx8NiaU7bE2Q5yRtq7ni0ftTw0ngJZYYR8pxsiX1sbCm6ACOksieBxa37arJGAW/ShCcBT9b387yL/lc9aL4QK5OFJok7a94rj5xaFB+S31wvDAzw8UcwJ+15BPEFB4Lm1Xgo4+vBE4KkKAz4WcGPbO83242Znu7OzIAa8mzuAPG+maXM6nX6nCN0NGsMjvz4Fmz6YdTEgJkGGWuUrbip0kZhD+fCJ/g7R/QHG9AOo8jCYeFhM44SUQz0gtyrl0x+MQxWmVnEcws+juGmNTBpCOij9koyVSDzxCBOitwHeBikL0UTBp1sHB1s1UbqPzTwP8mXhK/5ukujrX/O8laatZdiFHap9zVmaxmzF99UDacryPF/33Q3gcdmXv6Ah+NBtvS14gH+NOazQ+vn6a21lPsBTJTNany53q21l6XwZi5D78XrDlgA0jMqMa7jGW6pxSZVaTuXbPdGSFQUjmof5dKml+6DLMJIk2I9HPpT/ySs4crCIAL/cPe8GY3UkGkZwTThcDhmJESlldmNM947xzsfDjQHFPk8a0q+EFwKTCxlYS1/BJq1VRLhNq13McVOX7+UG7AIz3LAwc8XVnHafLhrtbTr3/L3kloPPQzw8t1+jLAy6ZIfL30U596FLNIT538qOQfej82qOu5JDWpvLVk1m57fYE5sbTQoZH0B209bubQ11drxm1YSDA7mQVSaBSN4OFNAov14a9YOzFXbm2K4reHDuwUyCnFkmTEinLAqtPtvnmygPKMG9RAyAhQlsUKnkd6t8Rdj9dN55BL89dyyBcIwAq1xfWO2OFRa2pi4YxJELKfIyr5KWwwprEFnuT/m6vHAmPrKEFerbe2MFfn3HCv6VaM0Cfdmm1EJISpBjYKuDQQ/y8DxDjbK7j8Bv8RkLx+a3Hnhfb4mBr7olrjgnEdSdkJUVmvVm2GJHeCphxtRNwhxYkkBhMV/2vTZakXw/G21TKqmeI1t/MtWh/tU6uE6Z7qOdS3T/ZXro4b4v+EKp3U8Z62z8BynkAtn3DpZcQjB3z1DrsoE5qd5Dc4aerKWjP4ojVVA9g5K9NOpGKVZNhLf6KCbUYOyvKp1G3S+RT+Hjnz5BjjO3Phqsv/gSmWQMOce/AklYsYHvvlEcnlWjOKKcDZZvoNCirn8+jmK8YRT4zgYGcdC87pcA5R7Eo9jf26Nu5F7KoziCa54XCOw/MZCJwssxoZiFFW/DVX2Z4zL0R1W5gHjwefAb0dDU2VLJyjdhqmOYzeU6R8a15tNouTomvAuGa5ybVz18ZNNgK8KiRVRvVQQWxZGwkNdXWbNrWn29pBNQyAmldr92Lm0Lz796TZxHz+3fMtG/w6yQ+T2l5EZvLry4ZXt4f4Q0RNPN+dNpzOjJonWXxgR44paP6mu62PDGmqfrntRrL3lmrMosxTcy4LpFL9vfXIpD1Vg8S0qqDqrOiAXOKlIrztqzOLq+m5lrlqhmeK9nP2YwtKwsCtAsUVqC/qmeiXswzHV2dmZxNL2bvel/JHs/4+ZN7ubuDRU6zItA/h20Pnoyi6Px3bT+XpVi/BuJ3dmdzc86X+ZTVQgOVDq9CH5rdhdgOFQQDsvNevJIp6BrghgolQGXNyTRG7ogS7EfMBb5wae76AVdaBMOFFd9piEBrMahDHbwVcwHHe55nflHTIzN9vEDxYymHBiEkgGfcQgHECrasAzTQQhXxkg1AsCTMdbPWUcVH+LzP1URYQWZKk0gb8wNPeNngGGpHYNwhStCjhZjxJp0qIKjznurvjv4BQ85KkU9Oj2+hywpgm26YjZ3TjsuHQ52dHqMdUli6OOwFnttKkkE0fIFEIZxEbsSPNQuVL596pIOIEkiKpTRzUsTW74iqMluEpQKs5KieJ4CrUpvbyCel0PiFqnSYh2mrz9lxkJhFuRIVFSCPFXlfbTyDklyNirpNcWiyYYiJUrLzuuKhHR1vXT/SUsdSqm8WiAkFvnO5RSkgkA1/DEDadx0zobcWNAxFvui5HWJ95sKJVwXoAXIBFaKQIMT3UWpV8ZNizJYLNJ5/eqlL4INPASjHKAFOsSQsrIgrSFLqIrHws4ts34jUCItu0AbAX2xLkxbJJOKvLB6mKzfp90K0AZrpjVTesSl+OxrqJ0mDWDMsyF53+pNDWvCcN1AM2JbpC+433/+/R9IKmnqRa7SSnvN/RXrGMv4rKmckVVUTAwZuJLr8CJQOTkTB8dmfCyHDwOaEvjEliqQH7gWxtZqjsJz302jfAUoz6RGA539aEqoaHJat6qKLl/bNEdHlVFisVytOnuWFPD2M8QdMvOLoPd/WIOppHFhcGd7G/9bikBDqXgoXp5Xz2fTv0Xx/W+ht8fgoWp5lUrOteTXced3U8g8GaOSrDG0Ofjt53v9dr0F0xfjwfNEHIkXvdefe+1D0TM9+epx8rS327ss3v759MUvLZi+aCedP6dvO3/ad28y0/uoRPL7i/F7+acZPH1cvnv7Xr9729Pv3ryy/M3jvYEcy8Hz30Qyffxx0NkWL5++2H7/pj0ZPP9t+/2fvxTvCflv2+8vL7eT/PDpQO4hTPHu7f+Ko4/7jw4+738+ON2/Pvic/dLih58+Pr1Ofjm43N9tvu/p5sHR4I+Pn2zx6nH66PCt2H0CB/BGnm6/TKK6NgiZCQkXYasviO8L3OwZKcXOqm0/UTnYMek6VadrheXvhavvtnrK+IgLyVB0+i/UAtBa6dv39Osou00QO9vbF+1KCI9vCqEn6bWHOkFO1SXIfy2n9eWtWx5Jvc5J653/joQDovFogdn6d8ekgaTUwk6j7tmX6LrJC9F0492z89l5HKFgFSaeCmWIYm7HUTfaWs5DYUMOJTnOvjgbrAzNcJnie8wNY+OF2LpqR7N4ecZK01wLbSwfCTlq3jrrfM7pCe6GE/gCv/NMQSH+AEwVeHHWoeJIoBaMgWOwjQLETX41T8Lth60K6bGVGa/5niznsEIKayErtXymrcgz1dJMZyHHQ2mbKmsTzTmKqswK/lnlSs7mmlelJUJWok3X+c7ODt17f27TBfHRE7p77ezOzp2Ea/cQynPWg2mXgV+ICv2nxSgpilZGJQvRwJpgIIRdQg4VbagX8lEB8gSjWjSbq/bNiyxkicqrQuIA/s+//4NmhMOXlvkbOyo1K9QENHaLUbdUBtcC40gEJsIMRTiUzuZ5BsZg8k5aGLlGLzGiyoIQnCW84APst8LQT0irXDVPzZWYFnszBnxWwKEftCuyuIIM3QfLlKIWJIxpSqvyejMZmyh9OUSSsE9sgP0FYPAWBGEKyDGXCcZizj4oysGWKwx3Cy0MMC5yBKaWseFQJAIRo9PTPLEs55KPKFyJ6UKNUihCd4BWA7y1GJWVLi7HHgUA61ikJ4YWe4b3IGIcP6ZgucggdSG5id2VyPtA39I1wOtngcuLBMy8NCuDK9DkD9yFtswyVijrLpkYr9X3FhFZzaXBK7sjKGxNJT4fONMaKZ+2GL4z4HmD9yVUgEzIS2yWabKzSs3ewMAIC/NkwmQyueGbflqc81zYcTlgGgo1nzeij+TJ6tOrHz+hJwGdm6PhCXZEJiHCWbPmFgFv+SOLJ3RkBf/AC/E/yxPw+MhEAtJA7YDZe378kl2xR63tKK5543sQvPWy93T/8GQf8eJ54eyv3dpubVMGVBmbc1lbirpEq6bRZcutPXhsmks3zaWb5tJNc+mmuZSxTXPpprl001y6aS7dNJdumks3zaWb5tL+prm0v2ku3TSXbppLN82lczFsmks3zaWb5tJNc+mmuXTTXLppLt00l26aSzfNpZvm0k1z6aa5dNNc+v+ludTXe2HguFVkXMhaDa0r9Ttbajk9j6MxlgJ2z6IvX/C1+rXOZjP8/KkEjXWE53F0xbXA7DlVEcahXA4LzC5hGnWjp+4xoHmKy8dO7akCZal4Eqv93Iw92vxbYevVisdHJ6dRHA18W2yuUpyj+QRbZvkk6kbos6m7tiokp+9foozLUUk1b5HDi1V+vLTjxRLBSyoR9H/USue4nNaoXKwddKzgv8jYygn/hVUgf8D0vytwN7J2gpdtgMYdPJ/NZv8HGPOZ6A==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Resend request mail",permalink:"/docs/API-docs/resendrequestmail"},next:{title:"Create Template",permalink:"/docs/API-docs/createtemplate"}},j={},g=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Draft Template"})}),"\n",(0,i.jsx)(l(),{method:"post",path:"/drafttemplate"}),"\n",(0,i.jsxs)(n.p,{children:["The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique ",(0,i.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,i.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"When document is created this webhook event will trigger"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:' {\n "event": "created",\n "objectId":"DOCUMENT_ID"\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n }\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified.This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": { \n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "readonly": false,\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"You can provide signer optionally if you it as default signer"})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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'.",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"name or email of the person or organization on the behalf of which you are sending the mail.",example:"opensign\u2122"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(p.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Template created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}})]})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "url": "https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/28b19cd2.05196014.js b/assets/js/28b19cd2.05196014.js deleted file mode 100644 index e1fd42810..000000000 --- a/assets/js/28b19cd2.05196014.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6033],{99442:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>x,default:()=>y,frontMatter:()=>h,metadata:()=>f,toc:()=>j});var i=s(85893),t=s(11151),r=s(58219),n=(s(62316),s(51039)),l=s.n(n),o=(s(82723),s(9487)),m=s(41429),c=s(5397),d=s(4667),p=s(9472),u=s(85162);const h={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWc1u3DgSfpUKL04Cudt2kj00FovJOMGsMYOxMXaQg200KKkk0aZIDX+6rW30bZ9kHm2eZFGkpFa7244DLOayCwSJTVUVi/X7VWXFHC8tm12zTzrzNSpn2W3CcrSZEY0TWrEZu6oQTg1yh9BTwceLM+BS6qWFVntwGkpUaIhG4RLyXhqkLdx566AxeiFyoUpwWDeSO5yLHISyDnkOugDfSM0DAQ8iCiHxtVDgKoRCm5poUm7xb+9BG0iF4qZ9A7hA04ITNQY9FGJOymRRXT4oMoGr7lpL0sBgQxS5bMFbzMNtFjKuIMWOO4fC6Jo+GxDKoSl4hsAdXL99+wlTX8KXs7dvb19XzjV2Np3yppnoBpUVpZI8tZNM19OcCJu8eENKexvevzFnrxOZc3KjWMJ0Q0YUWp3lbMY6Rbo3LIWreuOJnCWs4YbX6NCQB1dM8RrZjI3syxImyIMNdxV77Fad3mHmzoLxe0VYwgz+7oXBnM2c8Zgw61pJYq2oG0kE+NBInSObFVxaIsgqrDmbrZhrm0DpjFAlSxi5jbvxCT7wIGXGmn8ep1V2UjUpW69v47Vo3Y86b0lUppVD5ehH3jRSZMEo0ztLqq9Gd27UvWZkeTLGbdKrEt9IpjJkWSfQBvaOcKMzN4a3ZC6H9fj8CQFG0yN2X7x538cs094prhxbJwxrLuSzJgoEYwF3Gn/ofqNIIinRwc/deqcRUkQibiqtvkF9fPKO/rw7Zut1wpxw4XQ76EbRNL/szEbUhZY5GorS524gRSyqfP7YAKnWErnaCcqrSlgY4vpRibENZqJoYVmhq9CE4yVXDoJ0SyQpgqX6RNRR2wlQ/cqx4F46WHDpEYSFG0bhfcMmcFaElIxfNP2ypcKIFrjKQWk4CPfNrQ/BcTDtfk913h5sOC1wg53OAvNBhUA8VEELSyEl6U11KBaBwX50bR89/XX7DL5tw1Nvna4hXNMxhZpHBuHOG4Qu2SZwyhUIlUmfY1doyeBUpWC16kNgHiJjvYbVinyJZk6BuF4nmwO6a+sgRF88MZihWGxxDUe4YRzORqz40AjTznPuuoNM1w1X7VgBUSqhyrk3cr2e7ATfxjMvttuOmTqPkZD/AYuROmfq3ORoXpCvZwVYDOl2QMF6kIBWso2WEca6LgtjkHcKh69PWVko4QSXsp3A5yGrrU8tUale3iZrnBFliQZz6CgCcwLULAF5VsV6ELTiBSU03d4YXAjtba9exS2QpSRS33cVipguQpUT+LHtczeBkXWoMmy9fbIndQmZXOnTTvQn3o6bi/J1imbHpgHNEIjpuCDnraXbAlKhD1xmPuCG6G4gd1PparU3A+QZd5fhpkG/4w+UHYqnEs+vLl7gaXoQHMbqqMNh9EGUAedXF7BAI4quVU/gix381Dueb5FApnOEheDR9QksK5FVZP0WasKMqIK/YikPftvAuQA+4BB2FcqF3atRErsJpaoPqu0TDLkwmDnZhgDS3gHPc0HsXIJ12NgtLwctBkNeaf+SnPmGJTmUXuTB094MhRuNTUYgmoCz8RkxW8i96YFlF7REmaG1Gzv1ViGikfwEUNnIzqHg1qFJwKuAd41vKBt6kfjQoBGoMtxjgifxw3wMIEIdXhPxNsoMB7bRykZ4dXJ0RP88KjUKrM/oVdATRwRAtivRgTdUPjYfRUiI0IW5tD0gIJLB25pwxFJYjAWCpPSwOIEarbW8JMz7Yjj6PGzsZX8vWK7uxMm/HrLFyQVVaG+eh5L7BHQzyiNASS+kB36ntGEKDKW1c0rhpWxfbSFJoaRQOO8dMj85OpqfkP/XCXu/18XRYxVfoDoIqQdLkZfobIBefe2nqbCfnLQBpfvxEgcSLrUqYxOI1ZwQe+AMMfhf8ygao8332u9CIrcEVJ1vNi+Jgr9lw/dHR/MsG4z4YV+eLLgUeRjRr/Q9qld/wXM3jxtf7+L1pOpDHYK2m1FFJArf2dZrx+fxkRYzb4Rrw4z7cMgbcRi/z65vaXKs0VWapuVG26AxDbszNt2uQ9PVqBCtGYk1i35yDhk1JInlKk/1w+4wzxsxXRyzdfKYY+/o/yS1dbwUqjx8lut28/BLck60/9bzN8NrI35GCurOumOqbgNQISdAR/Ykn/+2mbY/954bjcXX/YQ7HmOHKXZnNB0u7sfPYfocj5i346GRse3BMO4aHg06jG0D+J5pgKeRax/GOv6whW66VcW4TfetW6hCB1t2IXjeoKJBNwTw4nine39FmekI0KiX9uR//vuPwNHHW8ivV3DuDTR6iabwMtSwQuKDoEa8u0GzyGuJ1so27JvKsE3LRSkcYY+uC2e84amQgjKSyHQEfaOkthP4uhmQD0xYg+ECJSUySK3vA1jQwL3Tdbijr+dLbe4LUikBDimtq6jbWsSeBVXFVUalK4ZmQvWXq4jUGkONlIuaiAm3YFGITJBgKj+GZw5qrniJdFkCpDdZoavdFoxOCfZZLX0ENk5DjejiE2m3ZyfwiYBkeHgAu+i4kJhHTGOTiCm74KRnqBxSDPtHnjmRYYR9jhsHkpaHIRXjvOKlhEa7OEMQnB77lgQ5w5UNu8gItDvXDObrQFe4I+ftBG7UjbqkYPEWKQCkUPd2dqMO4XoIs6+YWuFws0dcLpc7ZeHNNs9PwlU+pSWm3vCV4TAUkTH78MsbljCHprbnxSWahch6YPDEndNAPO2aB4+bh74E8Eb88JiBCrkUGSqLo1L/8aeLX2AB7yZHLBkVwhcoPP3l7PTzr5efSS6V6ph/x5OjyVFYcGnraq5GVz1eUof97Wi1uZXIox3j/zfcf+GGu+tZDh/ctJFcqBGkja37+tEIwRI2Gy+1bxNWUaufXbPVigz2hTYZdPy7R0M44TZhC24EFfvQzLrhJx8awZOR8Pq3bjB5A0/sx/fq3zdiRV04bBJjt7rH9tFGfn27TvpuTKpFitOowOEVydlI2IFqBCYix8csw8Y9SzvGRhfnl1csYf0irA4LfGb4kjb+fMlm7IbdsPAfEKH0hiU3na+Y5Kr0YUpgUS6BCO7JU2MEch8QSPcDvWyvTbahSXwK/U0P28vwd8rDn7H9x0AevzzJ0Nm2pyb/3K7X6/8AHryNmA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,f={id:"API-docs/createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",source:"@site/docs/API-docs/createdocumentwithtemplateid.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocumentwithtemplateid",permalink:"/docs/API-docs/createdocumentwithtemplateid",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWc1u3DgSfpUKL04Cudt2kj00FovJOMGsMYOxMXaQg200KKkk0aZIDX+6rW30bZ9kHm2eZFGkpFa7244DLOayCwSJTVUVi/X7VWXFHC8tm12zTzrzNSpn2W3CcrSZEY0TWrEZu6oQTg1yh9BTwceLM+BS6qWFVntwGkpUaIhG4RLyXhqkLdx566AxeiFyoUpwWDeSO5yLHISyDnkOugDfSM0DAQ8iCiHxtVDgKoRCm5poUm7xb+9BG0iF4qZ9A7hA04ITNQY9FGJOymRRXT4oMoGr7lpL0sBgQxS5bMFbzMNtFjKuIMWOO4fC6Jo+GxDKoSl4hsAdXL99+wlTX8KXs7dvb19XzjV2Np3yppnoBpUVpZI8tZNM19OcCJu8eENKexvevzFnrxOZc3KjWMJ0Q0YUWp3lbMY6Rbo3LIWreuOJnCWs4YbX6NCQB1dM8RrZjI3syxImyIMNdxV77Fad3mHmzoLxe0VYwgz+7oXBnM2c8Zgw61pJYq2oG0kE+NBInSObFVxaIsgqrDmbrZhrm0DpjFAlSxi5jbvxCT7wIGXGmn8ep1V2UjUpW69v47Vo3Y86b0lUppVD5ehH3jRSZMEo0ztLqq9Gd27UvWZkeTLGbdKrEt9IpjJkWSfQBvaOcKMzN4a3ZC6H9fj8CQFG0yN2X7x538cs094prhxbJwxrLuSzJgoEYwF3Gn/ofqNIIinRwc/deqcRUkQibiqtvkF9fPKO/rw7Zut1wpxw4XQ76EbRNL/szEbUhZY5GorS524gRSyqfP7YAKnWErnaCcqrSlgY4vpRibENZqJoYVmhq9CE4yVXDoJ0SyQpgqX6RNRR2wlQ/cqx4F46WHDpEYSFG0bhfcMmcFaElIxfNP2ypcKIFrjKQWk4CPfNrQ/BcTDtfk913h5sOC1wg53OAvNBhUA8VEELSyEl6U11KBaBwX50bR89/XX7DL5tw1Nvna4hXNMxhZpHBuHOG4Qu2SZwyhUIlUmfY1doyeBUpWC16kNgHiJjvYbVinyJZk6BuF4nmwO6a+sgRF88MZihWGxxDUe4YRzORqz40AjTznPuuoNM1w1X7VgBUSqhyrk3cr2e7ATfxjMvttuOmTqPkZD/AYuROmfq3ORoXpCvZwVYDOl2QMF6kIBWso2WEca6LgtjkHcKh69PWVko4QSXsp3A5yGrrU8tUale3iZrnBFliQZz6CgCcwLULAF5VsV6ELTiBSU03d4YXAjtba9exS2QpSRS33cVipguQpUT+LHtczeBkXWoMmy9fbIndQmZXOnTTvQn3o6bi/J1imbHpgHNEIjpuCDnraXbAlKhD1xmPuCG6G4gd1PparU3A+QZd5fhpkG/4w+UHYqnEs+vLl7gaXoQHMbqqMNh9EGUAedXF7BAI4quVU/gix381Dueb5FApnOEheDR9QksK5FVZP0WasKMqIK/YikPftvAuQA+4BB2FcqF3atRErsJpaoPqu0TDLkwmDnZhgDS3gHPc0HsXIJ12NgtLwctBkNeaf+SnPmGJTmUXuTB094MhRuNTUYgmoCz8RkxW8i96YFlF7REmaG1Gzv1ViGikfwEUNnIzqHg1qFJwKuAd41vKBt6kfjQoBGoMtxjgifxw3wMIEIdXhPxNsoMB7bRykZ4dXJ0RP88KjUKrM/oVdATRwRAtivRgTdUPjYfRUiI0IW5tD0gIJLB25pwxFJYjAWCpPSwOIEarbW8JMz7Yjj6PGzsZX8vWK7uxMm/HrLFyQVVaG+eh5L7BHQzyiNASS+kB36ntGEKDKW1c0rhpWxfbSFJoaRQOO8dMj85OpqfkP/XCXu/18XRYxVfoDoIqQdLkZfobIBefe2nqbCfnLQBpfvxEgcSLrUqYxOI1ZwQe+AMMfhf8ygao8332u9CIrcEVJ1vNi+Jgr9lw/dHR/MsG4z4YV+eLLgUeRjRr/Q9qld/wXM3jxtf7+L1pOpDHYK2m1FFJArf2dZrx+fxkRYzb4Rrw4z7cMgbcRi/z65vaXKs0VWapuVG26AxDbszNt2uQ9PVqBCtGYk1i35yDhk1JInlKk/1w+4wzxsxXRyzdfKYY+/o/yS1dbwUqjx8lut28/BLck60/9bzN8NrI35GCurOumOqbgNQISdAR/Ykn/+2mbY/954bjcXX/YQ7HmOHKXZnNB0u7sfPYfocj5i346GRse3BMO4aHg06jG0D+J5pgKeRax/GOv6whW66VcW4TfetW6hCB1t2IXjeoKJBNwTw4nine39FmekI0KiX9uR//vuPwNHHW8ivV3DuDTR6iabwMtSwQuKDoEa8u0GzyGuJ1so27JvKsE3LRSkcYY+uC2e84amQgjKSyHQEfaOkthP4uhmQD0xYg+ECJSUySK3vA1jQwL3Tdbijr+dLbe4LUikBDimtq6jbWsSeBVXFVUalK4ZmQvWXq4jUGkONlIuaiAm3YFGITJBgKj+GZw5qrniJdFkCpDdZoavdFoxOCfZZLX0ENk5DjejiE2m3ZyfwiYBkeHgAu+i4kJhHTGOTiCm74KRnqBxSDPtHnjmRYYR9jhsHkpaHIRXjvOKlhEa7OEMQnB77lgQ5w5UNu8gItDvXDObrQFe4I+ftBG7UjbqkYPEWKQCkUPd2dqMO4XoIs6+YWuFws0dcLpc7ZeHNNs9PwlU+pSWm3vCV4TAUkTH78MsbljCHprbnxSWahch6YPDEndNAPO2aB4+bh74E8Eb88JiBCrkUGSqLo1L/8aeLX2AB7yZHLBkVwhcoPP3l7PTzr5efSS6V6ph/x5OjyVFYcGnraq5GVz1eUof97Wi1uZXIox3j/zfcf+GGu+tZDh/ctJFcqBGkja37+tEIwRI2Gy+1bxNWUaufXbPVigz2hTYZdPy7R0M44TZhC24EFfvQzLrhJx8awZOR8Pq3bjB5A0/sx/fq3zdiRV04bBJjt7rH9tFGfn27TvpuTKpFitOowOEVydlI2IFqBCYix8csw8Y9SzvGRhfnl1csYf0irA4LfGb4kjb+fMlm7IbdsPAfEKH0hiU3na+Y5Kr0YUpgUS6BCO7JU2MEch8QSPcDvWyvTbahSXwK/U0P28vwd8rDn7H9x0AevzzJ0Nm2pyb/3K7X6/8AHryNmA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document",permalink:"/docs/API-docs/createdocument"},next:{title:"Get Document",permalink:"/docs/API-docs/getdocument"}},g={},j=[{value:"Request",id:"request",level:2}];function b(e){const a={a:"a",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(a.p,{children:"Create Document from Template"})}),"\n",(0,i.jsx)(l(),{method:"post",path:"/createdocument/{template_id}"}),"\n",(0,i.jsxs)(a.p,{children:["The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at ",(0,i.jsx)(a.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(a.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,i.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(a.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(m.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(u.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(a.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(a.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(a.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(a.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Accoutnant"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"mail",qualifierMessage:void 0,schema:{type:"string",format:"mail",example:"joe@example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"123123131"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(a.p,{children:"]"})})})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.\n",example:!0}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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'.",example:!0}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(r.Z,{children:[(0,i.jsxs)(u.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"In success response you will get url in response if you are also signer in document otherwise only get objectId, messsage"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document sent successfully!"}})]})]})}),(0,i.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://example.com",\n "message": "Document sent successfully!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(u.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"If you haven't add widgets and signers in template or not provide signers along with their roles in body"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please setup template properly!"}})})]})}),(0,i.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Please setup template properly!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(u.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/28b19cd2.5f8c6828.js b/assets/js/28b19cd2.5f8c6828.js new file mode 100644 index 000000000..9b2ad15e1 --- /dev/null +++ b/assets/js/28b19cd2.5f8c6828.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6033],{99442:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>g,toc:()=>j});var i=a(85893),t=a(11151),r=a(58219),l=(a(62316),a(51039)),n=a.n(l),o=(a(82723),a(9487)),m=a(41429),c=a(5397),d=a(4667),p=a(9472),h=a(85162);const u={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWc1u20gSfpVKXxwHtGQ7yR6ExWIyTjBrzGBsxA5ysA2hSRbFtpvdnP6RzBF0myeZR5snWVQ3SVE/dhxgMZddIEiiVnV1/ddXpSVzfGbZ5IZ91JmvUDnL7hKWo82MqJ3Qik3YdYlwZpA7hI4KPlyeA5dSLyw02oPTMEOFhmgULiDvuEHawL23Dmqj5yIXagYOq1pyh1ORg1DWIc9BF+BrqXkg4IFFISS+FgpciVBoUxFNyi3+4x1oA6lQ3DSHgHM0DThRYZBDIeYkTBbF5b0gI7hun7XEDQzWRJHLBrzFPLxmIeMKUmxv51AYXdHXBoRyaAqeIXAHN2/efMTUz+DL+Zs3d69L52o7GY95XY90jcqKmZI8taNMV+OcCOu8OCShvQ36r83ZyUTmHN0qljBdkxGFVuc5m7BWkFaHhXBlZzyRs4TV3PAKHRry4JIpXiGbsIF9WcIEebDmrmTbbtXpPWbuPBi/E4QlzOBvXhjM2cQZjwmzrpHE1oqqlkSAj7XUObJJwaUlgqzEirPJkrmmDpTOCDVjCSO3cTc8wUceuExY/e+TtMxOyzplq9VdfBat+1HnDbHKtHKoHP2X17UUWTDK+N6S6MvBm2txbxhZnoxxl3SiRB3JVIYs6wTacL0lXMvMjeENmcthNTx/goHRpMSuxmv9PmSZ9k5x5dgqYVhxIZ81USAYMrjX+EP7iSKJuEQHP/fqvUZIEYm4LrX6BvXJ6Vv68/aErVYJc8KF082gG0TT9Ko1G1EXWuZoKEqfe4EEsajy6bYBUq0lcrUTlNelsNDH9VaJsTVmomhgUaIr0YTjBVcOAndLJCmCpfpE1FHaEVD9yrHgXjqYc+kRhIVbRuF9y0ZwXoSUjN9o+rAhwoAWuMpBaTgI702tD8FxMG4/pzpvDtY3LXCDrcwC816EQNxXQQsLISXJTXUoFoHefvRsFz3dc/sMvmnDM2+driA8014KNY8Mwp03CG2yjeCMKxAqkz7HttCSwalKwXLZhcA0RMZqBcsl+RLNlAJxtUrWB/TWxkGIvnhiMEMx37jVH+H6Yn82uIqPtTDNNOeuPch0VXPVDAUQMyXUbOqNXK1GO8G39syL7bZjptZjxOR/wGIkzrm6MDmaF+TreQEWQ7odULAeJKCVbKJlhLGuzcIY5K3A4dunrCyUcIJL2YzgU5/V1qeWqFTHb501zojZDA3m0FKEywlQswTkWRnrQZCKF5TQ9HptcC60t514JbdAlpJIfd+VKGK6CDUbwY9Nl7sJDKxDlWFD99Ge1CVkcq3PWtYfeTNsLspXKZodmwY0QyCmvQU5byy9FpAKfcFl5gNuiO4GcjeVrkZ700OeYXfpX+rlO3lP2aF4KvHi+vIFniaF4ChWRx0Oow8iD7i4voQ5GlG0rXoEX2zvp87xfIMEMp0jzAWPrk9gUYqsJOs3UBFmRBX8FUt58NsazgXwAUewK1Au7F6JkthNKFV9EG0fY8iFwczJJgSQ9g54ngu6ziVYh7Xd8HKQojfktfYvyZlvWJLDzIs8eNqbvnCjsckARBNwNj6jyxZybzpg2QYtUWZo7dpOnVWIaMA/AVQ2XudQcOvQJOBVwLvG15QNHUt8rNEIVBnuN0FsUuty9+2CS1SEi2Pm69iHazRWKzrWZsaV+D3Gio5+SrHksiDaGCwEAUKbRZV3NiBum3Wtg+V//fEnlbgQB9NK531s2Je77RJNJZztC5HTFCKAEuPAY31WArfrAmeTrqjZBKzjVW0TUs/howtq6Zr0wUdhHamwEPkMnQXxVMh/RrJnNpAhDCoUqORG1QxjtpfL6S12AWoJG0+H8GiPe5+Eh9MhPgxtdkXEm0NEOLC1Vjai59PjY/pnq5MoMh0FLXTEEeBRaszQgTfUHdZfiqL3Ppe2w3tE0iezJpi4EBZj/Scu3dSTQIXWWj6jkebF08bzU0HH+3tnofJenP7+mM1PLyk6vXl+UtjHoB1Bt+YF0pAU/E5u/ZAfOmfrlMJL2bzaGBSEkkLhtHPI9PT4eHpK/l8l7N1eF0ePlXyO6iBU1j7YCVl30UyB3w3G2oDS3fYAexIudcgUV7bNmgaycDPE4H/No2iMNt9rv0uJ3FJJcr5eaxIZf8uG746Pp1nWG/H9vjyZcynysIG51g+oXv0N6q6VGz7v4vMk6mMVgrZdQYhIFL5nG9oOz6OSFjNvhGvCCuPxiNfiKH4/ubmjxUCFrtS0DKm1DRLTLmPCxpt1aLwcFKIVI7Zm3i1GQkb1SWK5ylP9uLur4bUYz0/YKtm+sXez8yS1dXwm1Ozo2Vt3a8WvyDnR/hvqr3cTtfgZKahb6w6p2gVPiZzwOtmTfP55vUz51HlusPW46RYYwy1Fv6TY2Tz0D3fbhX65MNwg3A13Aoxtzv1xlbQ1xzK2OZ91l/rpI97aB6FP3m+A13YTNURh3dEuKtlAA0+AgQ7UCFXo4Ik2gC9qVLQFCeE/P9nBCF9RZjqid2qrHflff/wZbnTRGp55BRfeQK0XaAovQwUsJD4KQmm761WLvJJorWzCMnIWVq25mAlHwLSFaBmveSqkoHwmMh0ngkFJsCP4ut6eHJiwI8U5SioDILV+CChKA/dOV+GNrhsstHkoSKQEOKS0y6RebRG7K6hKrjIqfDGwA8rhKsL42lAb5qIiYgK1WBQiE8SYipfhmYOKKz4LcCUBkpus0FZ+C0anNBNYLX1EvU5DheiiirT4tSP4SFNGUDxMQui4kJhHwGuTOHC0oU1qqBxSDMtpnjmRYZwJHDcOJG2WQyLHYdZLCbV2ccAkvDb0LTFyhisbFtVxCmtd05uvReThjZw3I7hVt+qKgsVbpACQQj3Yya06gps+zL5iaoXD9ZJ5sVjsFJXDzTs/CVf6lDbcen1vFg5DCRpe7z8csoQ5NJW9KK7QzEXWwYon3hwH4nHbenhcS3UFhNfih+0L1AakyFBZHDSKDz9d/gJzeDs6ZsmgjL5A4PEv52effr36RHyp0Mf8Oxkdj47D9lNbV3E1eGr7F4yAmQd7741EHiyg///zx9/480fb8Wg0GteSCzUAxLHx32wNICxhk+EvHncJKwkoTG7YckkG+0JrLjr+zaMhlHGXsDk3glpFaIXtZJz3PePJSHj9uR1rDuGJH0/2yt+1cUU9PExYsdc9YLP1c83qbpV0vZxEixRnUYCja+Kz5rAD9AiKxBsfsgxr9yztEFldXlxds4R1W9Iq/LrDDF/Qz0F8wSbslt2y8OtUPyyH8yWTXM18mDFY5EsQhHvy1BC/PAT80v6HNNtrk01gE1Whv0mxvRf+SXn4Mzb/6snjN09eaG3bUZN/7lar1X8ARXhStQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,g={id:"API-docs/createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",source:"@site/docs/API-docs/createdocumentwithtemplateid.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocumentwithtemplateid",permalink:"/docs/API-docs/createdocumentwithtemplateid",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWc1u20gSfpVKXxwHtGQ7yR6ExWIyTjBrzGBsxA5ysA2hSRbFtpvdnP6RzBF0myeZR5snWVQ3SVE/dhxgMZddIEiiVnV1/ddXpSVzfGbZ5IZ91JmvUDnL7hKWo82MqJ3Qik3YdYlwZpA7hI4KPlyeA5dSLyw02oPTMEOFhmgULiDvuEHawL23Dmqj5yIXagYOq1pyh1ORg1DWIc9BF+BrqXkg4IFFISS+FgpciVBoUxFNyi3+4x1oA6lQ3DSHgHM0DThRYZBDIeYkTBbF5b0gI7hun7XEDQzWRJHLBrzFPLxmIeMKUmxv51AYXdHXBoRyaAqeIXAHN2/efMTUz+DL+Zs3d69L52o7GY95XY90jcqKmZI8taNMV+OcCOu8OCShvQ36r83ZyUTmHN0qljBdkxGFVuc5m7BWkFaHhXBlZzyRs4TV3PAKHRry4JIpXiGbsIF9WcIEebDmrmTbbtXpPWbuPBi/E4QlzOBvXhjM2cQZjwmzrpHE1oqqlkSAj7XUObJJwaUlgqzEirPJkrmmDpTOCDVjCSO3cTc8wUceuExY/e+TtMxOyzplq9VdfBat+1HnDbHKtHKoHP2X17UUWTDK+N6S6MvBm2txbxhZnoxxl3SiRB3JVIYs6wTacL0lXMvMjeENmcthNTx/goHRpMSuxmv9PmSZ9k5x5dgqYVhxIZ81USAYMrjX+EP7iSKJuEQHP/fqvUZIEYm4LrX6BvXJ6Vv68/aErVYJc8KF082gG0TT9Ko1G1EXWuZoKEqfe4EEsajy6bYBUq0lcrUTlNelsNDH9VaJsTVmomhgUaIr0YTjBVcOAndLJCmCpfpE1FHaEVD9yrHgXjqYc+kRhIVbRuF9y0ZwXoSUjN9o+rAhwoAWuMpBaTgI702tD8FxMG4/pzpvDtY3LXCDrcwC816EQNxXQQsLISXJTXUoFoHefvRsFz3dc/sMvmnDM2+driA8014KNY8Mwp03CG2yjeCMKxAqkz7HttCSwalKwXLZhcA0RMZqBcsl+RLNlAJxtUrWB/TWxkGIvnhiMEMx37jVH+H6Yn82uIqPtTDNNOeuPch0VXPVDAUQMyXUbOqNXK1GO8G39syL7bZjptZjxOR/wGIkzrm6MDmaF+TreQEWQ7odULAeJKCVbKJlhLGuzcIY5K3A4dunrCyUcIJL2YzgU5/V1qeWqFTHb501zojZDA3m0FKEywlQswTkWRnrQZCKF5TQ9HptcC60t514JbdAlpJIfd+VKGK6CDUbwY9Nl7sJDKxDlWFD99Ge1CVkcq3PWtYfeTNsLspXKZodmwY0QyCmvQU5byy9FpAKfcFl5gNuiO4GcjeVrkZ700OeYXfpX+rlO3lP2aF4KvHi+vIFniaF4ChWRx0Oow8iD7i4voQ5GlG0rXoEX2zvp87xfIMEMp0jzAWPrk9gUYqsJOs3UBFmRBX8FUt58NsazgXwAUewK1Au7F6JkthNKFV9EG0fY8iFwczJJgSQ9g54ngu6ziVYh7Xd8HKQojfktfYvyZlvWJLDzIs8eNqbvnCjsckARBNwNj6jyxZybzpg2QYtUWZo7dpOnVWIaMA/AVQ2XudQcOvQJOBVwLvG15QNHUt8rNEIVBnuN0FsUuty9+2CS1SEi2Pm69iHazRWKzrWZsaV+D3Gio5+SrHksiDaGCwEAUKbRZV3NiBum3Wtg+V//fEnlbgQB9NK531s2Je77RJNJZztC5HTFCKAEuPAY31WArfrAmeTrqjZBKzjVW0TUs/howtq6Zr0wUdhHamwEPkMnQXxVMh/RrJnNpAhDCoUqORG1QxjtpfL6S12AWoJG0+H8GiPe5+Eh9MhPgxtdkXEm0NEOLC1Vjai59PjY/pnq5MoMh0FLXTEEeBRaszQgTfUHdZfiqL3Ppe2w3tE0iezJpi4EBZj/Scu3dSTQIXWWj6jkebF08bzU0HH+3tnofJenP7+mM1PLyk6vXl+UtjHoB1Bt+YF0pAU/E5u/ZAfOmfrlMJL2bzaGBSEkkLhtHPI9PT4eHpK/l8l7N1eF0ePlXyO6iBU1j7YCVl30UyB3w3G2oDS3fYAexIudcgUV7bNmgaycDPE4H/No2iMNt9rv0uJ3FJJcr5eaxIZf8uG746Pp1nWG/H9vjyZcynysIG51g+oXv0N6q6VGz7v4vMk6mMVgrZdQYhIFL5nG9oOz6OSFjNvhGvCCuPxiNfiKH4/ubmjxUCFrtS0DKm1DRLTLmPCxpt1aLwcFKIVI7Zm3i1GQkb1SWK5ylP9uLur4bUYz0/YKtm+sXez8yS1dXwm1Ozo2Vt3a8WvyDnR/hvqr3cTtfgZKahb6w6p2gVPiZzwOtmTfP55vUz51HlusPW46RYYwy1Fv6TY2Tz0D3fbhX65MNwg3A13Aoxtzv1xlbQ1xzK2OZ91l/rpI97aB6FP3m+A13YTNURh3dEuKtlAA0+AgQ7UCFXo4Ik2gC9qVLQFCeE/P9nBCF9RZjqid2qrHflff/wZbnTRGp55BRfeQK0XaAovQwUsJD4KQmm761WLvJJorWzCMnIWVq25mAlHwLSFaBmveSqkoHwmMh0ngkFJsCP4ut6eHJiwI8U5SioDILV+CChKA/dOV+GNrhsstHkoSKQEOKS0y6RebRG7K6hKrjIqfDGwA8rhKsL42lAb5qIiYgK1WBQiE8SYipfhmYOKKz4LcCUBkpus0FZ+C0anNBNYLX1EvU5DheiiirT4tSP4SFNGUDxMQui4kJhHwGuTOHC0oU1qqBxSDMtpnjmRYZwJHDcOJG2WQyLHYdZLCbV2ccAkvDb0LTFyhisbFtVxCmtd05uvReThjZw3I7hVt+qKgsVbpACQQj3Yya06gps+zL5iaoXD9ZJ5sVjsFJXDzTs/CVf6lDbcen1vFg5DCRpe7z8csoQ5NJW9KK7QzEXWwYon3hwH4nHbenhcS3UFhNfih+0L1AakyFBZHDSKDz9d/gJzeDs6ZsmgjL5A4PEv52effr36RHyp0Mf8Oxkdj47D9lNbV3E1eGr7F4yAmQd7741EHiyg///zx9/480fb8Wg0GteSCzUAxLHx32wNICxhk+EvHncJKwkoTG7YckkG+0JrLjr+zaMhlHGXsDk3glpFaIXtZJz3PePJSHj9uR1rDuGJH0/2yt+1cUU9PExYsdc9YLP1c83qbpV0vZxEixRnUYCja+Kz5rAD9AiKxBsfsgxr9yztEFldXlxds4R1W9Iq/LrDDF/Qz0F8wSbslt2y8OtUPyyH8yWTXM18mDFY5EsQhHvy1BC/PAT80v6HNNtrk01gE1Whv0mxvRf+SXn4Mzb/6snjN09eaG3bUZN/7lar1X8ARXhStQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document",permalink:"/docs/API-docs/createdocument"},next:{title:"Get Document",permalink:"/docs/API-docs/getdocument"}},f={},j=[{value:"Request",id:"request",level:2}];function y(e){const s={a:"a",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Create Document from Template"})}),"\n",(0,i.jsx)(n(),{method:"post",path:"/createdocument/{template_id}"}),"\n",(0,i.jsxs)(s.p,{children:["The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at ",(0,i.jsx)(s.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(s.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(m.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(s.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(s.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(s.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Accoutnant"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"mail",qualifierMessage:void 0,schema:{type:"string",format:"mail",example:"joe@example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"123123131"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.\n",example:!0}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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'.",example:!0}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email_sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"name or email of the person or organization on the behalf of which you are sending the mail.",example:"opensign\u2122"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(r.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"In success response you will get url in response if you are also signer in document otherwise only get objectId, messsage"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document sent successfully!"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://example.com",\n "message": "Document sent successfully!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"If you haven't add widgets and signers in template or not provide signers along with their roles in body"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please setup template properly!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Please setup template properly!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.cb5d272f.js b/assets/js/2c586be5.cb5d272f.js deleted file mode 100644 index e2fec4047..000000000 --- a/assets/js/2c586be5.cb5d272f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>u,default:()=>b,frontMatter:()=>p,metadata:()=>x,toc:()=>g});var i=s(85893),a=s(11151),t=s(58219),l=(s(62316),s(51039)),r=s.n(l),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),h=s(85162);const p={id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztW+FyGzeSfpXe+eNYNaREWna8rKurdezcnm6TSLVSKrUlqRRwpknCmgEmAEYUo+K/e5J7tH2SrW4AM0OKlGQ7lVXq6B8WB2gAjQ/djUajcZc4MbXJ6Dz5oLO6ROVscpkmOdrMyMpJrZJRcjZDeG9QOIRIBe9OjkAUhZ5bqC0aC07DFBUaolI4hzz2B+MFVEbfyFyqKeTCCZhLN4OxsPjmEFBlOsccJrLA/oW6UGeyGsGPVaFFDgtdGzj58F9NbzQMlZ3v7X3AcT2FH4/29i6/mjlX2dH+vqiqvq5QWTlVhRjbfqbL/ZwIq3zyMoX5DA1Sr5AJBSisLBYg8hzmMp+isym4GSrIdLWATGuTSyUc2hQqMUVQdTlGY1MQKodSGwSpQIBBkS96Tvdqi/A/p8c/wESbUrg+nBS1TZvhcmkwc8XCd+9m2MzqhY1oWGekmqZQimtCSzr4pZbZNU3bosrpLzV8d3LEWO3tndZVpY3DHH7yUxjt7VHNN1joOQiDTJ/pstQKKmFEiY6XayYcVxv8pZYGc78ooigiFqML1YO9PbeocLS3B0cqlxmBwR1SKehJoO17UgKJSE8rzOREBtIOdKAVzGcymzEmc+HXsypE5tk0aCvMnLzB1Y5vU1hQxx9Q6cjBTBv5q1ZOFLwcN2iczETRXTZikEitE8YRnJWWysXSMAL8IywPrR4vSpArYi0nsEqpuMYi3IiiRhu4mqcwI67+jpVBy6Ie+iUgVQ4zlNPZ1vFE/rG2bqVjqC2x2eUijBVXieFFhm0iCosgJytYluIaO6OBZh0WRR++WUCOE1EXLgVJEudMjX34QTsQVVXITIwLJMkFUh7haoM9XuUgDoERJUpe4xPWaLQgIJeTCRpSTqrkLkKbyB3JWWsCWHPcTCjQam2hM11oQ92vyRCXrwIJmVYOlevDuxshC+bez9aCVFlR5wjjQmTXKYyLGlMwmHvNXSDZrTRYISIBYQPoDBBYLEgMtaIJKB2GlxZs4Crvw9lM2lahqDJizYNI24U1qO1E08iEQdQxwFLIImXkUviox+CkKzAlja2EWqRkMDEFh7durG9TyGaYXfMvI3KpYVw7p5WfWG50leu5CmBOtHJW/rpBJWPNpyM6TOEwhTcpvE1hcJDCYJjC4DCFwZsUBm9TGB6kMBymMDxMYfjGszV8G7AWDcBdBgZDj7L746BLhvc7aVm1yWLaxgjPV4zwhRr0YW+vUSgu/vnnny/U3YUCuEhIwS6S0UXSkFwkKfg6spsXyWiQQii4vUhG8Gr4dSRY0PcbQtd/z+l7QKvhv2f0PRxcqGUYdMjMOFFWDzBC1b89E/EzyBMV8shUFm0bFZJR8rRUQ+tGpQ1bVLFsJ/SKJiSVdFIUdvucIsXzm1bL2drMDmlmLL3bp8XVz29Oka1Yw8bTV7Gx7VRFM8CMDNcgeN1vt5stCPhBnxsAgasvnf8bmn9js7aD0JA8PyS6rH0pHF/32T9gu70djEDw/KBoGftSIN4SELRvbUeBap8fBIGrWBF8AV93cNgbvO4ND4aHKzDQMcoTlGUvz3uLxeILIQQGjNyjMD57m8Gb9U4gnWAnRpcbjip8kmipgvvEv6N7/z059ePo72JOZ0Q+hETnpjkddj1yp3OxeGF9V7Fp48cRfevFLTpschXxwSflbKZlFpgnmui9jekw2CcQegR8vv/99/sdKH1hrywjvhBL6bvH0HdLy7Kf5/112pUV6pSWkOcpbCjfXJHnUJbltnJfQdvlhfozKUJw3bbrQiD4fdRhg9S342/VlbZC5FoVPD6f7jbrytr+MpMqVAS5gTUCg9O6EAZv6ZhqpVaMy29gida0KCpR6+bzqZYPhBwz8EjAV8fBlX8ZBJxmsNoBlTze7t7Eup0YnOIt95HV1umSmJG5oB5SsHU2o0OfiCcGgr2N7/BXJipJ0YUCneNSdFl/ExN+0Tonc1rU9YO5RbcyGWEhttxwNufV54PG4ID3vXAueWDjCxTPz+x3OIuVPtpB1ecXSSmC65JMsP2t3QzNRXLZtPFncsw7bWFTY7h8QJ+gVZocCzHG4r6uPVkbutMJktUBhypKqZpQArN8EDngWnG7Vhsqlxv0zE+7K+DRuEc1iThDIW2Mp6yC1m0dAk4cBlSIHFkcI8QGFLSNWvylIt8w9gSZjwYhrM4jIxAdMGET64uDPaBUNMLKynRxoT5KqWRZl03QctL0GhErwybfhYtaUig8jtBd3XsjiNtHRqAI4fYBLtSAIwsxJsF2ATb7goHk+RmGDmeP74CfYzJWds3P3e8+XRHjvLqKuGGbJFK/QTZKaLdrYR+OaVOiiKlvRCGwLMPKUbjsS1W0Yflp29KAI0ndENn2jalL9XvL4DZheop0rvH9m8lhoPsy34tQe5owdqfxBxLIFbaf7Cv5eGDpr6G2BQNLFr3nZgwDW2s7f5ImuqI7VanVUZ6MkoyvYeO9YZJy32jdNzpfJKO7JITw6WcIkFPT/Y+WLnLvEpvNsBT0K/JEV7909ZqkHINGY5M04ZgN3QMTasko0eOPmNFolSF2nERLfXC70V2k8neXSRrO7cko8ZeaSZrgrSgrIk7Wbn2rfJIs44APddWUtF1Z/tFcolI/K/fWn9Xbh04PyzSh+8bP7OkHaspzK/FMv9dU6PCDWNhOh94BSNZv3KkNqUMWWkEuFpY0rLbeVctEkdUFhQDwtpJm0cQjOA7QkY+G0WakhtHB62W76C1LwhixSNJEOiy75VuEwOhPX7kMNSHDkeJPbftR4xjxL6GALvh5nUT5yVx81Ahj5DWqZlp9cvvB8NVgOHg1GFIP4eLn83H0tfc5WBWMd3RgxTy67732sjYFviPpPyackZ6nLab4uDCebbvE71wd2pmui5wu5VCYPt+lf3aaxqp8N7tS/xFpXqbJ7eOTuYVM92KGAHxV4MRBXVVoINNGoXnZDf09m8kNDw+XabJ4fHqLP+T0vqbFmz8+u584taJNO/l38Prq7TJNZo/z+t9N8se/kdnDN8t2d11zHq7GOl9cRbu1fIwwbhREN9FFjoYckvv2qjU1ZGEoaelq3c6PtS5QqA2GZuXSP6SXkXtInmGIfc9nSP516zVy762jGvxIzy0lEuBaOFJacgdNjRdJH44mHbeXQwjreQeRlnMAlIYXPN6VrdmMv9gP34TRi26CFeW8tDH/yAITg8OyKjhDaS6Lgvimfb0PzT/2/BokiYG4XcaBH98q3vuwJw8YGq2m90DwHfvwXqgmw2M1kwLu7hoxYOlYLuHujlYVzRVtustl2hbQWCsFvK/6EoMZypuVVk0Rtg2bsk5T7+JckYvjC8JlWpcBOVVSTa9qUyyX/Xti2K7Rk3G7B1NYO+rk/wFixM6ROjY5mido7tHEn9w0vCBhfRFC6IyMNNYFffTiHhj2t2JbUA6JEXTg+7bRb1uPLVGp2F+rP87I6RQpjTFQcOOQd4Qim3nLwFyJCak2pyYavJG6tpG9mbCNy50ThfTqItV09eDZQYfTwrpz729SXUWJSsdnJ0/Ako/FPW+J/GnSz9L3AcdnJ5TsKCfhbNeHH22DRIRWrJAAnbXgRoqYD9W4bwsfyUTFiHizuZKZ2g9phj24z1Au7UaO0vZapUkNvtdxmw1LS6RrR2m4MqR4WYeVXcGRuWiAPNP1U6TyESQFTGu+oXW0K0fTyFc9bbKiVNaZ2kdxIa9NzM8MYkGUGVrb4hRRIaJO/ymgsr65gImwDk0KtZKEvKkpaNJ0ibcVGokqw80Q+G2gNSiPmzTOy9Qm6FaIlFdorFZUrM1UKPmrlxXt12mMM1FM2H1pbsF5S0OVRwyot1XLEf2X5BFvwrsbbQwiqAnl/2pl/YFoeHBAf1Zn0uSfh07pJo/wn9RFsfhTkj49APLwacwXb/ZwHjpezT7K4a+32c3whIxobT75eBu9wdoUlFJOYPYaZeTDbgdZqQqp8CrCdjU8OLgaELbLNDncBN+pLtHNOEWSQJwbTcnmVYGCkp/NAsRUSAXkm5jfEE00RpuHncVP4+whEA5XQHh9H4QjxRd2/IThTF+j+n1n2h3e+eGJ1duSZcUrdCI9EdcnK5PtlvtJWsxqI90iGZ3fJbc9Ucmerx+dXy4v04SA1RQ8rLRljoWbJaNk/14s0aK54VjQ+Z0X3UYarVA5XardO5+ISu7fDJJlut5i42lmK7V1YirVtPdgq8t2qqe0HB7xlQm3wZdK/g0p+hLw7FKliSQxmKEg54YQpFX+extI/TauVQxxbopatmuyHodct74bIosxsLgSK9wcKhy87gTpzmO8jUNoTQRtU1CsmXoMczVRrk7gqhO3Om9ltgkRxQjRgEMrw8NDjkF8PeDD+qu3fA4+fLNkKWvPhEmyeu7jkPf66SVJVr3y2KjxOUOr1nHyVzgrHkAsur8jdnYiWu6JZtkIC3ZcoTolh4RU8GZwP8yARabLJq88kv/zf/+PW8SFZgvxJziuDVR6jmZS++T0SYG3klyAzhupeIhFURZobbEA2vmn/Foql1NONIn7fyYqMZaFJJtCZNoHdTtmyfbhp/YY/ML4nJsbLMgUQaE1Px5yGkTtdMljxH1zrs31hFhKQcCY3pugJQcWYxNUM6Ey2ui9qqXkIdBjKfJUKiMtgpAlEZPHhJOJzCRvyFo5IzIHpVBiijRYyuEOQqGKr0WMHpPDaXVRe5eK3qwgOj9FvnLqwwdyYXniHMxGJ2SBufembOq92SDq4THWmE4OFQ0vM7Rtpl6BN2jYtPizSF0UUGnnzwfk3HTXljpyRihL+3MIpIelaeAL7h6PkYtFH+jeifYucnVJAAqprv3TqfNGzH7CsZUO21DPfD6/Z+Zerrb5q3SzegwGK922m3IhG8Vu8+bjJdkQNKU9npyiuZFZ9Ci2jLnPxPth+xM+qhBtiqjkX9YbkDYVMkNlsbNZvfvryXdwA6/6B0naMexPYHj/u6P33/5w+i31S1uP179B/6B/wPFpbV0pVGeotWeI66rbuQDbvVrcvVrcvVrcvVrcvVr847yr271a3L1a3L1a3L1a3L1a3L1a3L1afAZQ7F4t7l4t7l4t7l4t7l4t7l4t7l4t7l4t7l4t7l4t7l4t7l4tPo9HYrtXi7tXi89KIHevFuOrxZBKQn7jflUIqTrpcD7/6Hz9LeNlmswoQWl0ntzd0cXij5SZTMW/1Ggou+kyTW6EkRQ959ymNObwUPLKNVIWyXt/GdA7o/FTL/d8l72W0kUpSL7FO179B2m7OVQnx6dnSZrEVPJS59TGiDm9xRTzZJSQ0eZ3mwwpP5ET/LalEGpacz5N4vul1CNRu9lq3tI15y2FH520HKEWHS5XE5r8VOh/mtjGBv9Bd99/w8V/NuS+ZmuDgG2kpiW8XC6X/wKofBIg",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",source:"@site/docs/API-docs/createdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocument",permalink:"/docs/API-docs/createdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztW+FyGzeSfpXe+eNYNaREWna8rKurdezcnm6TSLVSKrUlqRRwpknCmgEmAEYUo+K/e5J7tH2SrW4AM0OKlGQ7lVXq6B8WB2gAjQ/djUajcZc4MbXJ6Dz5oLO6ROVscpkmOdrMyMpJrZJRcjZDeG9QOIRIBe9OjkAUhZ5bqC0aC07DFBUaolI4hzz2B+MFVEbfyFyqKeTCCZhLN4OxsPjmEFBlOsccJrLA/oW6UGeyGsGPVaFFDgtdGzj58F9NbzQMlZ3v7X3AcT2FH4/29i6/mjlX2dH+vqiqvq5QWTlVhRjbfqbL/ZwIq3zyMoX5DA1Sr5AJBSisLBYg8hzmMp+isym4GSrIdLWATGuTSyUc2hQqMUVQdTlGY1MQKodSGwSpQIBBkS96Tvdqi/A/p8c/wESbUrg+nBS1TZvhcmkwc8XCd+9m2MzqhY1oWGekmqZQimtCSzr4pZbZNU3bosrpLzV8d3LEWO3tndZVpY3DHH7yUxjt7VHNN1joOQiDTJ/pstQKKmFEiY6XayYcVxv8pZYGc78ooigiFqML1YO9PbeocLS3B0cqlxmBwR1SKehJoO17UgKJSE8rzOREBtIOdKAVzGcymzEmc+HXsypE5tk0aCvMnLzB1Y5vU1hQxx9Q6cjBTBv5q1ZOFLwcN2iczETRXTZikEitE8YRnJWWysXSMAL8IywPrR4vSpArYi0nsEqpuMYi3IiiRhu4mqcwI67+jpVBy6Ie+iUgVQ4zlNPZ1vFE/rG2bqVjqC2x2eUijBVXieFFhm0iCosgJytYluIaO6OBZh0WRR++WUCOE1EXLgVJEudMjX34QTsQVVXITIwLJMkFUh7haoM9XuUgDoERJUpe4xPWaLQgIJeTCRpSTqrkLkKbyB3JWWsCWHPcTCjQam2hM11oQ92vyRCXrwIJmVYOlevDuxshC+bez9aCVFlR5wjjQmTXKYyLGlMwmHvNXSDZrTRYISIBYQPoDBBYLEgMtaIJKB2GlxZs4Crvw9lM2lahqDJizYNI24U1qO1E08iEQdQxwFLIImXkUviox+CkKzAlja2EWqRkMDEFh7durG9TyGaYXfMvI3KpYVw7p5WfWG50leu5CmBOtHJW/rpBJWPNpyM6TOEwhTcpvE1hcJDCYJjC4DCFwZsUBm9TGB6kMBymMDxMYfjGszV8G7AWDcBdBgZDj7L746BLhvc7aVm1yWLaxgjPV4zwhRr0YW+vUSgu/vnnny/U3YUCuEhIwS6S0UXSkFwkKfg6spsXyWiQQii4vUhG8Gr4dSRY0PcbQtd/z+l7QKvhv2f0PRxcqGUYdMjMOFFWDzBC1b89E/EzyBMV8shUFm0bFZJR8rRUQ+tGpQ1bVLFsJ/SKJiSVdFIUdvucIsXzm1bL2drMDmlmLL3bp8XVz29Oka1Yw8bTV7Gx7VRFM8CMDNcgeN1vt5stCPhBnxsAgasvnf8bmn9js7aD0JA8PyS6rH0pHF/32T9gu70djEDw/KBoGftSIN4SELRvbUeBap8fBIGrWBF8AV93cNgbvO4ND4aHKzDQMcoTlGUvz3uLxeILIQQGjNyjMD57m8Gb9U4gnWAnRpcbjip8kmipgvvEv6N7/z059ePo72JOZ0Q+hETnpjkddj1yp3OxeGF9V7Fp48cRfevFLTpschXxwSflbKZlFpgnmui9jekw2CcQegR8vv/99/sdKH1hrywjvhBL6bvH0HdLy7Kf5/112pUV6pSWkOcpbCjfXJHnUJbltnJfQdvlhfozKUJw3bbrQiD4fdRhg9S342/VlbZC5FoVPD6f7jbrytr+MpMqVAS5gTUCg9O6EAZv6ZhqpVaMy29gida0KCpR6+bzqZYPhBwz8EjAV8fBlX8ZBJxmsNoBlTze7t7Eup0YnOIt95HV1umSmJG5oB5SsHU2o0OfiCcGgr2N7/BXJipJ0YUCneNSdFl/ExN+0Tonc1rU9YO5RbcyGWEhttxwNufV54PG4ID3vXAueWDjCxTPz+x3OIuVPtpB1ecXSSmC65JMsP2t3QzNRXLZtPFncsw7bWFTY7h8QJ+gVZocCzHG4r6uPVkbutMJktUBhypKqZpQArN8EDngWnG7Vhsqlxv0zE+7K+DRuEc1iThDIW2Mp6yC1m0dAk4cBlSIHFkcI8QGFLSNWvylIt8w9gSZjwYhrM4jIxAdMGET64uDPaBUNMLKynRxoT5KqWRZl03QctL0GhErwybfhYtaUig8jtBd3XsjiNtHRqAI4fYBLtSAIwsxJsF2ATb7goHk+RmGDmeP74CfYzJWds3P3e8+XRHjvLqKuGGbJFK/QTZKaLdrYR+OaVOiiKlvRCGwLMPKUbjsS1W0Yflp29KAI0ndENn2jalL9XvL4DZheop0rvH9m8lhoPsy34tQe5owdqfxBxLIFbaf7Cv5eGDpr6G2BQNLFr3nZgwDW2s7f5ImuqI7VanVUZ6MkoyvYeO9YZJy32jdNzpfJKO7JITw6WcIkFPT/Y+WLnLvEpvNsBT0K/JEV7909ZqkHINGY5M04ZgN3QMTasko0eOPmNFolSF2nERLfXC70V2k8neXSRrO7cko8ZeaSZrgrSgrIk7Wbn2rfJIs44APddWUtF1Z/tFcolI/K/fWn9Xbh04PyzSh+8bP7OkHaspzK/FMv9dU6PCDWNhOh94BSNZv3KkNqUMWWkEuFpY0rLbeVctEkdUFhQDwtpJm0cQjOA7QkY+G0WakhtHB62W76C1LwhixSNJEOiy75VuEwOhPX7kMNSHDkeJPbftR4xjxL6GALvh5nUT5yVx81Ahj5DWqZlp9cvvB8NVgOHg1GFIP4eLn83H0tfc5WBWMd3RgxTy67732sjYFviPpPyackZ6nLab4uDCebbvE71wd2pmui5wu5VCYPt+lf3aaxqp8N7tS/xFpXqbJ7eOTuYVM92KGAHxV4MRBXVVoINNGoXnZDf09m8kNDw+XabJ4fHqLP+T0vqbFmz8+u584taJNO/l38Prq7TJNZo/z+t9N8se/kdnDN8t2d11zHq7GOl9cRbu1fIwwbhREN9FFjoYckvv2qjU1ZGEoaelq3c6PtS5QqA2GZuXSP6SXkXtInmGIfc9nSP516zVy762jGvxIzy0lEuBaOFJacgdNjRdJH44mHbeXQwjreQeRlnMAlIYXPN6VrdmMv9gP34TRi26CFeW8tDH/yAITg8OyKjhDaS6Lgvimfb0PzT/2/BokiYG4XcaBH98q3vuwJw8YGq2m90DwHfvwXqgmw2M1kwLu7hoxYOlYLuHujlYVzRVtustl2hbQWCsFvK/6EoMZypuVVk0Rtg2bsk5T7+JckYvjC8JlWpcBOVVSTa9qUyyX/Xti2K7Rk3G7B1NYO+rk/wFixM6ROjY5mido7tHEn9w0vCBhfRFC6IyMNNYFffTiHhj2t2JbUA6JEXTg+7bRb1uPLVGp2F+rP87I6RQpjTFQcOOQd4Qim3nLwFyJCak2pyYavJG6tpG9mbCNy50ThfTqItV09eDZQYfTwrpz729SXUWJSsdnJ0/Ako/FPW+J/GnSz9L3AcdnJ5TsKCfhbNeHH22DRIRWrJAAnbXgRoqYD9W4bwsfyUTFiHizuZKZ2g9phj24z1Au7UaO0vZapUkNvtdxmw1LS6RrR2m4MqR4WYeVXcGRuWiAPNP1U6TyESQFTGu+oXW0K0fTyFc9bbKiVNaZ2kdxIa9NzM8MYkGUGVrb4hRRIaJO/ymgsr65gImwDk0KtZKEvKkpaNJ0ibcVGokqw80Q+G2gNSiPmzTOy9Qm6FaIlFdorFZUrM1UKPmrlxXt12mMM1FM2H1pbsF5S0OVRwyot1XLEf2X5BFvwrsbbQwiqAnl/2pl/YFoeHBAf1Zn0uSfh07pJo/wn9RFsfhTkj49APLwacwXb/ZwHjpezT7K4a+32c3whIxobT75eBu9wdoUlFJOYPYaZeTDbgdZqQqp8CrCdjU8OLgaELbLNDncBN+pLtHNOEWSQJwbTcnmVYGCkp/NAsRUSAXkm5jfEE00RpuHncVP4+whEA5XQHh9H4QjxRd2/IThTF+j+n1n2h3e+eGJ1duSZcUrdCI9EdcnK5PtlvtJWsxqI90iGZ3fJbc9Ucmerx+dXy4v04SA1RQ8rLRljoWbJaNk/14s0aK54VjQ+Z0X3UYarVA5XardO5+ISu7fDJJlut5i42lmK7V1YirVtPdgq8t2qqe0HB7xlQm3wZdK/g0p+hLw7FKliSQxmKEg54YQpFX+extI/TauVQxxbopatmuyHodct74bIosxsLgSK9wcKhy87gTpzmO8jUNoTQRtU1CsmXoMczVRrk7gqhO3Om9ltgkRxQjRgEMrw8NDjkF8PeDD+qu3fA4+fLNkKWvPhEmyeu7jkPf66SVJVr3y2KjxOUOr1nHyVzgrHkAsur8jdnYiWu6JZtkIC3ZcoTolh4RU8GZwP8yARabLJq88kv/zf/+PW8SFZgvxJziuDVR6jmZS++T0SYG3klyAzhupeIhFURZobbEA2vmn/Foql1NONIn7fyYqMZaFJJtCZNoHdTtmyfbhp/YY/ML4nJsbLMgUQaE1Px5yGkTtdMljxH1zrs31hFhKQcCY3pugJQcWYxNUM6Ey2ui9qqXkIdBjKfJUKiMtgpAlEZPHhJOJzCRvyFo5IzIHpVBiijRYyuEOQqGKr0WMHpPDaXVRe5eK3qwgOj9FvnLqwwdyYXniHMxGJ2SBufembOq92SDq4THWmE4OFQ0vM7Rtpl6BN2jYtPizSF0UUGnnzwfk3HTXljpyRihL+3MIpIelaeAL7h6PkYtFH+jeifYucnVJAAqprv3TqfNGzH7CsZUO21DPfD6/Z+Zerrb5q3SzegwGK922m3IhG8Vu8+bjJdkQNKU9npyiuZFZ9Ci2jLnPxPth+xM+qhBtiqjkX9YbkDYVMkNlsbNZvfvryXdwA6/6B0naMexPYHj/u6P33/5w+i31S1uP179B/6B/wPFpbV0pVGeotWeI66rbuQDbvVrcvVrcvVrcvVrcvVr847yr271a3L1a3L1a3L1a3L1a3L1a3L1afAZQ7F4t7l4t7l4t7l4t7l4t7l4t7l4t7l4t7l4t7l4t7l4t7l4tPo9HYrtXi7tXi89KIHevFuOrxZBKQn7jflUIqTrpcD7/6Hz9LeNlmswoQWl0ntzd0cXij5SZTMW/1Ggou+kyTW6EkRQ959ymNObwUPLKNVIWyXt/GdA7o/FTL/d8l72W0kUpSL7FO179B2m7OVQnx6dnSZrEVPJS59TGiDm9xRTzZJSQ0eZ3mwwpP5ET/LalEGpacz5N4vul1CNRu9lq3tI15y2FH520HKEWHS5XE5r8VOh/mtjGBv9Bd99/w8V/NuS+ZmuDgG2kpiW8XC6X/wKofBIg",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Draft Document",permalink:"/docs/API-docs/draftdocument"},next:{title:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"}},j={},g=[{value:"Request",id:"request",level:2}];function y(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Create Document"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/createdocument"}),"\n",(0,i.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": { \n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "readonly": false,\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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. \n",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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'.",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"name or email of the person or organization on the behalf of which you are sending the mail.",example:"opensign"}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-sign-document.com"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.da4bd7cd.js b/assets/js/2c586be5.da4bd7cd.js new file mode 100644 index 000000000..92da7a2b5 --- /dev/null +++ b/assets/js/2c586be5.da4bd7cd.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>u,default:()=>y,frontMatter:()=>p,metadata:()=>x,toc:()=>b});var i=s(85893),a=s(11151),l=s(58219),t=(s(62316),s(51039)),r=s.n(t),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),h=s(85162);const p={id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztW+9yGzeSf5Xe+eJYNaJEWna8qqurdezcrm6TSBXLldqSVAo40yRhzQATACOKUfHbPsk+2j7JVTeA+UORkmynskod/cHiAA2g8UN3o9Fo3CZOTG1yeJa801ldonI2uUiTHG1mZOWkVslhcjpDeGtQOIRIBW9OjkAUhZ5bqC0aC07DFBUaolI4hzz2B+MFVEZfy1yqKeTCCZhLN4OxsPjqAFBlOsccJrLAwbk6V6eyOoQPVaFFDgtdGzh59z9NbzQMlZ3t7LzDcT2FD0c7OxdfzZyr7OHenqiqga5QWTlVhRjbQabLvZwIq3zyPIX5DA1Sr5AJBSisLBYg8hzmMp+isym4GSrIdLWATGuTSyUc2hQqMUVQdTlGY1MQKodSGwSpQIBBkS92nd6tLcL/vj/+ASbalMIN4KSobdoMl0uDmSsWvns3w2ZWz2xEwzoj1TSFUlwRWtLBL7XMrmjaFlVOf6nhm5Mjxmpn531dVdo4zOEnP4XDnR2q+QYLPQdhkOkzXZZaQSWMKNHxcs2E42qDv9TSYO4XRRRFxOLwXO3Czo5bVHi4swNHKpcZgcEdUinoSaAdeFICiUjfV5jJiQykHehAK5jPZDZjTObCr2dViMyzadBWmDl5jf2Ob1JYUMfvUOnIwUwb+atWThS8HNdonMxE0V02YpBIrRPGEZyVlsrF0jAC/CMsD60eL0qQK2ItJ7BKqbjGIlyLokYbuJqnMCOufsTKoGVRD/0SkCqHGcrpbON4Iv9YW9frGGpLbHa5CGPFVWJ4kWGbiMIiyEkPy1JcYWc00KzDohjANwvIcSLqwqUgSeKcqXEAP2gHoqoKmYlxgSS5QMojXG1wl1c5iENgRImS1/iENRotCMjlZIKGlJMquYvQJnJHctaaANYcNxMKtFpZ6EwX2lD3KzLE5X0gIdPKoXIDeHMtZMHc+9lakCor6hxhXIjsKoVxUWMKBnOvuQsku5UGK0QkIGwAnQECiwWJoVY0AaXD8NKCDVzlAzidSdsqFFVGrHkQabuwBrWdaBqZMIg6BlgKWaSMXAof9RicdAWmpLGVUIuUDCam4PDGjfVNCtkMsyv+ZUQuNYxr57TyE8uNrnI9VwHMiVbOyl/XqGSs+XRERykcpPAqhdcpDPdTGI5SGB6kMHyVwvB1CqP9FEajFEYHKYxeebZGrwPWogG4y8Bw5FF2fxx0yfB+Jy2rNllM2xjhec8In6vhAHZ2GoXi4p9//vlc3Z4rgPOEFOw8OTxPGpLzJAVfR3bzPDkcphAKbs6TQ3gx+joSLOj7FaHrv+f0PaTV8N8z+h4Nz9UyDDpiZpwoq3sYoerfnon4GeSJCnlkKou2jQrJKHlaqqF1o9KGLapYthN6QROSSjopCrt5TpHi6U2r5WxlZgc0M5bezdPi6qc3p8hWrGHj6avY2HaqohlgRkYrELwctNvNBgT8oE8NgMDVl87/Fc2/sVmbQWhInh4SXda+FI6vB+wfsN3eDEYgeHpQtIx9KRCvCQjatzajQLVPD4LAVawIvoCv2z/YHb7cHe2PDnow0DHKE5Tlbp7vLhaLL4QQGDByj8L47G0Gb9Y7gXSCnRhdrjmq8EmipQruE/+O7v335NSPo7+LOZ0R+RASnZvmdNj1yJ3OxeKZ9V3Fpo0fR/StF7fosMlVxAeflLOZlllgnmii9zamw+CAQNgl4PO977/f60DpC3fLMuILsZS+dxn6bmlZDvJ8sErbW6FOaQl5nsKa8vUVeQ5lWW4q9xW0XZ6rP5MiBNdtsy4Egt9HHdZIfTv+Rl1pK0SuVcHj8+luva6s7C8zqUJFkBtYITA4rQth8IaOqVZqxbj8BpZoRYuiErVuPp9q+UDIMQOPBHx1HFz550HAaQb9Dqjk4XZ3JtbtxOAUb7iPrLZOl8SMzAX1kIKtsxkd+kQ8MRDsbXyHvzJRSYouFOgcl6LLBuuY8IvWOZnToq4ezC263mSEhdhyzdmcV58PGsN93vfCueSejS9QPD2z3+EsVvpoB1WfnSelCK5LMsH2t3YzNOfJRdPGn8kx77SFdY3h4h59glZpcizEGIu7uvZobehOJ0hWBxyqKKVqQgnM8n7kgGvFzUptqFyu0TM/7a6AR+Me1STiDIW0MZ7SB63bOgScOAyoEDmyOEaIDShoG7X4S0W+YewRMh8NQlidB0YgOmDCJtYXB7tHqWiE3sp0caE+SqlkWZdN0HLS9BoRK8Mm34WLWlIoPI7QXd07I4ibB0agCOHmAc7VkCMLMSbBdgHW+4KB5OkZhg5nD++An2Myervm5+53n66IcV5dRVyzTRKp3yAbJbSbtXAAx7QpUcTUN6IQWJZh5Shc9qUq2rD8uG1pyJGkbohs88bUpfq9ZXCTMD1GOlf4/s3kMNB9me9FqD1OGLvT+AMJZI/tR/tKPh5Y+muoTcHAkkXvqRnDwNbKzp+kia7oTlVqdZQnh0nG17Dx3jBJuW+07hudL5LD2ySE8OlnCJBT072Pli5ybxObzbAU9CvyRFe/dPWapByDRmOTNOGYDd0DE2rJYaLHHzGj0SpD7DiJlvrgdoe3kcrfXSZpOLcnh4m/1EzSBG9EWRFxsnLrW+WTZBkHvK+rpqTtyvKP5hKV+undW39Wb+86PSzThO4bP7OnH6gpz63EU/1WU6HDd2JhOx16ByBZvXGnNqQOWWgFuVhY0rDaelctE0VWFxQCwJtKmkUTj+A4QEc+GkabkRpGhy+X7aK3LAljxCJJE+mw7JZvEAKjP33lMtSEDEeKP7XtR41jxL+EArrg53US5Sdz8VEjjJHXqJpp9cnth6MXw9HwxXBEPYSLn8/H0dfe5aAvGG/owIp5dN9328vaFPiOZPCQcEZ6nraY4sPCeLrpEr9zdWhnui5yupRDYQZ8l/7ZaRp9+W52pcED0rxMk5uHJ3MDmd6NGQLwVYETB3VVoYFMG4XmeTf092QmNzo4WKbJ4uHpLf6Q0/uaFm/+8Ox+4tSKNu3kP8Hri9fLNJk9zOvfmuSP/yCzB6+W7e664jxcjnW+uIx2a/kQYdwoiG6iixwNOSR37VVrasjCUNLS5aqdH2tdoFBrDE3v0j+kl5F7SJ5hiH3PZ0j+des1cu+toxr8SM8tJRLgSjhSWnIHTY3nyQCOJh23l0MIq3kHkZZzAJSGZzzepa3ZjD/bC9+E0bNughXlvLQx/8gCE4PDsio4Q2kui4L4pn19AM0/9vwaJImBuF3GgR/eKt76sCcPGBr103sg+I4DeCtUk+HRz6SA29tGDFg6lku4vaVVRXNJm+5ymbYFNFavgPdVX2IwQ3nda9UUYduwKes09S7OJbk4viBcpnUZkFMl1fSyNsVyObgjhu0aPRq3OzCFtaNO/h8gRuwcqWOTo3mE5h5N/MlNwzMS1mchhM7ISGNd0Ecv7oFhfyu2AeWQGEEHvm8b/bb12BKViv21+uOMnE6R0hgDBTcOeUcospm3DMyVmJBqc2qiwWupaxvZmwnbuNw5UUivLlJN+wfPDjqcFtad+2Cd6ipKVDo+PXkElnws3vWWyJ8m/Sx9H3B8ekLJjnISznYD+GAbJCK0okcCdNaCayliPlTjvi18JBMVI+LNZi8zdRDSDHfhLkO5tGs5SttrlSY1+E7HbTYsLZGuHaXhypDiZR1Wtocjc9EAearrx0jlA0gKmNZ8Q+toV46mka962mRFqawztY/iQl6bmJ8ZxIIoM7S2xSmiQkSd/lNAZX1zARNhHZoUaiUJeVNT0KTpEm8qNBJVhmshMOihI8192Jr1E/8+/PhdyIGOc4hKOSYN9B1jDnXFUsOa0GSkxpVbnfoGa9sxeQ+zyZmj2gTtD7H8Co3Vioq1mQolf/XSrL0kjXEmigk7WM09PW+6qPLIM/XW5y96WP/+57+IVZbUy1LnjfTaxwvWCeUGO9sYI6c5lxwL9Inv8ZaxMXI2jYbNhuMaXTYavhTkaemK5oM30rpOHmNMIbirlD8i4Zl1eGD3nlSJBE0tulrV8BXyJdvu2PGS/RzYxr1cEcD73UTvR7bBpWD/KLFbK+tPuqP9ffrTh7R5WBA6JfBIuiZ1USz+lKSPj2zdf8z2xetd1/vOzbOPcvTrTXY9OiGx2aB693YQ3PzaFPRWgNZrt1kBjmJ0kJWqkAovI2yXo/39yyFhu0yTg3XwvdcluhnLDIE4N5peEVQFCspqNwsQUyEVkNNpfkM00Rht7j8FfBpn94Fw0APh5V0QjhTfxPLblFN9her3nWl3eOeHJ1ZvSpYVbwcT6Ym4PulNtlvuJ2kxq410i+Tw7Da52RWV3PX1h2cXy4s0IWA1RYUrbZlj4WbJYbJ3J0hs0VxzkO/s1otuI41WqJxuS+8cPEUl966HyTJdbbH2mLqR2joxlWq6e2+ri3aq72k5POK9CbdRtUr+HSmsFvDsUqWJJDGYoSCvlRCkVf6xjZB/G9cqxq7XhaPbNVkNMK9uA2tCxjFi3AsCr48BD192oq9nMZDKsdEmNLou2tlMPcYvm/BlJyLZCUietTLbxP5i6G/IMbPRwQEHl74echTmxWsOcBy8WrKUtYf9JOkf6PkuY/VYmiT941Zs1BwmQqvWI/Z3cz3XLhT1XZ22555r0dvSN+zo0XeSaqJZmMIKH1eo3pNrSjp7PbwbcMIi02XzwiCS//uf/+IWUTJ4mD/BcW2g0nM0k9o/U5gUeCPJGey8lovhDBRlgdYWCyAfcMrv5nI55ZSj6GFlohJjWUgyQkSmfXi/Y8fsAH5qAyLPjM++usaCbBcUWvMzMnJMaqdLHiNutHNtribEUgoCxvTyCC0dZTA2QTUTKiOHyusmuyr0bI581spIiyBkScTkO+NkIjPJO7hWzojMQSmUmLLPkXLgi1Co4rsho8d09LC6qL1zTa+XEJ2fIl8+DuAdHWZ44nytgU7IAnPvV9vUn2uCboRneWM6Q1Y0vMzQtjmbBV6jYVvkT6V1UUClnT8pktPVXVvqyBmhLG3o4UolLE0DX/B+eYxcLAZAN5C02dGhhwSgkOrKP6I7a8TsJxxb6bAN+s3n8zt28Xm/zV+lm9VjMFjptt2UC9mKdps3H8/J6KAp7fHkPZprmUUXZMOYe0y8F/ZL4eNL0QiJSv5ltQHtXYXMUFns7G5v/nryHVzDi8F+knZ2gkcwvPfd0dtvf3j/LfVLe5XXv+Fgf7DPNxXaulKozlArD1JXVbdzFbp9v7p9v7p9v7p9v7p9v/rHeWG5fb+6fb+6fb+6fb+6fb+6fb+6fb/6BKDYvl/dvl/dvl/dvl/dvl/dvl/dvl/dvl/dvl/dvl/dvl/dvl99Gs8Ft+9Xt+9Xn5RAbt+vxverIfeE/Ma9qhBSdfLnfMLS2eqr1os0mVFG0+FZcntLF4sfKEedin+p0VA61EWaXAsjKXrOyVBpTPqhbJcrpLSTt/4yYPeUxk+93PNd9koOGOUs+RZvePXvpe0mXZ0cvz9N0iQ+Kih1Tm2MmNOrXDFPDhMy2vyCt8kr5fLbpBBqWnMCTuL7pVwlUbtZP9HpihOdwo9OHo9Qiw6X/QwoPxX6nya2tsF/0d3333Hx3w25r9nYIGAbqWkJL5bL5f8BbrbQGQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",source:"@site/docs/API-docs/createdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocument",permalink:"/docs/API-docs/createdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztW+9yGzeSf5Xe+eJYNaJEWna8qqurdezcrm6TSBXLldqSVAo40yRhzQATACOKUfHbPsk+2j7JVTeA+UORkmynskod/cHiAA2g8UN3o9Fo3CZOTG1yeJa801ldonI2uUiTHG1mZOWkVslhcjpDeGtQOIRIBW9OjkAUhZ5bqC0aC07DFBUaolI4hzz2B+MFVEZfy1yqKeTCCZhLN4OxsPjqAFBlOsccJrLAwbk6V6eyOoQPVaFFDgtdGzh59z9NbzQMlZ3t7LzDcT2FD0c7OxdfzZyr7OHenqiqga5QWTlVhRjbQabLvZwIq3zyPIX5DA1Sr5AJBSisLBYg8hzmMp+isym4GSrIdLWATGuTSyUc2hQqMUVQdTlGY1MQKodSGwSpQIBBkS92nd6tLcL/vj/+ASbalMIN4KSobdoMl0uDmSsWvns3w2ZWz2xEwzoj1TSFUlwRWtLBL7XMrmjaFlVOf6nhm5Mjxmpn531dVdo4zOEnP4XDnR2q+QYLPQdhkOkzXZZaQSWMKNHxcs2E42qDv9TSYO4XRRRFxOLwXO3Czo5bVHi4swNHKpcZgcEdUinoSaAdeFICiUjfV5jJiQykHehAK5jPZDZjTObCr2dViMyzadBWmDl5jf2Ob1JYUMfvUOnIwUwb+atWThS8HNdonMxE0V02YpBIrRPGEZyVlsrF0jAC/CMsD60eL0qQK2ItJ7BKqbjGIlyLokYbuJqnMCOufsTKoGVRD/0SkCqHGcrpbON4Iv9YW9frGGpLbHa5CGPFVWJ4kWGbiMIiyEkPy1JcYWc00KzDohjANwvIcSLqwqUgSeKcqXEAP2gHoqoKmYlxgSS5QMojXG1wl1c5iENgRImS1/iENRotCMjlZIKGlJMquYvQJnJHctaaANYcNxMKtFpZ6EwX2lD3KzLE5X0gIdPKoXIDeHMtZMHc+9lakCor6hxhXIjsKoVxUWMKBnOvuQsku5UGK0QkIGwAnQECiwWJoVY0AaXD8NKCDVzlAzidSdsqFFVGrHkQabuwBrWdaBqZMIg6BlgKWaSMXAof9RicdAWmpLGVUIuUDCam4PDGjfVNCtkMsyv+ZUQuNYxr57TyE8uNrnI9VwHMiVbOyl/XqGSs+XRERykcpPAqhdcpDPdTGI5SGB6kMHyVwvB1CqP9FEajFEYHKYxeebZGrwPWogG4y8Bw5FF2fxx0yfB+Jy2rNllM2xjhec8In6vhAHZ2GoXi4p9//vlc3Z4rgPOEFOw8OTxPGpLzJAVfR3bzPDkcphAKbs6TQ3gx+joSLOj7FaHrv+f0PaTV8N8z+h4Nz9UyDDpiZpwoq3sYoerfnon4GeSJCnlkKou2jQrJKHlaqqF1o9KGLapYthN6QROSSjopCrt5TpHi6U2r5WxlZgc0M5bezdPi6qc3p8hWrGHj6avY2HaqohlgRkYrELwctNvNBgT8oE8NgMDVl87/Fc2/sVmbQWhInh4SXda+FI6vB+wfsN3eDEYgeHpQtIx9KRCvCQjatzajQLVPD4LAVawIvoCv2z/YHb7cHe2PDnow0DHKE5Tlbp7vLhaLL4QQGDByj8L47G0Gb9Y7gXSCnRhdrjmq8EmipQruE/+O7v335NSPo7+LOZ0R+RASnZvmdNj1yJ3OxeKZ9V3Fpo0fR/StF7fosMlVxAeflLOZlllgnmii9zamw+CAQNgl4PO977/f60DpC3fLMuILsZS+dxn6bmlZDvJ8sErbW6FOaQl5nsKa8vUVeQ5lWW4q9xW0XZ6rP5MiBNdtsy4Egt9HHdZIfTv+Rl1pK0SuVcHj8+luva6s7C8zqUJFkBtYITA4rQth8IaOqVZqxbj8BpZoRYuiErVuPp9q+UDIMQOPBHx1HFz550HAaQb9Dqjk4XZ3JtbtxOAUb7iPrLZOl8SMzAX1kIKtsxkd+kQ8MRDsbXyHvzJRSYouFOgcl6LLBuuY8IvWOZnToq4ezC263mSEhdhyzdmcV58PGsN93vfCueSejS9QPD2z3+EsVvpoB1WfnSelCK5LMsH2t3YzNOfJRdPGn8kx77SFdY3h4h59glZpcizEGIu7uvZobehOJ0hWBxyqKKVqQgnM8n7kgGvFzUptqFyu0TM/7a6AR+Me1STiDIW0MZ7SB63bOgScOAyoEDmyOEaIDShoG7X4S0W+YewRMh8NQlidB0YgOmDCJtYXB7tHqWiE3sp0caE+SqlkWZdN0HLS9BoRK8Mm34WLWlIoPI7QXd07I4ibB0agCOHmAc7VkCMLMSbBdgHW+4KB5OkZhg5nD++An2Myervm5+53n66IcV5dRVyzTRKp3yAbJbSbtXAAx7QpUcTUN6IQWJZh5Shc9qUq2rD8uG1pyJGkbohs88bUpfq9ZXCTMD1GOlf4/s3kMNB9me9FqD1OGLvT+AMJZI/tR/tKPh5Y+muoTcHAkkXvqRnDwNbKzp+kia7oTlVqdZQnh0nG17Dx3jBJuW+07hudL5LD2ySE8OlnCJBT072Pli5ybxObzbAU9CvyRFe/dPWapByDRmOTNOGYDd0DE2rJYaLHHzGj0SpD7DiJlvrgdoe3kcrfXSZpOLcnh4m/1EzSBG9EWRFxsnLrW+WTZBkHvK+rpqTtyvKP5hKV+undW39Wb+86PSzThO4bP7OnH6gpz63EU/1WU6HDd2JhOx16ByBZvXGnNqQOWWgFuVhY0rDaelctE0VWFxQCwJtKmkUTj+A4QEc+GkabkRpGhy+X7aK3LAljxCJJE+mw7JZvEAKjP33lMtSEDEeKP7XtR41jxL+EArrg53US5Sdz8VEjjJHXqJpp9cnth6MXw9HwxXBEPYSLn8/H0dfe5aAvGG/owIp5dN9328vaFPiOZPCQcEZ6nraY4sPCeLrpEr9zdWhnui5yupRDYQZ8l/7ZaRp9+W52pcED0rxMk5uHJ3MDmd6NGQLwVYETB3VVoYFMG4XmeTf092QmNzo4WKbJ4uHpLf6Q0/uaFm/+8Ox+4tSKNu3kP8Hri9fLNJk9zOvfmuSP/yCzB6+W7e664jxcjnW+uIx2a/kQYdwoiG6iixwNOSR37VVrasjCUNLS5aqdH2tdoFBrDE3v0j+kl5F7SJ5hiH3PZ0j+des1cu+toxr8SM8tJRLgSjhSWnIHTY3nyQCOJh23l0MIq3kHkZZzAJSGZzzepa3ZjD/bC9+E0bNughXlvLQx/8gCE4PDsio4Q2kui4L4pn19AM0/9vwaJImBuF3GgR/eKt76sCcPGBr103sg+I4DeCtUk+HRz6SA29tGDFg6lku4vaVVRXNJm+5ymbYFNFavgPdVX2IwQ3nda9UUYduwKes09S7OJbk4viBcpnUZkFMl1fSyNsVyObgjhu0aPRq3OzCFtaNO/h8gRuwcqWOTo3mE5h5N/MlNwzMS1mchhM7ISGNd0Ecv7oFhfyu2AeWQGEEHvm8b/bb12BKViv21+uOMnE6R0hgDBTcOeUcospm3DMyVmJBqc2qiwWupaxvZmwnbuNw5UUivLlJN+wfPDjqcFtad+2Cd6ipKVDo+PXkElnws3vWWyJ8m/Sx9H3B8ekLJjnISznYD+GAbJCK0okcCdNaCayliPlTjvi18JBMVI+LNZi8zdRDSDHfhLkO5tGs5SttrlSY1+E7HbTYsLZGuHaXhypDiZR1Wtocjc9EAearrx0jlA0gKmNZ8Q+toV46mka962mRFqawztY/iQl6bmJ8ZxIIoM7S2xSmiQkSd/lNAZX1zARNhHZoUaiUJeVNT0KTpEm8qNBJVhmshMOihI8192Jr1E/8+/PhdyIGOc4hKOSYN9B1jDnXFUsOa0GSkxpVbnfoGa9sxeQ+zyZmj2gTtD7H8Co3Vioq1mQolf/XSrL0kjXEmigk7WM09PW+6qPLIM/XW5y96WP/+57+IVZbUy1LnjfTaxwvWCeUGO9sYI6c5lxwL9Inv8ZaxMXI2jYbNhuMaXTYavhTkaemK5oM30rpOHmNMIbirlD8i4Zl1eGD3nlSJBE0tulrV8BXyJdvu2PGS/RzYxr1cEcD73UTvR7bBpWD/KLFbK+tPuqP9ffrTh7R5WBA6JfBIuiZ1USz+lKSPj2zdf8z2xetd1/vOzbOPcvTrTXY9OiGx2aB693YQ3PzaFPRWgNZrt1kBjmJ0kJWqkAovI2yXo/39yyFhu0yTg3XwvdcluhnLDIE4N5peEVQFCspqNwsQUyEVkNNpfkM00Rht7j8FfBpn94Fw0APh5V0QjhTfxPLblFN9her3nWl3eOeHJ1ZvSpYVbwcT6Ym4PulNtlvuJ2kxq410i+Tw7Da52RWV3PX1h2cXy4s0IWA1RYUrbZlj4WbJYbJ3J0hs0VxzkO/s1otuI41WqJxuS+8cPEUl966HyTJdbbH2mLqR2joxlWq6e2+ri3aq72k5POK9CbdRtUr+HSmsFvDsUqWJJDGYoSCvlRCkVf6xjZB/G9cqxq7XhaPbNVkNMK9uA2tCxjFi3AsCr48BD192oq9nMZDKsdEmNLou2tlMPcYvm/BlJyLZCUietTLbxP5i6G/IMbPRwQEHl74echTmxWsOcBy8WrKUtYf9JOkf6PkuY/VYmiT941Zs1BwmQqvWI/Z3cz3XLhT1XZ22555r0dvSN+zo0XeSaqJZmMIKH1eo3pNrSjp7PbwbcMIi02XzwiCS//uf/+IWUTJ4mD/BcW2g0nM0k9o/U5gUeCPJGey8lovhDBRlgdYWCyAfcMrv5nI55ZSj6GFlohJjWUgyQkSmfXi/Y8fsAH5qAyLPjM++usaCbBcUWvMzMnJMaqdLHiNutHNtribEUgoCxvTyCC0dZTA2QTUTKiOHyusmuyr0bI581spIiyBkScTkO+NkIjPJO7hWzojMQSmUmLLPkXLgi1Co4rsho8d09LC6qL1zTa+XEJ2fIl8+DuAdHWZ44nytgU7IAnPvV9vUn2uCboRneWM6Q1Y0vMzQtjmbBV6jYVvkT6V1UUClnT8pktPVXVvqyBmhLG3o4UolLE0DX/B+eYxcLAZAN5C02dGhhwSgkOrKP6I7a8TsJxxb6bAN+s3n8zt28Xm/zV+lm9VjMFjptt2UC9mKdps3H8/J6KAp7fHkPZprmUUXZMOYe0y8F/ZL4eNL0QiJSv5ltQHtXYXMUFns7G5v/nryHVzDi8F+knZ2gkcwvPfd0dtvf3j/LfVLe5XXv+Fgf7DPNxXaulKozlArD1JXVbdzFbp9v7p9v7p9v7p9v7p9v/rHeWG5fb+6fb+6fb+6fb+6fb+6fb+6fb/6BKDYvl/dvl/dvl/dvl/dvl/dvl/dvl/dvl/dvl/dvl/dvl/dvl99Gs8Ft+9Xt+9Xn5RAbt+vxverIfeE/Ma9qhBSdfLnfMLS2eqr1os0mVFG0+FZcntLF4sfKEedin+p0VA61EWaXAsjKXrOyVBpTPqhbJcrpLSTt/4yYPeUxk+93PNd9koOGOUs+RZvePXvpe0mXZ0cvz9N0iQ+Kih1Tm2MmNOrXDFPDhMy2vyCt8kr5fLbpBBqWnMCTuL7pVwlUbtZP9HpihOdwo9OHo9Qiw6X/QwoPxX6nya2tsF/0d3333Hx3w25r9nYIGAbqWkJL5bL5f8BbrbQGQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Draft Document",permalink:"/docs/API-docs/draftdocument"},next:{title:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"}},j={},b=[{value:"Request",id:"request",level:2}];function g(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Create Document"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/createdocument"}),"\n",(0,i.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": { \n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "readonly": false,\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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. \n",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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'.",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"name or email of the person or organization on the behalf of which you are sending the mail.",example:"opensign\u2122"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-sign-document.com"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/377084eb.8bd89dab.js b/assets/js/377084eb.8bd89dab.js new file mode 100644 index 000000000..d4197f69d --- /dev/null +++ b/assets/js/377084eb.8bd89dab.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8106],{56181:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var l=s(85893),i=s(11151),t=s(58219),n=(s(62316),s(51039)),r=s.n(n),m=(s(82723),s(9487)),c=s(41429),o=s(5397),p=s(4667),d=s(9472),h=s(85162);const u={id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzVWOluHLkRfpVa/skaaM0hy/JmEAQrZA1H2MXaWCkwEHsgsLtrummxSS5ZPQeE/pcnyaPtkwTFPtSjkUcWEhjIH2marK8u1kXeCZJFEIuP4horpyVhEMtE5Bgyrxwpa8RCXJcIb5GgJ4GL95cgtbabADtbA1nwSF7hGiFHkkoHkKmtCSQEh5laqQyoA08GNgEC+jWCDJDqGp1XhgKsrIfMoyRlCshtVlfIyxtFJTiPOa6UwRwC+Tqj2mOYiERYh16ytpe5WIgCqZchEuGklxUSejbzThhZoViIXp0blYtEKDbTSSrFQ9svfwK7GpQHKiWBQcwDW50irJCyEpmHx99r5TEXC/I1JiLQTrOkoCqnWRHcOm1zFIuV1IEJshIrKRZ3gnYuUpJXphCJWFlfSWpXTCGaZsnsg7MmYGDA6WzG//ZVDXWWYQirWsPgD5GIzBpCQ0wvndMqixvTz4FBd4da2PQzZsSO88yGVCuyXWb/Hte3XcGtjFYvxHb+99RU4fR9IZpEkCJePWRxDwjxx+ByRhlLT4CGA4qkDaukc/Tfyqw2qI4p2OoDkbC5d8R9HHYKs+rqKReVRC4sptMeXAf0k8xWjLYbs2f3MWfFPLO9VokIqjAxTwa09F7uOEEIq/C0N719SvUM7dc57LNFSDGqhZVU+knqFPHHbqH3hSuteULM2avz0/nLH17PmX6j8gLpv7C/3T2Ut5+oF1w6MYe11DUGOAH2u+RilkAgWbnJE8E30LPS25FAU1cp+jF6WBnQp2dnTSJ2z0S9nrN/ngl6+UOTiPKZoLNzPjlZ4DNx80fT6qoN6Zv+aJtjVDEzA5r80rzz++UjtVajNGOBXOabRMQkwvyCjgfa6ez05cl8djJ7fT0/X5z9efHqfDKbzf4pErGtYnR3nSnvil6vZP9du/ybyEEjU43Xtv468z3mymNGN7V/NEePxTGLi3PETWVznhJiawrH5cbuyQe1b864Xzw8Xz71JhFnj3XNK1shlTxsbNAQbLw1RQJOowwI5HcgC6kMMBv/3f+unaL39oky/TzNxnGtjFYGb/qR4eZsNruZD044O3TC9ah9wsrWJv+2pj4m/7hBZzfng0GvDg26NGupVR4n1Wt7i+bb2jMWT634w4hVLVHcF3vGjtdbIwNmtVe0iyPs9kQ6ddLuLz4ueTrkSLHd7BtnXirFQgwDwvRuNO82gvn5dT8Rx8QdZoogTZ7a7cQ6NNxntEwD99OpdGq65jb5ECGdewZ1IFkoU5wcRS3vLb7iU2kdv2f3fYt26mfkHt25dUzVTfYlyjhbNfy9shHcOfudQ8PVPx7Ven7Qqz+gzmyFPO1TidCT//Gvf0dEf0GJkfQdvKs9OLtBz0O4NDmsNG5Vqh+7MgWUlcYQ9A6UISw8x3+uCkVSx4mAMz+TTqZKK449JrOM9jAK3zCBDyVSiZ63/uQRJOS4Rs0hC9raW+ZDFmRNtooyOp1hY/3tilVKQEJaB2Uw8KUMewiaUpoMoT+LBKwHaQANoXdeBQSpKibmWxuuVipTzJgTzcuMoJJGFsjCEmC92QvO27XKMYC3aR0IgtV1NIQlVojUmhgvWRP4Sa2xNZwX29sl5lDUzCKBzOYIXd6xGSaHFAOBY/Eqw8g0kPQEGtfoY+zFk1zVWoOzXBCU1HzJG58tMyIvTeD21SrUH83gPuct37eijFzuJvDJfDJctKEOyAGglbkNi0/mBD4OYfYB06AIl9/3+bDZbA7y4MU+5q2isk7Bo7P3uCIuxqwZw4ePFyIRhL4K71ZX6Ncq6y8OX5A5jcTTrkzKLJbJbvLmHPvxIYBLllYZmoCjonbx9v0vsIaXk5lIRpn/FQpPf7n825tfr94wX65Nbf7NJ7PJLM7yNlAlzUjU+EniYd7e3Rf7/4Pni66SEW5p6rRUsR1081Rbyj/ezzKJWIwfL5aJKG0gJrm7S2XAf3jdNLz8e42eG8YyEWvpFU91sd7nKvDvfHiI+KLnvv+te9N4AV//DvKoMX2tNlyo472Hx79E3OLuwWNMs+Q7Q1uwWduW4iLL0NEIe9DA97rg2zfXIhGypnK/UdzGRtH9YO6P6rXfQVoF+C83s0cBf+GI+hl3fx3I250vAjr7emr20bJpmv8ArOjEAw==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",source:"@site/docs/API-docs/get-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-template",permalink:"/docs/API-docs/get-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzVWOluHLkRfpVa/skaaM0hy/JmEAQrZA1H2MXaWCkwEHsgsLtrummxSS5ZPQeE/pcnyaPtkwTFPtSjkUcWEhjIH2marK8u1kXeCZJFEIuP4horpyVhEMtE5Bgyrxwpa8RCXJcIb5GgJ4GL95cgtbabADtbA1nwSF7hGiFHkkoHkKmtCSQEh5laqQyoA08GNgEC+jWCDJDqGp1XhgKsrIfMoyRlCshtVlfIyxtFJTiPOa6UwRwC+Tqj2mOYiERYh16ytpe5WIgCqZchEuGklxUSejbzThhZoViIXp0blYtEKDbTSSrFQ9svfwK7GpQHKiWBQcwDW50irJCyEpmHx99r5TEXC/I1JiLQTrOkoCqnWRHcOm1zFIuV1IEJshIrKRZ3gnYuUpJXphCJWFlfSWpXTCGaZsnsg7MmYGDA6WzG//ZVDXWWYQirWsPgD5GIzBpCQ0wvndMqixvTz4FBd4da2PQzZsSO88yGVCuyXWb/Hte3XcGtjFYvxHb+99RU4fR9IZpEkCJePWRxDwjxx+ByRhlLT4CGA4qkDaukc/Tfyqw2qI4p2OoDkbC5d8R9HHYKs+rqKReVRC4sptMeXAf0k8xWjLYbs2f3MWfFPLO9VokIqjAxTwa09F7uOEEIq/C0N719SvUM7dc57LNFSDGqhZVU+knqFPHHbqH3hSuteULM2avz0/nLH17PmX6j8gLpv7C/3T2Ut5+oF1w6MYe11DUGOAH2u+RilkAgWbnJE8E30LPS25FAU1cp+jF6WBnQp2dnTSJ2z0S9nrN/ngl6+UOTiPKZoLNzPjlZ4DNx80fT6qoN6Zv+aJtjVDEzA5r80rzz++UjtVajNGOBXOabRMQkwvyCjgfa6ez05cl8djJ7fT0/X5z9efHqfDKbzf4pErGtYnR3nSnvil6vZP9du/ybyEEjU43Xtv468z3mymNGN7V/NEePxTGLi3PETWVznhJiawrH5cbuyQe1b864Xzw8Xz71JhFnj3XNK1shlTxsbNAQbLw1RQJOowwI5HcgC6kMMBv/3f+unaL39oky/TzNxnGtjFYGb/qR4eZsNruZD044O3TC9ah9wsrWJv+2pj4m/7hBZzfng0GvDg26NGupVR4n1Wt7i+bb2jMWT634w4hVLVHcF3vGjtdbIwNmtVe0iyPs9kQ6ddLuLz4ueTrkSLHd7BtnXirFQgwDwvRuNO82gvn5dT8Rx8QdZoogTZ7a7cQ6NNxntEwD99OpdGq65jb5ECGdewZ1IFkoU5wcRS3vLb7iU2kdv2f3fYt26mfkHt25dUzVTfYlyjhbNfy9shHcOfudQ8PVPx7Ven7Qqz+gzmyFPO1TidCT//Gvf0dEf0GJkfQdvKs9OLtBz0O4NDmsNG5Vqh+7MgWUlcYQ9A6UISw8x3+uCkVSx4mAMz+TTqZKK449JrOM9jAK3zCBDyVSiZ63/uQRJOS4Rs0hC9raW+ZDFmRNtooyOp1hY/3tilVKQEJaB2Uw8KUMewiaUpoMoT+LBKwHaQANoXdeBQSpKibmWxuuVipTzJgTzcuMoJJGFsjCEmC92QvO27XKMYC3aR0IgtV1NIQlVojUmhgvWRP4Sa2xNZwX29sl5lDUzCKBzOYIXd6xGSaHFAOBY/Eqw8g0kPQEGtfoY+zFk1zVWoOzXBCU1HzJG58tMyIvTeD21SrUH83gPuct37eijFzuJvDJfDJctKEOyAGglbkNi0/mBD4OYfYB06AIl9/3+bDZbA7y4MU+5q2isk7Bo7P3uCIuxqwZw4ePFyIRhL4K71ZX6Ncq6y8OX5A5jcTTrkzKLJbJbvLmHPvxIYBLllYZmoCjonbx9v0vsIaXk5lIRpn/FQpPf7n825tfr94wX65Nbf7NJ7PJLM7yNlAlzUjU+EniYd7e3Rf7/4Pni66SEW5p6rRUsR1081Rbyj/ezzKJWIwfL5aJKG0gJrm7S2XAf3jdNLz8e42eG8YyEWvpFU91sd7nKvDvfHiI+KLnvv+te9N4AV//DvKoMX2tNlyo472Hx79E3OLuwWNMs+Q7Q1uwWduW4iLL0NEIe9DA97rg2zfXIhGypnK/UdzGRtH9YO6P6rXfQVoF+C83s0cBf+GI+hl3fx3I250vAjr7emr20bJpmv8ArOjEAw==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Template",permalink:"/docs/API-docs/createtemplate"},next:{title:"Update Template",permalink:"/docs/API-docs/update-template"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get Template"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"folder"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}})]})]})}),(0,l.jsx)(p.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(p.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,l.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"widgets"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(p.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)(p.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "x1Hbnms2Pg",\n "title": "sample template",\n "note": "template note",\n "folder": {\n "objectId": "x1Hbnms2Pg",\n "name": "folder name"\n },\n "file": "https://templateuser.com",\n "owner": "template creator name",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": true,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z",\n "enableTour": true,\n "redirect_url": "",\n "allow_modifications": false\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/377084eb.cdd769c8.js b/assets/js/377084eb.cdd769c8.js deleted file mode 100644 index c2931cb04..000000000 --- a/assets/js/377084eb.cdd769c8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8106],{56181:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var l=s(85893),i=s(11151),r=s(58219),n=(s(62316),s(51039)),t=s.n(n),m=(s(82723),s(9487)),c=s(41429),o=s(5397),p=s(4667),d=s(9472),h=s(85162);const x={id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzVWG1v3DYS/itTfrkGkPfF2Ti9RVHUuAY5o0UT1D4EqLMwKGlWYkyRLDnaFyz07X7J/bT+ksNQ0lrrdewYPQS4L/aKmofzzHDeqJ0gWQQxvxZXWDktCYNYJCLHkHnlSFkj5uKqRHiLBL0InL+/AKm1XQfY2hrIgkfyClcIOZJUOoBMbU0gITjM1FJlQB14tN8mQEC/QpABUl2j88pQgKX1kHmUpEwBuc3qCnl5ragE5zHHpTKYQyBfZ1R7DCORCOvQS2Z7kYu5KJB6HSIRTnpZIaFnM3fCyArFXPR0blQuEqHYTCepFPdtv/gJ7HJPHqiUBAYxD2x1irBEykrkPTz+USuPuZiTrzERgbaaNQVVOc1EcOO0zVHMl1IHFshKrKSY7wRtXZQkr0whErG0vpLUrphCNM2Ctw/OmoCBAaeTCf87pBrqLMMQlrWGvT9EIjJrCA2xvHROqyy+GH8KDNods7DpJ8yIHed5G1KtynaZ/fs433YFNzJaPReb6T9TU4XT94VoEkGKePV4iztAiD/2LmeUsfQEaH9AUbRhSjpH/7XMaoPqMYItH4iCzZ0j7uKwI8zU1VMuKolcmI/HPbgO6EeZrRht1+bA7secFfPM9qwSEVRhYp7s0dJ7ueUEIazC09709inqGdovc9gni5BipIWVVPpJ6RTxx26h94UrrXlCzezV2en05Xevpyy/VnmB9Bfsb98e6ztM1HMunZjDSuoaA5wA+11yMUsgkKzc6Ing28sz6c1AoamrFP0QvV/Zo09nsyYR22eiXk/ZP88EvfyuSUT5TNDsjE9OFvhM3PTBtLpsQ/qmP9rmMamYmQFNfmHe+cPykVqrUZqhQi7zTSJiEmF+To8H2unk9OXJdHIyeX01PZvP/j5/dTaaTCa/i0RsqhjdXWfKu6LXk+yfa5d/BT3NfbFhHb7vN/Zmk4jZQ93o0lZIJTfxNRqCtbemSMBplAGB/BZkIZUB3sZ/879rU+i9faL8PY/ZMF6U0crgTd+Kb2aTyc1074TZsROuBm0JlrY2+dc19SH9jxs0uznbG/Tq2KALs5Ja5XECvLK3aL6uPUP11Ko/jljVCsX34sDY4XprZMCs9oq2cTTcnEinTtr38+sFT10cKbabKeMsSaWYi33jHe8Gc2QjeD+/6ifN2utBrw7S5KndjKxDw/VbyzRwnxpLp8Yrbj/3EdK5Z0gHkoUyxcmjqMWdxZd8Kq3jD+y+a31O/Yzc+zq3DqW6iblEGWeWhp+XNoI7Z79zaLiqxqNaTY964AfUma2Qp2gqEXrxP//9n4joB/8YSd/Au9qDs2v0PNxKk8NS40al+qGrSEBZaQxBb0EZwsJz/OeqUCR17LSc+Zl0MlVaceyxmGW0h0H4hhF8KJFK9Pzqbx5BQo4r1ByyoK295X3IgqzJVlFHxxnW1t8umVICEtI6KIOBLzvYQ9CU0mQI/VkkYD1IA2gIvfMqIEhVsTDfhnC5VJnijTnRvMwIKmlkgawsAebNXnDerlSOAbxN60AQrK6jIayxQqTWxHh5GcFPaoWt4bzY3towh6LmLRLIbI7Q5R2bYXJIMRA4Vq8yjJsGkp5A4wp9jL14kstaa3CWC4KSmi9Pw7PljchLE7iRt4T6o9m7z3nL95ioI5fbEXw0Hw0XbagDcgBoZW7D/KM5get9mH3ANCjCxbd9PqzX66M8eHGIeauorFPw6OwdroiLMWuG8P3DC5EIQl+Fd8tL9CuV9QP5Z3SOo/C4K5Myi2Wym2g5x368D+CSpVWGJuCgqJ2/ff8LrODlaCKSQeZ/AeHxLxf/ePPr5Rvel2tTm3/T0WQ0iTOyDVRJM1A1vOrfz9vdXbH/P/gs0FUywg2NnZYqtoPovF1Xyq/vZplEzIcfBRaJKG0gFtntUhnwX143DS//UaPnhrFIxEp6JVMueNc7kavAv/P9Bf+znvv2t+5bwQv48u8LDxrT12rDhTreJ8RciETc4vbeR45mwbN4W7CZbStxnmXoaIA9auAHXfDtmyuRCFlTedgobmOj6H7w7g/yOuwgLQH+y83sQcD3HFE/4/aHvXj75rOAzr5emn20aJrmv+1biV8=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",source:"@site/docs/API-docs/get-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-template",permalink:"/docs/API-docs/get-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzVWG1v3DYS/itTfrkGkPfF2Ti9RVHUuAY5o0UT1D4EqLMwKGlWYkyRLDnaFyz07X7J/bT+ksNQ0lrrdewYPQS4L/aKmofzzHDeqJ0gWQQxvxZXWDktCYNYJCLHkHnlSFkj5uKqRHiLBL0InL+/AKm1XQfY2hrIgkfyClcIOZJUOoBMbU0gITjM1FJlQB14tN8mQEC/QpABUl2j88pQgKX1kHmUpEwBuc3qCnl5ragE5zHHpTKYQyBfZ1R7DCORCOvQS2Z7kYu5KJB6HSIRTnpZIaFnM3fCyArFXPR0blQuEqHYTCepFPdtv/gJ7HJPHqiUBAYxD2x1irBEykrkPTz+USuPuZiTrzERgbaaNQVVOc1EcOO0zVHMl1IHFshKrKSY7wRtXZQkr0whErG0vpLUrphCNM2Ctw/OmoCBAaeTCf87pBrqLMMQlrWGvT9EIjJrCA2xvHROqyy+GH8KDNods7DpJ8yIHed5G1KtynaZ/fs433YFNzJaPReb6T9TU4XT94VoEkGKePV4iztAiD/2LmeUsfQEaH9AUbRhSjpH/7XMaoPqMYItH4iCzZ0j7uKwI8zU1VMuKolcmI/HPbgO6EeZrRht1+bA7secFfPM9qwSEVRhYp7s0dJ7ueUEIazC09709inqGdovc9gni5BipIWVVPpJ6RTxx26h94UrrXlCzezV2en05Xevpyy/VnmB9Bfsb98e6ztM1HMunZjDSuoaA5wA+11yMUsgkKzc6Ing28sz6c1AoamrFP0QvV/Zo09nsyYR22eiXk/ZP88EvfyuSUT5TNDsjE9OFvhM3PTBtLpsQ/qmP9rmMamYmQFNfmHe+cPykVqrUZqhQi7zTSJiEmF+To8H2unk9OXJdHIyeX01PZvP/j5/dTaaTCa/i0RsqhjdXWfKu6LXk+yfa5d/BT3NfbFhHb7vN/Zmk4jZQ93o0lZIJTfxNRqCtbemSMBplAGB/BZkIZUB3sZ/879rU+i9faL8PY/ZMF6U0crgTd+Kb2aTyc1074TZsROuBm0JlrY2+dc19SH9jxs0uznbG/Tq2KALs5Ja5XECvLK3aL6uPUP11Ko/jljVCsX34sDY4XprZMCs9oq2cTTcnEinTtr38+sFT10cKbabKeMsSaWYi33jHe8Gc2QjeD+/6ifN2utBrw7S5KndjKxDw/VbyzRwnxpLp8Yrbj/3EdK5Z0gHkoUyxcmjqMWdxZd8Kq3jD+y+a31O/Yzc+zq3DqW6iblEGWeWhp+XNoI7Z79zaLiqxqNaTY964AfUma2Qp2gqEXrxP//9n4joB/8YSd/Au9qDs2v0PNxKk8NS40al+qGrSEBZaQxBb0EZwsJz/OeqUCR17LSc+Zl0MlVaceyxmGW0h0H4hhF8KJFK9Pzqbx5BQo4r1ByyoK295X3IgqzJVlFHxxnW1t8umVICEtI6KIOBLzvYQ9CU0mQI/VkkYD1IA2gIvfMqIEhVsTDfhnC5VJnijTnRvMwIKmlkgawsAebNXnDerlSOAbxN60AQrK6jIayxQqTWxHh5GcFPaoWt4bzY3towh6LmLRLIbI7Q5R2bYXJIMRA4Vq8yjJsGkp5A4wp9jL14kstaa3CWC4KSmi9Pw7PljchLE7iRt4T6o9m7z3nL95ioI5fbEXw0Hw0XbagDcgBoZW7D/KM5get9mH3ANCjCxbd9PqzX66M8eHGIeauorFPw6OwdroiLMWuG8P3DC5EIQl+Fd8tL9CuV9QP5Z3SOo/C4K5Myi2Wym2g5x368D+CSpVWGJuCgqJ2/ff8LrODlaCKSQeZ/AeHxLxf/ePPr5Rvel2tTm3/T0WQ0iTOyDVRJM1A1vOrfz9vdXbH/P/gs0FUywg2NnZYqtoPovF1Xyq/vZplEzIcfBRaJKG0gFtntUhnwX143DS//UaPnhrFIxEp6JVMueNc7kavAv/P9Bf+znvv2t+5bwQv48u8LDxrT12rDhTreJ8RciETc4vbeR45mwbN4W7CZbStxnmXoaIA9auAHXfDtmyuRCFlTedgobmOj6H7w7g/yOuwgLQH+y83sQcD3HFE/4/aHvXj75rOAzr5emn20aJrmv+1biV8=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Template",permalink:"/docs/API-docs/createtemplate"},next:{title:"Update Template",permalink:"/docs/API-docs/update-template"}},g={},f=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get Template"})}),"\n",(0,l.jsx)(t(),{method:"get",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(r.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"folder"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}})]})]})}),(0,l.jsx)(p.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(p.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,l.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"widgets"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(p.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)(p.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "x1Hbnms2Pg",\n "title": "sample template",\n "note": "template note",\n "folder": {\n "objectId": "x1Hbnms2Pg",\n "name": "folder name"\n },\n "file": "https://templateuser.com",\n "owner": "template creator name",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": true,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a2de241.4d9dbd85.js b/assets/js/5a2de241.4d9dbd85.js new file mode 100644 index 000000000..b3d908f23 --- /dev/null +++ b/assets/js/5a2de241.4d9dbd85.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8163],{85763:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>f,toc:()=>g});var l=s(85893),i=s(11151),t=s(58219),n=(s(62316),s(51039)),d=s.n(n),r=(s(82723),s(9487)),m=s(41429),o=s(5397),p=s(4667),c=s(9472),h=s(85162);const x={id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFWG1vIzcO/iusvtwWGL8km7Y441DcXrtogxaNsfFigdsEgTzieNRoJFXU2DEMf+sv6U+7X3KgZsYev2y62+vdfQkcDUmRDynykTYiygWJyXsxw8obGZHEfSYUUh60j9pZMRGzEuGtVzIidFLwanoNaOXcIMHa1RAdVE7pYg3SKqgb6VgiKIxSGwJXgATymOtC5xBbO0ORCecxSN7qWomJaFS7fUQmvAyywoiB3dwIKysUE9EZeNBKZEKzm17GUhz7fv0t78yOdBoQSxnBIipir+fYest2Av5S64BKTGKoMRMU14Z3I115w87gkzdOoZgU0hAL5CVWUkw2Iq59koxB24XIROFCJeN+Zbu9b+wjxX84tWadQ1enwS21QpijcSvYhc1Odnh2OYIXMoJBSRGcxZ5sF8DnIhO5sxFt5I2k90bnCeTRz8S7bU5dd/OfMY+MeOCURI3EXxvAfz9ABkcmmCaC0o+dv2KbCeviJ5uZcogIAZcaV6mwSC8sxFITKJfXFYe3PUr5p22xq4q+jS3rGIWBK/LU3l6bJZtTcDOb9kTnzhmU9qQauapg0ATg0iKstDHtSYKb2RSWGPiEpFwN4S1hoEYmYI56iSAPRCB3CmGpJWAltclgVeq85IJfQ1VTBLRtDbXQ4Q65IaQihgGcOqQ0nfUoA2mMW2m7gDq5ds4wKB0wj2YNKx1LV0eQSmlWlwYooqdhH8XkxQ7ImavDf46khEWtFSqIrg5QuJC8xEAZ+HTMOAJtKYY6Z2UCVXN2Uxwsyr99cDkS7XHqUGGhnv0M0FKjLqGQFDFkUFvNyIfaR1Q7k/jkMWi0OZ6FIIH7kBppCzh9PBZTDJWO1EXKqZFKARrkpBBQnZcgm+8y1gEpA2111NJQBhRl5SkDFyDiE/cViM5z88QnTZGdX2m1wEigP1RHb5DPSN7zoQiuStlnbOy6Xwg7v6I7MjfjpGpqx0chaxNhKU19DrNtJqKOB0f5oTcbHubcardblgtI3llqutrleHzagXfTrZ0IDBlXQFEbs/7sz2upzfLvNRdJ6vJ7ml5977nNtC69is8rXY4vXw4uxoPxV7OLLydXf5188eVwPB7/U2TiqTL7fi5U25c79Jr/ewvaGm3xoUPt4XI8fnjZQnl1Dr22W/t2jC2l0QoKjUYB70l/IoAYggt/cJo8499z4XPIXfBXz5SOdREKV1v1/w73nEfPB3j18NUuxC9OQ7y2DWRM/WbuEe3/IsJ9PP3tY7M9u3pY1boRSt/FQbD99SZIwrwOOq4TrXwaSK8HzffJ+3smaxXG0jEl9XVymOnlRIy67jLa9PrMVrC9sOxYah2MmIgyRk+T0YikVXP3NHQeLXdGI+c0zF01kl6Plhdimx1rSO8/QZqiXGi7GDyrdb+P+Jaz0gB/EPcOfun1D7gWWQdrX6pl2yVKhSGlgJP9Zs9sX3cp22XlmA52bPDjCN7JuDtH2fqMTYgDVtZS9T69aJfOjttuFmtbuARJW0I3Hu0te8cFuLw4cesdmtxV2I2zTvxfv/6WNLpw0jafwU0dwLsVhqI2KfDC4JNmcsHCybHdxYpQVgaJzBqYUyxCCl4vdGQ+1TKLXHo510bziWIxx9oBeoeShvCuxFhi4E9/CcySFC7R8EEE49xjIkAOZB1dlfboCN3KhceCXcpAwrwmbZEICLFTQVtKmyN0FZZ4hLQN+/RBE4LUFQszF8Oi0Llmw9w+gswjVNLKRSIEGbDfjELbqQmCmzOVJWfqhqzxbRMxNiGmq9wQvmVynALnxebaiarhaZQ1PLntJhyGVTBHiuB5e51jQ2WjDHyxWmJIJyplkqc/eMdtTkvDjKifWzYUg7TEvbhxqEvNDr6WSKY9lFwP4c7e2VsulpqQC8Bo+0iTOzuA97sye4dz0hHvX3SnfLVanZzuzw91vtOxrOcQ0Lu93iItpl7QV9/9w3fFiKGim+IWw1Ln2LaWD+w5SsKjtvnLPDX/dPtoOsffjxW4ERudo6V+U3j13fRHWMLL4VhkvX72EQ6Pfrz+5vVPt6/ZLnfc5vxdDMfDMS95R7GStrfV0ePF8dHd7KfYf/uto+2vzLBH3kidhlQKftMOmPei1yYn/WeO+0yUjiKLbDZzSfg2mO2Wl3+pMfAYu8/EUgbNnqYp1N5X1K7hfTDsF2+6hwP4tBeTswF1U8TyCEnMvWnKj7g+errZ3m+zbpSwx43EN41fgxnb2Vs4IRg8CRuNV3mOPj4r25/o07czkYl5+wxTpRcdEeSKn4DkSkzEnbgT6WlqdwdL6xthpF3UcsHyjVkegLLmzPWn52Oanu0PDuwsJIdjtYmE/3JcZxX+xqX4A66/3ok3Xz6o0ELbSXN67rfb7b8BnPMChA==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,f={id:"API-docs/update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",source:"@site/docs/API-docs/update-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-template",permalink:"/docs/API-docs/update-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFWG1vIzcO/iusvtwWGL8km7Y441DcXrtogxaNsfFigdsEgTzieNRoJFXU2DEMf+sv6U+7X3KgZsYev2y62+vdfQkcDUmRDynykTYiygWJyXsxw8obGZHEfSYUUh60j9pZMRGzEuGtVzIidFLwanoNaOXcIMHa1RAdVE7pYg3SKqgb6VgiKIxSGwJXgATymOtC5xBbO0ORCecxSN7qWomJaFS7fUQmvAyywoiB3dwIKysUE9EZeNBKZEKzm17GUhz7fv0t78yOdBoQSxnBIipir+fYest2Av5S64BKTGKoMRMU14Z3I115w87gkzdOoZgU0hAL5CVWUkw2Iq59koxB24XIROFCJeN+Zbu9b+wjxX84tWadQ1enwS21QpijcSvYhc1Odnh2OYIXMoJBSRGcxZ5sF8DnIhO5sxFt5I2k90bnCeTRz8S7bU5dd/OfMY+MeOCURI3EXxvAfz9ABkcmmCaC0o+dv2KbCeviJ5uZcogIAZcaV6mwSC8sxFITKJfXFYe3PUr5p22xq4q+jS3rGIWBK/LU3l6bJZtTcDOb9kTnzhmU9qQauapg0ATg0iKstDHtSYKb2RSWGPiEpFwN4S1hoEYmYI56iSAPRCB3CmGpJWAltclgVeq85IJfQ1VTBLRtDbXQ4Q65IaQihgGcOqQ0nfUoA2mMW2m7gDq5ds4wKB0wj2YNKx1LV0eQSmlWlwYooqdhH8XkxQ7ImavDf46khEWtFSqIrg5QuJC8xEAZ+HTMOAJtKYY6Z2UCVXN2Uxwsyr99cDkS7XHqUGGhnv0M0FKjLqGQFDFkUFvNyIfaR1Q7k/jkMWi0OZ6FIIH7kBppCzh9PBZTDJWO1EXKqZFKARrkpBBQnZcgm+8y1gEpA2111NJQBhRl5SkDFyDiE/cViM5z88QnTZGdX2m1wEigP1RHb5DPSN7zoQiuStlnbOy6Xwg7v6I7MjfjpGpqx0chaxNhKU19DrNtJqKOB0f5oTcbHubcardblgtI3llqutrleHzagXfTrZ0IDBlXQFEbs/7sz2upzfLvNRdJ6vJ7ml5977nNtC69is8rXY4vXw4uxoPxV7OLLydXf5188eVwPB7/U2TiqTL7fi5U25c79Jr/ewvaGm3xoUPt4XI8fnjZQnl1Dr22W/t2jC2l0QoKjUYB70l/IoAYggt/cJo8499z4XPIXfBXz5SOdREKV1v1/w73nEfPB3j18NUuxC9OQ7y2DWRM/WbuEe3/IsJ9PP3tY7M9u3pY1boRSt/FQbD99SZIwrwOOq4TrXwaSK8HzffJ+3smaxXG0jEl9XVymOnlRIy67jLa9PrMVrC9sOxYah2MmIgyRk+T0YikVXP3NHQeLXdGI+c0zF01kl6Plhdimx1rSO8/QZqiXGi7GDyrdb+P+Jaz0gB/EPcOfun1D7gWWQdrX6pl2yVKhSGlgJP9Zs9sX3cp22XlmA52bPDjCN7JuDtH2fqMTYgDVtZS9T69aJfOjttuFmtbuARJW0I3Hu0te8cFuLw4cesdmtxV2I2zTvxfv/6WNLpw0jafwU0dwLsVhqI2KfDC4JNmcsHCybHdxYpQVgaJzBqYUyxCCl4vdGQ+1TKLXHo510bziWIxx9oBeoeShvCuxFhi4E9/CcySFC7R8EEE49xjIkAOZB1dlfboCN3KhceCXcpAwrwmbZEICLFTQVtKmyN0FZZ4hLQN+/RBE4LUFQszF8Oi0Llmw9w+gswjVNLKRSIEGbDfjELbqQmCmzOVJWfqhqzxbRMxNiGmq9wQvmVynALnxebaiarhaZQ1PLntJhyGVTBHiuB5e51jQ2WjDHyxWmJIJyplkqc/eMdtTkvDjKifWzYUg7TEvbhxqEvNDr6WSKY9lFwP4c7e2VsulpqQC8Bo+0iTOzuA97sye4dz0hHvX3SnfLVanZzuzw91vtOxrOcQ0Lu93iItpl7QV9/9w3fFiKGim+IWw1Ln2LaWD+w5SsKjtvnLPDX/dPtoOsffjxW4ERudo6V+U3j13fRHWMLL4VhkvX72EQ6Pfrz+5vVPt6/ZLnfc5vxdDMfDMS95R7GStrfV0ePF8dHd7KfYf/uto+2vzLBH3kidhlQKftMOmPei1yYn/WeO+0yUjiKLbDZzSfg2mO2Wl3+pMfAYu8/EUgbNnqYp1N5X1K7hfTDsF2+6hwP4tBeTswF1U8TyCEnMvWnKj7g+errZ3m+zbpSwx43EN41fgxnb2Vs4IRg8CRuNV3mOPj4r25/o07czkYl5+wxTpRcdEeSKn4DkSkzEnbgT6WlqdwdL6xthpF3UcsHyjVkegLLmzPWn52Oanu0PDuwsJIdjtYmE/3JcZxX+xqX4A66/3ok3Xz6o0ELbSXN67rfb7b8BnPMChA==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Template",permalink:"/docs/API-docs/get-template"},next:{title:"Delete Template",permalink:"/docs/API-docs/delete-template"}},j={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update Template"})}),"\n",(0,l.jsx)(d(),{method:"put",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(m.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a2de241.a62323e7.js b/assets/js/5a2de241.a62323e7.js deleted file mode 100644 index 6dec7f928..000000000 --- a/assets/js/5a2de241.a62323e7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8163],{85763:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var l=s(85893),i=s(11151),t=s(58219),n=(s(62316),s(51039)),r=s.n(n),d=(s(82723),s(9487)),o=s(41429),p=s(5397),m=s(4667),c=s(9472),h=s(85162);const u={id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFWOuO4zQUfpWD/7BI6WVmBxARQiywghGIGTFdrcRONXLjk8aMYxvbaaeq8o8n4dF4EnTspE2n3YHl+qdKnXP7zt3ZssCXnuVv2Axrq3hAz+YZE+gLJ22QRrOczSqEV1bwgNBTwYvrS0DNFwo9bEwDwUBthCw3wLWAJlGHCkFg4FJ5MCVw8BYLWcoCQidnzDJmLDpOqi4Fy1li7fWwjFnueI0BHZm5ZZrXyHLWC7iTgmVMkpmWh4o9tv3yK9JMhvQcECoeQCMKT1YvsLOW5Dj8uZEOBcuDazBjPmwUafOytoqMwQerjECWl1x5IigqrDnLtyxsbKQMTuoly1hpXM3D/qRt50k++vCFERviOTT12pmVFAgLVGYNO9hkZO/PPkbwjAdQyH0Ao3FA2wP4gGWsMDqgDqSIW6tkEZ08+cmTtu2x6WbxExaBPO4oJEGip7fJ4X8MkJzDo5ty5uPDzl7WZkyb8M5irgkigsOVxHVMLC+XGkIlPQhTNDXBax+F/N1U7LJiKKMlHiXQUUYey9tzE2WqgqvZ9YB0YYxCro+ykbIKRgmAiYewlkp1lQRXs2tYoaMKibEawyuPzicahwXKFQI/IIHCCISV5IA1lyqDdSWLihJ+A3XjA6DucqhzHe48N4aYxDCCY4OE9CctyoArZdZSL6GJpp0SDEI6LILawFqGyjQBuBCS2LkCH9D68dCL0YqdI2emcX/fkxyWjRQoIJjGQWlctBKdz8DGMiMEUvvgmoKYPYiGohtxECk9W2cK9H7vp94rRDSQnwFqn9g5lNwHdBk0WpLnXWMDip1IfLDoJOoCT7igzViQ4SAt7wZ97m5BbaNtic6ht0b7VKHn0+lxN9l16q67gW8KQlM2Sm3e++faQzr+o0LhXpx/468vvrFUMp1JL8LTTOfT8+ejs+lo+vHs7KP84pP8w4/G0+n0R5axh1rtexMTXY/pvZf+Dw6kVlLjXe+1u/Pp9O5558qLU97rOo/tWvKKKymglKgEkE7/DzoQnTPuL3bGJ+x7Cj5B7sFfPJE62gQoTaPF/w33lEVPA7y4+3gH8cNjiJc6uYzWmJm5R/1fINzjGaoPST2ZepjVMhHF9+wA7PA8gfRYNE6GTVyRHkbcylF6n7+Z0+JRY6gMrVe2iQbTqpSzSd9dJttBn2kZyXOrfuNqnGI5q0KwPp9MPNdiYR7GxqKmrqb4wo8LU0+4lZPVGWuzxxzc2neg9oEvpV6OnuSa7xHfUFSS4w9w79zPrfwWNyzr3Tqk6jbHCrlAF0NAwf5hv6W97EO2i8rj1abfbP7csnI0xk6tH8Ptg7GDDaNbO4ejsh+fUpcmwu7S5MqiviELKMlWZ0eqX6MqTI00wWme9eS//fJr5OhNjjXwHlw1DqxZoysbFcGVCh8kDUMijkvB7iLgkdcKvVcboBm4dBGgXMpA87+bhAW3fCGVpKohMkPcDgaF58fwusJQoaNX7zua6gJXqKjYQBlzHwe2Ad4EU0cd/QKyNu6+JJMy4LBovNToPXjEngV1xXWB0GdRBsYB12lbsk56BC5rIqbdActSFpIEU4twvAhQc82XSMoyILvJC1039uDMglYvb1STlgu6HSGGBDFePcbwFS1zETgdpmsSirRX+CztdV3HIBhawAJ9AEvqZYFp9Qrc0UVghS5WTYwkTXiwhlqZ5IquP8PYkqDguPbUb5NBfWh27usWn6hD8M0YbvWtvqFkaTxSAiip731+q0fwZpdmr3HhZcD5s76S1+v1UQV/cMjztQxVswCH1uz5lvEw1vuQffeH7jYBXe2vyht0K1lg1z7eonMSiSddg+dFbPBxW07d4fPHDNRslSxQ+2Hhv/j6+jtYwfPxlGWDnvUnDJ58d/nly+9vXpJc6qqp/s7G0/GUjqzxoeZ6oOrRZftx6W73k+rfvpt3PTTgQ5hYxWUcRBH8thsib9igFebDa/k8Y5XxgUi22wX3+MqptqXjnxt0NKrmGVtxJ8nSOGm6/Vrs+txbYT/7ob/owrvd8E8C6ieFpjGx4qrB1HjvcfPoU0M7b7N+XJDFieLLZNdoRnL2Eo6WCJp2ieNFUaANT9IOp/b1qxnL2KL7bFDHLxDM8TV9suBrlrNbdsvip5TYb4gonm+Z4nrZ8CXRJ7E05HhDkRtOyPs4IbsHAnbSJYejMyGhX8J1kuFTSsVvcfPZjjy9eStD59qemsIzb9v2d/SZiGg=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",source:"@site/docs/API-docs/update-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-template",permalink:"/docs/API-docs/update-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFWOuO4zQUfpWD/7BI6WVmBxARQiywghGIGTFdrcRONXLjk8aMYxvbaaeq8o8n4dF4EnTspE2n3YHl+qdKnXP7zt3ZssCXnuVv2Axrq3hAz+YZE+gLJ22QRrOczSqEV1bwgNBTwYvrS0DNFwo9bEwDwUBthCw3wLWAJlGHCkFg4FJ5MCVw8BYLWcoCQidnzDJmLDpOqi4Fy1li7fWwjFnueI0BHZm5ZZrXyHLWC7iTgmVMkpmWh4o9tv3yK9JMhvQcECoeQCMKT1YvsLOW5Dj8uZEOBcuDazBjPmwUafOytoqMwQerjECWl1x5IigqrDnLtyxsbKQMTuoly1hpXM3D/qRt50k++vCFERviOTT12pmVFAgLVGYNO9hkZO/PPkbwjAdQyH0Ao3FA2wP4gGWsMDqgDqSIW6tkEZ08+cmTtu2x6WbxExaBPO4oJEGip7fJ4X8MkJzDo5ty5uPDzl7WZkyb8M5irgkigsOVxHVMLC+XGkIlPQhTNDXBax+F/N1U7LJiKKMlHiXQUUYey9tzE2WqgqvZ9YB0YYxCro+ykbIKRgmAiYewlkp1lQRXs2tYoaMKibEawyuPzicahwXKFQI/IIHCCISV5IA1lyqDdSWLihJ+A3XjA6DucqhzHe48N4aYxDCCY4OE9CctyoArZdZSL6GJpp0SDEI6LILawFqGyjQBuBCS2LkCH9D68dCL0YqdI2emcX/fkxyWjRQoIJjGQWlctBKdz8DGMiMEUvvgmoKYPYiGohtxECk9W2cK9H7vp94rRDSQnwFqn9g5lNwHdBk0WpLnXWMDip1IfLDoJOoCT7igzViQ4SAt7wZ97m5BbaNtic6ht0b7VKHn0+lxN9l16q67gW8KQlM2Sm3e++faQzr+o0LhXpx/468vvrFUMp1JL8LTTOfT8+ejs+lo+vHs7KP84pP8w4/G0+n0R5axh1rtexMTXY/pvZf+Dw6kVlLjXe+1u/Pp9O5558qLU97rOo/tWvKKKymglKgEkE7/DzoQnTPuL3bGJ+x7Cj5B7sFfPJE62gQoTaPF/w33lEVPA7y4+3gH8cNjiJc6uYzWmJm5R/1fINzjGaoPST2ZepjVMhHF9+wA7PA8gfRYNE6GTVyRHkbcylF6n7+Z0+JRY6gMrVe2iQbTqpSzSd9dJttBn2kZyXOrfuNqnGI5q0KwPp9MPNdiYR7GxqKmrqb4wo8LU0+4lZPVGWuzxxzc2neg9oEvpV6OnuSa7xHfUFSS4w9w79zPrfwWNyzr3Tqk6jbHCrlAF0NAwf5hv6W97EO2i8rj1abfbP7csnI0xk6tH8Ptg7GDDaNbO4ejsh+fUpcmwu7S5MqiviELKMlWZ0eqX6MqTI00wWme9eS//fJr5OhNjjXwHlw1DqxZoysbFcGVCh8kDUMijkvB7iLgkdcKvVcboBm4dBGgXMpA87+bhAW3fCGVpKohMkPcDgaF58fwusJQoaNX7zua6gJXqKjYQBlzHwe2Ad4EU0cd/QKyNu6+JJMy4LBovNToPXjEngV1xXWB0GdRBsYB12lbsk56BC5rIqbdActSFpIEU4twvAhQc82XSMoyILvJC1039uDMglYvb1STlgu6HSGGBDFePcbwFS1zETgdpmsSirRX+CztdV3HIBhawAJ9AEvqZYFp9Qrc0UVghS5WTYwkTXiwhlqZ5IquP8PYkqDguPbUb5NBfWh27usWn6hD8M0YbvWtvqFkaTxSAiip731+q0fwZpdmr3HhZcD5s76S1+v1UQV/cMjztQxVswCH1uz5lvEw1vuQffeH7jYBXe2vyht0K1lg1z7eonMSiSddg+dFbPBxW07d4fPHDNRslSxQ+2Hhv/j6+jtYwfPxlGWDnvUnDJ58d/nly+9vXpJc6qqp/s7G0/GUjqzxoeZ6oOrRZftx6W73k+rfvpt3PTTgQ5hYxWUcRBH8thsib9igFebDa/k8Y5XxgUi22wX3+MqptqXjnxt0NKrmGVtxJ8nSOGm6/Vrs+txbYT/7ob/owrvd8E8C6ieFpjGx4qrB1HjvcfPoU0M7b7N+XJDFieLLZNdoRnL2Eo6WCJp2ieNFUaANT9IOp/b1qxnL2KL7bFDHLxDM8TV9suBrlrNbdsvip5TYb4gonm+Z4nrZ8CXRJ7E05HhDkRtOyPs4IbsHAnbSJYejMyGhX8J1kuFTSsVvcfPZjjy9eStD59qemsIzb9v2d/SZiGg=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Template",permalink:"/docs/API-docs/get-template"},next:{title:"Delete Template",permalink:"/docs/API-docs/delete-template"}},g={},f=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update Template"})}),"\n",(0,l.jsx)(r(),{method:"put",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/770b40a9.523b2d80.js b/assets/js/770b40a9.523b2d80.js new file mode 100644 index 000000000..bdf8e89b8 --- /dev/null +++ b/assets/js/770b40a9.523b2d80.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1520],{9104:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var i=s(85893),l=s(11151),t=s(58219),n=(s(62316),s(51039)),r=s.n(n),m=(s(82723),s(9487)),o=s(41429),c=s(5397),p=s(4667),d=s(9472),h=s(85162);const x={id:"gettemplatelist",title:"Get Template list",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.",sidebar_label:"Get Template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdV1tv2zYU/iunfNkKKLacWztjGBpsRRa0WAokQ4GlRkBJxxYbimRJyhcYetsv2U/bLxkOdbEcN3GzFX3YS2KR5zv3G9fM85lj4xt2jYWR3KNjk4hl6FIrjBdasTG7zhHO0UNLAm+F83D27gK4lHrhYKVL8BoseitwjsBBEoWeAp9zIXkiEXzLfwDXuXAwLVVK/LkUfgXG6rnI0AFXoOdo5wIXAS/lBhkBKp5IoWZQOrSOZKa51g5hanUBuBTO022HgEWOClKLPJxnOi0LVN4NWMS0QctJg4uMjdkMfYsi3VnEDLe8QI+W3LNmihfIxkyKQtCtIMd8KtGuWMQsfiqFxYyNp1w6jJjzK0nUU20LFjFcGqkzZGNvS7pNcyw4G69ZwZeiKAs2PonjiPmVIZAqiwQtqwjHC0OMRnEVdSq4O2G+mgYPy4yrCfF1RiuHjmgP45j+bSeHK9MUnZuWEjqPsoilWnlUnui5MVKk4WL40RFovauATj5iGtxuiY0XtUiLrpS+R8et5WSw8Fi4/fj6mCLcUTpvhZqxKLiG+/5JZztbjn5NVOEO383IJ154Ot1lsQG48KPLPEIp7feAWmoIpBWpJDO038qsOp8eU7DWBwJhtXFEp/htozCpLva5KPfeuPFw2IKphgepLgitF2rL7secFcpZt1pFzImZClX6b5PE6n2qp6i/zGEfNUKCQS0suJB7qRPEV81B6wuTa7VHzPHJ6eHo6OWLEdEvRDZD/x/sr2935W0X+hn1esxgzmWJDg6A/M59aTEC53lhBnuSr6MnpZe7zaeH7k469OHxcRWx1RNRL0bknyeCjl5WEcufCDo+pcjxGT4RN/psWV3VKX3bhrZ6jCpUpkOVXahLu90+Eq0lctUXSAOgilgoIszO/OOJdhgfHh2M4oP4xfXodHz8w/jkdBDH8R8sYssiZHczlLKm6bVKtt+lyb6JnLAZ4LUuv8x8i5mwmPrb0n62Rh/LYxIXFp/bQmdi2ow297jcMJYpUNvm9OfF/fhuR10oKRTetgP59jCOb0+JpIrYcXyyO5gv1JxLkYU97VrfoXr29cYyWqv3tOu+eF+L3zVf1EThnm0Z2z+vjXSYllb4VdjGlgfciIP6fnwzoVWlQJ/rZpUL65vP2ZgN7211Du28XelC7Lux5LjKEr0caIOKWpXkiaOWPORGDOfUae8juDFPoHaez4SaHTyKmmzsvKJY1O7esnbT5Y14g9TmG2f2qZr1MEcexnNF31MdwI2LLw0qaiAhQPPRTrt/jzLVBdKO7XOElvzvP/8KiHaVDvnzDC5LC0Yv0NIeyFUGU4lLQXv/7jPBIS8kOidXIJTHmaWhnomZ8FyGoUKresoNT4QUlHFEpgltoZe0bgDvc/Q5Wrr6ztKzI8M5SkpUkFrfhaeABl56XQQZjc6w0PZuSipFwCEpnVDoHDjEFoIq5ypFaGMRgbb0NEHl0RorHAIXBRFPtQWcTkUqiDGVl+Wph4IrPkMSFgHpTV7o3jhWJ6Xz4LQsgyEksUD0tYkKMXMD+EXMsTacDjP0XEjMYFYSiwhSnSE01UZmqAwSdB4MiRcpBqbOc+tB4hxtyL0QyWkpJRhNbUBwSY+sfmyJkbdcOeqAtUJtaDr3Gatp5Q8yMr4awAf1QV1RspQOKQGkUHdu/EEdwE2XZu8xccLj5Pu2HhaLxU4dPN/GnAuflwlYNHqDm4XDUDV9ePfxnEXMoy3c5fSKHpJpu3s+IHMYiIdNc+RpaI7N8kY19uo+gBqVFCkqh71Wdnb+7i3M4WgQs6hX+V+g8PDtxc+vf7t6TXypN9X1NxrEgzisg9r5gqueqK23eNPXtop3venz/9PHe9MCPS790EguwvRoZnnd+W/YVuefRCzXztP5ep1wh79bWVV0XD+haR5kwpG1m0f0Ha56T/6w+Nbz/0Ha5m2+IZ3QhxVEGwZV1PZkElhjztIUTV/AzmTeGm/nr69ZxHjp8+1ZcBdmQfODuLdXatXjvT0kagXoL9n0WcCPlCpvcPVTR17fPAho7GupKTSTqqr+AS2+XFw=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/gettemplatelist",title:"Get Template list",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.",source:"@site/docs/API-docs/gettemplatelist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/gettemplatelist",permalink:"/docs/API-docs/gettemplatelist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"gettemplatelist",title:"Get Template list",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.",sidebar_label:"Get Template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdV1tv2zYU/iunfNkKKLacWztjGBpsRRa0WAokQ4GlRkBJxxYbimRJyhcYetsv2U/bLxkOdbEcN3GzFX3YS2KR5zv3G9fM85lj4xt2jYWR3KNjk4hl6FIrjBdasTG7zhHO0UNLAm+F83D27gK4lHrhYKVL8BoseitwjsBBEoWeAp9zIXkiEXzLfwDXuXAwLVVK/LkUfgXG6rnI0AFXoOdo5wIXAS/lBhkBKp5IoWZQOrSOZKa51g5hanUBuBTO022HgEWOClKLPJxnOi0LVN4NWMS0QctJg4uMjdkMfYsi3VnEDLe8QI+W3LNmihfIxkyKQtCtIMd8KtGuWMQsfiqFxYyNp1w6jJjzK0nUU20LFjFcGqkzZGNvS7pNcyw4G69ZwZeiKAs2PonjiPmVIZAqiwQtqwjHC0OMRnEVdSq4O2G+mgYPy4yrCfF1RiuHjmgP45j+bSeHK9MUnZuWEjqPsoilWnlUnui5MVKk4WL40RFovauATj5iGtxuiY0XtUiLrpS+R8et5WSw8Fi4/fj6mCLcUTpvhZqxKLiG+/5JZztbjn5NVOEO383IJ154Ot1lsQG48KPLPEIp7feAWmoIpBWpJDO038qsOp8eU7DWBwJhtXFEp/htozCpLva5KPfeuPFw2IKphgepLgitF2rL7secFcpZt1pFzImZClX6b5PE6n2qp6i/zGEfNUKCQS0suJB7qRPEV81B6wuTa7VHzPHJ6eHo6OWLEdEvRDZD/x/sr2935W0X+hn1esxgzmWJDg6A/M59aTEC53lhBnuSr6MnpZe7zaeH7k469OHxcRWx1RNRL0bknyeCjl5WEcufCDo+pcjxGT4RN/psWV3VKX3bhrZ6jCpUpkOVXahLu90+Eq0lctUXSAOgilgoIszO/OOJdhgfHh2M4oP4xfXodHz8w/jkdBDH8R8sYssiZHczlLKm6bVKtt+lyb6JnLAZ4LUuv8x8i5mwmPrb0n62Rh/LYxIXFp/bQmdi2ow297jcMJYpUNvm9OfF/fhuR10oKRTetgP59jCOb0+JpIrYcXyyO5gv1JxLkYU97VrfoXr29cYyWqv3tOu+eF+L3zVf1EThnm0Z2z+vjXSYllb4VdjGlgfciIP6fnwzoVWlQJ/rZpUL65vP2ZgN7211Du28XelC7Lux5LjKEr0caIOKWpXkiaOWPORGDOfUae8juDFPoHaez4SaHTyKmmzsvKJY1O7esnbT5Y14g9TmG2f2qZr1MEcexnNF31MdwI2LLw0qaiAhQPPRTrt/jzLVBdKO7XOElvzvP/8KiHaVDvnzDC5LC0Yv0NIeyFUGU4lLQXv/7jPBIS8kOidXIJTHmaWhnomZ8FyGoUKresoNT4QUlHFEpgltoZe0bgDvc/Q5Wrr6ztKzI8M5SkpUkFrfhaeABl56XQQZjc6w0PZuSipFwCEpnVDoHDjEFoIq5ypFaGMRgbb0NEHl0RorHAIXBRFPtQWcTkUqiDGVl+Wph4IrPkMSFgHpTV7o3jhWJ6Xz4LQsgyEksUD0tYkKMXMD+EXMsTacDjP0XEjMYFYSiwhSnSE01UZmqAwSdB4MiRcpBqbOc+tB4hxtyL0QyWkpJRhNbUBwSY+sfmyJkbdcOeqAtUJtaDr3Gatp5Q8yMr4awAf1QV1RspQOKQGkUHdu/EEdwE2XZu8xccLj5Pu2HhaLxU4dPN/GnAuflwlYNHqDm4XDUDV9ePfxnEXMoy3c5fSKHpJpu3s+IHMYiIdNc+RpaI7N8kY19uo+gBqVFCkqh71Wdnb+7i3M4WgQs6hX+V+g8PDtxc+vf7t6TXypN9X1NxrEgzisg9r5gqueqK23eNPXtop3venz/9PHe9MCPS790EguwvRoZnnd+W/YVuefRCzXztP5ep1wh79bWVV0XD+haR5kwpG1m0f0Ha56T/6w+Nbz/0Ha5m2+IZ3QhxVEGwZV1PZkElhjztIUTV/AzmTeGm/nr69ZxHjp8+1ZcBdmQfODuLdXatXjvT0kagXoL9n0WcCPlCpvcPVTR17fPAho7GupKTSTqqr+AS2+XFw=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Template",permalink:"/docs/API-docs/delete-template"},next:{title:"Get Webhook",permalink:"/docs/API-docs/get-webhook"}},g={},f=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(a.p,{children:"Get Template list"})}),"\n",(0,i.jsx)(r(),{method:"get",path:"/templatelist"}),"\n",(0,i.jsx)(a.p,{children:"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."}),"\n",(0,i.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(a.p,{children:"Query Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsxs)("ul",{children:[(0,i.jsx)(o.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,i.jsx)(o.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"result"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"template[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(a.p,{children:"Array ["})})}),(0,i.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,i.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"folder"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}})]})]})}),(0,i.jsx)(p.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,i.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(a.p,{children:"Array ["})})}),(0,i.jsx)(p.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,i.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(a.p,{children:"Array ["})})}),(0,i.jsx)(p.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(a.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(a.p,{children:"]"})})})]})]})}),(0,i.jsx)(p.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(a.p,{children:"]"})})})]})]})})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "result": [\n {\n "objectId": "x1Hbnms2Pg",\n "title": "sample template",\n "note": "template note",\n "folder": {\n "objectId": "x1Hbnms2Pg",\n "name": "folder name"\n },\n "file": "https://templateuser.com",\n "owner": "template creator name",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": true,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z",\n "enableTour": true,\n "redirect_url": "",\n "allow_modifications": false\n }\n ]\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/770b40a9.ceac1441.js b/assets/js/770b40a9.ceac1441.js deleted file mode 100644 index 225d663b7..000000000 --- a/assets/js/770b40a9.ceac1441.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1520],{9104:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>f,toc:()=>g});var l=a(85893),i=a(11151),t=a(58219),n=(a(62316),a(51039)),r=a.n(n),m=(a(82723),a(9487)),o=a(41429),c=a(5397),d=a(4667),p=a(9472),h=a(85162);const x={id:"gettemplatelist",title:"Get Template list",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.",sidebar_label:"Get Template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdV1tv2zYU/iunfNkKKLacWzthGBpsRRa0WAokQ4GlRkBJxxYbimRJyhcYetsv2U/bLxkOJdly3MTNVvRhL4lFfh/PhefGFfN86lhyw66xNJJ7dGwcsRxdZoXxQiuWsOsC4Rw9dBB4K5yHs3cXwKXUcwdLXYHXYNFbgTMEDpIQegJ8xoXkqUTw3fkDuC6Eg0mlMjqfS+GXYKyeiRwdcAV6hnYmcB74Um6YEaDiqRRqCpVD60hmVmjtECZWl4AL4TztrhkwL1BBZpGH9VxnVYnKuwGLmDZoOWlwkbOETdF3LNKdRcxwy0v0aMk9K6Z4iSxhUpSCdgU55lOFdskiZvFTJSzmLJlw6TBizi8loSfalixiuDBS58gSbyvazQosOUtWrOQLUVYlS07iOGJ+aYikqjJFy2ri8dLQQaO4jtYquDthvpoGD8uM6zGd64xWDh1hD+OY/m0Hh6uyDJ2bVBLWHmURy7TyqDzhuTFSZGFj+NERabWrgE4/YhbcbukYLxqRFl0lfQ/HreVksPBYuv38ZplueI103go1ZVFwDff9lbXtbDH6NVWlO3w3JZ944Wl194gNwYUf68gjltJ+D6lDQ4DWpJLM0X4rs5p4ekzBRh8IwHrjiLXit63CpLrY56LCe+OS4bAjUw4PMl0SW8/Vlt2POSuks+60ipgTUxWy9N8GidX7VM9Qf5nDPmqEFINaWHIh96JTxFftQucLU2i1R8zxyenh6OjlixHh5yKfov8P9je7u/K2E/2Maj3mMOOyQgcHQH7nvrIYgfO8NIM9wbfGk9KL3eLTY69X1uzD4+M6Yssnsl6MyD9PJB29rCNWPJF0fEo3x6f4RN7os2l11YT0bXe19WOokJkOVX6hLu12+Ui1lshVXyA1gDpiIYkwP/OPB9phfHh0MIoP4hfXo9Pk+Ifk5HQQx/EfLGKLMkR325Tytuh1Snbflcm/gZz6Pqxfh+/7bdubQkmh8LZrdLeHcXx7SpA6YsfxyW7Du1AzLkUe5p9rfYfq2ddrd2it3lMG++J9I37XfNGAwj7bMra/3hjpMKus8Msw5SwOuBEHzX5yM6YRoERf6HZECmORL1jChvemJYd21o1KlZW9cu+4ylO9GGiDikqA5KmjUjfkRgxnVMHuM7gxT0A7z6dCTQ8eZY03dl7RXTTu3rJ2Uz2NeINUPltn9lHt2FUgD22vpu+JDuTWxZcGFSVmuKDZaKeMvkeZ6RJpdvUFQgf/+8+/AqMbUUP8PIPLyoLRc7Q0X3GVw0TiQtA8vTt+O+SlROfkEoTyOLXULHMxFZ7LUKxpBM644amQgiKOYJrYFnpB6wbwvkBfoKWt7yyN8znOUFKggtT6LozYGnjldRlktDrDXNu7CakUAYe0ckKhc+AQOwqqgqsMobuLCLSlkR+VR2uscAhclASeaAs4mYhM0MGUXpZnHkqu+BRJWASkN3lh/XawOq2cB6dlFQwhiSWib0xUiLkbwC9iho3htJij50JiDtOKjogg0zlCm21khsohRefBkHiRYTjUeW49SJyhDbEXbnJSSQlGUxkQXNLjpX+3dJC3XDnqBY1C3dWs3WesplE6yMj5cgAf1Ad1RcFSOaQAkELdueSDOoCbdZi9x9QJj+Pvu3yYz+c7efB8m3MufFGlYNHoDW8aFkPW9Onrj+csYh5t6S4nV/RAy7qZ7gGZwwAetsWRZ6E4tkMR5dir+wQqVFJkqBz2StnZ+bu3MIOjQcyiXuZ/gcLDtxc/v/7t6jWdS7Wpyb/RIB7EYczSzpdc9URtvXHburaVvKtNnf+fPorbEuhx4YdGchG6R/D6qq38N2yr8o8jVmjnaX21SrnD362sa1punqbUD3LhyNrN4/QOl72ndBgoWcJCbX8A2755N9AxfVhB2NCooq4mk8CGc5ZlaPoCdjrzVns7f33NIsYrX2z3grvQC9ofdHq3pZa9s7ebRKMA/SWbPkv4kULlDS5/WsObnQcJrX0dmq5mXNf1P6KdIbg=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,f={id:"API-docs/gettemplatelist",title:"Get Template list",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.",source:"@site/docs/API-docs/gettemplatelist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/gettemplatelist",permalink:"/docs/API-docs/gettemplatelist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"gettemplatelist",title:"Get Template list",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.",sidebar_label:"Get Template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdV1tv2zYU/iunfNkKKLacWzthGBpsRRa0WAokQ4GlRkBJxxYbimRJyhcYetsv2U/bLxkOJdly3MTNVvRhL4lFfh/PhefGFfN86lhyw66xNJJ7dGwcsRxdZoXxQiuWsOsC4Rw9dBB4K5yHs3cXwKXUcwdLXYHXYNFbgTMEDpIQegJ8xoXkqUTw3fkDuC6Eg0mlMjqfS+GXYKyeiRwdcAV6hnYmcB74Um6YEaDiqRRqCpVD60hmVmjtECZWl4AL4TztrhkwL1BBZpGH9VxnVYnKuwGLmDZoOWlwkbOETdF3LNKdRcxwy0v0aMk9K6Z4iSxhUpSCdgU55lOFdskiZvFTJSzmLJlw6TBizi8loSfalixiuDBS58gSbyvazQosOUtWrOQLUVYlS07iOGJ+aYikqjJFy2ri8dLQQaO4jtYquDthvpoGD8uM6zGd64xWDh1hD+OY/m0Hh6uyDJ2bVBLWHmURy7TyqDzhuTFSZGFj+NERabWrgE4/YhbcbukYLxqRFl0lfQ/HreVksPBYuv38ZplueI103go1ZVFwDff9lbXtbDH6NVWlO3w3JZ944Wl194gNwYUf68gjltJ+D6lDQ4DWpJLM0X4rs5p4ekzBRh8IwHrjiLXit63CpLrY56LCe+OS4bAjUw4PMl0SW8/Vlt2POSuks+60ipgTUxWy9N8GidX7VM9Qf5nDPmqEFINaWHIh96JTxFftQucLU2i1R8zxyenh6OjlixHh5yKfov8P9je7u/K2E/2Maj3mMOOyQgcHQH7nvrIYgfO8NIM9wbfGk9KL3eLTY69X1uzD4+M6Yssnsl6MyD9PJB29rCNWPJF0fEo3x6f4RN7os2l11YT0bXe19WOokJkOVX6hLu12+Ui1lshVXyA1gDpiIYkwP/OPB9phfHh0MIoP4hfXo9Pk+Ifk5HQQx/EfLGKLMkR325Tytuh1Snbflcm/gZz6Pqxfh+/7bdubQkmh8LZrdLeHcXx7SpA6YsfxyW7Du1AzLkUe5p9rfYfq2ddrd2it3lMG++J9I37XfNGAwj7bMra/3hjpMKus8Msw5SwOuBEHzX5yM6YRoERf6HZECmORL1jChvemJYd21o1KlZW9cu+4ylO9GGiDikqA5KmjUjfkRgxnVMHuM7gxT0A7z6dCTQ8eZY03dl7RXTTu3rJ2Uz2NeINUPltn9lHt2FUgD22vpu+JDuTWxZcGFSVmuKDZaKeMvkeZ6RJpdvUFQgf/+8+/AqMbUUP8PIPLyoLRc7Q0X3GVw0TiQtA8vTt+O+SlROfkEoTyOLXULHMxFZ7LUKxpBM644amQgiKOYJrYFnpB6wbwvkBfoKWt7yyN8znOUFKggtT6LozYGnjldRlktDrDXNu7CakUAYe0ckKhc+AQOwqqgqsMobuLCLSlkR+VR2uscAhclASeaAs4mYhM0MGUXpZnHkqu+BRJWASkN3lh/XawOq2cB6dlFQwhiSWib0xUiLkbwC9iho3htJij50JiDtOKjogg0zlCm21khsohRefBkHiRYTjUeW49SJyhDbEXbnJSSQlGUxkQXNLjpX+3dJC3XDnqBY1C3dWs3WesplE6yMj5cgAf1Ad1RcFSOaQAkELdueSDOoCbdZi9x9QJj+Pvu3yYz+c7efB8m3MufFGlYNHoDW8aFkPW9Onrj+csYh5t6S4nV/RAy7qZ7gGZwwAetsWRZ6E4tkMR5dir+wQqVFJkqBz2StnZ+bu3MIOjQcyiXuZ/gcLDtxc/v/7t6jWdS7Wpyb/RIB7EYczSzpdc9URtvXHburaVvKtNnf+fPorbEuhx4YdGchG6R/D6qq38N2yr8o8jVmjnaX21SrnD362sa1punqbUD3LhyNrN4/QOl72ndBgoWcJCbX8A2755N9AxfVhB2NCooq4mk8CGc5ZlaPoCdjrzVns7f33NIsYrX2z3grvQC9ofdHq3pZa9s7ebRKMA/SWbPkv4kULlDS5/WsObnQcJrX0dmq5mXNf1P6KdIbg=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Template",permalink:"/docs/API-docs/delete-template"},next:{title:"Get Webhook",permalink:"/docs/API-docs/get-webhook"}},j={},g=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get Template list"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/templatelist"}),"\n",(0,l.jsx)(s.p,{children:"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."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Query Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsxs)("ul",{children:[(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"template[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"folder"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"widgets"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "result": [\n {\n "objectId": "x1Hbnms2Pg",\n "title": "sample template",\n "note": "template note",\n "folder": {\n "objectId": "x1Hbnms2Pg",\n "name": "folder name"\n },\n "file": "https://templateuser.com",\n "owner": "template creator name",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": true,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/a9f09360.01e35e86.js b/assets/js/a9f09360.01e35e86.js deleted file mode 100644 index 51b24761c..000000000 --- a/assets/js/a9f09360.01e35e86.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8888],{63135:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>p,metadata:()=>x,toc:()=>f});var i=s(85893),a=s(11151),l=s(58219),t=(s(62316),s(51039)),r=s.n(t),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),h=s(85162);const p={id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztW+9yGzeSf5Xe+eJYNaJEWnZ8rKurdeLcnm6TSLVWKnUlqRRwpknCmgEmAEYUo+K3e5J7tHuSq24A84ciJdlOZZU6+oPFARpA44fuRqPRuEucmNlkfJ6811ldonI2uUyTHG1mZOWkVsk4OZsjvDdi6iASwbvTYxBFoRcWaovGgtMwQ4VGOASFC8hjdzBZQmX0jcylmkEunICFdHOYCItvjgBVpnPMYSoLHFyoC3UmqzH8VBVa5LDUtYHT9//e9EbDUNn53t57nNQz+Ol4b+/yq7lzlR0fHIiqGugKlZUzVYiJHWS6PMiJsMqnL1NYzNEg9QqZUIDCymIJIs9hIfMZOpuCm6OCTFdLyLQ2uVTCoU2hEjMEVZcTNDYFoXIotUGQCgQYFPly3+n92iL854eTH2GqTSncAE6L2qbNcLk0mLli6bt3c2xm9cJGNKwzUs1SKMU1oSUd/FrL7JqmbVHl9Jcavjs9Zqz29j7UVaWNwxx+9lMY7+1RzTdY6AUIg0yf6bLUCiphRImOl2suHFcb/LWWBnO/KKIoIhbjC7UPe3tuWeF4bw+OVS4zAoM7pFLQ00A78KQEEpF+qDCTUxlIO9CBVrCYy2zOmCyEX8+qEJln06CtMHPyBvsd36awpI7fo9KRg7k28jetnCh4OW7QOJmJortsxCCRWieMIzgrLZWLpWEE+K+wPLR6vChBroi1nMAqpeIai3Ajihpt4GqRwpy4+gdWBi2LeuiXgFQ5zFHO5lvHE/nH2rpex1BbYrPLRRgrrhLDiwzbVBQWQU57WJbiGjujgWYVFsUAvllCjlNRFy4FSRLnTI0D+FE7EFVVyExMCiTJBVIe4WqD+7zKQRwCI0qUvManrNFoQUAup1M0pJxUyV2ENpE7krPWBLDmuLlQoNXaQme60Ia6X5MhLu8DCZlWDpUbwLsbIQvm3s/WglRZUecIk0Jk1ylMihpTMJh7zV0i2a00WCEiAWED6AwQWCxIDLWiCSgdhpcWbOAqH8DZXNpWoagyYs2DSNuFNajtVNPIhEHUMcBSyCJl5FL4qCfgpCswJY2thFqmZDAxBYe3bqJvU8jmmF3zLyNyqWFSO6eVn1hudJXrhQpgTrVyVv62QSVjzacjOkrhKIU3KbxNYXiYwnCUwvAoheGbFIZvUxgdpjAapTA6SmH0xrM1ehuwFg3AXQaGI4+y+/OgS4b3e2lZtcli2sYIL3pG+EINB7C31ygUF//yyy8X6u5CAVwkpGAXyfgiaUgukhR8HdnNi2Q8TCEU3F4kY3g1+joSLOn7DaHrvxf0PaTV8N9z+h4NL9QqDDpiZpwoqwcYoerfn4n4GeSJCnlkKou2jQrJKHlaqqF1o9KGLapYtRN6RROSSjopCrt9TpHi+U2r5WxtZkc0M5be7dPi6uc3p8hWrGHj6avY2HaqohlgRkZrELwetNvNFgT8oM8NgMDVl87/Dc2/sVnbQWhInh8SXda+FI6vB+wfsN3eDkYgeH5QtIx9KRBvCQjat7ajQLXPD4LAVawIvoCvOzzaH77eHx2Ojnow0DHKE5Tlfp7vL5fLL4QQGDByj8L47G0Gb9Y7gXSCnRpdbjiq8EmipQruE/+O7v0P5NRPor+LOZ0R+RASnZvmdNj1yJ3OxfKF9V3Fpo0fR/StF7fssMlVxAeflLO5lllgnmii9zahw+CAQNgn4PODH3446EDpC/fLMuILsZS+9xn6bmlZDvJ8sE7bW6FOaQl5nsKG8s0VeQ5lWW4r9xW0XV6ofyFFCK7bdl0IBH+MOmyQ+nb8rbrSVohcq4LH59PdZl1Z21/mUoWKIDewRmBwVhfC4C0dU63UinH5HSzRmhZFJWrdfD7V8oGQYwYeCfjqJLjyL4OA0wz6HVDJ4+3uTazbicEZ3nIfWW2dLokZmQvqIQVbZ3M69Il4YiDY2/gOf2WikhRdKNA5LkWXDTYx4RetczKnRV0/mFt0vckIC7HlhrM5rz4fNIaHvO+Fc8kDG1+geH5mv8NZrPTRDqo+v0hKEVyXZIrtb+3maC6Sy6aNP5Nj3mkLmxrD5QP6BK3S5FiICRb3de3J2tCdTpCsDjhUUUrVhBKY5cPIAdeK27XaULnaoGd+2l0Bj8Y9qknEGQppYzylD1q3dQg4cRhQIXJkcYIQG1DQNmrxl4p8w9gTZD4ahLA6j4xAdMCETawvDvaAUtEIvZXp4kJ9lFLJsi6boOW06TUiVoZNvgsXtaRQeByhu7r3RhC3j4xAEcLtA1yoIUcWYkyC7QJs9gUDyfMzDB3OHt8BP8dk9HbNz93vPl0R47y6irhhmyRSv0E2Smi3a+EATmhTooipb0QhsCzDylG47EtVtGH5advSkCNJ3RDZ9o2pS/VHy+A2YXqKdK7x/bvJYaD7Mt+LUHuaMHan8ScSyB7bT/aVfDyw9NdQ24KBJYveczOGga21nT9JE13RnarU6jhPxklOt7Dx2jBJuWu07hudL5PxXRIi+PQzxMep5cFHS9e4d4nN5lgK+hVZootfunlN0oQDNXT3S1Al40RPPmJGY1SGeHASLbVk6vFdpPIXlkkaDuvJOPE3mUma4K0oKyJO1q56q3yarOKAD3XVlLRdWf7R3JxSP7276s/q7X2nh1Wa0CXjZ/b0IzXluZV4pr/VVOjwvVjaTod+10/Wb9mpDelAFlpBLpaW1Kq23j/LRJHVBZ378baSZtkEIfjw35GKhtFmpIbR4etVyrcNaLosCWPEMkkT6bDslm8RAqM/feUy1IQMh4c/te1HjRPEv4YCutXndRLlJ3PxUSNMkNeommv1ye2Ho1fD0fDVcEQ9hNuez8fR197noC8Y7+iUinn02ffbG9oU+GJk8JhwRnqetpjh48J4tu3mvnNfaOe6LnK6iUNhBnyB/tm5GX35braiwSPSvEqT28cncwuZ3o9pAfBVgVMHdVWhgUwbheZlN973bCY3Ojpapcny8ekt/5TT+5oWb/H47H7mfIo21+Sfweurt6s0mT/O6380GR//RGaP3qza3TXJDAqHcXO4muh8eRXt1uoxwrhREN1UFzka8kLu26vW1JCFoUylq3U7P9G6QKE2GJreTX/IKSOfkNzBEPBezJGc6tZV5N5b7zQ4j55byh7AtRiktOQDmhovkgEcTzu+LscN1pMNIi1f/CsNL3i8K1uzGX9xEL4JoxfdrCpKdGkD/ZEFJgaHZVVwWtJCFgXxTfv6AJp/7O41SBIDcbuMAz++VXzrY508YGjUz+mB4DEO4FuhmrSOfvoE3N01YsDSsVrB3R2tKpor2nRXq7QtoLF6Bbyv+hKDGcqbXqumCNuGTVmnqXdxrsjF8QXhBq3LgJwpqWZXtSlWq8E9MWzX6Mm43YMprB118v8AMWLnWJ2YHM0TNPd46o9rGl6QsL4IcXNGRhrrgj56cQ8M+6uwLSiHbAg65X3X6LetJ5aoVOyv1R9n5GyGlLsYKLhxSDZCkc29ZWCuxJRUm/MRDd5IXdvI3lzYxuXOiUJ6dZFq1j9tdtDhXLDu3AebVFdRdtLJ2ekTsOSz8L63RP4I6Wfp+4CTs1PKcJTTcKIbwE+2QSJCK3okQGctuJEiJkE17tvShy9RMSLebPbSUQcht3Af7jOUS7uRo7S9S2nyge913KbA0hLp2lHurQx5XdZhZXs4MhcNkGe6fopUPoKkgFnN17KOduVoGvl+p81QlMo6U/vQLeS1iUmZQSyIMkNrW5wiKkTU6T8FVNY3FzAV1qFJoVaSkDc1RUqaLvG2QiNRZbgZAr8NtAblcZPGyZjaBN0K4fEKjdWKirWZCSV/87Ki/TpNcC6KKbsvzdU3b2mo8ogB9da3HNF/SbreRC9Q4Y0wextt4CFoCeX8amX9eWh0eEh/+hNpcs6Dh0K3dwT/tC6K5V+S9OlRj4cPYw23cqOP89ABa/5Rjn67zW5Gp2RGa/PJB9zoD9amoExyAny/UUc+7nawlaqQCq8Y4qtcZ1cG7dXo8PBqSBiv0uRoE4wfdIluzumRBObCaEo0rwoUlPhsliBmQiogF8X8jqiiMdo87DN+GmcbkIgydHXUA+H1fRCOFV/W8fOFM32N6o+daXd454cnVm9LFhiv14n0RFyf9CbbLfeTtJjVRrplMj6/S273RSX3ff34/HJ1mSYErKbAYaUtcyzcPBknB+txRIvmhiNC53defBuJtELldJ9275QiKnlwM0xW6XqLjWeardTWiZlUs/0HW122M/1Aq+EB7823DcFU8u9IMZgAZ5cqTSRJwRwFuTgEIC3yP9og6ndxqWKgc1Pssl2S9Wjkug3eEF+M4cVexHBzwHD4uhOqO49RNw6kNXG0TaGxZuox2NXEujrhq0706rwV2SZQFONEQw6wjI6OOBLx9ZCP7K/e8mn46M2Khaw9GSZJ//TH0e71M0yS9H3z2KjxPEOr1n3ytzc9PyAW3d8XO/sRLfdUs2yEBTupUH0gt4Q08GZ4P9iARabLJqU8kv/vf/8Pt4gLzQbiL3BSG6j0As209nnp0wJvJTkCnedR8SiLoizQ2mIJtP/P+KFULmecYxK9gExUYiILSSaFyLQP7Xaskh3Az+1h+IXx6TY3WJAlgkJrfjfkNIja6ZLHiNvnQpvrKbGUgoAJPTVBS24sxiao5kJltN17VUvJT6B3UuSvVEZaBCFLIia/CadTmUnel7VyRmQOSqHEDGmwlIMehEIVH4oYPSG30+qi9o4VPVdBdH6KfNs0gPfkyPLEOaSNTsgCc+9T2dT7tEHUwzusCZ0fKhpeZmjbJL0Cb9CwafEnkroooNLOnxLIxemuLXXkjFCW9ugQTg9L08AXnD4eIxfLAdCVE21d5PCSABRSXftXU+eNmP2MEysdtgGfxWJxz8y97Lf5m3TzegIGK922m3EhG8Vu8+bjJdkQNKU9mX5AcyOz6FVsGfOAiQ/C7id8bCHaFFHJv643IG0qZIbKYmeveve30+/hBl4NDpO0Y9ifwPDB98fffvfjh++oX9p6vP4NB4eDQ45Sa+tKoTpD9R8grmtu5+5r91xx91xx91xx91xx91zxT/Ogbvdccfdccfdccfdccfdccfdccfdc8RlAsXuuuHuuuHuuuHuuuHuuuHuuuHuuuHuuuHuuuHuuuHuuuHuu+Dxeh+2eK+6eKz4rgdw9V4zPFUMiCfmNB1UhpOokxPnko/O1R4yXaTKn5KTxeXJ3R/eKP1FyMhX/WqOhzKbLNLkRRlLwnPOa0pjAQ5kr10gpJN/6u4D9Mxo+9WLPF9lr6VyUf+RbvOPFf5C2mz91evLhLEmTmE1e6pzaGLGgR5hikYwTstn8XpMR5Vdygp+3FELNak6mSXy/lHckajfvJy1dc9JS+NHJyRFq2eGyn83kp0L/08Q2NvhXuvr+Oy7/rSH3NVsbBGwjNa3g5Wq1+j/ZRA9A",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with base64 encoded file.",source:"@site/docs/API-docs/draftdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/draftdocument",permalink:"/docs/API-docs/draftdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztW+9yGzeSf5Xe+eJYNaJEWnZ8rKurdeLcnm6TSLVWKnUlqRRwpknCmgEmAEYUo+K3e5J7tHuSq24A84ciJdlOZZU6+oPFARpA44fuRqPRuEucmNlkfJ6811ldonI2uUyTHG1mZOWkVsk4OZsjvDdi6iASwbvTYxBFoRcWaovGgtMwQ4VGOASFC8hjdzBZQmX0jcylmkEunICFdHOYCItvjgBVpnPMYSoLHFyoC3UmqzH8VBVa5LDUtYHT9//e9EbDUNn53t57nNQz+Ol4b+/yq7lzlR0fHIiqGugKlZUzVYiJHWS6PMiJsMqnL1NYzNEg9QqZUIDCymIJIs9hIfMZOpuCm6OCTFdLyLQ2uVTCoU2hEjMEVZcTNDYFoXIotUGQCgQYFPly3+n92iL854eTH2GqTSncAE6L2qbNcLk0mLli6bt3c2xm9cJGNKwzUs1SKMU1oSUd/FrL7JqmbVHl9Jcavjs9Zqz29j7UVaWNwxx+9lMY7+1RzTdY6AUIg0yf6bLUCiphRImOl2suHFcb/LWWBnO/KKIoIhbjC7UPe3tuWeF4bw+OVS4zAoM7pFLQ00A78KQEEpF+qDCTUxlIO9CBVrCYy2zOmCyEX8+qEJln06CtMHPyBvsd36awpI7fo9KRg7k28jetnCh4OW7QOJmJortsxCCRWieMIzgrLZWLpWEE+K+wPLR6vChBroi1nMAqpeIai3Ajihpt4GqRwpy4+gdWBi2LeuiXgFQ5zFHO5lvHE/nH2rpex1BbYrPLRRgrrhLDiwzbVBQWQU57WJbiGjujgWYVFsUAvllCjlNRFy4FSRLnTI0D+FE7EFVVyExMCiTJBVIe4WqD+7zKQRwCI0qUvManrNFoQUAup1M0pJxUyV2ENpE7krPWBLDmuLlQoNXaQme60Ia6X5MhLu8DCZlWDpUbwLsbIQvm3s/WglRZUecIk0Jk1ylMihpTMJh7zV0i2a00WCEiAWED6AwQWCxIDLWiCSgdhpcWbOAqH8DZXNpWoagyYs2DSNuFNajtVNPIhEHUMcBSyCJl5FL4qCfgpCswJY2thFqmZDAxBYe3bqJvU8jmmF3zLyNyqWFSO6eVn1hudJXrhQpgTrVyVv62QSVjzacjOkrhKIU3KbxNYXiYwnCUwvAoheGbFIZvUxgdpjAapTA6SmH0xrM1ehuwFg3AXQaGI4+y+/OgS4b3e2lZtcli2sYIL3pG+EINB7C31ygUF//yyy8X6u5CAVwkpGAXyfgiaUgukhR8HdnNi2Q8TCEU3F4kY3g1+joSLOn7DaHrvxf0PaTV8N9z+h4NL9QqDDpiZpwoqwcYoerfn4n4GeSJCnlkKou2jQrJKHlaqqF1o9KGLapYtRN6RROSSjopCrt9TpHi+U2r5WxtZkc0M5be7dPi6uc3p8hWrGHj6avY2HaqohlgRkZrELwetNvNFgT8oM8NgMDVl87/Dc2/sVnbQWhInh8SXda+FI6vB+wfsN3eDkYgeH5QtIx9KRBvCQjat7ajQLXPD4LAVawIvoCvOzzaH77eHx2Ojnow0DHKE5Tlfp7vL5fLL4QQGDByj8L47G0Gb9Y7gXSCnRpdbjiq8EmipQruE/+O7v0P5NRPor+LOZ0R+RASnZvmdNj1yJ3OxfKF9V3Fpo0fR/StF7fssMlVxAeflLO5lllgnmii9zahw+CAQNgn4PODH3446EDpC/fLMuILsZS+9xn6bmlZDvJ8sE7bW6FOaQl5nsKG8s0VeQ5lWW4r9xW0XV6ofyFFCK7bdl0IBH+MOmyQ+nb8rbrSVohcq4LH59PdZl1Z21/mUoWKIDewRmBwVhfC4C0dU63UinH5HSzRmhZFJWrdfD7V8oGQYwYeCfjqJLjyL4OA0wz6HVDJ4+3uTazbicEZ3nIfWW2dLokZmQvqIQVbZ3M69Il4YiDY2/gOf2WikhRdKNA5LkWXDTYx4RetczKnRV0/mFt0vckIC7HlhrM5rz4fNIaHvO+Fc8kDG1+geH5mv8NZrPTRDqo+v0hKEVyXZIrtb+3maC6Sy6aNP5Nj3mkLmxrD5QP6BK3S5FiICRb3de3J2tCdTpCsDjhUUUrVhBKY5cPIAdeK27XaULnaoGd+2l0Bj8Y9qknEGQppYzylD1q3dQg4cRhQIXJkcYIQG1DQNmrxl4p8w9gTZD4ahLA6j4xAdMCETawvDvaAUtEIvZXp4kJ9lFLJsi6boOW06TUiVoZNvgsXtaRQeByhu7r3RhC3j4xAEcLtA1yoIUcWYkyC7QJs9gUDyfMzDB3OHt8BP8dk9HbNz93vPl0R47y6irhhmyRSv0E2Smi3a+EATmhTooipb0QhsCzDylG47EtVtGH5advSkCNJ3RDZ9o2pS/VHy+A2YXqKdK7x/bvJYaD7Mt+LUHuaMHan8ScSyB7bT/aVfDyw9NdQ24KBJYveczOGga21nT9JE13RnarU6jhPxklOt7Dx2jBJuWu07hudL5PxXRIi+PQzxMep5cFHS9e4d4nN5lgK+hVZootfunlN0oQDNXT3S1Al40RPPmJGY1SGeHASLbVk6vFdpPIXlkkaDuvJOPE3mUma4K0oKyJO1q56q3yarOKAD3XVlLRdWf7R3JxSP7276s/q7X2nh1Wa0CXjZ/b0IzXluZV4pr/VVOjwvVjaTod+10/Wb9mpDelAFlpBLpaW1Kq23j/LRJHVBZ378baSZtkEIfjw35GKhtFmpIbR4etVyrcNaLosCWPEMkkT6bDslm8RAqM/feUy1IQMh4c/te1HjRPEv4YCutXndRLlJ3PxUSNMkNeommv1ye2Ho1fD0fDVcEQ9hNuez8fR197noC8Y7+iUinn02ffbG9oU+GJk8JhwRnqetpjh48J4tu3mvnNfaOe6LnK6iUNhBnyB/tm5GX35braiwSPSvEqT28cncwuZ3o9pAfBVgVMHdVWhgUwbheZlN973bCY3Ojpapcny8ekt/5TT+5oWb/H47H7mfIo21+Sfweurt6s0mT/O6380GR//RGaP3qza3TXJDAqHcXO4muh8eRXt1uoxwrhREN1UFzka8kLu26vW1JCFoUylq3U7P9G6QKE2GJreTX/IKSOfkNzBEPBezJGc6tZV5N5b7zQ4j55byh7AtRiktOQDmhovkgEcTzu+LscN1pMNIi1f/CsNL3i8K1uzGX9xEL4JoxfdrCpKdGkD/ZEFJgaHZVVwWtJCFgXxTfv6AJp/7O41SBIDcbuMAz++VXzrY508YGjUz+mB4DEO4FuhmrSOfvoE3N01YsDSsVrB3R2tKpor2nRXq7QtoLF6Bbyv+hKDGcqbXqumCNuGTVmnqXdxrsjF8QXhBq3LgJwpqWZXtSlWq8E9MWzX6Mm43YMprB118v8AMWLnWJ2YHM0TNPd46o9rGl6QsL4IcXNGRhrrgj56cQ8M+6uwLSiHbAg65X3X6LetJ5aoVOyv1R9n5GyGlLsYKLhxSDZCkc29ZWCuxJRUm/MRDd5IXdvI3lzYxuXOiUJ6dZFq1j9tdtDhXLDu3AebVFdRdtLJ2ekTsOSz8L63RP4I6Wfp+4CTs1PKcJTTcKIbwE+2QSJCK3okQGctuJEiJkE17tvShy9RMSLebPbSUQcht3Af7jOUS7uRo7S9S2nyge913KbA0hLp2lHurQx5XdZhZXs4MhcNkGe6fopUPoKkgFnN17KOduVoGvl+p81QlMo6U/vQLeS1iUmZQSyIMkNrW5wiKkTU6T8FVNY3FzAV1qFJoVaSkDc1RUqaLvG2QiNRZbgZAr8NtAblcZPGyZjaBN0K4fEKjdWKirWZCSV/87Ki/TpNcC6KKbsvzdU3b2mo8ogB9da3HNF/SbreRC9Q4Y0wextt4CFoCeX8amX9eWh0eEh/+hNpcs6Dh0K3dwT/tC6K5V+S9OlRj4cPYw23cqOP89ABa/5Rjn67zW5Gp2RGa/PJB9zoD9amoExyAny/UUc+7nawlaqQCq8Y4qtcZ1cG7dXo8PBqSBiv0uRoE4wfdIluzumRBObCaEo0rwoUlPhsliBmQiogF8X8jqiiMdo87DN+GmcbkIgydHXUA+H1fRCOFV/W8fOFM32N6o+daXd454cnVm9LFhiv14n0RFyf9CbbLfeTtJjVRrplMj6/S273RSX3ff34/HJ1mSYErKbAYaUtcyzcPBknB+txRIvmhiNC53defBuJtELldJ9275QiKnlwM0xW6XqLjWeardTWiZlUs/0HW122M/1Aq+EB7823DcFU8u9IMZgAZ5cqTSRJwRwFuTgEIC3yP9og6ndxqWKgc1Pssl2S9Wjkug3eEF+M4cVexHBzwHD4uhOqO49RNw6kNXG0TaGxZuox2NXEujrhq0706rwV2SZQFONEQw6wjI6OOBLx9ZCP7K/e8mn46M2Khaw9GSZJ//TH0e71M0yS9H3z2KjxPEOr1n3ytzc9PyAW3d8XO/sRLfdUs2yEBTupUH0gt4Q08GZ4P9iARabLJqU8kv/vf/8Pt4gLzQbiL3BSG6j0As209nnp0wJvJTkCnedR8SiLoizQ2mIJtP/P+KFULmecYxK9gExUYiILSSaFyLQP7Xaskh3Az+1h+IXx6TY3WJAlgkJrfjfkNIja6ZLHiNvnQpvrKbGUgoAJPTVBS24sxiao5kJltN17VUvJT6B3UuSvVEZaBCFLIia/CadTmUnel7VyRmQOSqHEDGmwlIMehEIVH4oYPSG30+qi9o4VPVdBdH6KfNs0gPfkyPLEOaSNTsgCc+9T2dT7tEHUwzusCZ0fKhpeZmjbJL0Cb9CwafEnkroooNLOnxLIxemuLXXkjFCW9ugQTg9L08AXnD4eIxfLAdCVE21d5PCSABRSXftXU+eNmP2MEysdtgGfxWJxz8y97Lf5m3TzegIGK922m3EhG8Vu8+bjJdkQNKU9mX5AcyOz6FVsGfOAiQ/C7id8bCHaFFHJv643IG0qZIbKYmeveve30+/hBl4NDpO0Y9ifwPDB98fffvfjh++oX9p6vP4NB4eDQ45Sa+tKoTpD9R8grmtu5+5r91xx91xx91xx91xx91zxT/Ogbvdccfdccfdccfdccfdccfdccfdc8RlAsXuuuHuuuHuuuHuuuHuuuHuuuHuuuHuuuHuuuHuuuHuuuHuu+Dxeh+2eK+6eKz4rgdw9V4zPFUMiCfmNB1UhpOokxPnko/O1R4yXaTKn5KTxeXJ3R/eKP1FyMhX/WqOhzKbLNLkRRlLwnPOa0pjAQ5kr10gpJN/6u4D9Mxo+9WLPF9lr6VyUf+RbvOPFf5C2mz91evLhLEmTmE1e6pzaGLGgR5hikYwTstn8XpMR5Vdygp+3FELNak6mSXy/lHckajfvJy1dc9JS+NHJyRFq2eGyn83kp0L/08Q2NvhXuvr+Oy7/rSH3NVsbBGwjNa3g5Wq1+j/ZRA9A",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Self Sign",permalink:"/docs/API-docs/selfsign"},next:{title:"Create Document",permalink:"/docs/API-docs/createdocument"}},g={},f=[{value:"Request",id:"request",level:2}];function j(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Draft Document"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/draftdocument"}),"\n",(0,i.jsx)(n.p,{children:"The Draft Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": { \n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "readonly": false,\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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. \n",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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'.",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"name or email of the person or organization on the behalf of which you are sending the mail.",example:"opensign"}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"document_id",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-send-document.com"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "document_id": "hji2zxcv2P",\n "url": "https://url-to-send-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/a9f09360.553c32a0.js b/assets/js/a9f09360.553c32a0.js new file mode 100644 index 000000000..7cbf67696 --- /dev/null +++ b/assets/js/a9f09360.553c32a0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8888],{63135:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>p,metadata:()=>x,toc:()=>j});var i=s(85893),a=s(11151),t=s(58219),l=(s(62316),s(51039)),r=s.n(l),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),h=s(85162);const p={id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztO39zGzeuXwW3/6TxrGVLcdKc582bS5O+O79ra0/jTOfG9rjULiQx3iW3JNey6tF/90nuo90neQOQ3B+yZDtJp+fOU/6ItSRIgiAAAiBwmzgxtcnhWfJOZ3WJytnkIk1ytJmRlZNaJYfJ6QzhnRETBxEI3pwcgSgKPbdQWzQWnIYpKjTCISicQx6ng/ECKqOvZS7VFHLhBMylm8FYWHx1AKgynWMOE1ng4Fydq1NZHcKHqtAih4WuDZy8+59mNlqG2s52dt7huJ7Ch6OdnYuvZs5V9nBvT1TVQFeorJyqQoztINPlXk6AVT55nsJ8hgZpVsiEAhRWFgsQeQ5zmU/R2RTcDBVkulpAprXJpRIObQqVmCKouhyjsSkIlUOpDYJUIMCgyBe7Tu/WFuF/3x//ABNtSuEGcFLUNm2Wy6XBzBULP72bYbOrZzZSwzoj1TSFUlwRtaSDX2qZXdG2Laqc/tLANydHTKudnfd1VWnjMIef/BYOd3ao5xss9ByEQYbPdFlqBZUwokTHxzUTjrsN/lJLg7k/FFEUkRaH52oXdnbcosLDnR04UrnMiBg8IbWCngTYgQclIhHo+wozOZEBtEM60ArmM5nNmCZz4c+zKkTm0TRoK8ycvMb+xDcpLGjid6h0xGCmjfxVKycKPo5rNE5mougeGyFIoNYJ44iclZbKxdawAvwjHA+dHh9K4CtCLSdilVJxj0W4FkWNNmA1T2FGWP2IlUHLrB7mJUKqHGYop7ON64n8Y21db2KoLaHZxSKsFU+JyYtMtokoLIKc9GhZiivsrAaaRVgUA/hmATlORF24FCRxnDM1DuAH7UBUVSEzMS6QOBdIeISrDe7yKQd2CIgoUfIZn7BEowUBuZxM0JBwUidPEcZE7IjPWhXAkuNmQoFWKwed6UIbmn6Fh7i9T0jItHKo3ADeXAtZMPZ+txakyoo6RxgXIrtKYVzUmILB3EvuAklvpUELEQgIG4jOBAKLBbGhVrQBpcPy0oINWOUDOJ1J2woUdUZa8yLSdskaxHaiaWWiQZQxwFLIImXKpfBRj8FJV2BKElsJtUhJYWIKDm/cWN+kkM0wu+JfRuRSw7h2Tiu/sdzoKtdzFYg50cpZ+esakYw9n07RUQoHKbxK4XUKw/0UhqMUhgcpDF+lMHydwmg/hdEohdFBCqNXHq3R60Br0RC4i8Bw5Kns/jjUJcX7nbQs2qQxbaOE5z0lfK6GA9jZaQSKm3/++edzdXuuAM4TErDz5PA8aUDOkxR8H+nN8+RwmEJouDlPDuHF6OsIsKDvV0Rd/z2n7yGdhv+e0fdoeK6WYdERI+NEWd2DCHX/9kjEz8BP1MgrU1vUbdRISsnDUg+dG7U2aFHHst3QC9qQVNJJUdjNe4oQT29bLWYrOzugnTH3bt4Wdz+9PUW0Yg8rT9/FyrbTFdUAIzJaIcHLQXvdbKCAX/SpESBg9aX7f0X7b3TWZiI0IE+PEl3UvpQcXw/YPmC9vZkYAeDpkaJF7EsJ8ZoIQffWZipQ79MjQcAqdgRbwPftH+wOX+6O9kcHPTKQG+UBynI3z3cXi8UXkhCYYGQehfXZ2gzWrDcCyYOdGF2ucVXYk2ihgvnEv6N5/z0Z9eNo72JOPiI7IdG4abzDrkXudC4Wz6yfKg5t7DiCb624RQdN7iI82FPOZlpmAXmCidbbmJzBARFhlwif733//V6HlL5xtywjfSG20vcuk77bWpaDPB+swvZOqNNaQp6nsKZ9fUeeQ1mWm9p9B12X5+rPJAjBdNssCwHg9xGHNVzfrr9RVtoOkWtV8Prs3a2XlZX7ZSZV6Ah8AysABqd1IQzekJtqpVZMl99AE61IURSi1sxnr5YdQo4ZeErAV8fBlH8eGJx20J+AWh4ed2dj3UkMTvGG58hq63RJyMhc0Awp2DqbkdMnosdAZG/jO/yViUpSdKFA57gVXTZYh4Q/tI5nToe66phbdL3NCAtx5BrfnE+fHY3hPt97wS+55+ILEE9P7Xcwi50+2kHdZ+dJKYLpkkyw/a3dDM15ctGM8T455p2xsG4wXNwjT9AKTY6FGGNxV9YeLQ3d7QTO6hCHOkqpmlACo7wfMeBecbPSGzqXa+TMb7vL4FG5RzGJdIZC2hhP6ROtOzoEnDgMqBA5sjhGiAMoaBul+EtZvkHsETwfFUI4nQdWIDhgwCbWFxe7R6hohd7JdOlCc5RSybIum6DlpJk1UqwMl3yXXDSSQuFxhe7p3llB3DywAkUINy9wroYcWYgxCdYLsN4WDCBPTzF0MHv4BvwcldG7NT/3vvt0QYz76grimmuSQP0F2Qih3SyFAzimS4kipn4QhcCyDCtH4bIvFdEG5cddS0OOJHVDZJsvpi7U782Dm5jpMdy5gvdvxocB7stsL6La45ixu40/EEP20H60reTjgaV/htoUDCyZ9Z6aMgxordz8SZroit5UpVZHeXKY5PQKG58Nk5SnRuu+0fkiObxNQgSffob4OI3c+2jpGfc2sdkMS0G/Ikr08Esvr0macKCG3n6JVMlhoscfMaM1KkM4OImWRjL04W2E8g+WSRqc9eQw8S+ZSZrgjSgrAk5WnnqrfJIs44L3TdW0tFNZ/tG8nNI8vbfqz5rtXWeGZZrQI+NnzvQDDeW9lXiq32pqdPhOLGxnQn/rJ6uv7DSGZCALoyAXC0tiVVtvn2WiyOqC/H68qaRZNEEIdv47XNEg2qzUIDp8uUz5tQFNFyVhjFgkaSIdlt32DUxg9KefXIaaKMPh4U8d+1HjGPEvoYFe9fmcRPnJWHzUCGPkM6pmWn3y+OHoxXA0fDEc0Qzhtefz6eh772LQZ4w35KViHm323faFNgV+GBk8xJwRnrctpvgwM55uernvvBfama6LnF7iUJgBP6B/dm5Gn7+bq2jwADcv0+Tm4c3cQKZ3Y1oAfFXgxEFdVWgg00ahed6N9z2ZzY0ODpZpsnh4e4s/5Pa+psObP7y7nzifos01+U/g+uL1Mk1mD+P6tybj4z+I7MGrZXu7JplB4TBeDpdjnS8uo95aPgQYLwqCm+giR0NWyF191aoa0jCUqXS5qufHWhco1BpF03vpDzllZBOSORgC3vMZklHdmoo8e2udBuPRY0vZA7gSg5SWbEBT43kygKNJx9bluMFqskGE5Yd/peEZr3dpa1bjz/bCN9HoWTerihJd2kB/RIGBwWFZFZyWNJdFQXjTvT6A5h+bew0lCYF4XcaFH74q3vpYJy8YBvVzeiBYjAN4K1ST1tFPn4Db24YNmDuWS7i9pVNFc0mX7nKZtg20Vq+B71XfYjBDed0b1TRhO7Bp6wz1Js4lmTi+IbygdRGQUyXV9LI2xXI5uMOG7Rk9mm53yBTOjib5f0AxQudIHZsczSMk92ji3TUNz4hZn4W4OVNGGuuCPHp2Dwj7p7ANVA7ZEOTlfdvIt63HlqBUnK+VH2fkdIqUuxggeHBINkKRzbxmYKzEhESb8xENXktd24jeTNjG5M4JQnpxkWra9zY71OFcsO7eB+tEV1F20vHpySNoyb7wrtdE3oX0u/RzwPHpCWU4yknw6AbwwTaUiKQVPRAgXwuupYhJUI35tvDhS1RMEa82e+mog5BbuAt3EcqlXYtR2r6lNPnAdyZuU2DpiHTtKPdWhrwu67CyPToyFg0hT3X9GK58gJICpjU/yzq6laNq5PedNkNRKutM7UO3kNcmJmUGtiDIDK1t6RSpQkCd+VNAZf1wARNhHZoUaiWJ8qamSEkzJd5UaCSqDNeSwKAnHUnuw9qsn+334cfvQuJz3EMUyjFJoJ8Yc6gr5hqWhCYNNZ7c6tY3aNuOynsYTU4X1SZIfwjgV2isVtSszVQo+avnZu05aYwzUUzYwGoe5/nSRZVHnGm2Pn7Rwvr3P/9FqDKnXpY6b7jXPp6xTigh2NlGGTnNCeRYoM92j0+LjZKzaVRsNrhr9MJo+CWQt6Ur2g/eSOs6yYsxb+CuUP6IRM+sgwOb9yRKxGhq0ZWqBq+QJNlOx4aX7Ce+NublCgN2zMReBMrfrmxGthGloP4omVsr6x3d0f4+/elTtCkmCKYn0Y6Ya1IXxeJPSfr4cNb9XnaDrVxrvN7nOc8+ytGvN9n16IQYZ4Pw3TtBMPRrU1CJAPHpbnMGHMfo0FaqQiq8ZBJf5jq7NGgvR/v7l0Oi8TJNDtaR8b0u0c2YdYiYc6OpgqAqUFBGu1mAmAqpgGxP8xtSFY3R5n5n4NMwW0OJyEOXBz0ivLxLhCPFr7Bcl3Kqr1D9vjvtLu/88oTqTckM49VhIj0Q9ye9zXbb/SYtZrWRbpEcnt0mN7uikru+//DsYnmRJkRYTRHhSlvGWLhZcpjsrQaILZprDvWd3Xr2bTjSCpXTQ+kd91NUcu96mCzT1RFrndWN0NaJqVTT3XtHXbQ7fU+n4Qne228bW6vk35GCa4GcXag0kcQFMxRkuxIB6ZB/bKPj38ajihHsdUHp9khWw8yrl8GawHGMG/dCwesjwcOXnRjsWQyncoS0CZCui3k2W49RzCaI2YlLdsKSZy3LNhHAGAAccuRsdHDAIaavhxyLefGawxwHr5bMZK3LnyR9t56fMVad0yTpO11xUONShFGtXeyf5XoGXmjqGzztzD0Do3exb7jXowUl1UQzM4UTPq5QvScDlUT2eng37IRFpsumuCCC//uf/+IRkTN4mT/BcW2g0nM0k9pXKEwKvJFkEnYK5WJQA0VZoLXFAsgSnHLJXC6nnG0U7axMVGIsC0k6iMC0D/J31JgdwE9tWOSZ8YlX11iQ6oJCa64gI/OkdrrkNeJ9O9fmakIopSBgTEVHaMmhwTgE1UyojMwqL5tssFDFHFmulZEWQciSgMmCxslEZpIvcq2cEZmDUigxZcsj5fAXUaGKJUNGj8kBsbqovYlNhUuIzm+R3x0H8I5cGt44P26gE7LA3FvXNvXeTZCNUJE3Jk+youVlhrZN1yzwGg3rIu+b1kUBlXbeXyTTq3u2NJEzQlm61MPDSjiahnzBBuY1crEYAD0+0l1Hrg8xQCHVla+fO2vY7CccW+mwDf3N5/M7evF5f8xfpZvVYzBY6XbclBtZi3aHNx/PSemgKe3x5D2aa5lFM2TDmnsMvBeuS+GjTFEJiUr+ZXUAXV2FzFBZ7Fxub/568h1cw4vBfpJ2boJHILz33dHbb394/y3NS3eVl7/hYH+wz+8V2rpSqM5S/VLUVcntvIJuC1e3havbwtVt4eq2cPUPU1q5LVzdFq5uC1e3havbwtVt4eq2cPUJkGJbuLotXN0Wrm4LV7eFq9vC1W3h6rZwdVu4ui1c3RaubgtXn0ad4LZwdVu4+qQYclu4GgtXQ+YJ2Y17VSGk6mTQ+Wyls5Vy1os0mVE20+FZcntL74ofKE2dmn+p0VAq1EWaXAsjKXjOiVBpzPihVJcrpJyTt/4tYPeUlk892/ND9kr+FyUs+RFv+PDvhe0mXJ0cvz9N0iTWFZQ6pzFGzKkcV8yTw4R0NlfuNqml3H6bFEJNa86+Sfy8lKgkajfrZzldcZZT+NFJ4hFq0cGyn/7kt0L/08bWDvgvevr+Oy7+uwH3PRsHBNpGaDrBi+Vy+X9W+805",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with base64 encoded file.",source:"@site/docs/API-docs/draftdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/draftdocument",permalink:"/docs/API-docs/draftdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztO39zGzeuXwW3/6TxrGVLcdKc582bS5O+O79ra0/jTOfG9rjULiQx3iW3JNey6tF/90nuo90neQOQ3B+yZDtJp+fOU/6ItSRIgiAAAiBwmzgxtcnhWfJOZ3WJytnkIk1ytJmRlZNaJYfJ6QzhnRETBxEI3pwcgSgKPbdQWzQWnIYpKjTCISicQx6ng/ECKqOvZS7VFHLhBMylm8FYWHx1AKgynWMOE1ng4Fydq1NZHcKHqtAih4WuDZy8+59mNlqG2s52dt7huJ7Ch6OdnYuvZs5V9nBvT1TVQFeorJyqQoztINPlXk6AVT55nsJ8hgZpVsiEAhRWFgsQeQ5zmU/R2RTcDBVkulpAprXJpRIObQqVmCKouhyjsSkIlUOpDYJUIMCgyBe7Tu/WFuF/3x//ABNtSuEGcFLUNm2Wy6XBzBULP72bYbOrZzZSwzoj1TSFUlwRtaSDX2qZXdG2Laqc/tLANydHTKudnfd1VWnjMIef/BYOd3ao5xss9ByEQYbPdFlqBZUwokTHxzUTjrsN/lJLg7k/FFEUkRaH52oXdnbcosLDnR04UrnMiBg8IbWCngTYgQclIhHo+wozOZEBtEM60ArmM5nNmCZz4c+zKkTm0TRoK8ycvMb+xDcpLGjid6h0xGCmjfxVKycKPo5rNE5mougeGyFIoNYJ44iclZbKxdawAvwjHA+dHh9K4CtCLSdilVJxj0W4FkWNNmA1T2FGWP2IlUHLrB7mJUKqHGYop7ON64n8Y21db2KoLaHZxSKsFU+JyYtMtokoLIKc9GhZiivsrAaaRVgUA/hmATlORF24FCRxnDM1DuAH7UBUVSEzMS6QOBdIeISrDe7yKQd2CIgoUfIZn7BEowUBuZxM0JBwUidPEcZE7IjPWhXAkuNmQoFWKwed6UIbmn6Fh7i9T0jItHKo3ADeXAtZMPZ+txakyoo6RxgXIrtKYVzUmILB3EvuAklvpUELEQgIG4jOBAKLBbGhVrQBpcPy0oINWOUDOJ1J2woUdUZa8yLSdskaxHaiaWWiQZQxwFLIImXKpfBRj8FJV2BKElsJtUhJYWIKDm/cWN+kkM0wu+JfRuRSw7h2Tiu/sdzoKtdzFYg50cpZ+esakYw9n07RUQoHKbxK4XUKw/0UhqMUhgcpDF+lMHydwmg/hdEohdFBCqNXHq3R60Br0RC4i8Bw5Kns/jjUJcX7nbQs2qQxbaOE5z0lfK6GA9jZaQSKm3/++edzdXuuAM4TErDz5PA8aUDOkxR8H+nN8+RwmEJouDlPDuHF6OsIsKDvV0Rd/z2n7yGdhv+e0fdoeK6WYdERI+NEWd2DCHX/9kjEz8BP1MgrU1vUbdRISsnDUg+dG7U2aFHHst3QC9qQVNJJUdjNe4oQT29bLWYrOzugnTH3bt4Wdz+9PUW0Yg8rT9/FyrbTFdUAIzJaIcHLQXvdbKCAX/SpESBg9aX7f0X7b3TWZiI0IE+PEl3UvpQcXw/YPmC9vZkYAeDpkaJF7EsJ8ZoIQffWZipQ79MjQcAqdgRbwPftH+wOX+6O9kcHPTKQG+UBynI3z3cXi8UXkhCYYGQehfXZ2gzWrDcCyYOdGF2ucVXYk2ihgvnEv6N5/z0Z9eNo72JOPiI7IdG4abzDrkXudC4Wz6yfKg5t7DiCb624RQdN7iI82FPOZlpmAXmCidbbmJzBARFhlwif733//V6HlL5xtywjfSG20vcuk77bWpaDPB+swvZOqNNaQp6nsKZ9fUeeQ1mWm9p9B12X5+rPJAjBdNssCwHg9xGHNVzfrr9RVtoOkWtV8Prs3a2XlZX7ZSZV6Ah8AysABqd1IQzekJtqpVZMl99AE61IURSi1sxnr5YdQo4ZeErAV8fBlH8eGJx20J+AWh4ed2dj3UkMTvGG58hq63RJyMhc0Awp2DqbkdMnosdAZG/jO/yViUpSdKFA57gVXTZYh4Q/tI5nToe66phbdL3NCAtx5BrfnE+fHY3hPt97wS+55+ILEE9P7Xcwi50+2kHdZ+dJKYLpkkyw/a3dDM15ctGM8T455p2xsG4wXNwjT9AKTY6FGGNxV9YeLQ3d7QTO6hCHOkqpmlACo7wfMeBecbPSGzqXa+TMb7vL4FG5RzGJdIZC2hhP6ROtOzoEnDgMqBA5sjhGiAMoaBul+EtZvkHsETwfFUI4nQdWIDhgwCbWFxe7R6hohd7JdOlCc5RSybIum6DlpJk1UqwMl3yXXDSSQuFxhe7p3llB3DywAkUINy9wroYcWYgxCdYLsN4WDCBPTzF0MHv4BvwcldG7NT/3vvt0QYz76grimmuSQP0F2Qih3SyFAzimS4kipn4QhcCyDCtH4bIvFdEG5cddS0OOJHVDZJsvpi7U782Dm5jpMdy5gvdvxocB7stsL6La45ixu40/EEP20H60reTjgaV/htoUDCyZ9Z6aMgxordz8SZroit5UpVZHeXKY5PQKG58Nk5SnRuu+0fkiObxNQgSffob4OI3c+2jpGfc2sdkMS0G/Ikr08Esvr0macKCG3n6JVMlhoscfMaM1KkM4OImWRjL04W2E8g+WSRqc9eQw8S+ZSZrgjSgrAk5WnnqrfJIs44L3TdW0tFNZ/tG8nNI8vbfqz5rtXWeGZZrQI+NnzvQDDeW9lXiq32pqdPhOLGxnQn/rJ6uv7DSGZCALoyAXC0tiVVtvn2WiyOqC/H68qaRZNEEIdv47XNEg2qzUIDp8uUz5tQFNFyVhjFgkaSIdlt32DUxg9KefXIaaKMPh4U8d+1HjGPEvoYFe9fmcRPnJWHzUCGPkM6pmWn3y+OHoxXA0fDEc0Qzhtefz6eh772LQZ4w35KViHm323faFNgV+GBk8xJwRnrctpvgwM55uernvvBfama6LnF7iUJgBP6B/dm5Gn7+bq2jwADcv0+Tm4c3cQKZ3Y1oAfFXgxEFdVWgg00ahed6N9z2ZzY0ODpZpsnh4e4s/5Pa+psObP7y7nzifos01+U/g+uL1Mk1mD+P6tybj4z+I7MGrZXu7JplB4TBeDpdjnS8uo95aPgQYLwqCm+giR0NWyF191aoa0jCUqXS5qufHWhco1BpF03vpDzllZBOSORgC3vMZklHdmoo8e2udBuPRY0vZA7gSg5SWbEBT43kygKNJx9bluMFqskGE5Yd/peEZr3dpa1bjz/bCN9HoWTerihJd2kB/RIGBwWFZFZyWNJdFQXjTvT6A5h+bew0lCYF4XcaFH74q3vpYJy8YBvVzeiBYjAN4K1ST1tFPn4Db24YNmDuWS7i9pVNFc0mX7nKZtg20Vq+B71XfYjBDed0b1TRhO7Bp6wz1Js4lmTi+IbygdRGQUyXV9LI2xXI5uMOG7Rk9mm53yBTOjib5f0AxQudIHZsczSMk92ji3TUNz4hZn4W4OVNGGuuCPHp2Dwj7p7ANVA7ZEOTlfdvIt63HlqBUnK+VH2fkdIqUuxggeHBINkKRzbxmYKzEhESb8xENXktd24jeTNjG5M4JQnpxkWra9zY71OFcsO7eB+tEV1F20vHpySNoyb7wrtdE3oX0u/RzwPHpCWU4yknw6AbwwTaUiKQVPRAgXwuupYhJUI35tvDhS1RMEa82e+mog5BbuAt3EcqlXYtR2r6lNPnAdyZuU2DpiHTtKPdWhrwu67CyPToyFg0hT3X9GK58gJICpjU/yzq6laNq5PedNkNRKutM7UO3kNcmJmUGtiDIDK1t6RSpQkCd+VNAZf1wARNhHZoUaiWJ8qamSEkzJd5UaCSqDNeSwKAnHUnuw9qsn+334cfvQuJz3EMUyjFJoJ8Yc6gr5hqWhCYNNZ7c6tY3aNuOynsYTU4X1SZIfwjgV2isVtSszVQo+avnZu05aYwzUUzYwGoe5/nSRZVHnGm2Pn7Rwvr3P/9FqDKnXpY6b7jXPp6xTigh2NlGGTnNCeRYoM92j0+LjZKzaVRsNrhr9MJo+CWQt6Ur2g/eSOs6yYsxb+CuUP6IRM+sgwOb9yRKxGhq0ZWqBq+QJNlOx4aX7Ce+NublCgN2zMReBMrfrmxGthGloP4omVsr6x3d0f4+/elTtCkmCKYn0Y6Ya1IXxeJPSfr4cNb9XnaDrVxrvN7nOc8+ytGvN9n16IQYZ4Pw3TtBMPRrU1CJAPHpbnMGHMfo0FaqQiq8ZBJf5jq7NGgvR/v7l0Oi8TJNDtaR8b0u0c2YdYiYc6OpgqAqUFBGu1mAmAqpgGxP8xtSFY3R5n5n4NMwW0OJyEOXBz0ivLxLhCPFr7Bcl3Kqr1D9vjvtLu/88oTqTckM49VhIj0Q9ye9zXbb/SYtZrWRbpEcnt0mN7uikru+//DsYnmRJkRYTRHhSlvGWLhZcpjsrQaILZprDvWd3Xr2bTjSCpXTQ+kd91NUcu96mCzT1RFrndWN0NaJqVTT3XtHXbQ7fU+n4Qne228bW6vk35GCa4GcXag0kcQFMxRkuxIB6ZB/bKPj38ajihHsdUHp9khWw8yrl8GawHGMG/dCwesjwcOXnRjsWQyncoS0CZCui3k2W49RzCaI2YlLdsKSZy3LNhHAGAAccuRsdHDAIaavhxyLefGawxwHr5bMZK3LnyR9t56fMVad0yTpO11xUONShFGtXeyf5XoGXmjqGzztzD0Do3exb7jXowUl1UQzM4UTPq5QvScDlUT2eng37IRFpsumuCCC//uf/+IRkTN4mT/BcW2g0nM0k9pXKEwKvJFkEnYK5WJQA0VZoLXFAsgSnHLJXC6nnG0U7axMVGIsC0k6iMC0D/J31JgdwE9tWOSZ8YlX11iQ6oJCa64gI/OkdrrkNeJ9O9fmakIopSBgTEVHaMmhwTgE1UyojMwqL5tssFDFHFmulZEWQciSgMmCxslEZpIvcq2cEZmDUigxZcsj5fAXUaGKJUNGj8kBsbqovYlNhUuIzm+R3x0H8I5cGt44P26gE7LA3FvXNvXeTZCNUJE3Jk+youVlhrZN1yzwGg3rIu+b1kUBlXbeXyTTq3u2NJEzQlm61MPDSjiahnzBBuY1crEYAD0+0l1Hrg8xQCHVla+fO2vY7CccW+mwDf3N5/M7evF5f8xfpZvVYzBY6XbclBtZi3aHNx/PSemgKe3x5D2aa5lFM2TDmnsMvBeuS+GjTFEJiUr+ZXUAXV2FzFBZ7Fxub/568h1cw4vBfpJ2boJHILz33dHbb394/y3NS3eVl7/hYH+wz+8V2rpSqM5S/VLUVcntvIJuC1e3havbwtVt4eq2cPUPU1q5LVzdFq5uC1e3havbwtVt4eq2cPUJkGJbuLotXN0Wrm4LV7eFq9vC1W3h6rZwdVu4ui1c3RaubgtXn0ad4LZwdVu4+qQYclu4GgtXQ+YJ2Y17VSGk6mTQ+Wyls5Vy1os0mVE20+FZcntL74ofKE2dmn+p0VAq1EWaXAsjKXjOiVBpzPihVJcrpJyTt/4tYPeUlk892/ND9kr+FyUs+RFv+PDvhe0mXJ0cvz9N0iTWFZQ6pzFGzKkcV8yTw4R0NlfuNqml3H6bFEJNa86+Sfy8lKgkajfrZzldcZZT+NFJ4hFq0cGyn/7kt0L/08bWDvgvevr+Oy7+uwH3PRsHBNpGaDrBi+Vy+X9W+805",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Self Sign",permalink:"/docs/API-docs/selfsign"},next:{title:"Create Document",permalink:"/docs/API-docs/createdocument"}},g={},j=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Draft Document"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/draftdocument"}),"\n",(0,i.jsx)(n.p,{children:"The Draft Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": { \n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "readonly": false,\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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. \n",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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'.",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"name or email of the person or organization on the behalf of which you are sending the mail.",example:"opensign\u2122"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"document_id",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-send-document.com"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "document_id": "hji2zxcv2P",\n "url": "https://url-to-send-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/ae010e44.1e68d98f.js b/assets/js/ae010e44.a965d111.js similarity index 64% rename from assets/js/ae010e44.1e68d98f.js rename to assets/js/ae010e44.a965d111.js index 658a09e74..86b432e42 100644 --- a/assets/js/ae010e44.1e68d98f.js +++ b/assets/js/ae010e44.a965d111.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4930],{80204:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>f,contentTitle:()=>u,default:()=>b,frontMatter:()=>p,metadata:()=>x,toc:()=>g});var i=s(85893),a=s(11151),l=s(58219),r=(s(62316),s(51039)),t=s.n(r),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),h=s(85162);const p={id:"selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",sidebar_label:"Self Sign",hide_title:!0,hide_table_of_contents:!0,api:"eJztW1uPGzeW/itn+OK4UVK35LbjFRaLcezsjHeS2Eh3EAxajQ5VdaSim0VWSFZLSkPAPOzPmHnZn5Zfsji8VJXUNzsOZnqx8oOt4vWcj4eH5+Zr5vjCsskZe6PzpkLlLDvPWIE2N6J2Qis2YaclgkU5t2Kh4NX7t7BAhYY7tMDhh++/AVdyB6j4TKKFuUG0bi0RaLxQC9Bz4FDE9YfwV91AzhVwaTUIlcumQNB+My6hNjgocC4UFrAUxQKdzWBZirwEV4Y10fj5WAgH2gCuaq4KaGqtgFtQiAUWQzgthYXa6CtReEITNbiq0QhUOS1WCckNOO3X/vVvfz8hFv+qG0P8/vq3f8Bc6iUI5fvf1aj8AF7Xw6maqlNRT+CHWmpewFo3Bt6/+c+WUVqV2s4ODt7grFnAD28PDs6/KJ2r7eTwkNbQNSoiS/KZHea6OixoYF3MnxLLaJBWDbxyK+QaeNEDxZWoINf1GnKtTSEUnUgGNV8gqKaaobEZEDKVNkg8cDDIi/XA6UFjEf7r5N13MNem4m4I72Vjs3a7QhjMnVyH5Yn3xNUTCzNu8cUxWGeEWmRQ8UuCVTj4uRH5JbFtURUJ1Ffv33qsDg5OmrrWxmEBPwYWJgcH1PMVEsbcoB+f66rSCmpueIUOjQ3SRd0Gf26E8XLhSuBSJiwmUzWAgwO3rnFycABvVSFyL560ILWSCIaxwzCUQKKhJzXmYi7i0B50oFWUOsJkycN51pLngUyDtsbciSvcXniVwZoWfoNKJwpKbcQvWjku/XFcoXEi57J/bESgF2/HjSM4ay2US61xh/bm0On5Q4lyRaQVBFYllO+xCFdcNmgjVcsMSqLqe6wNWrrlaV0CUhVQoliUd+7Hiw+NdVsLQ2OJzD4Vca90Sh5e9LDNubQIYr6FZcUvsbdbqwGG8NUaCpzzRroMBEmcMw0O4Tvt6OZJkZOiIcn1d5q7xuDAn3IUh0iI4pU/4/edDijEfI6GLid1+iXinEQdyVlQGsSevzmu5Aq02jnoXEttaPkdGfLt20BCrpXzqu/VFRfSUx+4ta3+m0meX2Ywkw1mYLAIN3eNUuplFgTeDyENF0D3AJFeJjHUihhQOm4vLNhIVasJ04Wizlbb0ibC9mGN13auaWfCIN0xwIoLmXnkMvigZ+CEk5jRja25WmdQcIcZOFy5mV5lkJeYX870KgI218pZ8cst1y71fDpq4wyOM3iRwcsMRkcZjMYZjI4zGL3IYPQyg/FRBuNxBuPjDMYvAqbjlxFP3oLYJ2A0Dki6x4UgKdBvhPVXlDSfbZXpckuZTtVoCAcH7cXwzT/99NNUXU8VwJTRRZmyyZS1Q6Ysg9BH+m/KJqMMYsNqyibwbPxlGrCm7xeEYPhe0veIEA/fJX2PR1O1iZuOPTGOV/U9hFD3709E+owyQ41+Z2pLOooaSbmEsdRDZ0OtLVnUsekYekYMCSWc4NLezVMa8fjY6ijb4eyYOPMSejdbvvvx8ZTISj1eCYYurzR7Xemqe0LGOxA8H3bPxh0IhE0fGwCRqs/l/wXx3+qlu0Fohzw+JPqkfS4cXw79O+91891gxAGPD4qOsM8F4iUBQW/T3ShQ7+ODIFKVOuJ7H/qOjgej54Px0fh4CwZyh8KAqhoUxWC9Xn8mhOABIxMo7u+txmiVBmOOO4S50dUtLof3CLpR0UTyv5OZ/i0Z57Nkt2KR/NXWgGm9vL5l7XTB109sWCpNbW01Gt9Zausemb6L6PAeb15qkUfiaUyy0Gbk1A0JhAEBXxx+++1hD8rQOKiqhC+kVvoeeOj7rVU1LIrh7titE+q1VlAUGdzSfntHUUBVVXe1hw56Lqfq3+giRPPs7rsQB/xzr0Mn9N32D18VCghoJf3+3ku7/a7svC+lULEjyg3sDDC4aCQ3uCJ30wqtPC6/gybauUXpEnWmvPdOvWPnff8ABXzxLprrT6OAEwfbC1DLw/NuMNZfxOACV36NvLFOV0SMKDitkIFt8pKcN568AoK9i9P4r5zXgqIEEp3zrejy4W1EhEPredh0qrsOtkW3xQy3kGbe4mP70/eOxujIv3vR97jn4YsjHp/a71GWOkPUgrrPpqzi0XRhc+x+a1eimbLzdk7wrbHozYXbJsN5dvd9gu7SFCj5DOXNu/Y5tyEQ1xfDpIKTMCc0QAqbohfbrPVnx/COD7pRKJUkaYaQJsCsFZzPFsyWsI+TzHBvI4gPbEHjwA9sQ2utM32v7HvvWVQhPHiXc1d5OX9sUh/J2pERljFdU7ReaPW2YBOWIvks86uidV/pYs0m1ywGXOhnDGfQpMMPlrIA18zmJVacfiVqKG8wFxJZxkJc3rKMeeubkgiEF5swPfuAuWMZvRU1hT7R0hp+3uQ6jQrRZJZFC4xNWAgzs4zhilc1DY5NgCrXZObUxZxt0ob3LdW2dEtZ/6MNa9M6W0mP37Tam94Km4xRBPg3rvQdTfW8VXiqX2tqdPiGr21vwfB4sN10Dc2hO5DHWVDwtaUYVWPDdc65zBtJxhyuamHWrWXpLboWkh6h7U4toaPnm3ToPYruOGujP/2ActQEgHftP3XuB40zxD/GBsqs+OPg1SdT8UEjzNAfRV1q9cnzR+Nno/Ho2WhMK8RIXW8Nbgxfs4wJh5V9GMfQe5OC7fN/RRYGFkmTD7ooeQY+qDV8SAbTeM82X+DDMnd6V/akF8+1pW5kQZFS5Gbokxi/OT+2Lca0ied2+IDQbjK2epiZFeR6kFIz8IXEuYOmrintqI1C87Tvqz0a5sbHx5uMrR9mb/1/kr0v6fCWD3P3o89pdfm+fwWtz15uMlY+TOuf26zbv5DY4xeb7hFluUHuML0BFzNdrC+S3tr0ByYzYntofBE2tKMs0JDFcVNfdaqGRlK2+GJXz8+0lsjVLYpmKxPjvSnrTT8yLGOwYlki2fKdRehXt60pG83QYLJQdgd3/Edhyd4zDU7ZEN7OOyyDMbmbDEpjfTJIaXji97uwjVfjTw7jNyH0pJ/ZpmRjF6RJJPjB4LCqpU8NL4WURDc930No/3jTrkWSCEjPZdr44afidfBT/YZx0nZeFaKJOITXXLVpt+30Flxft0LgpWOzgetrOlU0F/TobjZZ10B7bTX4dzW0GMxRXG3Napuwm9i29aYGS+aCLJnQEKOffQJCAchFY+RmM7whht0ZfTRuN2CKZ0eL/H9AzFf8nOrGfMTF9V7aIFye4OEEwQ6LAIdF42OXjtRfkkEfBOnS8UJZZ5o8uLdFY1IFQirtqY3O0dphLDgYQCFsSMmW2F8/A1Q2TOcw59ahyaBRQjk0pqnJzb1ZLbTFv9/gQXUYNGbnLcVLSrUjWtlg042PjuifbbBSMRZEdUzRI+Js3ki5/gPLPt5Vu9+gDM23K+n7LMTygxj/ssqvxu9JDhrzyRZ6etAaI6kciZAbtBVi3l7vYSuUFAovEmwX46OjixFhu8nY8W3wnegKXelT7wTi0mgqVKolciqcMWvgCy4UkHo1vyOaaIw29793n0bZfSAcb4Hw/CYIb5UPP/qCvVN9ieqfy2l/exe2J1JXlZeV4IsxEQb5frbFbL89MGkxb4xwazY5u2arAa/FIPRPzs435xkjYDUFOGptPcXclWzCDnvxDovmioIUtIIX2lYOLVcFxYZuGFe8FodXI7bJdmfcaordOdo6vhBqMbh31nnH5AkdRMB6i9XOc6zFX5Bcx4hkf1TGBAlAibwgW2yTMTrf77tgz9fplFIY5rbISk+37cRKdlX7LdGPFPzYimfcHs4YPe8HEkKowHv/rfN/mz/fMp489NZB7/ncPZf7rJPV1rtNzu3Ie4Xj42PvPn058n7Gs5fehD9+sTnfsmYZ27ZYfTRu1+5ibNue8N+91zI8H3ROc+0PNSLdVpjSrbka3XRuUOa6akuM0vBf//t//Ix0Qv5S/wHeNQZqvUQzb0Kd0lziStB7SIN3TGfklURr5RroGVxQeS8UYuHzEekxzHnNZ0IKUgM0TIeIUU+T2CH82BnfT0xIzVyhJO0BUmtfK+o08Mbpyu+RnrqlNpdUbUtFqzCj8kK0FiximoKq5L5qN96RjIp/qTaWnu3aCIvARUWDyXzA+Vzkwr+hWjnDcwcVV3yBtFnmnSxCoS0QNnpGaVSrZRPsCypRRHSBRYqE2yG8oXpPz7iPlKHjQmIRTAtLdVwFxdS8lMba2xlZhTVtL3K0XUJX4hUarxOCbdhICbUm3Sy4JC+jf7a0kDNcWXpSY5QuHk0LX7R9/B4FXw+Bwtn03JDfQAIghboMlbJnrZj9iDMrHHYO5nK5vKGfnm7P+ZNwZTMDg7Xu5i18o9dm/entx1O6/Ggq+25+guZK5MkIuGPPQz/4ML5YPPgySR3wWvxxdwK9HlLkqCz23pdXf3r/DVzBs+ERy3oa+SMIPvzm7euvvzv5mtalNyPcv9HwaHjko2Lauoqr3lYnKOdwEt6ZnUhy++juK+n3lfT7Svp9Jf2+kn5fSb+vpN9X0u8r6feV9I+Lp30l/b6Sfl9Jv6+k31fS7yvp95X0+0r6fSX9vpJ+X0m/r6TfV9L7cquYQiQ9cFhLLlSv/CHkm8+6+vrzjJWUip6csetrCvX+QGU01Pxzg4by2OcZu+JGUKzDZ7GzlLOldOUlUuLwdQjdDE5p5yxcPp8C2UneU8o5zHiV51i7e8f2s+Xv352csoyluqdKFzTH8CX9/wC+ZBNGz43/XwQeTJ+k5b4QU3K1aHwGlYV1KdXMG1du56kvfZ46/uglYrla96jcTmAHVuhvYuzWCf9O+ZO/4Po/2uGh584JEds0mg7vfLPZ/C+TbRqp",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",source:"@site/docs/API-docs/selfsign.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/selfsign",permalink:"/docs/API-docs/selfsign",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",sidebar_label:"Self Sign",hide_title:!0,hide_table_of_contents:!0,api:"eJztW1uPGzeW/itn+OK4UVK35LbjFRaLcezsjHeS2Eh3EAxajQ5VdaSim0VWSFZLSkPAPOzPmHnZn5Zfsji8VJXUNzsOZnqx8oOt4vWcj4eH5+Zr5vjCsskZe6PzpkLlLDvPWIE2N6J2Qis2YaclgkU5t2Kh4NX7t7BAhYY7tMDhh++/AVdyB6j4TKKFuUG0bi0RaLxQC9Bz4FDE9YfwV91AzhVwaTUIlcumQNB+My6hNjgocC4UFrAUxQKdzWBZirwEV4Y10fj5WAgH2gCuaq4KaGqtgFtQiAUWQzgthYXa6CtReEITNbiq0QhUOS1WCckNOO3X/vVvfz8hFv+qG0P8/vq3f8Bc6iUI5fvf1aj8AF7Xw6maqlNRT+CHWmpewFo3Bt6/+c+WUVqV2s4ODt7grFnAD28PDs6/KJ2r7eTwkNbQNSoiS/KZHea6OixoYF3MnxLLaJBWDbxyK+QaeNEDxZWoINf1GnKtTSEUnUgGNV8gqKaaobEZEDKVNkg8cDDIi/XA6UFjEf7r5N13MNem4m4I72Vjs3a7QhjMnVyH5Yn3xNUTCzNu8cUxWGeEWmRQ8UuCVTj4uRH5JbFtURUJ1Ffv33qsDg5OmrrWxmEBPwYWJgcH1PMVEsbcoB+f66rSCmpueIUOjQ3SRd0Gf26E8XLhSuBSJiwmUzWAgwO3rnFycABvVSFyL560ILWSCIaxwzCUQKKhJzXmYi7i0B50oFWUOsJkycN51pLngUyDtsbciSvcXniVwZoWfoNKJwpKbcQvWjku/XFcoXEi57J/bESgF2/HjSM4ay2US61xh/bm0On5Q4lyRaQVBFYllO+xCFdcNmgjVcsMSqLqe6wNWrrlaV0CUhVQoliUd+7Hiw+NdVsLQ2OJzD4Vca90Sh5e9LDNubQIYr6FZcUvsbdbqwGG8NUaCpzzRroMBEmcMw0O4Tvt6OZJkZOiIcn1d5q7xuDAn3IUh0iI4pU/4/edDijEfI6GLid1+iXinEQdyVlQGsSevzmu5Aq02jnoXEttaPkdGfLt20BCrpXzqu/VFRfSUx+4ta3+m0meX2Ywkw1mYLAIN3eNUuplFgTeDyENF0D3AJFeJjHUihhQOm4vLNhIVasJ04Wizlbb0ibC9mGN13auaWfCIN0xwIoLmXnkMvigZ+CEk5jRja25WmdQcIcZOFy5mV5lkJeYX870KgI218pZ8cst1y71fDpq4wyOM3iRwcsMRkcZjMYZjI4zGL3IYPQyg/FRBuNxBuPjDMYvAqbjlxFP3oLYJ2A0Dki6x4UgKdBvhPVXlDSfbZXpckuZTtVoCAcH7cXwzT/99NNUXU8VwJTRRZmyyZS1Q6Ysg9BH+m/KJqMMYsNqyibwbPxlGrCm7xeEYPhe0veIEA/fJX2PR1O1iZuOPTGOV/U9hFD3709E+owyQ41+Z2pLOooaSbmEsdRDZ0OtLVnUsekYekYMCSWc4NLezVMa8fjY6ijb4eyYOPMSejdbvvvx8ZTISj1eCYYurzR7Xemqe0LGOxA8H3bPxh0IhE0fGwCRqs/l/wXx3+qlu0Fohzw+JPqkfS4cXw79O+91891gxAGPD4qOsM8F4iUBQW/T3ShQ7+ODIFKVOuJ7H/qOjgej54Px0fh4CwZyh8KAqhoUxWC9Xn8mhOABIxMo7u+txmiVBmOOO4S50dUtLof3CLpR0UTyv5OZ/i0Z57Nkt2KR/NXWgGm9vL5l7XTB109sWCpNbW01Gt9Zausemb6L6PAeb15qkUfiaUyy0Gbk1A0JhAEBXxx+++1hD8rQOKiqhC+kVvoeeOj7rVU1LIrh7titE+q1VlAUGdzSfntHUUBVVXe1hw56Lqfq3+giRPPs7rsQB/xzr0Mn9N32D18VCghoJf3+3ku7/a7svC+lULEjyg3sDDC4aCQ3uCJ30wqtPC6/gybauUXpEnWmvPdOvWPnff8ABXzxLprrT6OAEwfbC1DLw/NuMNZfxOACV36NvLFOV0SMKDitkIFt8pKcN568AoK9i9P4r5zXgqIEEp3zrejy4W1EhEPredh0qrsOtkW3xQy3kGbe4mP70/eOxujIv3vR97jn4YsjHp/a71GWOkPUgrrPpqzi0XRhc+x+a1eimbLzdk7wrbHozYXbJsN5dvd9gu7SFCj5DOXNu/Y5tyEQ1xfDpIKTMCc0QAqbohfbrPVnx/COD7pRKJUkaYaQJsCsFZzPFsyWsI+TzHBvI4gPbEHjwA9sQ2utM32v7HvvWVQhPHiXc1d5OX9sUh/J2pERljFdU7ReaPW2YBOWIvks86uidV/pYs0m1ywGXOhnDGfQpMMPlrIA18zmJVacfiVqKG8wFxJZxkJc3rKMeeubkgiEF5swPfuAuWMZvRU1hT7R0hp+3uQ6jQrRZJZFC4xNWAgzs4zhilc1DY5NgCrXZObUxZxt0ob3LdW2dEtZ/6MNa9M6W0mP37Tam94Km4xRBPg3rvQdTfW8VXiqX2tqdPiGr21vwfB4sN10Dc2hO5DHWVDwtaUYVWPDdc65zBtJxhyuamHWrWXpLboWkh6h7U4toaPnm3ToPYruOGujP/2ActQEgHftP3XuB40zxD/GBsqs+OPg1SdT8UEjzNAfRV1q9cnzR+Nno/Ho2WhMK8RIXW8Nbgxfs4wJh5V9GMfQe5OC7fN/RRYGFkmTD7ooeQY+qDV8SAbTeM82X+DDMnd6V/akF8+1pW5kQZFS5Gbokxi/OT+2Lca0ied2+IDQbjK2epiZFeR6kFIz8IXEuYOmrintqI1C87Tvqz0a5sbHx5uMrR9mb/1/kr0v6fCWD3P3o89pdfm+fwWtz15uMlY+TOuf26zbv5DY4xeb7hFluUHuML0BFzNdrC+S3tr0ByYzYntofBE2tKMs0JDFcVNfdaqGRlK2+GJXz8+0lsjVLYpmKxPjvSnrTT8yLGOwYlki2fKdRehXt60pG83QYLJQdgd3/Edhyd4zDU7ZEN7OOyyDMbmbDEpjfTJIaXji97uwjVfjTw7jNyH0pJ/ZpmRjF6RJJPjB4LCqpU8NL4WURDc930No/3jTrkWSCEjPZdr44afidfBT/YZx0nZeFaKJOITXXLVpt+30Flxft0LgpWOzgetrOlU0F/TobjZZ10B7bTX4dzW0GMxRXG3Napuwm9i29aYGS+aCLJnQEKOffQJCAchFY+RmM7whht0ZfTRuN2CKZ0eL/H9AzFf8nOrGfMTF9V7aIFye4OEEwQ6LAIdF42OXjtRfkkEfBOnS8UJZZ5o8uLdFY1IFQirtqY3O0dphLDgYQCFsSMmW2F8/A1Q2TOcw59ahyaBRQjk0pqnJzb1ZLbTFv9/gQXUYNGbnLcVLSrUjWtlg042PjuifbbBSMRZEdUzRI+Js3ki5/gPLPt5Vu9+gDM23K+n7LMTygxj/ssqvxu9JDhrzyRZ6etAaI6kciZAbtBVi3l7vYSuUFAovEmwX46OjixFhu8nY8W3wnegKXelT7wTi0mgqVKolciqcMWvgCy4UkHo1vyOaaIw29793n0bZfSAcb4Hw/CYIb5UPP/qCvVN9ieqfy2l/exe2J1JXlZeV4IsxEQb5frbFbL89MGkxb4xwazY5u2arAa/FIPRPzs435xkjYDUFOGptPcXclWzCDnvxDovmioIUtIIX2lYOLVcFxYZuGFe8FodXI7bJdmfcaordOdo6vhBqMbh31nnH5AkdRMB6i9XOc6zFX5Bcx4hkf1TGBAlAibwgW2yTMTrf77tgz9fplFIY5rbISk+37cRKdlX7LdGPFPzYimfcHs4YPe8HEkKowHv/rfN/mz/fMp489NZB7/ncPZf7rJPV1rtNzu3Ie4Xj42PvPn058n7Gs5fehD9+sTnfsmYZ27ZYfTRu1+5ibNue8N+91zI8H3ROc+0PNSLdVpjSrbka3XRuUOa6akuM0vBf//t//Ix0Qv5S/wHeNQZqvUQzb0Kd0lziStB7SIN3TGfklURr5RroGVxQeS8UYuHzEekxzHnNZ0IKUgM0TIeIUU+T2CH82BnfT0xIzVyhJO0BUmtfK+o08Mbpyu+RnrqlNpdUbUtFqzCj8kK0FiximoKq5L5qN96RjIp/qTaWnu3aCIvARUWDyXzA+Vzkwr+hWjnDcwcVV3yBtFnmnSxCoS0QNnpGaVSrZRPsCypRRHSBRYqE2yG8oXpPz7iPlKHjQmIRTAtLdVwFxdS8lMba2xlZhTVtL3K0XUJX4hUarxOCbdhICbUm3Sy4JC+jf7a0kDNcWXpSY5QuHk0LX7R9/B4FXw+Bwtn03JDfQAIghboMlbJnrZj9iDMrHHYO5nK5vKGfnm7P+ZNwZTMDg7Xu5i18o9dm/entx1O6/Ggq+25+guZK5MkIuGPPQz/4ML5YPPgySR3wWvxxdwK9HlLkqCz23pdXf3r/DVzBs+ERy3oa+SMIPvzm7euvvzv5mtalNyPcv9HwaHjko2Lauoqr3lYnKOdwEt6ZnUhy++juK+n3lfT7Svp9Jf2+kn5fSb+vpN9X0u8r6feV9I+Lp30l/b6Sfl9Jv6+k31fS7yvp95X0+0r6fSX9vpJ+X0m/r6TfV9L7cquYQiQ9cFhLLlSv/CHkm8+6+vrzjJWUip6csetrCvX+QGU01Pxzg4by2OcZu+JGUKzDZ7GzlLOldOUlUuLwdQjdDE5p5yxcPp8C2UneU8o5zHiV51i7e8f2s+Xv352csoyluqdKFzTH8CX9/wC+ZBNGz43/XwQeTJ+k5b4QU3K1aHwGlYV1KdXMG1du56kvfZ46/uglYrla96jcTmAHVuhvYuzWCf9O+ZO/4Po/2uGh584JEds0mg7vfLPZ/C+TbRqp",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Contact list",permalink:"/docs/API-docs/contactlist"},next:{title:"Draft Document",permalink:"/docs/API-docs/draftdocument"}},f={},g=[{value:"Request",id:"request",level:2}];function j(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Self Sign"})}),"\n",(0,i.jsx)(t(),{method:"post",path:"/selfsign"}),"\n",(0,i.jsx)(n.p,{children:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app."}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "name": "textbox",\n "required": true, \n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signer"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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. \n",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-sign-document.com"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4930],{80204:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>p,metadata:()=>x,toc:()=>j});var i=s(85893),a=s(11151),l=s(58219),t=(s(62316),s(51039)),r=s.n(t),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),h=s(9472),m=s(85162);const p={id:"selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",sidebar_label:"Self Sign",hide_title:!0,hide_table_of_contents:!0,api:"eJztO11zGzeSf6UXL45VQ0qkZcfHurpax87t+jaJXZFSqS1RpYAzTRIWBpgAGJGMilX7cD9j9+V+Wn7JVeNjZkiRkh2ndnV1zIPDARqN7kaj0V+6ZY7PLBtdsDc6r0tUzrLLjBVocyMqJ7RiI3Y+R7Aop1bMFLx6/xZmqNBwhxY4/PD9N+Dm3AEqPpFoYWoQrVtJBIIXagZ6ChyKiL8Pf9U15FwBl1aDULmsCwTtN+MSKoO9AqdCYQELUczQ2QwWc5HPwc0DTjR+PRbCgTaAy4qrAupKK+AWFGKBRR/O58JCZfSNKDyhiRpcVmgEqpyQlUJyA0573L/+7e9nxOJfdW2I31//9g+YSr0Aofz8uwqVB+BV1R+rsToX1Qh+qKTmBax0beD9m/9sGCWsNHZxdPQGJ/UMfnh7dHT5xdy5yo6OjwmHrlARWZJPbD/X5XFBgFUxfUoso0HCGnjlVsgV8KIjFDdHBbmuVpBrbQqh6EQyqPgMQdXlBI3NgCRTaoPEAweDvFj1nO7VFuG/zt59B1NtSu768F7WNmu2K4TB3MlVQE+8J66eWJhwiy9OwToj1CyDkl+TWIWDn2uRXxPbFlWRhPrq/Vsvq6Ojs7qqtHFYwI+BhdHREc18hSRjbtDD57ostYKKG16iQ2ODdtG0wZ9rYbxeuDlwKZMsRmPVg6Mjt6pwdHQEb1Uhcq+ehJBGSQUDbD+AkpAI9KzCXExFBO2IDrSKWkcyWfBwnpXkeSDToK0wd+IGNxEvM1gR4jeodKJgro34RSvHpT+OGzRO5Fx2j40I9OrtuHEkzkoL5dJo3KG5OXR6/lCiXhFpBQmrFMrPWIQbLmu0kapFBnOi6nusDFq65QkvCVIVMEcxm+/djxcfaus2EENticwuFXGvdEpevOjFNuXSIojphixLfo2d3RoL0IevVlDglNfSZSBI45ypsQ/faUc3T4qcDA1prr/T3NUGe/6UozpEQhQv/Rm/b21AIaZTNHQ5adKjiGsSdaRnwWgQe/7muDlXoNXWQedaakPot3TIj28KEnKtnDd9r264kJ76wK1t7N9E8vw6g4msMQODRbi5K5RSL7Kg8B6ELFwQuhcQ2WVSQ62IAaXj9sKCjVQ1ljBdKJpsrC1tImxXrPHaTjXtTDJIdwyw5EJmXnIZfNATcMJJzOjGVlytMii4wwwcLt1ELzPI55hfT/QyCmyqlbPilx3XLs18utSGGZxm8CKDlxkMTjIYDDMYnGYweJHB4GUGw5MMhsMMhqcZDF8EmQ5fRnnyRohdAgbDIEn3uCRIBvQbYf0VJctnG2O62DCmYzXow9FRczH88E8//TRWt2MFMGZ0UcZsNGYNyJhlEObI/o3ZaJBBHFiO2QieDb9MACv6fkESDN8L+h6QxMP3nL6Hg7Fax02HnhjHy+oeQmj69ycifUadoUG/M40lG0WDZFwCLM3Q2dBoQxZNrFuGnhFDQgknuLT7eUoQj4+tlrItzk6JM6+h+9ny04+Pp0RWmvFGMEx5o9mZSlfdEzLcEsHzfvts7JFA2PSxCSBS9bn8vyD+G7u0XwgNyOOTRJe0zxXHl33/znvbvF8YEeDxiaIl7HMF8ZIEQW/TfinQ7OMTQaQqTcT3PsydnPYGz3vDk+HphhgoHAoAZdkrit5qtfpMEYIXGLlAcX/vNUavNDhz3CFMjS53hBw+Imihoovkfyc3/VtyzifJb8UixauNA9NEeV3P2umCr57YgCotbXw1gm89tVWHTD9FdPiIN59rkUfiCSZ5aBMK6vokhB4Jvjj+9tvjjijDYK8sk3whjdJ3z4u+O1qW/aLob8NunFBntISiyGDH+O6JooCyLPeNhwl6Lsfq3+giRPds/12IAP/c69Aqfbv9w1eFEgJaSb+/j9J235Wt92UuVJyIegNbAAZnteQGlxRuWqGVl8vvYIm2blG6RK0r76NTH9j52D+IAr54F931p1HBiYNNBDTy8Lo7jHWRGJzh0uPIa+t0ScSIghOGDGydzyl44ykqILG3eRr/lfNKUJZAonN+FF3e30VEOLROhE2nuh1gW3QbzHALaeWOGNufvg80Bif+3Yuxxz0PX4R4fGa/Q1maDFkLmr4Ys5JH14VNsf2t3RzNmF02a0JsjUVnLexaDJfZ/vsE7aUpUPIJyrt37XNuQyCuq4bJBCdlTtIAKWzKXmyy1l0d0zs+6UapVNKkCUJaAJNGcT5bMRvCPk4zw72NQnxgC4IDD9ik1ppg+l7d99GzKEN6cF9wV3o9f2xaH8na0hGWMV1Rtl5o9bZgI5Yy+SzzWNG6r3SxYqNbFhMu9DOmM2jR8QdLVYBbZvM5lpx+JWqobjAVElnGQl7esox575uKCCQvNmJ68gFzxzJ6KypKfaIlHH7d6DZBhWwyy6IHxkYspJlZxnDJy4qA4xCgyjW5OVUxZeu04X2ompEWlfU/mrQ24dkoevwmbG86GNYZowzwb8T0HS31vJV4rl9rGnT4hq9sB2F4PNh2uYbW0B3I4yoo+MpSjqq24TrnXOa1JGcOl5Uwq8az9B5dI5IOoc1ODaGD5+t06B2K9py10Z9+QDlqEoAP7T917QeNE8Q/xgGqrPjj4OUnU/FBI0zQH0U11+qT1w+GzwbDwbPBkDDETF0HBzeGr1jGhMPSPizHMHuXgs3zf0UeBhbJkvfaLHkGPqnVf0gHE7xnm8/wYZ0731c96eRz7VzXsqBMKXLT90WM31wf21Rj2sRz239AadcZWz7MzBJy3UulGfhC4tRBXVVUdtRGoXnajdUeDXPD09N1xlYPs7f6P8nel3R4i4e5+9HXtNp637+C1mcv1xmbP0zrn5uq27+Q2NMX6/YRZblB7jC9AVcTXayukt1adwGTG7EJGl+ENe0oCzTkcdy1V62pIUiqFl9t2/mJ1hK52mFoNioxPpqy3vUjxzImKxZzJF++9Qg9dtu4stENDS4LVXdwK34Ulvw9U+OY9eHttJVlcCa3i0EJ1heDlIYnfr8rW3sz/uQ4fpOEnnQr21RsbJM0iQQPDA7LSvrS8EJISXTT892H5j/v2jWSJALSc5k2fvipeB3iVL9hXLRZV4XoIvbhNVdN2W2zvAW3t40SeO1Yr+H2lk4VzRU9uut11g7QXhsD/l0NIwZzFDcbq5ohbBc2Y52lwZO5Ik8mDMTsZ5eA0AByVRu5XvfvqGF7Rh8ttztiimdHSP4/SMx3/Jzr2nzExfVRWi9cnhDhBMUOSIDDrPa5S0fmL+mgT4K05XihrDN1HsLbojapAyG19lRG52htPzYc9KAQNpRk59jFnwEqG5ZzmHLr0GRQK6EcGlNXFObe7Rba4N9vsKYIKrTKkIgeVpvNsjd1ToUun05jU7rsCTHGxqbozDc9F6nJaJv1rUN6yGAHm97Gc9GMUHeLVjZ4ncOTE/rfJiupXQzig0H5LSJgWku5+gPLPj6YvN/lDcO7n5H7fNj5BzH8ZZnfDN+Tpu45nXsRxCe3NpIapkhyvaaHzUcUHdkKJYXCqyS2q+HJydWAZLvO2Oku8Z3pEt3cNweQEBdGUytVJZFTa49ZAZ9xoYAeAPM7ShON0eb+F/nTKLtPCKcbQnh+VwhvlU+Q+pbCc32N6p/LaXd7F7YnUpel15UQLTIRgPw822C2Ox6YtJjXRrgVG13csmWPV6IX5kcXl+vLjJFgNaVgKm09xdzN2YgddzIyFs0NpVEIg1faRg8tVwVlr+64f7wSxzcDts62V+x0FvdCW8dnQs169666bJk8o4MIst5gtY1tK/EXpOA2SrILlTFBCjBHXpC3uM4Yne/3bTrq63RKKVG0K/fTsW1b2Zxtw7sjP5PSMxsZl90Jl8HzbqojJDN8fqJJT+zKODSMpxxCk0LoZAU6SYGLVleb+DuF3wMftw5PT32A9+XAR0LPXvog4/TF+nLD32Zs06f2+cJtz5CxTY/Hf3fe85Cg3nrf/Ksv1FT7Y46yb7pi6R7dDO4GZChzXTZtUQn81//+H78inZm/5n+Ad7WBSi/QTOvQWzWVuBT0hhPwlruPvJRorVwBPd0zakmGQsx8DSU9jDmv+ERIQYaBwHTIcnVsi+3Dj23A8MSEctINSrInILX2/a1OA6+dLv0e6fFbaHNNHcLUaAsTaolEa8EipiWo5tx3Gsdbk1HDMvXzkqtRGWERuCgJmFwenE5FLvyrqpUzPHdQcsVnSJtlPjAkKTRNzUZPqPRrtayDT0RtlYgusEjZe9uHN9Sj6hn32T10XEgsgjtkqfesoDyg19vYLzwhT7ai7UWOti1CS7xB461E8GdrKaHSZK0FlxQZdc+WEDnDlaVHNmYW49E04otOi9+j4Ks+UAqeHiCKdUgBpFDXobv3olGzH3FihcM2KF4sFncs1tPNNX8Sbl5PwGCl23UzP+jtW3d58/GUzAGa0r6bnqG5EXlyC/bseeyBj+MbxkP8lQwEr8QftxfQbZIiR2Wx8+K8+tP7b+AGnvVPWNax0R9B8PE3b19//d3Z14SXXpFw/wb9k/6Jz+Rp60quOludoZzCWXh5trLfzTN86P4/dP8fuv8P3f+H7v9D9/+h+//Q/X/o/j90/z8ung7d/4fu/0P3/6H7/9D9f+j+P3T/H7r/D93/h+7/Q/f/ofv/0P3vW8RiUZHswHEluVCdhohQgb5o/ybgMmNzKk6PLtjtLaV6f6DWHxr+uUZDle3LjN1wIyjX4evaWariUgHzGqmU+DqkbnrntHMWLp8vgWyV86kIHVa8ynOs3L2w3fr5+3dn5yxjqVer1AWtMXxBf9PAF2zE6Lnxf/nghenLttw3j0quZrWvqbKAl4rPvHbzzcr1ta9cxx+d0ixXqw6VmyXtwAr9S4ztXPDvVD/5C67+owEPM3sXRNkmaDq8y/V6/b9fCVqF",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",source:"@site/docs/API-docs/selfsign.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/selfsign",permalink:"/docs/API-docs/selfsign",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",sidebar_label:"Self Sign",hide_title:!0,hide_table_of_contents:!0,api:"eJztO11zGzeSf6UXL45VQ0qkZcfHurpax87t+jaJXZFSqS1RpYAzTRIWBpgAGJGMilX7cD9j9+V+Wn7JVeNjZkiRkh2ndnV1zIPDARqN7kaj0V+6ZY7PLBtdsDc6r0tUzrLLjBVocyMqJ7RiI3Y+R7Aop1bMFLx6/xZmqNBwhxY4/PD9N+Dm3AEqPpFoYWoQrVtJBIIXagZ6ChyKiL8Pf9U15FwBl1aDULmsCwTtN+MSKoO9AqdCYQELUczQ2QwWc5HPwc0DTjR+PRbCgTaAy4qrAupKK+AWFGKBRR/O58JCZfSNKDyhiRpcVmgEqpyQlUJyA0573L/+7e9nxOJfdW2I31//9g+YSr0Aofz8uwqVB+BV1R+rsToX1Qh+qKTmBax0beD9m/9sGCWsNHZxdPQGJ/UMfnh7dHT5xdy5yo6OjwmHrlARWZJPbD/X5XFBgFUxfUoso0HCGnjlVsgV8KIjFDdHBbmuVpBrbQqh6EQyqPgMQdXlBI3NgCRTaoPEAweDvFj1nO7VFuG/zt59B1NtSu768F7WNmu2K4TB3MlVQE+8J66eWJhwiy9OwToj1CyDkl+TWIWDn2uRXxPbFlWRhPrq/Vsvq6Ojs7qqtHFYwI+BhdHREc18hSRjbtDD57ostYKKG16iQ2ODdtG0wZ9rYbxeuDlwKZMsRmPVg6Mjt6pwdHQEb1Uhcq+ehJBGSQUDbD+AkpAI9KzCXExFBO2IDrSKWkcyWfBwnpXkeSDToK0wd+IGNxEvM1gR4jeodKJgro34RSvHpT+OGzRO5Fx2j40I9OrtuHEkzkoL5dJo3KG5OXR6/lCiXhFpBQmrFMrPWIQbLmu0kapFBnOi6nusDFq65QkvCVIVMEcxm+/djxcfaus2EENticwuFXGvdEpevOjFNuXSIojphixLfo2d3RoL0IevVlDglNfSZSBI45ypsQ/faUc3T4qcDA1prr/T3NUGe/6UozpEQhQv/Rm/b21AIaZTNHQ5adKjiGsSdaRnwWgQe/7muDlXoNXWQedaakPot3TIj28KEnKtnDd9r264kJ76wK1t7N9E8vw6g4msMQODRbi5K5RSL7Kg8B6ELFwQuhcQ2WVSQ62IAaXj9sKCjVQ1ljBdKJpsrC1tImxXrPHaTjXtTDJIdwyw5EJmXnIZfNATcMJJzOjGVlytMii4wwwcLt1ELzPI55hfT/QyCmyqlbPilx3XLs18utSGGZxm8CKDlxkMTjIYDDMYnGYweJHB4GUGw5MMhsMMhqcZDF8EmQ5fRnnyRohdAgbDIEn3uCRIBvQbYf0VJctnG2O62DCmYzXow9FRczH88E8//TRWt2MFMGZ0UcZsNGYNyJhlEObI/o3ZaJBBHFiO2QieDb9MACv6fkESDN8L+h6QxMP3nL6Hg7Fax02HnhjHy+oeQmj69ycifUadoUG/M40lG0WDZFwCLM3Q2dBoQxZNrFuGnhFDQgknuLT7eUoQj4+tlrItzk6JM6+h+9ny04+Pp0RWmvFGMEx5o9mZSlfdEzLcEsHzfvts7JFA2PSxCSBS9bn8vyD+G7u0XwgNyOOTRJe0zxXHl33/znvbvF8YEeDxiaIl7HMF8ZIEQW/TfinQ7OMTQaQqTcT3PsydnPYGz3vDk+HphhgoHAoAZdkrit5qtfpMEYIXGLlAcX/vNUavNDhz3CFMjS53hBw+Imihoovkfyc3/VtyzifJb8UixauNA9NEeV3P2umCr57YgCotbXw1gm89tVWHTD9FdPiIN59rkUfiCSZ5aBMK6vokhB4Jvjj+9tvjjijDYK8sk3whjdJ3z4u+O1qW/aLob8NunFBntISiyGDH+O6JooCyLPeNhwl6Lsfq3+giRPds/12IAP/c69Aqfbv9w1eFEgJaSb+/j9J235Wt92UuVJyIegNbAAZnteQGlxRuWqGVl8vvYIm2blG6RK0r76NTH9j52D+IAr54F931p1HBiYNNBDTy8Lo7jHWRGJzh0uPIa+t0ScSIghOGDGydzyl44ykqILG3eRr/lfNKUJZAonN+FF3e30VEOLROhE2nuh1gW3QbzHALaeWOGNufvg80Bif+3Yuxxz0PX4R4fGa/Q1maDFkLmr4Ys5JH14VNsf2t3RzNmF02a0JsjUVnLexaDJfZ/vsE7aUpUPIJyrt37XNuQyCuq4bJBCdlTtIAKWzKXmyy1l0d0zs+6UapVNKkCUJaAJNGcT5bMRvCPk4zw72NQnxgC4IDD9ik1ppg+l7d99GzKEN6cF9wV3o9f2xaH8na0hGWMV1Rtl5o9bZgI5Yy+SzzWNG6r3SxYqNbFhMu9DOmM2jR8QdLVYBbZvM5lpx+JWqobjAVElnGQl7esox575uKCCQvNmJ68gFzxzJ6KypKfaIlHH7d6DZBhWwyy6IHxkYspJlZxnDJy4qA4xCgyjW5OVUxZeu04X2ompEWlfU/mrQ24dkoevwmbG86GNYZowzwb8T0HS31vJV4rl9rGnT4hq9sB2F4PNh2uYbW0B3I4yoo+MpSjqq24TrnXOa1JGcOl5Uwq8az9B5dI5IOoc1ODaGD5+t06B2K9py10Z9+QDlqEoAP7T917QeNE8Q/xgGqrPjj4OUnU/FBI0zQH0U11+qT1w+GzwbDwbPBkDDETF0HBzeGr1jGhMPSPizHMHuXgs3zf0UeBhbJkvfaLHkGPqnVf0gHE7xnm8/wYZ0731c96eRz7VzXsqBMKXLT90WM31wf21Rj2sRz239AadcZWz7MzBJy3UulGfhC4tRBXVVUdtRGoXnajdUeDXPD09N1xlYPs7f6P8nel3R4i4e5+9HXtNp637+C1mcv1xmbP0zrn5uq27+Q2NMX6/YRZblB7jC9AVcTXayukt1adwGTG7EJGl+ENe0oCzTkcdy1V62pIUiqFl9t2/mJ1hK52mFoNioxPpqy3vUjxzImKxZzJF++9Qg9dtu4stENDS4LVXdwK34Ulvw9U+OY9eHttJVlcCa3i0EJ1heDlIYnfr8rW3sz/uQ4fpOEnnQr21RsbJM0iQQPDA7LSvrS8EJISXTT892H5j/v2jWSJALSc5k2fvipeB3iVL9hXLRZV4XoIvbhNVdN2W2zvAW3t40SeO1Yr+H2lk4VzRU9uut11g7QXhsD/l0NIwZzFDcbq5ohbBc2Y52lwZO5Ik8mDMTsZ5eA0AByVRu5XvfvqGF7Rh8ttztiimdHSP4/SMx3/Jzr2nzExfVRWi9cnhDhBMUOSIDDrPa5S0fmL+mgT4K05XihrDN1HsLbojapAyG19lRG52htPzYc9KAQNpRk59jFnwEqG5ZzmHLr0GRQK6EcGlNXFObe7Rba4N9vsKYIKrTKkIgeVpvNsjd1ToUun05jU7rsCTHGxqbozDc9F6nJaJv1rUN6yGAHm97Gc9GMUHeLVjZ4ncOTE/rfJiupXQzig0H5LSJgWku5+gPLPj6YvN/lDcO7n5H7fNj5BzH8ZZnfDN+Tpu45nXsRxCe3NpIapkhyvaaHzUcUHdkKJYXCqyS2q+HJydWAZLvO2Oku8Z3pEt3cNweQEBdGUytVJZFTa49ZAZ9xoYAeAPM7ShON0eb+F/nTKLtPCKcbQnh+VwhvlU+Q+pbCc32N6p/LaXd7F7YnUpel15UQLTIRgPw822C2Ox6YtJjXRrgVG13csmWPV6IX5kcXl+vLjJFgNaVgKm09xdzN2YgddzIyFs0NpVEIg1faRg8tVwVlr+64f7wSxzcDts62V+x0FvdCW8dnQs169666bJk8o4MIst5gtY1tK/EXpOA2SrILlTFBCjBHXpC3uM4Yne/3bTrq63RKKVG0K/fTsW1b2Zxtw7sjP5PSMxsZl90Jl8HzbqojJDN8fqJJT+zKODSMpxxCk0LoZAU6SYGLVleb+DuF3wMftw5PT32A9+XAR0LPXvog4/TF+nLD32Zs06f2+cJtz5CxTY/Hf3fe85Cg3nrf/Ksv1FT7Y46yb7pi6R7dDO4GZChzXTZtUQn81//+H78inZm/5n+Ad7WBSi/QTOvQWzWVuBT0hhPwlruPvJRorVwBPd0zakmGQsx8DSU9jDmv+ERIQYaBwHTIcnVsi+3Dj23A8MSEctINSrInILX2/a1OA6+dLv0e6fFbaHNNHcLUaAsTaolEa8EipiWo5tx3Gsdbk1HDMvXzkqtRGWERuCgJmFwenE5FLvyrqpUzPHdQcsVnSJtlPjAkKTRNzUZPqPRrtayDT0RtlYgusEjZe9uHN9Sj6hn32T10XEgsgjtkqfesoDyg19vYLzwhT7ai7UWOti1CS7xB461E8GdrKaHSZK0FlxQZdc+WEDnDlaVHNmYW49E04otOi9+j4Ks+UAqeHiCKdUgBpFDXobv3olGzH3FihcM2KF4sFncs1tPNNX8Sbl5PwGCl23UzP+jtW3d58/GUzAGa0r6bnqG5EXlyC/bseeyBj+MbxkP8lQwEr8QftxfQbZIiR2Wx8+K8+tP7b+AGnvVPWNax0R9B8PE3b19//d3Z14SXXpFw/wb9k/6Jz+Rp60quOludoZzCWXh5trLfzTN86P4/dP8fuv8P3f+H7v9D9/+h+//Q/X/o/j90/z8ung7d/4fu/0P3/6H7/9D9f+j+P3T/H7r/D93/h+7/Q/f/ofv/0P3vW8RiUZHswHEluVCdhohQgb5o/ybgMmNzKk6PLtjtLaV6f6DWHxr+uUZDle3LjN1wIyjX4evaWariUgHzGqmU+DqkbnrntHMWLp8vgWyV86kIHVa8ynOs3L2w3fr5+3dn5yxjqVer1AWtMXxBf9PAF2zE6Lnxf/nghenLttw3j0quZrWvqbKAl4rPvHbzzcr1ta9cxx+d0ixXqw6VmyXtwAr9S4ztXPDvVD/5C67+owEPM3sXRNkmaDq8y/V6/b9fCVqF",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Contact list",permalink:"/docs/API-docs/contactlist"},next:{title:"Draft Document",permalink:"/docs/API-docs/draftdocument"}},g={},j=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Self Sign"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/selfsign"}),"\n",(0,i.jsx)(n.p,{children:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app."}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "name": "textbox",\n "required": true, \n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signer"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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. \n",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(m.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-sign-document.com"}})]})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(m.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(m.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.3855f22e.js b/assets/js/bbdfc22d.3855f22e.js new file mode 100644 index 000000000..1057f9dff --- /dev/null +++ b/assets/js/bbdfc22d.3855f22e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>u,default:()=>b,frontMatter:()=>h,metadata:()=>x,toc:()=>g});var t=s(85893),i=s(11151),a=s(58219),l=(s(62316),s(51039)),r=s.n(l),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),p=s(85162);const h={id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztW91yI7exfpXO3KxXNaRErrzew0qdOuufJJvY1pZXW66UpJLBmSYH1gwwBjCiaBXv8iR5tDzJqW4AM0OKlLS7Lkep8Ebi4Lf7Q6PR3WjcJk7MbTI5S06xqkvh0CYXaZKjzYysndQqmSSnBUKshq8MCiqH12/fgChLvbDQWDQWnIaMKhGyxjpdyV/FtERwceAUFoXMCrBorhGEhWnZYG2kchZm2sAcFRrhpJpDrrOmQqpYSFdAbTDHmVSYg3WmyVxj0A7hfa0V2CbL0NpZU7YzeTKkVim4AplQg64xyoKARslfGoSDg9j6UuYHB+AK4SATCqZI7OTETSAIe+RMBdVpxQPbGjM5k9Q4jDU8V+fqVNYTeF+XWuSw1I2Bt1//qR2CxqWys4ODr3HazOH9m4ODi88K52o7OTwUdT3UNSor56oUUzvMdHWYU8M6nz0nBNEgjcq0orCyXILIc1jIfI7OMscKMl0vIdPa5FJ56GsxR1BNNUVjUxAqh0obBKlAgEGRLwdODxqL8Nd3J9/TclTCDeFt2di0nS6XBjNXLv3whEDk6plH5uUxrY9U8xQqcUULKR380sjsiti2qBjWsCaM1cHBu6autXGYw4+ehcnBAdV8iaVegDDI7TNdVVpBLYyo0LG00YJRtcFfGmkw96IiyjJiMaFhBrTSyxonBwfwRuUyIzh4SCoFPQuth74pwURN34Wl9U174NHaezEmVBbCr2hdiswTapCkwslrXB/4JoUlDfw1Kh0pKLSRv2rlRMkLco3GyUyU/YUjAlnUnDC8M2otlYulYQb4e1ggWj9eliBZRFpOcFVScY1FuBZlgzZQtUihIKp+wNqgZQkP4xKUKocC5bzYOZ/If26sWxsYGktk9qkIc8V1YniRYZuJ0iLI2RqWlbjC3mygWQ2JcghfLiHHmWhKl4IkmXOmwSF8rx2Iui5lxvqGVAltH0FaYsCrHAQiEKJExWv81uhrmSMphVzOZmhoe1IlDxH6ROpI0mruQOzx3nGFUKDVxkJnutSGht+QIS5fBxIyrRwqN4TX10KWTL3n1oJUWdnkCNNSZFcpq8oUDOZ+7y6RFG/qRZ6bkD71oDNAYLEkMdSKGFA6TC9tp7SGp4W03Y6iugg1zyFtH9Wwb2eaJiYI4iYDrIQsUwYuhZ/1FJx0Jaa0ZWuhlinkwmEKDm/cVN+kkBWYXfEvI3KpYdo4R6qa5syNrnO9UAHLmVbOyl+37MhY8+GAjlM4TuFlCq9SGB2lMBqnMDpOYfQyhdGrFMZHKYzHKYyPUxi/9GSNXwWoRYtvn4DR2IPseuDC00aXNO+30vLOJpVpWy28WNPC52o0hIODdj9x8U8//XSubs8VwHlC++s8mZwnbZPzJAVfR2rzPJmMUggFN+fJBF6Mv4gNlvT9ktD13wv6HtFq+O+Cvsejc7UKk46ZGCeq+h5CqPq3JyJ+BnmiQp6ZyqJqo0LSSb4t1dC6UWlLFlWsOoZeEENSSSdFaXfzFFs8PbY6yjY4OybOWHp3s8XVT4+nSFasYd3pq1jX9qqiGmBCxhsQfD7sTpsdCPhJnxoAgapP5f8l8d/qrN0gtE2eHhJ90j4Vji+GbB6w3t4NRmjw9KDoCPtUIF4REHRu7UaBap8eBIGqWBFsAV93dDwYfT4YH42P12AgP8o3qKpBng+Wy+UnQggMGJlHYX42NoMx621A8llnRldbPBV2JLpWwXzi39G6/45s+mk0dzEnJ3Hd3Y3uYd8gdzoXy2fWDxW7tnYcte+suGWPTK4iOthVzgots0A8tYnW25S8wSGBMCDg88PvvjvsQekLB1UV8YVYSt8Dhr5fWlXDPB9utl1boV5pBXmewpby7RV5DlVV7Sr3FXRcnqv/GXIcgk233XshNPh9tsMWqe/m37lXugqRa1Xy/Ozcbd8rG+dLIVWoCHIDGw0MzptSGLwhL9VKrRiX30ATbeyiuIk6M5+dWvYHOWTgkYDPToIp/zwIOHGwPgCVPNzvDmP9QQzO8YbH8PE0IkbmIbBlm6wgn09Ej4Fg7wI8/JWJWlJwoUTnuBRdNtxGhF+0nmNOi7rpl1t0a8wIC7HnFtecV58djdERn3vBL7nn4Astnp7a71EWK32wg6rPzpNKBNMlmWH3W7sCzXly0fbxLjnmvb6wrTNc3LOfoNs0OZZiiuXdvfbo3dBnJ0hWDxyqqKRqIwlM8lGkgGvFzUZtqFxt2Wee7b6AR+Uet0nEGUppYzhlHbR+7xBv4jigQh+xnSLEDjBtRfKTRb4l7HEy7zVCWJ4HpqB2wA3bWF+c7YEZ1pamDwyNUUklq6Zqg5azdtQIWRVO+T5e1JNi+XGG/vLemUHcPDBDiKbvmOBcjTi0EIMSrBhguzEYmjw9zdCj7OEj8GN0xtqx+bEH3ofvxMhXfyduOSepqT8h211od2/DIZzQqUQRU9+JYmBZhrWjeNmn7tGW5Mft0RGHkvoxst0nU7/V7y2Du4TpMdK5QfdvJoeh3acZX4Ta44Sxz8Z/kECukf1oY8kHBCt/DbUrGlix6D01ZRjI2jj6kzTRNd/ravUmTyaJvyOON6ZJymOjdV/qfJlMbpMQw6efIUJOXQ9/tnQXfZvYrMBK0K9IE91ez2RJQ1EQGo1N0oSDNnSVTaglk0RPf8bMJSm5GDVdtKGlMbjf5Da28reXSRoc92SS+GvNJE3wRlQ1NQ5FgCrT5B3zEKs4431jtSXdWJZ/tPfHNA7dD37kMNx1tXF9/1Ej9UdYdbh2gwljxDLZzBSIF4PRj/P92puPchk3i3S0JdrLKm6WpIl0WPVn2bFqRn840hlq4oRjux/al5dFVB88J/WrC60+qmO4iNmC+SNR8rV3J15fstfkQGIezelBd3eaAt9ZDB+SmNieuRXz/pzeOLwz5+muO/XeVZ4tdFPmdEmGwgz5avuj8yY4NUWUWcPZIe0hscZZS2rL2WiVJjcPM3MDmR7EC3v4rMSZg6au0UCmjULzvB+KezLMjY+PV2myfJi95X8ke1/Q4i0e5u5HznToskD+HbS+eLVKk+JhWv/S5mL8G4k9frnqzrqNs/xyqvPlZdRbq4caxkOF2lFu0Bt1YnI0PSCmWpco1B0k3sy8laXhGRkjz0K8i6/QpbHxQIGFLEswmCGl43AIO+oqCEaHv1+HcItJxtk3VMBGo22mllqpOJ71A04RnJHzOVLSUWjBnUOSAApOcqM0HaJKzOj+n9OIDF5L3dhIXiEs3+OXSHapK1D6zBWp5utGYg8dTuHo8z7srw6V0CGnKKvg5PTtI7BkE3YArmgzFDyXfgw4OX1LiUlyFuywIby3LRIRWrHWBMgugmspYvJCq9uXPuqAihHRzOxaHtkwpAQN4C5BubRbKUq7GGibh3hn4C53jZZIN46S5mTIx7AOa7uGI1PRAnmqm8dI5QNICpg3fJ3iaMvGLCWOy3aJRVL5BEd2gPLGxFyqIBbUkrIdO5wiKtSoN34KqKzvLmAmrEOTUuojIW8acnDaIfGmRiNRZbgVAoMeusvGbLWb1jFYz9J5/8O3IWMx8hA35ZR2oB8Yc2hqlhreCW32WFy5TdbvGEosZZe0R9Bc7jLT1snkLC9twu4PcbcajdWKirWZCyV/9dIckj2nWIhyxtq3vVSjpDCaN9JMo63TF9Xvv/7xTyKVJfWy0nkrvfbxgvWW8vicbZWR05z5iSX63NR4JdAqOZtGxWaDLUc3A4Yj+MyWrokfvJHW9ZKO4n3f3U35AxKeWY8GPvtpK5GgqWV/V7V0heSmbjhOjZLr+Wrt2bMhgPefIf6Q6RzBoP8oCVMr683g8dER/duwQNdShWk3tGnE5fIPSfp4L/R+G9wXk997VyQ7KfmyGP/F1qrKChKSCq1dN6O3dHmAgT5uUpVS4WUE5XJ8dHT5OSG3SpPjbeC80xW6giWCNuDCaMrorUsUlF9qliDmQiqg6c1viBUao839XH8YZfeBcHx0dDlqQfj8LghvFF+KcPb4qb5C9fty2p/e+emJ1JuKlbDXcon0jbg+WWO2X+6ZtJg1RrplMjm7TW4GopYDXz85u1hdkNS5QlN8ptaWKRauSCbJ4Z1wDafvUyzg7DbhMyGJ9qYVKqd7izs2p6jl4fUoWaWbPbZaqDtbWyfmUs0H9/a66Fh9R8vhEV9juHOoa/k3JI864NlvlSaSxKBAQTYpIUir/EMXq/omrlWMIm0NDHWLshnqiZGeteDNpurfEo7pRWPOYiiEoxttcCPpOEraAAT9bEMKZ53otd57dN5H7PWOj4/ZPfxixH7Ui1fsohy/XF14hHvmOscD+zanj1SvGU+haN2YSJKth/faobnjzIzWiVQzzQsaQD6pUb0j44/2zfXorr+HZaarNuE2Nv/XP/7JPeIZxdP8AU4aA7VeoKHXJZRBOyvxRpK51Xv8QoYAh31FVaK1FONSDuf+4Yic8w18tGEyUYupLCUpAmqmfdZLT5fYIfxYIIXfqeqZ8ckI11iS/oBSa35WQUd/43TVf5wCC22uZkRSCgKmlIePlpwFjF1QFUJlZLL4/cHGAD0jIauwNtIiCFlRY7JOcTaTmaSBSesZkTmohBJzPtVT9jsJhTpm0Rs9JePe6rLx5ivl8iM6zyKH4ofwNbkLzDgV5uiELDH3lqtNvecQlGB4pjIlL62m6WWGtkthKvEaDesD7/c1ZQm1dt4XI7Omv7Y0kDNCWfJsPUFxaVr4gn3Jc+RiOQSKx9OBQ24FCUAp1RU9KhnAWStmP+LUSoedz71YLO7opufrff4sXdFMwWCtu35zLmRN1u/efjwnTYKmsiezd2iuZYZBMe6Y85AbH4YzS2R8ZkX9IGr5f5sd6PwoZYbKYu+Eef3nt9/CNbwYHiVpTxs/guDDb9989c33776hcem88PtvNDwaHnGgUFtXCdWb6iv/duy0048bYez28N0/SNs/SNs/SNs/SNs/SNs/SNs/SNs/SNs/SNs/SNs/SNs/SHuQ//2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP+OB2kh94UMx8O6FJKTp0J+q897Ott8pnaRJgUlRk3Okttbulp8b8rViop/adBQVtVFmlwLIyl8zjlVacwdomybK1zSFbe/DRic0vypl3u+jt9IJaPUJ9/jNa/+vW37uVtvT96dJmkyDU/pKp1THyMW9MxOLJJJQkqbn+S1yadcfpuUQs0bTgBK/LiU8iQaV6znS11xvlT40csjEmrZo3I9kcqzQn+Jsa0d/kh34n/D5f+2zX3Nzg4B29ialvBitVr9PwFbmLw=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",source:"@site/docs/API-docs/createtemplate.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createtemplate",permalink:"/docs/API-docs/createtemplate",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztW91yI7exfpXO3KxXNaRErrzew0qdOuufJJvY1pZXW66UpJLBmSYH1gwwBjCiaBXv8iR5tDzJqW4AM0OKlLS7Lkep8Ebi4Lf7Q6PR3WjcJk7MbTI5S06xqkvh0CYXaZKjzYysndQqmSSnBUKshq8MCiqH12/fgChLvbDQWDQWnIaMKhGyxjpdyV/FtERwceAUFoXMCrBorhGEhWnZYG2kchZm2sAcFRrhpJpDrrOmQqpYSFdAbTDHmVSYg3WmyVxj0A7hfa0V2CbL0NpZU7YzeTKkVim4AplQg64xyoKARslfGoSDg9j6UuYHB+AK4SATCqZI7OTETSAIe+RMBdVpxQPbGjM5k9Q4jDU8V+fqVNYTeF+XWuSw1I2Bt1//qR2CxqWys4ODr3HazOH9m4ODi88K52o7OTwUdT3UNSor56oUUzvMdHWYU8M6nz0nBNEgjcq0orCyXILIc1jIfI7OMscKMl0vIdPa5FJ56GsxR1BNNUVjUxAqh0obBKlAgEGRLwdODxqL8Nd3J9/TclTCDeFt2di0nS6XBjNXLv3whEDk6plH5uUxrY9U8xQqcUULKR380sjsiti2qBjWsCaM1cHBu6autXGYw4+ehcnBAdV8iaVegDDI7TNdVVpBLYyo0LG00YJRtcFfGmkw96IiyjJiMaFhBrTSyxonBwfwRuUyIzh4SCoFPQuth74pwURN34Wl9U174NHaezEmVBbCr2hdiswTapCkwslrXB/4JoUlDfw1Kh0pKLSRv2rlRMkLco3GyUyU/YUjAlnUnDC8M2otlYulYQb4e1ggWj9eliBZRFpOcFVScY1FuBZlgzZQtUihIKp+wNqgZQkP4xKUKocC5bzYOZ/If26sWxsYGktk9qkIc8V1YniRYZuJ0iLI2RqWlbjC3mygWQ2JcghfLiHHmWhKl4IkmXOmwSF8rx2Iui5lxvqGVAltH0FaYsCrHAQiEKJExWv81uhrmSMphVzOZmhoe1IlDxH6ROpI0mruQOzx3nGFUKDVxkJnutSGht+QIS5fBxIyrRwqN4TX10KWTL3n1oJUWdnkCNNSZFcpq8oUDOZ+7y6RFG/qRZ6bkD71oDNAYLEkMdSKGFA6TC9tp7SGp4W03Y6iugg1zyFtH9Wwb2eaJiYI4iYDrIQsUwYuhZ/1FJx0Jaa0ZWuhlinkwmEKDm/cVN+kkBWYXfEvI3KpYdo4R6qa5syNrnO9UAHLmVbOyl+37MhY8+GAjlM4TuFlCq9SGB2lMBqnMDpOYfQyhdGrFMZHKYzHKYyPUxi/9GSNXwWoRYtvn4DR2IPseuDC00aXNO+30vLOJpVpWy28WNPC52o0hIODdj9x8U8//XSubs8VwHlC++s8mZwnbZPzJAVfR2rzPJmMUggFN+fJBF6Mv4gNlvT9ktD13wv6HtFq+O+Cvsejc7UKk46ZGCeq+h5CqPq3JyJ+BnmiQp6ZyqJqo0LSSb4t1dC6UWlLFlWsOoZeEENSSSdFaXfzFFs8PbY6yjY4OybOWHp3s8XVT4+nSFasYd3pq1jX9qqiGmBCxhsQfD7sTpsdCPhJnxoAgapP5f8l8d/qrN0gtE2eHhJ90j4Vji+GbB6w3t4NRmjw9KDoCPtUIF4REHRu7UaBap8eBIGqWBFsAV93dDwYfT4YH42P12AgP8o3qKpBng+Wy+UnQggMGJlHYX42NoMx621A8llnRldbPBV2JLpWwXzi39G6/45s+mk0dzEnJ3Hd3Y3uYd8gdzoXy2fWDxW7tnYcte+suGWPTK4iOthVzgots0A8tYnW25S8wSGBMCDg88PvvjvsQekLB1UV8YVYSt8Dhr5fWlXDPB9utl1boV5pBXmewpby7RV5DlVV7Sr3FXRcnqv/GXIcgk233XshNPh9tsMWqe/m37lXugqRa1Xy/Ozcbd8rG+dLIVWoCHIDGw0MzptSGLwhL9VKrRiX30ATbeyiuIk6M5+dWvYHOWTgkYDPToIp/zwIOHGwPgCVPNzvDmP9QQzO8YbH8PE0IkbmIbBlm6wgn09Ej4Fg7wI8/JWJWlJwoUTnuBRdNtxGhF+0nmNOi7rpl1t0a8wIC7HnFtecV58djdERn3vBL7nn4Astnp7a71EWK32wg6rPzpNKBNMlmWH3W7sCzXly0fbxLjnmvb6wrTNc3LOfoNs0OZZiiuXdvfbo3dBnJ0hWDxyqqKRqIwlM8lGkgGvFzUZtqFxt2Wee7b6AR+Uet0nEGUppYzhlHbR+7xBv4jigQh+xnSLEDjBtRfKTRb4l7HEy7zVCWJ4HpqB2wA3bWF+c7YEZ1pamDwyNUUklq6Zqg5azdtQIWRVO+T5e1JNi+XGG/vLemUHcPDBDiKbvmOBcjTi0EIMSrBhguzEYmjw9zdCj7OEj8GN0xtqx+bEH3ofvxMhXfyduOSepqT8h211od2/DIZzQqUQRU9+JYmBZhrWjeNmn7tGW5Mft0RGHkvoxst0nU7/V7y2Du4TpMdK5QfdvJoeh3acZX4Ta44Sxz8Z/kECukf1oY8kHBCt/DbUrGlix6D01ZRjI2jj6kzTRNd/ravUmTyaJvyOON6ZJymOjdV/qfJlMbpMQw6efIUJOXQ9/tnQXfZvYrMBK0K9IE91ez2RJQ1EQGo1N0oSDNnSVTaglk0RPf8bMJSm5GDVdtKGlMbjf5Da28reXSRoc92SS+GvNJE3wRlQ1NQ5FgCrT5B3zEKs4431jtSXdWJZ/tPfHNA7dD37kMNx1tXF9/1Ej9UdYdbh2gwljxDLZzBSIF4PRj/P92puPchk3i3S0JdrLKm6WpIl0WPVn2bFqRn840hlq4oRjux/al5dFVB88J/WrC60+qmO4iNmC+SNR8rV3J15fstfkQGIezelBd3eaAt9ZDB+SmNieuRXz/pzeOLwz5+muO/XeVZ4tdFPmdEmGwgz5avuj8yY4NUWUWcPZIe0hscZZS2rL2WiVJjcPM3MDmR7EC3v4rMSZg6au0UCmjULzvB+KezLMjY+PV2myfJi95X8ke1/Q4i0e5u5HznToskD+HbS+eLVKk+JhWv/S5mL8G4k9frnqzrqNs/xyqvPlZdRbq4caxkOF2lFu0Bt1YnI0PSCmWpco1B0k3sy8laXhGRkjz0K8i6/QpbHxQIGFLEswmCGl43AIO+oqCEaHv1+HcItJxtk3VMBGo22mllqpOJ71A04RnJHzOVLSUWjBnUOSAApOcqM0HaJKzOj+n9OIDF5L3dhIXiEs3+OXSHapK1D6zBWp5utGYg8dTuHo8z7srw6V0CGnKKvg5PTtI7BkE3YArmgzFDyXfgw4OX1LiUlyFuywIby3LRIRWrHWBMgugmspYvJCq9uXPuqAihHRzOxaHtkwpAQN4C5BubRbKUq7GGibh3hn4C53jZZIN46S5mTIx7AOa7uGI1PRAnmqm8dI5QNICpg3fJ3iaMvGLCWOy3aJRVL5BEd2gPLGxFyqIBbUkrIdO5wiKtSoN34KqKzvLmAmrEOTUuojIW8acnDaIfGmRiNRZbgVAoMeusvGbLWb1jFYz9J5/8O3IWMx8hA35ZR2oB8Yc2hqlhreCW32WFy5TdbvGEosZZe0R9Bc7jLT1snkLC9twu4PcbcajdWKirWZCyV/9dIckj2nWIhyxtq3vVSjpDCaN9JMo63TF9Xvv/7xTyKVJfWy0nkrvfbxgvWW8vicbZWR05z5iSX63NR4JdAqOZtGxWaDLUc3A4Yj+MyWrokfvJHW9ZKO4n3f3U35AxKeWY8GPvtpK5GgqWV/V7V0heSmbjhOjZLr+Wrt2bMhgPefIf6Q6RzBoP8oCVMr683g8dER/duwQNdShWk3tGnE5fIPSfp4L/R+G9wXk997VyQ7KfmyGP/F1qrKChKSCq1dN6O3dHmAgT5uUpVS4WUE5XJ8dHT5OSG3SpPjbeC80xW6giWCNuDCaMrorUsUlF9qliDmQiqg6c1viBUao839XH8YZfeBcHx0dDlqQfj8LghvFF+KcPb4qb5C9fty2p/e+emJ1JuKlbDXcon0jbg+WWO2X+6ZtJg1RrplMjm7TW4GopYDXz85u1hdkNS5QlN8ptaWKRauSCbJ4Z1wDafvUyzg7DbhMyGJ9qYVKqd7izs2p6jl4fUoWaWbPbZaqDtbWyfmUs0H9/a66Fh9R8vhEV9juHOoa/k3JI864NlvlSaSxKBAQTYpIUir/EMXq/omrlWMIm0NDHWLshnqiZGeteDNpurfEo7pRWPOYiiEoxttcCPpOEraAAT9bEMKZ53otd57dN5H7PWOj4/ZPfxixH7Ui1fsohy/XF14hHvmOscD+zanj1SvGU+haN2YSJKth/faobnjzIzWiVQzzQsaQD6pUb0j44/2zfXorr+HZaarNuE2Nv/XP/7JPeIZxdP8AU4aA7VeoKHXJZRBOyvxRpK51Xv8QoYAh31FVaK1FONSDuf+4Yic8w18tGEyUYupLCUpAmqmfdZLT5fYIfxYIIXfqeqZ8ckI11iS/oBSa35WQUd/43TVf5wCC22uZkRSCgKmlIePlpwFjF1QFUJlZLL4/cHGAD0jIauwNtIiCFlRY7JOcTaTmaSBSesZkTmohBJzPtVT9jsJhTpm0Rs9JePe6rLx5ivl8iM6zyKH4ofwNbkLzDgV5uiELDH3lqtNvecQlGB4pjIlL62m6WWGtkthKvEaDesD7/c1ZQm1dt4XI7Omv7Y0kDNCWfJsPUFxaVr4gn3Jc+RiOQSKx9OBQ24FCUAp1RU9KhnAWStmP+LUSoedz71YLO7opufrff4sXdFMwWCtu35zLmRN1u/efjwnTYKmsiezd2iuZYZBMe6Y85AbH4YzS2R8ZkX9IGr5f5sd6PwoZYbKYu+Eef3nt9/CNbwYHiVpTxs/guDDb9989c33776hcem88PtvNDwaHnGgUFtXCdWb6iv/duy0048bYez28N0/SNs/SNs/SNs/SNs/SNs/SNs/SNs/SNs/SNs/SNs/SNs/SHuQ//2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP+OB2kh94UMx8O6FJKTp0J+q897Ott8pnaRJgUlRk3Okttbulp8b8rViop/adBQVtVFmlwLIyl8zjlVacwdomybK1zSFbe/DRic0vypl3u+jt9IJaPUJ9/jNa/+vW37uVtvT96dJmkyDU/pKp1THyMW9MxOLJJJQkqbn+S1yadcfpuUQs0bTgBK/LiU8iQaV6znS11xvlT40csjEmrZo3I9kcqzQn+Jsa0d/kh34n/D5f+2zX3Nzg4B29ialvBitVr9PwFbmLw=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Draft Template",permalink:"/docs/API-docs/drafttemplate"},next:{title:"Get Template",permalink:"/docs/API-docs/get-template"}},j={},g=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(n.p,{children:"Create Template"})}),"\n",(0,t.jsx)(r(),{method:"post",path:"/createtemplate"}),"\n",(0,t.jsxs)(n.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,t.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,t.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,t.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,t.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,t.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified.This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,t.jsxs)(n.ol,{start:"2",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,t.jsxs)(n.ol,{start:"3",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,t.jsxs)(n.ol,{start:"4",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,t.jsxs)(n.ol,{start:"5",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,t.jsxs)(n.ol,{start:"6",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,t.jsxs)(n.ol,{start:"7",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,t.jsxs)(n.ol,{start:"8",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,t.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,t.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,t.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,t.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,t.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,t.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,t.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,t.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.ol,{start:"9",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": { \n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,t.jsxs)(n.ol,{start:"10",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,t.jsxs)(n.ol,{start:"11",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,t.jsxs)(n.ol,{start:"12",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "readonly": false,\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,t.jsxs)(n.ol,{start:"13",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,t.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(n.p,{children:"Body"})}),(0,t.jsx)("strong",{className:"openapi-schema__required",children:(0,t.jsx)(n.p,{children:"required"})})]}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,t.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(n.p,{children:"signers"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(n.p,{children:"object[]"})}),(0,t.jsx)("span",{className:"openapi-schema__divider"}),(0,t.jsx)("span",{className:"openapi-schema__required",children:(0,t.jsx)(n.p,{children:"required"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,t.jsx)(n.p,{children:"You can provide signer optionally if you it as default signer"})}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(n.p,{children:"Array ["})})}),(0,t.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,t.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(n.p,{children:"widgets"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(n.p,{children:"object[]"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(n.p,{children:"Array ["})})}),(0,t.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(n.p,{children:"]"})})})]})]})}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(n.p,{children:"]"})})})]})]})}),(0,t.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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'.",example:!0}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"email_sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"name or email of the person or organization on the behalf of which you are sending the mail.",example:"opensign\u2122"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(a.Z,{children:[(0,t.jsxs)(p.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(n.p,{children:"Template created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(n.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}})]})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(n.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(n.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(n.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.636268e6.js b/assets/js/bbdfc22d.636268e6.js deleted file mode 100644 index 10616ac7b..000000000 --- a/assets/js/bbdfc22d.636268e6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>u,default:()=>b,frontMatter:()=>m,metadata:()=>x,toc:()=>f});var i=s(85893),a=s(11151),t=s(58219),l=(s(62316),s(51039)),r=s.n(l),d=(s(82723),s(9487)),o=(s(41429),s(5397)),c=s(4667),p=s(9472),h=s(85162);const m={id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztW+9yGzeSf5XOfHGsGlIirTg+1tXVOX8u690kckVypa4klQPONDmIZoAJgBHFqPhtn2QfbZ/kqhvAzJAiJdlOZbV1/CJxgAbQ/QMa6G40bhMn5jaZnCdnWNWlcGiTyzTJ0WZG1k5qlUySswIhVsPXBgWVw+u3b0CUpV5YaCwaC05DRpUIWWOdruTvYloiuNhxCotCZgVYNNcIwsK0bLA2UjkLM21gjgqNcFLNIddZUyFVLKQroDaY40wqzME602SuMWiH8K7WCmyTZWjtrCnbkTwbUqsUXIHMqEHXGGVBQKPkbw3CwUGkfi/zgwNwhXCQCQVTJHFykiYwhD12poLqtOKObY2ZnEkiDn0NL9SFOpP1BN7VpRY5LHVj4O03/9N2Qf1S2fnBwTc4bebw7s3BweXnhXO1nRweiroe6hqVlXNViqkdZro6zImwzmfPCUE0SL0yryisLJcg8hwWMp+jsyyxgkzXS8i0NrlUHvpazBFUU03R2BSEyqHSBkEqEGBQ5MuB04PGIvz19ORHmo5KuCG8LRubtsPl0mDmyqXvnhCIUj3zyLw8pvmRap5CJa5oIqWD3xqZXZHYFhXDGuaEsTo4OG3qWhuHOfzsRZgcHFDNV1jqBQiDTJ/pqtIKamFEhY5XG00YVRv8rZEGc79URFlGLCbUzYBmelnj5OAA3qhcZgQHd0mloGeBeuhJCSYiPQ1T60l74NHc+2VMqCyEn9G6FJln1CCtCievcb3jmxSW1PE3qHTkoNBG/q6VEyVPyDUaJzNR9ieOGOSl5oRhzai1VC6WhhHgf8ME0fzxtISVRazlBFclFddYhGtRNmgDV4sUCuLqJ6wNWl7hoV+CUuVQoJwXO8cT+a+NdWsdQ2OJzT4XYaw4TwwvMmwzUVoEOVvDshJX2BsNNG9DohzCV0vIcSaa0qUgac050+AQftQORF2XMuP9hrYSUh9Bu8SAZzksiMCIEhXP8Vujr2WOtCnkcjZDQ+pJldxFaBO5o5VWcwMSj3XHFUKBVhsTnelSG+p+Yw1x+TqQkGnlULkhvL4WsmTuvbQWpMrKJkeYliK7SnmrTMFg7nV3ibTxpn7JMwntpx50BggslrQMtSIBlA7DS9ttWsOzQtpOo6guQs1jSNtHNejtTNPABEFUMsBKyDJl4FL4VU/BSVdiSipbC7VMIRcOU3B446b6JoWswOyKfxmRSw3TxjnaqmnM3Og61wsVsJxp5az8fYtGxpoPB3ScwnEKL1N4lcLoKIXROIXRcQqjlymMXqUwPkphPE5hfJzC+KVna/wqQC1afPsMjMYeZNcDF542urTzfi8tazZtmbbdhRdru/CFGg3h4KDVJy7+5ZdfLtTthQK4SEi/LpLJRdKSXCQp+DraNi+SySiFUHBzkUzgxfjLSLCk75eErv9e0PeIZsN/F/Q9Hl2oVRh0zMw4UdX3MELVfzwT8TOsJyrkkaksbm1USHuSp6UamjcqbdmiilUn0AsSSCrppCjtbpkixdMTq+NsQ7JjkoxX726xuPrpyRTZijW8d/oq3mt7VXEbYEbGGxB8MexOmx0I+EGfGgCBq0+V/yXJ3+5Zu0FoSZ4eEn3WPhWOL4dsHvC+vRuMQPD0oOgY+1QgXhEQdG7tRoFqnx4EgatYEWwBX3d0PBh9MRgfjY/XYCA/yhNU1SDPB8vl8hMhBAaMzKMwPhubwZj1NiD5rDOjqy2eCjsSHVUwn/h3tO5/IJt+Gs1dzMlJXHd3o3vYN8idzsXymfVdxaatHUf0nRW37LHJVcQHu8pZoWUWmCeaaL1NyRscEggDAj4//OGHwx6UvnBQVRFfiKX0PWDo+6VVNczz4Sbt2gz1SivI8xS2lG+vyHOoqmpXua+g4/JC/ceQ4xBsuu3WhUDw56jDllXfjb9TV7oKkWtV8vjs3G3XlY3zpZAqVIR1AxsEBudNKQzekJdqpVaMyx+wE21oUVSizsxnp5b9QQ4ZeCTg85Ngyj8PC5wkWO+ASh5ud0ewficG53jDffh4GjEj8xDYsk1WkM8nosdAsHcBHv7KRC0puFCic1yKLhtuY8JPWs8xp0nd9MstujVhhIXYcotrzrPPjsboiM+94Jfcc/AFiqe37fc4i5U+2EHV5xdJJYLpksyw+61dgeYiuWzbeJcc815b2NYYLu/RJ+iUJsdSTLG8q2uP1oa+OGFl9cChikqqNpLALB9FDrhW3GzUhsrVFj3zYvcXeNzco5pEnKGUNoZT1kHrtw7xJo4DKvQR2ylCbADTdkl+8pJvGXvcmvc7QpieB4YgOmDCNtYXR3tghLWp6QNDfVRSyaqp2qDlrO01QlaFU76PF7WkWH4coT+9d0YQNw+MEKLpOwa4UCMOLcSgBG8MsN0YDCRPb2focfbwEfgxe8basfmxB96Ha2KUq6+JW85JIvUnZKuFdrcaDuGETiWKmPpGFAPLMqwdxcs+VUdblh+noyMOJfVjZLtPpj7Vn70Gdy2mx6zODb7/sHUY6D7N+CLUHrcY+2L8Gy3INbYfbSz5gGDlr6F2RQMrXnpPbTMMbG0c/Uma6JrvdbV6kyeTxN8RxxvTJOW+0bqvdL5MJrdJiOHTzxAhp6aHv1q6i75NbFZgJehX5Ilur2eypK4oCI3GJmnCQRu6yibUkkmip79i5pKUXIyaLtrQUh/cbnIbqfztZZIGxz2ZJP5aM0kTvBFVTcShCFBlmrxj7mIVR7yvr7ak68vyj/b+mPqh+8GP7Iabrjau7z+qp34Pqw7XrjNhjFgmm5kC8WIw+nG+XXvzUS6jskhHKtFeVjFZkibSYdUfZcesGf3hSGeoSRKO7X5oW54WUX3wmNSuLrT6qIbhImYL5o9EydfeHXh9yl6TA4l5NKcH3d1pCnxnMXxoxUR6llbM+2N64/DOmGe77tR7V3m20E2Z0yUZCjPkq+2Pzpvg1BRRZg1nh7SHxJpkLautZKNVmtw8LMwNZHoQL+zh8xJnDpq6RgOZNgrN834o7skINz4+XqXJ8mHxlv+W4n1Jk7d4WLqfOdOhywL5V/D64tUqTYqHef1Lm4vxL2T2+OWqO+s2zvL3U50v38d9a/UQYTxUiI5yg96oE5Oj6QEx1bpEoe4g8WbmrSwNz8gYeRbiXXyFLo2NBwosZFmCwQwpHYdD2HGvgmB0+Pt1CLeYZJx9SwVsNNpmaolKxf6s73CK4Iycz5GSjgIFNw5JAig4yY3SdIgrMaP7f04jMngtdWMje4WwfI9fItmlrkDpM1ekmq8biT10OIWjL/uwPztUQoecoqyCk7O3j8CSTdgBuKLNUPBS+j7g5OwtJSbJWbDDhvDOtkhEaMUaCZBdBNdSxOSFdm9f+qgDKkZEs7BreWTDkBI0gLsM5dJu5SjtYqBtHuKdjrvcNZoi3ThKmpMhH8M6rO0ajsxFC+SZbh6zKh9AUsC84esURyobs5Q4LtslFknlExzZAcobE3OpwrIgSsp27HCKqBBRr/8UUFnfXMBMWIcmpdRHQt405OC0XeJNjUaiynALBPersNfxzg4Py49y4LSy3goZHx3Rvw0DYC1Tk5hpszjL5WdJ+ngn4H4TyBeT23HXDOosmK+K8V9sraqsIBOmQmvXrZgtTR4QoI+bVKVU+D6C8n58dPT+C0JulSbH28A51RW6grOAaOUujKaEyrpEQel9ZgliLqQCGt78gVihMdrcL/WHcXYfCMdHR+9HLQhf3AXhjeKYNCfvnukrVH+upP3hnR+eWL2p2HfwvkAiPRHXJ2vC9su9kBazxki3TCbnt8nNQNRy4Osn55erS1p1rtDkHtfaMsfCFckkObzjLXP2NLli57dJY8pkksTj3gqVU9j4zpEvanl4PUpW6WaLrQbCTmrrxFyq+eDeVpedqKc0HR7xNYE7f6aWf0NyaAKefao0kbQMChRkEhCCNMs/daGCb+NcRSd+q1/eTcqmpx0d7TXfeXNL3+IN95zh8+iJsnPZ+pZJJ1HS+n/0s/Xozrul1zpP0XcasdMxPj5m6/zLEZuxL16xhXj8cnXpEe5ZSxyO6R/5PlC4dnbF80yqmeYJCKCc1KhO6aykdX49umseY5npqs1PjOT//Ps/uEU8XVkNP4OTxkCtF2goGZ8SDmcl3kg6nXpvBcj75yiZqEq0lkICyuHc59nLOV9YxqMpE7WYylKS4hKZ9kkCPd23Q/i5QIpWUtUz4+9ur7EkfYdSa85CdxpE43TVz+WHhTZXM2IpBQFTSltGS7YVxiaoCqEyihz69ZyCNkBZ93SI1kZaBCErIqbDHGczmUnqmHYpIzIHlVBijjRYymY6oVDHpGOjp2QLWV02/rSn1GdE50XkyOUQviHrigWnwhydkCXm/qC3qTe0wqYVsvqnZNTWNLzM0HYZHyVeo2H99WZyU5ZQa+dNV/Ip+nNLHTkjlCVHwDMUp6aFL1giPEYulkOg8CUdEGSF0QIopbqiHPwBnLfL7GecWumwc1EWi8WdveT5epvvpCuaKRisddduzoW88/Sbtx/PSfPRVPZkdormWmYYNrIdYx4y8WE4Y0TGZ0zUZ1HL/95sQPt9KTNUFnsnwuvv3n4P1/BieJSkvd3zEQwffv/m629/PP2W+qX93evfaHg0POK4irauEqo31Nf+qc1Zt59tRP3aw3L/fmf/fmf/fmf/fmf/fmf/fmf/fmf/fmf/fmf/fmf/fmf/fudB+ffvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/5/vN8JuSpkOB7WpZCc7MS327chT+l881XPZZoUlMg0OU9ub+lq8Z0pVysq/q1BQ1lQl2lyLYyk8DnnQKUx14eyY65wSVfc/jZgcEbjp37d83X8RuoXpSr5Fq959u+l7edavT05PUvSZBpeHlU6pzZGLOhVklgkk4Q2bX7BxJDy2xPBaeWlUPOGE3YS3y+lKInGFev5TVec3xR+9PJ+hFr2uFxPfPKi0F8SbGuD/6Q78b/h8r9acl+zs0HANlLTFF6uVqv/A6s7k8M=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",source:"@site/docs/API-docs/createtemplate.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createtemplate",permalink:"/docs/API-docs/createtemplate",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztW+9yGzeSf5XOfHGsGlIirTg+1tXVOX8u690kckVypa4klQPONDmIZoAJgBHFqPhtn2QfbZ/kqhvAzJAiJdlOZbV1/CJxgAbQ/QMa6G40bhMn5jaZnCdnWNWlcGiTyzTJ0WZG1k5qlUySswIhVsPXBgWVw+u3b0CUpV5YaCwaC05DRpUIWWOdruTvYloiuNhxCotCZgVYNNcIwsK0bLA2UjkLM21gjgqNcFLNIddZUyFVLKQroDaY40wqzME602SuMWiH8K7WCmyTZWjtrCnbkTwbUqsUXIHMqEHXGGVBQKPkbw3CwUGkfi/zgwNwhXCQCQVTJHFykiYwhD12poLqtOKObY2ZnEkiDn0NL9SFOpP1BN7VpRY5LHVj4O03/9N2Qf1S2fnBwTc4bebw7s3BweXnhXO1nRweiroe6hqVlXNViqkdZro6zImwzmfPCUE0SL0yryisLJcg8hwWMp+jsyyxgkzXS8i0NrlUHvpazBFUU03R2BSEyqHSBkEqEGBQ5MuB04PGIvz19ORHmo5KuCG8LRubtsPl0mDmyqXvnhCIUj3zyLw8pvmRap5CJa5oIqWD3xqZXZHYFhXDGuaEsTo4OG3qWhuHOfzsRZgcHFDNV1jqBQiDTJ/pqtIKamFEhY5XG00YVRv8rZEGc79URFlGLCbUzYBmelnj5OAA3qhcZgQHd0mloGeBeuhJCSYiPQ1T60l74NHc+2VMqCyEn9G6FJln1CCtCievcb3jmxSW1PE3qHTkoNBG/q6VEyVPyDUaJzNR9ieOGOSl5oRhzai1VC6WhhHgf8ME0fzxtISVRazlBFclFddYhGtRNmgDV4sUCuLqJ6wNWl7hoV+CUuVQoJwXO8cT+a+NdWsdQ2OJzT4XYaw4TwwvMmwzUVoEOVvDshJX2BsNNG9DohzCV0vIcSaa0qUgac050+AQftQORF2XMuP9hrYSUh9Bu8SAZzksiMCIEhXP8Vujr2WOtCnkcjZDQ+pJldxFaBO5o5VWcwMSj3XHFUKBVhsTnelSG+p+Yw1x+TqQkGnlULkhvL4WsmTuvbQWpMrKJkeYliK7SnmrTMFg7nV3ibTxpn7JMwntpx50BggslrQMtSIBlA7DS9ttWsOzQtpOo6guQs1jSNtHNejtTNPABEFUMsBKyDJl4FL4VU/BSVdiSipbC7VMIRcOU3B446b6JoWswOyKfxmRSw3TxjnaqmnM3Og61wsVsJxp5az8fYtGxpoPB3ScwnEKL1N4lcLoKIXROIXRcQqjlymMXqUwPkphPE5hfJzC+KVna/wqQC1afPsMjMYeZNcDF542urTzfi8tazZtmbbdhRdru/CFGg3h4KDVJy7+5ZdfLtTthQK4SEi/LpLJRdKSXCQp+DraNi+SySiFUHBzkUzgxfjLSLCk75eErv9e0PeIZsN/F/Q9Hl2oVRh0zMw4UdX3MELVfzwT8TOsJyrkkaksbm1USHuSp6UamjcqbdmiilUn0AsSSCrppCjtbpkixdMTq+NsQ7JjkoxX726xuPrpyRTZijW8d/oq3mt7VXEbYEbGGxB8MexOmx0I+EGfGgCBq0+V/yXJ3+5Zu0FoSZ4eEn3WPhWOL4dsHvC+vRuMQPD0oOgY+1QgXhEQdG7tRoFqnx4EgatYEWwBX3d0PBh9MRgfjY/XYCA/yhNU1SDPB8vl8hMhBAaMzKMwPhubwZj1NiD5rDOjqy2eCjsSHVUwn/h3tO5/IJt+Gs1dzMlJXHd3o3vYN8idzsXymfVdxaatHUf0nRW37LHJVcQHu8pZoWUWmCeaaL1NyRscEggDAj4//OGHwx6UvnBQVRFfiKX0PWDo+6VVNczz4Sbt2gz1SivI8xS2lG+vyHOoqmpXua+g4/JC/ceQ4xBsuu3WhUDw56jDllXfjb9TV7oKkWtV8vjs3G3XlY3zpZAqVIR1AxsEBudNKQzekJdqpVaMyx+wE21oUVSizsxnp5b9QQ4ZeCTg85Ngyj8PC5wkWO+ASh5ud0ewficG53jDffh4GjEj8xDYsk1WkM8nosdAsHcBHv7KRC0puFCic1yKLhtuY8JPWs8xp0nd9MstujVhhIXYcotrzrPPjsboiM+94Jfcc/AFiqe37fc4i5U+2EHV5xdJJYLpksyw+61dgeYiuWzbeJcc815b2NYYLu/RJ+iUJsdSTLG8q2uP1oa+OGFl9cChikqqNpLALB9FDrhW3GzUhsrVFj3zYvcXeNzco5pEnKGUNoZT1kHrtw7xJo4DKvQR2ylCbADTdkl+8pJvGXvcmvc7QpieB4YgOmDCNtYXR3tghLWp6QNDfVRSyaqp2qDlrO01QlaFU76PF7WkWH4coT+9d0YQNw+MEKLpOwa4UCMOLcSgBG8MsN0YDCRPb2focfbwEfgxe8basfmxB96Ha2KUq6+JW85JIvUnZKuFdrcaDuGETiWKmPpGFAPLMqwdxcs+VUdblh+noyMOJfVjZLtPpj7Vn70Gdy2mx6zODb7/sHUY6D7N+CLUHrcY+2L8Gy3INbYfbSz5gGDlr6F2RQMrXnpPbTMMbG0c/Uma6JrvdbV6kyeTxN8RxxvTJOW+0bqvdL5MJrdJiOHTzxAhp6aHv1q6i75NbFZgJehX5Ilur2eypK4oCI3GJmnCQRu6yibUkkmip79i5pKUXIyaLtrQUh/cbnIbqfztZZIGxz2ZJP5aM0kTvBFVTcShCFBlmrxj7mIVR7yvr7ak68vyj/b+mPqh+8GP7Iabrjau7z+qp34Pqw7XrjNhjFgmm5kC8WIw+nG+XXvzUS6jskhHKtFeVjFZkibSYdUfZcesGf3hSGeoSRKO7X5oW54WUX3wmNSuLrT6qIbhImYL5o9EydfeHXh9yl6TA4l5NKcH3d1pCnxnMXxoxUR6llbM+2N64/DOmGe77tR7V3m20E2Z0yUZCjPkq+2Pzpvg1BRRZg1nh7SHxJpkLautZKNVmtw8LMwNZHoQL+zh8xJnDpq6RgOZNgrN834o7skINz4+XqXJ8mHxlv+W4n1Jk7d4WLqfOdOhywL5V/D64tUqTYqHef1Lm4vxL2T2+OWqO+s2zvL3U50v38d9a/UQYTxUiI5yg96oE5Oj6QEx1bpEoe4g8WbmrSwNz8gYeRbiXXyFLo2NBwosZFmCwQwpHYdD2HGvgmB0+Pt1CLeYZJx9SwVsNNpmaolKxf6s73CK4Iycz5GSjgIFNw5JAig4yY3SdIgrMaP7f04jMngtdWMje4WwfI9fItmlrkDpM1ekmq8biT10OIWjL/uwPztUQoecoqyCk7O3j8CSTdgBuKLNUPBS+j7g5OwtJSbJWbDDhvDOtkhEaMUaCZBdBNdSxOSFdm9f+qgDKkZEs7BreWTDkBI0gLsM5dJu5SjtYqBtHuKdjrvcNZoi3ThKmpMhH8M6rO0ajsxFC+SZbh6zKh9AUsC84esURyobs5Q4LtslFknlExzZAcobE3OpwrIgSsp27HCKqBBRr/8UUFnfXMBMWIcmpdRHQt405OC0XeJNjUaiynALBPersNfxzg4Py49y4LSy3goZHx3Rvw0DYC1Tk5hpszjL5WdJ+ngn4H4TyBeT23HXDOosmK+K8V9sraqsIBOmQmvXrZgtTR4QoI+bVKVU+D6C8n58dPT+C0JulSbH28A51RW6grOAaOUujKaEyrpEQel9ZgliLqQCGt78gVihMdrcL/WHcXYfCMdHR+9HLQhf3AXhjeKYNCfvnukrVH+upP3hnR+eWL2p2HfwvkAiPRHXJ2vC9su9kBazxki3TCbnt8nNQNRy4Osn55erS1p1rtDkHtfaMsfCFckkObzjLXP2NLli57dJY8pkksTj3gqVU9j4zpEvanl4PUpW6WaLrQbCTmrrxFyq+eDeVpedqKc0HR7xNYE7f6aWf0NyaAKefao0kbQMChRkEhCCNMs/daGCb+NcRSd+q1/eTcqmpx0d7TXfeXNL3+IN95zh8+iJsnPZ+pZJJ1HS+n/0s/Xozrul1zpP0XcasdMxPj5m6/zLEZuxL16xhXj8cnXpEe5ZSxyO6R/5PlC4dnbF80yqmeYJCKCc1KhO6aykdX49umseY5npqs1PjOT//Ps/uEU8XVkNP4OTxkCtF2goGZ8SDmcl3kg6nXpvBcj75yiZqEq0lkICyuHc59nLOV9YxqMpE7WYylKS4hKZ9kkCPd23Q/i5QIpWUtUz4+9ur7EkfYdSa85CdxpE43TVz+WHhTZXM2IpBQFTSltGS7YVxiaoCqEyihz69ZyCNkBZ93SI1kZaBCErIqbDHGczmUnqmHYpIzIHlVBijjRYymY6oVDHpGOjp2QLWV02/rSn1GdE50XkyOUQviHrigWnwhydkCXm/qC3qTe0wqYVsvqnZNTWNLzM0HYZHyVeo2H99WZyU5ZQa+dNV/Ip+nNLHTkjlCVHwDMUp6aFL1giPEYulkOg8CUdEGSF0QIopbqiHPwBnLfL7GecWumwc1EWi8WdveT5epvvpCuaKRisddduzoW88/Sbtx/PSfPRVPZkdormWmYYNrIdYx4y8WE4Y0TGZ0zUZ1HL/95sQPt9KTNUFnsnwuvv3n4P1/BieJSkvd3zEQwffv/m629/PP2W+qX93evfaHg0POK4irauEqo31Nf+qc1Zt59tRP3aw3L/fmf/fmf/fmf/fmf/fmf/fmf/fmf/fmf/fmf/fmf/fmf/fudB+ffvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/5/vN8JuSpkOB7WpZCc7MS327chT+l881XPZZoUlMg0OU9ub+lq8Z0pVysq/q1BQ1lQl2lyLYyk8DnnQKUx14eyY65wSVfc/jZgcEbjp37d83X8RuoXpSr5Fq959u+l7edavT05PUvSZBpeHlU6pzZGLOhVklgkk4Q2bX7BxJDy2xPBaeWlUPOGE3YS3y+lKInGFev5TVec3xR+9PJ+hFr2uFxPfPKi0F8SbGuD/6Q78b/h8r9acl+zs0HANlLTFF6uVqv/A6s7k8M=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Draft Template",permalink:"/docs/API-docs/drafttemplate"},next:{title:"Get Template",permalink:"/docs/API-docs/get-template"}},j={},f=[{value:"Request",id:"request",level:2}];function g(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Create Template"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/createtemplate"}),"\n",(0,i.jsxs)(n.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,i.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified.This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": { \n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "readonly": false,\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"You can provide signer optionally if you it as default signer"})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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'.",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Template created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/bfe4b778.1e67588d.js b/assets/js/bfe4b778.1e67588d.js deleted file mode 100644 index edfe2623d..000000000 --- a/assets/js/bfe4b778.1e67588d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2087],{67554:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>f,default:()=>v,frontMatter:()=>u,metadata:()=>x,toc:()=>g});var t=s(85893),l=s(11151),i=s(58219),n=(s(62316),s(51039)),d=s.n(n),o=(s(82723),s(9487)),r=s(41429),c=s(5397),m=s(4667),p=s(9472),h=s(85162);const u={id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdWG1vI7cR/isTfskFWL3Y56TIoih6zR0SI0FsxD4cUNswRstZiTGXZEiuZEHQt/yS/rT+kmLIXWll+ZxcG7RAvxgyd2Y4z8N5Izci4jyI8ka8tVXbkIlB3BVCUqi8clFZI0pxvSB47yRGgl4K3lyeA2ptVwHaQD5AtNBYqeo1oJHQZvG4IJAUUekAtgaE4KhStapAdobG8KNNghghLlRIhq3R6956tL0xhJpW4NBjQ5F8KGBtW6jQGBuhWqCZ5w1rpQmsqQhUzB70TqsAlSeMJMeiENaRR4Z4LkUp8iY9PlGI/UaivNkIgw2JUvS27pUUhVBMj8O4EE85O3/LgA92TxgNkUygZtThYjuefmmVJynK6FsqRIhrzbsF1ThNohD06LSVJMoadWCBakENinIj4tolyeiVmYtC1NY3GPcr2+1dtk8h/s3KNescunrp7VJJghlpO+B3wHykxmmMFOAVRtCEIYI1NJDtAXwhClFZE5nCciPQOa2qRPLk58C7bY5dt7OfqUqMez6SqCjw10z4bwNkcjDRVIqQfuwoF9tCGBs/2cwlQyTwtFS0SvEc1Nzk+BzaPuDx07bYRcXQxpZ1tCTPEXlsb6/NkmRwpuni+nIgOrNWE5qjaOSoglEGYNMirJTWkG3AxfUlLMlzYqazGsP7lNNJxlNFasnpNxSBykqCpUKgBpUuYLVQ1YIDfg1NGyKQ6WKoo44GKZ+CGEZw7JBU4VmPilwOlJnvy82RYZDKUxX1GlYqLmwbAaVUrI4aQiQXxkMWkxc7Iq9t6/9zJhHmrZIkIdrWQ2198jIVK5fSjBEoE6JvK1YOIFs+3YSDRfm387aiEPY89ayw0MB+AWRCVkeoMUTyBbRGMfO+dZHkziQ9OvKKTEXPULAtRFTxICzvB3XufsZlY7tlOU/BWRNyhp5Op8fVZNchuuoGoa0YTd1qvf7sjysPefm3EgWDPP0uXJ595zhlOpfexJeVTqenr0cn09H0T9cnX5VnX5dffjWeTqd/F4V4bPS+Ngm2Jobspf8HC8poZei+Z+3+dDq9f91RefYce13lcV1JXqJWEmpFWgLvGf5AAsl76//NyviCfy/BZ8g9+LMXQocbem1bI//XcJ/z6GWAZ/dnO4hfHkM8N5kynnKu7QOZ/wbCPZ7h9jFvz64eRrXKQum7OAA7XM8gA1WtV3GdRqTHETo1yt/LmzsePBqKC8vjlWvzTBUXohSTvrpMNoM6sxVszy/7iav1WpRiEaML5WQS0MiZfRxbR4armsZZGFe2maBTk+WJ2BZPNdC5T5AOEefKzEcvat3tEV/xqWTiD3Dv6Eenvqe1KHpah1Ld5LgglOTTEfBh/7Sf0t71R7Y7laejTT/Z/L5h5Wkbe3b8GE4fQhxMGN3YOWyVfftUprYJdhcmF47MFXvAQbY8Odr6A+nKNsQdnPtZL/7PX/+RNHrPUg58BhetB2dX5OtWJ3C1pkfFzXBwA+F7AA8EhI2mEPQauAfOPc+uUs1V5P7fdcIKHc6UVpw1LGZZ28Mg8cIYPiwoLsjzp889d3VJS9KcbKCtfUgN2wK20TZpj57NlfUPNbtUAMKsDcpQCBCIehUyC+SbSR9FBVgPaPK05LwKBKgaFubZgepaVYoNc4nwWEVo0OCceLMC2G9moavGAbyd8egVrG7zcMGXMqKYIaarxxje8jCXgPNivp2RzHNFKPJc11UMhmEkzChEcLy9qiiPXhE9XwSW5FPW5HtXqzU4y6VMoebrz/Bs2VD0aALX2+xQfzQ7+rrBJ+0hcT2GW3NrrjhY2kAcAFqZh1DemhHc7MLsA82CinT3qs/k1Wp1lMFfHOp8q+KinYEnZ/d687SY8n2ovvuH7zaRfBMu6ivyS1VRVz4+suckCU+6Ao9VKvBpWs7V4a9PFbjYalWRCcPEf/Pt5Q+whNfjqSgGNet3ODz54fybdz9evWO7XFVz/p2Mp+MpLzkbYoNmsNWTS/7T1N3sO9X/65tAV7sjPcaJ06hSA0ykb7rmdSMGRbUcPgfcFWJhQ2SRzWaGgd57vd3y8i8teW6Rd4VYoldcQ1OH6+Z6uauvH6X71U/9BRs+7WXhWUB9hzLcnpaoW8oF/4HWT544tnfbom9T7HGW+Cb7NbpmO3sLR8MLd9ms8aaqyMUXZYfTwuX7a1GIWfdc0aSXD+FxxU8luBKluBW3Ij3hpDrHQml9IzSaeYtzls9mubliyyc37MwPqTN3PxjYs5QctuyMhP8yrmcV/syR+j2t/7ITz18+qtBR20vz8dxtt9t/AahZ3sk=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,x={id:"API-docs/update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",source:"@site/docs/API-docs/update-document.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-document",permalink:"/docs/API-docs/update-document",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdWG1vI7cR/isTfskFWL3Y56TIoih6zR0SI0FsxD4cUNswRstZiTGXZEiuZEHQt/yS/rT+kmLIXWll+ZxcG7RAvxgyd2Y4z8N5Izci4jyI8ka8tVXbkIlB3BVCUqi8clFZI0pxvSB47yRGgl4K3lyeA2ptVwHaQD5AtNBYqeo1oJHQZvG4IJAUUekAtgaE4KhStapAdobG8KNNghghLlRIhq3R6956tL0xhJpW4NBjQ5F8KGBtW6jQGBuhWqCZ5w1rpQmsqQhUzB70TqsAlSeMJMeiENaRR4Z4LkUp8iY9PlGI/UaivNkIgw2JUvS27pUUhVBMj8O4EE85O3/LgA92TxgNkUygZtThYjuefmmVJynK6FsqRIhrzbsF1ThNohD06LSVJMoadWCBakENinIj4tolyeiVmYtC1NY3GPcr2+1dtk8h/s3KNescunrp7VJJghlpO+B3wHykxmmMFOAVRtCEIYI1NJDtAXwhClFZE5nCciPQOa2qRPLk58C7bY5dt7OfqUqMez6SqCjw10z4bwNkcjDRVIqQfuwoF9tCGBs/2cwlQyTwtFS0SvEc1Nzk+BzaPuDx07bYRcXQxpZ1tCTPEXlsb6/NkmRwpuni+nIgOrNWE5qjaOSoglEGYNMirJTWkG3AxfUlLMlzYqazGsP7lNNJxlNFasnpNxSBykqCpUKgBpUuYLVQ1YIDfg1NGyKQ6WKoo44GKZ+CGEZw7JBU4VmPilwOlJnvy82RYZDKUxX1GlYqLmwbAaVUrI4aQiQXxkMWkxc7Iq9t6/9zJhHmrZIkIdrWQ2198jIVK5fSjBEoE6JvK1YOIFs+3YSDRfm387aiEPY89ayw0MB+AWRCVkeoMUTyBbRGMfO+dZHkziQ9OvKKTEXPULAtRFTxICzvB3XufsZlY7tlOU/BWRNyhp5Op8fVZNchuuoGoa0YTd1qvf7sjysPefm3EgWDPP0uXJ595zhlOpfexJeVTqenr0cn09H0T9cnX5VnX5dffjWeTqd/F4V4bPS+Ngm2Jobspf8HC8poZei+Z+3+dDq9f91RefYce13lcV1JXqJWEmpFWgLvGf5AAsl76//NyviCfy/BZ8g9+LMXQocbem1bI//XcJ/z6GWAZ/dnO4hfHkM8N5kynnKu7QOZ/wbCPZ7h9jFvz64eRrXKQum7OAA7XM8gA1WtV3GdRqTHETo1yt/LmzsePBqKC8vjlWvzTBUXohSTvrpMNoM6sxVszy/7iav1WpRiEaML5WQS0MiZfRxbR4armsZZGFe2maBTk+WJ2BZPNdC5T5AOEefKzEcvat3tEV/xqWTiD3Dv6Eenvqe1KHpah1Ld5LgglOTTEfBh/7Sf0t71R7Y7laejTT/Z/L5h5Wkbe3b8GE4fQhxMGN3YOWyVfftUprYJdhcmF47MFXvAQbY8Odr6A+nKNsQdnPtZL/7PX/+RNHrPUg58BhetB2dX5OtWJ3C1pkfFzXBwA+F7AA8EhI2mEPQauAfOPc+uUs1V5P7fdcIKHc6UVpw1LGZZ28Mg8cIYPiwoLsjzp889d3VJS9KcbKCtfUgN2wK20TZpj57NlfUPNbtUAMKsDcpQCBCIehUyC+SbSR9FBVgPaPK05LwKBKgaFubZgepaVYoNc4nwWEVo0OCceLMC2G9moavGAbyd8egVrG7zcMGXMqKYIaarxxje8jCXgPNivp2RzHNFKPJc11UMhmEkzChEcLy9qiiPXhE9XwSW5FPW5HtXqzU4y6VMoebrz/Bs2VD0aALX2+xQfzQ7+rrBJ+0hcT2GW3NrrjhY2kAcAFqZh1DemhHc7MLsA82CinT3qs/k1Wp1lMFfHOp8q+KinYEnZ/d687SY8n2ovvuH7zaRfBMu6ivyS1VRVz4+suckCU+6Ao9VKvBpWs7V4a9PFbjYalWRCcPEf/Pt5Q+whNfjqSgGNet3ODz54fybdz9evWO7XFVz/p2Mp+MpLzkbYoNmsNWTS/7T1N3sO9X/65tAV7sjPcaJ06hSA0ykb7rmdSMGRbUcPgfcFWJhQ2SRzWaGgd57vd3y8i8teW6Rd4VYoldcQ1OH6+Z6uauvH6X71U/9BRs+7WXhWUB9hzLcnpaoW8oF/4HWT544tnfbom9T7HGW+Cb7NbpmO3sLR8MLd9ms8aaqyMUXZYfTwuX7a1GIWfdc0aSXD+FxxU8luBKluBW3Ij3hpDrHQml9IzSaeYtzls9mubliyyc37MwPqTN3PxjYs5QctuyMhP8yrmcV/syR+j2t/7ITz18+qtBR20vz8dxtt9t/AahZ3sk=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Document",permalink:"/docs/API-docs/getdocument"},next:{title:"Delete Document",permalink:"/docs/API-docs/deletedocument"}},j={},g=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Update Document"})}),"\n",(0,t.jsx)(d(),{method:"put",path:"/document/{document_id}"}),"\n",(0,t.jsx)(a.p,{children:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(r.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"ID of the document that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(a.p,{children:"Body"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,t.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,t.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"document description"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(i.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Document updated successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Document not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document not found!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/bfe4b778.7505206d.js b/assets/js/bfe4b778.7505206d.js new file mode 100644 index 000000000..5c72fc3c3 --- /dev/null +++ b/assets/js/bfe4b778.7505206d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2087],{67554:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var i=s(85893),t=s(11151),l=s(58219),n=(s(62316),s(51039)),o=s.n(n),d=(s(82723),s(9487)),r=s(41429),c=s(5397),m=s(4667),p=s(9472),h=s(85162);const u={id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdWO9uI7cRf5UJv+QCrCXZ56TIoih6zR2SQ4LYOPtwQG3DGC1nJcZckiG5kgVB3/IkfbQ+STHkrrSydM5dG7RAvxgyd/7+OJz5kWsRcRZEeSNe26ptyMQg7gohKVReuaisEaW4nhO8dxIjQS8Fry7fAmptlwHaQD5AtNBYqeoVoJHQZvE4J5AUUekAtgaE4KhStapAdoZG8LNNghghzlVIhq3Rq956tL0xhJqW4NBjQ5F8KGBlW6jQGBuhmqOZZYe10gTWVAQq5gj6oFWAyhNGkiNRCOvII6f4VopSZCd9fqIQO0eivFkLgw2JUvS27pUUhVAMj8M4F08xe/uaE97znnI0RDIlNaUuL7bj6ddWeZKijL6lQoS40uwtqMZpEoWgR6etJFHWqAMLVHNqUJRrEVcuSUavzEwUora+wbhb2Wzusn0K8W9WrlhnP9RLbxdKEkxJ2wG+A+QjNU5jpAAvMIImDBGsoYFsn8BXohCVNZEhLNcCndOqSiCPfwnsbX0Yup3+QlVC3POWREWBv2bAfz9BBgcTTKUI6ccWcrEphLHxs81ccooEnhaKlqmeg5qZXJ9D23s4fp6LbVUMbWxYR0vyXJGH9nbaLEkGp5ouri8HolNrNaE5qEauKjjJCdi0CEulNWQbcHF9CQvyfDDTXo3gfTrTScZTRWrBx28oApWVBAuFQA0qXcByrqo5F/wKmjZEINPVUAcdDY58KmI4gcOApApHIypyO1Bmtms3B4ZBKk9V1CtYqji3bQSUUrE6agiRXBgNUUxRbIG8tq3/z5FEmLVKkoRoWw+19SnK1KxcOmacgTIh+rZi5QCy5d1NebAo/3beVhTCDqceFRYa2C+ATMjqCDWGSL6A1ihG3rcuktyapEdHXpGp6CgECdz71L87wMOnY3FJvlEx9Jny1qCUQJrSPIHQVnPA/B1j6ykUoIyKCnUoIERsXCjAeoj0yH0FonXcPOlRhcjBL5WcUQygPlZH74jPSDWIofa2SbvP2JjVsBC2cUX7xNw1b6oK3dSqsdURFqjbY5htChFV3DvK94PZcD/lVrvZsJyn4KwJuaudTSaHHXg7VbuJwJBxBdSt1qsv/riWmpd/r7lgkGc/hMvzHxy3mS6kV/F5pbPJ2cuT08nJ5E/Xp9+U59+WX38zmkwmfxeFeGz0rp8LtiaG6KX/BwvKaGXovkft/mwyuX/ZQXl+DL2uW7tujC1QKwm1Ii2BfYY/EEDy3vp/c5o8E99z6XPKffLnz5QOk6Datkb+r9M9FtHzCZ7fn29T/PowxbcmQ8bM8No+kPlvZLjLZ+g+Zvcc6n5VqyyUvou9ZIfrOclAVetVXCVa+XiCTp3k7+XNHZO1huLcMiV1beahcS5KMe67y3g96DMbwfb8omeprdeiFPMYXSjH44BGTu3jyDoy3Bk1TsOoss0YnRovTsWmeKqBzn2GdIg4U2Z28qzW3S7jK96VDPxe3lv40akfaSWKHtahVMe254SSfNoC3ux3O2b7pt+y7a48pYM9G/w0gvd03B2lbEPGJsQeK+uo+pBedEtHx20/i5WpbYKkK6ELR+aKo+MCXJwehPWBdGUb6sdZL/7P3/6RNPqok5sv4KL14OySfN3qlHit6VExuRjc6PhexQSLsNEUgl4Bc4qZ57uAVDMVmU91zKJCh1OlFZ8oFrOs7WFwKMMIPswpzsnzpy89syRJC9J8EEFb+5AIkAVso22Sjx7ppfUPNYdUAMK0DcpQCBCIehUyc+SbXl9hiUegyezTeRUIUDUszFyM6lpVig1z+/BYRWjQ4CwRggI4bkah69QBvJ0ylQ1Wt5ms8SWXKOYU01VuBK+ZHKfEeTHfdklmnhaKzJO7bsJpGAlTChEcu1cVZSob0fPFakE+nah8j221Bme5zSnUzIiGe8uGokcTuBfngPqt2cLXEcnkQ+JqBLfm1lxxsbSBuAC0Mg+hvDUncLMtsw80DSrS3Yv+lC+Xy4PT/dW+zvcqztspeHJ2pzdLi6kXDNW3//BdMZJvwkV9RX6hKupay0d8jpPwuGv+WKXmn24fuXP89akCN2KtKjJh2BRefX/5Eyzg5WgiikE/+4SAxz+9/e7Nz1dv2C533Hz+TkeT0YSXnA2xQTNw9eTR5OnRXe+m2P/rG0vX15nZj51GlYZjAn3dDbYbMWi45fB55a4Qcxsii6zXUwz03uvNhpd/bcnz+LwrxAK94v6apl93T5LbRvtRuF+86x8s4PNeao4m1E8vw6Mr3RjyMHig1ZMno83dpuhHGEecJb7LcZ1cs52dhQNiwxM4a7yqKnLxWdkhk7h8fy0KMe2ef5r0kiQ8LvnpCZeiFLfiVqQnse3dL62vhUYza3HG8tksD15seeeGU/shTe3uByd2FJL9cZ4z4b+c11GFP3Ol/kirv2zF85ePKnTQ9tK8PXebzeZfMflY5Q==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",source:"@site/docs/API-docs/update-document.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-document",permalink:"/docs/API-docs/update-document",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdWO9uI7cRf5UJv+QCrCXZ56TIoih6zR2SQ4LYOPtwQG3DGC1nJcZckiG5kgVB3/IkfbQ+STHkrrSydM5dG7RAvxgyd/7+OJz5kWsRcRZEeSNe26ptyMQg7gohKVReuaisEaW4nhO8dxIjQS8Fry7fAmptlwHaQD5AtNBYqeoVoJHQZvE4J5AUUekAtgaE4KhStapAdoZG8LNNghghzlVIhq3Rq956tL0xhJqW4NBjQ5F8KGBlW6jQGBuhmqOZZYe10gTWVAQq5gj6oFWAyhNGkiNRCOvII6f4VopSZCd9fqIQO0eivFkLgw2JUvS27pUUhVAMj8M4F08xe/uaE97znnI0RDIlNaUuL7bj6ddWeZKijL6lQoS40uwtqMZpEoWgR6etJFHWqAMLVHNqUJRrEVcuSUavzEwUora+wbhb2Wzusn0K8W9WrlhnP9RLbxdKEkxJ2wG+A+QjNU5jpAAvMIImDBGsoYFsn8BXohCVNZEhLNcCndOqSiCPfwnsbX0Yup3+QlVC3POWREWBv2bAfz9BBgcTTKUI6ccWcrEphLHxs81ccooEnhaKlqmeg5qZXJ9D23s4fp6LbVUMbWxYR0vyXJGH9nbaLEkGp5ouri8HolNrNaE5qEauKjjJCdi0CEulNWQbcHF9CQvyfDDTXo3gfTrTScZTRWrBx28oApWVBAuFQA0qXcByrqo5F/wKmjZEINPVUAcdDY58KmI4gcOApApHIypyO1Bmtms3B4ZBKk9V1CtYqji3bQSUUrE6agiRXBgNUUxRbIG8tq3/z5FEmLVKkoRoWw+19SnK1KxcOmacgTIh+rZi5QCy5d1NebAo/3beVhTCDqceFRYa2C+ATMjqCDWGSL6A1ihG3rcuktyapEdHXpGp6CgECdz71L87wMOnY3FJvlEx9Jny1qCUQJrSPIHQVnPA/B1j6ykUoIyKCnUoIERsXCjAeoj0yH0FonXcPOlRhcjBL5WcUQygPlZH74jPSDWIofa2SbvP2JjVsBC2cUX7xNw1b6oK3dSqsdURFqjbY5htChFV3DvK94PZcD/lVrvZsJyn4KwJuaudTSaHHXg7VbuJwJBxBdSt1qsv/riWmpd/r7lgkGc/hMvzHxy3mS6kV/F5pbPJ2cuT08nJ5E/Xp9+U59+WX38zmkwmfxeFeGz0rp8LtiaG6KX/BwvKaGXovkft/mwyuX/ZQXl+DL2uW7tujC1QKwm1Ii2BfYY/EEDy3vp/c5o8E99z6XPKffLnz5QOk6Datkb+r9M9FtHzCZ7fn29T/PowxbcmQ8bM8No+kPlvZLjLZ+g+Zvcc6n5VqyyUvou9ZIfrOclAVetVXCVa+XiCTp3k7+XNHZO1huLcMiV1beahcS5KMe67y3g96DMbwfb8omeprdeiFPMYXSjH44BGTu3jyDoy3Bk1TsOoss0YnRovTsWmeKqBzn2GdIg4U2Z28qzW3S7jK96VDPxe3lv40akfaSWKHtahVMe254SSfNoC3ux3O2b7pt+y7a48pYM9G/w0gvd03B2lbEPGJsQeK+uo+pBedEtHx20/i5WpbYKkK6ELR+aKo+MCXJwehPWBdGUb6sdZL/7P3/6RNPqok5sv4KL14OySfN3qlHit6VExuRjc6PhexQSLsNEUgl4Bc4qZ57uAVDMVmU91zKJCh1OlFZ8oFrOs7WFwKMMIPswpzsnzpy89syRJC9J8EEFb+5AIkAVso22Sjx7ppfUPNYdUAMK0DcpQCBCIehUyc+SbXl9hiUegyezTeRUIUDUszFyM6lpVig1z+/BYRWjQ4CwRggI4bkah69QBvJ0ylQ1Wt5ms8SWXKOYU01VuBK+ZHKfEeTHfdklmnhaKzJO7bsJpGAlTChEcu1cVZSob0fPFakE+nah8j221Bme5zSnUzIiGe8uGokcTuBfngPqt2cLXEcnkQ+JqBLfm1lxxsbSBuAC0Mg+hvDUncLMtsw80DSrS3Yv+lC+Xy4PT/dW+zvcqztspeHJ2pzdLi6kXDNW3//BdMZJvwkV9RX6hKupay0d8jpPwuGv+WKXmn24fuXP89akCN2KtKjJh2BRefX/5Eyzg5WgiikE/+4SAxz+9/e7Nz1dv2C533Hz+TkeT0YSXnA2xQTNw9eTR5OnRXe+m2P/rG0vX15nZj51GlYZjAn3dDbYbMWi45fB55a4Qcxsii6zXUwz03uvNhpd/bcnz+LwrxAK94v6apl93T5LbRvtRuF+86x8s4PNeao4m1E8vw6Mr3RjyMHig1ZMno83dpuhHGEecJb7LcZ1cs52dhQNiwxM4a7yqKnLxWdkhk7h8fy0KMe2ef5r0kiQ8LvnpCZeiFLfiVqQnse3dL62vhUYza3HG8tksD15seeeGU/shTe3uByd2FJL9cZ4z4b+c11GFP3Ol/kirv2zF85ePKnTQ9tK8PXebzeZfMflY5Q==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Document",permalink:"/docs/API-docs/getdocument"},next:{title:"Delete Document",permalink:"/docs/API-docs/deletedocument"}},f={},g=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(a.p,{children:"Update Document"})}),"\n",(0,i.jsx)(o(),{method:"put",path:"/document/{document_id}"}),"\n",(0,i.jsx)(a.p,{children:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created."}),"\n",(0,i.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(a.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(r.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"ID of the document that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,i.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(a.p,{children:"Body"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,i.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,i.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"document description"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{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.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Document updated successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Document not found!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document not found!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/f0ff4a36.28386b54.js b/assets/js/f0ff4a36.28386b54.js new file mode 100644 index 000000000..98d526eeb --- /dev/null +++ b/assets/js/f0ff4a36.28386b54.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var i=s(85893),l=s(11151),n=s(58219),r=(s(62316),s(51039)),t=s.n(r),m=(s(82723),s(9487)),o=s(41429),c=s(5397),d=s(4667),p=s(9472),h=s(85162);const u={id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WO9uIzUQf5XBX+Ckbf60uTuIEKKCoxQQh2jRSdxFkXd3kvXVaxt7NmkU7TeehEfjSdB4d9NNm+tdBNyXNmvPf8/8ZuytILkMYvpafGuzqkRDQcwSkWPIvHKkrBFTcV0gXCBBRwLnv1wCGplqDLCxFZAFj+QVrhByJKl0AJnaikBCcJiphcogb7kHIhHWoZcs/TIXU7FE6jZFIpz0skRCz2ZthZEliqnoCOYqF4lQbJaTVIj7ttr0LWZ0mYNd7OwVifD4R6U85mJKvsJEBNpoFhtU6TSKROCt0zZHMV1IHZggK7CUYroVtHGRkrwyS5GIhfWlpP4K3sooZSrc9+O0yE4Ll4q6nrHa4KwJGFjQ6WjE//btDVWWYQiLSsMuKCIRmTXElk+3QjqnVRY3hm8DM20fWte4zdHzLIZUo7KLxrF+fHehbk7P0uK3H0SdiIXixeMkFEQuTIfDdqXyepDZkqWRouPFhfiDc4hFGEtHS3AaZUAIaml2qRidszpH/7FC2WTzcRIaCyGy1ncBvCuJ1oU6EXZt9nz5IPlvLUKKyPwcnVh4OwnSe7nhiiMsw/uj5O3hs73TlqF9LBAHzcJSKv1e6hTx63ahyzVXWPMeNZOnz07HZ58/HzP9WuVLpH/hf7P7UN9+0Z9rbdeYw0rqCgOcxKyUVHlMIJAs3eB95dDRs9G3PYWmKlP0fe7dyo77dDKpE7E5kuv5mONzJNPZ53UiiiOZJs/45OQSj+Qb94uDsHRaEs6vmpSed0dbP0YV6yugyS/NS78PC6m1GqXpK+RWUici8ygJ83N6PNFOR6dnJ+PRyej59fjZdPLF9OmzwWg0+l0k4raM2d21Okko+nXeflcu/yh6ms5+basPc99jrjxmNK/8wRp9LI9ZneRimJc25ykhtrnwuN7Yofmg7rnTA/X7EMmnXidicqgDX9kSqVBmCWuebdbemmUCbbsgvwG5lMoAp4n/5L9rzei9PQjVd9E5zrJ+XiujlcF5N37MJ6PRfLwLwuRhEHajnbEEC1uZ/OO6ekj/4w5N5mc7h54+dOjSrKRWeRxVr+0Nmo/rT189NeofZqxqiOK+2HO2v944GTCrvKJNnIlvT6RTJ83+9PWMJ03OFNsO03GIpkJMxbArgOG2N0DXguX5VTdix8LdTWxBmjy1twPr0HCf0TIN3E+H0qnhitvkfQ7p3BHUgeRSmeXJo1yzO4+v+FSawO/5fdeinfoRuUe3Ye1TtVeFAmWckGr+XtjI3Ab7pUPD6B+PajV+0Ktfoc5siXzHoQKhI//7z78iRxfWmEmfwMvKg7Nr9DzQS5PDQuOtSjVG4gh1uytTQFlqDEFvQBnCpZeEkKulIqnjRMCVn0knU6UV5x6TWeb20EvfMIBXBVKBnrc+9QgSclyh5pQFbe0NyyELsiJbRh1dsa2tv1mwSQlISKugDIYAAbFjQVNIkyF0Z5GA9SANoCH0zquAIFXJxAvrARcLlSkWzIXmZUZQSiOXyMoSYLs5Cs7blcoxgLdpFQiC1VV0hDWWiNS4aBDzMIBv1Qobx3mxuV1iDsuKRSSQ2RyhrTt2w+SQYiBwrF5lGIUGkp5A4wp9zL14kotKa3CWAUFJzffF/tmyIPLSBG5fjUHd0ezC57zlu1vUkcvNAN6YN4ZBG6qAnABamZswfWNO4PUuzV5hGhTh7LOuHtbr9YM6eLLPc6GoqFLw6Owd3zIuxqrps+8+nohEEPoyvFxcoV+prLuWvUPnMBIPW5iUWYTJdvLmGvv6PgNDllYZmoA9UDu/+OUnWMHZYCSSXuV/gMHDny6/efHz1QuWy9jU1N94MBqM4ixvA5XS9FT13yTu1+32Duz/h/eLFnkIb2notFQRvtv5p4He16L3pDHtv17MElHYQEyy3aYy4G9e1zUv/1GhZ4CfJWIlvWL7Ij7nKvDvfPc48U5PP/u1fed4Au94CDloeQekhlE0Xkp4NkvEDW7uPb3UMx7oGzRl0xqK8yxDRz3eB911r0VdvLgWiZAVFfsofhNRvP3B0g/atQ/vjQH8lzvNQYYv+bh/xM1XO/Jm550MrX8dNcdoVtf1P3KYmXQ=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",source:"@site/docs/API-docs/getdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocument",permalink:"/docs/API-docs/getdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WO9uIzUQf5XBX+Ckbf60uTuIEKKCoxQQh2jRSdxFkXd3kvXVaxt7NmkU7TeehEfjSdB4d9NNm+tdBNyXNmvPf8/8ZuytILkMYvpafGuzqkRDQcwSkWPIvHKkrBFTcV0gXCBBRwLnv1wCGplqDLCxFZAFj+QVrhByJKl0AJnaikBCcJiphcogb7kHIhHWoZcs/TIXU7FE6jZFIpz0skRCz2ZthZEliqnoCOYqF4lQbJaTVIj7ttr0LWZ0mYNd7OwVifD4R6U85mJKvsJEBNpoFhtU6TSKROCt0zZHMV1IHZggK7CUYroVtHGRkrwyS5GIhfWlpP4K3sooZSrc9+O0yE4Ll4q6nrHa4KwJGFjQ6WjE//btDVWWYQiLSsMuKCIRmTXElk+3QjqnVRY3hm8DM20fWte4zdHzLIZUo7KLxrF+fHehbk7P0uK3H0SdiIXixeMkFEQuTIfDdqXyepDZkqWRouPFhfiDc4hFGEtHS3AaZUAIaml2qRidszpH/7FC2WTzcRIaCyGy1ncBvCuJ1oU6EXZt9nz5IPlvLUKKyPwcnVh4OwnSe7nhiiMsw/uj5O3hs73TlqF9LBAHzcJSKv1e6hTx63ahyzVXWPMeNZOnz07HZ58/HzP9WuVLpH/hf7P7UN9+0Z9rbdeYw0rqCgOcxKyUVHlMIJAs3eB95dDRs9G3PYWmKlP0fe7dyo77dDKpE7E5kuv5mONzJNPZ53UiiiOZJs/45OQSj+Qb94uDsHRaEs6vmpSed0dbP0YV6yugyS/NS78PC6m1GqXpK+RWUici8ygJ83N6PNFOR6dnJ+PRyej59fjZdPLF9OmzwWg0+l0k4raM2d21Okko+nXeflcu/yh6ms5+basPc99jrjxmNK/8wRp9LI9ZneRimJc25ykhtrnwuN7Yofmg7rnTA/X7EMmnXidicqgDX9kSqVBmCWuebdbemmUCbbsgvwG5lMoAp4n/5L9rzei9PQjVd9E5zrJ+XiujlcF5N37MJ6PRfLwLwuRhEHajnbEEC1uZ/OO6ekj/4w5N5mc7h54+dOjSrKRWeRxVr+0Nmo/rT189NeofZqxqiOK+2HO2v944GTCrvKJNnIlvT6RTJ83+9PWMJ03OFNsO03GIpkJMxbArgOG2N0DXguX5VTdix8LdTWxBmjy1twPr0HCf0TIN3E+H0qnhitvkfQ7p3BHUgeRSmeXJo1yzO4+v+FSawO/5fdeinfoRuUe3Ye1TtVeFAmWckGr+XtjI3Ab7pUPD6B+PajV+0Ktfoc5siXzHoQKhI//7z78iRxfWmEmfwMvKg7Nr9DzQS5PDQuOtSjVG4gh1uytTQFlqDEFvQBnCpZeEkKulIqnjRMCVn0knU6UV5x6TWeb20EvfMIBXBVKBnrc+9QgSclyh5pQFbe0NyyELsiJbRh1dsa2tv1mwSQlISKugDIYAAbFjQVNIkyF0Z5GA9SANoCH0zquAIFXJxAvrARcLlSkWzIXmZUZQSiOXyMoSYLs5Cs7blcoxgLdpFQiC1VV0hDWWiNS4aBDzMIBv1Qobx3mxuV1iDsuKRSSQ2RyhrTt2w+SQYiBwrF5lGIUGkp5A4wp9zL14kotKa3CWAUFJzffF/tmyIPLSBG5fjUHd0ezC57zlu1vUkcvNAN6YN4ZBG6qAnABamZswfWNO4PUuzV5hGhTh7LOuHtbr9YM6eLLPc6GoqFLw6Owd3zIuxqrps+8+nohEEPoyvFxcoV+prLuWvUPnMBIPW5iUWYTJdvLmGvv6PgNDllYZmoA9UDu/+OUnWMHZYCSSXuV/gMHDny6/efHz1QuWy9jU1N94MBqM4ixvA5XS9FT13yTu1+32Duz/h/eLFnkIb2notFQRvtv5p4He16L3pDHtv17MElHYQEyy3aYy4G9e1zUv/1GhZ4CfJWIlvWL7Ij7nKvDvfPc48U5PP/u1fed4Au94CDloeQekhlE0Xkp4NkvEDW7uPb3UMx7oGzRl0xqK8yxDRz3eB911r0VdvLgWiZAVFfsofhNRvP3B0g/atQ/vjQH8lzvNQYYv+bh/xM1XO/Jm550MrX8dNcdoVtf1P3KYmXQ=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"},next:{title:"Update Document",permalink:"/docs/API-docs/update-document"}},f={},g=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(a.p,{children:"Get Document"})}),"\n",(0,i.jsx)(t(),{method:"get",path:"/document/{document_id}"}),"\n",(0,i.jsx)(a.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,i.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(a.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(o.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"objectId of Document",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(n.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"folder"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(a.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(a.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(a.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(a.p,{children:"]"})})})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "file": "https://exampleurl.com",\n "title": "sample doc",\n "note": "please sign document",\n "folder": {\n "objectId": "FGik23bhUJ",\n "name": "folder name"\n },\n "owner": "joe bee",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": true,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z",\n "enableTour": true,\n "redirect_url": "",\n "allow_modifications": false\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Document not found!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/f0ff4a36.6147969f.js b/assets/js/f0ff4a36.6147969f.js deleted file mode 100644 index 18fd1c25c..000000000 --- a/assets/js/f0ff4a36.6147969f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var i=s(85893),n=s(11151),l=s(58219),r=(s(62316),s(51039)),t=s.n(r),m=(s(82723),s(9487)),c=s(41429),o=s(5397),d=s(4667),p=s(9472),h=s(85162);const u={id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WOtu2zYUfpVT/lkLKL4kbtoJw9Bg7bKsxVIsKQosNQJKOrbYUCRLUr7A0L89yR5tTzIcSrLlOJca2/onschz5znfOeSKeT51LL5ir3VaFqi8Y+OIZehSK4wXWrGYXeYIp+ihJYGT92eAiicSHSx1CV6DRW8FzhAy9FxIBzzRpQcOzmAqJiKFrOHusYhpg5aT9LOMxWyKvt1kETPc8gI9WjJrxRQvkMWsJbgWGYuYILMM9zm7batOPmPqzzLQk7W9LGIWv5TCYsZib0uMmPNLSWKdKIxEFjFcGKkzZPGES0cEaY4FZ/GK+aUJlN4KNWURm2hbcN9dwQUPUmJmfhkmeXqYm4RV1ZjUOqOVQ0eCDgcD+rdtryvTFJ2blBLWQWERS7XyZHm8YtwYKdKw0f/siGm1a13tNkXPkhgvapVtNPb14+dTcXN4lOQffmVVxCaCFveTkHtvXNzvNyullb1UFyTNC7+/OBd+UA6RCKX93hKMRO4QnJiqdSoG57TM0H6rUNbZvJ+E2kIIrNUmgJuSaFyoIqbnasuXr5L/WSMkiMRP0QmFt5bAreVLqjiPhXs8SlbffbYbbSnqhwJxp1lYcCEfpU4QXzULba6ZXKtH1IyeHx8Oj16+GBL9XGRT9P/C/3p3V9920Z9IqeeYwYzLEh0chKzkvrQYgfO8ML3HyqGlJ6MXHYWqLBK0Xe71ypr7cDSqIrbck+vFkOKzJ9PRyypi+Z5Mo2M6OT7FPfmG3eLwWBjJPV5f1Cl93R5t9RBVqC+HKjtT53YbFhKtJXLVVUitpIpYapF7zE78w4l2ODg8OhgODgYvLofH8ej7+PlxbzAY/MEitihCdretjntk3TpvvkuTfQM91Q5ZByxvQw9Fs4rY6K7OdqEL9LlQU5jTzDC3Wk0jaGDY2yXwKRcKKPz2yX/X8tBafScEbiK0n2XdfBFKCoXXbVu/Hg0G18N1EEa7QViPTEp7mOhSZd/W1bv0P+zQ6Ppo7dDzXYfO1IxLkYUR8FLfoPq2/nTV+1r9bsaKmijssy1nu+u1kw7T0gq/DLPm4oAbcVDvx1djmuAoU3QzpIbh1OcsZv22APqrzmBaMZJnZ+3oWlrZmYQcV1miFz1tUBF+S5446lN9bkR/Ru3nNgc3Zg9q5/lUqOnBg1zjjccXdCp14Lf83rQ+I94i9b4mrF2qZgTPkYfJo6LviQ7MTbDPDSpC1XBUs+FOD/yIMtUF0t3B5wgt+d9//hU42rCGTHoC56UFo+doaVDmKoOJxIVIJAZiTv10fRVxyAuJzsklCOVxarlHyMRUeC5Dp6XKT7nhiZCCco/INHFb6KSv68HHHH2Olra+swgcMpyhpJQFqfUNyfEaeOl1EXS0xTbX9mZCJkXAISmdUOgcOMSWBVXOVYrQnkUE2gJXgMqjNVY4BC4KIp5oCziZiFSQYCo0y1MPBVd8iqQsArKbomCsnokMHVidlM6D07IMjpDGAtHXLirEzPXgtZhh7Tgt1rc2zGBakogIUp0hNHVHbqgMEnQeDKkXKQahznPrQeIMbci9cJKTUkowmgBBcEn3sO7ZkiBvuXLUyGuD2qNZh89YTXeioCPjyx58Up8UgTaUDikBpFA3Lv6kDuBqnWYfMXHC4/hpWw/z+XynDp5t85wKn5cJWDR6wzcNi6Fquuzrj2csYh5t4c4nF2hnIm2vO/fo7AfifgOTPA0w2Uy0VGOvbjMQZEmRonLYAbWT0/fvYAZHvQGLOpX/FQb335399Oa3izckl7Cprr9hb9AbhBlZO19w1VHVvevfrtvVBuz/h3eBBnk8LnzfSC4CfAdnVw30XrHOU0HcfRUYRyzXzhPJapVwhx+srCpa/lKiJYAfR2zGrSD7Aj5nwtHvbH3pv9fTp7837wfP4J4Hhjstb4FUEYqGYZ/FjEXsBpe3njSqMQ3KNZqSaTXFSZqi8R3ene661aJO31yyiPHS59sofhNQvPlB0u+0axveawPoL3WaOxl+oON+i8sf1+T1zr0MjX8tNcVoXFXVPw/EXtA=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",source:"@site/docs/API-docs/getdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocument",permalink:"/docs/API-docs/getdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WOtu2zYUfpVT/lkLKL4kbtoJw9Bg7bKsxVIsKQosNQJKOrbYUCRLUr7A0L89yR5tTzIcSrLlOJca2/onschz5znfOeSKeT51LL5ir3VaFqi8Y+OIZehSK4wXWrGYXeYIp+ihJYGT92eAiicSHSx1CV6DRW8FzhAy9FxIBzzRpQcOzmAqJiKFrOHusYhpg5aT9LOMxWyKvt1kETPc8gI9WjJrxRQvkMWsJbgWGYuYILMM9zm7batOPmPqzzLQk7W9LGIWv5TCYsZib0uMmPNLSWKdKIxEFjFcGKkzZPGES0cEaY4FZ/GK+aUJlN4KNWURm2hbcN9dwQUPUmJmfhkmeXqYm4RV1ZjUOqOVQ0eCDgcD+rdtryvTFJ2blBLWQWERS7XyZHm8YtwYKdKw0f/siGm1a13tNkXPkhgvapVtNPb14+dTcXN4lOQffmVVxCaCFveTkHtvXNzvNyullb1UFyTNC7+/OBd+UA6RCKX93hKMRO4QnJiqdSoG57TM0H6rUNbZvJ+E2kIIrNUmgJuSaFyoIqbnasuXr5L/WSMkiMRP0QmFt5bAreVLqjiPhXs8SlbffbYbbSnqhwJxp1lYcCEfpU4QXzULba6ZXKtH1IyeHx8Oj16+GBL9XGRT9P/C/3p3V9920Z9IqeeYwYzLEh0chKzkvrQYgfO8ML3HyqGlJ6MXHYWqLBK0Xe71ypr7cDSqIrbck+vFkOKzJ9PRyypi+Z5Mo2M6OT7FPfmG3eLwWBjJPV5f1Cl93R5t9RBVqC+HKjtT53YbFhKtJXLVVUitpIpYapF7zE78w4l2ODg8OhgODgYvLofH8ej7+PlxbzAY/MEitihCdretjntk3TpvvkuTfQM91Q5ZByxvQw9Fs4rY6K7OdqEL9LlQU5jTzDC3Wk0jaGDY2yXwKRcKKPz2yX/X8tBafScEbiK0n2XdfBFKCoXXbVu/Hg0G18N1EEa7QViPTEp7mOhSZd/W1bv0P+zQ6Ppo7dDzXYfO1IxLkYUR8FLfoPq2/nTV+1r9bsaKmijssy1nu+u1kw7T0gq/DLPm4oAbcVDvx1djmuAoU3QzpIbh1OcsZv22APqrzmBaMZJnZ+3oWlrZmYQcV1miFz1tUBF+S5446lN9bkR/Ru3nNgc3Zg9q5/lUqOnBg1zjjccXdCp14Lf83rQ+I94i9b4mrF2qZgTPkYfJo6LviQ7MTbDPDSpC1XBUs+FOD/yIMtUF0t3B5wgt+d9//hU42rCGTHoC56UFo+doaVDmKoOJxIVIJAZiTv10fRVxyAuJzsklCOVxarlHyMRUeC5Dp6XKT7nhiZCCco/INHFb6KSv68HHHH2Olra+swgcMpyhpJQFqfUNyfEaeOl1EXS0xTbX9mZCJkXAISmdUOgcOMSWBVXOVYrQnkUE2gJXgMqjNVY4BC4KIp5oCziZiFSQYCo0y1MPBVd8iqQsArKbomCsnokMHVidlM6D07IMjpDGAtHXLirEzPXgtZhh7Tgt1rc2zGBakogIUp0hNHVHbqgMEnQeDKkXKQahznPrQeIMbci9cJKTUkowmgBBcEn3sO7ZkiBvuXLUyGuD2qNZh89YTXeioCPjyx58Up8UgTaUDikBpFA3Lv6kDuBqnWYfMXHC4/hpWw/z+XynDp5t85wKn5cJWDR6wzcNi6Fquuzrj2csYh5t4c4nF2hnIm2vO/fo7AfifgOTPA0w2Uy0VGOvbjMQZEmRonLYAbWT0/fvYAZHvQGLOpX/FQb335399Oa3izckl7Cprr9hb9AbhBlZO19w1VHVvevfrtvVBuz/h3eBBnk8LnzfSC4CfAdnVw30XrHOU0HcfRUYRyzXzhPJapVwhx+srCpa/lKiJYAfR2zGrSD7Aj5nwtHvbH3pv9fTp7837wfP4J4Hhjstb4FUEYqGYZ/FjEXsBpe3njSqMQ3KNZqSaTXFSZqi8R3ene661aJO31yyiPHS59sofhNQvPlB0u+0axveawPoL3WaOxl+oON+i8sf1+T1zr0MjX8tNcVoXFXVPw/EXtA=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"},next:{title:"Update Document",permalink:"/docs/API-docs/update-document"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(a.p,{children:"Get Document"})}),"\n",(0,i.jsx)(t(),{method:"get",path:"/document/{document_id}"}),"\n",(0,i.jsx)(a.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,i.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(a.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(c.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"objectId of Document",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"folder"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(a.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(a.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(a.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(a.p,{children:"]"})})})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "file": "https://exampleurl.com",\n "title": "sample doc",\n "note": "please sign document",\n "folder": {\n "objectId": "FGik23bhUJ",\n "name": "folder name"\n },\n "owner": "joe bee",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": true,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Document not found!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,n.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.b8b3b66b.js b/assets/js/fa40969b.b8b3b66b.js deleted file mode 100644 index e7b1cdf50..000000000 --- a/assets/js/fa40969b.b8b3b66b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[273],{61247:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var n=a(85893),i=a(11151),l=a(58219),r=(a(62316),a(51039)),t=a.n(r),m=(a(82723),a(9487)),c=a(41429),d=a(5397),o=a(4667),p=a(9472),h=a(85162);const u={id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztWG1v27YW/itn7IethWLLidNuwnCxYO0Nsg23RZOhwG2MgJKOLTYUyZGUX2Do2/0l+2n7JReHkmw5TtJ4G/ppXxKLPO98zgu5Zp7PHEs+stc6q0pU3rFJxHJ0mRXGC61Ywp49ewbdNlytDLrkWr1HbwXOEThI4TzoKeSdCEi5wxy0Ar8yeK2u1WgAL168tnzqN5Jc8uLFtQIAONqugS+4B24RsspaVF6uQCjIA6fz3FduQPKOSd6FOnpn9cyic39KqmmZg8QTkvijLo1Ej/lT5BV8jpAiKnBVlqFz00rKFWQbGQvhC+BSgsXfKmExBydmivvKYqNzTDrfLE3Ye6pGbOm5yoNLSoPUaoYWeLBCpBKD9NMQc8ykUIc6lHdc6Qp8gVA5tINrxSKmDVpOuLjIWcJm6LtDJxCwiBlueYkeLYFqzRQvkSUs1xkhgUVMEKAM9wW7i7KrAgNcdpHkNdgWaSxiXSBZ4m2FEXN+JUm+ExRzFjFcGqlzZMmUS0cEWYElZ8maBf0Jc94KNSNKVZWE+wCtYFgHBxaxzRk2IoNKsreJCpvUdbTxTYpS+M6z3yq0qx1DO0NaS6faln07Wz82ZpZ8KUqy7DSOo85oVZUpWlYTHw+eJqO4Z4K7FeZvs+BhnXE9IbnOaOXQEe1xHNO/3YPcZgNs0BJiqjwqT/TcGCmysDH85IhpvW+ATj9hFiBlSYwXjUqLrpK+R8et5eSw8Fi6z/M3y4TefUxQaLjfQUnnO/v3ubg9PkmLX3+imEwFLR4mofDeuGQ4bFcqKweZLkmaF/5wcS78oFQhEUr7gyUYidxhKEqbjAvOaZmj/VKhbDB8mITGQgis9TaArPPipnWhjpheqB1fniT/kw6FkPgpOqGa/VnAWX3/2W61ZagfC8S9ZmHJhfwsdYr4Q7vQYc0UWn1Gzfj05fHo5NtXI6JfiHyG/i/43+zu69stGmdS6gXmMOeyQgdH21YZUd8vzeBz6dDRk9HL/ULW496sbLiPx+M6YqsDuV6NKD4HMp18W0esOJBp/JJOjs/wQL5RPzk8lkZyjzeXDaRvuqOtH6MK+eVQ5Rfqrd0tC6nWErnqK6RmUkcss8g95mf+caAdx8cnR6P4KH51NXqZjL9LTl8O4jj+L4vYsgzo7uYH7pH187z9rkz+BfTUe2S9Ynm39OxGUyiaGG66pnlzHMc3YyKpIzaOx/vN8z0abT0o7YHPuZA8lfjV39c90Vp9bzXcBut+Cx5zahyPb043Tp3uO3Wh5lyKHM7eXcCVvkX1ZT3qq/eN+v0zFQ1R2Gc7zvbXGycdZpUVfhVG3OURN+Ko2U8+TmhGKtEXup2Pw0zsC5awYX9UHq7bmbhmJM/Ou4m5srI3Kziu8lQvB9qgogoneeqokg+5EcM5Fei7HNyYA6id5zOhZkePck22Hl/SqTSB3/F72xyM+BmpO7Rh7VO1E2qBPPTmmr6nOjC3wX5rUFHdCUc1H+11iQ8oM10i3QroWtKR//G/3wNHF+CApK/gbWXB6AVaGkXpujSVuKTrUSDm1HEcrHRF4hzyUqJz4WbocWa5R8jFTHguQy8SagYZNzwVUhD2iEwTt4UefN0APhToC7S09bWl63GOc5QEWZBa35Icr4FXXpdBR3exXmh7OyWTIuCQVk4outc6xI4FVcFVhtCdRQTaAleAyqM1VjgELkoinmoLOJ2KTJBgSjTLMw8lV3yGpCwCspuiYKyeixwdWJ1WzoPTsgqOkMYS0TcuKsTcDeC1mGPjOC3m6LmQmMOsIhERZDqn+2nIO3JD5ZCi82BIvcgwCHWeWw8S52gD9sJJ0tUZjKaCILikK2D/bEmQt1w5anWNQd3RbMJnrKZbR9CR89UA6Ap8SWCpHBIApFC39HBxBB83MPuAqRMeJ990+bBYLPby4Pkuz7nwRZWCRaO3fLOwGLKmz775eM4i5tGW7u30Eu1cZN2F4AGdw0A8bMskz0KZbGc+yrEf7jJQyZIiQ+WwV9TOzt/9AnM4GcQs6mX+Ewwe/nLx45v/XL4huVSbmvwbDeJBHKZI7XzJVU/VOW6fdpoXoanVZftmczeR19vq/8/r0j+vS5vXpbaJeFz6oZFchE4ccLtuu+hHdufBKeneliYRK7TzRLJeE0R+tbKuabl5EqHmmgtH48z2UeQWV70nnHD5YAkLjfIB2vatZUs6oQ8riPZ+HQ8i/5v37ck9h6c8ft0bnK7tqlXfqM7YLjb1hC4dTd8lG5vdsyxD0/d7bw7bGWbO31yxiPHKF7v9/jb0+/YHSb/Xpt1BoDGA/lKo72X4ntrTz7j614a82XmQofWvo6b4TOq6/j88Fdwk",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/getdocumentlist",title:"Get Document list from status",description:"### Document Types:",source:"@site/docs/API-docs/getdocumentlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocumentlist",permalink:"/docs/API-docs/getdocumentlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztWG1v27YW/itn7IethWLLidNuwnCxYO0Nsg23RZOhwG2MgJKOLTYUyZGUX2Do2/0l+2n7JReHkmw5TtJ4G/ppXxKLPO98zgu5Zp7PHEs+stc6q0pU3rFJxHJ0mRXGC61Ywp49ewbdNlytDLrkWr1HbwXOEThI4TzoKeSdCEi5wxy0Ar8yeK2u1WgAL168tnzqN5Jc8uLFtQIAONqugS+4B24RsspaVF6uQCjIA6fz3FduQPKOSd6FOnpn9cyic39KqmmZg8QTkvijLo1Ej/lT5BV8jpAiKnBVlqFz00rKFWQbGQvhC+BSgsXfKmExBydmivvKYqNzTDrfLE3Ye6pGbOm5yoNLSoPUaoYWeLBCpBKD9NMQc8ykUIc6lHdc6Qp8gVA5tINrxSKmDVpOuLjIWcJm6LtDJxCwiBlueYkeLYFqzRQvkSUs1xkhgUVMEKAM9wW7i7KrAgNcdpHkNdgWaSxiXSBZ4m2FEXN+JUm+ExRzFjFcGqlzZMmUS0cEWYElZ8maBf0Jc94KNSNKVZWE+wCtYFgHBxaxzRk2IoNKsreJCpvUdbTxTYpS+M6z3yq0qx1DO0NaS6faln07Wz82ZpZ8KUqy7DSOo85oVZUpWlYTHw+eJqO4Z4K7FeZvs+BhnXE9IbnOaOXQEe1xHNO/3YPcZgNs0BJiqjwqT/TcGCmysDH85IhpvW+ATj9hFiBlSYwXjUqLrpK+R8et5eSw8Fi6z/M3y4TefUxQaLjfQUnnO/v3ubg9PkmLX3+imEwFLR4mofDeuGQ4bFcqKweZLkmaF/5wcS78oFQhEUr7gyUYidxhKEqbjAvOaZmj/VKhbDB8mITGQgis9TaArPPipnWhjpheqB1fniT/kw6FkPgpOqGa/VnAWX3/2W61ZagfC8S9ZmHJhfwsdYr4Q7vQYc0UWn1Gzfj05fHo5NtXI6JfiHyG/i/43+zu69stGmdS6gXmMOeyQgdH21YZUd8vzeBz6dDRk9HL/ULW496sbLiPx+M6YqsDuV6NKD4HMp18W0esOJBp/JJOjs/wQL5RPzk8lkZyjzeXDaRvuqOtH6MK+eVQ5Rfqrd0tC6nWErnqK6RmUkcss8g95mf+caAdx8cnR6P4KH51NXqZjL9LTl8O4jj+L4vYsgzo7uYH7pH187z9rkz+BfTUe2S9Ynm39OxGUyiaGG66pnlzHMc3YyKpIzaOx/vN8z0abT0o7YHPuZA8lfjV39c90Vp9bzXcBut+Cx5zahyPb043Tp3uO3Wh5lyKHM7eXcCVvkX1ZT3qq/eN+v0zFQ1R2Gc7zvbXGycdZpUVfhVG3OURN+Ko2U8+TmhGKtEXup2Pw0zsC5awYX9UHq7bmbhmJM/Ou4m5srI3Kziu8lQvB9qgogoneeqokg+5EcM5Fei7HNyYA6id5zOhZkePck22Hl/SqTSB3/F72xyM+BmpO7Rh7VO1E2qBPPTmmr6nOjC3wX5rUFHdCUc1H+11iQ8oM10i3QroWtKR//G/3wNHF+CApK/gbWXB6AVaGkXpujSVuKTrUSDm1HEcrHRF4hzyUqJz4WbocWa5R8jFTHguQy8SagYZNzwVUhD2iEwTt4UefN0APhToC7S09bWl63GOc5QEWZBa35Icr4FXXpdBR3exXmh7OyWTIuCQVk4outc6xI4FVcFVhtCdRQTaAleAyqM1VjgELkoinmoLOJ2KTJBgSjTLMw8lV3yGpCwCspuiYKyeixwdWJ1WzoPTsgqOkMYS0TcuKsTcDeC1mGPjOC3m6LmQmMOsIhERZDqn+2nIO3JD5ZCi82BIvcgwCHWeWw8S52gD9sJJ0tUZjKaCILikK2D/bEmQt1w5anWNQd3RbMJnrKZbR9CR89UA6Ap8SWCpHBIApFC39HBxBB83MPuAqRMeJ990+bBYLPby4Pkuz7nwRZWCRaO3fLOwGLKmz775eM4i5tGW7u30Eu1cZN2F4AGdw0A8bMskz0KZbGc+yrEf7jJQyZIiQ+WwV9TOzt/9AnM4GcQs6mX+Ewwe/nLx45v/XL4huVSbmvwbDeJBHKZI7XzJVU/VOW6fdpoXoanVZftmczeR19vq/8/r0j+vS5vXpbaJeFz6oZFchE4ccLtuu+hHdufBKeneliYRK7TzRLJeE0R+tbKuabl5EqHmmgtH48z2UeQWV70nnHD5YAkLjfIB2vatZUs6oQ8riPZ+HQ8i/5v37ck9h6c8ft0bnK7tqlXfqM7YLjb1hC4dTd8lG5vdsyxD0/d7bw7bGWbO31yxiPHKF7v9/jb0+/YHSb/Xpt1BoDGA/lKo72X4ntrTz7j614a82XmQofWvo6b4TOq6/j88Fdwk",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Document",permalink:"/docs/API-docs/deletedocument"},next:{title:"Resend request mail",permalink:"/docs/API-docs/resendrequestmail"}},g={},f=[{value:"Document Types:",id:"document-types",level:3},{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(s.p,{children:"Get Document list from status"})}),"\n",(0,n.jsx)(t(),{method:"get",path:"/documentlist/{doctype}"}),"\n",(0,n.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,n.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,n.jsxs)(s.ol,{children:["\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Path Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(c.Z,{className:"paramsItem",param:{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draft","inprogress","completed","expired","declined"]}}})})})]}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Query Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsxs)("ul",{children:[(0,n.jsx)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,n.jsx)(c.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(l.Z,{children:[(0,n.jsxs)(h.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"successful operation"})}),(0,n.jsx)("div",{children:(0,n.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"result"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"document[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"folder"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"signers"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"widgets"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(d.Z,{responseExample:'{\n "result": [\n {\n "objectId": "FGik23bhUJ",\n "file": "https://exampleurl.com",\n "title": "sample doc",\n "note": "please sign document",\n "folder": {\n "objectId": "FGik23bhUJ",\n "name": "folder name"\n },\n "owner": "joe bee",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": true,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Report not available!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(d.Z,{responseExample:'{\n "error": "Report not available!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"405",value:"405",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Invalid API Token!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.e283f01a.js b/assets/js/fa40969b.e283f01a.js new file mode 100644 index 000000000..e1da6436a --- /dev/null +++ b/assets/js/fa40969b.e283f01a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[273],{61247:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>y});var i=a(85893),n=a(11151),l=a(58219),r=(a(62316),a(51039)),t=a.n(r),m=(a(82723),a(9487)),c=a(41429),o=a(5397),d=a(4667),p=a(9472),h=a(85162);const x={id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztWN1uGzcWfpVT5qJNMJJGtpy0QrGo0WQNt8UmiF0E2FgQODNHGsYckiU5+oExd/skfbQ+yeJwZqSRJTtWW+SqN7aGPP/8zg95xzyfOzb+yF7rtCxQeccmEcvQpVYYL7RiY/bs2TNot+F6bdCNb9R79FbgAoGDFM6DnkHWioCEO8xAK/BrgzfqRg378OLFa8tnfiPJjV+8uFEAAL3tGvice+AWIS2tReXlGoSCLHA6z33p+iTvhORdqt47q+cWnftTUk3DHCSeksQfdWEkesyeIi/nC4QEUYEr0xSdm5VSriHdyFgKnwOXEiz+VgqLGTgxV9yXFmudI9L5ZmXC3lM1YkPPVRZcUhqkVnO0wIMVIpEYpJ+FmGMqhTrWoazlStbgc4TSoe3fKBYxbdBywsVlxsZsjr49dAIBi5jhlhfo0RKo7pjiBbIxy3RKSGAREwQow33O7qPsOscAl10keQ22QRqLWBtINva2xIg5v5Yk3wmKOYsYrozUGbLxjEtHBGmOBWfjOxb0j5nzVqg5UaqyINwHaAXDWjiwiG3OsBYZVJK9dVTYpKqijW9SFMK3nv1Wol3vGNoa0lg607bo2tn4sTGz4CtRkGVncRy1RquySNCyivh48HQ8jDsmuFth/jYLHtYZVxOS64xWDh3RnsQx/ds9yG02wAYtIabKo/JEz42RIg0bg0+OmO72DdDJJ0wDpCyJ8aJWadGV0nfouLWcHBYeC/d5/nqZ0LuPCQoN9zsoaX1n/74QtyenSf7rTxSTmaDF4yTk3hs3HgyaldLKfqoLkuaFP16cCz8oVUiE0v5oCUYidxiK0ibjgnNaZmi/VChrDB8nobYQAmu1DSBrvZg2LlQR00u148uT5H/SoRASP0UnVLM/CzirD5/tVluK+rFAHDQLCy7kZ6kTxB+ahRZrJtfqM2pGZy9PhqffvhoS/VJkc/R/wf96d1/fbtE4l1IvMYMFlyU66G1bZUR9vzD9z6VDS09Gr/YLWYd7s7LhPhmNqoitj+R6NaT4HMl0+m0VsfxIptFLOjk+xyP5ht3k8FgYyT1Or2pIT9ujrR6jCvnlUGWX6q3dLQuJ1hK56iqkZlJFLLXIPWbn/nGgncQnp71h3ItfXQ9fjkffjc9e9uM4/i+L2KoI6G7nB+6RdfO8+S5N9kX0oOKJxGtdPs19i5mwmPppaQ/m6GM4JnWckmFa6EzMmjbpHtcbWjwd1D13OkX9foncPXWhaLKZts19ehLH0xGRVBEbxaP9Jv8ejbYelPbAF1xIis9Xf1+XR2v1waq9DdRhCx5zahSPpmcbp872nbpUCy5FBufvLuFa36L6sh511fta/f6Zipoo7LMdZ7vrtZMO09IKvw6j+KrHjejV++OPE5rlCvS5bub4MLv7nI3ZoDvSD+6a2b1iJM8u2sk+QHsz0ziuskSv+tqgokoseeKo4wy4EYMFNZL7HNyYI6id53Oh5r1HuSZbj6/oVOrA7/i9bWJG/IzUxZqwdqmaSTpHHmaIir5nOjA3wX5rUFF9DEe1GO51sw8oU10g3V7o+tSS//G/3wNHG+CApK/gbWnB6CVaGpnpWjeTuKJrXCAOxcDBWpckziEvJDoXbrAe55Z7hEzMhecy9Eyh5pBywxMhBWGPyDRxW+jA1/XhQ44+R0tbX1u6xme4QEmQBan1LcnxGnjpdRF0tA8AS21vZ2RSBByS0glF92+H2LKgyrlKEdqziEBb4ApQebTGCofARUHEM20BZzORChJMiWZ56qHgis+RlEVAdlMUjNULkaEDq5PSeXBalsER0lgg+tpFhZi5PrwWC6wdp8UMPRcSM5iXJCKCVGd0jw55R26oDBJ0HgypFykGoc5z60HiAm3AXjhJuuKD0VQQBJd0Ve2eLQnylitHBb42qD2aTfiM1XQ7Cjoyvu4DXdWvCCylQwKAFOqWHlh68HEDsw+YOOFx8k2bD8vlci8Pnu/yXAiflwlYNHrLNw+LIWu67JuP5yxiHm3h3s6u0C5E2l5cHtA5CMSDpkzyNJTJZjalHPvhPgOVLClSVA47Re384t0vsIDTfsyiTuY/weDBL5c/vvnP1RuSS7Wpzr9hP+7HYdrVzhdcdVRd4PYJqn65mlldNG9L9xP5blv9/3kF++cVbPMK1jQRjys/MJKL0ImbYa/uoh/ZvYexcfsGNolYrp0nkrs7gsivVlYVLddPN9RcM+FonNk+3tziuvPUFC5J9az4IG3zJrQlndCHFUR7WMeDyP/mfXNyz+Epj3QHg9O2XbXuGtUa28ammtDlqO67ZGO9e56maLp+781hO8PMxZtrFjFe+ny339+Gft/8IOkHbdodBGoD6C+F+iDD99Sefsb1vzbk9c6DDI1/LTXFZ1JV1f8BGbwW1w==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/getdocumentlist",title:"Get Document list from status",description:"### Document Types:",source:"@site/docs/API-docs/getdocumentlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocumentlist",permalink:"/docs/API-docs/getdocumentlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztWN1uGzcWfpVT5qJNMJJGtpy0QrGo0WQNt8UmiF0E2FgQODNHGsYckiU5+oExd/skfbQ+yeJwZqSRJTtWW+SqN7aGPP/8zg95xzyfOzb+yF7rtCxQeccmEcvQpVYYL7RiY/bs2TNot+F6bdCNb9R79FbgAoGDFM6DnkHWioCEO8xAK/BrgzfqRg378OLFa8tnfiPJjV+8uFEAAL3tGvice+AWIS2tReXlGoSCLHA6z33p+iTvhORdqt47q+cWnftTUk3DHCSeksQfdWEkesyeIi/nC4QEUYEr0xSdm5VSriHdyFgKnwOXEiz+VgqLGTgxV9yXFmudI9L5ZmXC3lM1YkPPVRZcUhqkVnO0wIMVIpEYpJ+FmGMqhTrWoazlStbgc4TSoe3fKBYxbdBywsVlxsZsjr49dAIBi5jhlhfo0RKo7pjiBbIxy3RKSGAREwQow33O7qPsOscAl10keQ22QRqLWBtINva2xIg5v5Yk3wmKOYsYrozUGbLxjEtHBGmOBWfjOxb0j5nzVqg5UaqyINwHaAXDWjiwiG3OsBYZVJK9dVTYpKqijW9SFMK3nv1Wol3vGNoa0lg607bo2tn4sTGz4CtRkGVncRy1RquySNCyivh48HQ8jDsmuFth/jYLHtYZVxOS64xWDh3RnsQx/ds9yG02wAYtIabKo/JEz42RIg0bg0+OmO72DdDJJ0wDpCyJ8aJWadGV0nfouLWcHBYeC/d5/nqZ0LuPCQoN9zsoaX1n/74QtyenSf7rTxSTmaDF4yTk3hs3HgyaldLKfqoLkuaFP16cCz8oVUiE0v5oCUYidxiK0ibjgnNaZmi/VChrDB8nobYQAmu1DSBrvZg2LlQR00u148uT5H/SoRASP0UnVLM/CzirD5/tVluK+rFAHDQLCy7kZ6kTxB+ahRZrJtfqM2pGZy9PhqffvhoS/VJkc/R/wf96d1/fbtE4l1IvMYMFlyU66G1bZUR9vzD9z6VDS09Gr/YLWYd7s7LhPhmNqoitj+R6NaT4HMl0+m0VsfxIptFLOjk+xyP5ht3k8FgYyT1Or2pIT9ujrR6jCvnlUGWX6q3dLQuJ1hK56iqkZlJFLLXIPWbn/nGgncQnp71h3ItfXQ9fjkffjc9e9uM4/i+L2KoI6G7nB+6RdfO8+S5N9kX0oOKJxGtdPs19i5mwmPppaQ/m6GM4JnWckmFa6EzMmjbpHtcbWjwd1D13OkX9foncPXWhaLKZts19ehLH0xGRVBEbxaP9Jv8ejbYelPbAF1xIis9Xf1+XR2v1waq9DdRhCx5zahSPpmcbp872nbpUCy5FBufvLuFa36L6sh511fta/f6Zipoo7LMdZ7vrtZMO09IKvw6j+KrHjejV++OPE5rlCvS5bub4MLv7nI3ZoDvSD+6a2b1iJM8u2sk+QHsz0ziuskSv+tqgokoseeKo4wy4EYMFNZL7HNyYI6id53Oh5r1HuSZbj6/oVOrA7/i9bWJG/IzUxZqwdqmaSTpHHmaIir5nOjA3wX5rUFF9DEe1GO51sw8oU10g3V7o+tSS//G/3wNHG+CApK/gbWnB6CVaGpnpWjeTuKJrXCAOxcDBWpckziEvJDoXbrAe55Z7hEzMhecy9Eyh5pBywxMhBWGPyDRxW+jA1/XhQ44+R0tbX1u6xme4QEmQBan1LcnxGnjpdRF0tA8AS21vZ2RSBByS0glF92+H2LKgyrlKEdqziEBb4ApQebTGCofARUHEM20BZzORChJMiWZ56qHgis+RlEVAdlMUjNULkaEDq5PSeXBalsER0lgg+tpFhZi5PrwWC6wdp8UMPRcSM5iXJCKCVGd0jw55R26oDBJ0HgypFykGoc5z60HiAm3AXjhJuuKD0VQQBJd0Ve2eLQnylitHBb42qD2aTfiM1XQ7Cjoyvu4DXdWvCCylQwKAFOqWHlh68HEDsw+YOOFx8k2bD8vlci8Pnu/yXAiflwlYNHrLNw+LIWu67JuP5yxiHm3h3s6u0C5E2l5cHtA5CMSDpkzyNJTJZjalHPvhPgOVLClSVA47Re384t0vsIDTfsyiTuY/weDBL5c/vvnP1RuSS7Wpzr9hP+7HYdrVzhdcdVRd4PYJqn65mlldNG9L9xP5blv9/3kF++cVbPMK1jQRjys/MJKL0ImbYa/uoh/ZvYexcfsGNolYrp0nkrs7gsivVlYVLddPN9RcM+FonNk+3tziuvPUFC5J9az4IG3zJrQlndCHFUR7WMeDyP/mfXNyz+Epj3QHg9O2XbXuGtUa28ammtDlqO67ZGO9e56maLp+781hO8PMxZtrFjFe+ny339+Gft/8IOkHbdodBGoD6C+F+iDD99Sefsb1vzbk9c6DDI1/LTXFZ1JV1f8BGbwW1w==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Document",permalink:"/docs/API-docs/deletedocument"},next:{title:"Resend request mail",permalink:"/docs/API-docs/resendrequestmail"}},f={},y=[{value:"Document Types:",id:"document-types",level:3},{value:"Request",id:"request",level:2}];function g(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,n.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Get Document list from status"})}),"\n",(0,i.jsx)(t(),{method:"get",path:"/documentlist/{doctype}"}),"\n",(0,i.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,i.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,i.jsxs)(s.ol,{children:["\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(c.Z,{className:"paramsItem",param:{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draft","inprogress","completed","expired","declined"]}}})})})]}),"\n",(0,i.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Query Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsxs)("ul",{children:[(0,i.jsx)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,i.jsx)(c.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"result"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"document[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"folder"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "result": [\n {\n "objectId": "FGik23bhUJ",\n "file": "https://exampleurl.com",\n "title": "sample doc",\n "note": "please sign document",\n "folder": {\n "objectId": "FGik23bhUJ",\n "name": "folder name"\n },\n "owner": "joe bee",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": true,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z",\n "enableTour": true,\n "redirect_url": "",\n "allow_modifications": false\n }\n ]\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Report not available!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Report not available!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.398f1da5.js b/assets/js/runtime~main.d41e5ed3.js similarity index 78% rename from assets/js/runtime~main.398f1da5.js rename to assets/js/runtime~main.d41e5ed3.js index 6dcbdd52a..bc06cb97e 100644 --- a/assets/js/runtime~main.398f1da5.js +++ b/assets/js/runtime~main.d41e5ed3.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,b,f,d={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return d[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=d,t.c=r,e=[],t.O=(a,c,b,f)=>{if(!c){var d=1/0;for(n=0;n=f)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,f0&&e[n-1][2]>f;n--)e[n]=e[n-1];e[n]=[c,b,f]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,b){if(1&b&&(e=this(e)),8&b)return e;if("object"==typeof e&&e){if(4&b&&e.__esModule)return e;if(16&b&&"function"==typeof e.then)return e}var f=Object.create(null);t.r(f);var d={};a=a||[null,c({}),c([]),c(c)];for(var r=2&b&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,t.d(f,d),f},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",230:"d91ad230",261:"reactPlayerKaltura",273:"fa40969b",339:"4f7a2d40",420:"e2c87691",453:"30a24c52",470:"299c7a47",533:"b2b675dd",762:"d8b805fb",792:"50ea61d6",823:"c7b98810",835:"ab2a161b",841:"c5e4dae0",853:"277a78f5",869:"b18842e4",948:"8717b14a",1001:"8001f939",1332:"f0ff4a36",1477:"b2f554cd",1512:"e9e778b7",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1653:"42f80fc5",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2121:"reactPlayerFacebook",2125:"f214d5ff",2207:"78b2b753",2213:"1c822755",2241:"2ace9d1d",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2535:"814f3328",2542:"5ce9853b",2546:"reactPlayerStreamable",2617:"56b5f4f8",2832:"1f73ca32",2865:"3e02da86",3e3:"1ee58ee1",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3156:"11b7b3d8",3205:"a80da1cf",3495:"8a855f99",3514:"73664a40",3554:"5e1bb91e",3608:"9e4087bc",3743:"reactPlayerVimeo",3965:"reactPlayerVidyard",4013:"01a85c17",4195:"c4f5d8e4",4277:"14716de7",4368:"a94703ab",4439:"reactPlayerYouTube",4478:"d1393a72",4641:"ada7accb",4651:"05632a52",4667:"reactPlayerMixcloud",4772:"b0378e01",4918:"1f7895dc",4930:"ae010e44",4955:"e226bb09",4985:"b839bf37",5377:"ce589067",5507:"8320e026",5858:"046910c8",5900:"38e3d9c8",6011:"reactPlayerFilePlayer",6033:"28b19cd2",6103:"ccc49370",6113:"13fdae3b",6125:"reactPlayerSoundCloud",6177:"611db08b",6216:"reactPlayerTwitch",6238:"e76c28ee",6344:"984cf7cf",6543:"17e5210b",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7286:"451a5132",7414:"393be207",7475:"500027af",7596:"reactPlayerDailyMotion",7664:"reactPlayerPreview",7816:"06577f20",7894:"a88a3db3",7917:"0028a090",7964:"2304e9ae",7971:"8a725248",8055:"reactPlayerWistia",8087:"e4f5c862",8106:"377084eb",8141:"98da7451",8163:"5a2de241",8215:"e5a49157",8468:"52d5c0f9",8474:"9640838e",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8766:"70853c19",8781:"489b8a4d",8784:"83cab870",8866:"eb56c656",8878:"cf03142d",8888:"a9f09360",8892:"38ec836e",9003:"925b3f96",9010:"06b6ef6a",9035:"4c9e35b1",9588:"5c04ee3b",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368",9914:"0c0943c7"}[e]||e)+"."+{53:"56191834",110:"ab20026d",230:"3cc5e6e9",261:"4b30f79b",273:"b8b3b66b",339:"d942a670",420:"3b683e17",453:"61f3e45f",470:"2cdb00ea",533:"2d5f5b1d",762:"74ae2291",792:"eda05c15",823:"64f8e5be",835:"ced0e4f6",841:"b9d70538",853:"6965f6a9",869:"52040461",948:"b2da1fd1",1001:"50ee673e",1332:"6147969f",1477:"b31b2642",1512:"9637e502",1520:"ceac1441",1531:"636268e6",1633:"d8366831",1653:"24ec49aa",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"1e67588d",2121:"c8df990c",2125:"9a2b70d2",2207:"f380f604",2213:"d47dd20f",2241:"5104cb4f",2245:"a7b94822",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2542:"28eaefb4",2546:"665b04f4",2617:"56321ade",2832:"e34356e0",2865:"eca1c9d2",3e3:"8c874417",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3156:"41df5616",3205:"af75d475",3495:"4657d57d",3514:"b2437ac4",3554:"e5046f78",3608:"0e768bf1",3743:"2ede10ee",3965:"f3db8112",4013:"e5e25f55",4148:"483fa267",4195:"08242eba",4277:"69395083",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"a41784da",4641:"40681dfc",4651:"8538abf4",4667:"c24bbf43",4682:"18721add",4772:"07189a34",4918:"7f3b7e65",4930:"1e68d98f",4955:"8f728b1e",4985:"dad32c3b",5377:"ccefc9dc",5507:"36c41078",5858:"bbab5814",5900:"e113e88d",6011:"6de743c9",6033:"05196014",6103:"ebc8482f",6113:"53df0513",6125:"9555c68b",6177:"443de2fe",6216:"0d890761",6238:"a8542bf5",6344:"962bbb02",6543:"7f67a86f",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7286:"0072a94c",7414:"8d31e6a7",7475:"6502681d",7596:"95bca972",7664:"7fd4bae6",7816:"38bd8c71",7894:"e09eee0c",7917:"50bb866e",7964:"4e6965bb",7971:"6792c484",8055:"27482879",8087:"b9e4a7cc",8106:"cdd769c8",8140:"901b2f91",8141:"81bec72f",8163:"a62323e7",8215:"c6b04c16",8468:"7cfe3494",8474:"8043eb00",8475:"d27b3009",8489:"35a41943",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"c931f7da",8781:"f4c6405c",8784:"fb16cf6f",8866:"381cdff2",8878:"0d381461",8888:"01e35e86",8892:"7315f43d",9003:"1e8e0783",9010:"09a7d359",9035:"37598b09",9588:"5ef75d8a",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"cb5d272f",9700:"ad032cc8",9817:"424c677a",9914:"8bf8d5ee"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),b={},f="OpenSign-Docs:",t.l=(e,a,c,d)=>{if(b[e])b[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var f=b[e];if(delete b[e],r.parentNode&&r.parentNode.removeChild(r),f&&f.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",d91ad230:"230",reactPlayerKaltura:"261",fa40969b:"273","4f7a2d40":"339",e2c87691:"420","30a24c52":"453","299c7a47":"470",b2b675dd:"533",d8b805fb:"762","50ea61d6":"792",c7b98810:"823",ab2a161b:"835",c5e4dae0:"841","277a78f5":"853",b18842e4:"869","8717b14a":"948","8001f939":"1001",f0ff4a36:"1332",b2f554cd:"1477",e9e778b7:"1512","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633","42f80fc5":"1653",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",reactPlayerFacebook:"2121",f214d5ff:"2125","78b2b753":"2207","1c822755":"2213","2ace9d1d":"2241",a2bc1463:"2245",e273c56f:"2362","814f3328":"2535","5ce9853b":"2542",reactPlayerStreamable:"2546","56b5f4f8":"2617","1f73ca32":"2832","3e02da86":"2865","1ee58ee1":"3000","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101","11b7b3d8":"3156",a80da1cf:"3205","8a855f99":"3495","73664a40":"3514","5e1bb91e":"3554","9e4087bc":"3608",reactPlayerVimeo:"3743",reactPlayerVidyard:"3965","01a85c17":"4013",c4f5d8e4:"4195","14716de7":"4277",a94703ab:"4368",reactPlayerYouTube:"4439",d1393a72:"4478",ada7accb:"4641","05632a52":"4651",reactPlayerMixcloud:"4667",b0378e01:"4772","1f7895dc":"4918",ae010e44:"4930",e226bb09:"4955",b839bf37:"4985",ce589067:"5377","8320e026":"5507","046910c8":"5858","38e3d9c8":"5900",reactPlayerFilePlayer:"6011","28b19cd2":"6033",ccc49370:"6103","13fdae3b":"6113",reactPlayerSoundCloud:"6125","611db08b":"6177",reactPlayerTwitch:"6216",e76c28ee:"6238","984cf7cf":"6344","17e5210b":"6543",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178","451a5132":"7286","393be207":"7414","500027af":"7475",reactPlayerDailyMotion:"7596",reactPlayerPreview:"7664","06577f20":"7816",a88a3db3:"7894","0028a090":"7917","2304e9ae":"7964","8a725248":"7971",reactPlayerWistia:"8055",e4f5c862:"8087","377084eb":"8106","98da7451":"8141","5a2de241":"8163",e5a49157:"8215","52d5c0f9":"8468","9640838e":"8474","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","70853c19":"8766","489b8a4d":"8781","83cab870":"8784",eb56c656:"8866",cf03142d:"8878",a9f09360:"8888","38ec836e":"8892","925b3f96":"9003","06b6ef6a":"9010","4c9e35b1":"9035","5c04ee3b":"9588","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817","0c0943c7":"9914"}[e]||e,t.p+t.u(e)},(()=>{var e={1303:0,532:0};t.f.j=(a,c)=>{var b=t.o(e,a)?e[a]:void 0;if(0!==b)if(b)c.push(b[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var f=new Promise(((c,f)=>b=e[a]=[c,f]));c.push(b[2]=f);var d=t.p+t.u(a),r=new Error;t.l(d,(c=>{if(t.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var f=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+f+": "+d+")",r.name="ChunkLoadError",r.type=f,r.request=d,b[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var b,f,d=c[0],r=c[1],o=c[2],l=0;if(d.some((a=>0!==e[a]))){for(b in r)t.o(r,b)&&(t.m[b]=r[b]);if(o)var n=o(t)}for(a&&a(c);l{"use strict";var e,a,c,b,d,f={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return f[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=f,t.c=r,e=[],t.O=(a,c,b,d)=>{if(!c){var f=1/0;for(n=0;n=d)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,d0&&e[n-1][2]>d;n--)e[n]=e[n-1];e[n]=[c,b,d]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,b){if(1&b&&(e=this(e)),8&b)return e;if("object"==typeof e&&e){if(4&b&&e.__esModule)return e;if(16&b&&"function"==typeof e.then)return e}var d=Object.create(null);t.r(d);var f={};a=a||[null,c({}),c([]),c(c)];for(var r=2&b&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>f[a]=()=>e[a]));return f.default=()=>e,t.d(d,f),d},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",230:"d91ad230",261:"reactPlayerKaltura",273:"fa40969b",339:"4f7a2d40",420:"e2c87691",453:"30a24c52",470:"299c7a47",533:"b2b675dd",762:"d8b805fb",792:"50ea61d6",823:"c7b98810",835:"ab2a161b",841:"c5e4dae0",853:"277a78f5",869:"b18842e4",948:"8717b14a",1001:"8001f939",1332:"f0ff4a36",1477:"b2f554cd",1512:"e9e778b7",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1653:"42f80fc5",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2121:"reactPlayerFacebook",2125:"f214d5ff",2207:"78b2b753",2213:"1c822755",2241:"2ace9d1d",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2535:"814f3328",2542:"5ce9853b",2546:"reactPlayerStreamable",2617:"56b5f4f8",2832:"1f73ca32",2865:"3e02da86",3e3:"1ee58ee1",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3156:"11b7b3d8",3205:"a80da1cf",3495:"8a855f99",3514:"73664a40",3554:"5e1bb91e",3608:"9e4087bc",3743:"reactPlayerVimeo",3965:"reactPlayerVidyard",4013:"01a85c17",4195:"c4f5d8e4",4277:"14716de7",4368:"a94703ab",4439:"reactPlayerYouTube",4478:"d1393a72",4641:"ada7accb",4651:"05632a52",4667:"reactPlayerMixcloud",4772:"b0378e01",4918:"1f7895dc",4930:"ae010e44",4955:"e226bb09",4985:"b839bf37",5377:"ce589067",5507:"8320e026",5858:"046910c8",5900:"38e3d9c8",6011:"reactPlayerFilePlayer",6033:"28b19cd2",6103:"ccc49370",6113:"13fdae3b",6125:"reactPlayerSoundCloud",6177:"611db08b",6216:"reactPlayerTwitch",6238:"e76c28ee",6344:"984cf7cf",6543:"17e5210b",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7286:"451a5132",7414:"393be207",7475:"500027af",7596:"reactPlayerDailyMotion",7664:"reactPlayerPreview",7816:"06577f20",7894:"a88a3db3",7917:"0028a090",7964:"2304e9ae",7971:"8a725248",8055:"reactPlayerWistia",8087:"e4f5c862",8106:"377084eb",8141:"98da7451",8163:"5a2de241",8215:"e5a49157",8468:"52d5c0f9",8474:"9640838e",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8766:"70853c19",8781:"489b8a4d",8784:"83cab870",8866:"eb56c656",8878:"cf03142d",8888:"a9f09360",8892:"38ec836e",9003:"925b3f96",9010:"06b6ef6a",9035:"4c9e35b1",9588:"5c04ee3b",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368",9914:"0c0943c7"}[e]||e)+"."+{53:"56191834",110:"ab20026d",230:"3cc5e6e9",261:"4b30f79b",273:"e283f01a",339:"d942a670",420:"3b683e17",453:"61f3e45f",470:"2cdb00ea",533:"2d5f5b1d",762:"74ae2291",792:"eda05c15",823:"64f8e5be",835:"ced0e4f6",841:"b9d70538",853:"6965f6a9",869:"52040461",948:"b2da1fd1",1001:"50ee673e",1332:"28386b54",1477:"b31b2642",1512:"9637e502",1520:"523b2d80",1531:"3855f22e",1633:"d8366831",1653:"24ec49aa",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"7505206d",2121:"c8df990c",2125:"9a2b70d2",2207:"f380f604",2213:"d47dd20f",2241:"5104cb4f",2245:"a7b94822",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2542:"28eaefb4",2546:"665b04f4",2617:"56321ade",2832:"e34356e0",2865:"eca1c9d2",3e3:"8c874417",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3156:"41df5616",3205:"af75d475",3495:"4657d57d",3514:"b2437ac4",3554:"e5046f78",3608:"0e768bf1",3743:"2ede10ee",3965:"f3db8112",4013:"e5e25f55",4148:"483fa267",4195:"08242eba",4277:"69395083",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"a41784da",4641:"40681dfc",4651:"8538abf4",4667:"c24bbf43",4682:"18721add",4772:"07189a34",4918:"7f3b7e65",4930:"a965d111",4955:"8f728b1e",4985:"dad32c3b",5377:"ccefc9dc",5507:"36c41078",5858:"bbab5814",5900:"e113e88d",6011:"6de743c9",6033:"5f8c6828",6103:"ebc8482f",6113:"53df0513",6125:"9555c68b",6177:"443de2fe",6216:"0d890761",6238:"a8542bf5",6344:"962bbb02",6543:"7f67a86f",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7286:"0072a94c",7414:"8d31e6a7",7475:"6502681d",7596:"95bca972",7664:"7fd4bae6",7816:"38bd8c71",7894:"e09eee0c",7917:"a94482e8",7964:"4e6965bb",7971:"6792c484",8055:"27482879",8087:"b9e4a7cc",8106:"8bd89dab",8140:"901b2f91",8141:"81bec72f",8163:"4d9dbd85",8215:"c6b04c16",8468:"7cfe3494",8474:"8043eb00",8475:"d27b3009",8489:"35a41943",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"c931f7da",8781:"f4c6405c",8784:"fb16cf6f",8866:"381cdff2",8878:"0d381461",8888:"553c32a0",8892:"7315f43d",9003:"1e8e0783",9010:"09a7d359",9035:"37598b09",9588:"5ef75d8a",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"da4bd7cd",9700:"ad032cc8",9817:"424c677a",9914:"8bf8d5ee"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),b={},d="OpenSign-Docs:",t.l=(e,a,c,f)=>{if(b[e])b[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var d=b[e];if(delete b[e],r.parentNode&&r.parentNode.removeChild(r),d&&d.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",d91ad230:"230",reactPlayerKaltura:"261",fa40969b:"273","4f7a2d40":"339",e2c87691:"420","30a24c52":"453","299c7a47":"470",b2b675dd:"533",d8b805fb:"762","50ea61d6":"792",c7b98810:"823",ab2a161b:"835",c5e4dae0:"841","277a78f5":"853",b18842e4:"869","8717b14a":"948","8001f939":"1001",f0ff4a36:"1332",b2f554cd:"1477",e9e778b7:"1512","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633","42f80fc5":"1653",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",reactPlayerFacebook:"2121",f214d5ff:"2125","78b2b753":"2207","1c822755":"2213","2ace9d1d":"2241",a2bc1463:"2245",e273c56f:"2362","814f3328":"2535","5ce9853b":"2542",reactPlayerStreamable:"2546","56b5f4f8":"2617","1f73ca32":"2832","3e02da86":"2865","1ee58ee1":"3000","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101","11b7b3d8":"3156",a80da1cf:"3205","8a855f99":"3495","73664a40":"3514","5e1bb91e":"3554","9e4087bc":"3608",reactPlayerVimeo:"3743",reactPlayerVidyard:"3965","01a85c17":"4013",c4f5d8e4:"4195","14716de7":"4277",a94703ab:"4368",reactPlayerYouTube:"4439",d1393a72:"4478",ada7accb:"4641","05632a52":"4651",reactPlayerMixcloud:"4667",b0378e01:"4772","1f7895dc":"4918",ae010e44:"4930",e226bb09:"4955",b839bf37:"4985",ce589067:"5377","8320e026":"5507","046910c8":"5858","38e3d9c8":"5900",reactPlayerFilePlayer:"6011","28b19cd2":"6033",ccc49370:"6103","13fdae3b":"6113",reactPlayerSoundCloud:"6125","611db08b":"6177",reactPlayerTwitch:"6216",e76c28ee:"6238","984cf7cf":"6344","17e5210b":"6543",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178","451a5132":"7286","393be207":"7414","500027af":"7475",reactPlayerDailyMotion:"7596",reactPlayerPreview:"7664","06577f20":"7816",a88a3db3:"7894","0028a090":"7917","2304e9ae":"7964","8a725248":"7971",reactPlayerWistia:"8055",e4f5c862:"8087","377084eb":"8106","98da7451":"8141","5a2de241":"8163",e5a49157:"8215","52d5c0f9":"8468","9640838e":"8474","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","70853c19":"8766","489b8a4d":"8781","83cab870":"8784",eb56c656:"8866",cf03142d:"8878",a9f09360:"8888","38ec836e":"8892","925b3f96":"9003","06b6ef6a":"9010","4c9e35b1":"9035","5c04ee3b":"9588","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817","0c0943c7":"9914"}[e]||e,t.p+t.u(e)},(()=>{var e={1303:0,532:0};t.f.j=(a,c)=>{var b=t.o(e,a)?e[a]:void 0;if(0!==b)if(b)c.push(b[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var d=new Promise(((c,d)=>b=e[a]=[c,d]));c.push(b[2]=d);var f=t.p+t.u(a),r=new Error;t.l(f,(c=>{if(t.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var d=c&&("load"===c.type?"missing":c.type),f=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+d+": "+f+")",r.name="ChunkLoadError",r.type=d,r.request=f,b[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var b,d,f=c[0],r=c[1],o=c[2],l=0;if(f.some((a=>0!==e[a]))){for(b in r)t.o(r,b)&&(t.m[b]=r[b]);if(o)var n=o(t)}for(a&&a(c);l Archive | OpenSign™ - + diff --git a/blog/first-blog-post/index.html b/blog/first-blog-post/index.html index 0b07d88de..6acd0b972 100644 --- a/blog/first-blog-post/index.html +++ b/blog/first-blog-post/index.html @@ -5,7 +5,7 @@ First Blog Post | OpenSign™ - + diff --git a/blog/index.html b/blog/index.html index 64061dd56..c7be1e5e6 100644 --- a/blog/index.html +++ b/blog/index.html @@ -5,7 +5,7 @@ Blog | OpenSign™ - + diff --git a/blog/long-blog-post/index.html b/blog/long-blog-post/index.html index 216af39fb..805b91bf4 100644 --- a/blog/long-blog-post/index.html +++ b/blog/long-blog-post/index.html @@ -5,7 +5,7 @@ Long Blog Post | OpenSign™ - + diff --git a/blog/mdx-blog-post/index.html b/blog/mdx-blog-post/index.html index bce1b179c..c02e83690 100644 --- a/blog/mdx-blog-post/index.html +++ b/blog/mdx-blog-post/index.html @@ -5,7 +5,7 @@ MDX Blog Post | OpenSign™ - + diff --git a/blog/tags/docusaurus/index.html b/blog/tags/docusaurus/index.html index 81364debd..1e4864199 100644 --- a/blog/tags/docusaurus/index.html +++ b/blog/tags/docusaurus/index.html @@ -5,7 +5,7 @@ 4 posts tagged with "docusaurus" | OpenSign™ - + diff --git a/blog/tags/facebook/index.html b/blog/tags/facebook/index.html index 834dd4cc1..4c6fdbd9e 100644 --- a/blog/tags/facebook/index.html +++ b/blog/tags/facebook/index.html @@ -5,7 +5,7 @@ One post tagged with "facebook" | OpenSign™ - + diff --git a/blog/tags/hello/index.html b/blog/tags/hello/index.html index 7c6e27667..4d706a924 100644 --- a/blog/tags/hello/index.html +++ b/blog/tags/hello/index.html @@ -5,7 +5,7 @@ 2 posts tagged with "hello" | OpenSign™ - + diff --git a/blog/tags/hola/index.html b/blog/tags/hola/index.html index f3784ad8e..343cffdaa 100644 --- a/blog/tags/hola/index.html +++ b/blog/tags/hola/index.html @@ -5,7 +5,7 @@ One post tagged with "hola" | OpenSign™ - + diff --git a/blog/tags/index.html b/blog/tags/index.html index ac162d180..f817ef872 100644 --- a/blog/tags/index.html +++ b/blog/tags/index.html @@ -5,7 +5,7 @@ Tags | OpenSign™ - + diff --git a/blog/welcome/index.html b/blog/welcome/index.html index e36691cf6..9143b803e 100644 --- a/blog/welcome/index.html +++ b/blog/welcome/index.html @@ -5,7 +5,7 @@ Welcome | OpenSign™ - + diff --git a/docs/API-docs/contactlist/index.html b/docs/API-docs/contactlist/index.html index 1000ad2e7..64adfd3ff 100644 --- a/docs/API-docs/contactlist/index.html +++ b/docs/API-docs/contactlist/index.html @@ -5,7 +5,7 @@ Get Contact list | OpenSign™ - + diff --git a/docs/API-docs/createcontact/index.html b/docs/API-docs/createcontact/index.html index 8bf9c901c..b9107e152 100644 --- a/docs/API-docs/createcontact/index.html +++ b/docs/API-docs/createcontact/index.html @@ -5,7 +5,7 @@ Create Contact | OpenSign™ - + diff --git a/docs/API-docs/createdocument/index.html b/docs/API-docs/createdocument/index.html index 57c1298d7..8163418bb 100644 --- a/docs/API-docs/createdocument/index.html +++ b/docs/API-docs/createdocument/index.html @@ -5,7 +5,7 @@ Create Document | OpenSign™ - + @@ -119,7 +119,7 @@ 
{
  "type":"image", 
  "page":1,  
  "x": 327, 
  "y": 628, 
  "w": 114, 
  "h": 21, 
  "options": {
    "required": true, 
    "name": "image"
  }
}

Request​

-

Body

required

    file base64required
    title stringrequired
    description string
    note string
    timeToCompleteDays number

    time to complete days is used to calculate expiry date of your document

    signers

    object[]

    required

  • Array [

    • role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

    • type string

    Allowed values - signature, stamp.

    page number

    The page number on which the widget should appear. use our Debug UI to calculate the value.

    x number

    x co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    y number

    y co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    w number

    Width of widget. use our Debug UI to calculate the value.

    h number

    Height of widget. use our Debug UI to calculate the value.

  • ]

  • ]

    • folderId string
    send_email boolean

    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.

    email_subject string

    Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

    email_body string

    Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

    sendInOrder boolean

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

    enableOTP boolean

    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.

    enableTour boolean

    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.

    email_sender_name string

    name or email of the person or organization on the behalf of which you are sending the mail.

+

Body

required

    file base64required
    title stringrequired
    description string
    note string
    timeToCompleteDays number

    time to complete days is used to calculate expiry date of your document

    signers

    object[]

    required

  • Array [

    • role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

    • type string

    Allowed values - signature, stamp.

    page number

    The page number on which the widget should appear. use our Debug UI to calculate the value.

    x number

    x co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    y number

    y co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    w number

    Width of widget. use our Debug UI to calculate the value.

    h number

    Height of widget. use our Debug UI to calculate the value.

  • ]

  • ]

    • folderId string
    send_email boolean

    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.

    email_subject string

    Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

    email_body string

    Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

    sendInOrder boolean

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

    enableOTP boolean

    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.

    enableTour boolean

    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.

    redirect_url string

    Specifies the URL where the signer will be redirected upon completing the document signing process.

    email_sender_name string

    name or email of the person or organization on the behalf of which you are sending the mail.

    allow_modifications boolean

    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.

Responses​

Document created successfully!

Schema

    objectId string
    url string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/createdocumentwithtemplateid/index.html b/docs/API-docs/createdocumentwithtemplateid/index.html index 1fc19a63b..dac31463d 100644 --- a/docs/API-docs/createdocumentwithtemplateid/index.html +++ b/docs/API-docs/createdocumentwithtemplateid/index.html @@ -5,7 +5,7 @@ Create Document from Template | OpenSign™ - + @@ -14,7 +14,7 @@

The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at Debug UI or using the Create Template API.

Request​

Path Parameters

    template_id stringrequired

    objectId of Template

-

Body

required

    signers

    object[]

    required

  • Array [

    • role string
    email mail
    name string
    phone string

  • ]

    • folderId string
    send_email boolean

    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.

    email_subject string

    Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

    email_body string

    Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

    sendInOrder boolean

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

    timeToCompleteDays number

    time to complete days is used to calculate expiry date of your document

    enableOTP boolean

    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.

    enableTour boolean

    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.

+

Body

required

    signers

    object[]

    required

  • Array [

    • role string
    email mail
    name string
    phone string

  • ]

    • folderId string
    send_email boolean

    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.

    email_subject string

    Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

    email_body string

    Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

    sendInOrder boolean

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

    timeToCompleteDays number

    time to complete days is used to calculate expiry date of your document

    enableOTP boolean

    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.

    enableTour boolean

    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.

    email_sender_name string

    name or email of the person or organization on the behalf of which you are sending the mail.

    allow_modifications boolean

    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.

Responses​

In success response you will get url in response if you are also signer in document otherwise only get objectId, messsage

Schema

    objectId string
    url string
    message string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/createfolder/index.html b/docs/API-docs/createfolder/index.html index 79cdeed5a..a50414fdd 100644 --- a/docs/API-docs/createfolder/index.html +++ b/docs/API-docs/createfolder/index.html @@ -5,7 +5,7 @@ Create Folder | OpenSign™ - + diff --git a/docs/API-docs/createtemplate/index.html b/docs/API-docs/createtemplate/index.html index cb428d4dd..bc408dbf4 100644 --- a/docs/API-docs/createtemplate/index.html +++ b/docs/API-docs/createtemplate/index.html @@ -5,7 +5,7 @@ Create Template | OpenSign™ - + @@ -119,7 +119,7 @@ 
{
  "type":"image", 
  "page":1,  
  "x": 327, 
  "y": 628, 
  "w": 114, 
  "h": 21, 
  "options": {
    "required": true, 
    "name": "image"
  }
}

Request​

-

Body

required

    file base64required
    title stringrequired
    note string
    description string

    signers

    object[]

    required

    You can provide signer optionally if you it as default signer

  • Array [

    • role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

    • type string

    Allowed values - signature, stamp.

    page number

    The page number on which the widget should appear. use our Debug UI to calculate the value.

    x number

    x co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    y number

    y co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    w number

    Width of widget. use our Debug UI to calculate the value.

    h number

    Height of widget. use our Debug UI to calculate the value.

  • ]

  • ]

    • sendInOrder boolean

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

    enableOTP boolean

    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.

    enableTour boolean

    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.

+

Body

required

    file base64required
    title stringrequired
    note string
    description string

    signers

    object[]

    required

    You can provide signer optionally if you it as default signer

  • Array [

    • role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

    • type string

    Allowed values - signature, stamp.

    page number

    The page number on which the widget should appear. use our Debug UI to calculate the value.

    x number

    x co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    y number

    y co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    w number

    Width of widget. use our Debug UI to calculate the value.

    h number

    Height of widget. use our Debug UI to calculate the value.

  • ]

  • ]

    • sendInOrder boolean

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

    enableOTP boolean

    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.

    enableTour boolean

    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.

    redirect_url string

    Specifies the URL where the signer will be redirected upon completing the document signing process.

    email_sender_name string

    name or email of the person or organization on the behalf of which you are sending the mail.

    allow_modifications boolean

    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.

Responses​

Template created successfully!

Schema

    objectId string
    message string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/delete-template/index.html b/docs/API-docs/delete-template/index.html index 747ae9de6..a36763524 100644 --- a/docs/API-docs/delete-template/index.html +++ b/docs/API-docs/delete-template/index.html @@ -5,7 +5,7 @@ Delete Template | OpenSign™ - + diff --git a/docs/API-docs/delete-webhook/index.html b/docs/API-docs/delete-webhook/index.html index 83b6bb59c..5fa7844c1 100644 --- a/docs/API-docs/delete-webhook/index.html +++ b/docs/API-docs/delete-webhook/index.html @@ -5,7 +5,7 @@ Delete Webhook | OpenSign™ - + diff --git a/docs/API-docs/deletecontact/index.html b/docs/API-docs/deletecontact/index.html index 915ecdc42..18a9281bf 100644 --- a/docs/API-docs/deletecontact/index.html +++ b/docs/API-docs/deletecontact/index.html @@ -5,7 +5,7 @@ Delete Contact | OpenSign™ - + diff --git a/docs/API-docs/deletedocument/index.html b/docs/API-docs/deletedocument/index.html index d8ab1e214..3100b1f13 100644 --- a/docs/API-docs/deletedocument/index.html +++ b/docs/API-docs/deletedocument/index.html @@ -5,7 +5,7 @@ Delete Document | OpenSign™ - + diff --git a/docs/API-docs/deletefolder/index.html b/docs/API-docs/deletefolder/index.html index f60649692..72244eeae 100644 --- a/docs/API-docs/deletefolder/index.html +++ b/docs/API-docs/deletefolder/index.html @@ -5,7 +5,7 @@ Delete Folder | OpenSign™ - + diff --git a/docs/API-docs/draftdocument/index.html b/docs/API-docs/draftdocument/index.html index 482e7ed14..e92467e0e 100644 --- a/docs/API-docs/draftdocument/index.html +++ b/docs/API-docs/draftdocument/index.html @@ -5,7 +5,7 @@ Draft Document | OpenSign™ - + @@ -119,7 +119,7 @@ 
{
  "type":"image", 
  "page":1,  
  "x": 327, 
  "y": 628, 
  "w": 114, 
  "h": 21, 
  "options": {
    "required": true, 
    "name": "image"
  }
}

Request​

-

Body

required

    file base64required
    title stringrequired
    description string
    note string
    timeToCompleteDays number

    time to complete days is used to calculate expiry date of your document

    signers

    object[]

  • Array [

    • role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

    • type string

    Allowed values - signature, stamp.

    page number

    The page number on which the widget should appear. use our Debug UI to calculate the value.

    x number

    x co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    y number

    y co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    w number

    Width of widget. use our Debug UI to calculate the value.

    h number

    Height of widget. use our Debug UI to calculate the value.

  • ]

  • ]

    • folderId string
    send_email boolean

    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.

    email_subject string

    Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

    email_body string

    Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

    sendInOrder boolean

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

    enableOTP boolean

    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.

    enableTour boolean

    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.

    email_sender_name string

    name or email of the person or organization on the behalf of which you are sending the mail.

+

Body

required

    file base64required
    title stringrequired
    description string
    note string
    timeToCompleteDays number

    time to complete days is used to calculate expiry date of your document

    signers

    object[]

  • Array [

    • role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

    • type string

    Allowed values - signature, stamp.

    page number

    The page number on which the widget should appear. use our Debug UI to calculate the value.

    x number

    x co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    y number

    y co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    w number

    Width of widget. use our Debug UI to calculate the value.

    h number

    Height of widget. use our Debug UI to calculate the value.

  • ]

  • ]

    • folderId string
    send_email boolean

    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.

    email_subject string

    Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

    email_body string

    Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

    sendInOrder boolean

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

    enableOTP boolean

    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.

    enableTour boolean

    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.

    redirect_url string

    Specifies the URL where the signer will be redirected upon completing the document signing process.

    email_sender_name string

    name or email of the person or organization on the behalf of which you are sending the mail.

    allow_modifications boolean

    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.

Responses​

Document created successfully!

Schema

    document_id string
    url string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/drafttemplate/index.html b/docs/API-docs/drafttemplate/index.html index 931c9c850..77a30a793 100644 --- a/docs/API-docs/drafttemplate/index.html +++ b/docs/API-docs/drafttemplate/index.html @@ -5,7 +5,7 @@ Draft Template | OpenSign™ - + @@ -121,7 +121,7 @@ 
{
  "type":"image", 
  "page":1,  
  "x": 327, 
  "y": 628, 
  "w": 114, 
  "h": 21, 
  "options": {
    "required": true, 
    "name": "image"
  }
}

Request​

-

Body

required

    file base64required
    title stringrequired
    note string
    description string

    signers

    object[]

    required

    You can provide signer optionally if you it as default signer

  • Array [

    • role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

    • type string

    Allowed values - signature, stamp.

    page number

    The page number on which the widget should appear. use our Debug UI to calculate the value.

    x number

    x co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    y number

    y co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    w number

    Width of widget. use our Debug UI to calculate the value.

    h number

    Height of widget. use our Debug UI to calculate the value.

  • ]

  • ]

    • sendInOrder boolean

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

    enableOTP boolean

    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.

    enableTour boolean

    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.

+

Body

required

    file base64required
    title stringrequired
    note string
    description string

    signers

    object[]

    required

    You can provide signer optionally if you it as default signer

  • Array [

    • role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

    • type string

    Allowed values - signature, stamp.

    page number

    The page number on which the widget should appear. use our Debug UI to calculate the value.

    x number

    x co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    y number

    y co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    w number

    Width of widget. use our Debug UI to calculate the value.

    h number

    Height of widget. use our Debug UI to calculate the value.

  • ]

  • ]

    • sendInOrder boolean

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

    enableOTP boolean

    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.

    enableTour boolean

    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.

    redirect_url string

    Specifies the URL where the signer will be redirected upon completing the document signing process.

    email_sender_name string

    name or email of the person or organization on the behalf of which you are sending the mail.

    allow_modifications boolean

    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.

Responses​

Template created successfully!

Schema

    objectId string
    url string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/folderlist/index.html b/docs/API-docs/folderlist/index.html index 3fcf32319..497aee84e 100644 --- a/docs/API-docs/folderlist/index.html +++ b/docs/API-docs/folderlist/index.html @@ -5,7 +5,7 @@ Get folder list | OpenSign™ - + diff --git a/docs/API-docs/get-template/index.html b/docs/API-docs/get-template/index.html index 2ac32e8ca..52a4f2b13 100644 --- a/docs/API-docs/get-template/index.html +++ b/docs/API-docs/get-template/index.html @@ -5,7 +5,7 @@ Get Template | OpenSign™ - + @@ -14,6 +14,6 @@

The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.

Request​

Path Parameters

    template_id strngrequired

    ID of template that needs to be fetched

-

Responses​

successful operation

Schema

    objectId string
    title string
    note string

    folder

    object

    objectId string
    name string
    file string
    owner string

    signers

    object[]

  • Array [

    • role string
    name string
    email string
    phone string

    widgets

    object[]

  • Array [

    • type string

    Allowed values - signature, stamp.

    x number
    y number
    w number
    h number
    page number

  • ]

  • ]

    • sendInOrder boolean
    createdAt date
    updatedAt date
Loading...
+

Responses​

successful operation

Schema

    objectId string
    title string
    note string

    folder

    object

    objectId string
    name string
    file string
    owner string

    signers

    object[]

  • Array [

    • role string
    name string
    email string
    phone string

    widgets

    object[]

  • Array [

    • type string

    Allowed values - signature, stamp.

    x number
    y number
    w number
    h number
    page number

  • ]

  • ]

    • sendInOrder boolean
    createdAt date
    updatedAt date
    enableTour boolean
    redirect_url string
    allow_modifications boolean
Loading...
\ No newline at end of file diff --git a/docs/API-docs/get-user/index.html b/docs/API-docs/get-user/index.html index 724b10570..b20cf2a92 100644 --- a/docs/API-docs/get-user/index.html +++ b/docs/API-docs/get-user/index.html @@ -5,7 +5,7 @@ Get your account details | OpenSign™ - + diff --git a/docs/API-docs/get-webhook/index.html b/docs/API-docs/get-webhook/index.html index 7cbe4a933..8b65d8a6d 100644 --- a/docs/API-docs/get-webhook/index.html +++ b/docs/API-docs/get-webhook/index.html @@ -5,7 +5,7 @@ Get Webhook | OpenSign™ - + diff --git a/docs/API-docs/getcontact/index.html b/docs/API-docs/getcontact/index.html index 76a6eb86a..00e7c0c24 100644 --- a/docs/API-docs/getcontact/index.html +++ b/docs/API-docs/getcontact/index.html @@ -5,7 +5,7 @@ Get Contact | OpenSign™ - + diff --git a/docs/API-docs/getdocument/index.html b/docs/API-docs/getdocument/index.html index c3a07bb73..fefc8cc60 100644 --- a/docs/API-docs/getdocument/index.html +++ b/docs/API-docs/getdocument/index.html @@ -5,7 +5,7 @@ Get Document | OpenSign™ - + @@ -14,6 +14,6 @@

The Get Document API enables you to retrieve details about a specific document.

Request​

Path Parameters

    document_id stringrequired

    objectId of Document

-

Responses​

successful operation

Schema

    objectId string
    file string
    title string
    note string

    folder

    object

    objectId string
    name string
    owner string

    signers

    object[]

  • Array [

    • role string
    name string
    email string
    phone string

    widgets

    object[]

  • Array [

    • type string

    Allowed values - signature, stamp.

    x number
    y number
    w number
    h number
    page number

  • ]

  • ]

    • sendInOrder boolean
    createdAt date
    updatedAt date
Loading...
+

Responses​

successful operation

Schema

    objectId string
    file string
    title string
    note string

    folder

    object

    objectId string
    name string
    owner string

    signers

    object[]

  • Array [

    • role string
    name string
    email string
    phone string

    widgets

    object[]

  • Array [

    • type string

    Allowed values - signature, stamp.

    x number
    y number
    w number
    h number
    page number

  • ]

  • ]

    • sendInOrder boolean
    createdAt date
    updatedAt date
    enableTour boolean
    redirect_url string
    allow_modifications boolean
Loading...
\ No newline at end of file diff --git a/docs/API-docs/getdocumentlist/index.html b/docs/API-docs/getdocumentlist/index.html index 3243980ad..857891a4a 100644 --- a/docs/API-docs/getdocumentlist/index.html +++ b/docs/API-docs/getdocumentlist/index.html @@ -5,7 +5,7 @@ Get Document list from status | OpenSign™ - + @@ -48,6 +48,6 @@

Request​

Path Parameters

    doctype stringrequired

    Possible values: [draft, inprogress, completed, expired, declined]

    The type of documents to retrieve

Query Parameters

    limit number

    Possible values: <= 500

    Example: 10
    skip number
    Example: 0
-

Responses​

successful operation

Schema

    result

    document[]

  • Array [

    • objectId string
    file string
    title string
    note string

    folder

    object

    objectId string
    name string
    owner string

    signers

    object[]

  • Array [

    • role string
    name string
    email string
    phone string

    widgets

    object[]

  • Array [

    • type string

    Allowed values - signature, stamp.

    x number
    y number
    w number
    h number
    page number

  • ]

  • ]

    • sendInOrder boolean
    createdAt date
    updatedAt date

  • ]

Loading...
+

Responses​

successful operation

Schema

    result

    document[]

  • Array [

    • objectId string
    file string
    title string
    note string

    folder

    object

    objectId string
    name string
    owner string

    signers

    object[]

  • Array [

    • role string
    name string
    email string
    phone string

    widgets

    object[]

  • Array [

    • type string

    Allowed values - signature, stamp.

    x number
    y number
    w number
    h number
    page number

  • ]

  • ]

    • sendInOrder boolean
    createdAt date
    updatedAt date
    enableTour boolean
    redirect_url string
    allow_modifications boolean

  • ]

Loading...
\ No newline at end of file diff --git a/docs/API-docs/getfolder/index.html b/docs/API-docs/getfolder/index.html index 8c8aee1dc..070076d37 100644 --- a/docs/API-docs/getfolder/index.html +++ b/docs/API-docs/getfolder/index.html @@ -5,7 +5,7 @@ Get Folder | OpenSign™ - + diff --git a/docs/API-docs/gettemplatelist/index.html b/docs/API-docs/gettemplatelist/index.html index d219e9925..08638d990 100644 --- a/docs/API-docs/gettemplatelist/index.html +++ b/docs/API-docs/gettemplatelist/index.html @@ -5,7 +5,7 @@ Get Template list | OpenSign™ - + @@ -14,6 +14,6 @@

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.

Request​

Query Parameters

    limit number

    Possible values: <= 500

    Example: 10
    skip number
    Example: 0
-

Responses​

successful operation

Schema

    result

    template[]

  • Array [

    • objectId string
    title string
    note string

    folder

    object

    objectId string
    name string
    file string
    owner string

    signers

    object[]

  • Array [

    • role string
    name string
    email string
    phone string

    widgets

    object[]

  • Array [

    • type string

    Allowed values - signature, stamp.

    x number
    y number
    w number
    h number
    page number

  • ]

  • ]

    • sendInOrder boolean
    createdAt date
    updatedAt date

  • ]

Loading...
+

Responses​

successful operation

Schema

    result

    template[]

  • Array [

    • objectId string
    title string
    note string

    folder

    object

    objectId string
    name string
    file string
    owner string

    signers

    object[]

  • Array [

    • role string
    name string
    email string
    phone string

    widgets

    object[]

  • Array [

    • type string

    Allowed values - signature, stamp.

    x number
    y number
    w number
    h number
    page number

  • ]

  • ]

    • sendInOrder boolean
    createdAt date
    updatedAt date
    enableTour boolean
    redirect_url string
    allow_modifications boolean

  • ]

Loading...
\ No newline at end of file diff --git a/docs/API-docs/intro/index.html b/docs/API-docs/intro/index.html index 9877f6816..1b817859e 100644 --- a/docs/API-docs/intro/index.html +++ b/docs/API-docs/intro/index.html @@ -5,7 +5,7 @@ Overview | OpenSign™ - + diff --git a/docs/API-docs/opensign-api-v-1/index.html b/docs/API-docs/opensign-api-v-1/index.html index dbff49d42..dc54a506c 100644 --- a/docs/API-docs/opensign-api-v-1/index.html +++ b/docs/API-docs/opensign-api-v-1/index.html @@ -5,7 +5,7 @@ OpenSign API v1 | OpenSign™ - + diff --git a/docs/API-docs/resendrequestmail/index.html b/docs/API-docs/resendrequestmail/index.html index b3e21a241..8020dbdf9 100644 --- a/docs/API-docs/resendrequestmail/index.html +++ b/docs/API-docs/resendrequestmail/index.html @@ -5,7 +5,7 @@ Resend request mail | OpenSign™ - + diff --git a/docs/API-docs/save-update-webhook/index.html b/docs/API-docs/save-update-webhook/index.html index c15d0cdb8..71c835567 100644 --- a/docs/API-docs/save-update-webhook/index.html +++ b/docs/API-docs/save-update-webhook/index.html @@ -5,7 +5,7 @@ Save or Update Webhook | OpenSign™ - + diff --git a/docs/API-docs/selfsign/index.html b/docs/API-docs/selfsign/index.html index c77ff3798..45a8349cb 100644 --- a/docs/API-docs/selfsign/index.html +++ b/docs/API-docs/selfsign/index.html @@ -5,7 +5,7 @@ Self Sign | OpenSign™ - + @@ -99,7 +99,7 @@ 
{
  "type":"image", 
  "page":1,  
  "x": 327, 
  "y": 628, 
  "w": 114, 
  "h": 21, 
  "options": {
    "required": true, 
    "name": "image"
  }
}

Request​

-

Body

required

    file base64required
    title stringrequired
    description string
    note string
    timeToCompleteDays number

    time to complete days is used to calculate expiry date of your document

    signer

    object

    role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

    • type string

    Allowed values - signature, stamp.

    page number

    The page number on which the widget should appear. use our Debug UI to calculate the value.

    x number

    x co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    y number

    y co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    w number

    Width of widget. use our Debug UI to calculate the value.

    h number

    Height of widget. use our Debug UI to calculate the value.

  • ]

    • folderId string
    send_email boolean

    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.

    email_subject string

    Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

    email_body string

    Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

    enableTour boolean

    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.

+

Body

required

    file base64required
    title stringrequired
    description string
    note string
    timeToCompleteDays number

    time to complete days is used to calculate expiry date of your document

    signer

    object

    role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

    • type string

    Allowed values - signature, stamp.

    page number

    The page number on which the widget should appear. use our Debug UI to calculate the value.

    x number

    x co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    y number

    y co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    w number

    Width of widget. use our Debug UI to calculate the value.

    h number

    Height of widget. use our Debug UI to calculate the value.

  • ]

    • folderId string
    send_email boolean

    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.

    email_subject string

    Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

    email_body string

    Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

    enableTour boolean

    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.

    redirect_url string

    Specifies the URL where the signer will be redirected upon completing the document signing process.

Responses​

Document created successfully!

Schema

    objectId string
    url string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/update-document/index.html b/docs/API-docs/update-document/index.html index 3fc643d2d..c81f15b39 100644 --- a/docs/API-docs/update-document/index.html +++ b/docs/API-docs/update-document/index.html @@ -5,7 +5,7 @@ Update Document | OpenSign™ - + @@ -14,7 +14,7 @@

The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.

Request​

Path Parameters

    document_id stringrequired

    ID of the document that needs to be updated

-

Body

Provide below parameter to update templates (at least one parameter required)

    name string
    note string
    description string
    folderId string
    enableOTP boolean

    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.

    enableTour boolean

    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.

+

Body

Provide below parameter to update templates (at least one parameter required)

    name string
    note string
    description string
    folderId string
    enableOTP boolean

    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.

    enableTour boolean

    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.

    allow_modifications boolean

    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.

Responses​

Document updated successfully!

Schema

    objectId string
    updatedAt date
Loading...
\ No newline at end of file diff --git a/docs/API-docs/update-template/index.html b/docs/API-docs/update-template/index.html index b041d0b9b..ee356765c 100644 --- a/docs/API-docs/update-template/index.html +++ b/docs/API-docs/update-template/index.html @@ -5,7 +5,7 @@ Update Template | OpenSign™ - + @@ -14,7 +14,7 @@

The Update Template API enables you to modify and update the details of a specific template.

Request​

Path Parameters

    template_id stringrequired

    ID of the template that needs to be updated

-

Body

Provide below parameter to update templates (at least one parameter required)

    name string
    note string
    description string
    folderId string
    enableOTP boolean

    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.

    enableTour boolean

    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.

+

Body

Provide below parameter to update templates (at least one parameter required)

    name string
    note string
    description string
    folderId string
    enableOTP boolean

    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.

    enableTour boolean

    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.

    allow_modifications boolean

    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.

Responses​

Template updated successfully!

Schema

    objectId string
    updatedAt date
Loading...
\ No newline at end of file diff --git a/docs/API-docs/updatefolder/index.html b/docs/API-docs/updatefolder/index.html index 8d633da01..f3fd0c295 100644 --- a/docs/API-docs/updatefolder/index.html +++ b/docs/API-docs/updatefolder/index.html @@ -5,7 +5,7 @@ Update Folder | OpenSign™ - + diff --git a/docs/category/cloud-storage/index.html b/docs/category/cloud-storage/index.html index 27f36ee5e..0666a11e0 100644 --- a/docs/category/cloud-storage/index.html +++ b/docs/category/cloud-storage/index.html @@ -5,7 +5,7 @@ Cloud Storage | OpenSign™ - + diff --git a/docs/category/create-new-opensign-document/index.html b/docs/category/create-new-opensign-document/index.html index a5de696a1..6392e044a 100644 --- a/docs/category/create-new-opensign-document/index.html +++ b/docs/category/create-new-opensign-document/index.html @@ -5,7 +5,7 @@ Create New OpenSign Document | OpenSign™ - + diff --git a/docs/category/docker/index.html b/docs/category/docker/index.html index 27201c8a6..199c4235d 100644 --- a/docs/category/docker/index.html +++ b/docs/category/docker/index.html @@ -5,7 +5,7 @@ Docker | OpenSign™ - + diff --git a/docs/category/faqs/index.html b/docs/category/faqs/index.html index db428016d..95d7c74f1 100644 --- a/docs/category/faqs/index.html +++ b/docs/category/faqs/index.html @@ -5,7 +5,7 @@ FAQs | OpenSign™ - + diff --git a/docs/category/guides/index.html b/docs/category/guides/index.html index 123f40e92..061c7b274 100644 --- a/docs/category/guides/index.html +++ b/docs/category/guides/index.html @@ -5,7 +5,7 @@ Guides | OpenSign™ - + diff --git a/docs/category/manage-docs-using-opensign-drive/index.html b/docs/category/manage-docs-using-opensign-drive/index.html index 4aa71e4dd..c8e5795f3 100644 --- a/docs/category/manage-docs-using-opensign-drive/index.html +++ b/docs/category/manage-docs-using-opensign-drive/index.html @@ -5,7 +5,7 @@ Manage Docs using OpenSign™ Drive | OpenSign™ - + diff --git a/docs/category/reports/index.html b/docs/category/reports/index.html index 5a09915c8..ab8687f53 100644 --- a/docs/category/reports/index.html +++ b/docs/category/reports/index.html @@ -5,7 +5,7 @@ Reports | OpenSign™ - + diff --git a/docs/category/settings/index.html b/docs/category/settings/index.html index 7beea640e..7ed55b81f 100644 --- a/docs/category/settings/index.html +++ b/docs/category/settings/index.html @@ -5,7 +5,7 @@ Settings | OpenSign™ - + diff --git a/docs/category/templates/index.html b/docs/category/templates/index.html index 9da27c8b7..1ba6dfa07 100644 --- a/docs/category/templates/index.html +++ b/docs/category/templates/index.html @@ -5,7 +5,7 @@ Templates | OpenSign™ - + diff --git a/docs/contribute/CODE_OF_CONDUCT/index.html b/docs/contribute/CODE_OF_CONDUCT/index.html index c5be46c3b..9d86e50ff 100644 --- a/docs/contribute/CODE_OF_CONDUCT/index.html +++ b/docs/contribute/CODE_OF_CONDUCT/index.html @@ -5,7 +5,7 @@ Code of conduct | OpenSign™ - + diff --git a/docs/contribute/COMMUNITY/index.html b/docs/contribute/COMMUNITY/index.html index 04f5b021e..c70645ce8 100644 --- a/docs/contribute/COMMUNITY/index.html +++ b/docs/contribute/COMMUNITY/index.html @@ -5,7 +5,7 @@ Community at OpenSign™ | OpenSign™ - + diff --git a/docs/contribute/INSTALLATION/index.html b/docs/contribute/INSTALLATION/index.html index 0a7e7a607..2af5b0574 100644 --- a/docs/contribute/INSTALLATION/index.html +++ b/docs/contribute/INSTALLATION/index.html @@ -5,7 +5,7 @@ Installation instructions | OpenSign™ - + diff --git a/docs/contribute/REPORTING_GUIDELINES/index.html b/docs/contribute/REPORTING_GUIDELINES/index.html index 566c23a74..e313fe566 100644 --- a/docs/contribute/REPORTING_GUIDELINES/index.html +++ b/docs/contribute/REPORTING_GUIDELINES/index.html @@ -5,7 +5,7 @@ OpenSign™ Reporting Guidelines | OpenSign™ - + diff --git a/docs/contribute/intro/index.html b/docs/contribute/intro/index.html index 144002b48..316f573fc 100644 --- a/docs/contribute/intro/index.html +++ b/docs/contribute/intro/index.html @@ -5,7 +5,7 @@ Contributing to OpenSign | OpenSign™ - + diff --git a/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html b/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html index ae59565f2..98e698b2a 100644 --- a/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html +++ b/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html @@ -5,7 +5,7 @@ Why am I getting 'Ensure this field is accurately filled and meets all requirements'? | OpenSign™ - + diff --git a/docs/help/FAQs/index.html b/docs/help/FAQs/index.html index 7b76774c9..0bb49e656 100644 --- a/docs/help/FAQs/index.html +++ b/docs/help/FAQs/index.html @@ -5,7 +5,7 @@ Why is there no dropdown list when I sign a document myself? | OpenSign™ - + diff --git a/docs/help/New-Document/enforce-email-verification/index.html b/docs/help/New-Document/enforce-email-verification/index.html index 57a022b99..0be8e4e66 100644 --- a/docs/help/New-Document/enforce-email-verification/index.html +++ b/docs/help/New-Document/enforce-email-verification/index.html @@ -5,7 +5,7 @@ Enforce email OTP verification | OpenSign™ - + diff --git a/docs/help/New-Document/navigate-between-pages/index.html b/docs/help/New-Document/navigate-between-pages/index.html index 69b3e8bb4..f3fbbbfa8 100644 --- a/docs/help/New-Document/navigate-between-pages/index.html +++ b/docs/help/New-Document/navigate-between-pages/index.html @@ -5,7 +5,7 @@ Navigate between pages of a document | OpenSign™ - + diff --git a/docs/help/New-Document/request-signatures/index.html b/docs/help/New-Document/request-signatures/index.html index ddb9f836d..5e93e14e1 100644 --- a/docs/help/New-Document/request-signatures/index.html +++ b/docs/help/New-Document/request-signatures/index.html @@ -5,7 +5,7 @@ Request signatures | OpenSign™ - + diff --git a/docs/help/New-Document/sign-yourself/index.html b/docs/help/New-Document/sign-yourself/index.html index faaa16ba6..939324834 100644 --- a/docs/help/New-Document/sign-yourself/index.html +++ b/docs/help/New-Document/sign-yourself/index.html @@ -5,7 +5,7 @@ Sign your-self | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/create-document/index.html b/docs/help/OpenSign™ Drive/create-document/index.html index 1768ecc9a..d77e144a7 100644 --- a/docs/help/OpenSign™ Drive/create-document/index.html +++ b/docs/help/OpenSign™ Drive/create-document/index.html @@ -5,7 +5,7 @@ Create Docs & Folders | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/list-grid-view/index.html b/docs/help/OpenSign™ Drive/list-grid-view/index.html index 13e19c907..66dc78ebf 100644 --- a/docs/help/OpenSign™ Drive/list-grid-view/index.html +++ b/docs/help/OpenSign™ Drive/list-grid-view/index.html @@ -5,7 +5,7 @@ Grid vs List view | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/organize-documents/index.html b/docs/help/OpenSign™ Drive/organize-documents/index.html index 27904b85c..09c2f05c3 100644 --- a/docs/help/OpenSign™ Drive/organize-documents/index.html +++ b/docs/help/OpenSign™ Drive/organize-documents/index.html @@ -5,7 +5,7 @@ OpenSign™ Drive Interface Documentation | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/rename-document/index.html b/docs/help/OpenSign™ Drive/rename-document/index.html index 30ac12b43..408a253da 100644 --- a/docs/help/OpenSign™ Drive/rename-document/index.html +++ b/docs/help/OpenSign™ Drive/rename-document/index.html @@ -5,7 +5,7 @@ Rename documents from OpenSign™ Drive | OpenSign™ - + diff --git a/docs/help/Reports/completed/index.html b/docs/help/Reports/completed/index.html index 3f381028f..6cbf7adbd 100644 --- a/docs/help/Reports/completed/index.html +++ b/docs/help/Reports/completed/index.html @@ -5,7 +5,7 @@ Completed | OpenSign™ - + diff --git a/docs/help/Reports/contactbook/index.html b/docs/help/Reports/contactbook/index.html index a54e788db..6c49be4cc 100644 --- a/docs/help/Reports/contactbook/index.html +++ b/docs/help/Reports/contactbook/index.html @@ -5,7 +5,7 @@ Contactbook | OpenSign™ - + diff --git a/docs/help/Reports/declined/index.html b/docs/help/Reports/declined/index.html index fd7ca34c1..9fea03e0e 100644 --- a/docs/help/Reports/declined/index.html +++ b/docs/help/Reports/declined/index.html @@ -5,7 +5,7 @@ Declined | OpenSign™ - + diff --git a/docs/help/Reports/drafts/index.html b/docs/help/Reports/drafts/index.html index 224bed186..ccd59d303 100644 --- a/docs/help/Reports/drafts/index.html +++ b/docs/help/Reports/drafts/index.html @@ -5,7 +5,7 @@ Drafts | OpenSign™ - + diff --git a/docs/help/Reports/expired/index.html b/docs/help/Reports/expired/index.html index a4c591121..514ca958f 100644 --- a/docs/help/Reports/expired/index.html +++ b/docs/help/Reports/expired/index.html @@ -5,7 +5,7 @@ Expired | OpenSign™ - + diff --git a/docs/help/Reports/in-progress/index.html b/docs/help/Reports/in-progress/index.html index 6ddad6673..63f6c3a69 100644 --- a/docs/help/Reports/in-progress/index.html +++ b/docs/help/Reports/in-progress/index.html @@ -5,7 +5,7 @@ In Progress | OpenSign™ - + diff --git a/docs/help/Reports/need-your-sign/index.html b/docs/help/Reports/need-your-sign/index.html index a37b1265f..21602e941 100644 --- a/docs/help/Reports/need-your-sign/index.html +++ b/docs/help/Reports/need-your-sign/index.html @@ -5,7 +5,7 @@ Need your sign | OpenSign™ - + diff --git a/docs/help/Settings/disabledocumentid/index.html b/docs/help/Settings/disabledocumentid/index.html index cf116017c..283ea8ffc 100644 --- a/docs/help/Settings/disabledocumentid/index.html +++ b/docs/help/Settings/disabledocumentid/index.html @@ -5,7 +5,7 @@ Disable DocumentId | OpenSign™ - + diff --git a/docs/help/Settings/manage-users/index.html b/docs/help/Settings/manage-users/index.html index 91b29901f..1c91a9e83 100644 --- a/docs/help/Settings/manage-users/index.html +++ b/docs/help/Settings/manage-users/index.html @@ -5,7 +5,7 @@ Manage users | OpenSign™ - + diff --git a/docs/help/Settings/my-signature/index.html b/docs/help/Settings/my-signature/index.html index dd97466c4..ab2bc7615 100644 --- a/docs/help/Settings/my-signature/index.html +++ b/docs/help/Settings/my-signature/index.html @@ -5,7 +5,7 @@ My Signature | OpenSign™ - + diff --git a/docs/help/Templates/create-template/index.html b/docs/help/Templates/create-template/index.html index 048df57cd..7e0061fe0 100644 --- a/docs/help/Templates/create-template/index.html +++ b/docs/help/Templates/create-template/index.html @@ -5,7 +5,7 @@ Create Templates | OpenSign™ - + diff --git a/docs/help/Templates/embed-template/index.html b/docs/help/Templates/embed-template/index.html index bc8d0e5ba..cb918b36c 100644 --- a/docs/help/Templates/embed-template/index.html +++ b/docs/help/Templates/embed-template/index.html @@ -5,7 +5,7 @@ Embedding OpenSign templates | OpenSign™ - + diff --git a/docs/help/Templates/publicTemplate/index.html b/docs/help/Templates/publicTemplate/index.html index f8b507c31..7990efc11 100644 --- a/docs/help/Templates/publicTemplate/index.html +++ b/docs/help/Templates/publicTemplate/index.html @@ -5,7 +5,7 @@ Setting up an OpenSign template for public signing | OpenSign™ - + diff --git a/docs/help/Templates/quick-send/index.html b/docs/help/Templates/quick-send/index.html index 04b462384..59b33e72b 100644 --- a/docs/help/Templates/quick-send/index.html +++ b/docs/help/Templates/quick-send/index.html @@ -5,7 +5,7 @@ Quickly Send the Document for Signature Using Template | OpenSign™ - + diff --git a/docs/help/Templates/use-template/index.html b/docs/help/Templates/use-template/index.html index ee9f13f58..973dee4c5 100644 --- a/docs/help/Templates/use-template/index.html +++ b/docs/help/Templates/use-template/index.html @@ -5,7 +5,7 @@ Use template to create documents | OpenSign™ - + diff --git a/docs/help/intro/index.html b/docs/help/intro/index.html index 84688623f..21faf0c68 100644 --- a/docs/help/intro/index.html +++ b/docs/help/intro/index.html @@ -5,7 +5,7 @@ Intro | OpenSign™ - + diff --git a/docs/intro/index.html b/docs/intro/index.html index 8ffec24ab..d6392fe8a 100644 --- a/docs/intro/index.html +++ b/docs/intro/index.html @@ -5,7 +5,7 @@ Tutorial Intro | OpenSign™ - + diff --git a/docs/self-host/One-click-Install/DigitalOcean/index.html b/docs/self-host/One-click-Install/DigitalOcean/index.html index 309414d52..3fcfd821a 100644 --- a/docs/self-host/One-click-Install/DigitalOcean/index.html +++ b/docs/self-host/One-click-Install/DigitalOcean/index.html @@ -5,7 +5,7 @@ Digital Ocean | OpenSign™ - + diff --git a/docs/self-host/cloud-storage/s3/index.html b/docs/self-host/cloud-storage/s3/index.html index 0b3748060..a8bfa93c0 100644 --- a/docs/self-host/cloud-storage/s3/index.html +++ b/docs/self-host/cloud-storage/s3/index.html @@ -5,7 +5,7 @@ AWS S3 | OpenSign™ - + diff --git a/docs/self-host/docker/run-locally/index.html b/docs/self-host/docker/run-locally/index.html index 457b09581..d67a58ad3 100644 --- a/docs/self-host/docker/run-locally/index.html +++ b/docs/self-host/docker/run-locally/index.html @@ -5,7 +5,7 @@ Self-host OpenSign™ with Docker on Linux/MacOS/Windows | OpenSign™ - + diff --git a/docs/self-host/docker/upgrade-deployment/index.html b/docs/self-host/docker/upgrade-deployment/index.html index 063fc6b91..b1c5c17f9 100644 --- a/docs/self-host/docker/upgrade-deployment/index.html +++ b/docs/self-host/docker/upgrade-deployment/index.html @@ -5,7 +5,7 @@ OpenSign™ Self-Hosted 'Upgrade Deployment' Guide Using Docker on Linux, macOS, or Windows | OpenSign™ - + diff --git a/docs/self-host/guides/env-variables/index.html b/docs/self-host/guides/env-variables/index.html index 17a9d898f..41d4f44c6 100644 --- a/docs/self-host/guides/env-variables/index.html +++ b/docs/self-host/guides/env-variables/index.html @@ -5,7 +5,7 @@ ENV variables which are used to setup OpenSign™ with Docker on Localhost | OpenSign™ - + diff --git a/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate/index.html b/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate/index.html index 37f7efdca..88471ae2f 100644 --- a/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate/index.html +++ b/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate/index.html @@ -5,7 +5,7 @@ How to generate self-signed document signing certificate? | OpenSign™ - + diff --git a/docs/self-host/guides/upgrade-to-v2.1.0/index.html b/docs/self-host/guides/upgrade-to-v2.1.0/index.html index ec151bcd6..3ad176f89 100644 --- a/docs/self-host/guides/upgrade-to-v2.1.0/index.html +++ b/docs/self-host/guides/upgrade-to-v2.1.0/index.html @@ -5,7 +5,7 @@ How to upgrade self-hosted OpenSign to v2.1.0? | OpenSign™ - + diff --git a/docs/self-host/intro/index.html b/docs/self-host/intro/index.html index 3a17e5004..c3609f2c3 100644 --- a/docs/self-host/intro/index.html +++ b/docs/self-host/intro/index.html @@ -5,7 +5,7 @@ Self-Hosting OpenSign | OpenSign™ - + diff --git a/index.html b/index.html index eb320e48f..70e62a592 100644 --- a/index.html +++ b/index.html @@ -5,7 +5,7 @@ Official OpenSign™ Docs - tutorials, API documentation, self-host help & much more. | OpenSign™ - + diff --git a/markdown-page/index.html b/markdown-page/index.html index c90ccfe7c..49778fc1d 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +