diff --git a/404.html b/404.html index c1e3d7af3..c2906989d 100644 --- a/404.html +++ b/404.html @@ -5,8 +5,8 @@ Page Not Found | OpenSign™ - - + +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

diff --git a/assets/js/0028a090.77285676.js b/assets/js/0028a090.3d5cb0c8.js similarity index 73% rename from assets/js/0028a090.77285676.js rename to assets/js/0028a090.3d5cb0c8.js index 4abc605ed..91da955f9 100644 --- a/assets/js/0028a090.77285676.js +++ b/assets/js/0028a090.3d5cb0c8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4317],{87440:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>f,contentTitle:()=>x,default:()=>j,frontMatter:()=>g,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"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":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJztO9122zjOr8LVTWd8ZCd200ybq820mY67zc826W+S06El2GIjkSpJxXFzfLdPso+2T7IHICnLdpxkfr7ZzPl8k1gkSAIgAIIgcB1ZPjLRzml0AkWZcwsmOo+jFEyiRWmFktFOdJIBC93sheZDK+SI7R71GUg+yMGwyoA2zCqWaECgpDJWFeIb9jIbZo6ZAX2JY7lhg7yCUgtpDRsqzUYgQXOaOFVJVQB2jIXNWKkhhaGQkDJjdZXYSoPpsLelksxUSQLGDKvcrSyUZGrIeL1mzGwGhKoGW2lpGGeVFF8rYK2WGnyBxPbTVot9l4IRI8ktpIhcGP5ZpN/HbJyJJGMJl2wASGqKlHqEoYHugGOfkrSmKSERQ4HAfrIO201TgTjyPJ/EjLNWq9J5q8WEYaVWlyKFNKymhkNkKSfWMiEt6CFPgHgFOIsc0TJhcsZlyoY8Ebmw82xkqTBWi0GFK3fO5Jk8EeUOe1vmiqdsoirNjl78NAO3imHbaav1AgbViL3tt1rn32XWlmZnY4OXZUeVIJFbOR+YTqKKjRQBy3RIvAINOCvxC7gR+YTxNGVjkY7AGtoQyRJVTliilE6FdKJR8hEwWRUD0CYmagqlgQnJONPA00nbqnZlgL06PjxANhTcdthRXpm4Xi4VGhKbT9z0yJ5A1SO3O9tbKENCjmJW8AvkkrDsayWSCyTbgKSt9SJDvGq13iO+NXeE8TKeMmYzYdgYBplSFwwusXss8pxZLUYj0K3Wmfzll1/O5PWZZOwsIoizaIedRX6Ksyh2XXZSgut5cfj87f7ewcnnk49He3V/kNQFmP6LGmIo8sUZ3r55XXdLXix2H+zuzxaQyvr+oxy4AabhUsCY9gG32tEauFAPa9gJN7ruwUGgDbaeYgtj1+7fPDbH/ZcHe2+auDgIKLjI50D29nf7r+dgykzJ+WmOfj48mJ+n0o1Z+gcvHVNc/xT/nXt8/Y7s+g066e/vHZ/s7h8h8NTvI0rDcVWWSuP2v3cCvYPbfCZ/hFyNGddA0pOoolCSlVzzAizZxoxb6tbwtRIaUmfceJ4Hzdg5k23WaqEo7LRarC9TkaBqODWflICWzcF2HCiqDIIee1PjQBuKhLbImRPUkDF32l3maEgQVANaKSsuYX7iq5hNcOIXgHLhps2UFt+UtDwnobgEbUXC86YSI4Jk+izXZIJKJaQNrX4F9tErK+oyqai3MohaiswqhKQeA+yS5xUYj9U4Zhli9QZKDYYsrp8XGSlTloEYZSvX4+mXyti5iVllgh0NWPi1wi4Re4HYNuS5ASaGc7ws+AU0VmOqdPa9w36csBSGvMptzATaH6sr6LADZRkvy1wkdDaiOXcHT6WhTbvsxcEjgqqCSBy58wFPhFTg2YDWBjtpCj8mYIdy5g4UJI/sqM24ZEoubHSicqWXRYia5/nIEiUtSNthu5dc5IS8I9YwIZO8SoENcp5cxHSyx0zjWYa7MoE8V+PYyTuB0AlLPCf+MAM5SqGSiL9UfnlhZmdoh52g/an1CTsDq2kRYZpc9TZ8qHBlZEFQMUZ2JSbGxeyLGjArbA4xKmzJ5SRmqXMa4MoO1FXMkgySC/qleSoUG1TWKukIS7UqUzWWnpdDJa0R327QyNDz6znai9lWzLZj9jRm3c2YdXsx627FrLsds+7TmPU2Y9brxay3FbPetkOr99TzmtcMbiLQ7Tku278Od9HuvhaGNBsNpqlt8HjOBnc7rNWqtWnx+J2dsTVIfVqhzcS+rv++wo/HvR/85wQ/t3tP/eeYQLtb/jPDz163eU70CBPLi/IWLLD7D8UgOAtOiLDNn7lnUbBn2IiGKA4ds6PY44Md0yYtj5EWIYUVPDeryQkQD4iiGUpLRG0hUSSuqynyPsiDIaeJD7ksaCZdF5nVRldQeMKit0T9k44/WVYT75Z9MLQ30Pl9pG+TNKsBO0HTtJr+2no9ICYs4vT7OPFDhxwAssyr+eABHhAX5jH6fTx4ijzAQ2k1A7D3AVHfQMddwOiEd32bW+3uk3Zvs7c1xwG8KTuAominaXsymfwR3EOfxy+PLk/wUJ1nhxGJoVbFDdcPuh3MoLxPRL+Dy76PjvoA6qAIRgHmYyrh/t/0sq1K+eSRcVOFobVzhvAz12zSQJO6EA+KhSSZEolHHmGCSzbAC14HedBGvqcb+/sbDU66xnZRtBca8bNNjG80FkUnTTsLkEu74xoLlqYxW26+sT1NWVEUK5pd+1lELtUzFH3via2Wfg/wZynATM7nF75VOTA6pGROa9Ml7WbtWDhCMhGCMV5U2AKAhlGVcw1XeNs0ixGOP1BzguLM/HW6ndLFzoX4iBXsu0Pvk3/vhRpJmJ8AW+4et0RZcxINI7iiOVwQF5ERKYVWY4y3Znh748H1R77Ponb0lfBSYJQgB2upFWzSuQkJt2uNGzbu6uIF24CdI4YbFkbecMem7Sfx7m7S8eYvGLecbx7iAZn4BZSw04UrXDAtKjh5AChlMPutbAb6LDqvx7hbNaR3jD2/hx5lIoWcDyBf7rq3DjRp8fLUYAx2FELWkQDCd7MRyCv41ULn2SyIt6BbjuKmUAcjHlQjsJjlwoRYyDy/mqN9sIhCeBJc+H8ALAxgg1oMf7eY14jdT86dFfCbc8cSCMcIsA7UhdXuWGFuY5qMwTkKIUVRFXXEcVjPGlhW+NO8yS8ciS8bYYXm7i6twK/uWME/zaxY4Ex2KTIQIgq3+Hoe4gEZgwWUbtfT32Im5s7IP+hwu1sBA1lNBbzhSERQdxjWymdWa1+HHeIBhFFONwjjVkkCpcUY1+9VzRrlex9BFAVyka0fKbK1WvKa8a8HJH03oPV/LIEe7s+RwiZ5fyFJnEP73tLo4ngFH91y2aXuByR/Hp+FzY3iSJWULaBkP412ohRzEsJLeBTTzGDsjyqdRDvXkQ+0408fxsaRG18MZjdcRybJoOD4K2CE+RD4oBrF4R0ziiOKvGByBLIr2vFvslGM94cSX8PA4Bw0buc6QLnn5ij29/BoJ3Lv0FEcwRUvSgT2TQxkovC2S1NMw4q3zVW3zOYy9KPOC8B58BHvN05DQ6cLCSG/aabmDNMZX2eTca35JFrMPQmvd+GS5sbVzxP5JCiJsKgK9ZMSgUVxJCwUzVVW7JpWv57TCSikhMKyv3YsbQsvfvWaOI7evX/LQP9acgPP78kl17u88PyW7eLlENLgNrdnD5wxo0eGzl0SE+CJWj5qrumcwKU1T1Y9fDfe20ymqjzFlyzgukPvz7850YVynXieVJR7Ux8Oc5TVqNaUdadxdHU3MVcsUe3wqs6+y2FoWVWWoFmitAT9fTO09mCI621tTeNocjd5k78keT/g5o3vpu49pSPMUjX+F7g+fjqNo+xuXH+uEyb+h8hubU9nZ53Pw6nz7wYqnXwOdmt6F2A4VBAOk7n68lCnoBuMGCiVA5dLnOgPnXel2CN0RR75WBa9cwttwoHi8rs0JIA5MxSSDraKeafDPYIz//aITtkeNpCzaKqBQSgZ5jNuwgGEnDFMcnQQwiUJ0ks+8CTD7DTrsOJDfKSnXB9M01KVCehl3NBjew7oj9oMhEsvEXI07xw2uEOJFk3aO83dwRY85CjR8/Dk6B68JNe17TLG3DntqHRzsMOTI8weEkPvh3XYW1NzIrCWz4Ew9IvYpeAhw6C27RMXXQBJHFEhV22W+NfxeTtttoxQKsyNGMWz+Gad2Lo08SzZELdIVRazHH12JzMWSjPHR8KiZuSJqu4jlXdwkrNRRc8jFlU2pBJRzHWW/SOky5qli09a6ZDw5MUCITGFdsanwBUEaswfM5DGDedsyI0FHWMqLXJeV3ixqaeEqxK0AJnAjSzQ4Fj3udI3+k3zPJhPpXn75rVPMQ00BKUcoAa6iSFlVUlSQ5pQp3iFnVskfclRQu0A/XmVg7bselAilg+qlaANpiFrpvSIS/HNpyWjR6IMsAFkPHeg3lTg4xLigxo+j0ywtf/5178beK30OJcRcyvwNMVI/x0Y0sXWCTx63BpKtIBqHiOcD/TfFw8BxI6U5nOh0lqRzP1l/Ajz/qyp7aJVlDUMObjc6vDyUNtbEwcba7xbiQ8Qmh4KKAdblUgvXAljG0lK4Slx2T68AeRj0sCB3BDUapR5OWkqeI2XT4aaTUepVGI+wa0+Bhd04fbjzJ13szupN8WYtKmkcR55b3MT/y1sfMgJD5nKszT5fPK3KL7/hfj260DISr5JFGcS82PW+9mUskgyFJIVOj8Dv93VaF70N2DyKhu8TMSheNV/+63fPRB905dvniTP+9v9i/LDu+evnnVg8qqb9N5NPvTe2Y/vc9P/okTy86vsk3xnBs+fVB8/fNIfP/T1x/dvLH//ZHcgMzl4+ZNIJk++DHqb4vXzV5uf3nfHg5c/bX5696z8RJP/tPnp4mIzKQ6eD+QuwpQfP/xTHH7Ze7z/be/b/sne1f63/FmHH3z98vwqebZ/sbfd/tTX7f3DwT++fLXlmyfp44MPYvsp7MN7ebL5Ooma0iBkLiR8Dlv9mej+jJs9JaHYumnbj1UBNiNZp1R0rTDPvXT53FZPGB9xIRmyTv+BUgBaK337nv46zG5jxNbm5uduzYQny0zoS3pfopKPE3UB8s+ltLm8dcsjqlcFSb07UCLhgKg/miO22e6INJBUWthJtHN6HV21eSnarn/n9Hx6HkfIWIUxsFIZwpjbLNqJNhZDYlh5Q/GW02ung7WiGS5TfANaUjZeio3LbjSNF0fcqJoroY3lIyFH7VtHnc8oPcbdcAyfo3cWtCjFPwCjFp6dTag4EigFGXD0+5GBuMlvZvHAvbBVIVJ3Y/BttieL4bQQTZsLkC2eaTeEvBoRr9MQbqIIUh1AimYURXWQB3/WYZvTmeTVEZIQIOlSZKG3tUVX8B+6dFd9/JSugVvb03PH4caViCKuTb/eBfLnHFTfNO+wRdGCgzTnpSw6KSsdhhX+QnAShRwq2nO/D4clyGP0wVGzLrvL127IE1XUyckB/D//+jeNCOczLfM3dlhpVqoxaKwco8qpHK4Eer0ITIgZiipS1J0XORiDoUZpYeSKvsSIkhyCK5nwkg+w9godVSGtcslEDWtjOux9Bvj2gV2PtMv3uIQcLQzLlaJyJHR7KquKZmEZGyt9MUSUsGZsgDUL6MwZgDAEZMZlgi8RToXIEcLyK3TOSy0MMC4KBKbyseFQJAInRruoeWJZwSUfkUcT0/UfuVCGigOtBnjHMiqv3C0C6x4ArCORXkI67AXe2ohwbEzB4ran7gJhYneB82bSl3cN8LJc4vIiATPLDMvhEjSZDHf9rvKclcq6KzG6dM29xYms5tJggMEhFLamZp9382mNlE86DJ9D8EhCZxcFIBfywpXfnNZi9h4GRliYhT7G4/GS+fp+fsxLYbNqgI6zmo0bUSMZu+bw+uN7NDagC3M4PMbqyCQ4QSvW3CDgDX+q8YROtaBsvBQ3uua5SEAaaJxBuy+PXrNL9rizGcUNg30PhDde95/vHRzv4bx4pDj963Y2O5sUr1XGFlw2lqKK0bqAdFFzG88z60LTdaHputB0XWi6LjRdF5quC03XhabrQtN1oem60HRdaMrWhabrQtM/ifZ1oem60HRdaLouNF0Xmq4LTdeFputC03Wh6brQdF1oui40XReargtN14Wm60LTdaHp/69CU59whV7hRplzIRtJrC7X7nSh/PQ8jjLMxds5ja6v8S34rc6nU2z+WoHGRL7zOLrkWmCMm9L44pCvhhleFzCJdqLnLmTfPsHlYyftlN+xkL2I6XZuxC7t+q2wzXTBo8PjkyiOBr5EtlApjtF8jOWzfOzSvDwzqUCSU+1TzuWoooSzyM2JKXa8stl8ft4F5ef5H428NS4nDQznE/ccGfgXibpxwPW1y/2bTmt417VyhGdsgMbtO59Op/8FrLq/nQ==","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"}}');var s=t(74848),a=t(28453),r=t(33617),l=t.n(r),o=t(17543),d=t.n(o),c=t(86013),h=t.n(c),p=t(63723),u=t.n(p),m=(t(18766),t(79329),t(9303));const g={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:"eJztO9122zjOr8LVTWd8ZCd200ybq820mY67zc826W+S06El2GIjkSpJxXFzfLdPso+2T7IHICnLdpxkfr7ZzPl8k1gkSAIgAIIgcB1ZPjLRzml0AkWZcwsmOo+jFEyiRWmFktFOdJIBC93sheZDK+SI7R71GUg+yMGwyoA2zCqWaECgpDJWFeIb9jIbZo6ZAX2JY7lhg7yCUgtpDRsqzUYgQXOaOFVJVQB2jIXNWKkhhaGQkDJjdZXYSoPpsLelksxUSQLGDKvcrSyUZGrIeL1mzGwGhKoGW2lpGGeVFF8rYK2WGnyBxPbTVot9l4IRI8ktpIhcGP5ZpN/HbJyJJGMJl2wASGqKlHqEoYHugGOfkrSmKSERQ4HAfrIO201TgTjyPJ/EjLNWq9J5q8WEYaVWlyKFNKymhkNkKSfWMiEt6CFPgHgFOIsc0TJhcsZlyoY8Ebmw82xkqTBWi0GFK3fO5Jk8EeUOe1vmiqdsoirNjl78NAO3imHbaav1AgbViL3tt1rn32XWlmZnY4OXZUeVIJFbOR+YTqKKjRQBy3RIvAINOCvxC7gR+YTxNGVjkY7AGtoQyRJVTliilE6FdKJR8hEwWRUD0CYmagqlgQnJONPA00nbqnZlgL06PjxANhTcdthRXpm4Xi4VGhKbT9z0yJ5A1SO3O9tbKENCjmJW8AvkkrDsayWSCyTbgKSt9SJDvGq13iO+NXeE8TKeMmYzYdgYBplSFwwusXss8pxZLUYj0K3Wmfzll1/O5PWZZOwsIoizaIedRX6Ksyh2XXZSgut5cfj87f7ewcnnk49He3V/kNQFmP6LGmIo8sUZ3r55XXdLXix2H+zuzxaQyvr+oxy4AabhUsCY9gG32tEauFAPa9gJN7ruwUGgDbaeYgtj1+7fPDbH/ZcHe2+auDgIKLjI50D29nf7r+dgykzJ+WmOfj48mJ+n0o1Z+gcvHVNc/xT/nXt8/Y7s+g066e/vHZ/s7h8h8NTvI0rDcVWWSuP2v3cCvYPbfCZ/hFyNGddA0pOoolCSlVzzAizZxoxb6tbwtRIaUmfceJ4Hzdg5k23WaqEo7LRarC9TkaBqODWflICWzcF2HCiqDIIee1PjQBuKhLbImRPUkDF32l3maEgQVANaKSsuYX7iq5hNcOIXgHLhps2UFt+UtDwnobgEbUXC86YSI4Jk+izXZIJKJaQNrX4F9tErK+oyqai3MohaiswqhKQeA+yS5xUYj9U4Zhli9QZKDYYsrp8XGSlTloEYZSvX4+mXyti5iVllgh0NWPi1wi4Re4HYNuS5ASaGc7ws+AU0VmOqdPa9w36csBSGvMptzATaH6sr6LADZRkvy1wkdDaiOXcHT6WhTbvsxcEjgqqCSBy58wFPhFTg2YDWBjtpCj8mYIdy5g4UJI/sqM24ZEoubHSicqWXRYia5/nIEiUtSNthu5dc5IS8I9YwIZO8SoENcp5cxHSyx0zjWYa7MoE8V+PYyTuB0AlLPCf+MAM5SqGSiL9UfnlhZmdoh52g/an1CTsDq2kRYZpc9TZ8qHBlZEFQMUZ2JSbGxeyLGjArbA4xKmzJ5SRmqXMa4MoO1FXMkgySC/qleSoUG1TWKukIS7UqUzWWnpdDJa0R327QyNDz6znai9lWzLZj9jRm3c2YdXsx627FrLsds+7TmPU2Y9brxay3FbPetkOr99TzmtcMbiLQ7Tku278Od9HuvhaGNBsNpqlt8HjOBnc7rNWqtWnx+J2dsTVIfVqhzcS+rv++wo/HvR/85wQ/t3tP/eeYQLtb/jPDz163eU70CBPLi/IWLLD7D8UgOAtOiLDNn7lnUbBn2IiGKA4ds6PY44Md0yYtj5EWIYUVPDeryQkQD4iiGUpLRG0hUSSuqynyPsiDIaeJD7ksaCZdF5nVRldQeMKit0T9k44/WVYT75Z9MLQ30Pl9pG+TNKsBO0HTtJr+2no9ICYs4vT7OPFDhxwAssyr+eABHhAX5jH6fTx4ijzAQ2k1A7D3AVHfQMddwOiEd32bW+3uk3Zvs7c1xwG8KTuAominaXsymfwR3EOfxy+PLk/wUJ1nhxGJoVbFDdcPuh3MoLxPRL+Dy76PjvoA6qAIRgHmYyrh/t/0sq1K+eSRcVOFobVzhvAz12zSQJO6EA+KhSSZEolHHmGCSzbAC14HedBGvqcb+/sbDU66xnZRtBca8bNNjG80FkUnTTsLkEu74xoLlqYxW26+sT1NWVEUK5pd+1lELtUzFH3via2Wfg/wZynATM7nF75VOTA6pGROa9Ml7WbtWDhCMhGCMV5U2AKAhlGVcw1XeNs0ixGOP1BzguLM/HW6ndLFzoX4iBXsu0Pvk3/vhRpJmJ8AW+4et0RZcxINI7iiOVwQF5ERKYVWY4y3Znh748H1R77Ponb0lfBSYJQgB2upFWzSuQkJt2uNGzbu6uIF24CdI4YbFkbecMem7Sfx7m7S8eYvGLecbx7iAZn4BZSw04UrXDAtKjh5AChlMPutbAb6LDqvx7hbNaR3jD2/hx5lIoWcDyBf7rq3DjRp8fLUYAx2FELWkQDCd7MRyCv41ULn2SyIt6BbjuKmUAcjHlQjsJjlwoRYyDy/mqN9sIhCeBJc+H8ALAxgg1oMf7eY14jdT86dFfCbc8cSCMcIsA7UhdXuWGFuY5qMwTkKIUVRFXXEcVjPGlhW+NO8yS8ciS8bYYXm7i6twK/uWME/zaxY4Ex2KTIQIgq3+Hoe4gEZgwWUbtfT32Im5s7IP+hwu1sBA1lNBbzhSERQdxjWymdWa1+HHeIBhFFONwjjVkkCpcUY1+9VzRrlex9BFAVyka0fKbK1WvKa8a8HJH03oPV/LIEe7s+RwiZ5fyFJnEP73tLo4ngFH91y2aXuByR/Hp+FzY3iSJWULaBkP412ohRzEsJLeBTTzGDsjyqdRDvXkQ+0408fxsaRG18MZjdcRybJoOD4K2CE+RD4oBrF4R0ziiOKvGByBLIr2vFvslGM94cSX8PA4Bw0buc6QLnn5ij29/BoJ3Lv0FEcwRUvSgT2TQxkovC2S1NMw4q3zVW3zOYy9KPOC8B58BHvN05DQ6cLCSG/aabmDNMZX2eTca35JFrMPQmvd+GS5sbVzxP5JCiJsKgK9ZMSgUVxJCwUzVVW7JpWv57TCSikhMKyv3YsbQsvfvWaOI7evX/LQP9acgPP78kl17u88PyW7eLlENLgNrdnD5wxo0eGzl0SE+CJWj5qrumcwKU1T1Y9fDfe20ymqjzFlyzgukPvz7850YVynXieVJR7Ux8Oc5TVqNaUdadxdHU3MVcsUe3wqs6+y2FoWVWWoFmitAT9fTO09mCI621tTeNocjd5k78keT/g5o3vpu49pSPMUjX+F7g+fjqNo+xuXH+uEyb+h8hubU9nZ53Pw6nz7wYqnXwOdmt6F2A4VBAOk7n68lCnoBuMGCiVA5dLnOgPnXel2CN0RR75WBa9cwttwoHi8rs0JIA5MxSSDraKeafDPYIz//aITtkeNpCzaKqBQSgZ5jNuwgGEnDFMcnQQwiUJ0ks+8CTD7DTrsOJDfKSnXB9M01KVCehl3NBjew7oj9oMhEsvEXI07xw2uEOJFk3aO83dwRY85CjR8/Dk6B68JNe17TLG3DntqHRzsMOTI8weEkPvh3XYW1NzIrCWz4Ew9IvYpeAhw6C27RMXXQBJHFEhV22W+NfxeTtttoxQKsyNGMWz+Gad2Lo08SzZELdIVRazHH12JzMWSjPHR8KiZuSJqu4jlXdwkrNRRc8jFlU2pBJRzHWW/SOky5qli09a6ZDw5MUCITGFdsanwBUEaswfM5DGDedsyI0FHWMqLXJeV3ixqaeEqxK0AJnAjSzQ4Fj3udI3+k3zPJhPpXn75rVPMQ00BKUcoAa6iSFlVUlSQ5pQp3iFnVskfclRQu0A/XmVg7bselAilg+qlaANpiFrpvSIS/HNpyWjR6IMsAFkPHeg3lTg4xLigxo+j0ywtf/5178beK30OJcRcyvwNMVI/x0Y0sXWCTx63BpKtIBqHiOcD/TfFw8BxI6U5nOh0lqRzP1l/Ajz/qyp7aJVlDUMObjc6vDyUNtbEwcba7xbiQ8Qmh4KKAdblUgvXAljG0lK4Slx2T68AeRj0sCB3BDUapR5OWkqeI2XT4aaTUepVGI+wa0+Bhd04fbjzJ13szupN8WYtKmkcR55b3MT/y1sfMgJD5nKszT5fPK3KL7/hfj260DISr5JFGcS82PW+9mUskgyFJIVOj8Dv93VaF70N2DyKhu8TMSheNV/+63fPRB905dvniTP+9v9i/LDu+evnnVg8qqb9N5NPvTe2Y/vc9P/okTy86vsk3xnBs+fVB8/fNIfP/T1x/dvLH//ZHcgMzl4+ZNIJk++DHqb4vXzV5uf3nfHg5c/bX5696z8RJP/tPnp4mIzKQ6eD+QuwpQfP/xTHH7Ze7z/be/b/sne1f63/FmHH3z98vwqebZ/sbfd/tTX7f3DwT++fLXlmyfp44MPYvsp7MN7ebL5Ooma0iBkLiR8Dlv9mej+jJs9JaHYumnbj1UBNiNZp1R0rTDPvXT53FZPGB9xIRmyTv+BUgBaK337nv46zG5jxNbm5uduzYQny0zoS3pfopKPE3UB8s+ltLm8dcsjqlcFSb07UCLhgKg/miO22e6INJBUWthJtHN6HV21eSnarn/n9Hx6HkfIWIUxsFIZwpjbLNqJNhZDYlh5Q/GW02ung7WiGS5TfANaUjZeio3LbjSNF0fcqJoroY3lIyFH7VtHnc8oPcbdcAyfo3cWtCjFPwCjFp6dTag4EigFGXD0+5GBuMlvZvHAvbBVIVJ3Y/BttieL4bQQTZsLkC2eaTeEvBoRr9MQbqIIUh1AimYURXWQB3/WYZvTmeTVEZIQIOlSZKG3tUVX8B+6dFd9/JSugVvb03PH4caViCKuTb/eBfLnHFTfNO+wRdGCgzTnpSw6KSsdhhX+QnAShRwq2nO/D4clyGP0wVGzLrvL127IE1XUyckB/D//+jeNCOczLfM3dlhpVqoxaKwco8qpHK4Eer0ITIgZiipS1J0XORiDoUZpYeSKvsSIkhyCK5nwkg+w9godVSGtcslEDWtjOux9Bvj2gV2PtMv3uIQcLQzLlaJyJHR7KquKZmEZGyt9MUSUsGZsgDUL6MwZgDAEZMZlgi8RToXIEcLyK3TOSy0MMC4KBKbyseFQJAInRruoeWJZwSUfkUcT0/UfuVCGigOtBnjHMiqv3C0C6x4ArCORXkI67AXe2ohwbEzB4ran7gJhYneB82bSl3cN8LJc4vIiATPLDMvhEjSZDHf9rvKclcq6KzG6dM29xYms5tJggMEhFLamZp9382mNlE86DJ9D8EhCZxcFIBfywpXfnNZi9h4GRliYhT7G4/GS+fp+fsxLYbNqgI6zmo0bUSMZu+bw+uN7NDagC3M4PMbqyCQ4QSvW3CDgDX+q8YROtaBsvBQ3uua5SEAaaJxBuy+PXrNL9rizGcUNg30PhDde95/vHRzv4bx4pDj963Y2O5sUr1XGFlw2lqKK0bqAdFFzG88z60LTdaHputB0XWi6LjRdF5quC03XhabrQtN1oem60HRdaMrWhabrQtM/ifZ1oem60HRdaLouNF0Xmq4LTdeFputC03Wh6brQdF1oui40XReargtN14Wm60LTdaHp/69CU59whV7hRplzIRtJrC7X7nSh/PQ8jjLMxds5ja6v8S34rc6nU2z+WoHGRL7zOLrkWmCMm9L44pCvhhleFzCJdqLnLmTfPsHlYyftlN+xkL2I6XZuxC7t+q2wzXTBo8PjkyiOBr5EtlApjtF8jOWzfOzSvDwzqUCSU+1TzuWoooSzyM2JKXa8stl8ft4F5ef5H428NS4nDQznE/ccGfgXibpxwPW1y/2bTmt417VyhGdsgMbtO59Op/8FrLq/nQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,f={},y=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Draft Template"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/drafttemplate",context:"endpoint"}),"\n",(0,s.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,s.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,s.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.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,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"When document is created this webhook event will trigger"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\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,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.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,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"iob Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio Button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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 "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded file"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{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},x:{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},y:{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},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},url:{type:"string",example:"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}},title:"inline_response_draft_200"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4317],{87440:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>b,contentTitle:()=>x,default:()=>j,frontMatter:()=>g,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"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":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJztO9122zjOr8LVTWd8ZCd200ybq820mY67zc826W+S06El2GIjkSpJxXFzfLdPso+2T7IHICnLdpxkfr7ZzPl8k1gkSAIgAIIgcB1ZPjLRzml0AkWZcwsmOo+jFEyiRWmFktFOdJIBC93sheZDK+SI7R71GUg+yMGwyoA2zCqWaECgpDJWFeIb9jIbZo6ZAX2JY7lhg7yCUgtpDRsqzUYgQXOaOFVJVQB2jIXNWKkhhaGQkDJjdZXYSoPpsLelksxUSQLGDKvcrSyUZGrIeL1mzGwGhKoGW2lpGGeVFF8rYK2WGnyBxPbTVot9l4IRI8ktpIhcGP5ZpN/HbJyJJGMJl2wASGqKlHqEoYHugGOfkrSmKSERQ4HAfrIO201TgTjyPJ/EjLNWq9J5q8WEYaVWlyKFNKymhkNkKSfWMiEt6CFPgHgFOIsc0TJhcsZlyoY8Ebmw82xkqTBWi0GFK3fO5Jk8EeUOe1vmiqdsoirNjl78NAO3imHbaav1AgbViL3tt1rn32XWlmZnY4OXZUeVIJFbOR+YTqKKjRQBy3RIvAINOCvxC7gR+YTxNGVjkY7AGtoQyRJVTliilE6FdKJR8hEwWRUD0CYmagqlgQnJONPA00nbqnZlgL06PjxANhTcdthRXpm4Xi4VGhKbT9z0yJ5A1SO3O9tbKENCjmJW8AvkkrDsayWSCyTbgKSt9SJDvGq13iO+NXeE8TKeMmYzYdgYBplSFwwusXss8pxZLUYj0K3Wmfzll1/O5PWZZOwsIoizaIedRX6Ksyh2XXZSgut5cfj87f7ewcnnk49He3V/kNQFmP6LGmIo8sUZ3r55XXdLXix2H+zuzxaQyvr+oxy4AabhUsCY9gG32tEauFAPa9gJN7ruwUGgDbaeYgtj1+7fPDbH/ZcHe2+auDgIKLjI50D29nf7r+dgykzJ+WmOfj48mJ+n0o1Z+gcvHVNc/xT/nXt8/Y7s+g066e/vHZ/s7h8h8NTvI0rDcVWWSuP2v3cCvYPbfCZ/hFyNGddA0pOoolCSlVzzAizZxoxb6tbwtRIaUmfceJ4Hzdg5k23WaqEo7LRarC9TkaBqODWflICWzcF2HCiqDIIee1PjQBuKhLbImRPUkDF32l3maEgQVANaKSsuYX7iq5hNcOIXgHLhps2UFt+UtDwnobgEbUXC86YSI4Jk+izXZIJKJaQNrX4F9tErK+oyqai3MohaiswqhKQeA+yS5xUYj9U4Zhli9QZKDYYsrp8XGSlTloEYZSvX4+mXyti5iVllgh0NWPi1wi4Re4HYNuS5ASaGc7ws+AU0VmOqdPa9w36csBSGvMptzATaH6sr6LADZRkvy1wkdDaiOXcHT6WhTbvsxcEjgqqCSBy58wFPhFTg2YDWBjtpCj8mYIdy5g4UJI/sqM24ZEoubHSicqWXRYia5/nIEiUtSNthu5dc5IS8I9YwIZO8SoENcp5cxHSyx0zjWYa7MoE8V+PYyTuB0AlLPCf+MAM5SqGSiL9UfnlhZmdoh52g/an1CTsDq2kRYZpc9TZ8qHBlZEFQMUZ2JSbGxeyLGjArbA4xKmzJ5SRmqXMa4MoO1FXMkgySC/qleSoUG1TWKukIS7UqUzWWnpdDJa0R327QyNDz6znai9lWzLZj9jRm3c2YdXsx627FrLsds+7TmPU2Y9brxay3FbPetkOr99TzmtcMbiLQ7Tku278Od9HuvhaGNBsNpqlt8HjOBnc7rNWqtWnx+J2dsTVIfVqhzcS+rv++wo/HvR/85wQ/t3tP/eeYQLtb/jPDz163eU70CBPLi/IWLLD7D8UgOAtOiLDNn7lnUbBn2IiGKA4ds6PY44Md0yYtj5EWIYUVPDeryQkQD4iiGUpLRG0hUSSuqynyPsiDIaeJD7ksaCZdF5nVRldQeMKit0T9k44/WVYT75Z9MLQ30Pl9pG8j6WiaTtA0raa/tl4PiAmLOP0+TvzQIQeALPNqPniAB8SFeYx+Hw+eIg/wUFrNAOx9QNQ30HEXMDrhXd/mVrv7pN3b7G3NcQBvyg6gKNpp2p5MJn8E99Dn8cujyxM8VOfZYURiqFVxw/WDbgczKO8T0e/gsu+joz6AOiiCUYD5mEq4/ze9bKtSPnlk3FRhaO2cIfzMNZs00KQuxINiIUmmROKRR5jgkg3wgtdBHrSR7+nG/v5Gg5OusV0U7YVG/GwT4xuNRdFJ084C5NLuuMaCpWnMlptvbE9TVhTFimbXfhaRS/UMRd97Yqul3wP8WQowk/P5hW9VDowOKZnT2nRJu1k7Fo6QTIRgjBcVtgCgYVTlXMMV3jbNYoTjD9ScoDgzf51up3SxcyE+YgX77tD75N97oUYS5ifAlrvHLVHWnETDCK5oDhfERWRESqHVGOOtGd7eeHD9ke+zqB19JbwUGCXIwVpqBZt0bkLC7Vrjho27unjBNmDniOGGhZE33LFp+0m8u5t0vPkLxi3nm4d4QCZ+ASXsdOEKF0yLCk4eAEoZzH4rm4E+i87rMe5WDekdY8/voUeZSCHnA8iXu+6tA01avDw1GIMdhZB1JIDw3WwE8gp+tdB5NgviLeiWo7gp1MGIB9UILGa5MCEWMs+v5mgfLKIQngQX/h8ACwPYoBbD3y3mNWL3k3NnBfzm3LEEwjECrAN1YbU7VpjbmCZjcI5CSFFURR1xHNazBpYV/jRv8gtH4stGWKG5u0sr8Ks7VvBPMysWOJNdigyEiMItvp6HeEDGYAGl2/X0t5iJuTPyDzrc7lbAQFZTAW84EhHUHYa18pnV2tdhh3gAYZTTDcK4VZJAaTHG9XtVs0b53kcQRYFcZOtHimytlrxm/OsBSd8NaP0fS6CH+3OksEneX0gS59C+tzS6OF7BR7dcdqn7Acmfx2dhc6M4UiVlCyjZT6OdKMWchPASHsU0Mxj7o0on0c515APt+NOHsXHkxheD2Q3XkUkyKDj+ChhhPgQ+qEZxeMeM4ogiL5gcgeyKdvybbBTj/aHE1zAwOAeN27kOUO65OYr9PTzaidw7dBRHcMWLEoF9EwOZKLzt0hTTsOJtc9Uts7kM/ajzAnAefMT7jdPQ0OlCQshvmqk5w3TG19lkXGs+iRZzT8LrXbikuXH180Q+CUoiLKpC/aREYFEcCQtFc5UVu6bVr+d0AgopobDsrx1L28KLX70mjqN3798y0L+W3MDze3LJ9S4vPL9lu3g5hDS4ze3ZA2fM6JGhc5fEBHiilo+aazoncGnNk1UP3433NpOpKk/xJQu47tD7829OdKFcJ54nFeXe1IfDHGU1qjVl3WkcXd1NzBVLVDu8qrPvchhaVpUlaJYoLUF/3wytPRjieltb0zia3E3e5C9J3g+4eeO7qXtP6QizVI3/Ba6Pn07jKLsb15/rhIn/IbJb29PZWefzcOr8u4FKJ5+D3ZreBRgOFYTDZK6+PNQp6AYjBkrlwOUSJ/pD510p9ghdkUc+lkXv3EKbcKC4/C4NCWDODIWkg61i3ulwj+DMvz2iU7aHDeQsmmpgEEqG+YybcAAhZwyTHB2EcEmC9JIPPMkwO806rPgQH+kp1wfTtFRlAnoZN/TYngP6ozYD4dJLhBzNO4cN7lCiRZP2TnN3sAUPOUr0PDw5ugcvyXVtu4wxd047Kt0c7PDkCLOHxND7YR321tScCKzlcyAM/SJ2KXjIMKht+8RFF0ASR1TIVZsl/nV83k6bLSOUCnMjRvEsvlknti5NPEs2xC1SlcUsR5/dyYyF0szxkbCoGXmiqvtI5R2c5GxU0fOIRZUNqUQUc51l/wjpsmbp4pNWOiQ8ebFASEyhnfEpcAWBGvPHDKRxwzkbcmNBx5hKi5zXFV5s6inhqgQtQCZwIws0ONZ9rvSNftM8D+ZTad6+ee1TTAMNQSkHqIFuYkhZVZLUkCbUKV5h5xZJX3KUUDtAf17loC27HpSI5YNqJWiDaciaKT3iUnzzacnokSgDbAAZzx2oNxX4uIT4oIbPIxNs7X/+9e8GXis9zmXE3Ao8TTHSfweGdLF1Ao8et4YSLaCaxwjnA/33xUMAsSOl+VyotFYkc38ZP8K8P2tqu2gVZQ1DDi63Orw81PbWxMHGGu9W4gOEpocCysFWJdILV8LYRpJSeEpctg9vAPmYNHAgNwS1GmVeTpoKXuPlk6Fm01EqlZhPcKuPwQVduP04c+fd7E7qTTEmbSppnEfe29zEfwsbH3LCQ6byLE0+n/wtiu9/Ib79OhCykm8SxZnE/Jj1fjalLJIMhWSFzs/Ab3c1mhf9DZi8ygYvE3EoXvXffut3D0Tf9OWbJ8nz/nb/ovzw7vmrZx2YvOomvXeTD7139uP73PS/KJH8/Cr7JN+ZwfMn1ccPn/THD3398f0by98/2R3ITA5e/iSSyZMvg96meP381ean993x4OVPm5/ePSs/0eQ/bX66uNhMioPnA7mLMOXHD/8Uh1/2Hu9/2/u2f7J3tf8tf9bhB1+/PL9Knu1f7G23P/V1e/9w8I8vX2355kn6+OCD2H4K+/Benmy+TqKmNAiZCwmfw1Z/Jro/42ZPSSi2btr2Y1WAzUjWKRVdK8xzL10+t9UTxkdcSIas03+gFIDWSt++p78Os9sYsbW5+blbM+HJMhP6kt6XqOTjRF2A/HMpbS5v3fKI6lVBUu8OlEg4IOqP5ohttjsiDSSVFnYS7ZxeR1dtXoq26985PZ+exxEyVmEMrFSGMOY2i3aijcWQGFbeULzl9NrpYK1ohssU34CWlI2XYuOyG03jxRE3quZKaGP5SMhR+9ZR5zNKj3E3HMPn6J0FLUrxD8CohWdnEyqOBEpBBhz9fmQgbvKbWTxwL2xViNTdGHyb7cliOC1E0+YCZItn2g0hr0bE6zSEmyiCVAeQohlFUR3kwZ912OZ0Jnl1hCQESLoUWehtbdEV/Icu3VUfP6Vr4Nb29NxxuHEloohr0693gfw5B9U3zTtsUbTgIM15KYtOykqHYYW/EJxEIYeK9tzvw2EJ8hh9cNSsy+7ytRvyRBV1cnIA/8+//k0jwvlMy/yNHVaalWoMGivHqHIqhyuBXi8CE2KGoooUdedFDsZgqFFaGLmiLzGiJIfgSia85AOsvUJHVUirXDJRw9qYDnufAb59YNcj7fI9LiFHC8NypagcCd2eyqqiWVjGxkpfDBElrBkbYM0COnMGIAwBmXGZ4EuEUyFyhLD8Cp3zUgsDjIsCgal8bDgUicCJ0S5qnlhWcMlH5NHEdP1HLpSh4kCrAd6xjMord4vAugcA60ikl5AOe4G3NiIcG1OwuO2pu0CY2F3gvJn05V0DvCyXuLxIwMwyw3K4BE0mw12/qzxnpbLuSowuXXNvcSKruTQYYHAIha2p2efdfFoj5ZMOw+cQPJLQ2UUByIW8cOU3p7WYvYeBERZmoY/xeLxkvr6fH/NS2KwaoOOsZuNG1EjGrjm8/vgejQ3owhwOj7E6MglO0Io1Nwh4w59qPKFTLSgbL8WNrnkuEpAGGmfQ7suj1+ySPe5sRnHDYN8D4Y3X/ed7B8d7OC8eKU7/up3NzibFa5WxBZeNpahitC4gXdTcxvPMutB0XWi6LjRdF5quC03XhabrQtN1oem60HRdaLouNF0XmrJ1oem60PRPon1daLouNF0Xmq4LTdeFputC03Wh6brQdF1oui40XReargtN14Wm60LTdaHputB0XWj6/6vQ1CdcoVe4UeZcyEYSq8u1O10oPz2Powxz8XZOo+trfAt+q/PpFJu/VqAxke88ji65FhjjpjS+OOSrYYbXBUyinei5C9m3T3D52Ek75XcsZC9iup0bsUu7fitsM13w6PD4JIqjgS+RLVSKYzQfY/ksH7s0L89MKpDkVPuUczmqKOEscnNiih2vbDafn3dB+Xn+RyNvjctJA8P5xD1HBv5Fom4ccH3tcv+m0xreda0c4RkboHH7zqfT6X8BDmK/nw==","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"}}');var s=t(74848),r=t(28453),o=t(33617),a=t.n(o),l=t(17543),d=t.n(l),c=t(86013),h=t.n(c),p=t(63723),u=t.n(p),m=(t(18766),t(79329),t(9303));const g={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:"eJztO9122zjOr8LVTWd8ZCd200ybq820mY67zc826W+S06El2GIjkSpJxXFzfLdPso+2T7IHICnLdpxkfr7ZzPl8k1gkSAIgAIIgcB1ZPjLRzml0AkWZcwsmOo+jFEyiRWmFktFOdJIBC93sheZDK+SI7R71GUg+yMGwyoA2zCqWaECgpDJWFeIb9jIbZo6ZAX2JY7lhg7yCUgtpDRsqzUYgQXOaOFVJVQB2jIXNWKkhhaGQkDJjdZXYSoPpsLelksxUSQLGDKvcrSyUZGrIeL1mzGwGhKoGW2lpGGeVFF8rYK2WGnyBxPbTVot9l4IRI8ktpIhcGP5ZpN/HbJyJJGMJl2wASGqKlHqEoYHugGOfkrSmKSERQ4HAfrIO201TgTjyPJ/EjLNWq9J5q8WEYaVWlyKFNKymhkNkKSfWMiEt6CFPgHgFOIsc0TJhcsZlyoY8Ebmw82xkqTBWi0GFK3fO5Jk8EeUOe1vmiqdsoirNjl78NAO3imHbaav1AgbViL3tt1rn32XWlmZnY4OXZUeVIJFbOR+YTqKKjRQBy3RIvAINOCvxC7gR+YTxNGVjkY7AGtoQyRJVTliilE6FdKJR8hEwWRUD0CYmagqlgQnJONPA00nbqnZlgL06PjxANhTcdthRXpm4Xi4VGhKbT9z0yJ5A1SO3O9tbKENCjmJW8AvkkrDsayWSCyTbgKSt9SJDvGq13iO+NXeE8TKeMmYzYdgYBplSFwwusXss8pxZLUYj0K3Wmfzll1/O5PWZZOwsIoizaIedRX6Ksyh2XXZSgut5cfj87f7ewcnnk49He3V/kNQFmP6LGmIo8sUZ3r55XXdLXix2H+zuzxaQyvr+oxy4AabhUsCY9gG32tEauFAPa9gJN7ruwUGgDbaeYgtj1+7fPDbH/ZcHe2+auDgIKLjI50D29nf7r+dgykzJ+WmOfj48mJ+n0o1Z+gcvHVNc/xT/nXt8/Y7s+g066e/vHZ/s7h8h8NTvI0rDcVWWSuP2v3cCvYPbfCZ/hFyNGddA0pOoolCSlVzzAizZxoxb6tbwtRIaUmfceJ4Hzdg5k23WaqEo7LRarC9TkaBqODWflICWzcF2HCiqDIIee1PjQBuKhLbImRPUkDF32l3maEgQVANaKSsuYX7iq5hNcOIXgHLhps2UFt+UtDwnobgEbUXC86YSI4Jk+izXZIJKJaQNrX4F9tErK+oyqai3MohaiswqhKQeA+yS5xUYj9U4Zhli9QZKDYYsrp8XGSlTloEYZSvX4+mXyti5iVllgh0NWPi1wi4Re4HYNuS5ASaGc7ws+AU0VmOqdPa9w36csBSGvMptzATaH6sr6LADZRkvy1wkdDaiOXcHT6WhTbvsxcEjgqqCSBy58wFPhFTg2YDWBjtpCj8mYIdy5g4UJI/sqM24ZEoubHSicqWXRYia5/nIEiUtSNthu5dc5IS8I9YwIZO8SoENcp5cxHSyx0zjWYa7MoE8V+PYyTuB0AlLPCf+MAM5SqGSiL9UfnlhZmdoh52g/an1CTsDq2kRYZpc9TZ8qHBlZEFQMUZ2JSbGxeyLGjArbA4xKmzJ5SRmqXMa4MoO1FXMkgySC/qleSoUG1TWKukIS7UqUzWWnpdDJa0R327QyNDz6znai9lWzLZj9jRm3c2YdXsx627FrLsds+7TmPU2Y9brxay3FbPetkOr99TzmtcMbiLQ7Tku278Od9HuvhaGNBsNpqlt8HjOBnc7rNWqtWnx+J2dsTVIfVqhzcS+rv++wo/HvR/85wQ/t3tP/eeYQLtb/jPDz163eU70CBPLi/IWLLD7D8UgOAtOiLDNn7lnUbBn2IiGKA4ds6PY44Md0yYtj5EWIYUVPDeryQkQD4iiGUpLRG0hUSSuqynyPsiDIaeJD7ksaCZdF5nVRldQeMKit0T9k44/WVYT75Z9MLQ30Pl9pG8j6WiaTtA0raa/tl4PiAmLOP0+TvzQIQeALPNqPniAB8SFeYx+Hw+eIg/wUFrNAOx9QNQ30HEXMDrhXd/mVrv7pN3b7G3NcQBvyg6gKNpp2p5MJn8E99Dn8cujyxM8VOfZYURiqFVxw/WDbgczKO8T0e/gsu+joz6AOiiCUYD5mEq4/ze9bKtSPnlk3FRhaO2cIfzMNZs00KQuxINiIUmmROKRR5jgkg3wgtdBHrSR7+nG/v5Gg5OusV0U7YVG/GwT4xuNRdFJ084C5NLuuMaCpWnMlptvbE9TVhTFimbXfhaRS/UMRd97Yqul3wP8WQowk/P5hW9VDowOKZnT2nRJu1k7Fo6QTIRgjBcVtgCgYVTlXMMV3jbNYoTjD9ScoDgzf51up3SxcyE+YgX77tD75N97oUYS5ifAlrvHLVHWnETDCK5oDhfERWRESqHVGOOtGd7eeHD9ke+zqB19JbwUGCXIwVpqBZt0bkLC7Vrjho27unjBNmDniOGGhZE33LFp+0m8u5t0vPkLxi3nm4d4QCZ+ASXsdOEKF0yLCk4eAEoZzH4rm4E+i87rMe5WDekdY8/voUeZSCHnA8iXu+6tA01avDw1GIMdhZB1JIDw3WwE8gp+tdB5NgviLeiWo7gp1MGIB9UILGa5MCEWMs+v5mgfLKIQngQX/h8ACwPYoBbD3y3mNWL3k3NnBfzm3LEEwjECrAN1YbU7VpjbmCZjcI5CSFFURR1xHNazBpYV/jRv8gtH4stGWKG5u0sr8Ks7VvBPMysWOJNdigyEiMItvp6HeEDGYAGl2/X0t5iJuTPyDzrc7lbAQFZTAW84EhHUHYa18pnV2tdhh3gAYZTTDcK4VZJAaTHG9XtVs0b53kcQRYFcZOtHimytlrxm/OsBSd8NaP0fS6CH+3OksEneX0gS59C+tzS6OF7BR7dcdqn7Acmfx2dhc6M4UiVlCyjZT6OdKMWchPASHsU0Mxj7o0on0c515APt+NOHsXHkxheD2Q3XkUkyKDj+ChhhPgQ+qEZxeMeM4ogiL5gcgeyKdvybbBTj/aHE1zAwOAeN27kOUO65OYr9PTzaidw7dBRHcMWLEoF9EwOZKLzt0hTTsOJtc9Uts7kM/ajzAnAefMT7jdPQ0OlCQshvmqk5w3TG19lkXGs+iRZzT8LrXbikuXH180Q+CUoiLKpC/aREYFEcCQtFc5UVu6bVr+d0AgopobDsrx1L28KLX70mjqN3798y0L+W3MDze3LJ9S4vPL9lu3g5hDS4ze3ZA2fM6JGhc5fEBHiilo+aazoncGnNk1UP3433NpOpKk/xJQu47tD7829OdKFcJ54nFeXe1IfDHGU1qjVl3WkcXd1NzBVLVDu8qrPvchhaVpUlaJYoLUF/3wytPRjieltb0zia3E3e5C9J3g+4eeO7qXtP6QizVI3/Ba6Pn07jKLsb15/rhIn/IbJb29PZWefzcOr8u4FKJ5+D3ZreBRgOFYTDZK6+PNQp6AYjBkrlwOUSJ/pD510p9ghdkUc+lkXv3EKbcKC4/C4NCWDODIWkg61i3ulwj+DMvz2iU7aHDeQsmmpgEEqG+YybcAAhZwyTHB2EcEmC9JIPPMkwO806rPgQH+kp1wfTtFRlAnoZN/TYngP6ozYD4dJLhBzNO4cN7lCiRZP2TnN3sAUPOUr0PDw5ugcvyXVtu4wxd047Kt0c7PDkCLOHxND7YR321tScCKzlcyAM/SJ2KXjIMKht+8RFF0ASR1TIVZsl/nV83k6bLSOUCnMjRvEsvlknti5NPEs2xC1SlcUsR5/dyYyF0szxkbCoGXmiqvtI5R2c5GxU0fOIRZUNqUQUc51l/wjpsmbp4pNWOiQ8ebFASEyhnfEpcAWBGvPHDKRxwzkbcmNBx5hKi5zXFV5s6inhqgQtQCZwIws0ONZ9rvSNftM8D+ZTad6+ee1TTAMNQSkHqIFuYkhZVZLUkCbUKV5h5xZJX3KUUDtAf17loC27HpSI5YNqJWiDaciaKT3iUnzzacnokSgDbAAZzx2oNxX4uIT4oIbPIxNs7X/+9e8GXis9zmXE3Ao8TTHSfweGdLF1Ao8et4YSLaCaxwjnA/33xUMAsSOl+VyotFYkc38ZP8K8P2tqu2gVZQ1DDi63Orw81PbWxMHGGu9W4gOEpocCysFWJdILV8LYRpJSeEpctg9vAPmYNHAgNwS1GmVeTpoKXuPlk6Fm01EqlZhPcKuPwQVduP04c+fd7E7qTTEmbSppnEfe29zEfwsbH3LCQ6byLE0+n/wtiu9/Ib79OhCykm8SxZnE/Jj1fjalLJIMhWSFzs/Ab3c1mhf9DZi8ygYvE3EoXvXffut3D0Tf9OWbJ8nz/nb/ovzw7vmrZx2YvOomvXeTD7139uP73PS/KJH8/Cr7JN+ZwfMn1ccPn/THD3398f0by98/2R3ITA5e/iSSyZMvg96meP381ean993x4OVPm5/ePSs/0eQ/bX66uNhMioPnA7mLMOXHD/8Uh1/2Hu9/2/u2f7J3tf8tf9bhB1+/PL9Knu1f7G23P/V1e/9w8I8vX2355kn6+OCD2H4K+/Benmy+TqKmNAiZCwmfw1Z/Jro/42ZPSSi2btr2Y1WAzUjWKRVdK8xzL10+t9UTxkdcSIas03+gFIDWSt++p78Os9sYsbW5+blbM+HJMhP6kt6XqOTjRF2A/HMpbS5v3fKI6lVBUu8OlEg4IOqP5ohttjsiDSSVFnYS7ZxeR1dtXoq26985PZ+exxEyVmEMrFSGMOY2i3aijcWQGFbeULzl9NrpYK1ohssU34CWlI2XYuOyG03jxRE3quZKaGP5SMhR+9ZR5zNKj3E3HMPn6J0FLUrxD8CohWdnEyqOBEpBBhz9fmQgbvKbWTxwL2xViNTdGHyb7cliOC1E0+YCZItn2g0hr0bE6zSEmyiCVAeQohlFUR3kwZ912OZ0Jnl1hCQESLoUWehtbdEV/Icu3VUfP6Vr4Nb29NxxuHEloohr0693gfw5B9U3zTtsUbTgIM15KYtOykqHYYW/EJxEIYeK9tzvw2EJ8hh9cNSsy+7ytRvyRBV1cnIA/8+//k0jwvlMy/yNHVaalWoMGivHqHIqhyuBXi8CE2KGoooUdedFDsZgqFFaGLmiLzGiJIfgSia85AOsvUJHVUirXDJRw9qYDnufAb59YNcj7fI9LiFHC8NypagcCd2eyqqiWVjGxkpfDBElrBkbYM0COnMGIAwBmXGZ4EuEUyFyhLD8Cp3zUgsDjIsCgal8bDgUicCJ0S5qnlhWcMlH5NHEdP1HLpSh4kCrAd6xjMord4vAugcA60ikl5AOe4G3NiIcG1OwuO2pu0CY2F3gvJn05V0DvCyXuLxIwMwyw3K4BE0mw12/qzxnpbLuSowuXXNvcSKruTQYYHAIha2p2efdfFoj5ZMOw+cQPJLQ2UUByIW8cOU3p7WYvYeBERZmoY/xeLxkvr6fH/NS2KwaoOOsZuNG1EjGrjm8/vgejQ3owhwOj7E6MglO0Io1Nwh4w59qPKFTLSgbL8WNrnkuEpAGGmfQ7suj1+ySPe5sRnHDYN8D4Y3X/ed7B8d7OC8eKU7/up3NzibFa5WxBZeNpahitC4gXdTcxvPMutB0XWi6LjRdF5quC03XhabrQtN1oem60HRdaLouNF0XmrJ1oem60PRPon1daLouNF0Xmq4LTdeFputC03Wh6brQdF1oui40XReargtN14Wm60LTdaHputB0XWj6/6vQ1CdcoVe4UeZcyEYSq8u1O10oPz2Powxz8XZOo+trfAt+q/PpFJu/VqAxke88ji65FhjjpjS+OOSrYYbXBUyinei5C9m3T3D52Ek75XcsZC9iup0bsUu7fitsM13w6PD4JIqjgS+RLVSKYzQfY/ksH7s0L89MKpDkVPuUczmqKOEscnNiih2vbDafn3dB+Xn+RyNvjctJA8P5xD1HBv5Fom4ccH3tcv+m0xreda0c4RkboHH7zqfT6X8BDmK/nw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,b={},y=[];function f(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Draft Template"}),"\n",(0,s.jsx)(a(),{method:"post",path:"/drafttemplate",context:"endpoint"}),"\n",(0,s.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,s.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,s.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.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,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"When document is created this webhook event will trigger"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\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,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.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,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio Button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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 "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded file"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{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},x:{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},y:{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},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},url:{type:"string",example:"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}},title:"inline_response_draft_200"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/0058b4c6.a11ab028.js b/assets/js/0058b4c6.a11ab028.js new file mode 100644 index 000000000..614cc1f48 --- /dev/null +++ b/assets/js/0058b4c6.a11ab028.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[849],{86164:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Intro","href":"/docs/help/intro","docId":"help/intro","unlisted":false},{"type":"category","label":"Create New OpenSign Document","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Sign your-self","href":"/docs/help/New-Document/sign-yourself","docId":"help/New-Document/sign-yourself","unlisted":false},{"type":"link","label":"Request signatures","href":"/docs/help/New-Document/request-signatures","docId":"help/New-Document/request-signatures","unlisted":false},{"type":"link","label":"Navigate between pages of a document","href":"/docs/help/New-Document/navigate-between-pages","docId":"help/New-Document/navigate-between-pages","unlisted":false},{"type":"link","label":"Enforce email OTP verification","href":"/docs/help/New-Document/enforce-email-verification","docId":"help/New-Document/enforce-email-verification","unlisted":false}],"href":"/docs/category/create-new-opensign-document"},{"type":"category","label":"Manage Docs using OpenSign\u2122 Drive","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create Docs & Folders","href":"/docs/help/OpenSign\u2122 Drive/create-document","docId":"help/OpenSign\u2122 Drive/create-document","unlisted":false},{"type":"link","label":"Grid vs List view","href":"/docs/help/OpenSign\u2122 Drive/list-grid-view","docId":"help/OpenSign\u2122 Drive/list-grid-view","unlisted":false},{"type":"link","label":"OpenSign\u2122 Drive Interface Documentation","href":"/docs/help/OpenSign\u2122 Drive/organize-documents","docId":"help/OpenSign\u2122 Drive/organize-documents","unlisted":false},{"type":"link","label":"Rename documents from OpenSign\u2122 Drive","href":"/docs/help/OpenSign\u2122 Drive/rename-document","docId":"help/OpenSign\u2122 Drive/rename-document","unlisted":false}],"href":"/docs/category/manage-docs-using-opensign-drive"},{"type":"category","label":"Reports","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Need your sign","href":"/docs/help/Reports/need-your-sign","docId":"help/Reports/need-your-sign","unlisted":false},{"type":"link","label":"In Progress","href":"/docs/help/Reports/in-progress","docId":"help/Reports/in-progress","unlisted":false},{"type":"link","label":"Completed","href":"/docs/help/Reports/completed","docId":"help/Reports/completed","unlisted":false},{"type":"link","label":"Drafts","href":"/docs/help/Reports/drafts","docId":"help/Reports/drafts","unlisted":false},{"type":"link","label":"Declined","href":"/docs/help/Reports/declined","docId":"help/Reports/declined","unlisted":false},{"type":"link","label":"Expired","href":"/docs/help/Reports/expired","docId":"help/Reports/expired","unlisted":false},{"type":"link","label":"Contactbook","href":"/docs/help/Reports/contactbook","docId":"help/Reports/contactbook","unlisted":false}],"href":"/docs/category/reports"},{"type":"category","label":"Templates","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create Templates","href":"/docs/help/Templates/create-template","docId":"help/Templates/create-template","unlisted":false},{"type":"link","label":"Use template to create documents","href":"/docs/help/Templates/use-template","docId":"help/Templates/use-template","unlisted":false},{"type":"link","label":"Quickly Send the Document for Signature Using Template","href":"/docs/help/Templates/quick-send","docId":"help/Templates/quick-send","unlisted":false},{"type":"link","label":"Setting up an OpenSign template for public signing","href":"/docs/help/Templates/publicTemplate","docId":"help/Templates/publicTemplate","unlisted":false},{"type":"link","label":"Embedding OpenSign templates","href":"/docs/help/Templates/embed-template","docId":"help/Templates/embed-template","unlisted":false}],"href":"/docs/category/templates"},{"type":"category","label":"Settings","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"My Signature","href":"/docs/help/Settings/my-signature","docId":"help/Settings/my-signature","unlisted":false},{"type":"link","label":"Disable DocumentId","href":"/docs/help/Settings/disabledocumentid","docId":"help/Settings/disabledocumentid","unlisted":false},{"type":"link","label":"Manage users","href":"/docs/help/Settings/manage-users","docId":"help/Settings/manage-users","unlisted":false}],"href":"/docs/category/settings"},{"type":"category","label":"FAQs","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Why is there no dropdown list when I sign a document myself?","href":"/docs/help/FAQs/","docId":"help/FAQs/FAQs","unlisted":false},{"type":"link","label":"Why am I getting \'Ensure this field is accurately filled and meets all requirements\'?","href":"/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements","docId":"help/FAQs/Ensure this field is accurately filled and meets all requirements","unlisted":false}],"href":"/docs/category/faqs"}],"selfhostSidebar":[{"type":"link","label":"Self-Hosting OpenSign","href":"/docs/self-host/intro","docId":"self-host/intro","unlisted":false},{"type":"category","label":"Docker","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Self-host OpenSign\u2122 with Docker on Linux/MacOS/Windows","href":"/docs/self-host/docker/run-locally","docId":"self-host/docker/run-locally","unlisted":false},{"type":"link","label":"OpenSign\u2122 Self-Hosted \'Upgrade Deployment\' Guide Using Docker on Linux, macOS, or Windows","href":"/docs/self-host/docker/upgrade-deployment","docId":"self-host/docker/upgrade-deployment","unlisted":false}],"href":"/docs/category/docker"},{"type":"category","label":"Cloud Storage","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"AWS S3","href":"/docs/self-host/cloud-storage/s3","docId":"self-host/cloud-storage/s3","unlisted":false}],"href":"/docs/category/cloud-storage"},{"type":"category","label":"Guides","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","href":"/docs/self-host/guides/env-variables","docId":"self-host/guides/env-variables","unlisted":false},{"type":"link","label":"How to generate self-signed document signing certificate?","href":"/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate","docId":"self-host/guides/how-to-generate-self-signed-document-signing-certificate","unlisted":false},{"type":"link","label":"How to upgrade self-hosted OpenSign to v2.1.0?","href":"/docs/self-host/guides/upgrade-to-v2.1.0","docId":"self-host/guides/upgrade-to-v2.1.0","unlisted":false}],"href":"/docs/category/guides"},{"type":"category","label":"One-click-Install","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Digital Ocean","href":"/docs/self-host/One-click-Install/DigitalOcean","docId":"self-host/One-click-Install/DigitalOcean","unlisted":false}]}],"contributeSidebar":[{"type":"link","label":"Code of conduct","href":"/docs/contribute/CODE_OF_CONDUCT","docId":"contribute/CODE_OF_CONDUCT","unlisted":false},{"type":"link","label":"Contributing to OpenSign","href":"/docs/contribute/intro","docId":"contribute/intro","unlisted":false},{"type":"link","label":"Installation instructions","href":"/docs/contribute/INSTALLATION","docId":"contribute/INSTALLATION","unlisted":false},{"type":"link","label":"Community at OpenSign\u2122","href":"/docs/contribute/COMMUNITY","docId":"contribute/COMMUNITY","unlisted":false},{"type":"link","label":"OpenSign\u2122 Reporting Guidelines","href":"/docs/contribute/REPORTING_GUIDELINES","docId":"contribute/REPORTING_GUIDELINES","unlisted":false}],"apiSidebar":[{"type":"link","label":"Introduction","href":"/docs/API-docs/opensign-api-v-1","docId":"API-docs/opensign-api-v-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","label":"Get your account details","href":"/docs/API-docs/get-user","className":"api-method get","docId":"API-docs/get-user","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","label":"Create Contact","href":"/docs/API-docs/createcontact","className":"api-method post","docId":"API-docs/createcontact","unlisted":false},{"type":"link","label":"Get Contact","href":"/docs/API-docs/getcontact","className":"api-method get","docId":"API-docs/getcontact","unlisted":false},{"type":"link","label":"Delete Contact","href":"/docs/API-docs/deletecontact","className":"api-method delete","docId":"API-docs/deletecontact","unlisted":false},{"type":"link","label":"Get Contact list","href":"/docs/API-docs/contactlist","className":"api-method get","docId":"API-docs/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","label":"Self Sign","href":"/docs/API-docs/selfsign","className":"api-method post","docId":"API-docs/selfsign","unlisted":false},{"type":"link","label":"Draft Document","href":"/docs/API-docs/draftdocument","className":"api-method post","docId":"API-docs/draftdocument","unlisted":false},{"type":"link","label":"Create Document","href":"/docs/API-docs/createdocument","className":"api-method post","docId":"API-docs/createdocument","unlisted":false},{"type":"link","label":"Create Document from Template","href":"/docs/API-docs/createdocumentwithtemplateid","className":"api-method post","docId":"API-docs/createdocumentwithtemplateid","unlisted":false},{"type":"link","label":"Get Document","href":"/docs/API-docs/getdocument","className":"api-method get","docId":"API-docs/getdocument","unlisted":false},{"type":"link","label":"Update Document","href":"/docs/API-docs/update-document","className":"api-method put","docId":"API-docs/update-document","unlisted":false},{"type":"link","label":"Revoke Document","href":"/docs/API-docs/revokedocument","className":"api-method post","docId":"API-docs/revokedocument","unlisted":false},{"type":"link","label":"Delete Document","href":"/docs/API-docs/deletedocument","className":"api-method delete","docId":"API-docs/deletedocument","unlisted":false},{"type":"link","label":"Get Document list from status","href":"/docs/API-docs/getdocumentlist","className":"api-method get","docId":"API-docs/getdocumentlist","unlisted":false},{"type":"link","label":"Resend request mail","href":"/docs/API-docs/resendrequestmail","className":"api-method post","docId":"API-docs/resendrequestmail","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","label":"Draft Template","href":"/docs/API-docs/drafttemplate","className":"api-method post","docId":"API-docs/drafttemplate","unlisted":false},{"type":"link","label":"Create Template","href":"/docs/API-docs/createtemplate","className":"api-method post","docId":"API-docs/createtemplate","unlisted":false},{"type":"link","label":"Get Template","href":"/docs/API-docs/get-template","className":"api-method get","docId":"API-docs/get-template","unlisted":false},{"type":"link","label":"Update Template","href":"/docs/API-docs/update-template","className":"api-method put","docId":"API-docs/update-template","unlisted":false},{"type":"link","label":"Delete Template","href":"/docs/API-docs/delete-template","className":"api-method delete","docId":"API-docs/delete-template","unlisted":false},{"type":"link","label":"Get Template list","href":"/docs/API-docs/gettemplatelist","className":"api-method get","docId":"API-docs/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","label":"Get Webhook","href":"/docs/API-docs/get-webhook","className":"api-method get","docId":"API-docs/get-webhook","unlisted":false},{"type":"link","label":"Save or Update Webhook","href":"/docs/API-docs/save-update-webhook","className":"api-method post","docId":"API-docs/save-update-webhook","unlisted":false},{"type":"link","label":"Delete Webhook","href":"/docs/API-docs/delete-webhook","className":"api-method delete","docId":"API-docs/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Folder","items":[{"type":"link","label":"Create Folder","href":"/docs/API-docs/createfolder","className":"api-method post","docId":"API-docs/createfolder","unlisted":false},{"type":"link","label":"Get Folder","href":"/docs/API-docs/getfolder","className":"api-method get","docId":"API-docs/getfolder","unlisted":false},{"type":"link","label":"Update Folder","href":"/docs/API-docs/updatefolder","className":"api-method put","docId":"API-docs/updatefolder","unlisted":false},{"type":"link","label":"Delete Folder","href":"/docs/API-docs/deletefolder","className":"api-method delete","docId":"API-docs/deletefolder","unlisted":false},{"type":"link","label":"Get folder list","href":"/docs/API-docs/folderlist","className":"api-method get","docId":"API-docs/folderlist","unlisted":false}],"collapsed":true,"collapsible":true}]},"docs":{"API-docs/contactlist":{"id":"API-docs/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar":"apiSidebar"},"API-docs/createcontact":{"id":"API-docs/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar":"apiSidebar"},"API-docs/createdocument":{"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.","sidebar":"apiSidebar"},"API-docs/createdocumentwithtemplateid":{"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.","sidebar":"apiSidebar"},"API-docs/createfolder":{"id":"API-docs/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","sidebar":"apiSidebar"},"API-docs/createtemplate":{"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.","sidebar":"apiSidebar"},"API-docs/delete-template":{"id":"API-docs/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar":"apiSidebar"},"API-docs/delete-webhook":{"id":"API-docs/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar":"apiSidebar"},"API-docs/deletecontact":{"id":"API-docs/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar":"apiSidebar"},"API-docs/deletedocument":{"id":"API-docs/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar":"apiSidebar"},"API-docs/deletefolder":{"id":"API-docs/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","sidebar":"apiSidebar"},"API-docs/draftdocument":{"id":"API-docs/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar":"apiSidebar"},"API-docs/drafttemplate":{"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.","sidebar":"apiSidebar"},"API-docs/folderlist":{"id":"API-docs/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","sidebar":"apiSidebar"},"API-docs/get-template":{"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.","sidebar":"apiSidebar"},"API-docs/get-user":{"id":"API-docs/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar":"apiSidebar"},"API-docs/get-webhook":{"id":"API-docs/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar":"apiSidebar"},"API-docs/getcontact":{"id":"API-docs/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar":"apiSidebar"},"API-docs/getdocument":{"id":"API-docs/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar":"apiSidebar"},"API-docs/getdocumentlist":{"id":"API-docs/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/getfolder":{"id":"API-docs/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","sidebar":"apiSidebar"},"API-docs/gettemplatelist":{"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.","sidebar":"apiSidebar"},"API-docs/intro":{"id":"API-docs/intro","title":"Overview","description":"OpenSign\u2122 API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures."},"API-docs/opensign-api-v-1":{"id":"API-docs/opensign-api-v-1","title":"OpenSign API v1","description":"Welcome to the OpenSign\u2122 API documentation! Our powerful and flexible API allows you to seamlessly integrate digital signing capabilities into your applications. Whether you\'re a developer looking to automate document workflows, a business seeking to enhance security, or an enterprise aiming for efficient contract management, our API provides robust solutions to meet your needs. Dive into our detailed guides, code examples, and best practices to start leveraging the full potential of OpenSign\u2122 and transform your digital document processes today.","sidebar":"apiSidebar"},"API-docs/resendrequestmail":{"id":"API-docs/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","sidebar":"apiSidebar"},"API-docs/revokedocument":{"id":"API-docs/revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","sidebar":"apiSidebar"},"API-docs/save-update-webhook":{"id":"API-docs/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar":"apiSidebar"},"API-docs/selfsign":{"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.","sidebar":"apiSidebar"},"API-docs/update-document":{"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.","sidebar":"apiSidebar"},"API-docs/update-template":{"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.","sidebar":"apiSidebar"},"API-docs/updatefolder":{"id":"API-docs/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","sidebar":"apiSidebar"},"contribute/CODE_OF_CONDUCT":{"id":"contribute/CODE_OF_CONDUCT","title":"Code of conduct","description":"1. Introduction","sidebar":"contributeSidebar"},"contribute/COMMUNITY":{"id":"contribute/COMMUNITY","title":"Community at OpenSign\u2122","description":"Welcome to the OpenSign\u2122 Community page! OpenSign\u2122 is dedicated to fostering a vibrant and engaging community where members can connect, share ideas and collaborate on the OpenSign\u2122 project. This page provides links to our active social media platforms and community channels, offering various ways for you to join and participate in the OpenSign\u2122 community. Whether you\'re looking for support, eager to contribute or just want to stay updated, you\'ll find a platform that suits your preference. Connect with us on Discord for real-time discussions, follow us on Twitter for the latest updates, engage with our professional network on LinkedIn or join our Facebook group for a broader community experience. Join us in our mission to develop OpenSign\u2122 as the premier open-source alternative to DocuSign.","sidebar":"contributeSidebar"},"contribute/INSTALLATION":{"id":"contribute/INSTALLATION","title":"Installation instructions","description":"You can use our app as a cloud version from OpenSignLabs","sidebar":"contributeSidebar"},"contribute/intro":{"id":"contribute/intro","title":"Contributing to OpenSign","description":"Hello there! Thank you for considering contributing to OpenSign, the open-source alternative to DocuSign. OpenSign is not just a project, but a community endeavor that aims to create a robust, user-friendly, and secure electronic signature solution. Your contributions, irrespective of their size, are valuable in making this vision a reality.","sidebar":"contributeSidebar"},"contribute/REPORTING_GUIDELINES":{"id":"contribute/REPORTING_GUIDELINES","title":"OpenSign\u2122 Reporting Guidelines","description":"This document provides guidelines for reporting issues, suggesting enhancements, and submitting pull requests to the OpenSign\u2122 GitHub repository. Adhering to these guidelines helps maintain the project\'s quality and efficiency.","sidebar":"contributeSidebar"},"help/FAQs/Ensure this field is accurately filled and meets all requirements":{"id":"help/FAQs/Ensure this field is accurately filled and meets all requirements","title":"Why am I getting \'Ensure this field is accurately filled and meets all requirements\'?","description":"This happens when you leave a field blank or when you don\u2019t enter correct values in the field, for example not entering email address in correct format.","sidebar":"tutorialSidebar"},"help/FAQs/FAQs":{"id":"help/FAQs/FAQs","title":"Why is there no dropdown list when I sign a document myself?","description":"The dropdown list field is available only when you request a signature from others or when you create a template. This is because dropdown lists function as temporary widgets, allowing the user to select one of multiple values. Once a signer selects a value from the dropdown, it is embedded into the document as text. When you sign a document yourself, OpenSign digitally signs it immediately upon clicking the finish button. Therefore, you can use the text widget to add the necessary text to the document.","sidebar":"tutorialSidebar"},"help/intro":{"id":"help/intro","title":"Intro","description":"\ud83c\udf1fGet ready for an electrifying journey at OpenSign\u2122, the most incredibly documented open source document signing solution! \ud83d\ude80 This is your go-to spot for diving deep into everything OpenSign\u2122 has to offer. Whether you\u2019re just starting out or you\u2019re a seasoned pro eager to uncover even more cool features, we\u2019ve got you covered with the most awesome, top-notch guides and resources around. Get ready to make the most out of OpenSign\u2122 \ud83c\udf89\ud83d\udcda\ud83d\udd0d Your adventure in excellence starts here! \ud83c\udf08\u2728\ud83c\udf1f","sidebar":"tutorialSidebar"},"help/New-Document/enforce-email-verification":{"id":"help/New-Document/enforce-email-verification","title":"Enforce email OTP verification","description":"The \\"Enable OTP Verification\\" feature in OpenSign is designed to add an extra layer of security to the document-signing process by verifying the signer\u2019s email address. Here\u2019s an in-depth look at how it works, when to use it, and its impact on the signing process.","sidebar":"tutorialSidebar"},"help/New-Document/navigate-between-pages":{"id":"help/New-Document/navigate-between-pages","title":"Navigate between pages of a document","description":"To navigate between pages of a document that you have uploaded either click on the \'prev\' & \'next\' buttons at the top or click on any of the page previews loaded on the left side -","sidebar":"tutorialSidebar"},"help/New-Document/request-signatures":{"id":"help/New-Document/request-signatures","title":"Request signatures","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/New-Document/sign-yourself":{"id":"help/New-Document/sign-yourself","title":"Sign your-self","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/create-document":{"id":"help/OpenSign\u2122 Drive/create-document","title":"Create Docs & Folders","description":"OpenSign Drive offers a streamlined way to manage, sign, and request signatures on your important documents. Whether you\'re drafting an offer letter or storing signed agreements, organizing your documents effectively is crucial. Here\u2019s a step-by-step guide on how to create documents and folders in OpenSign Drive.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/list-grid-view":{"id":"help/OpenSign\u2122 Drive/list-grid-view","title":"Grid vs List view","description":"- Navigate to OpenSign drive using the main menu or clicking this link.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/organize-documents":{"id":"help/OpenSign\u2122 Drive/organize-documents","title":"OpenSign\u2122 Drive Interface Documentation","description":"Overview","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/rename-document":{"id":"help/OpenSign\u2122 Drive/rename-document","title":"Rename documents from OpenSign\u2122 Drive","description":"The OpenSign\u2122 Drive interface allows users to rename their documents efficiently.","sidebar":"tutorialSidebar"},"help/Reports/completed":{"id":"help/Reports/completed","title":"Completed","description":"---","sidebar":"tutorialSidebar"},"help/Reports/contactbook":{"id":"help/Reports/contactbook","title":"Contactbook","description":"The Contactbook report in OpenSign enables you to add and manage contacts.","sidebar":"tutorialSidebar"},"help/Reports/declined":{"id":"help/Reports/declined","title":"Declined","description":"The \\"Declined documents\\" report within OpenSign serves as a vital tool for managing and reviewing all declined documents that have been processed through the platform. This guide will walk you through the key features and functionalities of the \\"Declined documents\\" report, enabling you to efficiently navigate and manage your signed documents.","sidebar":"tutorialSidebar"},"help/Reports/drafts":{"id":"help/Reports/drafts","title":"Drafts","description":"The Draft documents section in OpenSign helps you manage all your in-progress documents easily. This feature allows you to save, review, and edit documents before sending them for signature. Here\'s a detailed overview of how to navigate and use the Draft Documents report effectively.","sidebar":"tutorialSidebar"},"help/Reports/expired":{"id":"help/Reports/expired","title":"Expired","description":"The Expired documents report in OpenSign allows you to manage and review documents that have reached their expiration date without being signed. This feature is essential for maintaining an organized record of inactive documents that may require follow-up or archival.","sidebar":"tutorialSidebar"},"help/Reports/in-progress":{"id":"help/Reports/in-progress","title":"In Progress","description":"The In-Progress documents report in OpenSign helps you monitor and manage documents that are currently in the signing process. This report enables you to monitor the status of your documents, manually share the document URL, track document progress, resend reminders, revoke access, or delete documents that are no longer required. Here\u2019s a detailed guide on how to use the In-Progress documents report effectively.","sidebar":"tutorialSidebar"},"help/Reports/need-your-sign":{"id":"help/Reports/need-your-sign","title":"Need your sign","description":"The \\"Need your sign\\" feature in OpenSign is designed to simplify the process of managing documents that require your signature. This guide will walk you through the various elements of the \\"Need your sign\\" report, helping you to efficiently navigate and complete your pending signing tasks.","sidebar":"tutorialSidebar"},"help/Settings/disabledocumentid":{"id":"help/Settings/disabledocumentid","title":"Disable DocumentId","description":"Whenever a document is signed by all parties, OpenSign\u2122 adds a DocumentId at the top left corner of the digitally signed document.","sidebar":"tutorialSidebar"},"help/Settings/manage-users":{"id":"help/Settings/manage-users","title":"Manage users","description":"The User Management feature allows administrators to add, edit, and manage users within the OpenSign application. This feature is available on self-hosted, teams, and enterprise plans. Only users with \\"Admin\\" & \\"OrgAdmin\\" role are allowed to manage users.","sidebar":"tutorialSidebar"},"help/Settings/my-signature":{"id":"help/Settings/my-signature","title":"My Signature","description":"This guide provides instructions on how to save your signature and initials using the OpenSign application. Once saved, you can use them with one click when signing documents. To create your signature, start by clicking the \\"My Signature\\" link under \\"settings\\" menu.","sidebar":"tutorialSidebar"},"help/Templates/create-template":{"id":"help/Templates/create-template","title":"Create Templates","description":"Getting Started","sidebar":"tutorialSidebar"},"help/Templates/embed-template":{"id":"help/Templates/embed-template","title":"Embedding OpenSign templates","description":"OpenSign Template Embedding allows users to seamlessly integrate public document templates into their websites or applications. By embedding templates, you can provide a direct and interactive signing experience for your users without requiring them to leave your platform. This feature supports various technologies like React, Next.js, HTML, JavaScript, and Angular, making it easy to add signing capabilities to different web projects.","sidebar":"tutorialSidebar"},"help/Templates/publicTemplate":{"id":"help/Templates/publicTemplate","title":"Setting up an OpenSign template for public signing","description":"The OpenSign Public profile feature offers the ultimate public document signing solution without any need for integrations. With this feature, users can share document templates publicly, allowing anyone to access and sign the documents directly through the shared templates. This streamlines the signing process by providing a seamless, accessible way for public signers to complete documents without additional steps or integrations.","sidebar":"tutorialSidebar"},"help/Templates/quick-send":{"id":"help/Templates/quick-send","title":"Quickly Send the Document for Signature Using Template","description":"Step 1: Begin New Template Creation","sidebar":"tutorialSidebar"},"help/Templates/use-template":{"id":"help/Templates/use-template","title":"Use template to create documents","description":"Step 1: Begin New Template Creation","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Tutorial Intro","description":"Let\'s discover Docusaurus in less than 5 minutes."},"self-host/cloud-storage/s3":{"id":"self-host/cloud-storage/s3","title":"AWS S3","description":"You can create an AWS S3 bucket to store your uploaded documents using OpenSign\u2122","sidebar":"selfhostSidebar"},"self-host/docker/run-locally":{"id":"self-host/docker/run-locally","title":"Self-host OpenSign\u2122 with Docker on Linux/MacOS/Windows","description":"Steps to run OpenSign\u2122 with docker on Linux/MacOS/Windows:","sidebar":"selfhostSidebar"},"self-host/docker/upgrade-deployment":{"id":"self-host/docker/upgrade-deployment","title":"OpenSign\u2122 Self-Hosted \'Upgrade Deployment\' Guide Using Docker on Linux, macOS, or Windows","description":"This guide provides step-by-step instructions to upgrade the deployment of OpenSign using Docker.","sidebar":"selfhostSidebar"},"self-host/guides/env-variables":{"id":"self-host/guides/env-variables","title":"ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","description":"Information About ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","sidebar":"selfhostSidebar"},"self-host/guides/how-to-generate-self-signed-document-signing-certificate":{"id":"self-host/guides/how-to-generate-self-signed-document-signing-certificate","title":"How to generate self-signed document signing certificate?","description":"","sidebar":"selfhostSidebar"},"self-host/guides/upgrade-to-v2.1.0":{"id":"self-host/guides/upgrade-to-v2.1.0","title":"How to upgrade self-hosted OpenSign to v2.1.0?","description":"For self-hosted deployments, version 2.1.0 introduces changes to the signup process:","sidebar":"selfhostSidebar"},"self-host/intro":{"id":"self-host/intro","title":"Self-Hosting OpenSign","description":"This section of the OpenSign\u2122 documentation is dedicated to guiding you through the process of self-hosting the OpenSign platform. Self-hosting OpenSign allows for greater control and customization, ensuring that it aligns perfectly with your specific needs and infrastructure requirements. We cover everything from initial setup, configuration options, to maintenance best practices. Whether you are an individual enthusiast or a professional looking to deploy OpenSign in a corporate environment, this guide will provide you with the necessary steps and tips to successfully self-host OpenSign\u2122 - the best open source document signing infrastructure.","sidebar":"selfhostSidebar"},"self-host/One-click-Install/DigitalOcean":{"id":"self-host/One-click-Install/DigitalOcean","title":"Digital Ocean","description":"OpenSign application consistes of 3 components -","sidebar":"selfhostSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/0058b4c6.accd8a6d.js b/assets/js/0058b4c6.accd8a6d.js deleted file mode 100644 index f13732cb1..000000000 --- a/assets/js/0058b4c6.accd8a6d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[849],{86164:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Intro","href":"/docs/help/intro","docId":"help/intro","unlisted":false},{"type":"category","label":"Create New OpenSign Document","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Sign your-self","href":"/docs/help/New-Document/sign-yourself","docId":"help/New-Document/sign-yourself","unlisted":false},{"type":"link","label":"Request signatures","href":"/docs/help/New-Document/request-signatures","docId":"help/New-Document/request-signatures","unlisted":false},{"type":"link","label":"Navigate between pages of a document","href":"/docs/help/New-Document/navigate-between-pages","docId":"help/New-Document/navigate-between-pages","unlisted":false},{"type":"link","label":"Enforce email OTP verification","href":"/docs/help/New-Document/enforce-email-verification","docId":"help/New-Document/enforce-email-verification","unlisted":false}],"href":"/docs/category/create-new-opensign-document"},{"type":"category","label":"Manage Docs using OpenSign\u2122 Drive","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create Docs & Folders","href":"/docs/help/OpenSign\u2122 Drive/create-document","docId":"help/OpenSign\u2122 Drive/create-document","unlisted":false},{"type":"link","label":"Grid vs List view","href":"/docs/help/OpenSign\u2122 Drive/list-grid-view","docId":"help/OpenSign\u2122 Drive/list-grid-view","unlisted":false},{"type":"link","label":"OpenSign\u2122 Drive Interface Documentation","href":"/docs/help/OpenSign\u2122 Drive/organize-documents","docId":"help/OpenSign\u2122 Drive/organize-documents","unlisted":false},{"type":"link","label":"Rename documents from OpenSign\u2122 Drive","href":"/docs/help/OpenSign\u2122 Drive/rename-document","docId":"help/OpenSign\u2122 Drive/rename-document","unlisted":false}],"href":"/docs/category/manage-docs-using-opensign-drive"},{"type":"category","label":"Reports","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Need your sign","href":"/docs/help/Reports/need-your-sign","docId":"help/Reports/need-your-sign","unlisted":false},{"type":"link","label":"In Progress","href":"/docs/help/Reports/in-progress","docId":"help/Reports/in-progress","unlisted":false},{"type":"link","label":"Completed","href":"/docs/help/Reports/completed","docId":"help/Reports/completed","unlisted":false},{"type":"link","label":"Drafts","href":"/docs/help/Reports/drafts","docId":"help/Reports/drafts","unlisted":false},{"type":"link","label":"Declined","href":"/docs/help/Reports/declined","docId":"help/Reports/declined","unlisted":false},{"type":"link","label":"Expired","href":"/docs/help/Reports/expired","docId":"help/Reports/expired","unlisted":false},{"type":"link","label":"Contactbook","href":"/docs/help/Reports/contactbook","docId":"help/Reports/contactbook","unlisted":false}],"href":"/docs/category/reports"},{"type":"category","label":"Templates","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create Templates","href":"/docs/help/Templates/create-template","docId":"help/Templates/create-template","unlisted":false},{"type":"link","label":"Use template to create documents","href":"/docs/help/Templates/use-template","docId":"help/Templates/use-template","unlisted":false},{"type":"link","label":"Quickly Send the Document for Signature Using Template","href":"/docs/help/Templates/quick-send","docId":"help/Templates/quick-send","unlisted":false},{"type":"link","label":"Setting up an OpenSign template for public signing","href":"/docs/help/Templates/publicTemplate","docId":"help/Templates/publicTemplate","unlisted":false},{"type":"link","label":"Embedding OpenSign templates","href":"/docs/help/Templates/embed-template","docId":"help/Templates/embed-template","unlisted":false}],"href":"/docs/category/templates"},{"type":"category","label":"Settings","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"My Signature","href":"/docs/help/Settings/my-signature","docId":"help/Settings/my-signature","unlisted":false},{"type":"link","label":"Disable DocumentId","href":"/docs/help/Settings/disabledocumentid","docId":"help/Settings/disabledocumentid","unlisted":false},{"type":"link","label":"Manage users","href":"/docs/help/Settings/manage-users","docId":"help/Settings/manage-users","unlisted":false}],"href":"/docs/category/settings"},{"type":"category","label":"FAQs","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Why is there no dropdown list when I sign a document myself?","href":"/docs/help/FAQs/","docId":"help/FAQs/FAQs","unlisted":false},{"type":"link","label":"Why am I getting \'Ensure this field is accurately filled and meets all requirements\'?","href":"/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements","docId":"help/FAQs/Ensure this field is accurately filled and meets all requirements","unlisted":false}],"href":"/docs/category/faqs"}],"selfhostSidebar":[{"type":"link","label":"Self-Hosting OpenSign","href":"/docs/self-host/intro","docId":"self-host/intro","unlisted":false},{"type":"category","label":"Docker","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Self-host OpenSign\u2122 with Docker on Linux/MacOS/Windows","href":"/docs/self-host/docker/run-locally","docId":"self-host/docker/run-locally","unlisted":false},{"type":"link","label":"OpenSign\u2122 Self-Hosted \'Upgrade Deployment\' Guide Using Docker on Linux, macOS, or Windows","href":"/docs/self-host/docker/upgrade-deployment","docId":"self-host/docker/upgrade-deployment","unlisted":false}],"href":"/docs/category/docker"},{"type":"category","label":"Cloud Storage","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"AWS S3","href":"/docs/self-host/cloud-storage/s3","docId":"self-host/cloud-storage/s3","unlisted":false}],"href":"/docs/category/cloud-storage"},{"type":"category","label":"Guides","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","href":"/docs/self-host/guides/env-variables","docId":"self-host/guides/env-variables","unlisted":false},{"type":"link","label":"How to generate self-signed document signing certificate?","href":"/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate","docId":"self-host/guides/how-to-generate-self-signed-document-signing-certificate","unlisted":false},{"type":"link","label":"How to upgrade self-hosted OpenSign to v2.1.0?","href":"/docs/self-host/guides/upgrade-to-v2.1.0","docId":"self-host/guides/upgrade-to-v2.1.0","unlisted":false}],"href":"/docs/category/guides"},{"type":"category","label":"One-click-Install","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Digital Ocean","href":"/docs/self-host/One-click-Install/DigitalOcean","docId":"self-host/One-click-Install/DigitalOcean","unlisted":false}]}],"contributeSidebar":[{"type":"link","label":"Code of conduct","href":"/docs/contribute/CODE_OF_CONDUCT","docId":"contribute/CODE_OF_CONDUCT","unlisted":false},{"type":"link","label":"Contributing to OpenSign","href":"/docs/contribute/intro","docId":"contribute/intro","unlisted":false},{"type":"link","label":"Installation instructions","href":"/docs/contribute/INSTALLATION","docId":"contribute/INSTALLATION","unlisted":false},{"type":"link","label":"Community at OpenSign\u2122","href":"/docs/contribute/COMMUNITY","docId":"contribute/COMMUNITY","unlisted":false},{"type":"link","label":"OpenSign\u2122 Reporting Guidelines","href":"/docs/contribute/REPORTING_GUIDELINES","docId":"contribute/REPORTING_GUIDELINES","unlisted":false}],"apiSidebar":[{"type":"link","label":"Introduction","href":"/docs/API-docs/opensign-api-v-1","docId":"API-docs/opensign-api-v-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","label":"Get your account details","href":"/docs/API-docs/get-user","className":"api-method get","docId":"API-docs/get-user","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","label":"Create Contact","href":"/docs/API-docs/createcontact","className":"api-method post","docId":"API-docs/createcontact","unlisted":false},{"type":"link","label":"Get Contact","href":"/docs/API-docs/getcontact","className":"api-method get","docId":"API-docs/getcontact","unlisted":false},{"type":"link","label":"Delete Contact","href":"/docs/API-docs/deletecontact","className":"api-method delete","docId":"API-docs/deletecontact","unlisted":false},{"type":"link","label":"Get Contact list","href":"/docs/API-docs/contactlist","className":"api-method get","docId":"API-docs/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","label":"Self Sign","href":"/docs/API-docs/selfsign","className":"api-method post","docId":"API-docs/selfsign","unlisted":false},{"type":"link","label":"Draft Document","href":"/docs/API-docs/draftdocument","className":"api-method post","docId":"API-docs/draftdocument","unlisted":false},{"type":"link","label":"Create Document","href":"/docs/API-docs/createdocument","className":"api-method post","docId":"API-docs/createdocument","unlisted":false},{"type":"link","label":"Create Document from Template","href":"/docs/API-docs/createdocumentwithtemplateid","className":"api-method post","docId":"API-docs/createdocumentwithtemplateid","unlisted":false},{"type":"link","label":"Get Document","href":"/docs/API-docs/getdocument","className":"api-method get","docId":"API-docs/getdocument","unlisted":false},{"type":"link","label":"Update Document","href":"/docs/API-docs/update-document","className":"api-method put","docId":"API-docs/update-document","unlisted":false},{"type":"link","label":"Delete Document","href":"/docs/API-docs/deletedocument","className":"api-method delete","docId":"API-docs/deletedocument","unlisted":false},{"type":"link","label":"Get Document list from status","href":"/docs/API-docs/getdocumentlist","className":"api-method get","docId":"API-docs/getdocumentlist","unlisted":false},{"type":"link","label":"Resend request mail","href":"/docs/API-docs/resendrequestmail","className":"api-method post","docId":"API-docs/resendrequestmail","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","label":"Draft Template","href":"/docs/API-docs/drafttemplate","className":"api-method post","docId":"API-docs/drafttemplate","unlisted":false},{"type":"link","label":"Create Template","href":"/docs/API-docs/createtemplate","className":"api-method post","docId":"API-docs/createtemplate","unlisted":false},{"type":"link","label":"Get Template","href":"/docs/API-docs/get-template","className":"api-method get","docId":"API-docs/get-template","unlisted":false},{"type":"link","label":"Update Template","href":"/docs/API-docs/update-template","className":"api-method put","docId":"API-docs/update-template","unlisted":false},{"type":"link","label":"Delete Template","href":"/docs/API-docs/delete-template","className":"api-method delete","docId":"API-docs/delete-template","unlisted":false},{"type":"link","label":"Get Template list","href":"/docs/API-docs/gettemplatelist","className":"api-method get","docId":"API-docs/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","label":"Get Webhook","href":"/docs/API-docs/get-webhook","className":"api-method get","docId":"API-docs/get-webhook","unlisted":false},{"type":"link","label":"Save or Update Webhook","href":"/docs/API-docs/save-update-webhook","className":"api-method post","docId":"API-docs/save-update-webhook","unlisted":false},{"type":"link","label":"Delete Webhook","href":"/docs/API-docs/delete-webhook","className":"api-method delete","docId":"API-docs/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Folder","items":[{"type":"link","label":"Create Folder","href":"/docs/API-docs/createfolder","className":"api-method post","docId":"API-docs/createfolder","unlisted":false},{"type":"link","label":"Get Folder","href":"/docs/API-docs/getfolder","className":"api-method get","docId":"API-docs/getfolder","unlisted":false},{"type":"link","label":"Update Folder","href":"/docs/API-docs/updatefolder","className":"api-method put","docId":"API-docs/updatefolder","unlisted":false},{"type":"link","label":"Delete Folder","href":"/docs/API-docs/deletefolder","className":"api-method delete","docId":"API-docs/deletefolder","unlisted":false},{"type":"link","label":"Get folder list","href":"/docs/API-docs/folderlist","className":"api-method get","docId":"API-docs/folderlist","unlisted":false}],"collapsed":true,"collapsible":true}]},"docs":{"API-docs/contactlist":{"id":"API-docs/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar":"apiSidebar"},"API-docs/createcontact":{"id":"API-docs/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar":"apiSidebar"},"API-docs/createdocument":{"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.","sidebar":"apiSidebar"},"API-docs/createdocumentwithtemplateid":{"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.","sidebar":"apiSidebar"},"API-docs/createfolder":{"id":"API-docs/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","sidebar":"apiSidebar"},"API-docs/createtemplate":{"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.","sidebar":"apiSidebar"},"API-docs/delete-template":{"id":"API-docs/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar":"apiSidebar"},"API-docs/delete-webhook":{"id":"API-docs/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar":"apiSidebar"},"API-docs/deletecontact":{"id":"API-docs/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar":"apiSidebar"},"API-docs/deletedocument":{"id":"API-docs/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar":"apiSidebar"},"API-docs/deletefolder":{"id":"API-docs/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","sidebar":"apiSidebar"},"API-docs/draftdocument":{"id":"API-docs/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar":"apiSidebar"},"API-docs/drafttemplate":{"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.","sidebar":"apiSidebar"},"API-docs/folderlist":{"id":"API-docs/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","sidebar":"apiSidebar"},"API-docs/get-template":{"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.","sidebar":"apiSidebar"},"API-docs/get-user":{"id":"API-docs/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar":"apiSidebar"},"API-docs/get-webhook":{"id":"API-docs/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar":"apiSidebar"},"API-docs/getcontact":{"id":"API-docs/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar":"apiSidebar"},"API-docs/getdocument":{"id":"API-docs/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar":"apiSidebar"},"API-docs/getdocumentlist":{"id":"API-docs/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/getfolder":{"id":"API-docs/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","sidebar":"apiSidebar"},"API-docs/gettemplatelist":{"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.","sidebar":"apiSidebar"},"API-docs/intro":{"id":"API-docs/intro","title":"Overview","description":"OpenSign\u2122 API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures."},"API-docs/opensign-api-v-1":{"id":"API-docs/opensign-api-v-1","title":"OpenSign API v1","description":"Welcome to the OpenSign\u2122 API documentation! Our powerful and flexible API allows you to seamlessly integrate digital signing capabilities into your applications. Whether you\'re a developer looking to automate document workflows, a business seeking to enhance security, or an enterprise aiming for efficient contract management, our API provides robust solutions to meet your needs. Dive into our detailed guides, code examples, and best practices to start leveraging the full potential of OpenSign\u2122 and transform your digital document processes today.","sidebar":"apiSidebar"},"API-docs/resendrequestmail":{"id":"API-docs/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","sidebar":"apiSidebar"},"API-docs/save-update-webhook":{"id":"API-docs/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar":"apiSidebar"},"API-docs/selfsign":{"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.","sidebar":"apiSidebar"},"API-docs/update-document":{"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.","sidebar":"apiSidebar"},"API-docs/update-template":{"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.","sidebar":"apiSidebar"},"API-docs/updatefolder":{"id":"API-docs/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","sidebar":"apiSidebar"},"contribute/CODE_OF_CONDUCT":{"id":"contribute/CODE_OF_CONDUCT","title":"Code of conduct","description":"1. Introduction","sidebar":"contributeSidebar"},"contribute/COMMUNITY":{"id":"contribute/COMMUNITY","title":"Community at OpenSign\u2122","description":"Welcome to the OpenSign\u2122 Community page! OpenSign\u2122 is dedicated to fostering a vibrant and engaging community where members can connect, share ideas and collaborate on the OpenSign\u2122 project. This page provides links to our active social media platforms and community channels, offering various ways for you to join and participate in the OpenSign\u2122 community. Whether you\'re looking for support, eager to contribute or just want to stay updated, you\'ll find a platform that suits your preference. Connect with us on Discord for real-time discussions, follow us on Twitter for the latest updates, engage with our professional network on LinkedIn or join our Facebook group for a broader community experience. Join us in our mission to develop OpenSign\u2122 as the premier open-source alternative to DocuSign.","sidebar":"contributeSidebar"},"contribute/INSTALLATION":{"id":"contribute/INSTALLATION","title":"Installation instructions","description":"You can use our app as a cloud version from OpenSignLabs","sidebar":"contributeSidebar"},"contribute/intro":{"id":"contribute/intro","title":"Contributing to OpenSign","description":"Hello there! Thank you for considering contributing to OpenSign, the open-source alternative to DocuSign. OpenSign is not just a project, but a community endeavor that aims to create a robust, user-friendly, and secure electronic signature solution. Your contributions, irrespective of their size, are valuable in making this vision a reality.","sidebar":"contributeSidebar"},"contribute/REPORTING_GUIDELINES":{"id":"contribute/REPORTING_GUIDELINES","title":"OpenSign\u2122 Reporting Guidelines","description":"This document provides guidelines for reporting issues, suggesting enhancements, and submitting pull requests to the OpenSign\u2122 GitHub repository. Adhering to these guidelines helps maintain the project\'s quality and efficiency.","sidebar":"contributeSidebar"},"help/FAQs/Ensure this field is accurately filled and meets all requirements":{"id":"help/FAQs/Ensure this field is accurately filled and meets all requirements","title":"Why am I getting \'Ensure this field is accurately filled and meets all requirements\'?","description":"This happens when you leave a field blank or when you don\u2019t enter correct values in the field, for example not entering email address in correct format.","sidebar":"tutorialSidebar"},"help/FAQs/FAQs":{"id":"help/FAQs/FAQs","title":"Why is there no dropdown list when I sign a document myself?","description":"The dropdown list field is available only when you request a signature from others or when you create a template. This is because dropdown lists function as temporary widgets, allowing the user to select one of multiple values. Once a signer selects a value from the dropdown, it is embedded into the document as text. When you sign a document yourself, OpenSign digitally signs it immediately upon clicking the finish button. Therefore, you can use the text widget to add the necessary text to the document.","sidebar":"tutorialSidebar"},"help/intro":{"id":"help/intro","title":"Intro","description":"\ud83c\udf1fGet ready for an electrifying journey at OpenSign\u2122, the most incredibly documented open source document signing solution! \ud83d\ude80 This is your go-to spot for diving deep into everything OpenSign\u2122 has to offer. Whether you\u2019re just starting out or you\u2019re a seasoned pro eager to uncover even more cool features, we\u2019ve got you covered with the most awesome, top-notch guides and resources around. Get ready to make the most out of OpenSign\u2122 \ud83c\udf89\ud83d\udcda\ud83d\udd0d Your adventure in excellence starts here! \ud83c\udf08\u2728\ud83c\udf1f","sidebar":"tutorialSidebar"},"help/New-Document/enforce-email-verification":{"id":"help/New-Document/enforce-email-verification","title":"Enforce email OTP verification","description":"The \\"Enable OTP Verification\\" feature in OpenSign is designed to add an extra layer of security to the document-signing process by verifying the signer\u2019s email address. Here\u2019s an in-depth look at how it works, when to use it, and its impact on the signing process.","sidebar":"tutorialSidebar"},"help/New-Document/navigate-between-pages":{"id":"help/New-Document/navigate-between-pages","title":"Navigate between pages of a document","description":"To navigate between pages of a document that you have uploaded either click on the \'prev\' & \'next\' buttons at the top or click on any of the page previews loaded on the left side -","sidebar":"tutorialSidebar"},"help/New-Document/request-signatures":{"id":"help/New-Document/request-signatures","title":"Request signatures","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/New-Document/sign-yourself":{"id":"help/New-Document/sign-yourself","title":"Sign your-self","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/create-document":{"id":"help/OpenSign\u2122 Drive/create-document","title":"Create Docs & Folders","description":"OpenSign Drive offers a streamlined way to manage, sign, and request signatures on your important documents. Whether you\'re drafting an offer letter or storing signed agreements, organizing your documents effectively is crucial. Here\u2019s a step-by-step guide on how to create documents and folders in OpenSign Drive.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/list-grid-view":{"id":"help/OpenSign\u2122 Drive/list-grid-view","title":"Grid vs List view","description":"- Navigate to OpenSign drive using the main menu or clicking this link.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/organize-documents":{"id":"help/OpenSign\u2122 Drive/organize-documents","title":"OpenSign\u2122 Drive Interface Documentation","description":"Overview","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/rename-document":{"id":"help/OpenSign\u2122 Drive/rename-document","title":"Rename documents from OpenSign\u2122 Drive","description":"The OpenSign\u2122 Drive interface allows users to rename their documents efficiently.","sidebar":"tutorialSidebar"},"help/Reports/completed":{"id":"help/Reports/completed","title":"Completed","description":"---","sidebar":"tutorialSidebar"},"help/Reports/contactbook":{"id":"help/Reports/contactbook","title":"Contactbook","description":"The Contactbook report in OpenSign enables you to add and manage contacts.","sidebar":"tutorialSidebar"},"help/Reports/declined":{"id":"help/Reports/declined","title":"Declined","description":"The \\"Declined documents\\" report within OpenSign serves as a vital tool for managing and reviewing all declined documents that have been processed through the platform. This guide will walk you through the key features and functionalities of the \\"Declined documents\\" report, enabling you to efficiently navigate and manage your signed documents.","sidebar":"tutorialSidebar"},"help/Reports/drafts":{"id":"help/Reports/drafts","title":"Drafts","description":"The Draft documents section in OpenSign helps you manage all your in-progress documents easily. This feature allows you to save, review, and edit documents before sending them for signature. Here\'s a detailed overview of how to navigate and use the Draft Documents report effectively.","sidebar":"tutorialSidebar"},"help/Reports/expired":{"id":"help/Reports/expired","title":"Expired","description":"The Expired documents report in OpenSign allows you to manage and review documents that have reached their expiration date without being signed. This feature is essential for maintaining an organized record of inactive documents that may require follow-up or archival.","sidebar":"tutorialSidebar"},"help/Reports/in-progress":{"id":"help/Reports/in-progress","title":"In Progress","description":"The In-Progress documents report in OpenSign helps you monitor and manage documents that are currently in the signing process. This report enables you to monitor the status of your documents, manually share the document URL, track document progress, resend reminders, revoke access, or delete documents that are no longer required. Here\u2019s a detailed guide on how to use the In-Progress documents report effectively.","sidebar":"tutorialSidebar"},"help/Reports/need-your-sign":{"id":"help/Reports/need-your-sign","title":"Need your sign","description":"The \\"Need your sign\\" feature in OpenSign is designed to simplify the process of managing documents that require your signature. This guide will walk you through the various elements of the \\"Need your sign\\" report, helping you to efficiently navigate and complete your pending signing tasks.","sidebar":"tutorialSidebar"},"help/Settings/disabledocumentid":{"id":"help/Settings/disabledocumentid","title":"Disable DocumentId","description":"Whenever a document is signed by all parties, OpenSign\u2122 adds a DocumentId at the top left corner of the digitally signed document.","sidebar":"tutorialSidebar"},"help/Settings/manage-users":{"id":"help/Settings/manage-users","title":"Manage users","description":"The User Management feature allows administrators to add, edit, and manage users within the OpenSign application. This feature is available on self-hosted, teams, and enterprise plans. Only users with \\"Admin\\" & \\"OrgAdmin\\" role are allowed to manage users.","sidebar":"tutorialSidebar"},"help/Settings/my-signature":{"id":"help/Settings/my-signature","title":"My Signature","description":"This guide provides instructions on how to save your signature and initials using the OpenSign application. Once saved, you can use them with one click when signing documents. To create your signature, start by clicking the \\"My Signature\\" link under \\"settings\\" menu.","sidebar":"tutorialSidebar"},"help/Templates/create-template":{"id":"help/Templates/create-template","title":"Create Templates","description":"Getting Started","sidebar":"tutorialSidebar"},"help/Templates/embed-template":{"id":"help/Templates/embed-template","title":"Embedding OpenSign templates","description":"OpenSign Template Embedding allows users to seamlessly integrate public document templates into their websites or applications. By embedding templates, you can provide a direct and interactive signing experience for your users without requiring them to leave your platform. This feature supports various technologies like React, Next.js, HTML, JavaScript, and Angular, making it easy to add signing capabilities to different web projects.","sidebar":"tutorialSidebar"},"help/Templates/publicTemplate":{"id":"help/Templates/publicTemplate","title":"Setting up an OpenSign template for public signing","description":"The OpenSign Public profile feature offers the ultimate public document signing solution without any need for integrations. With this feature, users can share document templates publicly, allowing anyone to access and sign the documents directly through the shared templates. This streamlines the signing process by providing a seamless, accessible way for public signers to complete documents without additional steps or integrations.","sidebar":"tutorialSidebar"},"help/Templates/quick-send":{"id":"help/Templates/quick-send","title":"Quickly Send the Document for Signature Using Template","description":"Step 1: Begin New Template Creation","sidebar":"tutorialSidebar"},"help/Templates/use-template":{"id":"help/Templates/use-template","title":"Use template to create documents","description":"Step 1: Begin New Template Creation","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Tutorial Intro","description":"Let\'s discover Docusaurus in less than 5 minutes."},"self-host/cloud-storage/s3":{"id":"self-host/cloud-storage/s3","title":"AWS S3","description":"You can create an AWS S3 bucket to store your uploaded documents using OpenSign\u2122","sidebar":"selfhostSidebar"},"self-host/docker/run-locally":{"id":"self-host/docker/run-locally","title":"Self-host OpenSign\u2122 with Docker on Linux/MacOS/Windows","description":"Steps to run OpenSign\u2122 with docker on Linux/MacOS/Windows:","sidebar":"selfhostSidebar"},"self-host/docker/upgrade-deployment":{"id":"self-host/docker/upgrade-deployment","title":"OpenSign\u2122 Self-Hosted \'Upgrade Deployment\' Guide Using Docker on Linux, macOS, or Windows","description":"This guide provides step-by-step instructions to upgrade the deployment of OpenSign using Docker.","sidebar":"selfhostSidebar"},"self-host/guides/env-variables":{"id":"self-host/guides/env-variables","title":"ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","description":"Information About ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","sidebar":"selfhostSidebar"},"self-host/guides/how-to-generate-self-signed-document-signing-certificate":{"id":"self-host/guides/how-to-generate-self-signed-document-signing-certificate","title":"How to generate self-signed document signing certificate?","description":"","sidebar":"selfhostSidebar"},"self-host/guides/upgrade-to-v2.1.0":{"id":"self-host/guides/upgrade-to-v2.1.0","title":"How to upgrade self-hosted OpenSign to v2.1.0?","description":"For self-hosted deployments, version 2.1.0 introduces changes to the signup process:","sidebar":"selfhostSidebar"},"self-host/intro":{"id":"self-host/intro","title":"Self-Hosting OpenSign","description":"This section of the OpenSign\u2122 documentation is dedicated to guiding you through the process of self-hosting the OpenSign platform. Self-hosting OpenSign allows for greater control and customization, ensuring that it aligns perfectly with your specific needs and infrastructure requirements. We cover everything from initial setup, configuration options, to maintenance best practices. Whether you are an individual enthusiast or a professional looking to deploy OpenSign in a corporate environment, this guide will provide you with the necessary steps and tips to successfully self-host OpenSign\u2122 - the best open source document signing infrastructure.","sidebar":"selfhostSidebar"},"self-host/One-click-Install/DigitalOcean":{"id":"self-host/One-click-Install/DigitalOcean","title":"Digital Ocean","description":"OpenSign application consistes of 3 components -","sidebar":"selfhostSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.18811835.js b/assets/js/2c586be5.18811835.js new file mode 100644 index 000000000..13e86cfa8 --- /dev/null +++ b/assets/js/2c586be5.18811835.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9599],{60112:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>g,default:()=>b,frontMatter:()=>x,metadata:()=>i,toc:()=>f});const i=JSON.parse('{"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":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJztG9lyHLfxV5B5kcWaXXJXlKzwKbLkJExsk2VS5UqRLBo707sDcQYYA5g9zNq3fEk+LV+S6gYwxx5c6ohDV1YP4g7QABqN7kZfuI8sn5jo5Cp6p5KqAGlNdBNHKZhEi9IKJaOT6DID9lYDt8ACFHtzfsp4nquZYZUBbZhVbAISNEJJmLE0zMdGC1ZqNRWpkBOWcsvZTNiMjbiBV8cMZKJSSNlY5NC/ltfyUpQn7H2ZK56yhao0O3/353o2XAbbrg4O3sGomrD3pwcHN19l1pbm5PCQl2VflSCNmMicj0w/UcVhioBlOn4es1kGGnBWlnDJgBuRLxhPUzYT6QSsiZnNQLJElQuWKKVTIbkFE7OST4DJqhiBNjHjMmWF0sCEZJxp4OmiZ1WvMsD+dnH2AxsrXXDbZ+d5ZeJ6uVRoSGy+cNPbDOpdPTOBGsZqIScxK/gdUktY9kslkjvctgGZ4l8c+Ob8lGh1cHBRlaXSFlL2k9vCycEB9nwDuZoxroHgE1UUSrKSa16ApePKuKVuDb9UQkPqDoXneaDFybXssYMDuyjh5OCAncpUJEgMmhBbmRp72L4DRSIh6EUJiRgLD9oiHVOSzTKRZESTGXfnWeY8cWhqMCUkVkyhO/E8Zguc+B1IFTDIlBa/Kml5TscxBW1FwvP2sSGCCGos1xbJWSohbWj1K7B/+OPB06ND8XyFqKVIrEJI6jHApjyvwHisZjHLEKsfodRgiNX9vEhImbIMxCTbuh5PP1TGdiZmlUE021j4tcIpEXmByDbmuQEmxh1aFvwOWqsxRTLM8z77ZsFSGPMqtzETyHFWV9BnPyjLeFnmIuGjHJBzGQoPt5WGHp2yZwePiOQFnfE5STQYxlkqxmPQKJzYSVP4MQE75LNGBZDk2IxLpuTKQScqV3qdhai5S0eWKGlB2j57M+UiJ+TdZg0TMsmrFNgo58ldzEZ5BTHTkDrBXQCqrdgrIQRh3HiaE32YgRy5UEnEXyq/vDDMeKzSPrvMhGnkCTsDqWkRYdpU9VI7VrgykiCIGIOCizwmwsXsgxoxK2wOMQpsyeUiRn0JMbMwtyM1j1mSQXJHvzRPhWKjylol3cZSrcpUzaSn5VhJa8SvGyQy9Hw8RYcxO47Zq5i9jtngKGaDYcwGxzEbvIrZ4HXMhkcxGw5jNjyO2fCVQ2v42tOa1wRuIzAYOirb3w91Ue9+JwxJNipMU+vgWUcHD/rs4KCWJmz7+eefr+X9tWTsOkLhuo5O2HVUg1xHsetDnYl9A/89x48Xw6/95wI/Xw1f+88ZgQ6O/WeGn8PBtVz6Ba/lkDCxvCgfwAK7vygG/sszEbbRotgW9Bk2oiKKQweeVQcf7Fi29/IC9yKksILnZvt2AsQT2lGD0tqmjnFTxK7bd0TdT2g7bXywh9Sk6yK12uoKAk9YDNd2/7Lvb5btm3fLPpm9t9D5vK2/wq2jarpE1bR9/7X2ekJEWMXp8yjxdZ8MANLM2+ngAZ4QFboYfR4NXiMN8FLaTgDsfUK7b6GDHf6Gd31Hx73By97waHjcoQD6Rg6gKHpp2lssFl+Cemjz+OXR5AkWqrPs0Csda1VscD/IO2igvE1Ev4PJ/j0a6qNgw0KKfh85FsFiqT2+tpVtVcoXz4ybKgytjTOEb0yzRQtN6kI8yPtNMiUSjzzCBJNshA5eH2nQQ7qnh99/f9iipGvsFUVvpRE/e0T4VmNR9NO0vwK5djqusWBpGrP15o3tacqKotjS7NqvIzKp/ois7y2x7dzvAX4rAWj4vLvwg8KB8QAlc1qbnLTN0rFyhWRC+g7PKmwFQMOkyrmGOXqbRijpoL+85ATBaex18k7JsSPf35GCfXXmbfLnnqlxC90JsGX3uLWdtSfRMIE5zZFUxqoCkREpxxliZqokQ++NB9Mf6d7Eaegr4aXAKEEO1lIr2KS/CQl3ai0PG0911cE2YDub4YaFkRt8bDp+Yu/BEV1v3sF44H7zEE9Ixa+ghJ0uXIHdV9dRwckCQC6D5reyGejr6KYe47xqSHeMvXmEHGUihZyPIF/verQMtPfi+alFGOwohKwjAYTvUdzq5POVTte33CBbbsdtpg5KPIhGIDHLhQmxkC692qN9sIhCeBKAooIjYGEABlyD5H4um9eIPY7PnRbwh7NjCYRjBFgH6sJqO1boHEybMDhHIaQoqqKOOI7rWQPJCn+bt+mFIzGOHVZon+7aCny+YwUM721f4FoOKDIQIgoP2Hoe4gkpgxWUHpbTT1ETnTvyC11uuwUwbKstgBuuRAR1l2EtfGa79PXZGV5AGOV0gzBulSRQWoxxfa5o1ig/+gqiKJCLbH1Dka3tnNeOfz0h7tuA1n+ZAz3cb8OF7e39jjixg/ajudHF8Qo+ecDZpe4nxH8en5XDjeJIlZj5FEqeptFJlFCyNGT3opimBmO/UekiOrmPfKQdf/o4Ng49/GAw3XofmSSDguOvgBImaDFBGsUULAZtojii0Atma5Fe0UmkRh8gwdVKjehYAQbnoHEn9wHKZRij2Dvi0UnkUo9RHMGcFyUCRyu52TIdR8uw4ENT1S3NVIZ+1KlOnAeTeJ84zQ84dLmSoP6kmd61ZqC9FXCp3irss/COL0xrXnfTR6t5cRyDcpD4USzlC4OiVRlnlCU8T6ocnXqYl0Iv6ggDefYt/qjxrVeq8R28XDaH3qDEteaLKI6EhaLdvoUJtPr4k0tAIWUozPuxYz8oGAH8yTdgGp4OnhcfjcUHBWwEdOhlpuRHjx8MXwyGgxeDIc7g8zOfTkfXu45BlzHeoDsKaTDUe01KNWaU1ujv4tEAT9vmE9jNjJfbUu2tDJ/JVJWnmDsDrvuU8f7kYoouf9fXUX8HNy/jaL57M3OWqF7I47OvchhbVpUlaJYoLUE/bwfznszmhsfHyzha7N7e4ne5va/x8Ga7d/cTFUA0xSH/C1xfvF7GUbYb17/WJRr/Q2SPXy2b23XFeLgdqXRxG/TWchdguCgQbqzyFDQaJOv6qlE1qGGwtOh2Vc+PlMqByw2KppOb90VgaBeiSeij2bMM0KxuzEWavbFQvQHpsMV8P6wEG4VBQ1BXcB312em4Ze9SrGC1PCDAUqpeKvaM1rs1FanxZ4f+G2n0rF0GhZUpTRQ/oEDAzEJR5lRHNBN5jnjjvd5n9T+y/GpKIgLhugwL774q3rqgJi3oB3WLcJi3HfvsLZd1IUa34IHd39dsQNyxXLL7ezxV0Ld46S6XcdOAa3Ua6F51LRoSENPOqLoJmoF1W2uoM3Fu0cRxDT4x1kZATKSQk9tK58tlf40NmzN6NN3WyOTPDif5P6AYonMqz3QK+hGSezp2Lptiz5BZn/kAOVFGaGO9PDp29wi7PNcWKvuCBvT0vq3l21Qjg1AyzNfIj9ViMgEsNvQQNNiXBwFPMqcZCCs+RtGmAkINU6EqE9DLuKlN7hQhhBMXISddj7NFHareau+9v0l0JdYTnV2eP4KW5A/3nCZyzqTbpZuDnV2eY0miGHvfrs/em5oSgbS8A8LQ12JTwUPZUm2+LVzIEiRRxKnNTv1o3xcD9tg6QqkwGzGKm6RJXcC7NnFTs4pHpCqLxbLCV2IZC6Xp0JGwqAl5qarHcOUOSnI2qSjnavFWDqqREjlNSaGQxurKhWtZWulQRenZAiETMKahU6AKArXmjxlI44ZzNubGgo5ZJQVSXlcYLamnhHkJWoBMYCMJNDjSoeTu1mbd+rz3P37nK5XDHoJQjlAC3cSQsqokriFJqOtGw8mtbn2j7vBqazeCeEFTdaeP1JegjZIMqzL1hEvxq2NhcjqUQY8t47kD9aoCM9aID0p4F5lgTv37n/9q4bXV7VxHzK3A0xTThzswpGiZY3iM0msoUQOqLkY4H+g/rdp5iB0JzW2h0lqQzON5/ByLia2p9aJVVHwOObhK+ZDOrPWtiYOONd5zxKympuwjEtuqEvcLc2Fsq/Ix1Ces64cfAemYtHAgTwOlGnleLtoCXuPlKyyb6cgGFN2q2drSXZGFhy1WZ9I2cS6virESXEnjnO7h0RH+6ZK0fongJ0XiIaOPqzxf/CGKHx9ke9jjd82breiHXPjsgxj+Ok+mw/PIB3C6muAjAw+fFIXBMasxmC366MGteN+n0jk+c8C99GpeoGlbZyxkLiTchgO8TVVyG3aPcAUY0w1oPAqH+rjJQuie9Y7lkcWWcXS8iYsuVAE2I9HBeWda4euLMgeOrwH0gvEJF5KhG6C/IFOB1ko/7Jd9HGYPkeD46Oh2UBPh5ToRTiXlwOlNz6W6A/nb7rS9vHXLI6rzghjV3U+RcEDUH3U22253mzSQVFrYRXRydR/Ne7wUPdd/cnWzvEEWtJnCOH2pDGHMbRadRIdrYXsDekph16t7Jze1KBguU0xUr4UCeCkOp4NoGa+O2Bg42AptLJ8IOek9OOqm2eoFHoejeGfDjbopxd8B9Y2nZxsqjgSyQQYc/QikIJ7yj03O4ttwViGbsClB0JzJasg/RPw7QfzVK3JDWH5zVH7wshUPvwqhbYpW18HqTfHneusholwHlFsx4laI+Krh2ToaG4KxA4piDo+PKdz39YDiYi9eU8jp+NWSuKwJv0RRN8RCyaXVQEEUdR3gMKh27/yoxkdxmc6Ose2busZnmKk29joW16rBtdX42WL7BINXyLEifvNMcFaCvEB/AsV6OliPEkKeqKJ+vRHA//3Pf9GIwDy0zB/YWaVZqWagx5V7AjLOYS7Qgm89RAwxKOBFDsbkC4aG+4SeJKZiQlVgwSxOeMlHIheopxBMuZxMS9WZPvupiWI9064gbgo5qjeWK0Uv9NCEq6wqaI1wR82UvhsjSjHjbISPutAwNQBhCMiMywQDYU58yajDF4noaJRaGGBcFAiMDg+MxyIRZOsoaTVPLCu45BOyzmKKViIVyvAkS6sR+otG5ZXziPBhGIB1W6RUcZ+9Qw+UNk65KLB47KlzhkzsnFEvPv7F4wgd/xKXFwmYpnQ2hyloUlculFDlOSuVde49mqfts8WJrObS4GXv82D+aGryeZeF1kj5os8wX4z3IRruyAC5kHfufeJVzWY/wcgIC02kdjabranO590xfxE2q0boBKhm3IQaSdG2h9cfz1EvgS7M2fgC9FQkwUTasuYhAR/6K5W7oGAQNl6KjW5GLhKQBloX4Ju/nH/HpuxF/yiKW5fFIxA+/O707bc/XHyL8+J15uRv0D/qH1F6SRlbcNlaauWt76rotvLX+6fB+6fB+6fB+6fB+6fBv5vHq/unwfunwfunwfunwfunwfunwf89IuyfBu+fBu+fBu+fBu+fBu+fBu+fBu+fBu+fBu+fBu+fBu+fBn+5h5n7p8H7p8H7p8FPnRP3T4NDEQlahYdlzoVsVeG5yqOr1QfDN3GUYWnSyVV0f4/pv/dY/o/Nv1Sgsa7pJo6mXAsMclNVUxyqd7Bs5Q6wfuSti9n3LnH92LE7ZZxXirmw+MiNeEPH/iBsu3rq/OziMoqj8F6jUCmO0XyGD575zBWeeGrSG1ROj8dyLicVVdFEbk4sOOKVzbrVSndUreR/tIpxuFy0MOyWMblt4P+4qY0D7u9dJdRyWcO7rq0jPGEDNJ7fzXK5/A+Pglp1","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"}}');var s=t(74848),o=t(28453),r=t(33617),l=t.n(r),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const x={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:"eJztG9lyHLfxV5B5kcWaXXJXlKzwKbLkJExsk2VS5UqRLBo707sDcQYYA5g9zNq3fEk+LV+S6gYwxx5c6ohDV1YP4g7QABqN7kZfuI8sn5jo5Cp6p5KqAGlNdBNHKZhEi9IKJaOT6DID9lYDt8ACFHtzfsp4nquZYZUBbZhVbAISNEJJmLE0zMdGC1ZqNRWpkBOWcsvZTNiMjbiBV8cMZKJSSNlY5NC/ltfyUpQn7H2ZK56yhao0O3/353o2XAbbrg4O3sGomrD3pwcHN19l1pbm5PCQl2VflSCNmMicj0w/UcVhioBlOn4es1kGGnBWlnDJgBuRLxhPUzYT6QSsiZnNQLJElQuWKKVTIbkFE7OST4DJqhiBNjHjMmWF0sCEZJxp4OmiZ1WvMsD+dnH2AxsrXXDbZ+d5ZeJ6uVRoSGy+cNPbDOpdPTOBGsZqIScxK/gdUktY9kslkjvctgGZ4l8c+Ob8lGh1cHBRlaXSFlL2k9vCycEB9nwDuZoxroHgE1UUSrKSa16ApePKuKVuDb9UQkPqDoXneaDFybXssYMDuyjh5OCAncpUJEgMmhBbmRp72L4DRSIh6EUJiRgLD9oiHVOSzTKRZESTGXfnWeY8cWhqMCUkVkyhO/E8Zguc+B1IFTDIlBa/Kml5TscxBW1FwvP2sSGCCGos1xbJWSohbWj1K7B/+OPB06ND8XyFqKVIrEJI6jHApjyvwHisZjHLEKsfodRgiNX9vEhImbIMxCTbuh5PP1TGdiZmlUE021j4tcIpEXmByDbmuQEmxh1aFvwOWqsxRTLM8z77ZsFSGPMqtzETyHFWV9BnPyjLeFnmIuGjHJBzGQoPt5WGHp2yZwePiOQFnfE5STQYxlkqxmPQKJzYSVP4MQE75LNGBZDk2IxLpuTKQScqV3qdhai5S0eWKGlB2j57M+UiJ+TdZg0TMsmrFNgo58ldzEZ5BTHTkDrBXQCqrdgrIQRh3HiaE32YgRy5UEnEXyq/vDDMeKzSPrvMhGnkCTsDqWkRYdpU9VI7VrgykiCIGIOCizwmwsXsgxoxK2wOMQpsyeUiRn0JMbMwtyM1j1mSQXJHvzRPhWKjylol3cZSrcpUzaSn5VhJa8SvGyQy9Hw8RYcxO47Zq5i9jtngKGaDYcwGxzEbvIrZ4HXMhkcxGw5jNjyO2fCVQ2v42tOa1wRuIzAYOirb3w91Ue9+JwxJNipMU+vgWUcHD/rs4KCWJmz7+eefr+X9tWTsOkLhuo5O2HVUg1xHsetDnYl9A/89x48Xw6/95wI/Xw1f+88ZgQ6O/WeGn8PBtVz6Ba/lkDCxvCgfwAK7vygG/sszEbbRotgW9Bk2oiKKQweeVQcf7Fi29/IC9yKksILnZvt2AsQT2lGD0tqmjnFTxK7bd0TdT2g7bXywh9Sk6yK12uoKAk9YDNd2/7Lvb5btm3fLPpm9t9D5vK2/wq2jarpE1bR9/7X2ekJEWMXp8yjxdZ8MANLM2+ngAZ4QFboYfR4NXiMN8FLaTgDsfUK7b6GDHf6Gd31Hx73By97waHjcoQD6Rg6gKHpp2lssFl+Cemjz+OXR5AkWqrPs0Csda1VscD/IO2igvE1Ev4PJ/j0a6qNgw0KKfh85FsFiqT2+tpVtVcoXz4ybKgytjTOEb0yzRQtN6kI8yPtNMiUSjzzCBJNshA5eH2nQQ7qnh99/f9iipGvsFUVvpRE/e0T4VmNR9NO0vwK5djqusWBpGrP15o3tacqKotjS7NqvIzKp/ois7y2x7dzvAX4rAWj4vLvwg8KB8QAlc1qbnLTN0rFyhWRC+g7PKmwFQMOkyrmGOXqbRijpoL+85ATBaex18k7JsSPf35GCfXXmbfLnnqlxC90JsGX3uLWdtSfRMIE5zZFUxqoCkREpxxliZqokQ++NB9Mf6d7Eaegr4aXAKEEO1lIr2KS/CQl3ai0PG0911cE2YDub4YaFkRt8bDp+Yu/BEV1v3sF44H7zEE9Ixa+ghJ0uXIHdV9dRwckCQC6D5reyGejr6KYe47xqSHeMvXmEHGUihZyPIF/verQMtPfi+alFGOwohKwjAYTvUdzq5POVTte33CBbbsdtpg5KPIhGIDHLhQmxkC692qN9sIhCeBKAooIjYGEABlyD5H4um9eIPY7PnRbwh7NjCYRjBFgH6sJqO1boHEybMDhHIaQoqqKOOI7rWQPJCn+bt+mFIzGOHVZon+7aCny+YwUM721f4FoOKDIQIgoP2Hoe4gkpgxWUHpbTT1ETnTvyC11uuwUwbKstgBuuRAR1l2EtfGa79PXZGV5AGOV0gzBulSRQWoxxfa5o1ig/+gqiKJCLbH1Dka3tnNeOfz0h7tuA1n+ZAz3cb8OF7e39jjixg/ajudHF8Qo+ecDZpe4nxH8en5XDjeJIlZj5FEqeptFJlFCyNGT3opimBmO/UekiOrmPfKQdf/o4Ng49/GAw3XofmSSDguOvgBImaDFBGsUULAZtojii0Atma5Fe0UmkRh8gwdVKjehYAQbnoHEn9wHKZRij2Dvi0UnkUo9RHMGcFyUCRyu52TIdR8uw4ENT1S3NVIZ+1KlOnAeTeJ84zQ84dLmSoP6kmd61ZqC9FXCp3irss/COL0xrXnfTR6t5cRyDcpD4USzlC4OiVRlnlCU8T6ocnXqYl0Iv6ggDefYt/qjxrVeq8R28XDaH3qDEteaLKI6EhaLdvoUJtPr4k0tAIWUozPuxYz8oGAH8yTdgGp4OnhcfjcUHBWwEdOhlpuRHjx8MXwyGgxeDIc7g8zOfTkfXu45BlzHeoDsKaTDUe01KNWaU1ujv4tEAT9vmE9jNjJfbUu2tDJ/JVJWnmDsDrvuU8f7kYoouf9fXUX8HNy/jaL57M3OWqF7I47OvchhbVpUlaJYoLUE/bwfznszmhsfHyzha7N7e4ne5va/x8Ga7d/cTFUA0xSH/C1xfvF7GUbYb17/WJRr/Q2SPXy2b23XFeLgdqXRxG/TWchdguCgQbqzyFDQaJOv6qlE1qGGwtOh2Vc+PlMqByw2KppOb90VgaBeiSeij2bMM0KxuzEWavbFQvQHpsMV8P6wEG4VBQ1BXcB312em4Ze9SrGC1PCDAUqpeKvaM1rs1FanxZ4f+G2n0rF0GhZUpTRQ/oEDAzEJR5lRHNBN5jnjjvd5n9T+y/GpKIgLhugwL774q3rqgJi3oB3WLcJi3HfvsLZd1IUa34IHd39dsQNyxXLL7ezxV0Ld46S6XcdOAa3Ua6F51LRoSENPOqLoJmoF1W2uoM3Fu0cRxDT4x1kZATKSQk9tK58tlf40NmzN6NN3WyOTPDif5P6AYonMqz3QK+hGSezp2Lptiz5BZn/kAOVFGaGO9PDp29wi7PNcWKvuCBvT0vq3l21Qjg1AyzNfIj9ViMgEsNvQQNNiXBwFPMqcZCCs+RtGmAkINU6EqE9DLuKlN7hQhhBMXISddj7NFHareau+9v0l0JdYTnV2eP4KW5A/3nCZyzqTbpZuDnV2eY0miGHvfrs/em5oSgbS8A8LQ12JTwUPZUm2+LVzIEiRRxKnNTv1o3xcD9tg6QqkwGzGKm6RJXcC7NnFTs4pHpCqLxbLCV2IZC6Xp0JGwqAl5qarHcOUOSnI2qSjnavFWDqqREjlNSaGQxurKhWtZWulQRenZAiETMKahU6AKArXmjxlI44ZzNubGgo5ZJQVSXlcYLamnhHkJWoBMYCMJNDjSoeTu1mbd+rz3P37nK5XDHoJQjlAC3cSQsqokriFJqOtGw8mtbn2j7vBqazeCeEFTdaeP1JegjZIMqzL1hEvxq2NhcjqUQY8t47kD9aoCM9aID0p4F5lgTv37n/9q4bXV7VxHzK3A0xTThzswpGiZY3iM0msoUQOqLkY4H+g/rdp5iB0JzW2h0lqQzON5/ByLia2p9aJVVHwOObhK+ZDOrPWtiYOONd5zxKympuwjEtuqEvcLc2Fsq/Ix1Ces64cfAemYtHAgTwOlGnleLtoCXuPlKyyb6cgGFN2q2drSXZGFhy1WZ9I2cS6virESXEnjnO7h0RH+6ZK0fongJ0XiIaOPqzxf/CGKHx9ke9jjd82breiHXPjsgxj+Ok+mw/PIB3C6muAjAw+fFIXBMasxmC366MGteN+n0jk+c8C99GpeoGlbZyxkLiTchgO8TVVyG3aPcAUY0w1oPAqH+rjJQuie9Y7lkcWWcXS8iYsuVAE2I9HBeWda4euLMgeOrwH0gvEJF5KhG6C/IFOB1ko/7Jd9HGYPkeD46Oh2UBPh5ToRTiXlwOlNz6W6A/nb7rS9vHXLI6rzghjV3U+RcEDUH3U22253mzSQVFrYRXRydR/Ne7wUPdd/cnWzvEEWtJnCOH2pDGHMbRadRIdrYXsDekph16t7Jze1KBguU0xUr4UCeCkOp4NoGa+O2Bg42AptLJ8IOek9OOqm2eoFHoejeGfDjbopxd8B9Y2nZxsqjgSyQQYc/QikIJ7yj03O4ttwViGbsClB0JzJasg/RPw7QfzVK3JDWH5zVH7wshUPvwqhbYpW18HqTfHneusholwHlFsx4laI+Krh2ToaG4KxA4piDo+PKdz39YDiYi9eU8jp+NWSuKwJv0RRN8RCyaXVQEEUdR3gMKh27/yoxkdxmc6Ose2busZnmKk29joW16rBtdX42WL7BINXyLEifvNMcFaCvEB/AsV6OliPEkKeqKJ+vRHA//3Pf9GIwDy0zB/YWaVZqWagx5V7AjLOYS7Qgm89RAwxKOBFDsbkC4aG+4SeJKZiQlVgwSxOeMlHIheopxBMuZxMS9WZPvupiWI9064gbgo5qjeWK0Uv9NCEq6wqaI1wR82UvhsjSjHjbISPutAwNQBhCMiMywQDYU58yajDF4noaJRaGGBcFAiMDg+MxyIRZOsoaTVPLCu45BOyzmKKViIVyvAkS6sR+otG5ZXziPBhGIB1W6RUcZ+9Qw+UNk65KLB47KlzhkzsnFEvPv7F4wgd/xKXFwmYpnQ2hyloUlculFDlOSuVde49mqfts8WJrObS4GXv82D+aGryeZeF1kj5os8wX4z3IRruyAC5kHfufeJVzWY/wcgIC02kdjabranO590xfxE2q0boBKhm3IQaSdG2h9cfz1EvgS7M2fgC9FQkwUTasuYhAR/6K5W7oGAQNl6KjW5GLhKQBloX4Ju/nH/HpuxF/yiKW5fFIxA+/O707bc/XHyL8+J15uRv0D/qH1F6SRlbcNlaauWt76rotvLX+6fB+6fB+6fB+6fB+6fBv5vHq/unwfunwfunwfunwfunwfunwf89IuyfBu+fBu+fBu+fBu+fBu+fBu+fBu+fBu+fBu+fBu+fBu+fBn+5h5n7p8H7p8H7p8FPnRP3T4NDEQlahYdlzoVsVeG5yqOr1QfDN3GUYWnSyVV0f4/pv/dY/o/Nv1Sgsa7pJo6mXAsMclNVUxyqd7Bs5Q6wfuSti9n3LnH92LE7ZZxXirmw+MiNeEPH/iBsu3rq/OziMoqj8F6jUCmO0XyGD575zBWeeGrSG1ROj8dyLicVVdFEbk4sOOKVzbrVSndUreR/tIpxuFy0MOyWMblt4P+4qY0D7u9dJdRyWcO7rq0jPGEDNJ7fzXK5/A+Pglp1",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,y={},f=[];function j(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/createdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.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,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.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,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio Button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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 "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{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},x:{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},y:{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},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{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},email_subject:{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:""},email_body:{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:""},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"createdocument_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},signurl:{type:"array",items:{type:"object",properties:{email:{type:"string",format:"string",example:"mail@example.com"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_doc_signurl"}},message:{type:"string",format:"string",example:"Document sent successfully!"}},title:"inline_response_doc"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.bf9b3bd8.js b/assets/js/2c586be5.bf9b3bd8.js deleted file mode 100644 index da2be1d59..000000000 --- a/assets/js/2c586be5.bf9b3bd8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9599],{60112:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>j,contentTitle:()=>x,default:()=>b,frontMatter:()=>g,metadata:()=>i,toc:()=>f});const i=JSON.parse('{"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":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJztO11zGzeSf6V3XhyrhpRIy45PT+vYuT3dJZEqlit1JakUcKZJwpoBJgBGFKPi2/6S/Wn7S666AQxn+CHJH5tV6ugHiwM0gEaju9FfuEucmNjk6Dx5p7O6ROVscpkmOdrMyMpJrZKj5GyK8NagcAgRCt6cHoMoCj2zUFs0FpyGCSo0BKVwBnmcD0ZzqIy+kblUE8iFEzCTbgojYfHVIaDKdI45jGWB/Qt1oc5kdQQfqkKLHOa6NnD67j+b2WgZajvf23uHo3oCH4739i6/mTpX2aP9fVFVfV2hsnKiCjGy/UyX+zkBVvn4eQqzKRqkWSETClBYWcxB5DnMZD5BZ1NwU1SQ6WoOmdYml0o4tClUYoKg6nKExqYgVA6lNghSgQCDIp/3nO7VFuG/35/8BGNtSuH6cFrUNm2Wy6XBzBVzP72bYrOrZzZSwzoj1SSFUlwTtaSD32qZXdO2Laqc/tLAN6fHTKu9vfd1VWnjMIdf/BaO9vao5zss9AyEQYbPdFlqBZUwokTHxzUVjrsN/lZLg7k/FFEUkRZHF6oHe3tuXuHR3h4cq1xmRAyekFpBjwNs34MSkQj0fYWZHMsA2iIdaAWzqcymTJOZ8OdZFSLzaBq0FWZO3mB34tsU5jTxO1Q6YjDVRv6ulRMFH8cNGiczUbSPjRAkUOuEcUTOSkvlYmtYAf43HA+dHh9K4CtCLSdilVJxj0W4EUWNNmA1S2FKWP2MlUHLrB7mJUKqHKYoJ9Ot64n8Y21dZ2KoLaHZxiKsFU+JyYtMtrEoLIIcd2hZimtsrQaaZVgUffhuDjmORV24FCRxnDM19uEn7UBUVSEzMSqQOBdIeISrDfb4lAM7BESUKPmMT1mi0YKAXI7HaEg4qZOnCGMidsRnSxXAkuOmQoFWKwed6UKbdRbi5i4dIdPKoXJ9eHMjZMHI+81akCor6hxhVIjsOoVRUWMKBnMvuHMktZUGJUQgIGygOdMHLBbEhVoR/kqH5aUFG7DK+3A2lXYpT9QZSc2LSNumapDasaaViQRRxABLIYuUCZfCRz0CJ12BKQlsJdQ8JX2JKTi8dSN9m0I2xeyafxmRSw2j2jmt/MZyo6tcz1Sg5VgrZ+XvGyQy9nw6RYcpHKbwKoXXKQwOUhgMUxgcpjB4lcLgdQrDgxSGwxSGhykMX3m0hq8DrUVD4DYCg6GnsvvzUJf07g/SsmSTwrSNDp51dPCgD3t7jTRR26+//nqh7i4UwEVCwnWRHMFF0oBcJKnvI51JfYPwfUsfL4bfhs85fb4avg6fMwYdHIbPKX0OBxdqERa8UEPGxImyugcL6v6qGISvwETUxotSW9Rn1EiKKI0ddFYdfKhj0d7LC9qLVNJJUdjt24kQT2hHS5TWNnVIm2J23b4j7n5C22njQz2sJn0Xq9VWVxR4xmK4tvuX/XCzbN+8X/bJ7L2Fzpdt/RVzsx7BGamm7ftvtNcTIsIqTl9GiW/7bACwZt5OhwDwhKjQxejLaPCaaECX0nYCUO8T2n0LHeoIN7zvOzjsDV72hgfDww4FyDfyAGXZy/PefD7/GtQjmycsTyZPtFC9ZUde6djocoP7wd7BEirYRPw7muw/kqE+ijYs5uT3sWMRLZbG42tb2U7nYv7M+qni0MY4I/ilaTZvocldhAd7v9lUyywgTzDRJBuRg9cnGvSI7vn+jz/utyjpG3tl2VtppM8eE77VWJb9PO+vQK6djm8sIc9TWG/e2J7nUJbllmbffpGwSfUfxPrBEtvO/QHgjxKAJZ93F75XOCgeoFXBa7OTtlk6Vq6QqVShI7AKrAAYnNSFMHhL3qaVWnnory85UXCW9jp7p+zYse/vSQHfnASb/HlgatpCdwJqeXjc2s7akxic4C3PkdXW6ZKQkbmgGVKwdTYl701E05/ovozT8FcmKklRggKd41Z0WX8TEv7UWh42neqqg23RdTYjLMSRG3xsPn5m78EBX2/BwbjnfgsQT0jFr6BEnT5cQd3nF0kp2AIgLsPlb+2maC6Sy2aM96oxf2Ds5SPkaCpzLMQIi/WuR8tAey+Bn1qEoY5SqiYSwPgepK1OcbvS6fsWG2TL77jN1FGJR9GIJIZC2hgL6dKrPToEiziEpxA5KjhCiAMo4Bol90vZvEHscXzutUA4nAeWIDhgwCZQF1d7YIXOwbQJQ3OUUsmyLpuI47iZNZKsDLd5m140kuLYcYX26a6tIG4fWIHCe9sXuFADjgzEiMI9tl6AeELKYAWl++X0c9RE5478SpfbwwIYt9UWwA1XIoH6y7ARPrtd+vpwQhcQRTn9IIpbZRlWjmJcXyqaDcqPvoI4CuQjW99xZGs757XjX0+I+zag9S/mwAD3x3Bhe3t/Ik7soP1obvRxvFJM7nF2ufsJ8V/AZ+VwkzTRFWU+pVbHeXKUZJwsjdm9JOWp0brvdD5Pju6SEGmnnyGOTUP3P1pKt94lNptiKehXRIkStJQgTVIOFqOxSZpw6IWytUSv5CjRo4+Y0WqVIXScREtz8LijuwjlM4xJGhzx5CjxqcckTfBWlBUBJyu52SofJ4u44H1TNS3LqSz/aFKdNA8l8T5zmp9o6GIlQf1ZM71rzcB7K/FMv9XU5/CdmNvWvP6mT1bz4jSG5CALoyAXc0uiVVtvlGWiyOqCnHq8raSZNxEG9uxb/NHg26zU4Dt4uVge+hIlYYyYJ2kiHZbt9i1MYPSnn1yGmijDYd5PHftR4wjxr6GB0vB88KL8ZCw+aoQR8qFXU60+efxg+GIwHLwYDGmGkJ/5fDr63nUMuozxhtxRzKOh3lumVFPgtEb/IR6N8LxtMcGHmfFsW6q9leGzU10XOeXOUJg+Z7w/u5iiy9/NddR/gJsXaXL78GZuIdO9mMeHbwocO6irCg1k2ig0z9vBvCezueHh4SJN5g9vb/6n3N63dHizh3f3CxdALItD/h24vni9SJPpw7j+V1Oi8W9E9vDVYnm7rhgPVyOdz6+i3lo8BBgvCoIb6yJHQwbJur5aqhrSMFRadLWq50daFyjUBkXTyc2HIjCyC8kkDNHs2RTJrF6aizz70kINBqTHlvL9uBJslJYMQVPjRdKH43HL3uVYwWp5QITlVL3S8IzXu7I1q/Fn++GbaPSsXQZFlSnLKH5EgYHBYVkVXEc0k0VBeNO93ofmH1t+DSUJgXhdxoUfvire+qAmLxgGdYtwINiOfXgrVFOI0S14gLu7hg2YOxYLuLujU0VzRZfuYpEuG2itTgPfq77FYIbypjOqacLlwKatNdSbOFdk4viGkBhrIyAnSqrJVW2KxaK/xobLM3o03dbIFM6OJvl/QDFC51idmBzNIyT3eOxdNg3PiFmfhQA5U0Ya64I8enYPCPs81xYqh4IG8vS+b+Tb1iNLUCrOt5QfZ+RkglRsGCB4cCgPQpFNvWZgrMSYRJsLCA3eSF3biN5U2MbkzglCenGRatL1OFvU4eqt9t77m0RXUT3RydnpI2jJ/nDPayLvTPpd+jng5OyUShLlOPh2ffhgG0pE0ooOCJCvBTdSxLKlxnyb+5AlKqaIV5ud+tF+KAbswTpCubQbMUqXSZOmgHdt4mXNKh2Rrh0Vy8pQiWUdVrZDR8aiIeSZrh/DlQ9QUsCk5pyro1s5qkZO5CxLCqWyztQ+XAt5bWIVZWALgszQ2iWdIlUIqDV/CqisHy5gLKxDk0KtJFHe1BQtaabE2wqNRJXhRhIY9KQjyX1Ym3Xr8z78/EOoVI57iEI5Ign0E2MOdcVcw5LQ1I3Gk1vd+kbdEdTWwwjSBc3VnSFSX6GxWgFVZZqJUPJ3z8LsdGhLHttUFB40qArKWBM+JOFdZKI59c+//6OF11a3cx0xv4LIc0ofPoAhR8s8w1OU3mBFGlB3MaL50Px11c4j7FhorkqdN4JkH8/jp1RM7GyjF53m4nMs0FfKx3Rmo29tGnWsDZ4jZTUNZx+J2E5XtF+8lda1Kh9jfcK6fvgZiY5ZCwf2NEiqiefVvC3gDV6hwnI5HduAsls121i6K7Jwv8XqTdplnCuoYqoE18p6p3t4cEB/uiRtXiKESYl4xOjjuijmf0nSxwfZ7vf4ffNmK/o+F376UQ5/v81uhqdJCOB0NcEnBh4+KwpDY1ZjMFv00b1bCb5PbQp65kB76TW8wNO2zliqQiq8igd4levsKu6e4Eq0thvQeBQOzXGzhdA96weWJxZbpMnhJi56r0t0UxYdmndmNL2+qAoU9BrAzEFMhFRAboD5ikyFxmhzv1/2aZjdR4LDg4OrQUOEl+tEOFacA+c3PWf6GtUfu9P28s4vT6jelsyo/n5KpAfi/qSz2Xa736TFrDbSzZOj87vkticq2fP9R+eXi0tiQTfVFKevtGWMhZsmR8n+WtjeornhsOv5nZebRhSsUDklqtdCAaKS+zeDZJGujtgYONgKbZ2YSDXp3TvqcrnV93QcnuKdDS/VTSX/B0nfBHq2odJEEhtMUZAfQRSkU/55mbP4Pp5VzCZsShAsz2Q15B8j/p0g/uoVuSEsvzkqP3jZioefx9A2R6ubYPWm+HOz9RhRbgLKrRhxK0R8vuTZJhobg7EDjmIODw853PftgONiL15zyOnw1YK5bBl+SZJuiIWTS6uBgiTpOsBxUOPehVFLH8VnOjvGdmjqGp9xpsbY61hcqwbXVuNni+0TDV6pxpr5LTDBSYXqPfkTJNY3g/UoIRaZLpvXGxH8n3//B4+IzMPL/AVOagOVnqEZ1/4JyLjAW0kWfOshYoxBoSgLtLaYAxnuE36SmMsJV4FFszgTlRjJQpKeIjDtczItVWf78MsyivXM+IK4GyxIvUGhNb/QIxOudrrkNeIdNdPmekwopSBgRI+6yDC1iHEIqqlQGQXCvPiyUUcvEsnRqIy0CEKWBEwOD47HMpNs62jljMgclEKJCVtnKUcriQpVfJJl9Ij8RauL2ntE9DAM0fktcqq4D+/IA+WNcy4KHR177p0hm3pnNIhPePE4Ise/ouVlhnZZOlvgDRpWVz6UUBcFVNp5957M0/bZ0kTOCGXpsg95sHA0DfmCy8Jr5GLeB8oX031IhjsxQCHVtX+feN6w2S84stLhMlI7m83WVOfz7pi/STetR+QE6OW4CTeyom0Pbz6ek15CU9qT8Xs0NzKLJtKWNfcZeD9cqcIHBaOwiUpudDMKmaGy2LoA3/zt9Ae4gRf9gyRtXRaPQHj/h+O33//0/nual64zL3+D/kH/gNNL2rpSqNZSK299V0W3lb/ePQ3ePQ3ePQ3ePQ3ePQ3+0zxe3T0N3j0N3j0N3j0N3j0N3j0N/tcRYfc0ePc0ePc0ePc0ePc0ePc0ePc0ePc0ePc0ePc0ePc0ePc0+Os9zNw9Dd49Dd49DX7qnLh7GhyLSMgq3K8KIVWrCs9XHp2vPhi+TJMplSYdnSd3d5T++0Dl/9T8W42G6pou0+RGGElBbq5qSmP1DpWtXCPVj7z1MfveGa2fenbnjPNKMRcVH/kRb/jY74VtV0+dnrw/S9IkvtcodU5jjJjRg2cx84UngZr8BlXw47FCqEnNVTSJn5MKjkTtpt1qpWuuVgo/WsU4Qs1bGHbLmPw26H/a1MYBd3e+EmqxaOB919YRgbARms7vcrFY/B8sNVpz","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"}}');var s=t(74848),o=t(28453),r=t(33617),l=t.n(r),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const g={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:"eJztO11zGzeSf6V3XhyrhpRIy45PT+vYuT3dJZEqlit1JakUcKZJwpoBJgBGFKPi2/6S/Wn7S666AQxn+CHJH5tV6ugHiwM0gEaju9FfuEucmNjk6Dx5p7O6ROVscpkmOdrMyMpJrZKj5GyK8NagcAgRCt6cHoMoCj2zUFs0FpyGCSo0BKVwBnmcD0ZzqIy+kblUE8iFEzCTbgojYfHVIaDKdI45jGWB/Qt1oc5kdQQfqkKLHOa6NnD67j+b2WgZajvf23uHo3oCH4739i6/mTpX2aP9fVFVfV2hsnKiCjGy/UyX+zkBVvn4eQqzKRqkWSETClBYWcxB5DnMZD5BZ1NwU1SQ6WoOmdYml0o4tClUYoKg6nKExqYgVA6lNghSgQCDIp/3nO7VFuG/35/8BGNtSuH6cFrUNm2Wy6XBzBVzP72bYrOrZzZSwzoj1SSFUlwTtaSD32qZXdO2Laqc/tLAN6fHTKu9vfd1VWnjMIdf/BaO9vao5zss9AyEQYbPdFlqBZUwokTHxzUVjrsN/lZLg7k/FFEUkRZHF6oHe3tuXuHR3h4cq1xmRAyekFpBjwNs34MSkQj0fYWZHMsA2iIdaAWzqcymTJOZ8OdZFSLzaBq0FWZO3mB34tsU5jTxO1Q6YjDVRv6ulRMFH8cNGiczUbSPjRAkUOuEcUTOSkvlYmtYAf43HA+dHh9K4CtCLSdilVJxj0W4EUWNNmA1S2FKWP2MlUHLrB7mJUKqHKYoJ9Ot64n8Y21dZ2KoLaHZxiKsFU+JyYtMtrEoLIIcd2hZimtsrQaaZVgUffhuDjmORV24FCRxnDM19uEn7UBUVSEzMSqQOBdIeISrDfb4lAM7BESUKPmMT1mi0YKAXI7HaEg4qZOnCGMidsRnSxXAkuOmQoFWKwed6UKbdRbi5i4dIdPKoXJ9eHMjZMHI+81akCor6hxhVIjsOoVRUWMKBnMvuHMktZUGJUQgIGygOdMHLBbEhVoR/kqH5aUFG7DK+3A2lXYpT9QZSc2LSNumapDasaaViQRRxABLIYuUCZfCRz0CJ12BKQlsJdQ8JX2JKTi8dSN9m0I2xeyafxmRSw2j2jmt/MZyo6tcz1Sg5VgrZ+XvGyQy9nw6RYcpHKbwKoXXKQwOUhgMUxgcpjB4lcLgdQrDgxSGwxSGhykMX3m0hq8DrUVD4DYCg6GnsvvzUJf07g/SsmSTwrSNDp51dPCgD3t7jTRR26+//nqh7i4UwEVCwnWRHMFF0oBcJKnvI51JfYPwfUsfL4bfhs85fb4avg6fMwYdHIbPKX0OBxdqERa8UEPGxImyugcL6v6qGISvwETUxotSW9Rn1EiKKI0ddFYdfKhj0d7LC9qLVNJJUdjt24kQT2hHS5TWNnVIm2J23b4j7n5C22njQz2sJn0Xq9VWVxR4xmK4tvuX/XCzbN+8X/bJ7L2Fzpdt/RVzsx7BGamm7ftvtNcTIsIqTl9GiW/7bACwZt5OhwDwhKjQxejLaPCaaECX0nYCUO8T2n0LHeoIN7zvOzjsDV72hgfDww4FyDfyAGXZy/PefD7/GtQjmycsTyZPtFC9ZUde6djocoP7wd7BEirYRPw7muw/kqE+ijYs5uT3sWMRLZbG42tb2U7nYv7M+qni0MY4I/ilaTZvocldhAd7v9lUyywgTzDRJBuRg9cnGvSI7vn+jz/utyjpG3tl2VtppM8eE77VWJb9PO+vQK6djm8sIc9TWG/e2J7nUJbllmbffpGwSfUfxPrBEtvO/QHgjxKAJZ93F75XOCgeoFXBa7OTtlk6Vq6QqVShI7AKrAAYnNSFMHhL3qaVWnnory85UXCW9jp7p+zYse/vSQHfnASb/HlgatpCdwJqeXjc2s7akxic4C3PkdXW6ZKQkbmgGVKwdTYl701E05/ovozT8FcmKklRggKd41Z0WX8TEv7UWh42neqqg23RdTYjLMSRG3xsPn5m78EBX2/BwbjnfgsQT0jFr6BEnT5cQd3nF0kp2AIgLsPlb+2maC6Sy2aM96oxf2Ds5SPkaCpzLMQIi/WuR8tAey+Bn1qEoY5SqiYSwPgepK1OcbvS6fsWG2TL77jN1FGJR9GIJIZC2hgL6dKrPToEiziEpxA5KjhCiAMo4Bol90vZvEHscXzutUA4nAeWIDhgwCZQF1d7YIXOwbQJQ3OUUsmyLpuI47iZNZKsDLd5m140kuLYcYX26a6tIG4fWIHCe9sXuFADjgzEiMI9tl6AeELKYAWl++X0c9RE5478SpfbwwIYt9UWwA1XIoH6y7ARPrtd+vpwQhcQRTn9IIpbZRlWjmJcXyqaDcqPvoI4CuQjW99xZGs757XjX0+I+zag9S/mwAD3x3Bhe3t/Ik7soP1obvRxvFJM7nF2ufsJ8V/AZ+VwkzTRFWU+pVbHeXKUZJwsjdm9JOWp0brvdD5Pju6SEGmnnyGOTUP3P1pKt94lNptiKehXRIkStJQgTVIOFqOxSZpw6IWytUSv5CjRo4+Y0WqVIXScREtz8LijuwjlM4xJGhzx5CjxqcckTfBWlBUBJyu52SofJ4u44H1TNS3LqSz/aFKdNA8l8T5zmp9o6GIlQf1ZM71rzcB7K/FMv9XU5/CdmNvWvP6mT1bz4jSG5CALoyAXc0uiVVtvlGWiyOqCnHq8raSZNxEG9uxb/NHg26zU4Dt4uVge+hIlYYyYJ2kiHZbt9i1MYPSnn1yGmijDYd5PHftR4wjxr6GB0vB88KL8ZCw+aoQR8qFXU60+efxg+GIwHLwYDGmGkJ/5fDr63nUMuozxhtxRzKOh3lumVFPgtEb/IR6N8LxtMcGHmfFsW6q9leGzU10XOeXOUJg+Z7w/u5iiy9/NddR/gJsXaXL78GZuIdO9mMeHbwocO6irCg1k2ig0z9vBvCezueHh4SJN5g9vb/6n3N63dHizh3f3CxdALItD/h24vni9SJPpw7j+V1Oi8W9E9vDVYnm7rhgPVyOdz6+i3lo8BBgvCoIb6yJHQwbJur5aqhrSMFRadLWq50daFyjUBkXTyc2HIjCyC8kkDNHs2RTJrF6aizz70kINBqTHlvL9uBJslJYMQVPjRdKH43HL3uVYwWp5QITlVL3S8IzXu7I1q/Fn++GbaPSsXQZFlSnLKH5EgYHBYVkVXEc0k0VBeNO93ofmH1t+DSUJgXhdxoUfvire+qAmLxgGdYtwINiOfXgrVFOI0S14gLu7hg2YOxYLuLujU0VzRZfuYpEuG2itTgPfq77FYIbypjOqacLlwKatNdSbOFdk4viGkBhrIyAnSqrJVW2KxaK/xobLM3o03dbIFM6OJvl/QDFC51idmBzNIyT3eOxdNg3PiFmfhQA5U0Ya64I8enYPCPs81xYqh4IG8vS+b+Tb1iNLUCrOt5QfZ+RkglRsGCB4cCgPQpFNvWZgrMSYRJsLCA3eSF3biN5U2MbkzglCenGRatL1OFvU4eqt9t77m0RXUT3RydnpI2jJ/nDPayLvTPpd+jng5OyUShLlOPh2ffhgG0pE0ooOCJCvBTdSxLKlxnyb+5AlKqaIV5ud+tF+KAbswTpCubQbMUqXSZOmgHdt4mXNKh2Rrh0Vy8pQiWUdVrZDR8aiIeSZrh/DlQ9QUsCk5pyro1s5qkZO5CxLCqWyztQ+XAt5bWIVZWALgszQ2iWdIlUIqDV/CqisHy5gLKxDk0KtJFHe1BQtaabE2wqNRJXhRhIY9KQjyX1Ym3Xr8z78/EOoVI57iEI5Ign0E2MOdcVcw5LQ1I3Gk1vd+kbdEdTWwwjSBc3VnSFSX6GxWgFVZZqJUPJ3z8LsdGhLHttUFB40qArKWBM+JOFdZKI59c+//6OF11a3cx0xv4LIc0ofPoAhR8s8w1OU3mBFGlB3MaL50Px11c4j7FhorkqdN4JkH8/jp1RM7GyjF53m4nMs0FfKx3Rmo29tGnWsDZ4jZTUNZx+J2E5XtF+8lda1Kh9jfcK6fvgZiY5ZCwf2NEiqiefVvC3gDV6hwnI5HduAsls121i6K7Jwv8XqTdplnCuoYqoE18p6p3t4cEB/uiRtXiKESYl4xOjjuijmf0nSxwfZ7vf4ffNmK/o+F376UQ5/v81uhqdJCOB0NcEnBh4+KwpDY1ZjMFv00b1bCb5PbQp65kB76TW8wNO2zliqQiq8igd4levsKu6e4Eq0thvQeBQOzXGzhdA96weWJxZbpMnhJi56r0t0UxYdmndmNL2+qAoU9BrAzEFMhFRAboD5ikyFxmhzv1/2aZjdR4LDg4OrQUOEl+tEOFacA+c3PWf6GtUfu9P28s4vT6jelsyo/n5KpAfi/qSz2Xa736TFrDbSzZOj87vkticq2fP9R+eXi0tiQTfVFKevtGWMhZsmR8n+WtjeornhsOv5nZebRhSsUDklqtdCAaKS+zeDZJGujtgYONgKbZ2YSDXp3TvqcrnV93QcnuKdDS/VTSX/B0nfBHq2odJEEhtMUZAfQRSkU/55mbP4Pp5VzCZsShAsz2Q15B8j/p0g/uoVuSEsvzkqP3jZioefx9A2R6ubYPWm+HOz9RhRbgLKrRhxK0R8vuTZJhobg7EDjmIODw853PftgONiL15zyOnw1YK5bBl+SZJuiIWTS6uBgiTpOsBxUOPehVFLH8VnOjvGdmjqGp9xpsbY61hcqwbXVuNni+0TDV6pxpr5LTDBSYXqPfkTJNY3g/UoIRaZLpvXGxH8n3//B4+IzMPL/AVOagOVnqEZ1/4JyLjAW0kWfOshYoxBoSgLtLaYAxnuE36SmMsJV4FFszgTlRjJQpKeIjDtczItVWf78MsyivXM+IK4GyxIvUGhNb/QIxOudrrkNeIdNdPmekwopSBgRI+6yDC1iHEIqqlQGQXCvPiyUUcvEsnRqIy0CEKWBEwOD47HMpNs62jljMgclEKJCVtnKUcriQpVfJJl9Ij8RauL2ntE9DAM0fktcqq4D+/IA+WNcy4KHR177p0hm3pnNIhPePE4Ise/ouVlhnZZOlvgDRpWVz6UUBcFVNp5957M0/bZ0kTOCGXpsg95sHA0DfmCy8Jr5GLeB8oX031IhjsxQCHVtX+feN6w2S84stLhMlI7m83WVOfz7pi/STetR+QE6OW4CTeyom0Pbz6ek15CU9qT8Xs0NzKLJtKWNfcZeD9cqcIHBaOwiUpudDMKmaGy2LoA3/zt9Ae4gRf9gyRtXRaPQHj/h+O33//0/nual64zL3+D/kH/gNNL2rpSqNZSK299V0W3lb/ePQ3ePQ3ePQ3ePQ3ePQ3+0zxe3T0N3j0N3j0N3j0N3j0N3j0N/tcRYfc0ePc0ePc0ePc0ePc0ePc0ePc0ePc0ePc0ePc0ePc0ePc0+Os9zNw9Dd49Dd49DX7qnLh7GhyLSMgq3K8KIVWrCs9XHp2vPhi+TJMplSYdnSd3d5T++0Dl/9T8W42G6pou0+RGGElBbq5qSmP1DpWtXCPVj7z1MfveGa2fenbnjPNKMRcVH/kRb/jY74VtV0+dnrw/S9IkvtcodU5jjJjRg2cx84UngZr8BlXw47FCqEnNVTSJn5MKjkTtpt1qpWuuVgo/WsU4Qs1bGHbLmPw26H/a1MYBd3e+EmqxaOB919YRgbARms7vcrFY/B8sNVpz",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={},f=[];function y(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/createdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.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,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.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,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"iob Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio Button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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 "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{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},x:{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},y:{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},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{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},email_subject:{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:""},email_body:{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:""},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"createdocument_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},signurl:{type:"array",items:{type:"object",properties:{email:{type:"string",format:"string",example:"mail@example.com"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_doc_signurl"}},message:{type:"string",format:"string",example:"Document sent successfully!"}},title:"inline_response_doc"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/4d665321.9d5f9e5e.js b/assets/js/4d665321.9d5f9e5e.js new file mode 100644 index 000000000..470443dfd --- /dev/null +++ b/assets/js/4d665321.9d5f9e5e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6792],{87610:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>S,contentTitle:()=>g,default:()=>h,frontMatter:()=>v,metadata:()=>n,toc:()=>U});const n=JSON.parse('{"id":"API-docs/revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","source":"@site/docs/API-docs/revokedocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/revokedocument","permalink":"/docs/API-docs/revokedocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","sidebar_label":"Revoke Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V9tu3DYQ/RVmXpoA2osvSVE91bkgNRrURuwiQJ2FMSuNtIwpkiGpvWCht35JP61fUgwl7cqXGAmQ5sVeUXM7M8Mzoy0ELD2kV/DaZHVFOniYJZCTz5y0QRoNKVwuSLynpbkhkXdS4uT8VKBSZuXFxtQiGOFaCW8pk4XM9qKFMxULud2RH0MCxpJD9nCaQwqtdi8ACVh0WFEgx9FtQWNFkEIvcC1zSEBydBbDAu6GfO7MUuYkzPwTZeE0F6bYB7QLFhJw9LmWjnJIg6spAR82ih15WVnFArS2yuQEaYHKs0C2oAoh3ULY2CgZnNQlJFAYV2EYntAao5UU7OJwvjhEn0PTzFqv5MNLk2/YUmZ0YNTpFtBaJbOYl8knz1i29122qDhJjrMYJHl+6wg7jbuh7QOBpkkgyBAf7iS9afilI2+N9q3Jw+mU/91Obt8qXRZz4essI++LWqnNE0i+F56+eI8jernmxNrf7BHE6GNIJ+FxpcPp4dHoYDqa/nx58CI9/iV9/mI8nU7/ggTWlWLdvuEwEAxS1j4398RI0W3BrsPanB4/lMYLU1FYSF2KFSdz5YwuE2EVoScR3EZgiVILhYHcd8wqOWfc49n5tsiGHSW1kpqu+x66Pp5Orw92STh+pJe0CaIwtc5/LNSH/D8O6Pj6aAfo+X1Ap3qJSuaRIC/NDekfi2foPrTu73erbIXie7gFdnjegvSU1U6GTWTh9QitHLXv06sZUxl3imEGt8a3vB0WkMKkZ5XJdsDZDbBBt+xZvXYKUliEYH06mXjU+dysx8aS9rLUCud+nJlqglZOlgfQJHc10NpvkPYBS6nL0aNasz3kCy5Lm/lbwHf5Ryt/pw0kfV6HUt10WhDm5GINuNrv98T/pq/ZnriBiyF1YaKPrihnlvSFLHUs6fLg3qj7QCozFfFUCwsSvfi/f/8TNfrsx457Is5qJ6xZkStqJVDnolC0lnNFD0x0T1gp8l5thNSBSoeBRC5LGVAJTh4zRIYW51JJ7lEWM+2oH7S5H4sPCwoLcvzqJ0cCRU5LUtzaQhlzw3aCEVgHU0Uf/aVcGXdTcEiJQDGvvdTkvfBEvQrpBeqMRF+yRBgnUAvSgZx10pNAWbFwYZygopCZZMN8IR1mQVSosSR2lgiOm7Ng2+XBC2fmtQ/CG1VHIOyxIgotRE2U+7F4LZfUAo8rDgWUinJR1mwiEZnJSXT3k2HoXMzJB2HZvcwoGvUBXRCKluRii8ZK8jgV1jBxSFS8wQxry4aCQ+157ejWq640u/RZZ3guRx85bsbio/6omdxF7YkbQEl949OPeiSudm32geZeBpo97a/NarW6d12e3dZ5K8OingtH1uz1yngYL9dQfffwDBII5Cp/VlyQW8qMurv6BZ+TKDzp6BSzSKdUoVTtVfz1rgLfJiUz0p4G5Hfy9vydWIqj8RSSAUF8RcCTd6ev3vxx8YbtMoW19+9gPB1P+YgJsEI9cNUtza/3W+2tqztY/P6nHbvjqUDrMLEKZWT7iHnbEfUVDHbudLhezxJYMKWnV7DdztHTn041DR9/rsnxPJglsEQncc48dbWFXHr+ne925S+iffq+W7ufia/e1B/E0hOxZhZeoqrjjpvADW3ufC00sybp2ZiDbSVetSGNLtnO3sK9Ic3DpNU4yTKy4VHZ4VQ8P7u4hATm3aZfxU8JcLjibw9ctdGamKJ2h+ezLSjUZY0ly7Y2eYBgzRUbTp+bOH26H4zqwXzcHkstDP7LoB5U2G7bydY0O/n21Rc1usT20lycWdM0/wGcUwVl","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Document","permalink":"/docs/API-docs/update-document"},"next":{"title":"Delete Document","permalink":"/docs/API-docs/deletedocument"}}');var i=o(74848),s=o(28453),c=o(33617),a=o.n(c),d=o(17543),r=o.n(d),p=o(86013),l=o.n(p),u=o(63723),m=o.n(u),f=(o(18766),o(79329),o(9303));const v={id:"revokedocument",title:"Revoke Document",description:"The Revoke document API allows you to revoke specific document from your documents.",sidebar_label:"Revoke Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V9tu3DYQ/RVmXpoA2osvSVE91bkgNRrURuwiQJ2FMSuNtIwpkiGpvWCht35JP61fUgwl7cqXGAmQ5sVeUXM7M8Mzoy0ELD2kV/DaZHVFOniYJZCTz5y0QRoNKVwuSLynpbkhkXdS4uT8VKBSZuXFxtQiGOFaCW8pk4XM9qKFMxULud2RH0MCxpJD9nCaQwqtdi8ACVh0WFEgx9FtQWNFkEIvcC1zSEBydBbDAu6GfO7MUuYkzPwTZeE0F6bYB7QLFhJw9LmWjnJIg6spAR82ih15WVnFArS2yuQEaYHKs0C2oAoh3ULY2CgZnNQlJFAYV2EYntAao5UU7OJwvjhEn0PTzFqv5MNLk2/YUmZ0YNTpFtBaJbOYl8knz1i29122qDhJjrMYJHl+6wg7jbuh7QOBpkkgyBAf7iS9afilI2+N9q3Jw+mU/91Obt8qXRZz4essI++LWqnNE0i+F56+eI8jernmxNrf7BHE6GNIJ+FxpcPp4dHoYDqa/nx58CI9/iV9/mI8nU7/ggTWlWLdvuEwEAxS1j4398RI0W3BrsPanB4/lMYLU1FYSF2KFSdz5YwuE2EVoScR3EZgiVILhYHcd8wqOWfc49n5tsiGHSW1kpqu+x66Pp5Orw92STh+pJe0CaIwtc5/LNSH/D8O6Pj6aAfo+X1Ap3qJSuaRIC/NDekfi2foPrTu73erbIXie7gFdnjegvSU1U6GTWTh9QitHLXv06sZUxl3imEGt8a3vB0WkMKkZ5XJdsDZDbBBt+xZvXYKUliEYH06mXjU+dysx8aS9rLUCud+nJlqglZOlgfQJHc10NpvkPYBS6nL0aNasz3kCy5Lm/lbwHf5Ryt/pw0kfV6HUt10WhDm5GINuNrv98T/pq/ZnriBiyF1YaKPrihnlvSFLHUs6fLg3qj7QCozFfFUCwsSvfi/f/8TNfrsx457Is5qJ6xZkStqJVDnolC0lnNFD0x0T1gp8l5thNSBSoeBRC5LGVAJTh4zRIYW51JJ7lEWM+2oH7S5H4sPCwoLcvzqJ0cCRU5LUtzaQhlzw3aCEVgHU0Uf/aVcGXdTcEiJQDGvvdTkvfBEvQrpBeqMRF+yRBgnUAvSgZx10pNAWbFwYZygopCZZMN8IR1mQVSosSR2lgiOm7Ng2+XBC2fmtQ/CG1VHIOyxIgotRE2U+7F4LZfUAo8rDgWUinJR1mwiEZnJSXT3k2HoXMzJB2HZvcwoGvUBXRCKluRii8ZK8jgV1jBxSFS8wQxry4aCQ+157ejWq640u/RZZ3guRx85bsbio/6omdxF7YkbQEl949OPeiSudm32geZeBpo97a/NarW6d12e3dZ5K8OingtH1uz1yngYL9dQfffwDBII5Cp/VlyQW8qMurv6BZ+TKDzp6BSzSKdUoVTtVfz1rgLfJiUz0p4G5Hfy9vydWIqj8RSSAUF8RcCTd6ev3vxx8YbtMoW19+9gPB1P+YgJsEI9cNUtza/3W+2tqztY/P6nHbvjqUDrMLEKZWT7iHnbEfUVDHbudLhezxJYMKWnV7DdztHTn041DR9/rsnxPJglsEQncc48dbWFXHr+ne925S+iffq+W7ufia/e1B/E0hOxZhZeoqrjjpvADW3ufC00sybp2ZiDbSVetSGNLtnO3sK9Ic3DpNU4yTKy4VHZ4VQ8P7u4hATm3aZfxU8JcLjibw9ctdGamKJ2h+ezLSjUZY0ly7Y2eYBgzRUbTp+bOH26H4zqwXzcHkstDP7LoB5U2G7bydY0O/n21Rc1usT20lycWdM0/wGcUwVl",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,S={},U=[];function k(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Revoke Document"}),"\n",(0,i.jsx)(a(),{method:"post",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Revoke document API allows you to revoke specific document from your documents."}),"\n",(0,i.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(r(),{parameters:[{name:"document_id",in:"path",description:"Provide objectId of document to revoke",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,i.jsx)(l(),{title:"Body",body:{content:{"application/json":{schema:{type:"object",properties:{reason:{type:"string",example:""}},title:"revokedocument"}}}}}),"\n",(0,i.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document revoked successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},revokedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"revoke"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Document not found!"}},title:"inline_response_404_3"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(k,{...e})}):k(e)}}}]); \ No newline at end of file diff --git a/assets/js/52d5c0f9.5faf56ff.js b/assets/js/52d5c0f9.5faf56ff.js deleted file mode 100644 index 5ab190f61..000000000 --- a/assets/js/52d5c0f9.5faf56ff.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4469],{27668:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>g,contentTitle:()=>P,default:()=>y,frontMatter:()=>b,metadata:()=>n,toc:()=>h});const n=JSON.parse('{"id":"API-docs/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","source":"@site/docs/API-docs/deletedocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/deletedocument","permalink":"/docs/API-docs/deletedocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar_label":"Delete Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9Vttu20YQ/ZXJvjQGaEm+JEX5VLc2UqNBE9QuAtQRjBE5JDde7m52l7pA4Fu/pJ/WLymGF4myZCMB2rxI5PLMfefMrEXA3Iv4TlyapCpJBy+mkUjJJ07aII0WsbgtCC5JUSBIOxRcvL8GVMosPKxMBcGAo9LMCbylRGYy2UIzZ0oGuc2RH4lIGEsO2cJ1KmKRNvp7gIiERYclBXLs3VpoLIlhHeBepiISkr2zGArx2OX3zsxlSmBmnygJ1ymYbOtQMNCaE5Fw9LmSjlIRB1dRJHxYKTbkZWkVA2hplUlJxBkqz4CkoBJFvBZhZRtkcFLnIhKZcSWG4QktsdESC1uczopT9Kmo6ylb9dZoT571nE4m/LcbQF+OztMUfJUk5H1WKbV6ISKRGB04U/FaoLVKJk0ux588i6/33WwzwYl1nPkgW+N9gg4FtHX/pyU7b3+xZ6KO+lpdhOeFTienZ8cnk+PJ97cnr+PzH+JXr0eTyeRPEYllqVi2LyoGYr1BBrV9r/dgbc2GwO6kZvD5oTTemJJCIXUOC07mwhmdR2AVoScIbgWYo9SgMJD7D7NKzhn3fHa+zrN6ELXUSmq67+/Q/flkcn+yScL5M3dJmwCZqXT6bUM9ZP/5gM7vzzYBvdoP6FrPUcm0IaFb80D628YzNB9a8/u3Vbag5rvYCXZ43gbpKamcDKuG6ZbHaOVx+z2+mzJd8E0xW5Zs2DEUIhbjntPG6wEz1oJVunnPnZVTIhZFCNbH47FHnc7McmQsaS9zrXDmR4kpx2jleH4i6uixBFr7FWgfMJc6P35WaroN+oYL0+Z+J/RNBdDKX2kloj6zQ1Q3AwrClFxTBakz0wh3+X5nSd/IXDfVmp/sTYoPpBJTEg+FUBD08H/++ruR6NPaXKYX8K5yYM2CXFYpQJ1CpmgpZ4oODERPWCryXq1A6kC5Qx6gMpcBFXBWuPkTtDiTSvL1Y5hpJ+XgBvsRfCgoFOT403eOACGlOSm+taCMeWA9wQBWwZQ4HNIL4x4ydikChFnlpSbvwRP1IqQL1AlBX4sIjAPUQDqQs056ApQlgzPjgLJMJpIVc685TAKUqDEnNhYB+81ZsO3s9eDMrPIBvFFVEwhbLIlCG6ImSv0ILuWc2sCbDYECSkUp5BWriCAxKUHXehyGTmFGPoBl8zKhRqkP6AIompNr7l5TSZ6UYA1zgkTFC8CwtqwoONSep3a3nXSl2aTPOsMjt7GR4moEH/VHzbwNlSe+AErqBx9/1Mdwt7lmH2jmZaDpy74fFovFXh8c7cq8kaGoZuDImq1c3hw2XTMU37wciUgEcqV/l92Qm8uEuiZ8wua4AY87psSkYUoqUaq2x358LMCspWRC2tOA1y7evH8LczgbTUQ06PwvcHj89vrnq99urlgvc1PbfyejyWjCR9b4UKIemOp2zsvtUrjTuust5f9PK2pHQIGWYWwVyobIm5jXHQPficHKGg+302kkCuMDQ9brGXr6w6m65uPPFTmm+mkk5ugkzpin7tYilZ6f082q+WS0L3/vttYj+OJF92AsPcNqptc5qorfRCQeaPVo2a6nddTTLDvbIi6ShGwYyO5N3p3xdXn19ur2SkQCK07ekOEfGobvHtjAQdd2qb/1gX95Ch0UWK/b6VHXG3z76UmJLsYezXma1nX9L4AUmIY=","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Document","permalink":"/docs/API-docs/update-document"},"next":{"title":"Get Document list from status","permalink":"/docs/API-docs/getdocumentlist"}}');var c=o(74848),s=o(28453),l=o(33617),m=o.n(l),i=o(17543),d=o.n(i),p=o(86013),r=o.n(p),a=o(63723),u=o.n(a),I=(o(18766),o(79329),o(9303));const b={id:"deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu20YQ/ZXJvjQGaEm+JEX5VLc2UqNBE9QuAtQRjBE5JDde7m52l7pA4Fu/pJ/WLymGF4myZCMB2rxI5PLMfefMrEXA3Iv4TlyapCpJBy+mkUjJJ07aII0WsbgtCC5JUSBIOxRcvL8GVMosPKxMBcGAo9LMCbylRGYy2UIzZ0oGuc2RH4lIGEsO2cJ1KmKRNvp7gIiERYclBXLs3VpoLIlhHeBepiISkr2zGArx2OX3zsxlSmBmnygJ1ymYbOtQMNCaE5Fw9LmSjlIRB1dRJHxYKTbkZWkVA2hplUlJxBkqz4CkoBJFvBZhZRtkcFLnIhKZcSWG4QktsdESC1uczopT9Kmo6ylb9dZoT571nE4m/LcbQF+OztMUfJUk5H1WKbV6ISKRGB04U/FaoLVKJk0ux588i6/33WwzwYl1nPkgW+N9gg4FtHX/pyU7b3+xZ6KO+lpdhOeFTienZ8cnk+PJ97cnr+PzH+JXr0eTyeRPEYllqVi2LyoGYr1BBrV9r/dgbc2GwO6kZvD5oTTemJJCIXUOC07mwhmdR2AVoScIbgWYo9SgMJD7D7NKzhn3fHa+zrN6ELXUSmq67+/Q/flkcn+yScL5M3dJmwCZqXT6bUM9ZP/5gM7vzzYBvdoP6FrPUcm0IaFb80D628YzNB9a8/u3Vbag5rvYCXZ43gbpKamcDKuG6ZbHaOVx+z2+mzJd8E0xW5Zs2DEUIhbjntPG6wEz1oJVunnPnZVTIhZFCNbH47FHnc7McmQsaS9zrXDmR4kpx2jleH4i6uixBFr7FWgfMJc6P35WaroN+oYL0+Z+J/RNBdDKX2kloj6zQ1Q3AwrClFxTBakz0wh3+X5nSd/IXDfVmp/sTYoPpBJTEg+FUBD08H/++ruR6NPaXKYX8K5yYM2CXFYpQJ1CpmgpZ4oODERPWCryXq1A6kC5Qx6gMpcBFXBWuPkTtDiTSvL1Y5hpJ+XgBvsRfCgoFOT403eOACGlOSm+taCMeWA9wQBWwZQ4HNIL4x4ydikChFnlpSbvwRP1IqQL1AlBX4sIjAPUQDqQs056ApQlgzPjgLJMJpIVc685TAKUqDEnNhYB+81ZsO3s9eDMrPIBvFFVEwhbLIlCG6ImSv0ILuWc2sCbDYECSkUp5BWriCAxKUHXehyGTmFGPoBl8zKhRqkP6AIompNr7l5TSZ6UYA1zgkTFC8CwtqwoONSep3a3nXSl2aTPOsMjt7GR4moEH/VHzbwNlSe+AErqBx9/1Mdwt7lmH2jmZaDpy74fFovFXh8c7cq8kaGoZuDImq1c3hw2XTMU37wciUgEcqV/l92Qm8uEuiZ8wua4AY87psSkYUoqUaq2x358LMCspWRC2tOA1y7evH8LczgbTUQ06PwvcHj89vrnq99urlgvc1PbfyejyWjCR9b4UKIemOp2zsvtUrjTuust5f9PK2pHQIGWYWwVyobIm5jXHQPficHKGg+302kkCuMDQ9brGXr6w6m65uPPFTmm+mkk5ugkzpin7tYilZ6f082q+WS0L3/vttYj+OJF92AsPcNqptc5qorfRCQeaPVo2a6nddTTLDvbIi6ShGwYyO5N3p3xdXn19ur2SkQCK07ekOEfGobvHtjAQdd2qb/1gX95Ch0UWK/b6VHXG3z76UmJLsYezXma1nX9L4AUmIY=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},P=void 0,g={},h=[];function k(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(I.default,{as:"h1",className:"openapi__heading",children:"Delete Document"}),"\n",(0,c.jsx)(m(),{method:"delete",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,c.jsx)(t.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,c.jsx)(I.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,c.jsx)(d(),{parameters:[{name:"document_id",in:"path",description:"Provide objectId of document to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,c.jsx)(r(),{title:"Body",body:void 0}),"\n",(0,c.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Document not found!"}},title:"inline_response_404_3"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function y(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,c.jsx)(t,{...e,children:(0,c.jsx)(k,{...e})}):k(e)}}}]); \ No newline at end of file diff --git a/assets/js/52d5c0f9.b91649d3.js b/assets/js/52d5c0f9.b91649d3.js new file mode 100644 index 000000000..e3f3dca90 --- /dev/null +++ b/assets/js/52d5c0f9.b91649d3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4469],{27668:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>g,contentTitle:()=>P,default:()=>y,frontMatter:()=>b,metadata:()=>n,toc:()=>h});const n=JSON.parse('{"id":"API-docs/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","source":"@site/docs/API-docs/deletedocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/deletedocument","permalink":"/docs/API-docs/deletedocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar_label":"Delete Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9Vttu20YQ/ZXJvjQGaEm+JEX5VLc2UqNBE9QuAtQRjBE5JDde7m52l7pA4Fu/pJ/WLymGF4myZCMB2rxI5PLMfefMrEXA3Iv4TlyapCpJBy+mkUjJJ07aII0WsbgtCC5JUSBIOxRcvL8GVMosPKxMBcGAo9LMCbylRGYy2UIzZ0oGuc2RH4lIGEsO2cJ1KmKRNvp7gIiERYclBXLs3VpoLIlhHeBepiISkr2zGArx2OX3zsxlSmBmnygJ1ymYbOtQMNCaE5Fw9LmSjlIRB1dRJHxYKTbkZWkVA2hplUlJxBkqz4CkoBJFvBZhZRtkcFLnIhKZcSWG4QktsdESC1uczopT9Kmo6ylb9dZoT571nE4m/LcbQF+OztMUfJUk5H1WKbV6ISKRGB04U/FaoLVKJk0ux588i6/33WwzwYl1nPkgW+N9gg4FtHX/pyU7b3+xZ6KO+lpdhOeFTienZ8cnk+PJ97cnr+PzH+JXr0eTyeRPEYllqVi2LyoGYr1BBrV9r/dgbc2GwO6kZvD5oTTemJJCIXUOC07mwhmdR2AVoScIbgWYo9SgMJD7D7NKzhn3fHa+zrN6ELXUSmq67+/Q/flkcn+yScL5M3dJmwCZqXT6bUM9ZP/5gM7vzzYBvdoP6FrPUcm0IaFb80D628YzNB9a8/u3Vbag5rvYCXZ43gbpKamcDKuG6ZbHaOVx+z2+mzJd8E0xW5Zs2DEUIhbjntPG6wEz1oJVunnPnZVTIhZFCNbH47FHnc7McmQsaS9zrXDmR4kpx2jleH4i6uixBFr7FWgfMJc6P35WaroN+oYL0+Z+J/RNBdDKX2kloj6zQ1Q3AwrClFxTBakz0wh3+X5nSd/IXDfVmp/sTYoPpBJTEg+FUBD08H/++ruR6NPaXKYX8K5yYM2CXFYpQJ1CpmgpZ4oODERPWCryXq1A6kC5Qx6gMpcBFXBWuPkTtDiTSvL1Y5hpJ+XgBvsRfCgoFOT403eOACGlOSm+taCMeWA9wQBWwZQ4HNIL4x4ydikChFnlpSbvwRP1IqQL1AlBX4sIjAPUQDqQs056ApQlgzPjgLJMJpIVc685TAKUqDEnNhYB+81ZsO3s9eDMrPIBvFFVEwhbLIlCG6ImSv0ILuWc2sCbDYECSkUp5BWriCAxKUHXehyGTmFGPoBl8zKhRqkP6AIompNr7l5TSZ6UYA1zgkTFC8CwtqwoONSep3a3nXSl2aTPOsMjt7GR4moEH/VHzbwNlSe+AErqBx9/1Mdwt7lmH2jmZaDpy74fFovFXh8c7cq8kaGoZuDImq1c3hw2XTMU37wciUgEcqV/l92Qm8uEuiZ8wua4AY87psSkYUoqUaq2x358LMCspWRC2tOA1y7evH8LczgbTUQ06PwvcHj89vrnq99urlgvc1PbfyejyWjCR9b4UKIemOp2zsvtUrjTuust5f9PK2pHQIGWYWwVyobIm5jXHQPficHKGg+302kkCuMDQ9brGXr6w6m65uPPFTmm+mkk5ugkzpin7tYilZ6f082q+WS0L3/vttYj+OJF92AsPcNqptc5qorfRCQeaPVo2a6nddTTLDvbIi6ShGwYyO5N3p3xdXn19ur2SkQCK07ekOEfGobvHtjAQdd2qb/1gX95Ch0UWK/b6VHXG3z76UmJLsYezXma1nX9L4AUmIY=","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Revoke Document","permalink":"/docs/API-docs/revokedocument"},"next":{"title":"Get Document list from status","permalink":"/docs/API-docs/getdocumentlist"}}');var c=o(74848),s=o(28453),l=o(33617),m=o.n(l),i=o(17543),r=o.n(i),d=o(86013),p=o.n(d),a=o(63723),u=o.n(a),I=(o(18766),o(79329),o(9303));const b={id:"deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu20YQ/ZXJvjQGaEm+JEX5VLc2UqNBE9QuAtQRjBE5JDde7m52l7pA4Fu/pJ/WLymGF4myZCMB2rxI5PLMfefMrEXA3Iv4TlyapCpJBy+mkUjJJ07aII0WsbgtCC5JUSBIOxRcvL8GVMosPKxMBcGAo9LMCbylRGYy2UIzZ0oGuc2RH4lIGEsO2cJ1KmKRNvp7gIiERYclBXLs3VpoLIlhHeBepiISkr2zGArx2OX3zsxlSmBmnygJ1ymYbOtQMNCaE5Fw9LmSjlIRB1dRJHxYKTbkZWkVA2hplUlJxBkqz4CkoBJFvBZhZRtkcFLnIhKZcSWG4QktsdESC1uczopT9Kmo6ylb9dZoT571nE4m/LcbQF+OztMUfJUk5H1WKbV6ISKRGB04U/FaoLVKJk0ux588i6/33WwzwYl1nPkgW+N9gg4FtHX/pyU7b3+xZ6KO+lpdhOeFTienZ8cnk+PJ97cnr+PzH+JXr0eTyeRPEYllqVi2LyoGYr1BBrV9r/dgbc2GwO6kZvD5oTTemJJCIXUOC07mwhmdR2AVoScIbgWYo9SgMJD7D7NKzhn3fHa+zrN6ELXUSmq67+/Q/flkcn+yScL5M3dJmwCZqXT6bUM9ZP/5gM7vzzYBvdoP6FrPUcm0IaFb80D628YzNB9a8/u3Vbag5rvYCXZ43gbpKamcDKuG6ZbHaOVx+z2+mzJd8E0xW5Zs2DEUIhbjntPG6wEz1oJVunnPnZVTIhZFCNbH47FHnc7McmQsaS9zrXDmR4kpx2jleH4i6uixBFr7FWgfMJc6P35WaroN+oYL0+Z+J/RNBdDKX2kloj6zQ1Q3AwrClFxTBakz0wh3+X5nSd/IXDfVmp/sTYoPpBJTEg+FUBD08H/++ruR6NPaXKYX8K5yYM2CXFYpQJ1CpmgpZ4oODERPWCryXq1A6kC5Qx6gMpcBFXBWuPkTtDiTSvL1Y5hpJ+XgBvsRfCgoFOT403eOACGlOSm+taCMeWA9wQBWwZQ4HNIL4x4ydikChFnlpSbvwRP1IqQL1AlBX4sIjAPUQDqQs056ApQlgzPjgLJMJpIVc685TAKUqDEnNhYB+81ZsO3s9eDMrPIBvFFVEwhbLIlCG6ImSv0ILuWc2sCbDYECSkUp5BWriCAxKUHXehyGTmFGPoBl8zKhRqkP6AIompNr7l5TSZ6UYA1zgkTFC8CwtqwoONSep3a3nXSl2aTPOsMjt7GR4moEH/VHzbwNlSe+AErqBx9/1Mdwt7lmH2jmZaDpy74fFovFXh8c7cq8kaGoZuDImq1c3hw2XTMU37wciUgEcqV/l92Qm8uEuiZ8wua4AY87psSkYUoqUaq2x358LMCspWRC2tOA1y7evH8LczgbTUQ06PwvcHj89vrnq99urlgvc1PbfyejyWjCR9b4UKIemOp2zsvtUrjTuust5f9PK2pHQIGWYWwVyobIm5jXHQPficHKGg+302kkCuMDQ9brGXr6w6m65uPPFTmm+mkk5ugkzpin7tYilZ6f082q+WS0L3/vttYj+OJF92AsPcNqptc5qorfRCQeaPVo2a6nddTTLDvbIi6ShGwYyO5N3p3xdXn19ur2SkQCK07ekOEfGobvHtjAQdd2qb/1gX95Ch0UWK/b6VHXG3z76UmJLsYezXma1nX9L4AUmIY=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},P=void 0,g={},h=[];function k(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(I.default,{as:"h1",className:"openapi__heading",children:"Delete Document"}),"\n",(0,c.jsx)(m(),{method:"delete",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,c.jsx)(t.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,c.jsx)(I.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,c.jsx)(r(),{parameters:[{name:"document_id",in:"path",description:"Provide objectId of document to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,c.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,c.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Document not found!"}},title:"inline_response_404_3"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function y(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,c.jsx)(t,{...e,children:(0,c.jsx)(k,{...e})}):k(e)}}}]); \ No newline at end of file diff --git a/assets/js/a9f09360.929f06fd.js b/assets/js/a9f09360.49530215.js similarity index 98% rename from assets/js/a9f09360.929f06fd.js rename to assets/js/a9f09360.49530215.js index af3473468..41b3ba23d 100644 --- a/assets/js/a9f09360.929f06fd.js +++ b/assets/js/a9f09360.49530215.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3213],{20730:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>f,contentTitle:()=>x,default:()=>j,frontMatter:()=>y,metadata:()=>i,toc:()=>g});const i=JSON.parse('{"id":"API-docs/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","source":"@site/docs/API-docs/draftdocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/draftdocument","permalink":"/docs/API-docs/draftdocument","draft":false,"unlisted":false,"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 a base64 encoded file.","sidebar_label":"Draft Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztO11zGzmOfwXbL5m4WrKlOJmcnzaTzO35bmbsmjg1dWW7PFQ3JDHuJntItmWNS2/7S/an7S+5Aki2uvVhOx8766lTHmI1CZIgCIAACNwlTkxscnSevNNZXaJyNrlMkxxtZmTlpFbJUXI2RXhnxNhBBII3p8cgikLPLNQWjQWnYYIKjXAICmeQx+lgNIfK6BuZSzWBXDgBM+mmIGAkLL46BFSZzjGHsSywf6Eu1JmsjuBDVWiRw1zXBk7f/WczHy1Ebed7e+9wVE/gw/He3uU3U+cqe7S/L6qqrytUVk5UIUa2n+lyPyfAKh8/T2E2RYM0K2RCAQorizmIPIeZzCfobApuigoyXc0h09rkUgmHNoVKTBBUXY7Q2BSEyqHUBkEqEGBQ5POe073aIvz3+5OfYKxNKVwfTovaps1yuTSYuWLup3dTbHb1zEZqWGekmqRQimuil3TwWy2za9q2RZXTXxr45vSYabW3976uKm0c5vCL38LR3h71fIeFnoEwyPCZLkutoBJGlOj4wKbCcbfB32ppMA/HUhSRFkcXqgd7e25e4dHeHhyrXGZEDJ6QWkGPA2zfgxKRCPR9hZkcywDaIh1oBbOpzKZMk5nw51kVIvNoGrQVZk7eYHfi2xTmNPE7VDpiMNVG/q6VEwUfxw0aJzNRtI+NECRQ64RxRM5KS+Via1gB/jccD50eH0rgK0ItJ2KVUnGPRbgRRY02YDVLYUpY/YyVQcvMHuYlQqocpign063rifxjbV1nYqgtodnGIqwVT4nJi0y2sSgsghx3aFmKa2ytBpqFWBR9+G4OOY5FXbgUJHGcMzX24SftQFRVITMxKpA4F0h4hKsN9viUAzsERJQo+YxPWabRgoBcjsdoSDipk6cIYyJ2xGdLJcCS46ZCgVYrB53pQpt1FuLmLh0h08qhcn14cyNkwcj7zVqQKivqHGFUiOw6hVFRYwoGcy+4cyTFlXp+ZxAQNtCc6QMWC+JCrQh/pcPy0oINWOV9OJtKu5Qn6oyk5kWkbVM1SO1Y08pEgihigKWQRcqES+GjHoGTrsCUBLYSap6SxsQUHN66kb5NIZtids2/jMilhlHtnFZ+Y7nRVa5nKtByrJWz8vcNEhl7Pp2iwxQOU3iVwusUBgcpDIYpDA5TGLxKYfA6heFBCsNhCsPDFIavPFrD12lU+ZHAbQQGQ09l9+ehLundH6RlySaFaRsdPOvo4EEf9vYaaaK2X3/99ULdXSiAi4SE6yI5goukAblIUt9HOpP6BuH7lj5eDL8Nn3P6fDV8HT5nDDo4DJ9T+hwOLtQiLHihhoyJE2V1DxbU/VUxCF+BiaiNF6W2qM+okRRRGjvorDr4UMeivZcXtBeppJOisNu3EyGe0I6WKK1t6pA2xey6fUfc/YS208aHelhN+i5Wq62uKPCMxXBt9y/74WbZvnm/7JPZewudL9v6K+ZmPYIzUk3b999orydEhFWcvowS3/bZAGDNvJ0OAeAJUaGL0ZfR4DXRgC6l7QSg3ie0+xY61BFueN93cNgbvOwND4aHHQqQb+QByrKX5735fP41qEc2T1ieTJ5ooXrLjvzSsdHlBveDvYMlVLCJ+Hc02X8kQ30UbVjMye9jxyJaLI3H17aync7F/Jn1U8WhjXFG8EvTbN5Ck7sID/Z+s6mWWUCeYKJJNiIHr0806BHd8/0ff9xvUdI39sqyt9JInz0mfKuxLPt53l+BXDsd31hCnqew3ryxPc+hLMstzb79ImGT6j+I9YMltp37A8AfJQBLPu8ufK9wUDxAq4LXZidts3SsXCFTqUJHYBVYATA4qQth8Ja8TSu18tBfX3Ki4CztdfZO2bFj39+TAr45CTb588DUtIXuBNTy8Li1nbUnMTjBW54jq63TJSEjc0EzpGDrbErem4imP9F9Gafhr0xUkqIEBTrHreiy/iYk/Km1PGw61VUH26LrbEZYiCM3+Nh8/MzegwO+3oKDcc/9FiCekIpfQYk6fbiCus8vklKwBUBchsvf2k3RXCSXzRjvVWP+wNjLR8jRVOZYiBEW612PloH2XgI/tQhDHaVUTSSA8T1IW53idqXT9y02yJbfcZupoxKPohFJDIW0MRbSpVd7dAgWcQhPIXJUcIQQB1DINUrul7J5g9jj+NxrgXA4DyxBcMCATaAurvbACp2DaROG5iilkmVdNhHHcTNrJFkZbvM2vWgkRbLjCu3TXVtB3D6wAoX3ti9woQYcGYgRhXtsvQDxhJTBCkr3y+nnqInOHfmVLreHBTBuqy2AG65EAvWXYSN8drv09eGELiCKcvpBFLfKMqwcxbi+VDQblB99BXEUyEe2vuPI1nbOa8e/nhD3bUDrX8yBAe6P4cL29v5EnNhB+9Hc6ON4pZjc4+xy9xPiv4DPyuEmaaIrevuUWh3nyVGS02tpfNxLUp4ZrftO5/Pk6C4JgXb6GcLYNHL/o6Xn1rvEZlMsBf2KGNEDLb2PJmnC8RZ6oyUiJUeJHn3EjNaoDOHgJFoaydBHdxHKPysmafC+k6PEvzcmaYK3oqwIOFl5kK3ycbKIC943VdOynMryj+Z9k+ahl7vPnOYnGrpYeZb+rJnetWbgvZV4pt9q6nP4Tsxta15/vSerr+E0hpg/C6MgF3NL8lRbb4llosjqgjx5vK2kmTdhBXbnW1zR4Nus1OA7eLlI+VkATRslYYyYJ2kiHZbt9i1MYPSnn1yGmijDsd1PHftR4wjxr6GB3t754EX5yVh81Agj5EOvplp98vjB8MVgOHgxGNIM4VHm8+noe9cx6DLGG/JBMY/WeW/5jpoCv2X0H+LRCM/bFhN8mBnPtr2vt5717FTXRU4PZihMn5+5PzuDosvfzR3Uf4CbF2ly+/BmbiHTvfh4D98UOHZQVxUayLRRaJ63I3hPZnPDw8NFmswf3t78T7m9b+nwZg/v7hfOelhmhPw7cH3xepEm04dx/a8mL+PfiOzhq8Xydk0yg8JhvByuRjqfX0W9tXgIMF4UBDfWRY6GrJB1fbVUNaRhKJ/oalXPj7QuUKgNiqbzIB9yv8gYJDswhLBnUyRbemkj8uxLszRYjR5beuTHlQijtGT9mRovkj4cj1tGLgcIVnMCIiy/zysNz3i9K1uzGn+2H76JRs/auU+UjrIM3UcUGBgcllXByUMzWRSEN93rfWj+sbnXUJIQiNdlXPjhq+Ktj2TygmFQN/MGgsXYh7dCNdkX3SwHuLtr2IC5Y7GAuzs6VTRXdOkuFumygdbqNPC96lsMZihvOqOaJlwObNpaQ72Jc0Umjm8Ir2FtBORESTW5qk2xWPTX2HB5Ro+m2xqZwtnRJP8PKEboHKsTk6N5hOQej72fpuEZMeuzEBVnykhjXZBHz+4BYf+4tYXKIYuB3LvvG/m29cgSlIrzLeXHGTmZIGUYBggeHHKCUGRTrxkYKzEm0easQYM3Utc2ojcVtjG5c4KQXlykmnTdzBZ1OGWrvff+JtFVlER0cnb6CFqyE9zzmsh7kH6Xfg44OTulPEQ5Dh5dHz7YhhKRtKIDAuRrwY0UMVepMd/mPk6Jiini1WYnabQfMgB7sI5QLu1GjNLlS0mTt7s28TJRlY5I144yZGVIv7IOK9uhI2PREPJM14/hygcoKWBS80Oro1s5qkZ+vVnmEUplnal9jBby2sTUycAWBJmhtUs6RaoQUGv+FFBZP1zAWFiHJoVaSaK8qSlE0kyJtxUaiSrDjSQw6ElHkvuwNusm5X34+YeQnhz3EIVyRBLoJ8Yc6oq5hiWhSRaNJ7e69Y26I6ithxGkC5pTOkN4vkJjtQJKxTQToeTvnoXZ6dCWPLapKDxoUBX0TE34kIR3kYnm1D///o8WXlvdznXE/Aoiz+nN8AEMOUTmGZ5C8wYr0oC6ixHNh+avq3YeYcdCc1XqvBEk+3geP6UMYmcbveg0Z5xjgT5BPr5hNvrWplHH2uA50lOm4SdHIrbTFe0Xb6V1rXTHmJSwrh9+RqJj1sKBPQ2SauJ5NW8LeINXSKtcTsc2oOymyjaW7oostCzWTjDMX/Rs0S6DW0ETU/a3Vtb73MODA/rTpWhTfxCsYKId8fm4Lor5X5L08ZG1+x3+Blu50Y6+z4mffpTD32+zm+EpMc4WPXDvBMHnqE1BNQUkGL3mDJgfW7SVqpAKr5jEV7nOrgzaq+HBwdWAaLxIk8NNZHyvS3RTZh0i5sxoKjmoChSUAm/mICZCKiAz2HxFqqIx2tzvl3waZhsoEXno6rBDhJfrRDhW/PDLpSxn+hrVH7vT9vLOL0+o3pbMMF4/J9IDcX/S2Wy73W/SYlYb6ebJ0fldctsTlez5/qPzy8VlmhBhNQWnK20ZY+GmyVGyvxqrtmhuOOp4fufZt+FIK1ROj7NrnrCo5P7NIFmkqyM2+s1boa0TE6kmvXtHXS53+p5OwxO8s99lmK+S/4MU5wvkbEOliSQumKIgM5oISIf88zJQ/308qhhM3xQfXx7JasQ7Brw7MezVG2JDVHpzUHrwshUOPo+RXQ7WNrHaTeHXZusxoNrEU1sh0laE9HzJsk0wMsYiBxzEGx4ecrTr2wGHhV685ojL4asFM9ky+pAk3QgDP6is+slJ0vX/4qDGuwmjlia6f93r2JqhqWt7xZkaW6djcKzaG1vv/i1Xf7T3pBpr5rfABCcVqvdkTpNU3wzWg2RYZLpsKhYi+D///g8eEZmHl/kLnNQGKj1DM6592cO4wFtJBmyr/C6GYFCUBVpbzIHs1gkX4uVywplP0SrMRCVGspCkpghM+yeJlqazffhlGcR5ZnwS2A0WpN2g0Jqr0siCqZ0ueY14Jc+0uR4TSinV9lEhE9llFjEOQTUVKqM4kBdftmmoCo/s7MpIiyBkScBk7+N4LDPJd71WzojMQSmUmLBxknKwjqhQxTIko0fkLlld1N4hoGIoROe3yM+jfXhHDhhvnJ9i0NGx594XsKn3xYL4hCq/Efm9FS0vM7TLdNECb9CwuvKedF0UUGnnvVuyztpnSxM5I5Slez88A4WjacgXLHZeIxfzPtAbKV2HZLcSAxRSXfuavPOGzX7BkZUOl4HK2Wy2pjqfd8f8TbppPSIbWC/HTbiRFW17ePPxnPQSmtKejN+juZFZtFS2rLnPwPvhRhU+JhaFTVRyo5VdyAyVxdb99+Zvpz/ADbzoHyRp67J4BML7Pxy//f6n99/TvHSdefkb9A/6B/y6oq0rhWot1S1wXZXc1pvtrhx2Vw67K4fdlcPuymH/PAWbu3LYXTnsrhx2Vw67K4fdlcP+64iwK4fdlcPuymF35bC7cthdOeyuHHZXDrsrh92Vw+7KYXflsF+vGHFXDrsrh92Vwz51TtyVw8YkErIK96tCSNVKhvOJR+crRbKXaTKlxKSj8+Tujl7/PlDyOzX/VqOhrKbLNLkRRlKMm3Oa0pi8Q1kr10jpI299yL53Rsunntv5wXkllYtyj/yIN3zq98K2c6dOT96fJWkSqxVKndMYI2ZU5CtmPu8kEJMrMAWXThVCTWpOokn8nJRvJGo37SYrXXOyUvjRysURat7CsJvF5LdB/9OmNg64u/OJUItFA++7to4IhI3QdHyXi8Xi/wBnLvtg","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"}}');var s=t(74848),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),h=t.n(c),p=t(63723),m=t.n(p),u=(t(18766),t(79329),t(9303));const y={id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztO11zGzmOfwXbL5m4WrKlOJmcnzaTzO35bmbsmjg1dWW7PFQ3JDHuJntItmWNS2/7S/an7S+5Aki2uvVhOx8766lTHmI1CZIgCIAACNwlTkxscnSevNNZXaJyNrlMkxxtZmTlpFbJUXI2RXhnxNhBBII3p8cgikLPLNQWjQWnYYIKjXAICmeQx+lgNIfK6BuZSzWBXDgBM+mmIGAkLL46BFSZzjGHsSywf6Eu1JmsjuBDVWiRw1zXBk7f/WczHy1Ebed7e+9wVE/gw/He3uU3U+cqe7S/L6qqrytUVk5UIUa2n+lyPyfAKh8/T2E2RYM0K2RCAQorizmIPIeZzCfobApuigoyXc0h09rkUgmHNoVKTBBUXY7Q2BSEyqHUBkEqEGBQ5POe073aIvz3+5OfYKxNKVwfTovaps1yuTSYuWLup3dTbHb1zEZqWGekmqRQimuil3TwWy2za9q2RZXTXxr45vSYabW3976uKm0c5vCL38LR3h71fIeFnoEwyPCZLkutoBJGlOj4wKbCcbfB32ppMA/HUhSRFkcXqgd7e25e4dHeHhyrXGZEDJ6QWkGPA2zfgxKRCPR9hZkcywDaIh1oBbOpzKZMk5nw51kVIvNoGrQVZk7eYHfi2xTmNPE7VDpiMNVG/q6VEwUfxw0aJzNRtI+NECRQ64RxRM5KS+Via1gB/jccD50eH0rgK0ItJ2KVUnGPRbgRRY02YDVLYUpY/YyVQcvMHuYlQqocpign063rifxjbV1nYqgtodnGIqwVT4nJi0y2sSgsghx3aFmKa2ytBpqFWBR9+G4OOY5FXbgUJHGcMzX24SftQFRVITMxKpA4F0h4hKsN9viUAzsERJQo+YxPWabRgoBcjsdoSDipk6cIYyJ2xGdLJcCS46ZCgVYrB53pQpt1FuLmLh0h08qhcn14cyNkwcj7zVqQKivqHGFUiOw6hVFRYwoGcy+4cyTFlXp+ZxAQNtCc6QMWC+JCrQh/pcPy0oINWOV9OJtKu5Qn6oyk5kWkbVM1SO1Y08pEgihigKWQRcqES+GjHoGTrsCUBLYSap6SxsQUHN66kb5NIZtids2/jMilhlHtnFZ+Y7nRVa5nKtByrJWz8vcNEhl7Pp2iwxQOU3iVwusUBgcpDIYpDA5TGLxKYfA6heFBCsNhCsPDFIavPFrD12lU+ZHAbQQGQ09l9+ehLundH6RlySaFaRsdPOvo4EEf9vYaaaK2X3/99ULdXSiAi4SE6yI5goukAblIUt9HOpP6BuH7lj5eDL8Nn3P6fDV8HT5nDDo4DJ9T+hwOLtQiLHihhoyJE2V1DxbU/VUxCF+BiaiNF6W2qM+okRRRGjvorDr4UMeivZcXtBeppJOisNu3EyGe0I6WKK1t6pA2xey6fUfc/YS208aHelhN+i5Wq62uKPCMxXBt9y/74WbZvnm/7JPZewudL9v6K+ZmPYIzUk3b999orydEhFWcvowS3/bZAGDNvJ0OAeAJUaGL0ZfR4DXRgC6l7QSg3ie0+xY61BFueN93cNgbvOwND4aHHQqQb+QByrKX5735fP41qEc2T1ieTJ5ooXrLjvzSsdHlBveDvYMlVLCJ+Hc02X8kQ30UbVjMye9jxyJaLI3H17aync7F/Jn1U8WhjXFG8EvTbN5Ck7sID/Z+s6mWWUCeYKJJNiIHr0806BHd8/0ff9xvUdI39sqyt9JInz0mfKuxLPt53l+BXDsd31hCnqew3ryxPc+hLMstzb79ImGT6j+I9YMltp37A8AfJQBLPu8ufK9wUDxAq4LXZidts3SsXCFTqUJHYBVYATA4qQth8Ja8TSu18tBfX3Ki4CztdfZO2bFj39+TAr45CTb588DUtIXuBNTy8Li1nbUnMTjBW54jq63TJSEjc0EzpGDrbErem4imP9F9Gafhr0xUkqIEBTrHreiy/iYk/Km1PGw61VUH26LrbEZYiCM3+Nh8/MzegwO+3oKDcc/9FiCekIpfQYk6fbiCus8vklKwBUBchsvf2k3RXCSXzRjvVWP+wNjLR8jRVOZYiBEW612PloH2XgI/tQhDHaVUTSSA8T1IW53idqXT9y02yJbfcZupoxKPohFJDIW0MRbSpVd7dAgWcQhPIXJUcIQQB1DINUrul7J5g9jj+NxrgXA4DyxBcMCATaAurvbACp2DaROG5iilkmVdNhHHcTNrJFkZbvM2vWgkRbLjCu3TXVtB3D6wAoX3ti9woQYcGYgRhXtsvQDxhJTBCkr3y+nnqInOHfmVLreHBTBuqy2AG65EAvWXYSN8drv09eGELiCKcvpBFLfKMqwcxbi+VDQblB99BXEUyEe2vuPI1nbOa8e/nhD3bUDrX8yBAe6P4cL29v5EnNhB+9Hc6ON4pZjc4+xy9xPiv4DPyuEmaaIrevuUWh3nyVGS02tpfNxLUp4ZrftO5/Pk6C4JgXb6GcLYNHL/o6Xn1rvEZlMsBf2KGNEDLb2PJmnC8RZ6oyUiJUeJHn3EjNaoDOHgJFoaydBHdxHKPysmafC+k6PEvzcmaYK3oqwIOFl5kK3ycbKIC943VdOynMryj+Z9k+ahl7vPnOYnGrpYeZb+rJnetWbgvZV4pt9q6nP4Tsxta15/vSerr+E0hpg/C6MgF3NL8lRbb4llosjqgjx5vK2kmTdhBXbnW1zR4Nus1OA7eLlI+VkATRslYYyYJ2kiHZbt9i1MYPSnn1yGmijDsd1PHftR4wjxr6GB3t754EX5yVh81Agj5EOvplp98vjB8MVgOHgxGNIM4VHm8+noe9cx6DLGG/JBMY/WeW/5jpoCv2X0H+LRCM/bFhN8mBnPtr2vt5717FTXRU4PZihMn5+5PzuDosvfzR3Uf4CbF2ly+/BmbiHTvfh4D98UOHZQVxUayLRRaJ63I3hPZnPDw8NFmswf3t78T7m9b+nwZg/v7hfOelhmhPw7cH3xepEm04dx/a8mL+PfiOzhq8Xydk0yg8JhvByuRjqfX0W9tXgIMF4UBDfWRY6GrJB1fbVUNaRhKJ/oalXPj7QuUKgNiqbzIB9yv8gYJDswhLBnUyRbemkj8uxLszRYjR5beuTHlQijtGT9mRovkj4cj1tGLgcIVnMCIiy/zysNz3i9K1uzGn+2H76JRs/auU+UjrIM3UcUGBgcllXByUMzWRSEN93rfWj+sbnXUJIQiNdlXPjhq+Ktj2TygmFQN/MGgsXYh7dCNdkX3SwHuLtr2IC5Y7GAuzs6VTRXdOkuFumygdbqNPC96lsMZihvOqOaJlwObNpaQ72Jc0Umjm8Ir2FtBORESTW5qk2xWPTX2HB5Ro+m2xqZwtnRJP8PKEboHKsTk6N5hOQej72fpuEZMeuzEBVnykhjXZBHz+4BYf+4tYXKIYuB3LvvG/m29cgSlIrzLeXHGTmZIGUYBggeHHKCUGRTrxkYKzEm0easQYM3Utc2ojcVtjG5c4KQXlykmnTdzBZ1OGWrvff+JtFVlER0cnb6CFqyE9zzmsh7kH6Xfg44OTulPEQ5Dh5dHz7YhhKRtKIDAuRrwY0UMVepMd/mPk6Jiini1WYnabQfMgB7sI5QLu1GjNLlS0mTt7s28TJRlY5I144yZGVIv7IOK9uhI2PREPJM14/hygcoKWBS80Oro1s5qkZ+vVnmEUplnal9jBby2sTUycAWBJmhtUs6RaoQUGv+FFBZP1zAWFiHJoVaSaK8qSlE0kyJtxUaiSrDjSQw6ElHkvuwNusm5X34+YeQnhz3EIVyRBLoJ8Yc6oq5hiWhSRaNJ7e69Y26I6ithxGkC5pTOkN4vkJjtQJKxTQToeTvnoXZ6dCWPLapKDxoUBX0TE34kIR3kYnm1D///o8WXlvdznXE/Aoiz+nN8AEMOUTmGZ5C8wYr0oC6ixHNh+avq3YeYcdCc1XqvBEk+3geP6UMYmcbveg0Z5xjgT5BPr5hNvrWplHH2uA50lOm4SdHIrbTFe0Xb6V1rXTHmJSwrh9+RqJj1sKBPQ2SauJ5NW8LeINXSKtcTsc2oOymyjaW7oostCzWTjDMX/Rs0S6DW0ETU/a3Vtb73MODA/rTpWhTfxCsYKId8fm4Lor5X5L08ZG1+x3+Blu50Y6+z4mffpTD32+zm+EpMc4WPXDvBMHnqE1BNQUkGL3mDJgfW7SVqpAKr5jEV7nOrgzaq+HBwdWAaLxIk8NNZHyvS3RTZh0i5sxoKjmoChSUAm/mICZCKiAz2HxFqqIx2tzvl3waZhsoEXno6rBDhJfrRDhW/PDLpSxn+hrVH7vT9vLOL0+o3pbMMF4/J9IDcX/S2Wy73W/SYlYb6ebJ0fldctsTlez5/qPzy8VlmhBhNQWnK20ZY+GmyVGyvxqrtmhuOOp4fufZt+FIK1ROj7NrnrCo5P7NIFmkqyM2+s1boa0TE6kmvXtHXS53+p5OwxO8s99lmK+S/4MU5wvkbEOliSQumKIgM5oISIf88zJQ/308qhhM3xQfXx7JasQ7Brw7MezVG2JDVHpzUHrwshUOPo+RXQ7WNrHaTeHXZusxoNrEU1sh0laE9HzJsk0wMsYiBxzEGx4ecrTr2wGHhV685ojL4asFM9ky+pAk3QgDP6is+slJ0vX/4qDGuwmjlia6f93r2JqhqWt7xZkaW6djcKzaG1vv/i1Xf7T3pBpr5rfABCcVqvdkTpNU3wzWg2RYZLpsKhYi+D///g8eEZmHl/kLnNQGKj1DM6592cO4wFtJBmyr/C6GYFCUBVpbzIHs1gkX4uVywplP0SrMRCVGspCkpghM+yeJlqazffhlGcR5ZnwS2A0WpN2g0Jqr0siCqZ0ueY14Jc+0uR4TSinV9lEhE9llFjEOQTUVKqM4kBdftmmoCo/s7MpIiyBkScBk7+N4LDPJd71WzojMQSmUmLBxknKwjqhQxTIko0fkLlld1N4hoGIoROe3yM+jfXhHDhhvnJ9i0NGx594XsKn3xYL4hCq/Efm9FS0vM7TLdNECb9CwuvKedF0UUGnnvVuyztpnSxM5I5Slez88A4WjacgXLHZeIxfzPtAbKV2HZLcSAxRSXfuavPOGzX7BkZUOl4HK2Wy2pjqfd8f8TbppPSIbWC/HTbiRFW17ePPxnPQSmtKejN+juZFZtFS2rLnPwPvhRhU+JhaFTVRyo5VdyAyVxdb99+Zvpz/ADbzoHyRp67J4BML7Pxy//f6n99/TvHSdefkb9A/6B/y6oq0rhWot1S1wXZXc1pvtrhx2Vw67K4fdlcPuymH/PAWbu3LYXTnsrhx2Vw67K4fdlcP+64iwK4fdlcPuymF35bC7cthdOeyuHHZXDrsrh92Vw+7KYXflsF+vGHFXDrsrh92Vwz51TtyVw8YkErIK96tCSNVKhvOJR+crRbKXaTKlxKSj8+Tujl7/PlDyOzX/VqOhrKbLNLkRRlKMm3Oa0pi8Q1kr10jpI299yL53Rsunntv5wXkllYtyj/yIN3zq98K2c6dOT96fJWkSqxVKndMYI2ZU5CtmPu8kEJMrMAWXThVCTWpOokn8nJRvJGo37SYrXXOyUvjRysURat7CsJvF5LdB/9OmNg64u/OJUItFA++7to4IhI3QdHyXi8Xi/wBnLvtg",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,f={},g=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Draft Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/draftdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.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,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.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,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"iob Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio Button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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 "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{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},x:{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},y:{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},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{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},email_subject:{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:""},email_body:{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:""},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"draftdocument_body"}}},required:!0}}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{document_id:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-send-document.com"}},title:"inline_draft_doc_res_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3213],{20730:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>f,contentTitle:()=>x,default:()=>j,frontMatter:()=>y,metadata:()=>i,toc:()=>g});const i=JSON.parse('{"id":"API-docs/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","source":"@site/docs/API-docs/draftdocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/draftdocument","permalink":"/docs/API-docs/draftdocument","draft":false,"unlisted":false,"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 a base64 encoded file.","sidebar_label":"Draft Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztO11zGzmOfwXbL5m4WrKlOJmcnzaTzO35bmbsmjg1dWW7PFQ3JDHuJntItmWNS2/7S/an7S+5Aki2uvVhOx8766lTHmI1CZIgCIAACNwlTkxscnSevNNZXaJyNrlMkxxtZmTlpFbJUXI2RXhnxNhBBII3p8cgikLPLNQWjQWnYYIKjXAICmeQx+lgNIfK6BuZSzWBXDgBM+mmIGAkLL46BFSZzjGHsSywf6Eu1JmsjuBDVWiRw1zXBk7f/WczHy1Ebed7e+9wVE/gw/He3uU3U+cqe7S/L6qqrytUVk5UIUa2n+lyPyfAKh8/T2E2RYM0K2RCAQorizmIPIeZzCfobApuigoyXc0h09rkUgmHNoVKTBBUXY7Q2BSEyqHUBkEqEGBQ5POe073aIvz3+5OfYKxNKVwfTovaps1yuTSYuWLup3dTbHb1zEZqWGekmqRQimuil3TwWy2za9q2RZXTXxr45vSYabW3976uKm0c5vCL38LR3h71fIeFnoEwyPCZLkutoBJGlOj4wKbCcbfB32ppMA/HUhSRFkcXqgd7e25e4dHeHhyrXGZEDJ6QWkGPA2zfgxKRCPR9hZkcywDaIh1oBbOpzKZMk5nw51kVIvNoGrQVZk7eYHfi2xTmNPE7VDpiMNVG/q6VEwUfxw0aJzNRtI+NECRQ64RxRM5KS+Via1gB/jccD50eH0rgK0ItJ2KVUnGPRbgRRY02YDVLYUpY/YyVQcvMHuYlQqocpign063rifxjbV1nYqgtodnGIqwVT4nJi0y2sSgsghx3aFmKa2ytBpqFWBR9+G4OOY5FXbgUJHGcMzX24SftQFRVITMxKpA4F0h4hKsN9viUAzsERJQo+YxPWabRgoBcjsdoSDipk6cIYyJ2xGdLJcCS46ZCgVYrB53pQpt1FuLmLh0h08qhcn14cyNkwcj7zVqQKivqHGFUiOw6hVFRYwoGcy+4cyTFlXp+ZxAQNtCc6QMWC+JCrQh/pcPy0oINWOV9OJtKu5Qn6oyk5kWkbVM1SO1Y08pEgihigKWQRcqES+GjHoGTrsCUBLYSap6SxsQUHN66kb5NIZtids2/jMilhlHtnFZ+Y7nRVa5nKtByrJWz8vcNEhl7Pp2iwxQOU3iVwusUBgcpDIYpDA5TGLxKYfA6heFBCsNhCsPDFIavPFrD12lU+ZHAbQQGQ09l9+ehLundH6RlySaFaRsdPOvo4EEf9vYaaaK2X3/99ULdXSiAi4SE6yI5goukAblIUt9HOpP6BuH7lj5eDL8Nn3P6fDV8HT5nDDo4DJ9T+hwOLtQiLHihhoyJE2V1DxbU/VUxCF+BiaiNF6W2qM+okRRRGjvorDr4UMeivZcXtBeppJOisNu3EyGe0I6WKK1t6pA2xey6fUfc/YS208aHelhN+i5Wq62uKPCMxXBt9y/74WbZvnm/7JPZewudL9v6K9o6qaYzUk3b999orydEhFWcvowS3/bZAGDNvJ0OAeAJUaGL0ZfR4DXRgC6l7QSg3ie0+xY61BFueN93cNgbvOwND4aHHQqQb+QByrKX5735fP41qEc2T1ieTJ5ooXrLjvzSsdHlBveDvYMlVLCJ+Hc02X8kQ30UbVjMye9jxyJaLI3H17aync7F/Jn1U8WhjXFG8EvTbN5Ck7sID/Z+s6mWWUCeYKJJNiIHr0806BHd8/0ff9xvUdI39sqyt9JInz0mfKuxLPt53l+BXDsd31hCnqew3ryxPc+hLMstzb79ImGT6j+I9YMltp37A8AfJQBLPu8ufK9wUDxAq4LXZidts3SsXCFTqUJHYBVYATA4qQth8Ja8TSu18tBfX3Ki4CztdfZO2bFj39+TAr45CTb588DUtIXuBNTy8Li1nbUnMTjBW54jq63TJSEjc0EzpGDrbErem4imP9F9Gafhr0xUkqIEBTrHreiy/iYk/Km1PGw61VUH26LrbEZYiCM3+Nh8/MzegwO+3oKDcc/9FiCekIpfQYk6fbiCus8vklKwBUBchsvf2k3RXCSXzRjvVWP+wNjLR8jRVOZYiBEW612PloH2XgI/tQhDHaVUTSSA8T1IW53idqXT9y02yJbfcZupoxKPohFJDIW0MRbSpVd7dAgWcQhPIXJUcIQQB1DINUrul7J5g9jj+NxrgXA4DyxBcMCATaAurvbACp2DaROG5iilkmVdNhHHcTNrJFkZbvM2vWgkRbLjCu3TXVtB3D6wAoX3ti9woQYcGYgRhXtsvQDxhJTBCkr3y+nnqInOHfmVLreHBTBuqy2AG65EAvWXYSN8drv09eGELiCKcvpBFLfKMqwcxbi+VDQblB99BXEUyEe2vuPI1nbOa8e/nhD3bUDrX8yBAe6P4cL29v5EnNhB+9Hc6ON4pZjc4+xy9xPiv4DPyuEmaaIrevuUWh3nyVGS02tpfNxLUp4ZrftO5/Pk6C4JgXb6GcLYNHL/o6Xn1rvEZlMsBf2KGNEDLb2PJmnC8RZ6oyUiJUeJHn3EjNaoDOHgJFoaydBHdxHKPysmafC+k6PEvzcmaYK3oqwIOFl5kK3ycbKIC943VdOynMryj+Z9k+ahl7vPnOYnGrpYeZb+rJnetWbgvZV4pt9q6nP4Tsxta15/vSerr+E0hpg/C6MgF3NL8lRbb4llosjqgjx5vK2kmTdhBXbnW1zR4Nus1OA7eLlI+VkATRslYYyYJ2kiHZbt9i1MYPSnn1yGmijDsd1PHftR4wjxr6GB3t754EX5yVh81Agj5EOvplp98vjB8MVgOHgxGNIM4VHm8+noe9cx6DLGG/JBMY/WeW/5jpoCv2X0H+LRCM/bFhN8mBnPtr2vt5717FTXRU4PZihMn5+5PzuDosvfzR3Uf4CbF2ly+/BmbiHTvfh4D98UOHZQVxUayLRRaJ63I3hPZnPDw8NFmswf3t78T7m9b+nwZg/v7hfOelhmhPw7cH3xepEm04dx/a8mL+PfiOzhq8Xydk0yg8JhvByuRjqfX0W9tXgIMF4UBDfWRY6GrJB1fbVUNaRhKJ/oalXPj7QuUKgNiqbzIB9yv8gYJDswhLBnUyRbemkj8uxLszRYjR5beuTHlQijtGT9mRovkj4cj1tGLgcIVnMCIiy/zysNz3i9K1uzGn+2H76JRs/auU+UjrIM3UcUGBgcllXByUMzWRSEN93rfWj+sbnXUJIQiNdlXPjhq+Ktj2TygmFQN/MGgsXYh7dCNdkX3SwHuLtr2IC5Y7GAuzs6VTRXdOkuFumygdbqNPC96lsMZihvOqOaJlwObNpaQ72Jc0Umjm8Ir2FtBORESTW5qk2xWPTX2HB5Ro+m2xqZwtnRJP8PKEboHKsTk6N5hOQej72fpuEZMeuzEBVnykhjXZBHz+4BYf+4tYXKIYuB3LvvG/m29cgSlIrzLeXHGTmZIGUYBggeHHKCUGRTrxkYKzEm0easQYM3Utc2ojcVtjG5c4KQXlykmnTdzBZ1OGWrvff+JtFVlER0cnb6CFqyE9zzmsh7kH6Xfg44OTulPEQ5Dh5dHz7YhhKRtKIDAuRrwY0UMVepMd/mPk6Jiini1WYnabQfMgB7sI5QLu1GjNLlS0mTt7s28TJRlY5I144yZGVIv7IOK9uhI2PREPJM14/hygcoKWBS80Oro1s5qkZ+vVnmEUplnal9jBby2sTUycAWBJmhtUs6RaoQUGv+FFBZP1zAWFiHJoVaSaK8qSlE0kyJtxUaiSrDjSQw6ElHkvuwNusm5X34+YeQnhz3EIVyRBLoJ8Yc6oq5hiWhSRaNJ7e69Y26I6ithxGkC5pTOkN4vkJjtQJKxTQToeTvnoXZ6dCWPLapKDxoUBX0TE34kIR3kYnm1D///o8WXlvdznXE/Aoiz+nN8AEMOUTmGZ5C8wYr0oC6ixHNh+avq3YeYcdCc1XqvBEk+3geP6UMYmcbveg0Z5xjgT5BPr5hNvrWplHH2uA50lOm4SdHIrbTFe0Xb6V1rXTHmJSwrh9+RqJj1sKBPQ2SauJ5NW8LeINXSKtcTsc2oOymyjaW7oostCzWTjDMX/Rs0S6DW0ETU/a3Vtb73MODA/rTpWhTfxCsYKId8fm4Lor5X5L08ZG1+x3+Blu50Y6+z4mffpTD32+zm+EpMc4WPXDvBMHnqE1BNQUkGL3mDJgfW7SVqpAKr5jEV7nOrgzaq+HBwdWAaLxIk8NNZHyvS3RTZh0i5sxoKjmoChSUAm/mICZCKiAz2HxFqqIx2tzvl3waZhsoEXno6rBDhJfrRDhW/PDLpSxn+hrVH7vT9vLOL0+o3pbMMF4/J9IDcX/S2Wy73W/SYlYb6ebJ0fldctsTlez5/qPzy8VlmhBhNQWnK20ZY+GmyVGyvxqrtmhuOOp4fufZt+FIK1ROj7NrnrCo5P7NIFmkqyM2+s1boa0TE6kmvXtHXS53+p5OwxO8s99lmK+S/4MU5wvkbEOliSQumKIgM5oISIf88zJQ/308qhhM3xQfXx7JasQ7Brw7MezVG2JDVHpzUHrwshUOPo+RXQ7WNrHaTeHXZusxoNrEU1sh0laE9HzJsk0wMsYiBxzEGx4ecrTr2wGHhV685ojL4asFM9ky+pAk3QgDP6is+slJ0vX/4qDGuwmjlia6f93r2JqhqWt7xZkaW6djcKzaG1vv/i1Xf7T3pBpr5rfABCcVqvdkTpNU3wzWg2RYZLpsKhYi+D///g8eEZmHl/kLnNQGKj1DM6592cO4wFtJBmyr/C6GYFCUBVpbzIHs1gkX4uVywplP0SrMRCVGspCkpghM+yeJlqazffhlGcR5ZnwS2A0WpN2g0Jqr0siCqZ0ueY14Jc+0uR4TSinV9lEhE9llFjEOQTUVKqM4kBdftmmoCo/s7MpIiyBkScBk7+N4LDPJd71WzojMQSmUmLBxknKwjqhQxTIko0fkLlld1N4hoGIoROe3yM+jfXhHDhhvnJ9i0NGx594XsKn3xYL4hCq/Efm9FS0vM7TLdNECb9CwuvKedF0UUGnnvVuyztpnSxM5I5Slez88A4WjacgXLHZeIxfzPtAbKV2HZLcSAxRSXfuavPOGzX7BkZUOl4HK2Wy2pjqfd8f8TbppPSIbWC/HTbiRFW17ePPxnPQSmtKejN+juZFZtFS2rLnPwPvhRhU+JhaFTVRyo5VdyAyVxdb99+Zvpz/ADbzoHyRp67J4BML7Pxy//f6n99/TvHSdefkb9A/6B/y6oq0rhWot1S1wXZXc1pvtrhx2Vw67K4fdlcPuymH/PAWbu3LYXTnsrhx2Vw67K4fdlcP+64iwK4fdlcPuymF35bC7cthdOeyuHHZXDrsrh92Vw+7KYXflsF+vGHFXDrsrh92Vwz51TtyVw8YkErIK96tCSNVKhvOJR+crRbKXaTKlxKSj8+Tujl7/PlDyOzX/VqOhrKbLNLkRRlKMm3Oa0pi8Q1kr10jpI299yL53Rsunntv5wXkllYtyj/yIN3zq98K2c6dOT96fJWkSqxVKndMYI2ZU5CtmPu8kEJMrMAWXThVCTWpOokn8nJRvJGo37SYrXXOyUvjRysURat7CsJvF5LdB/9OmNg64u/OJUItFA++7to4IhI3QdHyXi8Xi/wDJbfti","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"}}');var s=t(74848),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),h=t.n(c),p=t(63723),m=t.n(p),u=(t(18766),t(79329),t(9303));const y={id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztO11zGzmOfwXbL5m4WrKlOJmcnzaTzO35bmbsmjg1dWW7PFQ3JDHuJntItmWNS2/7S/an7S+5Aki2uvVhOx8766lTHmI1CZIgCIAACNwlTkxscnSevNNZXaJyNrlMkxxtZmTlpFbJUXI2RXhnxNhBBII3p8cgikLPLNQWjQWnYYIKjXAICmeQx+lgNIfK6BuZSzWBXDgBM+mmIGAkLL46BFSZzjGHsSywf6Eu1JmsjuBDVWiRw1zXBk7f/WczHy1Ebed7e+9wVE/gw/He3uU3U+cqe7S/L6qqrytUVk5UIUa2n+lyPyfAKh8/T2E2RYM0K2RCAQorizmIPIeZzCfobApuigoyXc0h09rkUgmHNoVKTBBUXY7Q2BSEyqHUBkEqEGBQ5POe073aIvz3+5OfYKxNKVwfTovaps1yuTSYuWLup3dTbHb1zEZqWGekmqRQimuil3TwWy2za9q2RZXTXxr45vSYabW3976uKm0c5vCL38LR3h71fIeFnoEwyPCZLkutoBJGlOj4wKbCcbfB32ppMA/HUhSRFkcXqgd7e25e4dHeHhyrXGZEDJ6QWkGPA2zfgxKRCPR9hZkcywDaIh1oBbOpzKZMk5nw51kVIvNoGrQVZk7eYHfi2xTmNPE7VDpiMNVG/q6VEwUfxw0aJzNRtI+NECRQ64RxRM5KS+Via1gB/jccD50eH0rgK0ItJ2KVUnGPRbgRRY02YDVLYUpY/YyVQcvMHuYlQqocpign063rifxjbV1nYqgtodnGIqwVT4nJi0y2sSgsghx3aFmKa2ytBpqFWBR9+G4OOY5FXbgUJHGcMzX24SftQFRVITMxKpA4F0h4hKsN9viUAzsERJQo+YxPWabRgoBcjsdoSDipk6cIYyJ2xGdLJcCS46ZCgVYrB53pQpt1FuLmLh0h08qhcn14cyNkwcj7zVqQKivqHGFUiOw6hVFRYwoGcy+4cyTFlXp+ZxAQNtCc6QMWC+JCrQh/pcPy0oINWOV9OJtKu5Qn6oyk5kWkbVM1SO1Y08pEgihigKWQRcqES+GjHoGTrsCUBLYSap6SxsQUHN66kb5NIZtids2/jMilhlHtnFZ+Y7nRVa5nKtByrJWz8vcNEhl7Pp2iwxQOU3iVwusUBgcpDIYpDA5TGLxKYfA6heFBCsNhCsPDFIavPFrD12lU+ZHAbQQGQ09l9+ehLundH6RlySaFaRsdPOvo4EEf9vYaaaK2X3/99ULdXSiAi4SE6yI5goukAblIUt9HOpP6BuH7lj5eDL8Nn3P6fDV8HT5nDDo4DJ9T+hwOLtQiLHihhoyJE2V1DxbU/VUxCF+BiaiNF6W2qM+okRRRGjvorDr4UMeivZcXtBeppJOisNu3EyGe0I6WKK1t6pA2xey6fUfc/YS208aHelhN+i5Wq62uKPCMxXBt9y/74WbZvnm/7JPZewudL9v6K9o6qaYzUk3b999orydEhFWcvowS3/bZAGDNvJ0OAeAJUaGL0ZfR4DXRgC6l7QSg3ie0+xY61BFueN93cNgbvOwND4aHHQqQb+QByrKX5735fP41qEc2T1ieTJ5ooXrLjvzSsdHlBveDvYMlVLCJ+Hc02X8kQ30UbVjMye9jxyJaLI3H17aync7F/Jn1U8WhjXFG8EvTbN5Ck7sID/Z+s6mWWUCeYKJJNiIHr0806BHd8/0ff9xvUdI39sqyt9JInz0mfKuxLPt53l+BXDsd31hCnqew3ryxPc+hLMstzb79ImGT6j+I9YMltp37A8AfJQBLPu8ufK9wUDxAq4LXZidts3SsXCFTqUJHYBVYATA4qQth8Ja8TSu18tBfX3Ki4CztdfZO2bFj39+TAr45CTb588DUtIXuBNTy8Li1nbUnMTjBW54jq63TJSEjc0EzpGDrbErem4imP9F9Gafhr0xUkqIEBTrHreiy/iYk/Km1PGw61VUH26LrbEZYiCM3+Nh8/MzegwO+3oKDcc/9FiCekIpfQYk6fbiCus8vklKwBUBchsvf2k3RXCSXzRjvVWP+wNjLR8jRVOZYiBEW612PloH2XgI/tQhDHaVUTSSA8T1IW53idqXT9y02yJbfcZupoxKPohFJDIW0MRbSpVd7dAgWcQhPIXJUcIQQB1DINUrul7J5g9jj+NxrgXA4DyxBcMCATaAurvbACp2DaROG5iilkmVdNhHHcTNrJFkZbvM2vWgkRbLjCu3TXVtB3D6wAoX3ti9woQYcGYgRhXtsvQDxhJTBCkr3y+nnqInOHfmVLreHBTBuqy2AG65EAvWXYSN8drv09eGELiCKcvpBFLfKMqwcxbi+VDQblB99BXEUyEe2vuPI1nbOa8e/nhD3bUDrX8yBAe6P4cL29v5EnNhB+9Hc6ON4pZjc4+xy9xPiv4DPyuEmaaIrevuUWh3nyVGS02tpfNxLUp4ZrftO5/Pk6C4JgXb6GcLYNHL/o6Xn1rvEZlMsBf2KGNEDLb2PJmnC8RZ6oyUiJUeJHn3EjNaoDOHgJFoaydBHdxHKPysmafC+k6PEvzcmaYK3oqwIOFl5kK3ycbKIC943VdOynMryj+Z9k+ahl7vPnOYnGrpYeZb+rJnetWbgvZV4pt9q6nP4Tsxta15/vSerr+E0hpg/C6MgF3NL8lRbb4llosjqgjx5vK2kmTdhBXbnW1zR4Nus1OA7eLlI+VkATRslYYyYJ2kiHZbt9i1MYPSnn1yGmijDsd1PHftR4wjxr6GB3t754EX5yVh81Agj5EOvplp98vjB8MVgOHgxGNIM4VHm8+noe9cx6DLGG/JBMY/WeW/5jpoCv2X0H+LRCM/bFhN8mBnPtr2vt5717FTXRU4PZihMn5+5PzuDosvfzR3Uf4CbF2ly+/BmbiHTvfh4D98UOHZQVxUayLRRaJ63I3hPZnPDw8NFmswf3t78T7m9b+nwZg/v7hfOelhmhPw7cH3xepEm04dx/a8mL+PfiOzhq8Xydk0yg8JhvByuRjqfX0W9tXgIMF4UBDfWRY6GrJB1fbVUNaRhKJ/oalXPj7QuUKgNiqbzIB9yv8gYJDswhLBnUyRbemkj8uxLszRYjR5beuTHlQijtGT9mRovkj4cj1tGLgcIVnMCIiy/zysNz3i9K1uzGn+2H76JRs/auU+UjrIM3UcUGBgcllXByUMzWRSEN93rfWj+sbnXUJIQiNdlXPjhq+Ktj2TygmFQN/MGgsXYh7dCNdkX3SwHuLtr2IC5Y7GAuzs6VTRXdOkuFumygdbqNPC96lsMZihvOqOaJlwObNpaQ72Jc0Umjm8Ir2FtBORESTW5qk2xWPTX2HB5Ro+m2xqZwtnRJP8PKEboHKsTk6N5hOQej72fpuEZMeuzEBVnykhjXZBHz+4BYf+4tYXKIYuB3LvvG/m29cgSlIrzLeXHGTmZIGUYBggeHHKCUGRTrxkYKzEm0easQYM3Utc2ojcVtjG5c4KQXlykmnTdzBZ1OGWrvff+JtFVlER0cnb6CFqyE9zzmsh7kH6Xfg44OTulPEQ5Dh5dHz7YhhKRtKIDAuRrwY0UMVepMd/mPk6Jiini1WYnabQfMgB7sI5QLu1GjNLlS0mTt7s28TJRlY5I144yZGVIv7IOK9uhI2PREPJM14/hygcoKWBS80Oro1s5qkZ+vVnmEUplnal9jBby2sTUycAWBJmhtUs6RaoQUGv+FFBZP1zAWFiHJoVaSaK8qSlE0kyJtxUaiSrDjSQw6ElHkvuwNusm5X34+YeQnhz3EIVyRBLoJ8Yc6oq5hiWhSRaNJ7e69Y26I6ithxGkC5pTOkN4vkJjtQJKxTQToeTvnoXZ6dCWPLapKDxoUBX0TE34kIR3kYnm1D///o8WXlvdznXE/Aoiz+nN8AEMOUTmGZ5C8wYr0oC6ixHNh+avq3YeYcdCc1XqvBEk+3geP6UMYmcbveg0Z5xjgT5BPr5hNvrWplHH2uA50lOm4SdHIrbTFe0Xb6V1rXTHmJSwrh9+RqJj1sKBPQ2SauJ5NW8LeINXSKtcTsc2oOymyjaW7oostCzWTjDMX/Rs0S6DW0ETU/a3Vtb73MODA/rTpWhTfxCsYKId8fm4Lor5X5L08ZG1+x3+Blu50Y6+z4mffpTD32+zm+EpMc4WPXDvBMHnqE1BNQUkGL3mDJgfW7SVqpAKr5jEV7nOrgzaq+HBwdWAaLxIk8NNZHyvS3RTZh0i5sxoKjmoChSUAm/mICZCKiAz2HxFqqIx2tzvl3waZhsoEXno6rBDhJfrRDhW/PDLpSxn+hrVH7vT9vLOL0+o3pbMMF4/J9IDcX/S2Wy73W/SYlYb6ebJ0fldctsTlez5/qPzy8VlmhBhNQWnK20ZY+GmyVGyvxqrtmhuOOp4fufZt+FIK1ROj7NrnrCo5P7NIFmkqyM2+s1boa0TE6kmvXtHXS53+p5OwxO8s99lmK+S/4MU5wvkbEOliSQumKIgM5oISIf88zJQ/308qhhM3xQfXx7JasQ7Brw7MezVG2JDVHpzUHrwshUOPo+RXQ7WNrHaTeHXZusxoNrEU1sh0laE9HzJsk0wMsYiBxzEGx4ecrTr2wGHhV685ojL4asFM9ky+pAk3QgDP6is+slJ0vX/4qDGuwmjlia6f93r2JqhqWt7xZkaW6djcKzaG1vv/i1Xf7T3pBpr5rfABCcVqvdkTpNU3wzWg2RYZLpsKhYi+D///g8eEZmHl/kLnNQGKj1DM6592cO4wFtJBmyr/C6GYFCUBVpbzIHs1gkX4uVywplP0SrMRCVGspCkpghM+yeJlqazffhlGcR5ZnwS2A0WpN2g0Jqr0siCqZ0ueY14Jc+0uR4TSinV9lEhE9llFjEOQTUVKqM4kBdftmmoCo/s7MpIiyBkScBk7+N4LDPJd71WzojMQSmUmLBxknKwjqhQxTIko0fkLlld1N4hoGIoROe3yM+jfXhHDhhvnJ9i0NGx594XsKn3xYL4hCq/Efm9FS0vM7TLdNECb9CwuvKedF0UUGnnvVuyztpnSxM5I5Slez88A4WjacgXLHZeIxfzPtAbKV2HZLcSAxRSXfuavPOGzX7BkZUOl4HK2Wy2pjqfd8f8TbppPSIbWC/HTbiRFW17ePPxnPQSmtKejN+juZFZtFS2rLnPwPvhRhU+JhaFTVRyo5VdyAyVxdb99+Zvpz/ADbzoHyRp67J4BML7Pxy//f6n99/TvHSdefkb9A/6B/y6oq0rhWot1S1wXZXc1pvtrhx2Vw67K4fdlcPuymH/PAWbu3LYXTnsrhx2Vw67K4fdlcP+64iwK4fdlcPuymF35bC7cthdOeyuHHZXDrsrh92Vw+7KYXflsF+vGHFXDrsrh92Vwz51TtyVw8YkErIK96tCSNVKhvOJR+crRbKXaTKlxKSj8+Tujl7/PlDyOzX/VqOhrKbLNLkRRlKMm3Oa0pi8Q1kr10jpI299yL53Rsunntv5wXkllYtyj/yIN3zq98K2c6dOT96fJWkSqxVKndMYI2ZU5CtmPu8kEJMrMAWXThVCTWpOokn8nJRvJGo37SYrXXOyUvjRysURat7CsJvF5LdB/9OmNg64u/OJUItFA++7to4IhI3QdHyXi8Xi/wDJbfti",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,f={},g=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Draft Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/draftdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.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,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.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,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio Button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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 "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{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},x:{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},y:{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},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{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},email_subject:{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:""},email_body:{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:""},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"draftdocument_body"}}},required:!0}}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{document_id:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-send-document.com"}},title:"inline_draft_doc_res_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/ae010e44.245776e2.js b/assets/js/ae010e44.af652df7.js similarity index 50% rename from assets/js/ae010e44.245776e2.js rename to assets/js/ae010e44.af652df7.js index 2671bab1a..1c7b72731 100644 --- a/assets/js/ae010e44.245776e2.js +++ b/assets/js/ae010e44.af652df7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6685],{73320:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>f,contentTitle:()=>x,default:()=>b,frontMatter:()=>g,metadata:()=>s,toc:()=>y});const s=JSON.parse('{"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":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJztG11zG7fxr2zvxbHmSIm07Lh8qmOnrVsn9kTKZDKSRgHvljxYOOAC4EQyGs7koT+jfclPyy/pLD6Od/wQ7STTqC39IPOABbC7WCz2C3eJZVOTjC6SVyqrS5TWJFdpkqPJNK8sVzIZJecFgkExMXwq4cW71zBFiZpZNMDg66/egC2YBZRsLNDARCMauxAIBM/lFNQEGORh/j58q2rImAQmjAIuM1HnCMotxgRUGns5TrjEHGY8n6I1KcwKnhVgCz8najcec25BacB5xWQOdaUkMAMSMce8D+cFN1Bpdctzh2jEBucVao4yo8lKLpgGq9zcP//4zzMi8VtVa6L35x//BROhZsCl639boXQArKr6l/JSnvNqBF9XQrEcFqrW8O7VnxtCaVZquzg6eoXjegpfvz46uvqksLYyo+NjmkNVKAktwcamn6nyOCfAKp88JpJRI83qaWWGiwWwvMUUW6CETFULyJTSOZe0IylUbIog63KM2qRAnCmVRqKBgUaWL3pW9WqD8Lezt1/CROmS2T68E7VJm+VyrjGzYuGnJ9ojVY8MjJnBZ6dgrOZymkLJboit3ML3Nc9uiGyDMo9MffHutePV0dFZXVVKW8zhG0/C6OiIej5D4jHT6OAzVZZKQsU0K9GiNl66qFvj9zXXTi5sAUyIyIvRpezB0ZFdVDg6OoLXMueZE0+akFpJBD1s34MSkwj0rMKMT3gAbbEOlAxSRzyZMb+flWCZR1OjqTCz/Ba7E89TWNDEr1CqiEGhNP9BScuE245b1JZnTLS3jRB04m2ZtsTOSnFpY2tYoTk5tHtuU4JcEWo5Mavk0vUYhFsmajQBq1kKBWH1FVYaDZ3yOC8xUuZQIJ8WO9dj+fva2M7EUBtCs41FWCvukmMvOrZNmDAIfNLhZclusLVaowH68NkCcpywWtgUOEmc1TX24Utl6eQJnpGiIcl1Z5rZWmPP7XIQh4CIZKXb43crHZDzyQQ1HU7qdFOEMRE7kjOvNIg8d3JswSQoubbRmRJKb4qQa+7yETIlrdN8L24ZFw55T6xp1N9YsOwmhbGoMQWNuT+4CxRCzVIv7w6EFJznueMPqWWSQiUJf6nC8tyACVg1ijCeJ+pslC0twk2bq+HUThStTCyIRwywZFykjnEpvFdjsNwKTOnAVkwuUsiZxRQszu1YzVPICsxuxmoe+DVR0hr+w5ZTF3s+nmvDFE5TeJbC8xQGJykMhikMTlMYPEth8DyF4UkKw2EKw9MUhs88T4fPAz9Zw8Q2AoOh56R9WBwk/fmGG3dCSfGZRpfOOrp00Iejo+ZUUNt33313Ke8uJcBlQofkMhnBZdKAXCap7yPdR32D8D2njyfDT8Pngj6fDZ+Hz5kDHZyGz4I+h4NLuQwLXsqhw8SysroHC+r+TTEIX0FQqM0tSm1RL1EjKZQ0dtB+dPChjmWblidEC5fccibMbnIixAOiaIXSBlGnRJQTyd0Uue4HRE4bH+px6s53OfXY6oqH2mEx3KD+aT/cELuJ98s+GNpb6Pw60p85aVZjOCf1s5v+RkM9ICas4/TrOPFp313kTvvu5kMAeEBc6GL063jwnHhAF89uBlDvA6K+hQ51hFvc952c9gZPe8OT4WmHA+TjeICy7OV5b7FY/BbcI7smLE9mTbQ0vYXGLMJEq3KLG+Gs/BVUsHvc72h6f0EG9zjaophHH7SxShrPrW0tW5WzxSPjp4pDGwOM4Ffm16KFpusiPJwXmxWKZwF5golm15gctT7xoEd8z4+/+OK4xUnf2CvL3lojffYc41uNZdnP8/4a5Mbu+MYS8jyFzeat7XkOZVnuaPbtl4kzqf5Ioh+srd3SHwD+UwdgJefdhe89HOTXKync2s7Z2n461q6QgsvQEUQF1gA0TmvBNM7JazRcSQ/925+ceHBWNrnzMp2D5nx4zwr45G2wux8HoSYSuhNQy/5xG5S1J9E4xbmbI6uNVSUhw3NGM6Rg6qwgL4xF8574voq3uK+MVZy8fYHWula0WX8bEn7XWp4y7eq6o2zQdohhBuLILb6y234n3oMTd70FJ+Ke+y1APCAVv4YSdfqwA3VfXCYlcxYASRmufitboL5Mrpox3jvGfM/Yqw84RwXPUbAxis2uDz4DbVqCPLUYQx0ll41H7/A9SVudbL7W6fuWW86Wp7gt1FGJx6MRWQyCmxjT6PKrPToEfVwojgKsJJdjhDgAxo0Y/moxbxD7MDn3WiBszp4lCA4cYBNwa3zs+1fobEybMTRHySUv67KJHE6aWSPLynCbt/lFI2uDOq7Q3t2NFdh8zwoUptu9wKUcuMgAL9n0HkPPdT8gNRDwWZPvJE1URfkHruTrPBklMTeRpG5SNPYzlS+S0V0SYkj0M0RoaNDxe0N5jbvEZAWWjH5FZCgTMuECkzTxmQaTpIlzOCgtQpxKRokav8fMJildmxUFc9HQHG7c6C5C+fh4kgbzMxklPnCepAnOWVkRcGgClJkiI6/KJ8kyLnjfVE3LairjfjSBepqHQtC/cJovaehyLRP0i2Z61ZrB0VbiuXqpqM/iK7YwrXm9fCfrCSgaQ+c3C6MgZwtDYbfaeFWUMZHVgkxZnFdcLxq72tmzDUta+DYrNfgOni7jprcw2rHXWn38BmWoiAEuhvGxY98rHCP+KTRQrsjtLys/Gov3CmGMbm+rQsmPHj8YPhkMB08GQ5ohBB9bczCt2SJJE26xNPv56Hs3Meju/wuytTCPt1BvFfdPwcXs+vtEMcI7stkU98vc+a58UCtEbQpVi5yCv8h036VlfnHGryvGtIijtr9HaJdpMt9PzBwy1YvJJvhE4MRCXVWUSFVaon7c9lQfDHHD09Nlmiz2k7f4ryTvU9q82X7qvnFZulUG8/fA9cnzZZoU+3H9a5NH/B2RPX22XF2iSaaRWYx3wPVY5YvrqLeWbcBoRnRBw42wpBVFjposjk19tVI1BEn57+t1PT9WSiCTWxRNJ7nk/ErjzFYyikOoZlYgOTcra9bNbhozPJjQ3mShhBWuedLckKWna7xM+vB6suKlN4TX81sR1uW3pIJHbr1rUzs1/ug4fBOHHrVz9ZQ+XYWoIgoOGCyWlXDJ7hkXgvCm67sPzT9n2jWcJATidRkX3n9VvPQeu1swDOpmiiGYiH14yWSTSexm7ODurhECJx3LJdzd0a6ivqZLd7lMVw20VqfB3au+RWOG/LYzqmnC1cCmrTXUWzLXZMn4hhD1bSPgS1quay2Wy/6GGK726IP5tsGmsHc0yf8Dx1wN07mq9QccXOdh9vzh8Q6OF2w/CTCY1i5ya0n9RRl04aBVgQGXxuraO32Q1zrWVMRipUqrDI3phxKKHuTc+Cxzge35U0Bp/HAGE2Ys6hRqyaVFreuKPMLN+qcO/W6BJXlQvviHWLRfbLqZfKoF83VLrVKteNjjxBhKtYIx31SRxLKpddK3atcgH/sRJE3oaj2Cv1+hNkpS2ZjSUyb5D84j9NadMmQaF0x4UC/5nOLehA8p2S4y8d76+R8/tfDaad9vIuZXYHlOQcg9GDovn9x543x9jZVYgFVdjGg+1H9av1CTvdecvwlXXnBQvlTlpKTxtvrw5IT+65IRywYhXLMUH6Vtm9RCLP6QpB/ugt/vKPjm7ZfvfZZ/8Z4Pf5hnt8N3tEU7ZPreCYKhUmtBhXPEuV5Ty7jOWy4Fl3gd2XY9PDm5HhBvl2lyuo19Z6pEW7gqEWLiTCsqqasEMirx0gtgU8Yl0LWpf0NuotZK32/HfBxm9zHhtMOEp5tMeC1dQNSVlp6rG5T/WUrby1u/PKE6L52seDWTcA/k+pMOse12T6TBrNbcLpLRxV0y77GK93z/6OJqeZUmxFhFgatKGYcxs0UySo5bcSyD+paCTzSDE9pGDg2TOcUrN4xmVvHj20GyTNdHbDWxd0Iby6ZcTnv3jrpaEXlGG+F53SF1FRGo+N+RQgKBk22oNOEkAAWynGzsZZrQ/n61CuJ9Hncphte2Rcxaum0tBhZDYJ2o1rom3hKn2h6mGjxtB4h8CMhFdZqgzrY4TUN4jLw0gZdWLKUVSrlYyWoTtYhBi4Hz9oenp84t/nTg/Mcnz51rdvpsedXxUpKk64m4IOu6PZ0kXTvRfbesIJ/qWLMK4szNLdy5Ctdvwt23Em3/RDlZCRvYlFjTYbwdbPrCKDJVNkV2Efznf/zkRsSNd7riD/C21lCpGepJ7Sv1JgLnnMwnAl7ztJCVAo0RCyCraUr17ZDzqUvkRZskYxUbc8FJuxCY8gHGloIyffhm5as90j6neYuClBIIpVyxtFXAaqtKt0a8QWdK31C5OVVtw5jqa8kqMIhxCMqCubL1cPRSMhKoOJysvEpzg8B4ScBkbeJkwjPurmYlrWaZhZJJNkVaLHU+OXGhqZDXakxZCqNE7c1RqtFFtJ5ESvqYPryigmdHuAusoqWtzb0laqiSMacQrBP+UHw+JieiouV5hmZV/SDwFrVTNd6VqIWASpHK50yQLdTeW5rIaiYN3dQhqBu2pmFfsBfdGjlb9IHSHnSLkdVEAiC4vPGl4heNmH2DY8MtruIRs9lsQ+097o75C7dFPSYLTK3GTV2jU5Lt4c3HY9IpqEvzdnKG+pZn0bbYseaxAz4OFyHzrm88UKziW0+T4BlKg61r68Vf3r2BW3jSP0nSlqL/AISP37x++fmXZ5/TvHQV+fM36J/0T1wQVRlbMtla6gzFBM789bWWNWju8sNTksNTksNTksNTksNTksNTksNTksNTksNTksNTksNTksNTksNTkt+t0vbwlOTwlOTwlOTwlGR/CfzhKcnhKcnhKcnhKcnhKcnhKcn/zlOSkGsljXhcCcZlq07EJ+YvVg9MrtKkoJz96CK5u6Pg9ddUR0bN39eoKeF/lSa3THMK37h0fxqT25TXvUHKsL700ajeOa2cem3kkjprVQ6Um/cjXmQZVvZe2HZZwbu3Z+dJmsTCv1LlNEazGT2QYTOfvw18dJls5qqQBZPT2qWZEz8n5eNZbYtuMv/GJfPDj1a2mslFC8Nult+TQX+JqK0D7u58ocBy2cD7rp0jAmMjNO3c1XK5/Dd89pc+","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"}}');var i=t(74848),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const g={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:"eJztG11zG7fxr2zvxbHmSIm07Lh8qmOnrVsn9kTKZDKSRgHvljxYOOAC4EQyGs7koT+jfclPyy/pLD6Od/wQ7STTqC39IPOABbC7WCz2C3eJZVOTjC6SVyqrS5TWJFdpkqPJNK8sVzIZJecFgkExMXwq4cW71zBFiZpZNMDg66/egC2YBZRsLNDARCMauxAIBM/lFNQEGORh/j58q2rImAQmjAIuM1HnCMotxgRUGns5TrjEHGY8n6I1KcwKnhVgCz8najcec25BacB5xWQOdaUkMAMSMce8D+cFN1Bpdctzh2jEBucVao4yo8lKLpgGq9zcP//4zzMi8VtVa6L35x//BROhZsCl639boXQArKr6l/JSnvNqBF9XQrEcFqrW8O7VnxtCaVZquzg6eoXjegpfvz46uvqksLYyo+NjmkNVKAktwcamn6nyOCfAKp88JpJRI83qaWWGiwWwvMUUW6CETFULyJTSOZe0IylUbIog63KM2qRAnCmVRqKBgUaWL3pW9WqD8Lezt1/CROmS2T68E7VJm+VyrjGzYuGnJ9ojVY8MjJnBZ6dgrOZymkLJboit3ML3Nc9uiGyDMo9MffHutePV0dFZXVVKW8zhG0/C6OiIej5D4jHT6OAzVZZKQsU0K9GiNl66qFvj9zXXTi5sAUyIyIvRpezB0ZFdVDg6OoLXMueZE0+akFpJBD1s34MSkwj0rMKMT3gAbbEOlAxSRzyZMb+flWCZR1OjqTCz/Ba7E89TWNDEr1CqiEGhNP9BScuE245b1JZnTLS3jRB04m2ZtsTOSnFpY2tYoTk5tHtuU4JcEWo5Mavk0vUYhFsmajQBq1kKBWH1FVYaDZ3yOC8xUuZQIJ8WO9dj+fva2M7EUBtCs41FWCvukmMvOrZNmDAIfNLhZclusLVaowH68NkCcpywWtgUOEmc1TX24Utl6eQJnpGiIcl1Z5rZWmPP7XIQh4CIZKXb43crHZDzyQQ1HU7qdFOEMRE7kjOvNIg8d3JswSQoubbRmRJKb4qQa+7yETIlrdN8L24ZFw55T6xp1N9YsOwmhbGoMQWNuT+4CxRCzVIv7w6EFJznueMPqWWSQiUJf6nC8tyACVg1ijCeJ+pslC0twk2bq+HUThStTCyIRwywZFykjnEpvFdjsNwKTOnAVkwuUsiZxRQszu1YzVPICsxuxmoe+DVR0hr+w5ZTF3s+nmvDFE5TeJbC8xQGJykMhikMTlMYPEth8DyF4UkKw2EKw9MUhs88T4fPAz9Zw8Q2AoOh56R9WBwk/fmGG3dCSfGZRpfOOrp00Iejo+ZUUNt33313Ke8uJcBlQofkMhnBZdKAXCap7yPdR32D8D2njyfDT8Pngj6fDZ+Hz5kDHZyGz4I+h4NLuQwLXsqhw8SysroHC+r+TTEIX0FQqM0tSm1RL1EjKZQ0dtB+dPChjmWblidEC5fccibMbnIixAOiaIXSBlGnRJQTyd0Uue4HRE4bH+px6s53OfXY6oqH2mEx3KD+aT/cELuJ98s+GNpb6Pw60p85aVZjOCf1s5v+RkM9ICas4/TrOPFp313kTvvu5kMAeEBc6GL063jwnHhAF89uBlDvA6K+hQ51hFvc952c9gZPe8OT4WmHA+TjeICy7OV5b7FY/BbcI7smLE9mTbQ0vYXGLMJEq3KLG+Gs/BVUsHvc72h6f0EG9zjaophHH7SxShrPrW0tW5WzxSPjp4pDGwOM4Ffm16KFpusiPJwXmxWKZwF5golm15gctT7xoEd8z4+/+OK4xUnf2CvL3lojffYc41uNZdnP8/4a5Mbu+MYS8jyFzeat7XkOZVnuaPbtl4kzqf5Ioh+srd3SHwD+UwdgJefdhe89HOTXKync2s7Z2n461q6QgsvQEUQF1gA0TmvBNM7JazRcSQ/925+ceHBWNrnzMp2D5nx4zwr45G2wux8HoSYSuhNQy/5xG5S1J9E4xbmbI6uNVSUhw3NGM6Rg6qwgL4xF8574voq3uK+MVZy8fYHWula0WX8bEn7XWp4y7eq6o2zQdohhBuLILb6y234n3oMTd70FJ+Ke+y1APCAVv4YSdfqwA3VfXCYlcxYASRmufitboL5Mrpox3jvGfM/Yqw84RwXPUbAxis2uDz4DbVqCPLUYQx0ll41H7/A9SVudbL7W6fuWW86Wp7gt1FGJx6MRWQyCmxjT6PKrPToEfVwojgKsJJdjhDgAxo0Y/moxbxD7MDn3WiBszp4lCA4cYBNwa3zs+1fobEybMTRHySUv67KJHE6aWSPLynCbt/lFI2uDOq7Q3t2NFdh8zwoUptu9wKUcuMgAL9n0HkPPdT8gNRDwWZPvJE1URfkHruTrPBklMTeRpG5SNPYzlS+S0V0SYkj0M0RoaNDxe0N5jbvEZAWWjH5FZCgTMuECkzTxmQaTpIlzOCgtQpxKRokav8fMJildmxUFc9HQHG7c6C5C+fh4kgbzMxklPnCepAnOWVkRcGgClJkiI6/KJ8kyLnjfVE3LairjfjSBepqHQtC/cJovaehyLRP0i2Z61ZrB0VbiuXqpqM/iK7YwrXm9fCfrCSgaQ+c3C6MgZwtDYbfaeFWUMZHVgkxZnFdcLxq72tmzDUta+DYrNfgOni7jprcw2rHXWn38BmWoiAEuhvGxY98rHCP+KTRQrsjtLys/Gov3CmGMbm+rQsmPHj8YPhkMB08GQ5ohBB9bczCt2SJJE26xNPv56Hs3Meju/wuytTCPt1BvFfdPwcXs+vtEMcI7stkU98vc+a58UCtEbQpVi5yCv8h036VlfnHGryvGtIijtr9HaJdpMt9PzBwy1YvJJvhE4MRCXVWUSFVaon7c9lQfDHHD09Nlmiz2k7f4ryTvU9q82X7qvnFZulUG8/fA9cnzZZoU+3H9a5NH/B2RPX22XF2iSaaRWYx3wPVY5YvrqLeWbcBoRnRBw42wpBVFjposjk19tVI1BEn57+t1PT9WSiCTWxRNJ7nk/ErjzFYyikOoZlYgOTcra9bNbhozPJjQ3mShhBWuedLckKWna7xM+vB6suKlN4TX81sR1uW3pIJHbr1rUzs1/ug4fBOHHrVz9ZQ+XYWoIgoOGCyWlXDJ7hkXgvCm67sPzT9n2jWcJATidRkX3n9VvPQeu1swDOpmiiGYiH14yWSTSexm7ODurhECJx3LJdzd0a6ivqZLd7lMVw20VqfB3au+RWOG/LYzqmnC1cCmrTXUWzLXZMn4hhD1bSPgS1quay2Wy/6GGK726IP5tsGmsHc0yf8Dx1wN07mq9QccXOdh9vzh8Q6OF2w/CTCY1i5ya0n9RRl04aBVgQGXxuraO32Q1zrWVMRipUqrDI3phxKKHuTc+Cxzge35U0Bp/HAGE2Ys6hRqyaVFreuKPMLN+qcO/W6BJXlQvviHWLRfbLqZfKoF83VLrVKteNjjxBhKtYIx31SRxLKpddK3atcgH/sRJE3oaj2Cv1+hNkpS2ZjSUyb5D84j9NadMmQaF0x4UC/5nOLehA8p2S4y8d76+R8/tfDaad9vIuZXYHlOQcg9GDovn9x543x9jZVYgFVdjGg+1H9av1CTvdecvwlXXnBQvlTlpKTxtvrw5IT+65IRywYhXLMUH6Vtm9RCLP6QpB/ugt/vKPjm7ZfvfZZ/8Z4Pf5hnt8N3tEU7ZPreCYKhUmtBhXPEuV5Ty7jOWy4Fl3gd2XY9PDm5HhBvl2lyuo19Z6pEW7gqEWLiTCsqqasEMirx0gtgU8Yl0LWpf0NuotZK32/HfBxm9zHhtMOEp5tMeC1dQNSVlp6rG5T/WUrby1u/PKE6L52seDWTcA/k+pMOse12T6TBrNbcLpLRxV0y77GK93z/6OJqeZUmxFhFgatKGYcxs0UySo5bcSyD+paCTzSDE9pGDg2TOcUrN4xmVvHj20GyTNdHbDWxd0Iby6ZcTnv3jrpaEXlGG+F53SF1FRGo+N+RQgKBk22oNOEkAAWynGzsZZrQ/n61CuJ9Hncphte2Rcxaum0tBhZDYJ2o1rom3hKn2h6mGjxtB4h8CMhFdZqgzrY4TUN4jLw0gZdWLKUVSrlYyWoTtYhBi4Hz9oenp84t/nTg/Mcnz51rdvpsedXxUpKk64m4IOu6PZ0kXTvRfbesIJ/qWLMK4szNLdy5Ctdvwt23Em3/RDlZCRvYlFjTYbwdbPrCKDJVNkV2Efznf/zkRsSNd7riD/C21lCpGepJ7Sv1JgLnnMwnAl7ztJCVAo0RCyCraUr17ZDzqUvkRZskYxUbc8FJuxCY8gHGloIyffhm5as90j6neYuClBIIpVyxtFXAaqtKt0a8QWdK31C5OVVtw5jqa8kqMIhxCMqCubL1cPRSMhKoOJysvEpzg8B4ScBkbeJkwjPurmYlrWaZhZJJNkVaLHU+OXGhqZDXakxZCqNE7c1RqtFFtJ5ESvqYPryigmdHuAusoqWtzb0laqiSMacQrBP+UHw+JieiouV5hmZV/SDwFrVTNd6VqIWASpHK50yQLdTeW5rIaiYN3dQhqBu2pmFfsBfdGjlb9IHSHnSLkdVEAiC4vPGl4heNmH2DY8MtruIRs9lsQ+097o75C7dFPSYLTK3GTV2jU5Lt4c3HY9IpqEvzdnKG+pZn0bbYseaxAz4OFyHzrm88UKziW0+T4BlKg61r68Vf3r2BW3jSP0nSlqL/AISP37x++fmXZ5/TvHQV+fM36J/0T1wQVRlbMtla6gzFBM789bWWNWju8sNTksNTksNTksNTksNTksNTksNTksNTksNTksNTksNTksNTksNTkt+t0vbwlOTwlOTwlOTwlGR/CfzhKcnhKcnhKcnhKcnhKcnhKcn/zlOSkGsljXhcCcZlq07EJ+YvVg9MrtKkoJz96CK5u6Pg9ddUR0bN39eoKeF/lSa3THMK37h0fxqT25TXvUHKsL700ajeOa2cem3kkjprVQ6Um/cjXmQZVvZe2HZZwbu3Z+dJmsTCv1LlNEazGT2QYTOfvw18dJls5qqQBZPT2qWZEz8n5eNZbYtuMv/GJfPDj1a2mslFC8Nult+TQX+JqK0D7u58ocBy2cD7rp0jAmMjNO3c1XK5/Dd89pc+",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,f={},y=[];function j(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Self Sign"}),"\n",(0,i.jsx)(l(),{method:"post",path:"/selfsign",context:"endpoint"}),"\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:"iob 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:"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)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signer:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{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},x:{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},y:{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},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"selfsigndocument_body_signer"},folderId:{type:"string",example:""},send_email:{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},email_subject:{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:""},email_body:{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:""},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"}},title:"selfsigndocument_body"}}},required:!0}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...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([[6685],{73320:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>x,default:()=>j,frontMatter:()=>g,metadata:()=>i,toc:()=>f});const i=JSON.parse('{"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":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJztG11zG7fxr2zvxbHmSIm07Lh8qmOnrVsn9kTKZDKSRgHvljxYOOAC4EQyGs7koT+jfclPyy/pLD6Od/wQ7STTqC39IPOABbC7WCz2C3eJZVOTjC6SVyqrS5TWJFdpkqPJNK8sVzIZJecFgkExMXwq4cW71zBFiZpZNMDg66/egC2YBZRsLNDARCMauxAIBM/lFNQEGORh/j58q2rImAQmjAIuM1HnCMotxgRUGns5TrjEHGY8n6I1KcwKnhVgCz8najcec25BacB5xWQOdaUkMAMSMce8D+cFN1Bpdctzh2jEBucVao4yo8lKLpgGq9zcP//4zzMi8VtVa6L35x//BROhZsCl639boXQArKr6l/JSnvNqBF9XQrEcFqrW8O7VnxtCaVZquzg6eoXjegpfvz46uvqksLYyo+NjmkNVKAktwcamn6nyOCfAKp88JpJRI83qaWWGiwWwvMUUW6CETFULyJTSOZe0IylUbIog63KM2qRAnCmVRqKBgUaWL3pW9WqD8Lezt1/CROmS2T68E7VJm+VyrjGzYuGnJ9ojVY8MjJnBZ6dgrOZymkLJboit3ML3Nc9uiGyDMo9MffHutePV0dFZXVVKW8zhG0/C6OiIej5D4jHT6OAzVZZKQsU0K9GiNl66qFvj9zXXTi5sAUyIyIvRpezB0ZFdVDg6OoLXMueZE0+akFpJBD1s34MSkwj0rMKMT3gAbbEOlAxSRzyZMb+flWCZR1OjqTCz/Ba7E89TWNDEr1CqiEGhNP9BScuE245b1JZnTLS3jRB04m2ZtsTOSnFpY2tYoTk5tHtuU4JcEWo5Mavk0vUYhFsmajQBq1kKBWH1FVYaDZ3yOC8xUuZQIJ8WO9dj+fva2M7EUBtCs41FWCvukmMvOrZNmDAIfNLhZclusLVaowH68NkCcpywWtgUOEmc1TX24Utl6eQJnpGiIcl1Z5rZWmPP7XIQh4CIZKXb43crHZDzyQQ1HU7qdFOEMRE7kjOvNIg8d3JswSQoubbRmRJKb4qQa+7yETIlrdN8L24ZFw55T6xp1N9YsOwmhbGoMQWNuT+4CxRCzVIv7w6EFJznueMPqWWSQiUJf6nC8tyACVg1ijCeJ+pslC0twk2bq+HUThStTCyIRwywZFykjnEpvFdjsNwKTOnAVkwuUsiZxRQszu1YzVPICsxuxmoe+DVR0hr+w5ZTF3s+nmvDFE5TeJbC8xQGJykMhikMTlMYPEth8DyF4UkKw2EKw9MUhs88T4fPAz9Zw8Q2AoOh56R9WBwk/fmGG3dCSfGZRpfOOrp00Iejo+ZUUNt33313Ke8uJcBlQofkMhnBZdKAXCap7yPdR32D8D2njyfDT8Pngj6fDZ+Hz5kDHZyGz4I+h4NLuQwLXsqhw8SysroHC+r+TTEIX0FQqM0tSm1RL1EjKZQ0dtB+dPChjmWblidEC5fccibMbnIixAOiaIXSBlGnRJQTyd0Uue4HRE4bH+px6s53OfXY6oqH2mEx3KD+aT/cELuJ98s+GNpb6Pw60p8R6aR+zkn97Ka/0VAPiAnrOP06Tnzadxe50767+RAAHhAXuhj9Oh48Jx7QxbObAdT7gKhvoUMd4Rb3fSenvcHT3vBkeNrhAPk4HqAse3neWywWvwX3yK4Jy5NZEy1Nb6ExizDRqtziRjgrfwUV7B73O5reX5DBPY62KObRB22sksZza1vLVuVs8cj4qeLQxgAj+JX5tWih6boID+fFZoXiWUCeYKLZNSZHrU886BHf8+MvvjhucdI39sqyt9ZInz3H+FZjWfbzvL8GubE7vrGEPE9hs3lre55DWZY7mn37ZeJMqj+S6Adra7f0B4D/1AFYyXl34XsPB/n1Sgq3tnO2tp+OtSuk4DJ0BFGBNQCN01owjXPyGg1X0kP/9icnHpyVTe68TOegOR/eswI+eRvs7sdBqImE7gTUsn/cBmXtSTROce7myGpjVUnI8JzRDCmYOivIC2PRvCe+r+It7itjFSdvX6C1rhVt1t+GhN+1lqdMu7ruKBu0HWKYgThyi6/stt+J9+DEXW/BibjnfgsQD0jFr6FEnT7sQN0Xl0nJnAVAUoar38oWqC+Tq2aM944x3zP26gPOUcFzFGyMYrPrg89Am5YgTy3GUEfJZePRO3xP0lYnm691+r7llrPlKW4LdVTi8WhEFoPgJsY0uvxqjw5BHxeKowAryeUYIQ6AcSOGv1rMG8Q+TM69Fgibs2cJggMH2ATcGh/7/hU6G9NmDM1RcsnLumwih5Nm1siyMtzmbX7RyNqgjiu0d3djBTbfswKF6XYvcCkHLjLASza9x9Bz3Q9IDQR81uQ7SRNVUf6BK/k6T0ZJzE0kqZsUjf1M5YtkdJeEGBL9DBEaGnT83lBe4y4xWYElo18RGcqETLjAJE18psEkaeIcDkqLEKeSUaLG7zGzSUrXZkXBXDQ0hxs3uotQPj6epMH8TEaJD5wnaYJzVlYEHJoAZabIyKvySbKMC943VdOymsq4H02gnuahEPQvnOZLGrpcywT9opletWZwtJV4rl4q6rP4ii1Ma14v38l6AorG0PnNwijI2cJQ2K02XhVlTGS1IFMW5xXXi8audvZsw5IWvs1KDb6Dp8u46S2Mduy1Vh+/QRkqYoCLYXzs2PcKx4h/Cg2UK3L7y8qPxuK9Qhij29uqUPKjxw+GTwbDwZPBkGYIwcfWHExrtkjShFsszX4++t5NDLr7/4JsLczjLdRbxf1TcDG7/j5RjPCObDbF/TJ3visf1ApRm0LVIqfgLzLdd2mZX5zx64oxLeKo7e8R2mWazPcTM4dM9WKyCT4ROLFQVxUlUpWWqB+3PdUHQ9zw9HSZJov95C3+K8n7lDZvtp+6b1yWbpXB/D1wffJ8mSbFflz/2uQRf0dkT58tV5dokmlkFuMdcD1W+eI66q1lGzCaEV3QcCMsaUWRoyaLY1NfrVQNQVL++3pdz4+VEsjkFkXTSS45v9I4s5WM4hCqmRVIzs3KmnWzm8YMDya0N1koYYVrnjQ3ZOnpGi+TPryerHjpDeH1/FaEdfktqeCRW+/a1E6NPzoO38ShR+1cPaVPVyGqiIIDBotlJVyye8aFILzp+u5D88+Zdg0nCYF4XcaF918VL73H7hYMg7qZYggmYh9eMtlkErsZO7i7a4TAScdyCXd3tKuor+nSXS7TVQOt1Wlw96pv0Zghv+2MappwNbBpaw31lsw1WTK+IUR92wj4kpbrWovlsr8hhqs9+mC+bbAp7B1N8v/AMVfDdK5q/QEH13mYPX94vIPjBdtPAgymtYvcWlJ/UQZdOGhVYMClsbr2Th/ktY41FbFYqdIqQ2P6oYSiBzk3PstcYHv+FFAaP5zBhBmLOoVacmlR67oij3Cz/qlDv1tgSR6UL/4hFu0Xm24mn2rBfN1Sq1QrHvY4MYZSrWDMN1UksWxqnfSt2jXIx34ESRO6Wo/g71eojZJUNqb0lEn+g/MIvXWnDJnGBRMe1Es+p7g34UNKtotMvLd+/sdPLbx22vebiPkVWJ5TEHIPhs7LJ3feOF9fYyUWYFUXI5oP9Z/WL9Rk7zXnb8KVFxyUL1U5KWm8rT48OaH/umTEskEI1yzFR2nbJrUQiz8k6Ye74Pc7Cr55++V7n+VfvOfDH+bZ7fAdbdEOmb53gmCo1FpQ4RxxrtfUMq7zlkvBJV5Htl0PT06uB8TbZZqcbmPfmSrRFq5KhJg404pK6iqBjEq89ALYlHEJdG3q35CbqLXS99sxH4fZfUw47TDh6SYTXksXEHWlpefqBuV/ltL28tYvT6jOSycrXs0k3AO5/qRDbLvdE2kwqzW3i2R0cZfMe6ziPd8/urhaXqUJMVZR4KpSxmHMbJGMkuNWHMugvqXgE83ghLaRQ8NkTvHKDaOZVfz4dpAs0/URW03sndDGsimX0969o65WRJ7RRnhed0hdRQQq/nekkEDgZBsqTTgJQIEsJxt7mSa0v1+tgnifx12K4bVtEbOWbluLgcUQWCeqta6Jt8SptoepBk/bASIfAnJRnSaosy1O0xAeIy9N4KUVS2mFUi5WstpELWLQYuC8/eHpqXOLPx04//HJc+eanT5bXnW8lCTpeiIuyLpuTydJ10503y0ryKc61qyCOHNzC3euwvWbcPetRNs/UU5WwgY2JdZ0GG8Hm74wikyVTZFdBP/5Hz+5EXHjna74A7ytNVRqhnpS+0q9icA5J/OJgNc8LWSlQGPEAshqmlJ9O+R86hJ50SbJWMXGXHDSLgSmfICxpaBMH75Z+WqPtM9p3qIgpQRCKVcsbRWw2qrSrRFv0JnSN1RuTlXbMKb6WrIKDGIcgrJgrmw9HL2UjAQqDicrr9LcIDBeEjBZmziZ8Iy7q1lJq1lmoWSSTZEWS51PTlxoKuS1GlOWwihRe3OUanQRrSeRkj6mD6+o4NkR7gKraGlrc2+JGqpkzCkE64Q/FJ+PyYmoaHmeoVlVPwi8Re1UjXclaiGgUqTyORNkC7X3liaymklDN3UI6oatadgX7EW3Rs4WfaC0B91iZDWRAAgub3yp+EUjZt/g2HCLq3jEbDbbUHuPu2P+wm1Rj8kCU6txU9folGR7ePPxmHQK6tK8nZyhvuVZtC12rHnsgI/DRci86xsPFKv41tMkeIbSYOvaevGXd2/gFp70T5K0peg/AOHjN69ffv7l2ec0L11F/vwN+if9ExdEVcaWTLaWOkMxgTN/fa1lDZq7/PCU5PCU5PCU5PCU5PCU5PCU5PCU5PCU5PCU5PCU5PCU5PCU5PCU5HertD08JTk8JTk8JTk8JdlfAn94SnJ4SnJ4SnJ4SnJ4SnJ4SvK/85Qk5FpJIx5XgnHZqhPxifmL1QOTqzQpKGc/ukju7ih4/TXVkVHz9zVqSvhfpckt05zCNy7dn8bkNuV1b5AyrC99NKp3TiunXhu5pM5alQPl5v2IF1mGlb0Xtl1W8O7t2XmSJrHwr1Q5jdFsRg9k2MznbwMfXSabuSpkweS0dmnmxM9J+XhW26KbzL9xyfzwo5WtZnLRwrCb5fdk0F8iauuAuztfKLBcNvC+a+eIwNgITTt3tVwu/w3MX5dA","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"}}');var s=t(74848),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),m=t.n(h),u=(t(18766),t(79329),t(9303));const g={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:"eJztG11zG7fxr2zvxbHmSIm07Lh8qmOnrVsn9kTKZDKSRgHvljxYOOAC4EQyGs7koT+jfclPyy/pLD6Od/wQ7STTqC39IPOABbC7WCz2C3eJZVOTjC6SVyqrS5TWJFdpkqPJNK8sVzIZJecFgkExMXwq4cW71zBFiZpZNMDg66/egC2YBZRsLNDARCMauxAIBM/lFNQEGORh/j58q2rImAQmjAIuM1HnCMotxgRUGns5TrjEHGY8n6I1KcwKnhVgCz8najcec25BacB5xWQOdaUkMAMSMce8D+cFN1Bpdctzh2jEBucVao4yo8lKLpgGq9zcP//4zzMi8VtVa6L35x//BROhZsCl639boXQArKr6l/JSnvNqBF9XQrEcFqrW8O7VnxtCaVZquzg6eoXjegpfvz46uvqksLYyo+NjmkNVKAktwcamn6nyOCfAKp88JpJRI83qaWWGiwWwvMUUW6CETFULyJTSOZe0IylUbIog63KM2qRAnCmVRqKBgUaWL3pW9WqD8Lezt1/CROmS2T68E7VJm+VyrjGzYuGnJ9ojVY8MjJnBZ6dgrOZymkLJboit3ML3Nc9uiGyDMo9MffHutePV0dFZXVVKW8zhG0/C6OiIej5D4jHT6OAzVZZKQsU0K9GiNl66qFvj9zXXTi5sAUyIyIvRpezB0ZFdVDg6OoLXMueZE0+akFpJBD1s34MSkwj0rMKMT3gAbbEOlAxSRzyZMb+flWCZR1OjqTCz/Ba7E89TWNDEr1CqiEGhNP9BScuE245b1JZnTLS3jRB04m2ZtsTOSnFpY2tYoTk5tHtuU4JcEWo5Mavk0vUYhFsmajQBq1kKBWH1FVYaDZ3yOC8xUuZQIJ8WO9dj+fva2M7EUBtCs41FWCvukmMvOrZNmDAIfNLhZclusLVaowH68NkCcpywWtgUOEmc1TX24Utl6eQJnpGiIcl1Z5rZWmPP7XIQh4CIZKXb43crHZDzyQQ1HU7qdFOEMRE7kjOvNIg8d3JswSQoubbRmRJKb4qQa+7yETIlrdN8L24ZFw55T6xp1N9YsOwmhbGoMQWNuT+4CxRCzVIv7w6EFJznueMPqWWSQiUJf6nC8tyACVg1ijCeJ+pslC0twk2bq+HUThStTCyIRwywZFykjnEpvFdjsNwKTOnAVkwuUsiZxRQszu1YzVPICsxuxmoe+DVR0hr+w5ZTF3s+nmvDFE5TeJbC8xQGJykMhikMTlMYPEth8DyF4UkKw2EKw9MUhs88T4fPAz9Zw8Q2AoOh56R9WBwk/fmGG3dCSfGZRpfOOrp00Iejo+ZUUNt33313Ke8uJcBlQofkMhnBZdKAXCap7yPdR32D8D2njyfDT8Pngj6fDZ+Hz5kDHZyGz4I+h4NLuQwLXsqhw8SysroHC+r+TTEIX0FQqM0tSm1RL1EjKZQ0dtB+dPChjmWblidEC5fccibMbnIixAOiaIXSBlGnRJQTyd0Uue4HRE4bH+px6s53OfXY6oqH2mEx3KD+aT/cELuJ98s+GNpb6Pw60p8R6aR+zkn97Ka/0VAPiAnrOP06Tnzadxe50767+RAAHhAXuhj9Oh48Jx7QxbObAdT7gKhvoUMd4Rb3fSenvcHT3vBkeNrhAPk4HqAse3neWywWvwX3yK4Jy5NZEy1Nb6ExizDRqtziRjgrfwUV7B73O5reX5DBPY62KObRB22sksZza1vLVuVs8cj4qeLQxgAj+JX5tWih6boID+fFZoXiWUCeYKLZNSZHrU886BHf8+MvvjhucdI39sqyt9ZInz3H+FZjWfbzvL8GubE7vrGEPE9hs3lre55DWZY7mn37ZeJMqj+S6Adra7f0B4D/1AFYyXl34XsPB/n1Sgq3tnO2tp+OtSuk4DJ0BFGBNQCN01owjXPyGg1X0kP/9icnHpyVTe68TOegOR/eswI+eRvs7sdBqImE7gTUsn/cBmXtSTROce7myGpjVUnI8JzRDCmYOivIC2PRvCe+r+It7itjFSdvX6C1rhVt1t+GhN+1lqdMu7ruKBu0HWKYgThyi6/stt+J9+DEXW/BibjnfgsQD0jFr6FEnT7sQN0Xl0nJnAVAUoar38oWqC+Tq2aM944x3zP26gPOUcFzFGyMYrPrg89Am5YgTy3GUEfJZePRO3xP0lYnm691+r7llrPlKW4LdVTi8WhEFoPgJsY0uvxqjw5BHxeKowAryeUYIQ6AcSOGv1rMG8Q+TM69Fgibs2cJggMH2ATcGh/7/hU6G9NmDM1RcsnLumwih5Nm1siyMtzmbX7RyNqgjiu0d3djBTbfswKF6XYvcCkHLjLASza9x9Bz3Q9IDQR81uQ7SRNVUf6BK/k6T0ZJzE0kqZsUjf1M5YtkdJeEGBL9DBEaGnT83lBe4y4xWYElo18RGcqETLjAJE18psEkaeIcDkqLEKeSUaLG7zGzSUrXZkXBXDQ0hxs3uotQPj6epMH8TEaJD5wnaYJzVlYEHJoAZabIyKvySbKMC943VdOymsq4H02gnuahEPQvnOZLGrpcywT9opletWZwtJV4rl4q6rP4ii1Ma14v38l6AorG0PnNwijI2cJQ2K02XhVlTGS1IFMW5xXXi8audvZsw5IWvs1KDb6Dp8u46S2Mduy1Vh+/QRkqYoCLYXzs2PcKx4h/Cg2UK3L7y8qPxuK9Qhij29uqUPKjxw+GTwbDwZPBkGYIwcfWHExrtkjShFsszX4++t5NDLr7/4JsLczjLdRbxf1TcDG7/j5RjPCObDbF/TJ3visf1ApRm0LVIqfgLzLdd2mZX5zx64oxLeKo7e8R2mWazPcTM4dM9WKyCT4ROLFQVxUlUpWWqB+3PdUHQ9zw9HSZJov95C3+K8n7lDZvtp+6b1yWbpXB/D1wffJ8mSbFflz/2uQRf0dkT58tV5dokmlkFuMdcD1W+eI66q1lGzCaEV3QcCMsaUWRoyaLY1NfrVQNQVL++3pdz4+VEsjkFkXTSS45v9I4s5WM4hCqmRVIzs3KmnWzm8YMDya0N1koYYVrnjQ3ZOnpGi+TPryerHjpDeH1/FaEdfktqeCRW+/a1E6NPzoO38ShR+1cPaVPVyGqiIIDBotlJVyye8aFILzp+u5D88+Zdg0nCYF4XcaF918VL73H7hYMg7qZYggmYh9eMtlkErsZO7i7a4TAScdyCXd3tKuor+nSXS7TVQOt1Wlw96pv0Zghv+2MappwNbBpaw31lsw1WTK+IUR92wj4kpbrWovlsr8hhqs9+mC+bbAp7B1N8v/AMVfDdK5q/QEH13mYPX94vIPjBdtPAgymtYvcWlJ/UQZdOGhVYMClsbr2Th/ktY41FbFYqdIqQ2P6oYSiBzk3PstcYHv+FFAaP5zBhBmLOoVacmlR67oij3Cz/qlDv1tgSR6UL/4hFu0Xm24mn2rBfN1Sq1QrHvY4MYZSrWDMN1UksWxqnfSt2jXIx34ESRO6Wo/g71eojZJUNqb0lEn+g/MIvXWnDJnGBRMe1Es+p7g34UNKtotMvLd+/sdPLbx22vebiPkVWJ5TEHIPhs7LJ3feOF9fYyUWYFUXI5oP9Z/WL9Rk7zXnb8KVFxyUL1U5KWm8rT48OaH/umTEskEI1yzFR2nbJrUQiz8k6Ye74Pc7Cr55++V7n+VfvOfDH+bZ7fAdbdEOmb53gmCo1FpQ4RxxrtfUMq7zlkvBJV5Htl0PT06uB8TbZZqcbmPfmSrRFq5KhJg404pK6iqBjEq89ALYlHEJdG3q35CbqLXS99sxH4fZfUw47TDh6SYTXksXEHWlpefqBuV/ltL28tYvT6jOSycrXs0k3AO5/qRDbLvdE2kwqzW3i2R0cZfMe6ziPd8/urhaXqUJMVZR4KpSxmHMbJGMkuNWHMugvqXgE83ghLaRQ8NkTvHKDaOZVfz4dpAs0/URW03sndDGsimX0969o65WRJ7RRnhed0hdRQQq/nekkEDgZBsqTTgJQIEsJxt7mSa0v1+tgnifx12K4bVtEbOWbluLgcUQWCeqta6Jt8SptoepBk/bASIfAnJRnSaosy1O0xAeIy9N4KUVS2mFUi5WstpELWLQYuC8/eHpqXOLPx04//HJc+eanT5bXnW8lCTpeiIuyLpuTydJ10503y0ryKc61qyCOHNzC3euwvWbcPetRNs/UU5WwgY2JdZ0GG8Hm74wikyVTZFdBP/5Hz+5EXHjna74A7ytNVRqhnpS+0q9icA5J/OJgNc8LWSlQGPEAshqmlJ9O+R86hJ50SbJWMXGXHDSLgSmfICxpaBMH75Z+WqPtM9p3qIgpQRCKVcsbRWw2qrSrRFv0JnSN1RuTlXbMKb6WrIKDGIcgrJgrmw9HL2UjAQqDicrr9LcIDBeEjBZmziZ8Iy7q1lJq1lmoWSSTZEWS51PTlxoKuS1GlOWwihRe3OUanQRrSeRkj6mD6+o4NkR7gKraGlrc2+JGqpkzCkE64Q/FJ+PyYmoaHmeoVlVPwi8Re1UjXclaiGgUqTyORNkC7X3liaymklDN3UI6oatadgX7EW3Rs4WfaC0B91iZDWRAAgub3yp+EUjZt/g2HCLq3jEbDbbUHuPu2P+wm1Rj8kCU6txU9folGR7ePPxmHQK6tK8nZyhvuVZtC12rHnsgI/DRci86xsPFKv41tMkeIbSYOvaevGXd2/gFp70T5K0peg/AOHjN69ffv7l2ec0L11F/vwN+if9ExdEVcaWTLaWOkMxgTN/fa1lDZq7/PCU5PCU5PCU5PCU5PCU5PCU5PCU5PCU5PCU5PCU5PCU5PCU5PCU5HertD08JTk8JTk8JTk8JdlfAn94SnJ4SnJ4SnJ4SnJ4SnJ4SvK/85Qk5FpJIx5XgnHZqhPxifmL1QOTqzQpKGc/ukju7ih4/TXVkVHz9zVqSvhfpckt05zCNy7dn8bkNuV1b5AyrC99NKp3TiunXhu5pM5alQPl5v2IF1mGlb0Xtl1W8O7t2XmSJrHwr1Q5jdFsRg9k2MznbwMfXSabuSpkweS0dmnmxM9J+XhW26KbzL9xyfzwo5WtZnLRwrCb5fdk0F8iauuAuztfKLBcNvC+a+eIwNgITTt3tVwu/w3MX5dA",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,y={},f=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Self Sign"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/selfsign",context:"endpoint"}),"\n",(0,s.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,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.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,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.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,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signer:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{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},x:{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},y:{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},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"selfsigndocument_body_signer"},folderId:{type:"string",example:""},send_email:{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},email_subject:{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:""},email_body:{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:""},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"}},title:"selfsigndocument_body"}}},required:!0}}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.de0fa34e.js b/assets/js/bbdfc22d.9bc26be1.js similarity index 72% rename from assets/js/bbdfc22d.de0fa34e.js rename to assets/js/bbdfc22d.9bc26be1.js index 92d8843a5..8acdb99b0 100644 --- a/assets/js/bbdfc22d.de0fa34e.js +++ b/assets/js/bbdfc22d.9bc26be1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3844],{60092:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>y,default:()=>b,frontMatter:()=>x,metadata:()=>i,toc:()=>f});const i=JSON.parse('{"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":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJztO9tyIzeuv4Ltl8m4WrKlOJNZP52ZJGd3zkniqYynUqdsl0N1Q2rG3WSHZFtWXHrbL9lP2y/ZAki2unWxPZeTdar0YqtJkARAAARA8C5xYmaTk/PkDKu6FA5tcpkmOdrMyNpJrZKT5KxAiN3wjUFB7fDq7RsQZannFhqLxoLTkFEnQtZYpyv5u5iUCC5OnMK8kFkBFs0NgrAwKRusjVTOwlQbmKFCI5xUM8h11lRIHXPpCqgN5jiVCnOwzjSZawzaIbyvtQLbZBlaO23KdiWPhtQqBVcgI2rQNUZZENAo+VuDcHAQoa9kfnAArhAOMqFggkROTtQEhLCDzkRQn1Y8sa0xk1NJwGGu4YW6UGeyPoH3dalFDgvdGHj77X+3U9C81HZ+cPAtTpoZvH9zcHD5ReFcbU8OD0VdD3WNysqZKsXEDjNdHeYEWOfT58RBNEizMq4orCwXIPIc5jKfobNMsYJM1wvItDa5VJ71tZghqKaaoLEpCJVDpQ2CVCDAoMgXA6cHjUX4n3enP9J2VMIN4W3Z2LRdLpcGM1cu/PTEgUjVM8+ZF8e0P1LNUqjENW2kdPBbI7NrItuiYraGPWFeHRy8a+paG4c5/OxJODk4oJ7XWOo5CIMMn+mq0gpqYUSFjqWNNoy6Df7WSIO5FxVRlpEXJxdqQPu8qPHk4ADeqFxmxAyekFpBTwPs0IMSkwj0XdhYD9phHe28F2LiyVz4/axLkXk0DZJMOHmD/YlvU1jQxN+i0hGDQhv5u1ZOlLwdN2iczETZ3TZCkAXNCcN6UWupXGwNK8D/he2h3eNNCXJFqOXErEoq7rEIN6Js0Aas5ikUhNVPWBu0LN9hXmKkyqFAOSt2rifyXxvrehNDYwnNLhZhrbhLzF5ktk1FaRHktMfLSlxjZzXQbIREOYTXC8hxKprSpSBJ4pxpcAg/ageirkuZsbUhQ0LKI8hGDHiXgzgERJSoeI/fGn0jcySTkMvpFA0pJ3XyFGFMxI7krOYBRB5rjiuEAq3WNjrTpTabIsTNfT5CppVD5Ybw6kbIkpH3xFqQKiubHGFSiuw6ZTuZgsHcK+4CyeqmXt4ZhIyp5znzByyWJIVaEf5Kh+WlXVmsIZwV0q70iTojq3kRabtcDVo71bQysSCqGGAlZJky41L4VU/ASVdiSgpbC7VIIRcOU3B46yb6NoWswOyafxmRSw2Txjky1LRmbnSd67kKvJxq5az8fYtGxp4P5+g4heMUXqTwMoXRUQqjcQqj4xRGL1IYvUxhfJTCeJzC+DiF8QuP1vhl4LVoGdxFYDT2XHZ/Hu6S3f1eWtZsMpi2tcHzng0eDeHgoNUmavvll18u1N2FArhISLkukhO4SFqQiyT1fWQzqW8Uvm/p48vx1+FzQZ8vxi/D55xBR8fhs6DP8ehCLcOCF2rMmDhR1fdgQd2fFYPwFYSI2nhRaov2jBrJEKWxg/aqhw91LLu0fEm0SCWdFKXdTU6EeEIUrVDaIOqYiGJx3U0Rdz8hcrr4UA+bSd/FZrXTFRWesRhvUP/VMJwsu4n3yz4Z2jvofBrpL1ia9QTOyDTtpr+1Xk+ICes4fRonvh6yA8CWeTcfAsAT4kIfo0/jwUviAR1KuxlAvU+I+g461BFOeN93dDwYfTUYH42Pexyg2MgDVNUgzweLxeJzcI98nrA8uTzRQ/WeHYWhU6OrLeEHRwcrqOAT8e/osv9Ajvok+rCYU9zXj2BjxNf1sp3OxeKZ9VPFoa1zRvAr12zRQZO7CA+OfrNCyywgTzDRJZtQgDckHgyI7/nhDz8cdjjpGwdVNVhrpM8BM77TWFXDPB+uQW7sjm+sIM9T2Gze2p7nUFXVjmbffpGwS/XXIScV2BPbLf0B4I9SgJWc9xe+VzkoH6BVyWtzkLZdO9aOkEKq0BFEBdYADM6aUhi8pWjTSq089OfXnKg4K3+do1MO7Dj296yAL06DT/48CDWR0J+AWh4et0FZdxKDM7zlOXxajJCRechP2SYrKHoT0fUnvq/yNPyViVpSlqBE57gVXTbchoTftU6ETbu6HmBbdD1ihIU4ckuMzdvP4j064uMtBBj3nG8B4gmZ+DWUqNOnK6j7/CKpBHsAJGW4+q1dgeYiuWzH+Kga8wfGXj5CjwqZYykmWG52PVoHurQEeeowhjoqqdpMAON7lHY6xe1ap+9bbtEtT3FXqKMRj6oRWQyltDEX0udXd3RIFnEKT6FPtk4Q4gCYtGL4yWLeIvY4OfdWIGzOA0sQHDBgm6iLqz2wQm9juoyhOSqpZNVUbcZx2s4aWVaF07zLLxpJafi4Qnd3N1YQtw+sEBLhOxa4UCPODMSMwj2+XoB4QsZgDaX79fRjzETvjPxMh9vDChjJ6irgliORQP1h2Cqf3a19QzilA4iynH4Q5a2yDGtHOa5PVc0W5UcfQZwF8pmt15zZ2i153fzXE5K+LWj9P0tggPtjpLBL3p9IEntoP1oafR6vErN7gl3ufkLyF/BZ29wkTXTNd69avcmTk8Tf48ZbzSTlqdG61zpfJCd3Sci008+Qx6ahh79aui++S2xWYCXoV0SJbpinsqSpKFmMxiZpwqkXum4mfiUniZ78iplLUgogaroOQ0tz8LiTuwjlbxiTNATiyUnirx6TNMFbUdUEHJoAVaYp3OUplnHF++ZqW1ZzWf7R3vHSPHSL95HT8NDl2hX7R83UnWG54utqMmGMWCTrt/nx+i5GaX5cez9RLqKWSEe60N4pMViSJtJh1V1lx64Z/eGczlATJZyX/dCxvC2i+uA1aVxdaPVRA8N1yRaeP5JLvndz4f6WvaLoEPPoNw9WN5wp8C3D8CGJifBMrZh11/Re4MaaZ7tuvjsXbrbQTZnTVRYKM+QL6I+ubeDyEVFmDVdwtKdDj7IW1Zay0TJNbh8m5hYyPYjX6vBFiVMHTV2jgUwbheZ5N7f2ZIgbHx8v02TxMHmLPyV5X9PmzR+m7meuR1jVavwncP3y5TJNiodx/XtbMfEfRPb4xXJ11q2d5VcTnS+uot1aPgQYDxWCo/qdN+rU5Gg6jJhoXaJQG5x4M/XulYZn5Is8C8ksvuiWxsYDBeayLMFghlQ0wznpaKsgOB3+FhzC5SN5Zd9RA3uLtplYglJxPusnnCA4I2czpMKgAMGDw1U+Ci5Eo2IawkpM6Zaei30M3kjd2IheISzftpdIDqkrUPr6Eqlmfe+wwx2utOjSPuzuDrXQIafo7v/07O0jeMm+6wBc0dYReCr9HHB69pbKh+Q0+GFDeG9bTkTWih4IkF8EN1LEEoPWti98egEVc0Qzsb1ar2Eo3BnAJkK5tFsxSlcJzrZWcGPiVX0ZbZFuHBW2yVA1YR3WtsdHxqJl5JluHiOVD3BSwKzh+xFHKhtriTjpuir/kcoXIXLkkzcmVjwFsSBIqkhc8SlyhYA686eAyvrhAqbCOjQplScS501DkU07Jd7WaCSqDLeywKBn3VVjtvpNfR70a2ne//R9qCqMNESlnJAG+okxh6ZmqWFNaGu84s6tk77hKJF2oLna5aBtuh5ciRWyajUaqxVQBZWZCSV/9yLMHom2CBMsROlBg6mg2yXChzS8j0y0tf/6xz87eO30ODcR8yuIPKdU/wMYcmTrBZ48boM1WUDdx4jmQ/Nf64cAYcdKc1XpvFUk+3gZf0uFf862dtFpLhTFEn0pa7x6aO2tTaONtcGtpBsIwzcFXPKqa6IXb6V1nSqleJe4aR9+QuJj1sGB3RDSapJ5tegqeItXqIZaTce1VLJf4dYeg2u6cP9x5s+7VUwaTDFVbWplvUc+Pjqif2sb36ssJsVsq47LxV+S9PEB8f3hgG+mEHxTFFcS87oY/93WqsoKEpIKre179FuGPEBAl29SlVLhVWTK1fjo6Oor4twyTY63MeedrtAVLBFkC+ZGUwFwXaKgglSzADETUgEtbz4jr9AYbe6n+sMwu48Jx0dHV6OWCV9tMuGN4msYLjY/09eo/lhKu8s7vzyheluxVfNmN5EeiPuTHrHddk+kxawx0i2Sk/O75HYgajnw/Sfnl8tLkjpXaEoV1doyxsIVyUlyuJE54mp/Skuc3yV8PCXR9bVC5XRXsuH+iloe3oySZbo+YquzvBPaOjGTaja4d9TlitR3tB2e4z2CV7F9Lf8XKbgP/OxCpYkkMShQkHtMHKRd/mmVNvsu7lVMaG3NUa02ZT3rFJNOvTzSuunfkhnqJIbOY1aGEy1tniVZUZS0uRD62WY3zlei1yYSYh5hxAH4+PiYI9WvRxzSffmSo6XjF8tLz+FO5MCZya776xPePT8uNPX9miRZ8yN6h/n6Wb7zXN1xrEZfSqqp5j0P+3Bao3pHriqp1s1oMzrFMtNVW8Qbwf/1j3/yiHiM8TJ/gdPGQK3naOi9ClXlTku8leQcdp7TUPKNs9OiKtFaysgphzP/FEXOuBggelyZqMVElpJsBYFpX3TTMTd2CD8XSHcE1PXM+LqIGyzJxECpNT/UIO+gcbrqPneBuTbXU0IpBQETqu0nn8cixiGoCqEyyth7FWJ/gR6mkA9bG2kRhKwImHxpnE5lJmliMoxGZA4qocSMD/6Uo2TiQh0r842eUChiddl4Z5veByA6TyLfGAzhWwpumHBqzNHRtufez7apj3OCnQwPXyYUU9a0vMzQriqoSrxBwybDR6lNWUKtnY8cyfPp7i1N5IxQluJwj1DcmpZ9wRvmNXKxGAJdG9CZRD4hCUAp1bV/pnLeitnPOLHS4SpDMJ/PN8zX8/6Yv0lXNBPyL/Vq3Iwb2dh1h7cfz8nYoKns6fQdmhuZYbCdO9Y8ZODDcKyJjI+1qGyills92FJmqCx2DqFXf3v7PdzAl8OjJO0Y7EcgfPj9m2+++/HddzQvHSle/0bDo+ERpzW1dZVQnaW+8a/RzlYmdC3p3p7P+ydu+ydu+ydu+ydu+ydu+ydu+ydu+ydu+ydu+yduG0Ttn7jtn7jtn7jtn7jtn7jtn7jtn7jtn7jtn7jtn7g9FRO/f+K2f+K2f+K2f+K2f+L2pB4W7Z+4/RESuH/itn/i9ognbqGEhbzCw7oUkmugQsWsL186X3/4dpkmBdU3nZwnd3d0/ffelMslNf/WoKHiqMs0uRFGUpKbS6PSWAJERTPXuKBraJ+zH5zR+qkXd74yX6sIowomP+IVb/u9sN0SrLen786SNJmEx3mVzmmMEXN6uCfmvnImcJOfZgl+dVEKNWu4hifxc1LVkmhc0S95uuaSp/CjUwok1KKDYb8WypNBf4morQPu7nw51XLZwvuunSMCYyM07d/lcrn8NwWGxDE=","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"}}');var s=t(74848),r=t(28453),a=t(33617),o=t.n(a),l=t(17543),d=t.n(l),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const x={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:"eJztO9tyIzeuv4Ltl8m4WrKlOJNZP52ZJGd3zkniqYynUqdsl0N1Q2rG3WSHZFtWXHrbL9lP2y/ZAki2unWxPZeTdar0YqtJkARAAARA8C5xYmaTk/PkDKu6FA5tcpkmOdrMyNpJrZKT5KxAiN3wjUFB7fDq7RsQZannFhqLxoLTkFEnQtZYpyv5u5iUCC5OnMK8kFkBFs0NgrAwKRusjVTOwlQbmKFCI5xUM8h11lRIHXPpCqgN5jiVCnOwzjSZawzaIbyvtQLbZBlaO23KdiWPhtQqBVcgI2rQNUZZENAo+VuDcHAQoa9kfnAArhAOMqFggkROTtQEhLCDzkRQn1Y8sa0xk1NJwGGu4YW6UGeyPoH3dalFDgvdGHj77X+3U9C81HZ+cPAtTpoZvH9zcHD5ReFcbU8OD0VdD3WNysqZKsXEDjNdHeYEWOfT58RBNEizMq4orCwXIPIc5jKfobNMsYJM1wvItDa5VJ71tZghqKaaoLEpCJVDpQ2CVCDAoMgXA6cHjUX4n3enP9J2VMIN4W3Z2LRdLpcGM1cu/PTEgUjVM8+ZF8e0P1LNUqjENW2kdPBbI7NrItuiYraGPWFeHRy8a+paG4c5/OxJODk4oJ7XWOo5CIMMn+mq0gpqYUSFjqWNNoy6Df7WSIO5FxVRlpEXJxdqQPu8qPHk4ADeqFxmxAyekFpBTwPs0IMSkwj0XdhYD9phHe28F2LiyVz4/axLkXk0DZJMOHmD/YlvU1jQxN+i0hGDQhv5u1ZOlLwdN2iczETZ3TZCkAXNCcN6UWupXGwNK8D/he2h3eNNCXJFqOXErEoq7rEIN6Js0Aas5ikUhNVPWBu0LN9hXmKkyqFAOSt2rifyXxvrehNDYwnNLhZhrbhLzF5ktk1FaRHktMfLSlxjZzXQbIREOYTXC8hxKprSpSBJ4pxpcAg/ageirkuZsbUhQ0LKI8hGDHiXgzgERJSoeI/fGn0jcySTkMvpFA0pJ3XyFGFMxI7krOYBRB5rjiuEAq3WNjrTpTabIsTNfT5CppVD5Ybw6kbIkpH3xFqQKiubHGFSiuw6ZTuZgsHcK+4CyeqmXt4ZhIyp5znzByyWJIVaEf5Kh+WlXVmsIZwV0q70iTojq3kRabtcDVo71bQysSCqGGAlZJky41L4VU/ASVdiSgpbC7VIIRcOU3B46yb6NoWswOyafxmRSw2Txjky1LRmbnSd67kKvJxq5az8fYtGxp4P5+g4heMUXqTwMoXRUQqjcQqj4xRGL1IYvUxhfJTCeJzC+DiF8QuP1vhl4LVoGdxFYDT2XHZ/Hu6S3f1eWtZsMpi2tcHzng0eDeHgoNUmavvll18u1N2FArhISLkukhO4SFqQiyT1fWQzqW8Uvm/p48vx1+FzQZ8vxi/D55xBR8fhs6DP8ehCLcOCF2rMmDhR1fdgQd2fFYPwFYSI2nhRaov2jBrJEKWxg/aqhw91LLu0fEm0SCWdFKXdTU6EeEIUrVDaIOqYiGJx3U0Rdz8hcrr4UA+bSd/FZrXTFRWesRhvUP/VMJwsu4n3yz4Z2jvofBrpL1ia9QTOyDTtpr+1Xk+ICes4fRonvh6yA8CWeTcfAsAT4kIfo0/jwUviAR1KuxlAvU+I+g461BFOeN93dDwYfTUYH42Pexyg2MgDVNUgzweLxeJzcI98nrA8uTzRQ/WeHYWhU6OrLeEHRwcrqOAT8e/osv9Ajvok+rCYU9zXj2BjxNf1sp3OxeKZ9VPFoa1zRvAr12zRQZO7CA+OfrNCyywgTzDRJZtQgDckHgyI7/nhDz8cdjjpGwdVNVhrpM8BM77TWFXDPB+uQW7sjm+sIM9T2Gze2p7nUFXVjmbffpGwS/XXIScV2BPbLf0B4I9SgJWc9xe+VzkoH6BVyWtzkLZdO9aOkEKq0BFEBdYADM6aUhi8pWjTSq089OfXnKg4K3+do1MO7Dj296yAL06DT/48CDWR0J+AWh4et0FZdxKDM7zlOXxajJCRechP2SYrKHoT0fUnvq/yNPyViVpSlqBE57gVXTbchoTftU6ETbu6HmBbdD1ihIU4ckuMzdvP4j064uMtBBj3nG8B4gmZ+DWUqNOnK6j7/CKpBHsAJGW4+q1dgeYiuWzH+Kga8wfGXj5CjwqZYykmWG52PVoHurQEeeowhjoqqdpMAON7lHY6xe1ap+9bbtEtT3FXqKMRj6oRWQyltDEX0udXd3RIFnEKT6FPtk4Q4gCYtGL4yWLeIvY4OfdWIGzOA0sQHDBgm6iLqz2wQm9juoyhOSqpZNVUbcZx2s4aWVaF07zLLxpJafi4Qnd3N1YQtw+sEBLhOxa4UCPODMSMwj2+XoB4QsZgDaX79fRjzETvjPxMh9vDChjJ6irgliORQP1h2Cqf3a19QzilA4iynH4Q5a2yDGtHOa5PVc0W5UcfQZwF8pmt15zZ2i153fzXE5K+LWj9P0tggPtjpLBL3p9IEntoP1oafR6vErN7gl3ufkLyF/BZ29wkTXTNd69avcmTk8Tf48ZbzSTlqdG61zpfJCd3Sci008+Qx6ahh79aui++S2xWYCXoV0SJbpinsqSpKFmMxiZpwqkXum4mfiUniZ78iplLUgogaroOQ0tz8LiTuwjlbxiTNATiyUnirx6TNMFbUdUEHJoAVaYp3OUplnHF++ZqW1ZzWf7R3vHSPHSL95HT8NDl2hX7R83UnWG54utqMmGMWCTrt/nx+i5GaX5cez9RLqKWSEe60N4pMViSJtJh1V1lx64Z/eGczlATJZyX/dCxvC2i+uA1aVxdaPVRA8N1yRaeP5JLvndz4f6WvaLoEPPoNw9WN5wp8C3D8CGJifBMrZh11/Re4MaaZ7tuvjsXbrbQTZnTVRYKM+QL6I+ubeDyEVFmDVdwtKdDj7IW1Zay0TJNbh8m5hYyPYjX6vBFiVMHTV2jgUwbheZ5N7f2ZIgbHx8v02TxMHmLPyV5X9PmzR+m7meuR1jVavwncP3y5TJNiodx/XtbMfEfRPb4xXJ11q2d5VcTnS+uot1aPgQYDxWCo/qdN+rU5Gg6jJhoXaJQG5x4M/XulYZn5Is8C8ksvuiWxsYDBeayLMFghlQ0wznpaKsgOB3+FhzC5SN5Zd9RA3uLtplYglJxPusnnCA4I2czpMKgAMGDw1U+Ci5Eo2IawkpM6Zaei30M3kjd2IheISzftpdIDqkrUPr6Eqlmfe+wwx2utOjSPuzuDrXQIafo7v/07O0jeMm+6wBc0dYReCr9HHB69pbKh+Q0+GFDeG9bTkTWih4IkF8EN1LEEoPWti98egEVc0Qzsb1ar2Eo3BnAJkK5tFsxSlcJzrZWcGPiVX0ZbZFuHBW2yVA1YR3WtsdHxqJl5JluHiOVD3BSwKzh+xFHKhtriTjpuir/kcoXIXLkkzcmVjwFsSBIqkhc8SlyhYA686eAyvrhAqbCOjQplScS501DkU07Jd7WaCSqDLeywKBn3VVjtvpNfR70a2ne//R9qCqMNESlnJAG+okxh6ZmqWFNaGu84s6tk77hKJF2oLna5aBtuh5ciRWyajUaqxVQBZWZCSV/9yLMHom2CBMsROlBg6mg2yXChzS8j0y0tf/6xz87eO30ODcR8yuIPKdU/wMYcmTrBZ48boM1WUDdx4jmQ/Nf64cAYcdKc1XpvFUk+3gZf0uFf862dtFpLhTFEn0pa7x6aO2tTaONtcGtpBsIwzcFXPKqa6IXb6V1nSqleJe4aR9+QuJj1sGB3RDSapJ5tegqeItXqIZaTce1VLJf4dYeg2u6cP9x5s+7VUwaTDFVbWplvUc+Pjqif2sb36ssJsVsq47LxV+S9PEB8f3hgG+mEHxTFFcS87oY/93WqsoKEpIKre179FuGPEBAl29SlVLhVWTK1fjo6Oor4twyTY63MeedrtAVLBFkC+ZGUwFwXaKgglSzADETUgEtbz4jr9AYbe6n+sMwu48Jx0dHV6OWCV9tMuGN4msYLjY/09eo/lhKu8s7vzyheluxVfNmN5EeiPuTHrHddk+kxawx0i2Sk/O75HYgajnw/Sfnl8tLkjpXaEoV1doyxsIVyUlyuJE54mp/Skuc3yV8PCXR9bVC5XRXsuH+iloe3oySZbo+YquzvBPaOjGTaja4d9TlitR3tB2e4z2CV7F9Lf8XKbgP/OxCpYkkMShQkHtMHKRd/mmVNvsu7lVMaG3NUa02ZT3rFJNOvTzSuunfkhnqJIbOY1aGEy1tniVZUZS0uRD62WY3zlei1yYSYh5hxAH4+PiYI9WvRxzSffmSo6XjF8tLz+FO5MCZya776xPePT8uNPX9miRZ8yN6h/n6Wb7zXN1xrEZfSqqp5j0P+3Bao3pHriqp1s1oMzrFMtNVW8Qbwf/1j3/yiHiM8TJ/gdPGQK3naOi9ClXlTku8leQcdp7TUPKNs9OiKtFaysgphzP/FEXOuBggelyZqMVElpJsBYFpX3TTMTd2CD8XSHcE1PXM+LqIGyzJxECpNT/UIO+gcbrqPneBuTbXU0IpBQETqu0nn8cixiGoCqEyyth7FWJ/gR6mkA9bG2kRhKwImHxpnE5lJmliMoxGZA4qocSMD/6Uo2TiQh0r842eUChiddl4Z5veByA6TyLfGAzhWwpumHBqzNHRtufez7apj3OCnQwPXyYUU9a0vMzQriqoSrxBwybDR6lNWUKtnY8cyfPp7i1N5IxQluJwj1DcmpZ9wRvmNXKxGAJdG9CZRD4hCUAp1bV/pnLeitnPOLHS4SpDMJ/PN8zX8/6Yv0lXNBPyL/Vq3Iwb2dh1h7cfz8nYoKns6fQdmhuZYbCdO9Y8ZODDcKyJjI+1qGyills92FJmqCx2DqFXf3v7PdzAl8OjJO0Y7EcgfPj9m2+++/HddzQvHSle/0bDo+ERpzW1dZVQnaW+8a/RzlYmdC3p3p7P+ydu+ydu+ydu+ydu+ydu+ydu+ydu+ydu+ydu+yduG0Ttn7jtn7jtn7jtn7jtn7jtn7jtn7jtn7jtn7jtn7g9FRO/f+K2f+K2f+K2f+K2f+L2pB4W7Z+4/RESuH/itn/i9ognbqGEhbzCw7oUkmugQsWsL186X3/4dpkmBdU3nZwnd3d0/ffelMslNf/WoKHiqMs0uRFGUpKbS6PSWAJERTPXuKBraJ+zH5zR+qkXd74yX6sIowomP+IVb/u9sN0SrLen786SNJmEx3mVzmmMEXN6uCfmvnImcJOfZgl+dVEKNWu4hifxc1LVkmhc0S95uuaSp/CjUwok1KKDYb8WypNBf4morQPu7nw51XLZwvuunSMCYyM07d/lcrn8NwWGxDE=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},y=void 0,g={},f=[];function j(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Template"}),"\n",(0,s.jsx)(o(),{method:"post",path:"/createtemplate",context:"endpoint"}),"\n",(0,s.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,s.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.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,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.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,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"iob Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio Button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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 "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded file"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{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},x:{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},y:{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},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},message:{type:"string",example:"Template created successfully!"}},title:"inline_response_200_5"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3844],{60092:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>g,default:()=>j,frontMatter:()=>x,metadata:()=>i,toc:()=>f});const i=JSON.parse('{"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":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJztO9tyIzeuv4Ltl8m4WrKlOJNZP52ZJGd3zkniqYynUqdsl0N1Q2rG3WSHZFtWXHrbL9lP2y/ZAki2unWxPZeTdar0YqtJkARAAARA8C5xYmaTk/PkDKu6FA5tcpkmOdrMyNpJrZKT5KxAiN3wjUFB7fDq7RsQZannFhqLxoLTkFEnQtZYpyv5u5iUCC5OnMK8kFkBFs0NgrAwKRusjVTOwlQbmKFCI5xUM8h11lRIHXPpCqgN5jiVCnOwzjSZawzaIbyvtQLbZBlaO23KdiWPhtQqBVcgI2rQNUZZENAo+VuDcHAQoa9kfnAArhAOMqFggkROTtQEhLCDzkRQn1Y8sa0xk1NJwGGu4YW6UGeyPoH3dalFDgvdGHj77X+3U9C81HZ+cPAtTpoZvH9zcHD5ReFcbU8OD0VdD3WNysqZKsXEDjNdHeYEWOfT58RBNEizMq4orCwXIPIc5jKfobNMsYJM1wvItDa5VJ71tZghqKaaoLEpCJVDpQ2CVCDAoMgXA6cHjUX4n3enP9J2VMIN4W3Z2LRdLpcGM1cu/PTEgUjVM8+ZF8e0P1LNUqjENW2kdPBbI7NrItuiYraGPWFeHRy8a+paG4c5/OxJODk4oJ7XWOo5CIMMn+mq0gpqYUSFjqWNNoy6Df7WSIO5FxVRlpEXJxdqQPu8qPHk4ADeqFxmxAyekFpBTwPs0IMSkwj0XdhYD9phHe28F2LiyVz4/axLkXk0DZJMOHmD/YlvU1jQxN+i0hGDQhv5u1ZOlLwdN2iczETZ3TZCkAXNCcN6UWupXGwNK8D/he2h3eNNCXJFqOXErEoq7rEIN6Js0Aas5ikUhNVPWBu0LN9hXmKkyqFAOSt2rifyXxvrehNDYwnNLhZhrbhLzF5ktk1FaRHktMfLSlxjZzXQbIREOYTXC8hxKprSpSBJ4pxpcAg/ageirkuZsbUhQ0LKI8hGDHiXgzgERJSoeI/fGn0jcySTkMvpFA0pJ3XyFGFMxI7krOYBRB5rjiuEAq3WNjrTpTabIsTNfT5CppVD5Ybw6kbIkpH3xFqQKiubHGFSiuw6ZTuZgsHcK+4CyeqmXt4ZhIyp5znzByyWJIVaEf5Kh+WlXVmsIZwV0q70iTojq3kRabtcDVo71bQysSCqGGAlZJky41L4VU/ASVdiSgpbC7VIIRcOU3B46yb6NoWswOyafxmRSw2Txjky1LRmbnSd67kKvJxq5az8fYtGxp4P5+g4heMUXqTwMoXRUQqjcQqj4xRGL1IYvUxhfJTCeJzC+DiF8QuP1vhl4LVoGdxFYDT2XHZ/Hu6S3f1eWtZsMpi2tcHzng0eDeHgoNUmavvll18u1N2FArhISLkukhO4SFqQiyT1fWQzqW8Uvm/p48vx1+FzQZ8vxi/D55xBR8fhs6DP8ehCLcOCF2rMmDhR1fdgQd2fFYPwFYSI2nhRaov2jBrJEKWxg/aqhw91LLu0fEm0SCWdFKXdTU6EeEIUrVDaIOqYiGJx3U0Rdz8hcrr4UA+bSd/FZrXTFRWesRhvUP/VMJwsu4n3yz4Z2jvofBrpL4h0Mk1nZJp2099aryfEhHWcPo0TXw/ZAWDLvJsPAeAJcaGP0afx4CXxgA6l3Qyg3idEfQcd6ggnvO87Oh6MvhqMj8bHPQ5QbOQBqmqQ54PFYvE5uEc+T1ieXJ7ooXrPjsLQqdHVlvCDo4MVVPCJ+Hd02X8gR30SfVjMKe7rR7Ax4ut62U7nYvHM+qni0NY5I/iVa7booMldhAdHv1mhZRaQJ5jokk0owBsSDwbE9/zwhx8OO5z0jYOqGqw10ueAGd9prKphng/XIDd2xzdWkOcpbDZvbc9zqKpqR7Nvv0jYpfrrkJMK7Intlv4A8EcpwErO+wvfqxyUD9Cq5LU5SNuuHWtHSCFV6AiiAmsABmdNKQzeUrRppVYe+vNrTlSclb/O0SkHdhz7e1bAF6fBJ38ehJpI6E9ALQ+P26CsO4nBGd7yHD4tRsjIPOSnbJMVFL2J6PoT31d5Gv7KRC0pS1Cic9yKLhtuQ8LvWifCpl1dD7Atuh4xwkIcuSXG5u1n8R4d8fEWAox7zrcA8YRM/BpK1OnTFdR9fpFUgj0AkjJc/dauQHORXLZjfFSN+QNjLx+hR4XMsRQTLDe7Hq0DXVqCPHUYQx2VVG0mgPE9Sjud4nat0/ctt+iWp7gr1NGIR9WILIZS2pgL6fOrOzokiziFp9AnWycIcQBMWjH8ZDFvEXucnHsrEDbngSUIDhiwTdTF1R5YobcxXcbQHJVUsmqqNuM4bWeNLKvCad7lF42kNHxcobu7GyuI2wdWCInwHQtcqBFnBmJG4R5fL0A8IWOwhtL9evoxZqJ3Rn6mw+1hBYxkdRVwy5FIoP4wbJXP7ta+IZzSAURZTj+I8lZZhrWjHNenqmaL8qOPIM4C+czWa85s7Za8bv7rCUnfFrT+nyUwwP0xUtgl708kiT20Hy2NPo9Xidk9wS53PyH5C/isbW6SJrrmu1et3uTJSeLvceOtZpLy1Gjda50vkpO7JGTa6WfIY9PQw18t3RffJTYrsBL0K6JEN8xTWdJUlCxGY5M04dQLXTcTv5KTRE9+xcwlKQUQNV2HoaU5eNzJXYTyN4xJGgLx5CTxV49JmuCtqGoCDk2AKtMU7vIUy7jifXO1Lau5LP9o73hpHrrF+8hpeOhy7Yr9o2bqzrBc8XU1mTBGLJL12/x4fRejND+uvZ8oF1FLpCNdaO+UGCxJE+mw6q6yY9eM/nBOZ6iJEs7LfuhY3hZRffCaNK4utPqogeG6ZAvPH8kl37u5cH/LXlF0iHn0mwerG84U+JZh+JDERHimVsy6a3ovcGPNs103350LN1vopszpKguFGfIF9EfXNnD5iCizhis42tOhR1mLakvZaJkmtw8TcwuZHsRrdfiixKmDpq7RQKaNQvO8m1t7MsSNj4+XabJ4mLzFn5K8r2nz5g9T9zPXI6xqNf4TuH75cpkmxcO4/r2tmPgPInv8Yrk669bO8quJzhdX0W4tHwKMhwrBUf3OG3VqcjQdRky0LlGoDU68mXr3SsMz8kWehWQWX3RLY+OBAnNZlmAwQyqa4Zx0tFUQnA5/Cw7h8pG8su+ogb1F20wsQak4n/UTThCckbMZUmFQgODB4SofBReiUTENYSWmdEvPxT4Gb6RubESvEJZv20skh9QVKH19iVSzvnfY4Q5XWnRpH3Z3h1rokFN093969vYRvGTfdQCuaOsIPJV+Djg9e0vlQ3Ia/LAhvLctJyJrRQ8EyC+CGyliiUFr2xc+vYCKOaKZ2F6t1zAU7gxgE6Fc2q0YpasEZ1sruDHxqr6Mtkg3jgrbZKiasA5r2+MjY9Ey8kw3j5HKBzgpYNbw/YgjlY21RJx0XZX/SOWLEDnyyRsTK56CWBAkVSSu+BS5QkCd+VNAZf1wAVNhHZqUyhOJ86ahyKadEm9rNBJVhltZYNCz7qoxW/2mPg/6tTTvf/o+VBVGGqJSTkgD/cSYQ1Oz1LAmtDVecefWSd9wlEg70FztctA2XQ+uxApZtRqN1QqogsrMhJK/exFmj0RbhAkWovSgwVTQ7RLhQxreRyba2n/9458dvHZ6nJuI+RVEnlOq/wEMObL1Ak8et8GaLKDuY0Tzofmv9UOAsGOluap03iqSfbyMv6XCP2dbu+g0F4piib6UNV49tPbWptHG2uBW0g2E4ZsCLnnVNdGLt9K6TpVSvEvctA8/IfEx6+DAbghpNcm8WnQVvMUrVEOtpuNaKtmvcGuPwTVduP848+fdKiYNppiqNrWy3iMfHx3Rv7WN71UWk2K2Vcfl4i9J+viA+P5wwDdTCL4piiuJeV2M/25rVWUFCUmF1vY9+i1DHiCgyzepSqnwKjLlanx0dPUVcW6ZJsfbmPNOV+gKlgiyBXOjqQC4LlFQQapZgJgJqYCWN5+RV2iMNvdT/WGY3ceE46Ojq1HLhK82mfBG8TUMF5uf6WtUfyyl3eWdX55Qva3Yqnmzm0gPxP1Jj9huuyfSYtYY6RbJyfldcjsQtRz4/pPzy+UlSZ0rNKWKam0ZY+GK5CQ53MgccbU/pSXO7xI+npLo+lqhcror2XB/RS0Pb0bJMl0fsdVZ3gltnZhJNRvcO+pyReo72g7P8R7Bq9i+lv+LFNwHfnah0kSSGBQoyD0mDtIu/7RKm30X9yomtLbmqFabsp51ikmnXh5p3fRvyQx1EkPnMSvDiZY2z5KsKEraXAj9bLMb5yvRaxMJMY8w4gB8fHzMkerXIw7pvnzJ0dLxi+Wl53AncuDMZNf99Qnvnh8Xmvp+TZKs+RG9w3z9LN95ru44VqMvJdVU856HfTitUb0jV5VU62a0GZ1imemqLeKN4P/6xz95RDzGeJm/wGljoNZzNPRehapypyXeSnIOO89pKPnG2WlRlWgtZeSUw5l/iiJnXAwQPa5M1GIiS0m2gsC0L7rpmBs7hJ8LpDsC6npmfF3EDZZkYqDUmh9qkHfQOF11n7vAXJvrKaGUgoAJ1faTz2MR4xBUhVAZZey9CrG/QA9TyIetjbQIQlYETL40TqcykzQxGUYjMgeVUGLGB3/KUTJxoY6V+UZPKBSxumy8s03vAxCdJ5FvDIbwLQU3TDg15uho23PvZ9vUxznBToaHLxOKKWtaXmZoVxVUJd6gYZPho9SmLKHWzkeO5Pl095YmckYoS3G4RyhuTcu+4A3zGrlYDIGuDehMIp+QBKCU6to/UzlvxexnnFjpcJUhmM/nG+breX/M36Qrmgn5l3o1bsaNbOy6w9uP52Rs0FT2dPoOzY3MMNjOHWseMvBhONZExsdaVDZRy60ebCkzVBY7h9Crv739Hm7gy+FRknYM9iMQPvz+zTff/fjuO5qXjhSvf6Ph0fCI05raukqozlLf+NdoZysTupZ0b8/n/RO3/RO3/RO3/RO3/RO3/RO3/RO3/RO3/RO3/RO3DaL2T9z2T9z2T9z2T9z2T9z2T9z2T9z2T9z2T9z2T9yeionfP3HbP3HbP3HbP3HbP3F7Ug+L9k/c/ggJ3D9x2z9xe8QTt1DCQl7hYV0KyTVQoWLWly+drz98u0yTguqbTs6Tuzu6/ntvyuWSmn9r0FBx1GWa3AgjKcnNpVFpLAGioplrXNA1tM/ZD85o/dSLO1+Zr1WEUQWTH/GKt/1e2G4J1tvTd2dJmkzC47xK5zTGiDk93BNzXzkTuMlPswS/uiiFmjVcw5P4OalqSTSu6Jc8XXPJU/jRKQUSatHBsF8L5cmgv0TU1gF3d76carls4X3XzhGBsRGa9u9yuVz+G2ObxDM=","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"}}');var s=t(74848),r=t(28453),o=t(33617),a=t.n(o),l=t(17543),d=t.n(l),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const x={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:"eJztO9tyIzeuv4Ltl8m4WrKlOJNZP52ZJGd3zkniqYynUqdsl0N1Q2rG3WSHZFtWXHrbL9lP2y/ZAki2unWxPZeTdar0YqtJkARAAARA8C5xYmaTk/PkDKu6FA5tcpkmOdrMyNpJrZKT5KxAiN3wjUFB7fDq7RsQZannFhqLxoLTkFEnQtZYpyv5u5iUCC5OnMK8kFkBFs0NgrAwKRusjVTOwlQbmKFCI5xUM8h11lRIHXPpCqgN5jiVCnOwzjSZawzaIbyvtQLbZBlaO23KdiWPhtQqBVcgI2rQNUZZENAo+VuDcHAQoa9kfnAArhAOMqFggkROTtQEhLCDzkRQn1Y8sa0xk1NJwGGu4YW6UGeyPoH3dalFDgvdGHj77X+3U9C81HZ+cPAtTpoZvH9zcHD5ReFcbU8OD0VdD3WNysqZKsXEDjNdHeYEWOfT58RBNEizMq4orCwXIPIc5jKfobNMsYJM1wvItDa5VJ71tZghqKaaoLEpCJVDpQ2CVCDAoMgXA6cHjUX4n3enP9J2VMIN4W3Z2LRdLpcGM1cu/PTEgUjVM8+ZF8e0P1LNUqjENW2kdPBbI7NrItuiYraGPWFeHRy8a+paG4c5/OxJODk4oJ7XWOo5CIMMn+mq0gpqYUSFjqWNNoy6Df7WSIO5FxVRlpEXJxdqQPu8qPHk4ADeqFxmxAyekFpBTwPs0IMSkwj0XdhYD9phHe28F2LiyVz4/axLkXk0DZJMOHmD/YlvU1jQxN+i0hGDQhv5u1ZOlLwdN2iczETZ3TZCkAXNCcN6UWupXGwNK8D/he2h3eNNCXJFqOXErEoq7rEIN6Js0Aas5ikUhNVPWBu0LN9hXmKkyqFAOSt2rifyXxvrehNDYwnNLhZhrbhLzF5ktk1FaRHktMfLSlxjZzXQbIREOYTXC8hxKprSpSBJ4pxpcAg/ageirkuZsbUhQ0LKI8hGDHiXgzgERJSoeI/fGn0jcySTkMvpFA0pJ3XyFGFMxI7krOYBRB5rjiuEAq3WNjrTpTabIsTNfT5CppVD5Ybw6kbIkpH3xFqQKiubHGFSiuw6ZTuZgsHcK+4CyeqmXt4ZhIyp5znzByyWJIVaEf5Kh+WlXVmsIZwV0q70iTojq3kRabtcDVo71bQysSCqGGAlZJky41L4VU/ASVdiSgpbC7VIIRcOU3B46yb6NoWswOyafxmRSw2Txjky1LRmbnSd67kKvJxq5az8fYtGxp4P5+g4heMUXqTwMoXRUQqjcQqj4xRGL1IYvUxhfJTCeJzC+DiF8QuP1vhl4LVoGdxFYDT2XHZ/Hu6S3f1eWtZsMpi2tcHzng0eDeHgoNUmavvll18u1N2FArhISLkukhO4SFqQiyT1fWQzqW8Uvm/p48vx1+FzQZ8vxi/D55xBR8fhs6DP8ehCLcOCF2rMmDhR1fdgQd2fFYPwFYSI2nhRaov2jBrJEKWxg/aqhw91LLu0fEm0SCWdFKXdTU6EeEIUrVDaIOqYiGJx3U0Rdz8hcrr4UA+bSd/FZrXTFRWesRhvUP/VMJwsu4n3yz4Z2jvofBrpL4h0Mk1nZJp2099aryfEhHWcPo0TXw/ZAWDLvJsPAeAJcaGP0afx4CXxgA6l3Qyg3idEfQcd6ggnvO87Oh6MvhqMj8bHPQ5QbOQBqmqQ54PFYvE5uEc+T1ieXJ7ooXrPjsLQqdHVlvCDo4MVVPCJ+Hd02X8gR30SfVjMKe7rR7Ax4ut62U7nYvHM+qni0NY5I/iVa7booMldhAdHv1mhZRaQJ5jokk0owBsSDwbE9/zwhx8OO5z0jYOqGqw10ueAGd9prKphng/XIDd2xzdWkOcpbDZvbc9zqKpqR7Nvv0jYpfrrkJMK7Intlv4A8EcpwErO+wvfqxyUD9Cq5LU5SNuuHWtHSCFV6AiiAmsABmdNKQzeUrRppVYe+vNrTlSclb/O0SkHdhz7e1bAF6fBJ38ehJpI6E9ALQ+P26CsO4nBGd7yHD4tRsjIPOSnbJMVFL2J6PoT31d5Gv7KRC0pS1Cic9yKLhtuQ8LvWifCpl1dD7Atuh4xwkIcuSXG5u1n8R4d8fEWAox7zrcA8YRM/BpK1OnTFdR9fpFUgj0AkjJc/dauQHORXLZjfFSN+QNjLx+hR4XMsRQTLDe7Hq0DXVqCPHUYQx2VVG0mgPE9Sjud4nat0/ctt+iWp7gr1NGIR9WILIZS2pgL6fOrOzokiziFp9AnWycIcQBMWjH8ZDFvEXucnHsrEDbngSUIDhiwTdTF1R5YobcxXcbQHJVUsmqqNuM4bWeNLKvCad7lF42kNHxcobu7GyuI2wdWCInwHQtcqBFnBmJG4R5fL0A8IWOwhtL9evoxZqJ3Rn6mw+1hBYxkdRVwy5FIoP4wbJXP7ta+IZzSAURZTj+I8lZZhrWjHNenqmaL8qOPIM4C+czWa85s7Za8bv7rCUnfFrT+nyUwwP0xUtgl708kiT20Hy2NPo9Xidk9wS53PyH5C/isbW6SJrrmu1et3uTJSeLvceOtZpLy1Gjda50vkpO7JGTa6WfIY9PQw18t3RffJTYrsBL0K6JEN8xTWdJUlCxGY5M04dQLXTcTv5KTRE9+xcwlKQUQNV2HoaU5eNzJXYTyN4xJGgLx5CTxV49JmuCtqGoCDk2AKtMU7vIUy7jifXO1Lau5LP9o73hpHrrF+8hpeOhy7Yr9o2bqzrBc8XU1mTBGLJL12/x4fRejND+uvZ8oF1FLpCNdaO+UGCxJE+mw6q6yY9eM/nBOZ6iJEs7LfuhY3hZRffCaNK4utPqogeG6ZAvPH8kl37u5cH/LXlF0iHn0mwerG84U+JZh+JDERHimVsy6a3ovcGPNs103350LN1vopszpKguFGfIF9EfXNnD5iCizhis42tOhR1mLakvZaJkmtw8TcwuZHsRrdfiixKmDpq7RQKaNQvO8m1t7MsSNj4+XabJ4mLzFn5K8r2nz5g9T9zPXI6xqNf4TuH75cpkmxcO4/r2tmPgPInv8Yrk669bO8quJzhdX0W4tHwKMhwrBUf3OG3VqcjQdRky0LlGoDU68mXr3SsMz8kWehWQWX3RLY+OBAnNZlmAwQyqa4Zx0tFUQnA5/Cw7h8pG8su+ogb1F20wsQak4n/UTThCckbMZUmFQgODB4SofBReiUTENYSWmdEvPxT4Gb6RubESvEJZv20skh9QVKH19iVSzvnfY4Q5XWnRpH3Z3h1rokFN093969vYRvGTfdQCuaOsIPJV+Djg9e0vlQ3Ia/LAhvLctJyJrRQ8EyC+CGyliiUFr2xc+vYCKOaKZ2F6t1zAU7gxgE6Fc2q0YpasEZ1sruDHxqr6Mtkg3jgrbZKiasA5r2+MjY9Ey8kw3j5HKBzgpYNbw/YgjlY21RJx0XZX/SOWLEDnyyRsTK56CWBAkVSSu+BS5QkCd+VNAZf1wAVNhHZqUyhOJ86ahyKadEm9rNBJVhltZYNCz7qoxW/2mPg/6tTTvf/o+VBVGGqJSTkgD/cSYQ1Oz1LAmtDVecefWSd9wlEg70FztctA2XQ+uxApZtRqN1QqogsrMhJK/exFmj0RbhAkWovSgwVTQ7RLhQxreRyba2n/9458dvHZ6nJuI+RVEnlOq/wEMObL1Ak8et8GaLKDuY0Tzofmv9UOAsGOluap03iqSfbyMv6XCP2dbu+g0F4piib6UNV49tPbWptHG2uBW0g2E4ZsCLnnVNdGLt9K6TpVSvEvctA8/IfEx6+DAbghpNcm8WnQVvMUrVEOtpuNaKtmvcGuPwTVduP848+fdKiYNppiqNrWy3iMfHx3Rv7WN71UWk2K2Vcfl4i9J+viA+P5wwDdTCL4piiuJeV2M/25rVWUFCUmF1vY9+i1DHiCgyzepSqnwKjLlanx0dPUVcW6ZJsfbmPNOV+gKlgiyBXOjqQC4LlFQQapZgJgJqYCWN5+RV2iMNvdT/WGY3ceE46Ojq1HLhK82mfBG8TUMF5uf6WtUfyyl3eWdX55Qva3Yqnmzm0gPxP1Jj9huuyfSYtYY6RbJyfldcjsQtRz4/pPzy+UlSZ0rNKWKam0ZY+GK5CQ53MgccbU/pSXO7xI+npLo+lqhcror2XB/RS0Pb0bJMl0fsdVZ3gltnZhJNRvcO+pyReo72g7P8R7Bq9i+lv+LFNwHfnah0kSSGBQoyD0mDtIu/7RKm30X9yomtLbmqFabsp51ikmnXh5p3fRvyQx1EkPnMSvDiZY2z5KsKEraXAj9bLMb5yvRaxMJMY8w4gB8fHzMkerXIw7pvnzJ0dLxi+Wl53AncuDMZNf99Qnvnh8Xmvp+TZKs+RG9w3z9LN95ru44VqMvJdVU856HfTitUb0jV5VU62a0GZ1imemqLeKN4P/6xz95RDzGeJm/wGljoNZzNPRehapypyXeSnIOO89pKPnG2WlRlWgtZeSUw5l/iiJnXAwQPa5M1GIiS0m2gsC0L7rpmBs7hJ8LpDsC6npmfF3EDZZkYqDUmh9qkHfQOF11n7vAXJvrKaGUgoAJ1faTz2MR4xBUhVAZZey9CrG/QA9TyIetjbQIQlYETL40TqcykzQxGUYjMgeVUGLGB3/KUTJxoY6V+UZPKBSxumy8s03vAxCdJ5FvDIbwLQU3TDg15uho23PvZ9vUxznBToaHLxOKKWtaXmZoVxVUJd6gYZPho9SmLKHWzkeO5Pl095YmckYoS3G4RyhuTcu+4A3zGrlYDIGuDehMIp+QBKCU6to/UzlvxexnnFjpcJUhmM/nG+breX/M36Qrmgn5l3o1bsaNbOy6w9uP52Rs0FT2dPoOzY3MMNjOHWseMvBhONZExsdaVDZRy60ebCkzVBY7h9Crv739Hm7gy+FRknYM9iMQPvz+zTff/fjuO5qXjhSvf6Ph0fCI05raukqozlLf+NdoZysTupZ0b8/n/RO3/RO3/RO3/RO3/RO3/RO3/RO3/RO3/RO3/RO3DaL2T9z2T9z2T9z2T9z2T9z2T9z2T9z2T9z2T9z2T9yeionfP3HbP3HbP3HbP3HbP3F7Ug+L9k/c/ggJ3D9x2z9xe8QTt1DCQl7hYV0KyTVQoWLWly+drz98u0yTguqbTs6Tuzu6/ntvyuWSmn9r0FBx1GWa3AgjKcnNpVFpLAGioplrXNA1tM/ZD85o/dSLO1+Zr1WEUQWTH/GKt/1e2G4J1tvTd2dJmkzC47xK5zTGiDk93BNzXzkTuMlPswS/uiiFmjVcw5P4OalqSTSu6Jc8XXPJU/jRKQUSatHBsF8L5cmgv0TU1gF3d76carls4X3XzhGBsRGa9u9yuVz+G2ObxDM=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,y={},f=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Template"}),"\n",(0,s.jsx)(a(),{method:"post",path:"/createtemplate",context:"endpoint"}),"\n",(0,s.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,s.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.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,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.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,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio Button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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 "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.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,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded file"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{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},x:{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},y:{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},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},message:{type:"string",example:"Template created successfully!"}},title:"inline_response_200_5"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/bfe4b778.e59f2eb2.js b/assets/js/bfe4b778.f69d6817.js similarity index 98% rename from assets/js/bfe4b778.e59f2eb2.js rename to assets/js/bfe4b778.f69d6817.js index 2a5a7978b..ad13d2ba2 100644 --- a/assets/js/bfe4b778.e59f2eb2.js +++ b/assets/js/bfe4b778.f69d6817.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4948],{55151:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>P,contentTitle:()=>x,default:()=>b,frontMatter:()=>h,metadata:()=>o,toc:()=>g});const o=JSON.parse('{"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":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJzdWF9vGzcS/ypTvlwKrCXZcVtUT5c2QWtcURuxgwDnGMZoOatlzSVZkitZEPR2n+Q+Wj9JMeSutLIUN7kWd8C9GDJ3/v44nPmRaxFxHsT0Vry2ZduQiUHcFUJSKL1yUVkjpuKmJnjnJEaCXgpeXV0Aam2XAdpAPkC00FipqhWgkdBm8VgTSIqodABbAUJwVKpKlSA7QyP42SZBjBBrFZJha/Sqtx5tbwyhoiU49NhQJB8KWNkWSjTGRihrNPPssFKawJqSQMUcQR+0ClB6wkhyJAphHXnkFC+kmIrspM9PFGLnSExv18JgQ2Iqelv3SopCKIbHYazFU8wuXnPCe95TjoZIpqRm1OXFdjz92ipPUkyjb6kQIa40ewuqcZpEIejRaStJTCvUgQXKmhoU07WIK5cko1dmLgpRWd9g3K1sNnfZPoX4nZUr1tkP9crbhZIEM9J2gO8A+UiN0xgpwAuMoAlDBGtoINsn8KUoRGlNZAina4HOaVUmkMe/BPa2Pgzdzn6hMiHueUuiosBfM+B/nCCDgwmmqQjpxxZysSmEsfGzzVxxigSeFoqWqZ6Dmptcn0Pbezh+nottVQxtbFhHS/JckYf2dtosSQZnmi5vrgaiM2s1oTmoRq4qOMkJ2LQIS6U1ZBtweXMFC/J8MNNejeBdOtNJxlNJasHHbygCpZUEC4VADSpdwLJWZc0Fv4KmDRHIdDXUQUeDI5+KGE7gMCCpwtGIitwOlJnv2s2BYZDKUxn1CpYq1raNgFIqVkcNIZILoyGKKYotkDe29X8eSYR5qyRJiLb1UFmfokzNyqVjxhkoE6JvS1YOIFve3ZQHi/Jv521JIexw6lFhoYH9AsiErI5QYYjkC2iNYuR96yLJrUl6dOQVmZKOQpDAvU/9uwM8fDoWV+QbFUOfKW8NSgmkKc0TCG1ZA+bvGFtPoQBlVFSoQwEhYuNCAdZDpEfuKxCt4+ZJjypEDn6p5JxiAPWxOnpLfEbKQQyVt03afcbGrIaFsI0r2ifmbnhTVeimVoWtjrBA3R7DbFOIqOLeUb4fzIb7GbfazYblPAVnTchd7WwyOezA26naTQSGjCugarVeffHXtdS8/EfNBYM8+zFcnf/ouM10Ib2KzyudTc5enpxOTibf3Jx+PT3/dvrV16PJZPJPUYjHRu/6uWBrYohe+n+woIxWhu571O7PJpP7lx2U58fQ67q168bYArWSUCnSEthn+AsBJO+t/w+nyTPxPZc+p9wnf/5M6TAJqmxr5P863WMRPZ/g+f35NsWvDlO8MBkyZoY39oHMfyPDXT5D9zG751D3q1plofRd7CU7XM9JBipbr+Iq0crHE3TqJH+f3t4xWWso1pYpqWszD421mIpx313G60Gf2Qi25xc9S229FlNRx+jCdDwOaOTMPo6sI8OdUeMsjErbjNGp8eJUbIqnGujcZ0iHiHNl5ifPat3tMr7mXcnA7+W9hR+d+getRNHDOpTq2HZNKMmnLeDNfrtjtm/6LdvuylM62LPBTyN4T8fdUco2ZGxC7LGyjqoP6UW3dHTc9rNYmcomSLoSunRkrjk6LsDF6UFY70mXtqF+nPXiv/3r30mjjzq5+QIuWw/OLslXrU6JV5oeFZOLwY2O71VMsAgbTSHoFTCnmHu+C0g1V5H5VMcsSnQ4U1rxiWIxy9oeBocyjOB9TbEmz5/+5pklSVqQ5oMI2tqHRIAsYBttk3z0SC+tf6g4pAIQZm1QhkKAQNSrkKmRb3p9hSUegSazT+dVIEDVsDBzMaoqVSo2zO3DYxmhQYPzRAgK4LgZha5TB/B2xlQ2WN1mssaXXKKYU0xXuRG8ZnKcEufFfNslmXlaKDJP7roJp2EkzChEcOxelZSpbETPF6sF+XSi8j221Rqc5TanUDMjGu4tG4oeTeBenAPqt2YLX0ckkw+JqxF8MB/MNRdLG4gLQCvzEKYfzAncbsvsPc2CinT3oj/ly+Xy4HR/ua/zg4p1OwNPzu705mkx9YKh+vYfvitG8k24rK7JL1RJXWv5iM9xEh53zR/L1PzT7SN3jr8/VeBGrFVJJgybwqsfrn6CBbwcTUQx6GefEPD4p4vv3/x8/YbtcsfN5+90NBlNeMnZEBs0A1dPHk2eHt31bor9v76xdH2dmf3YaVRpOCbQ191guxWDhjsdPq/cFaK2IbLIej3DQO+83mx4+deWPI/Pu0Is0Cvur2n6dfckuW20H4X7xdv+wQI+76XmaEL99DI8utKNIQ+DB1o9eTLa3G2KfoRxxFni+xzXyQ3b2Vk4IDY8gbPGq7IkF5+VHTKJq3c3ohCz7vmnSS9JwuOSn55wmYPNt9k0nNPaWmg08xbnLJtN8tDFlndtOLEf0sTufnBSR+HYH+U5C/7LOR1VWK8zG9hstvL500c1Olx7ad6bu81m8zvLylmf","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"}}');var i=n(74848),s=n(28453),a=n(33617),d=n.n(a),p=n(17543),c=n.n(p),r=n(86013),l=n.n(r),m=n(63723),u=n.n(m),f=(n(18766),n(79329),n(9303));const h={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:"eJzdWF9vGzcS/ypTvlwKrCXZcVtUT5c2QWtcURuxgwDnGMZoOatlzSVZkitZEPR2n+Q+Wj9JMeSutLIUN7kWd8C9GDJ3/v44nPmRaxFxHsT0Vry2ZduQiUHcFUJSKL1yUVkjpuKmJnjnJEaCXgpeXV0Aam2XAdpAPkC00FipqhWgkdBm8VgTSIqodABbAUJwVKpKlSA7QyP42SZBjBBrFZJha/Sqtx5tbwyhoiU49NhQJB8KWNkWSjTGRihrNPPssFKawJqSQMUcQR+0ClB6wkhyJAphHXnkFC+kmIrspM9PFGLnSExv18JgQ2Iqelv3SopCKIbHYazFU8wuXnPCe95TjoZIpqRm1OXFdjz92ipPUkyjb6kQIa40ewuqcZpEIejRaStJTCvUgQXKmhoU07WIK5cko1dmLgpRWd9g3K1sNnfZPoX4nZUr1tkP9crbhZIEM9J2gO8A+UiN0xgpwAuMoAlDBGtoINsn8KUoRGlNZAina4HOaVUmkMe/BPa2Pgzdzn6hMiHueUuiosBfM+B/nCCDgwmmqQjpxxZysSmEsfGzzVxxigSeFoqWqZ6Dmptcn0Pbezh+nottVQxtbFhHS/JckYf2dtosSQZnmi5vrgaiM2s1oTmoRq4qOMkJ2LQIS6U1ZBtweXMFC/J8MNNejeBdOtNJxlNJasHHbygCpZUEC4VADSpdwLJWZc0Fv4KmDRHIdDXUQUeDI5+KGE7gMCCpwtGIitwOlJnv2s2BYZDKUxn1CpYq1raNgFIqVkcNIZILoyGKKYotkDe29X8eSYR5qyRJiLb1UFmfokzNyqVjxhkoE6JvS1YOIFve3ZQHi/Jv521JIexw6lFhoYH9AsiErI5QYYjkC2iNYuR96yLJrUl6dOQVmZKOQpDAvU/9uwM8fDoWV+QbFUOfKW8NSgmkKc0TCG1ZA+bvGFtPoQBlVFSoQwEhYuNCAdZDpEfuKxCt4+ZJjypEDn6p5JxiAPWxOnpLfEbKQQyVt03afcbGrIaFsI0r2ifmbnhTVeimVoWtjrBA3R7DbFOIqOLeUb4fzIb7GbfazYblPAVnTchd7WwyOezA26naTQSGjCugarVeffHXtdS8/EfNBYM8+zFcnf/ouM10Ib2KzyudTc5enpxOTibf3Jx+PT3/dvrV16PJZPJPUYjHRu/6uWBrYohe+n+woIxWhu571O7PJpP7lx2U58fQ67q168bYArWSUCnSEthn+AsBJO+t/w+nyTPxPZc+p9wnf/5M6TAJqmxr5P863WMRPZ/g+f35NsWvDlO8MBkyZoY39oHMfyPDXT5D9zG751D3q1plofRd7CU7XM9JBipbr+Iq0crHE3TqJH+f3t4xWWso1pYpqWszD421mIpx313G60Gf2Qi25xc9S229FlNRx+jCdDwOaOTMPo6sI8OdUeMsjErbjNGp8eJUbIqnGujcZ0iHiHNl5ifPat3tMr7mXcnA7+W9hR+d+getRNHDOpTq2HZNKMmnLeDNfrtjtm/6LdvuylM62LPBTyN4T8fdUco2ZGxC7LGyjqoP6UW3dHTc9rNYmcomSLoSunRkrjk6LsDF6UFY70mXtqF+nPXiv/3r30mjjzq5+QIuWw/OLslXrU6JV5oeFZOLwY2O71VMsAgbTSHoFTCnmHu+C0g1V5H5VMcsSnQ4U1rxiWIxy9oeBocyjOB9TbEmz5/+5pklSVqQ5oMI2tqHRIAsYBttk3z0SC+tf6g4pAIQZm1QhkKAQNSrkKmRb3p9hSUegSazT+dVIEDVsDBzMaoqVSo2zO3DYxmhQYPzRAgK4LgZha5TB/B2xlQ2WN1mssaXXKKYU0xXuRG8ZnKcEufFfNslmXlaKDJP7roJp2EkzChEcOxelZSpbETPF6sF+XSi8j221Rqc5TanUDMjGu4tG4oeTeBenAPqt2YLX0ckkw+JqxF8MB/MNRdLG4gLQCvzEKYfzAncbsvsPc2CinT3oj/ly+Xy4HR/ua/zg4p1OwNPzu705mkx9YKh+vYfvitG8k24rK7JL1RJXWv5iM9xEh53zR/L1PzT7SN3jr8/VeBGrFVJJgybwqsfrn6CBbwcTUQx6GefEPD4p4vv3/x8/YbtcsfN5+90NBlNeMnZEBs0A1dPHk2eHt31bor9v76xdH2dmf3YaVRpOCbQ191guxWDhjsdPq/cFaK2IbLIej3DQO+83mx4+deWPI/Pu0Is0Cvur2n6dfckuW20H4X7xdv+wQI+76XmaEL99DI8utKNIQ+DB1o9eTLa3G2KfoRxxFni+xzXyQ3b2Vk4IDY8gbPGq7IkF5+VHTKJq3c3ohCz7vmnSS9JwuOSn55wmYPNt9k0nNPaWmg08xbnLJtN8tDFlndtOLEf0sTufnBSR+HYH+U5C/7LOR1VWK8zG9hstvL500c1Olx7ad6bu81m8zvLylmf",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,P={},g=[];function I(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Update Document"}),"\n",(0,i.jsx)(d(),{method:"put",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.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)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(c(),{parameters:[{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)(l(),{title:"Body",body:{description:"Provide below parameter to update templates (at least one parameter required)",content:{"application/json":{schema:{type:"object",properties:{name:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"Please review and sign this document"},description:{type:"string",format:"string",example:"document description"},folderId:{type:"string",example:""},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"document_document_id_body"}}}}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document updated successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"asd2HsP4Hp"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_3"}}}},400:{description:"Please provide valid field names!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please provide valid field names!"}},title:"inline_response_400"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Document not found!"}},title:"inline_response_404_4"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(I,{...e})}):I(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4948],{55151:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>P,contentTitle:()=>x,default:()=>b,frontMatter:()=>h,metadata:()=>o,toc:()=>g});const o=JSON.parse('{"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":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJzdWF9vGzcS/ypTvlwKrCXZcVtUT5c2QWtcURuxgwDnGMZoOatlzSVZkitZEPR2n+Q+Wj9JMeSutLIUN7kWd8C9GDJ3/v44nPmRaxFxHsT0Vry2ZduQiUHcFUJSKL1yUVkjpuKmJnjnJEaCXgpeXV0Aam2XAdpAPkC00FipqhWgkdBm8VgTSIqodABbAUJwVKpKlSA7QyP42SZBjBBrFZJha/Sqtx5tbwyhoiU49NhQJB8KWNkWSjTGRihrNPPssFKawJqSQMUcQR+0ClB6wkhyJAphHXnkFC+kmIrspM9PFGLnSExv18JgQ2Iqelv3SopCKIbHYazFU8wuXnPCe95TjoZIpqRm1OXFdjz92ipPUkyjb6kQIa40ewuqcZpEIejRaStJTCvUgQXKmhoU07WIK5cko1dmLgpRWd9g3K1sNnfZPoX4nZUr1tkP9crbhZIEM9J2gO8A+UiN0xgpwAuMoAlDBGtoINsn8KUoRGlNZAina4HOaVUmkMe/BPa2Pgzdzn6hMiHueUuiosBfM+B/nCCDgwmmqQjpxxZysSmEsfGzzVxxigSeFoqWqZ6Dmptcn0Pbezh+nottVQxtbFhHS/JckYf2dtosSQZnmi5vrgaiM2s1oTmoRq4qOMkJ2LQIS6U1ZBtweXMFC/J8MNNejeBdOtNJxlNJasHHbygCpZUEC4VADSpdwLJWZc0Fv4KmDRHIdDXUQUeDI5+KGE7gMCCpwtGIitwOlJnv2s2BYZDKUxn1CpYq1raNgFIqVkcNIZILoyGKKYotkDe29X8eSYR5qyRJiLb1UFmfokzNyqVjxhkoE6JvS1YOIFve3ZQHi/Jv521JIexw6lFhoYH9AsiErI5QYYjkC2iNYuR96yLJrUl6dOQVmZKOQpDAvU/9uwM8fDoWV+QbFUOfKW8NSgmkKc0TCG1ZA+bvGFtPoQBlVFSoQwEhYuNCAdZDpEfuKxCt4+ZJjypEDn6p5JxiAPWxOnpLfEbKQQyVt03afcbGrIaFsI0r2ifmbnhTVeimVoWtjrBA3R7DbFOIqOLeUb4fzIb7GbfazYblPAVnTchd7WwyOezA26naTQSGjCugarVeffHXtdS8/EfNBYM8+zFcnf/ouM10Ib2KzyudTc5enpxOTibf3Jx+PT3/dvrV16PJZPJPUYjHRu/6uWBrYohe+n+woIxWhu571O7PJpP7lx2U58fQ67q168bYArWSUCnSEthn+AsBJO+t/w+nyTPxPZc+p9wnf/5M6TAJqmxr5P863WMRPZ/g+f35NsWvDlO8MBkyZoY39oHMfyPDXT5D9zG751D3q1plofRd7CU7XM9JBipbr+Iq0crHE3TqJH+f3t4xWWso1pYpqWszD421mIpx313G60Gf2Qi25xc9S229FlNRx+jCdDwOaOTMPo6sI8OdUeMsjErbjNGp8eJUbIqnGujcZ0iHiHNl5ifPat3tMr7mXcnA7+W9hR+d+getRNHDOpTq2HZNKMmnLeDNfrtjtm/6LdvuylM62LPBTyN4T8fdUco2ZGxC7LGyjqoP6UW3dHTc9rNYmcomSLoSunRkrjk6LsDF6UFY70mXtqF+nPXiv/3r30mjjzq5+QIuWw/OLslXrU6JV5oeFZOLwY2O71VMsAgbTSHoFTCnmHu+C0g1V5H5VMcsSnQ4U1rxiWIxy9oeBocyjOB9TbEmz5/+5pklSVqQ5oMI2tqHRIAsYBttk3z0SC+tf6g4pAIQZm1QhkKAQNSrkKmRb3p9hSUegSazT+dVIEDVsDBzMaoqVSo2zO3DYxmhQYPzRAgK4LgZha5TB/B2xlQ2WN1mssaXXKKYU0xXuRG8ZnKcEufFfNslmXlaKDJP7roJp2EkzChEcOxelZSpbETPF6sF+XSi8j221Rqc5TanUDMjGu4tG4oeTeBenAPqt2YLX0ckkw+JqxF8MB/MNRdLG4gLQCvzEKYfzAncbsvsPc2CinT3oj/ly+Xy4HR/ua/zg4p1OwNPzu705mkx9YKh+vYfvitG8k24rK7JL1RJXWv5iM9xEh53zR/L1PzT7SN3jr8/VeBGrFVJJgybwqsfrn6CBbwcTUQx6GefEPD4p4vv3/x8/YbtcsfN5+90NBlNeMnZEBs0A1dPHk2eHt31bor9v76xdH2dmf3YaVRpOCbQ191guxWDhjsdPq/cFaK2IbLIej3DQO+83mx4+deWPI/Pu0Is0Cvur2n6dfckuW20H4X7xdv+wQI+76XmaEL99DI8utKNIQ+DB1o9eTLa3G2KfoRxxFni+xzXyQ3b2Vk4IDY8gbPGq7IkF5+VHTKJq3c3ohCz7vmnSS9JwuOSn55wmYPNt9k0nNPaWmg08xbnLJtN8tDFlndtOLEf0sTufnBSR+HYH+U5C/7LOR1VWK8zG9hstvL500c1Olx7ad6bu81m8zvLylmf","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":"Revoke Document","permalink":"/docs/API-docs/revokedocument"}}');var i=n(74848),s=n(28453),a=n(33617),d=n.n(a),p=n(17543),c=n.n(p),r=n(86013),l=n.n(r),m=n(63723),u=n.n(m),f=(n(18766),n(79329),n(9303));const h={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:"eJzdWF9vGzcS/ypTvlwKrCXZcVtUT5c2QWtcURuxgwDnGMZoOatlzSVZkitZEPR2n+Q+Wj9JMeSutLIUN7kWd8C9GDJ3/v44nPmRaxFxHsT0Vry2ZduQiUHcFUJSKL1yUVkjpuKmJnjnJEaCXgpeXV0Aam2XAdpAPkC00FipqhWgkdBm8VgTSIqodABbAUJwVKpKlSA7QyP42SZBjBBrFZJha/Sqtx5tbwyhoiU49NhQJB8KWNkWSjTGRihrNPPssFKawJqSQMUcQR+0ClB6wkhyJAphHXnkFC+kmIrspM9PFGLnSExv18JgQ2Iqelv3SopCKIbHYazFU8wuXnPCe95TjoZIpqRm1OXFdjz92ipPUkyjb6kQIa40ewuqcZpEIejRaStJTCvUgQXKmhoU07WIK5cko1dmLgpRWd9g3K1sNnfZPoX4nZUr1tkP9crbhZIEM9J2gO8A+UiN0xgpwAuMoAlDBGtoINsn8KUoRGlNZAina4HOaVUmkMe/BPa2Pgzdzn6hMiHueUuiosBfM+B/nCCDgwmmqQjpxxZysSmEsfGzzVxxigSeFoqWqZ6Dmptcn0Pbezh+nottVQxtbFhHS/JckYf2dtosSQZnmi5vrgaiM2s1oTmoRq4qOMkJ2LQIS6U1ZBtweXMFC/J8MNNejeBdOtNJxlNJasHHbygCpZUEC4VADSpdwLJWZc0Fv4KmDRHIdDXUQUeDI5+KGE7gMCCpwtGIitwOlJnv2s2BYZDKUxn1CpYq1raNgFIqVkcNIZILoyGKKYotkDe29X8eSYR5qyRJiLb1UFmfokzNyqVjxhkoE6JvS1YOIFve3ZQHi/Jv521JIexw6lFhoYH9AsiErI5QYYjkC2iNYuR96yLJrUl6dOQVmZKOQpDAvU/9uwM8fDoWV+QbFUOfKW8NSgmkKc0TCG1ZA+bvGFtPoQBlVFSoQwEhYuNCAdZDpEfuKxCt4+ZJjypEDn6p5JxiAPWxOnpLfEbKQQyVt03afcbGrIaFsI0r2ifmbnhTVeimVoWtjrBA3R7DbFOIqOLeUb4fzIb7GbfazYblPAVnTchd7WwyOezA26naTQSGjCugarVeffHXtdS8/EfNBYM8+zFcnf/ouM10Ib2KzyudTc5enpxOTibf3Jx+PT3/dvrV16PJZPJPUYjHRu/6uWBrYohe+n+woIxWhu571O7PJpP7lx2U58fQ67q168bYArWSUCnSEthn+AsBJO+t/w+nyTPxPZc+p9wnf/5M6TAJqmxr5P863WMRPZ/g+f35NsWvDlO8MBkyZoY39oHMfyPDXT5D9zG751D3q1plofRd7CU7XM9JBipbr+Iq0crHE3TqJH+f3t4xWWso1pYpqWszD421mIpx313G60Gf2Qi25xc9S229FlNRx+jCdDwOaOTMPo6sI8OdUeMsjErbjNGp8eJUbIqnGujcZ0iHiHNl5ifPat3tMr7mXcnA7+W9hR+d+getRNHDOpTq2HZNKMmnLeDNfrtjtm/6LdvuylM62LPBTyN4T8fdUco2ZGxC7LGyjqoP6UW3dHTc9rNYmcomSLoSunRkrjk6LsDF6UFY70mXtqF+nPXiv/3r30mjjzq5+QIuWw/OLslXrU6JV5oeFZOLwY2O71VMsAgbTSHoFTCnmHu+C0g1V5H5VMcsSnQ4U1rxiWIxy9oeBocyjOB9TbEmz5/+5pklSVqQ5oMI2tqHRIAsYBttk3z0SC+tf6g4pAIQZm1QhkKAQNSrkKmRb3p9hSUegSazT+dVIEDVsDBzMaoqVSo2zO3DYxmhQYPzRAgK4LgZha5TB/B2xlQ2WN1mssaXXKKYU0xXuRG8ZnKcEufFfNslmXlaKDJP7roJp2EkzChEcOxelZSpbETPF6sF+XSi8j221Rqc5TanUDMjGu4tG4oeTeBenAPqt2YLX0ckkw+JqxF8MB/MNRdLG4gLQCvzEKYfzAncbsvsPc2CinT3oj/ly+Xy4HR/ua/zg4p1OwNPzu705mkx9YKh+vYfvitG8k24rK7JL1RJXWv5iM9xEh53zR/L1PzT7SN3jr8/VeBGrFVJJgybwqsfrn6CBbwcTUQx6GefEPD4p4vv3/x8/YbtcsfN5+90NBlNeMnZEBs0A1dPHk2eHt31bor9v76xdH2dmf3YaVRpOCbQ191guxWDhjsdPq/cFaK2IbLIej3DQO+83mx4+deWPI/Pu0Is0Cvur2n6dfckuW20H4X7xdv+wQI+76XmaEL99DI8utKNIQ+DB1o9eTLa3G2KfoRxxFni+xzXyQ3b2Vk4IDY8gbPGq7IkF5+VHTKJq3c3ohCz7vmnSS9JwuOSn55wmYPNt9k0nNPaWmg08xbnLJtN8tDFlndtOLEf0sTufnBSR+HYH+U5C/7LOR1VWK8zG9hstvL500c1Olx7ad6bu81m8zvLylmf",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,P={},g=[];function I(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Update Document"}),"\n",(0,i.jsx)(d(),{method:"put",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.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)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(c(),{parameters:[{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)(l(),{title:"Body",body:{description:"Provide below parameter to update templates (at least one parameter required)",content:{"application/json":{schema:{type:"object",properties:{name:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"Please review and sign this document"},description:{type:"string",format:"string",example:"document description"},folderId:{type:"string",example:""},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"document_document_id_body"}}}}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document updated successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"asd2HsP4Hp"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_3"}}}},400:{description:"Please provide valid field names!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please provide valid field names!"}},title:"inline_response_400"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Document not found!"}},title:"inline_response_404_4"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(I,{...e})}):I(e)}}}]); \ No newline at end of file diff --git a/assets/js/main.707be612.js b/assets/js/main.1f91456d.js similarity index 54% rename from assets/js/main.707be612.js rename to assets/js/main.1f91456d.js index 24d4bc222..c75493a1e 100644 --- a/assets/js/main.707be612.js +++ b/assets/js/main.1f91456d.js @@ -1,2 +1,2 @@ -/*! For license information please see main.707be612.js.LICENSE.txt */ -(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8792],{204:(e,t,n)=>{"use strict";n.d(t,{G:()=>r});const r={page:{blogListPage:"blog-list-page",blogPostPage:"blog-post-page",blogTagsListPage:"blog-tags-list-page",blogTagPostListPage:"blog-tags-post-list-page",blogAuthorsListPage:"blog-authors-list-page",blogAuthorsPostsPage:"blog-authors-posts-page",docsDocPage:"docs-doc-page",docsTagsListPage:"docs-tags-list-page",docsTagDocListPage:"docs-tags-doc-list-page",mdxPage:"mdx-page"},wrapper:{main:"main-wrapper",blogPages:"blog-wrapper",docsPages:"docs-wrapper",mdxPages:"mdx-wrapper"},common:{editThisPage:"theme-edit-this-page",lastUpdated:"theme-last-updated",backToTopButton:"theme-back-to-top-button",codeBlock:"theme-code-block",admonition:"theme-admonition",unlistedBanner:"theme-unlisted-banner",draftBanner:"theme-draft-banner",admonitionType:e=>`theme-admonition-${e}`},layout:{},docs:{docVersionBanner:"theme-doc-version-banner",docVersionBadge:"theme-doc-version-badge",docBreadcrumbs:"theme-doc-breadcrumbs",docMarkdown:"theme-doc-markdown",docTocMobile:"theme-doc-toc-mobile",docTocDesktop:"theme-doc-toc-desktop",docFooter:"theme-doc-footer",docFooterTagsRow:"theme-doc-footer-tags-row",docFooterEditMetaRow:"theme-doc-footer-edit-meta-row",docSidebarContainer:"theme-doc-sidebar-container",docSidebarMenu:"theme-doc-sidebar-menu",docSidebarItemCategory:"theme-doc-sidebar-item-category",docSidebarItemLink:"theme-doc-sidebar-item-link",docSidebarItemCategoryLevel:e=>`theme-doc-sidebar-item-category-level-${e}`,docSidebarItemLinkLevel:e=>`theme-doc-sidebar-item-link-level-${e}`},blog:{blogFooterTagsRow:"theme-blog-footer-tags-row",blogFooterEditMetaRow:"theme-blog-footer-edit-meta-row"},pages:{pageFooterEditMetaRow:"theme-pages-footer-edit-meta-row"}}},1093:e=>{"use strict";var t=Object.prototype.toString;e.exports=function(e){var n=t.call(e),r="[object Arguments]"===n;return r||(r="[object Array]"!==n&&null!==e&&"object"==typeof e&&"number"==typeof e.length&&e.length>=0&&"[object Function]"===t.call(e.callee)),r}},1189:(e,t,n)=>{"use strict";var r=Array.prototype.slice,o=n(1093),a=Object.keys,i=a?function(e){return a(e)}:n(28875),l=Object.keys;i.shim=function(){if(Object.keys){var e=function(){var e=Object.keys(arguments);return e&&e.length===arguments.length}(1,2);e||(Object.keys=function(e){return o(e)?l(r.call(e)):l(e)})}else Object.keys=i;return Object.keys||i},e.exports=i},2694:(e,t,n)=>{"use strict";var r=n(6925);function o(){}function a(){}a.resetWarningCache=o,e.exports=function(){function e(e,t,n,o,a,i){if(i!==r){var l=new Error("Calling PropTypes validators directly is not supported by the `prop-types` package. Use PropTypes.checkPropTypes() to call them. Read more at http://fb.me/use-check-prop-types");throw l.name="Invariant Violation",l}}function t(){return e}e.isRequired=e;var n={array:e,bigint:e,bool:e,func:e,number:e,object:e,string:e,symbol:e,any:e,arrayOf:t,element:e,elementType:e,instanceOf:t,node:e,objectOf:t,oneOf:t,oneOfType:t,shape:t,exact:t,checkPropTypes:a,resetWarningCache:o};return n.PropTypes=n,n}},2833:e=>{e.exports=function(e,t,n,r){var o=n?n.call(r,e,t):void 0;if(void 0!==o)return!!o;if(e===t)return!0;if("object"!=typeof e||!e||"object"!=typeof t||!t)return!1;var a=Object.keys(e),i=Object.keys(t);if(a.length!==i.length)return!1;for(var l=Object.prototype.hasOwnProperty.bind(t),s=0;s{"use strict";n.r(t)},3918:(e,t,n)=>{"use strict";var r=n(65606);function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;te.length)&&(n=e.length),e.substring(n-t.length,n)===t}var w="",k="",x="",S="",E={deepStrictEqual:"Expected values to be strictly deep-equal:",strictEqual:"Expected values to be strictly equal:",strictEqualObject:'Expected "actual" to be reference-equal to "expected":',deepEqual:"Expected values to be loosely deep-equal:",equal:"Expected values to be loosely equal:",notDeepStrictEqual:'Expected "actual" not to be strictly deep-equal to:',notStrictEqual:'Expected "actual" to be strictly unequal to:',notStrictEqualObject:'Expected "actual" not to be reference-equal to "expected":',notDeepEqual:'Expected "actual" not to be loosely deep-equal to:',notEqual:'Expected "actual" to be loosely unequal to:',notIdentical:"Values identical but not reference-equal:"};function _(e){var t=Object.keys(e),n=Object.create(Object.getPrototypeOf(e));return t.forEach((function(t){n[t]=e[t]})),Object.defineProperty(n,"message",{value:e.message}),n}function A(e){return y(e,{compact:!1,customInspect:!1,depth:1e3,maxArrayLength:1/0,showHidden:!1,breakLength:1/0,showProxy:!1,sorted:!0,getters:!0})}function P(e,t,n){var o="",a="",i=0,l="",s=!1,c=A(e),u=c.split("\n"),d=A(t).split("\n"),p=0,f="";if("strictEqual"===n&&"object"===h(e)&&"object"===h(t)&&null!==e&&null!==t&&(n="strictEqualObject"),1===u.length&&1===d.length&&u[0]!==d[0]){var m=u[0].length+d[0].length;if(m<=10){if(!("object"===h(e)&&null!==e||"object"===h(t)&&null!==t||0===e&&0===t))return"".concat(E[n],"\n\n")+"".concat(u[0]," !== ").concat(d[0],"\n")}else if("strictEqualObject"!==n){if(m<(r.stderr&&r.stderr.isTTY?r.stderr.columns:80)){for(;u[0][p]===d[0][p];)p++;p>2&&(f="\n ".concat(function(e,t){if(t=Math.floor(t),0==e.length||0==t)return"";var n=e.length*t;for(t=Math.floor(Math.log(t)/Math.log(2));t;)e+=e,t--;return e+e.substring(0,n-e.length)}(" ",p),"^"),p=0)}}}for(var g=u[u.length-1],y=d[d.length-1];g===y&&(p++<2?l="\n ".concat(g).concat(l):o=g,u.pop(),d.pop(),0!==u.length&&0!==d.length);)g=u[u.length-1],y=d[d.length-1];var b=Math.max(u.length,d.length);if(0===b){var _=c.split("\n");if(_.length>30)for(_[26]="".concat(w,"...").concat(S);_.length>27;)_.pop();return"".concat(E.notIdentical,"\n\n").concat(_.join("\n"),"\n")}p>3&&(l="\n".concat(w,"...").concat(S).concat(l),s=!0),""!==o&&(l="\n ".concat(o).concat(l),o="");var P=0,j=E[n]+"\n".concat(k,"+ actual").concat(S," ").concat(x,"- expected").concat(S),C=" ".concat(w,"...").concat(S," Lines skipped");for(p=0;p1&&p>2&&(O>4?(a+="\n".concat(w,"...").concat(S),s=!0):O>3&&(a+="\n ".concat(d[p-2]),P++),a+="\n ".concat(d[p-1]),P++),i=p,o+="\n".concat(x,"-").concat(S," ").concat(d[p]),P++;else if(d.length1&&p>2&&(O>4?(a+="\n".concat(w,"...").concat(S),s=!0):O>3&&(a+="\n ".concat(u[p-2]),P++),a+="\n ".concat(u[p-1]),P++),i=p,a+="\n".concat(k,"+").concat(S," ").concat(u[p]),P++;else{var T=d[p],I=u[p],R=I!==T&&(!v(I,",")||I.slice(0,-1)!==T);R&&v(T,",")&&T.slice(0,-1)===I&&(R=!1,I+=","),R?(O>1&&p>2&&(O>4?(a+="\n".concat(w,"...").concat(S),s=!0):O>3&&(a+="\n ".concat(u[p-2]),P++),a+="\n ".concat(u[p-1]),P++),i=p,a+="\n".concat(k,"+").concat(S," ").concat(I),o+="\n".concat(x,"-").concat(S," ").concat(T),P+=2):(a+=o,o="",1!==O&&0!==p||(a+="\n ".concat(I),P++))}if(P>20&&p30)for(f[26]="".concat(w,"...").concat(S);f.length>27;)f.pop();t=1===f.length?p.call(this,"".concat(d," ").concat(f[0])):p.call(this,"".concat(d,"\n\n").concat(f.join("\n"),"\n"))}else{var m=A(i),g="",y=E[o];"notDeepEqual"===o||"notEqual"===o?(m="".concat(E[o],"\n\n").concat(m)).length>1024&&(m="".concat(m.slice(0,1021),"...")):(g="".concat(A(l)),m.length>512&&(m="".concat(m.slice(0,509),"...")),g.length>512&&(g="".concat(g.slice(0,509),"...")),"deepEqual"===o||"equal"===o?m="".concat(y,"\n\n").concat(m,"\n\nshould equal\n\n"):g=" ".concat(o," ").concat(g)),t=p.call(this,"".concat(m).concat(g))}return Error.stackTraceLimit=s,t.generatedMessage=!n,Object.defineProperty(u(t),"name",{value:"AssertionError [ERR_ASSERTION]",enumerable:!1,writable:!0,configurable:!0}),t.code="ERR_ASSERTION",t.actual=i,t.expected=l,t.operator=o,Error.captureStackTrace&&Error.captureStackTrace(u(t),a),t.stack,t.name="AssertionError",c(t)}return i=v,(s=[{key:"toString",value:function(){return"".concat(this.name," [").concat(this.code,"]: ").concat(this.message)}},{key:t,value:function(e,t){return y(this,a(a({},t),{},{customInspect:!1,depth:0}))}}])&&l(i.prototype,s),d&&l(i,d),Object.defineProperty(i,"prototype",{writable:!1}),v}(d(Error),y.custom);e.exports=j},4023:(e,t,n)=>{"use strict";n.d(t,{A:()=>g});var r=n(96540),o=n(61934),a=n(27143),i=n(30099),l=n(36668),s=n(75313),c=n(74848);function u(e){let{error:t,tryAgain:n}=e;return(0,c.jsxs)("div",{style:{display:"flex",flexDirection:"column",justifyContent:"center",alignItems:"flex-start",minHeight:"100vh",width:"100%",maxWidth:"80ch",fontSize:"20px",margin:"0 auto",padding:"1rem"},children:[(0,c.jsx)("h1",{style:{fontSize:"3rem"},children:"This page crashed"}),(0,c.jsx)("button",{type:"button",onClick:n,style:{margin:"1rem 0",fontSize:"2rem",cursor:"pointer",borderRadius:20,padding:"1rem"},children:"Try again"}),(0,c.jsx)(d,{error:t})]})}function d(e){let{error:t}=e;const n=(0,i.rA)(t).map((e=>e.message)).join("\n\nCause:\n");return(0,c.jsx)("p",{style:{whiteSpace:"pre-wrap"},children:n})}function p(e){let{children:t}=e;return(0,c.jsx)(s.W,{value:{plugin:{name:"docusaurus-core-error-boundary",id:"default"}},children:t})}function f(e){let{error:t,tryAgain:n}=e;return(0,c.jsx)(p,{children:(0,c.jsxs)(g,{fallback:()=>(0,c.jsx)(u,{error:t,tryAgain:n}),children:[(0,c.jsx)(a.A,{children:(0,c.jsx)("title",{children:"Page Error"})}),(0,c.jsx)(l.A,{children:(0,c.jsx)(u,{error:t,tryAgain:n})})]})})}const m=e=>(0,c.jsx)(f,{...e});class g extends r.Component{constructor(e){super(e),this.state={error:null}}componentDidCatch(e){o.default.canUseDOM&&this.setState({error:e})}render(){const{children:e}=this.props,{error:t}=this.state;if(t){const e={error:t,tryAgain:()=>this.setState({error:null})};return(this.props.fallback??m)(e)}return e??null}}},4146:(e,t,n)=>{"use strict";var r=n(44363),o={childContextTypes:!0,contextType:!0,contextTypes:!0,defaultProps:!0,displayName:!0,getDefaultProps:!0,getDerivedStateFromError:!0,getDerivedStateFromProps:!0,mixins:!0,propTypes:!0,type:!0},a={name:!0,length:!0,prototype:!0,caller:!0,callee:!0,arguments:!0,arity:!0},i={$$typeof:!0,compare:!0,defaultProps:!0,displayName:!0,propTypes:!0,type:!0},l={};function s(e){return r.isMemo(e)?i:l[e.$$typeof]||o}l[r.ForwardRef]={$$typeof:!0,render:!0,defaultProps:!0,displayName:!0,propTypes:!0},l[r.Memo]=i;var c=Object.defineProperty,u=Object.getOwnPropertyNames,d=Object.getOwnPropertySymbols,p=Object.getOwnPropertyDescriptor,f=Object.getPrototypeOf,m=Object.prototype;e.exports=function e(t,n,r){if("string"!=typeof n){if(m){var o=f(n);o&&o!==m&&e(t,o,r)}var i=u(n);d&&(i=i.concat(d(n)));for(var l=s(t),g=s(n),h=0;h{"use strict";n.r(t),n.d(t,{default:()=>r});const r={title:"OpenSign\u2122",tagline:"Official OpenSign\u2122 Docs - tutorials, API documentation, self-host help & much more.",favicon:"img/favicon.ico",url:"https://docs.opensignlabs.com",baseUrl:"/",organizationName:"opensignlabs",projectName:"opensign",onBrokenLinks:"throw",onBrokenMarkdownLinks:"warn",i18n:{defaultLocale:"en",locales:["en"],path:"i18n",localeConfigs:{}},presets:[["classic",{docs:{sidebarPath:"./sidebars.js",editUrl:"https://github.com/opensignlabs/opensign/tree/feat-docs/docs/",docItemComponent:"@theme/ApiItem"},blog:{showReadingTime:!0,editUrl:"https://github.com/facebook/docusaurus/tree/feat-docs/docs/"},theme:{customCss:"./src/css/custom.css"}}]],plugins:[["docusaurus-plugin-openapi-docs",{id:"openapi",docsPluginId:"default",config:{opensign:{specPath:"docs/API-docs/opensign.yaml",outputDir:"docs/API-docs",sidebarOptions:{groupPathsBy:"tag"}}}}]],themes:["docusaurus-theme-openapi-docs"],themeConfig:{announcementBar:{id:"support_us",content:'Help use spread the word - \u2b50 OpenSign on GitHub',backgroundColor:"#cae4fa",textColor:"#091E42",isCloseable:!1},image:"img/docusaurus-social-card.png",navbar:{title:"OpenSign\u2122",logo:{alt:"OpenSign\u2122 Logo",src:"img/logo.png"},items:[{type:"docSidebar",sidebarId:"tutorialSidebar",position:"left",label:"Help"},{type:"docSidebar",sidebarId:"apiSidebar",position:"left",label:"APIs"},{type:"docSidebar",sidebarId:"contributeSidebar",position:"left",label:"Contribute"},{href:"https://www.opensignlabs.com/plans-pricing",label:"Cloud Pricing",position:"left"},{type:"docSidebar",sidebarId:"selfhostSidebar",position:"left",label:"Self-host"},{href:"https://github.com/opensignlabs/opensign",label:"GitHub",position:"right"}],hideOnScroll:!1},footer:{style:"dark",links:[{title:"Docs",items:[{label:"Help",to:"/docs/help/intro"},{label:"APIs",to:"/docs/API-docs/opensign-api-v-1"},{label:"Contribute",to:"/docs/contribute/intro"},{label:"Self-host",to:"/docs/self-host/intro"}]},{title:"Community",items:[{label:"Discord",href:"https://discord.com/invite/xe9TDuyAyj"},{label:"LinkedIn",href:"https://www.linkedin.com/company/opensign%E2%84%A2/"},{label:"Twitter",href:"https://www.twitter.com/opensignhq"},{label:"Facebook",href:"https://www.facebook.com/profile.php?id=61551030403669"}]},{title:"More",items:[{label:"Official Website",href:"https://www.opensignlabs.com"},{label:"GitHub",href:"https://github.com/opensignlabs/opensign"}]}],copyright:"Copyright \xa9 2025 OpenSign\u2122.
The best Open Source DocuSign alternative."},prism:{theme:{plain:{color:"#393A34",backgroundColor:"#f6f8fa"},styles:[{types:["comment","prolog","doctype","cdata"],style:{color:"#999988",fontStyle:"italic"}},{types:["namespace"],style:{opacity:.7}},{types:["string","attr-value"],style:{color:"#e3116c"}},{types:["punctuation","operator"],style:{color:"#393A34"}},{types:["entity","url","symbol","number","boolean","variable","constant","property","regex","inserted"],style:{color:"#36acaa"}},{types:["atrule","keyword","attr-name","selector"],style:{color:"#00a4db"}},{types:["function","deleted","tag"],style:{color:"#d73a49"}},{types:["function-variable"],style:{color:"#6f42c1"}},{types:["tag","selector","keyword"],style:{color:"#00009f"}}]},darkTheme:{plain:{color:"#F8F8F2",backgroundColor:"#282A36"},styles:[{types:["prolog","constant","builtin"],style:{color:"rgb(189, 147, 249)"}},{types:["inserted","function"],style:{color:"rgb(80, 250, 123)"}},{types:["deleted"],style:{color:"rgb(255, 85, 85)"}},{types:["changed"],style:{color:"rgb(255, 184, 108)"}},{types:["punctuation","symbol"],style:{color:"rgb(248, 248, 242)"}},{types:["string","char","tag","selector"],style:{color:"rgb(255, 121, 198)"}},{types:["keyword","variable"],style:{color:"rgb(189, 147, 249)",fontStyle:"italic"}},{types:["comment"],style:{color:"rgb(98, 114, 164)"}},{types:["attr-name"],style:{color:"rgb(241, 250, 140)"}}]},additionalLanguages:[],magicComments:[{className:"theme-code-block-highlighted-line",line:"highlight-next-line",block:{start:"highlight-start",end:"highlight-end"}}]},colorMode:{defaultMode:"light",disableSwitch:!1,respectPrefersColorScheme:!1},docs:{versionPersistence:"localStorage",sidebar:{hideable:!1,autoCollapseCategories:!1}},blog:{sidebar:{groupByYear:!0}},metadata:[],tableOfContents:{minHeadingLevel:2,maxHeadingLevel:3}},baseUrlIssueBanner:!0,future:{experimental_faster:{swcJsLoader:!1,swcJsMinimizer:!1,swcHtmlMinimizer:!1,lightningCssMinimizer:!1,mdxCrossCompilerCache:!1,rspackBundler:!1},experimental_storage:{type:"localStorage",namespace:!1},experimental_router:"browser"},onBrokenAnchors:"warn",onDuplicateRoutes:"warn",staticDirectories:["static"],customFields:{},scripts:[],headTags:[],stylesheets:[],clientModules:[],titleDelimiter:"|",noIndex:!1,markdown:{format:"mdx",mermaid:!1,mdx1Compat:{comments:!0,admonitions:!0,headingIds:!0},anchors:{maintainCase:!1}}}},5338:(e,t,n)=>{"use strict";var r=n(40961);t.createRoot=r.createRoot,t.hydrateRoot=r.hydrateRoot},5528:(e,t,n)=>{"use strict";n.d(t,{M:()=>f,e:()=>p});var r=n(96540),o=n(63065),a=n(86682),i=n(30604),l=n(53115),s=n(26849),c=n(74848);const u=r.createContext(void 0);function d(){const e=function(){const e=(0,o.YL)(),{items:t}=(0,l.p)().navbar;return 0===t.length&&!e.component}(),t=(0,a.l)(),n=!e&&"mobile"===t,[s,c]=(0,r.useState)(!1);(0,i.$Z)((()=>{if(s)return c(!1),!1}));const u=(0,r.useCallback)((()=>{c((e=>!e))}),[]);return(0,r.useEffect)((()=>{"desktop"===t&&c(!1)}),[t]),(0,r.useMemo)((()=>({disabled:e,shouldRender:n,toggle:u,shown:s})),[e,n,u,s])}function p(e){let{children:t}=e;const n=d();return(0,c.jsx)(u.Provider,{value:n,children:t})}function f(){const e=r.useContext(u);if(void 0===e)throw new s.dV("NavbarMobileSidebarProvider");return e}},5556:(e,t,n)=>{e.exports=n(2694)()},5947:function(e,t,n){var r,o;r=function(){var e,t,n={version:"0.2.0"},r=n.settings={minimum:.08,easing:"ease",positionUsing:"",speed:200,trickle:!0,trickleRate:.02,trickleSpeed:800,showSpinner:!0,barSelector:'[role="bar"]',spinnerSelector:'[role="spinner"]',parent:"body",template:'
'};function o(e,t,n){return en?n:e}function a(e){return 100*(-1+e)}function i(e,t,n){var o;return(o="translate3d"===r.positionUsing?{transform:"translate3d("+a(e)+"%,0,0)"}:"translate"===r.positionUsing?{transform:"translate("+a(e)+"%,0)"}:{"margin-left":a(e)+"%"}).transition="all "+t+"ms "+n,o}n.configure=function(e){var t,n;for(t in e)void 0!==(n=e[t])&&e.hasOwnProperty(t)&&(r[t]=n);return this},n.status=null,n.set=function(e){var t=n.isStarted();e=o(e,r.minimum,1),n.status=1===e?null:e;var a=n.render(!t),c=a.querySelector(r.barSelector),u=r.speed,d=r.easing;return a.offsetWidth,l((function(t){""===r.positionUsing&&(r.positionUsing=n.getPositioningCSS()),s(c,i(e,u,d)),1===e?(s(a,{transition:"none",opacity:1}),a.offsetWidth,setTimeout((function(){s(a,{transition:"all "+u+"ms linear",opacity:0}),setTimeout((function(){n.remove(),t()}),u)}),u)):setTimeout(t,u)})),this},n.isStarted=function(){return"number"==typeof n.status},n.start=function(){n.status||n.set(0);var e=function(){setTimeout((function(){n.status&&(n.trickle(),e())}),r.trickleSpeed)};return r.trickle&&e(),this},n.done=function(e){return e||n.status?n.inc(.3+.5*Math.random()).set(1):this},n.inc=function(e){var t=n.status;return t?("number"!=typeof e&&(e=(1-t)*o(Math.random()*t,.1,.95)),t=o(t+e,0,.994),n.set(t)):n.start()},n.trickle=function(){return n.inc(Math.random()*r.trickleRate)},e=0,t=0,n.promise=function(r){return r&&"resolved"!==r.state()?(0===t&&n.start(),e++,t++,r.always((function(){0==--t?(e=0,n.done()):n.set((e-t)/e)})),this):this},n.render=function(e){if(n.isRendered())return document.getElementById("nprogress");u(document.documentElement,"nprogress-busy");var t=document.createElement("div");t.id="nprogress",t.innerHTML=r.template;var o,i=t.querySelector(r.barSelector),l=e?"-100":a(n.status||0),c=document.querySelector(r.parent);return s(i,{transition:"all 0 linear",transform:"translate3d("+l+"%,0,0)"}),r.showSpinner||(o=t.querySelector(r.spinnerSelector))&&f(o),c!=document.body&&u(c,"nprogress-custom-parent"),c.appendChild(t),t},n.remove=function(){d(document.documentElement,"nprogress-busy"),d(document.querySelector(r.parent),"nprogress-custom-parent");var e=document.getElementById("nprogress");e&&f(e)},n.isRendered=function(){return!!document.getElementById("nprogress")},n.getPositioningCSS=function(){var e=document.body.style,t="WebkitTransform"in e?"Webkit":"MozTransform"in e?"Moz":"msTransform"in e?"ms":"OTransform"in e?"O":"";return t+"Perspective"in e?"translate3d":t+"Transform"in e?"translate":"margin"};var l=function(){var e=[];function t(){var n=e.shift();n&&n(t)}return function(n){e.push(n),1==e.length&&t()}}(),s=function(){var e=["Webkit","O","Moz","ms"],t={};function n(e){return e.replace(/^-ms-/,"ms-").replace(/-([\da-z])/gi,(function(e,t){return t.toUpperCase()}))}function r(t){var n=document.body.style;if(t in n)return t;for(var r,o=e.length,a=t.charAt(0).toUpperCase()+t.slice(1);o--;)if((r=e[o]+a)in n)return r;return t}function o(e){return e=n(e),t[e]||(t[e]=r(e))}function a(e,t,n){t=o(t),e.style[t]=n}return function(e,t){var n,r,o=arguments;if(2==o.length)for(n in t)void 0!==(r=t[n])&&t.hasOwnProperty(n)&&a(e,n,r);else a(e,o[1],o[2])}}();function c(e,t){return("string"==typeof e?e:p(e)).indexOf(" "+t+" ")>=0}function u(e,t){var n=p(e),r=n+t;c(n,t)||(e.className=r.substring(1))}function d(e,t){var n,r=p(e);c(e,t)&&(n=r.replace(" "+t+" "," "),e.className=n.substring(1,n.length-1))}function p(e){return(" "+(e.className||"")+" ").replace(/\s+/gi," ")}function f(e){e&&e.parentNode&&e.parentNode.removeChild(e)}return n},void 0===(o="function"==typeof r?r.call(t,n,t,e):r)||(e.exports=o)},6188:e=>{"use strict";e.exports=Math.max},6549:e=>{"use strict";e.exports=Object.getOwnPropertyDescriptor},6925:e=>{"use strict";e.exports="SECRET_DO_NOT_PASS_THIS_OR_YOU_WILL_BE_FIRED"},6969:e=>{e.exports&&(e.exports={core:{meta:{path:"components/prism-core.js",option:"mandatory"},core:"Core"},themes:{meta:{path:"themes/{id}.css",link:"index.html?theme={id}",exclusive:!0},prism:{title:"Default",option:"default"},"prism-dark":"Dark","prism-funky":"Funky","prism-okaidia":{title:"Okaidia",owner:"ocodia"},"prism-twilight":{title:"Twilight",owner:"remybach"},"prism-coy":{title:"Coy",owner:"tshedor"},"prism-solarizedlight":{title:"Solarized Light",owner:"hectormatos2011 "},"prism-tomorrow":{title:"Tomorrow Night",owner:"Rosey"}},languages:{meta:{path:"components/prism-{id}",noCSS:!0,examplesPath:"examples/prism-{id}",addCheckAll:!0},markup:{title:"Markup",alias:["html","xml","svg","mathml","ssml","atom","rss"],aliasTitles:{html:"HTML",xml:"XML",svg:"SVG",mathml:"MathML",ssml:"SSML",atom:"Atom",rss:"RSS"},option:"default"},css:{title:"CSS",option:"default",modify:"markup"},clike:{title:"C-like",option:"default"},javascript:{title:"JavaScript",require:"clike",modify:"markup",optional:"regex",alias:"js",option:"default"},abap:{title:"ABAP",owner:"dellagustin"},abnf:{title:"ABNF",owner:"RunDevelopment"},actionscript:{title:"ActionScript",require:"javascript",modify:"markup",owner:"Golmote"},ada:{title:"Ada",owner:"Lucretia"},agda:{title:"Agda",owner:"xy-ren"},al:{title:"AL",owner:"RunDevelopment"},antlr4:{title:"ANTLR4",alias:"g4",owner:"RunDevelopment"},apacheconf:{title:"Apache Configuration",owner:"GuiTeK"},apex:{title:"Apex",require:["clike","sql"],owner:"RunDevelopment"},apl:{title:"APL",owner:"ngn"},applescript:{title:"AppleScript",owner:"Golmote"},aql:{title:"AQL",owner:"RunDevelopment"},arduino:{title:"Arduino",require:"cpp",alias:"ino",owner:"dkern"},arff:{title:"ARFF",owner:"Golmote"},armasm:{title:"ARM Assembly",alias:"arm-asm",owner:"RunDevelopment"},arturo:{title:"Arturo",alias:"art",optional:["bash","css","javascript","markup","markdown","sql"],owner:"drkameleon"},asciidoc:{alias:"adoc",title:"AsciiDoc",owner:"Golmote"},aspnet:{title:"ASP.NET (C#)",require:["markup","csharp"],owner:"nauzilus"},asm6502:{title:"6502 Assembly",owner:"kzurawel"},asmatmel:{title:"Atmel AVR Assembly",owner:"cerkit"},autohotkey:{title:"AutoHotkey",owner:"aviaryan"},autoit:{title:"AutoIt",owner:"Golmote"},avisynth:{title:"AviSynth",alias:"avs",owner:"Zinfidel"},"avro-idl":{title:"Avro IDL",alias:"avdl",owner:"RunDevelopment"},awk:{title:"AWK",alias:"gawk",aliasTitles:{gawk:"GAWK"},owner:"RunDevelopment"},bash:{title:"Bash",alias:["sh","shell"],aliasTitles:{sh:"Shell",shell:"Shell"},owner:"zeitgeist87"},basic:{title:"BASIC",owner:"Golmote"},batch:{title:"Batch",owner:"Golmote"},bbcode:{title:"BBcode",alias:"shortcode",aliasTitles:{shortcode:"Shortcode"},owner:"RunDevelopment"},bbj:{title:"BBj",owner:"hyyan"},bicep:{title:"Bicep",owner:"johnnyreilly"},birb:{title:"Birb",require:"clike",owner:"Calamity210"},bison:{title:"Bison",require:"c",owner:"Golmote"},bnf:{title:"BNF",alias:"rbnf",aliasTitles:{rbnf:"RBNF"},owner:"RunDevelopment"},bqn:{title:"BQN",owner:"yewscion"},brainfuck:{title:"Brainfuck",owner:"Golmote"},brightscript:{title:"BrightScript",owner:"RunDevelopment"},bro:{title:"Bro",owner:"wayward710"},bsl:{title:"BSL (1C:Enterprise)",alias:"oscript",aliasTitles:{oscript:"OneScript"},owner:"Diversus23"},c:{title:"C",require:"clike",owner:"zeitgeist87"},csharp:{title:"C#",require:"clike",alias:["cs","dotnet"],owner:"mvalipour"},cpp:{title:"C++",require:"c",owner:"zeitgeist87"},cfscript:{title:"CFScript",require:"clike",alias:"cfc",owner:"mjclemente"},chaiscript:{title:"ChaiScript",require:["clike","cpp"],owner:"RunDevelopment"},cil:{title:"CIL",owner:"sbrl"},cilkc:{title:"Cilk/C",require:"c",alias:"cilk-c",owner:"OpenCilk"},cilkcpp:{title:"Cilk/C++",require:"cpp",alias:["cilk-cpp","cilk"],owner:"OpenCilk"},clojure:{title:"Clojure",owner:"troglotit"},cmake:{title:"CMake",owner:"mjrogozinski"},cobol:{title:"COBOL",owner:"RunDevelopment"},coffeescript:{title:"CoffeeScript",require:"javascript",alias:"coffee",owner:"R-osey"},concurnas:{title:"Concurnas",alias:"conc",owner:"jasontatton"},csp:{title:"Content-Security-Policy",owner:"ScottHelme"},cooklang:{title:"Cooklang",owner:"ahue"},coq:{title:"Coq",owner:"RunDevelopment"},crystal:{title:"Crystal",require:"ruby",owner:"MakeNowJust"},"css-extras":{title:"CSS Extras",require:"css",modify:"css",owner:"milesj"},csv:{title:"CSV",owner:"RunDevelopment"},cue:{title:"CUE",owner:"RunDevelopment"},cypher:{title:"Cypher",owner:"RunDevelopment"},d:{title:"D",require:"clike",owner:"Golmote"},dart:{title:"Dart",require:"clike",owner:"Golmote"},dataweave:{title:"DataWeave",owner:"machaval"},dax:{title:"DAX",owner:"peterbud"},dhall:{title:"Dhall",owner:"RunDevelopment"},diff:{title:"Diff",owner:"uranusjr"},django:{title:"Django/Jinja2",require:"markup-templating",alias:"jinja2",owner:"romanvm"},"dns-zone-file":{title:"DNS zone file",owner:"RunDevelopment",alias:"dns-zone"},docker:{title:"Docker",alias:"dockerfile",owner:"JustinBeckwith"},dot:{title:"DOT (Graphviz)",alias:"gv",optional:"markup",owner:"RunDevelopment"},ebnf:{title:"EBNF",owner:"RunDevelopment"},editorconfig:{title:"EditorConfig",owner:"osipxd"},eiffel:{title:"Eiffel",owner:"Conaclos"},ejs:{title:"EJS",require:["javascript","markup-templating"],owner:"RunDevelopment",alias:"eta",aliasTitles:{eta:"Eta"}},elixir:{title:"Elixir",owner:"Golmote"},elm:{title:"Elm",owner:"zwilias"},etlua:{title:"Embedded Lua templating",require:["lua","markup-templating"],owner:"RunDevelopment"},erb:{title:"ERB",require:["ruby","markup-templating"],owner:"Golmote"},erlang:{title:"Erlang",owner:"Golmote"},"excel-formula":{title:"Excel Formula",alias:["xlsx","xls"],owner:"RunDevelopment"},fsharp:{title:"F#",require:"clike",owner:"simonreynolds7"},factor:{title:"Factor",owner:"catb0t"},false:{title:"False",owner:"edukisto"},"firestore-security-rules":{title:"Firestore security rules",require:"clike",owner:"RunDevelopment"},flow:{title:"Flow",require:"javascript",owner:"Golmote"},fortran:{title:"Fortran",owner:"Golmote"},ftl:{title:"FreeMarker Template Language",require:"markup-templating",owner:"RunDevelopment"},gml:{title:"GameMaker Language",alias:"gamemakerlanguage",require:"clike",owner:"LiarOnce"},gap:{title:"GAP (CAS)",owner:"RunDevelopment"},gcode:{title:"G-code",owner:"RunDevelopment"},gdscript:{title:"GDScript",owner:"RunDevelopment"},gedcom:{title:"GEDCOM",owner:"Golmote"},gettext:{title:"gettext",alias:"po",owner:"RunDevelopment"},gherkin:{title:"Gherkin",owner:"hason"},git:{title:"Git",owner:"lgiraudel"},glsl:{title:"GLSL",require:"c",owner:"Golmote"},gn:{title:"GN",alias:"gni",owner:"RunDevelopment"},"linker-script":{title:"GNU Linker Script",alias:"ld",owner:"RunDevelopment"},go:{title:"Go",require:"clike",owner:"arnehormann"},"go-module":{title:"Go module",alias:"go-mod",owner:"RunDevelopment"},gradle:{title:"Gradle",require:"clike",owner:"zeabdelkhalek-badido18"},graphql:{title:"GraphQL",optional:"markdown",owner:"Golmote"},groovy:{title:"Groovy",require:"clike",owner:"robfletcher"},haml:{title:"Haml",require:"ruby",optional:["css","css-extras","coffeescript","erb","javascript","less","markdown","scss","textile"],owner:"Golmote"},handlebars:{title:"Handlebars",require:"markup-templating",alias:["hbs","mustache"],aliasTitles:{mustache:"Mustache"},owner:"Golmote"},haskell:{title:"Haskell",alias:"hs",owner:"bholst"},haxe:{title:"Haxe",require:"clike",optional:"regex",owner:"Golmote"},hcl:{title:"HCL",owner:"outsideris"},hlsl:{title:"HLSL",require:"c",owner:"RunDevelopment"},hoon:{title:"Hoon",owner:"matildepark"},http:{title:"HTTP",optional:["csp","css","hpkp","hsts","javascript","json","markup","uri"],owner:"danielgtaylor"},hpkp:{title:"HTTP Public-Key-Pins",owner:"ScottHelme"},hsts:{title:"HTTP Strict-Transport-Security",owner:"ScottHelme"},ichigojam:{title:"IchigoJam",owner:"BlueCocoa"},icon:{title:"Icon",owner:"Golmote"},"icu-message-format":{title:"ICU Message Format",owner:"RunDevelopment"},idris:{title:"Idris",alias:"idr",owner:"KeenS",require:"haskell"},ignore:{title:".ignore",owner:"osipxd",alias:["gitignore","hgignore","npmignore"],aliasTitles:{gitignore:".gitignore",hgignore:".hgignore",npmignore:".npmignore"}},inform7:{title:"Inform 7",owner:"Golmote"},ini:{title:"Ini",owner:"aviaryan"},io:{title:"Io",owner:"AlesTsurko"},j:{title:"J",owner:"Golmote"},java:{title:"Java",require:"clike",owner:"sherblot"},javadoc:{title:"JavaDoc",require:["markup","java","javadoclike"],modify:"java",optional:"scala",owner:"RunDevelopment"},javadoclike:{title:"JavaDoc-like",modify:["java","javascript","php"],owner:"RunDevelopment"},javastacktrace:{title:"Java stack trace",owner:"RunDevelopment"},jexl:{title:"Jexl",owner:"czosel"},jolie:{title:"Jolie",require:"clike",owner:"thesave"},jq:{title:"JQ",owner:"RunDevelopment"},jsdoc:{title:"JSDoc",require:["javascript","javadoclike","typescript"],modify:"javascript",optional:["actionscript","coffeescript"],owner:"RunDevelopment"},"js-extras":{title:"JS Extras",require:"javascript",modify:"javascript",optional:["actionscript","coffeescript","flow","n4js","typescript"],owner:"RunDevelopment"},json:{title:"JSON",alias:"webmanifest",aliasTitles:{webmanifest:"Web App Manifest"},owner:"CupOfTea696"},json5:{title:"JSON5",require:"json",owner:"RunDevelopment"},jsonp:{title:"JSONP",require:"json",owner:"RunDevelopment"},jsstacktrace:{title:"JS stack trace",owner:"sbrl"},"js-templates":{title:"JS Templates",require:"javascript",modify:"javascript",optional:["css","css-extras","graphql","markdown","markup","sql"],owner:"RunDevelopment"},julia:{title:"Julia",owner:"cdagnino"},keepalived:{title:"Keepalived Configure",owner:"dev-itsheng"},keyman:{title:"Keyman",owner:"mcdurdin"},kotlin:{title:"Kotlin",alias:["kt","kts"],aliasTitles:{kts:"Kotlin Script"},require:"clike",owner:"Golmote"},kumir:{title:"KuMir (\u041a\u0443\u041c\u0438\u0440)",alias:"kum",owner:"edukisto"},kusto:{title:"Kusto",owner:"RunDevelopment"},latex:{title:"LaTeX",alias:["tex","context"],aliasTitles:{tex:"TeX",context:"ConTeXt"},owner:"japborst"},latte:{title:"Latte",require:["clike","markup-templating","php"],owner:"nette"},less:{title:"Less",require:"css",optional:"css-extras",owner:"Golmote"},lilypond:{title:"LilyPond",require:"scheme",alias:"ly",owner:"RunDevelopment"},liquid:{title:"Liquid",require:"markup-templating",owner:"cinhtau"},lisp:{title:"Lisp",alias:["emacs","elisp","emacs-lisp"],owner:"JuanCaicedo"},livescript:{title:"LiveScript",owner:"Golmote"},llvm:{title:"LLVM IR",owner:"porglezomp"},log:{title:"Log file",optional:"javastacktrace",owner:"RunDevelopment"},lolcode:{title:"LOLCODE",owner:"Golmote"},lua:{title:"Lua",owner:"Golmote"},magma:{title:"Magma (CAS)",owner:"RunDevelopment"},makefile:{title:"Makefile",owner:"Golmote"},markdown:{title:"Markdown",require:"markup",optional:"yaml",alias:"md",owner:"Golmote"},"markup-templating":{title:"Markup templating",require:"markup",owner:"Golmote"},mata:{title:"Mata",owner:"RunDevelopment"},matlab:{title:"MATLAB",owner:"Golmote"},maxscript:{title:"MAXScript",owner:"RunDevelopment"},mel:{title:"MEL",owner:"Golmote"},mermaid:{title:"Mermaid",owner:"RunDevelopment"},metafont:{title:"METAFONT",owner:"LaeriExNihilo"},mizar:{title:"Mizar",owner:"Golmote"},mongodb:{title:"MongoDB",owner:"airs0urce",require:"javascript"},monkey:{title:"Monkey",owner:"Golmote"},moonscript:{title:"MoonScript",alias:"moon",owner:"RunDevelopment"},n1ql:{title:"N1QL",owner:"TMWilds"},n4js:{title:"N4JS",require:"javascript",optional:"jsdoc",alias:"n4jsd",owner:"bsmith-n4"},"nand2tetris-hdl":{title:"Nand To Tetris HDL",owner:"stephanmax"},naniscript:{title:"Naninovel Script",owner:"Elringus",alias:"nani"},nasm:{title:"NASM",owner:"rbmj"},neon:{title:"NEON",owner:"nette"},nevod:{title:"Nevod",owner:"nezaboodka"},nginx:{title:"nginx",owner:"volado"},nim:{title:"Nim",owner:"Golmote"},nix:{title:"Nix",owner:"Golmote"},nsis:{title:"NSIS",owner:"idleberg"},objectivec:{title:"Objective-C",require:"c",alias:"objc",owner:"uranusjr"},ocaml:{title:"OCaml",owner:"Golmote"},odin:{title:"Odin",owner:"edukisto"},opencl:{title:"OpenCL",require:"c",modify:["c","cpp"],owner:"Milania1"},openqasm:{title:"OpenQasm",alias:"qasm",owner:"RunDevelopment"},oz:{title:"Oz",owner:"Golmote"},parigp:{title:"PARI/GP",owner:"Golmote"},parser:{title:"Parser",require:"markup",owner:"Golmote"},pascal:{title:"Pascal",alias:"objectpascal",aliasTitles:{objectpascal:"Object Pascal"},owner:"Golmote"},pascaligo:{title:"Pascaligo",owner:"DefinitelyNotAGoat"},psl:{title:"PATROL Scripting Language",owner:"bertysentry"},pcaxis:{title:"PC-Axis",alias:"px",owner:"RunDevelopment"},peoplecode:{title:"PeopleCode",alias:"pcode",owner:"RunDevelopment"},perl:{title:"Perl",owner:"Golmote"},php:{title:"PHP",require:"markup-templating",owner:"milesj"},phpdoc:{title:"PHPDoc",require:["php","javadoclike"],modify:"php",owner:"RunDevelopment"},"php-extras":{title:"PHP Extras",require:"php",modify:"php",owner:"milesj"},"plant-uml":{title:"PlantUML",alias:"plantuml",owner:"RunDevelopment"},plsql:{title:"PL/SQL",require:"sql",owner:"Golmote"},powerquery:{title:"PowerQuery",alias:["pq","mscript"],owner:"peterbud"},powershell:{title:"PowerShell",owner:"nauzilus"},processing:{title:"Processing",require:"clike",owner:"Golmote"},prolog:{title:"Prolog",owner:"Golmote"},promql:{title:"PromQL",owner:"arendjr"},properties:{title:".properties",owner:"Golmote"},protobuf:{title:"Protocol Buffers",require:"clike",owner:"just-boris"},pug:{title:"Pug",require:["markup","javascript"],optional:["coffeescript","ejs","handlebars","less","livescript","markdown","scss","stylus","twig"],owner:"Golmote"},puppet:{title:"Puppet",owner:"Golmote"},pure:{title:"Pure",optional:["c","cpp","fortran"],owner:"Golmote"},purebasic:{title:"PureBasic",require:"clike",alias:"pbfasm",owner:"HeX0R101"},purescript:{title:"PureScript",require:"haskell",alias:"purs",owner:"sriharshachilakapati"},python:{title:"Python",alias:"py",owner:"multipetros"},qsharp:{title:"Q#",require:"clike",alias:"qs",owner:"fedonman"},q:{title:"Q (kdb+ database)",owner:"Golmote"},qml:{title:"QML",require:"javascript",owner:"RunDevelopment"},qore:{title:"Qore",require:"clike",owner:"temnroegg"},r:{title:"R",owner:"Golmote"},racket:{title:"Racket",require:"scheme",alias:"rkt",owner:"RunDevelopment"},cshtml:{title:"Razor C#",alias:"razor",require:["markup","csharp"],optional:["css","css-extras","javascript","js-extras"],owner:"RunDevelopment"},jsx:{title:"React JSX",require:["markup","javascript"],optional:["jsdoc","js-extras","js-templates"],owner:"vkbansal"},tsx:{title:"React TSX",require:["jsx","typescript"]},reason:{title:"Reason",require:"clike",owner:"Golmote"},regex:{title:"Regex",owner:"RunDevelopment"},rego:{title:"Rego",owner:"JordanSh"},renpy:{title:"Ren'py",alias:"rpy",owner:"HyuchiaDiego"},rescript:{title:"ReScript",alias:"res",owner:"vmarcosp"},rest:{title:"reST (reStructuredText)",owner:"Golmote"},rip:{title:"Rip",owner:"ravinggenius"},roboconf:{title:"Roboconf",owner:"Golmote"},robotframework:{title:"Robot Framework",alias:"robot",owner:"RunDevelopment"},ruby:{title:"Ruby",require:"clike",alias:"rb",owner:"samflores"},rust:{title:"Rust",owner:"Golmote"},sas:{title:"SAS",optional:["groovy","lua","sql"],owner:"Golmote"},sass:{title:"Sass (Sass)",require:"css",optional:"css-extras",owner:"Golmote"},scss:{title:"Sass (SCSS)",require:"css",optional:"css-extras",owner:"MoOx"},scala:{title:"Scala",require:"java",owner:"jozic"},scheme:{title:"Scheme",owner:"bacchus123"},"shell-session":{title:"Shell session",require:"bash",alias:["sh-session","shellsession"],owner:"RunDevelopment"},smali:{title:"Smali",owner:"RunDevelopment"},smalltalk:{title:"Smalltalk",owner:"Golmote"},smarty:{title:"Smarty",require:"markup-templating",optional:"php",owner:"Golmote"},sml:{title:"SML",alias:"smlnj",aliasTitles:{smlnj:"SML/NJ"},owner:"RunDevelopment"},solidity:{title:"Solidity (Ethereum)",alias:"sol",require:"clike",owner:"glachaud"},"solution-file":{title:"Solution file",alias:"sln",owner:"RunDevelopment"},soy:{title:"Soy (Closure Template)",require:"markup-templating",owner:"Golmote"},sparql:{title:"SPARQL",require:"turtle",owner:"Triply-Dev",alias:"rq"},"splunk-spl":{title:"Splunk SPL",owner:"RunDevelopment"},sqf:{title:"SQF: Status Quo Function (Arma 3)",require:"clike",owner:"RunDevelopment"},sql:{title:"SQL",owner:"multipetros"},squirrel:{title:"Squirrel",require:"clike",owner:"RunDevelopment"},stan:{title:"Stan",owner:"RunDevelopment"},stata:{title:"Stata Ado",require:["mata","java","python"],owner:"RunDevelopment"},iecst:{title:"Structured Text (IEC 61131-3)",owner:"serhioromano"},stylus:{title:"Stylus",owner:"vkbansal"},supercollider:{title:"SuperCollider",alias:"sclang",owner:"RunDevelopment"},swift:{title:"Swift",owner:"chrischares"},systemd:{title:"Systemd configuration file",owner:"RunDevelopment"},"t4-templating":{title:"T4 templating",owner:"RunDevelopment"},"t4-cs":{title:"T4 Text Templates (C#)",require:["t4-templating","csharp"],alias:"t4",owner:"RunDevelopment"},"t4-vb":{title:"T4 Text Templates (VB)",require:["t4-templating","vbnet"],owner:"RunDevelopment"},tap:{title:"TAP",owner:"isaacs",require:"yaml"},tcl:{title:"Tcl",owner:"PeterChaplin"},tt2:{title:"Template Toolkit 2",require:["clike","markup-templating"],owner:"gflohr"},textile:{title:"Textile",require:"markup",optional:"css",owner:"Golmote"},toml:{title:"TOML",owner:"RunDevelopment"},tremor:{title:"Tremor",alias:["trickle","troy"],owner:"darach",aliasTitles:{trickle:"trickle",troy:"troy"}},turtle:{title:"Turtle",alias:"trig",aliasTitles:{trig:"TriG"},owner:"jakubklimek"},twig:{title:"Twig",require:"markup-templating",owner:"brandonkelly"},typescript:{title:"TypeScript",require:"javascript",optional:"js-templates",alias:"ts",owner:"vkbansal"},typoscript:{title:"TypoScript",alias:"tsconfig",aliasTitles:{tsconfig:"TSConfig"},owner:"dkern"},unrealscript:{title:"UnrealScript",alias:["uscript","uc"],owner:"RunDevelopment"},uorazor:{title:"UO Razor Script",owner:"jaseowns"},uri:{title:"URI",alias:"url",aliasTitles:{url:"URL"},owner:"RunDevelopment"},v:{title:"V",require:"clike",owner:"taggon"},vala:{title:"Vala",require:"clike",optional:"regex",owner:"TemplarVolk"},vbnet:{title:"VB.Net",require:"basic",owner:"Bigsby"},velocity:{title:"Velocity",require:"markup",owner:"Golmote"},verilog:{title:"Verilog",owner:"a-rey"},vhdl:{title:"VHDL",owner:"a-rey"},vim:{title:"vim",owner:"westonganger"},"visual-basic":{title:"Visual Basic",alias:["vb","vba"],aliasTitles:{vba:"VBA"},owner:"Golmote"},warpscript:{title:"WarpScript",owner:"RunDevelopment"},wasm:{title:"WebAssembly",owner:"Golmote"},"web-idl":{title:"Web IDL",alias:"webidl",owner:"RunDevelopment"},wgsl:{title:"WGSL",owner:"Dr4gonthree"},wiki:{title:"Wiki markup",require:"markup",owner:"Golmote"},wolfram:{title:"Wolfram language",alias:["mathematica","nb","wl"],aliasTitles:{mathematica:"Mathematica",nb:"Mathematica Notebook"},owner:"msollami"},wren:{title:"Wren",owner:"clsource"},xeora:{title:"Xeora",require:"markup",alias:"xeoracube",aliasTitles:{xeoracube:"XeoraCube"},owner:"freakmaxi"},"xml-doc":{title:"XML doc (.net)",require:"markup",modify:["csharp","fsharp","vbnet"],owner:"RunDevelopment"},xojo:{title:"Xojo (REALbasic)",owner:"Golmote"},xquery:{title:"XQuery",require:"markup",owner:"Golmote"},yaml:{title:"YAML",alias:"yml",owner:"hason"},yang:{title:"YANG",owner:"RunDevelopment"},zig:{title:"Zig",owner:"RunDevelopment"}},plugins:{meta:{path:"plugins/{id}/prism-{id}",link:"plugins/{id}/"},"line-highlight":{title:"Line Highlight",description:"Highlights specific lines and/or line ranges."},"line-numbers":{title:"Line Numbers",description:"Line number at the beginning of code lines.",owner:"kuba-kubula"},"show-invisibles":{title:"Show Invisibles",description:"Show hidden characters such as tabs and line breaks.",optional:["autolinker","data-uri-highlight"]},autolinker:{title:"Autolinker",description:"Converts URLs and emails in code to clickable links. Parses Markdown links in comments."},wpd:{title:"WebPlatform Docs",description:'Makes tokens link to WebPlatform.org documentation. The links open in a new tab.'},"custom-class":{title:"Custom Class",description:"This plugin allows you to prefix Prism's default classes (.comment can become .namespace--comment) or replace them with your defined ones (like .editor__comment). You can even add new classes.",owner:"dvkndn",noCSS:!0},"file-highlight":{title:"File Highlight",description:"Fetch external files and highlight them with Prism. Used on the Prism website itself.",noCSS:!0},"show-language":{title:"Show Language",description:"Display the highlighted language in code blocks (inline code does not show the label).",owner:"nauzilus",noCSS:!0,require:"toolbar"},"jsonp-highlight":{title:"JSONP Highlight",description:"Fetch content with JSONP and highlight some interesting content (e.g. GitHub/Gists or Bitbucket API).",noCSS:!0,owner:"nauzilus"},"highlight-keywords":{title:"Highlight Keywords",description:"Adds special CSS classes for each keyword for fine-grained highlighting.",owner:"vkbansal",noCSS:!0},"remove-initial-line-feed":{title:"Remove initial line feed",description:"Removes the initial line feed in code blocks.",owner:"Golmote",noCSS:!0},"inline-color":{title:"Inline color",description:"Adds a small inline preview for colors in style sheets.",require:"css-extras",owner:"RunDevelopment"},previewers:{title:"Previewers",description:"Previewers for angles, colors, gradients, easing and time.",require:"css-extras",owner:"Golmote"},autoloader:{title:"Autoloader",description:"Automatically loads the needed languages to highlight the code blocks.",owner:"Golmote",noCSS:!0},"keep-markup":{title:"Keep Markup",description:"Prevents custom markup from being dropped out during highlighting.",owner:"Golmote",optional:"normalize-whitespace",noCSS:!0},"command-line":{title:"Command Line",description:"Display a command line with a prompt and, optionally, the output/response from the commands.",owner:"chriswells0"},"unescaped-markup":{title:"Unescaped Markup",description:"Write markup without having to escape anything."},"normalize-whitespace":{title:"Normalize Whitespace",description:"Supports multiple operations to normalize whitespace in code blocks.",owner:"zeitgeist87",optional:"unescaped-markup",noCSS:!0},"data-uri-highlight":{title:"Data-URI Highlight",description:"Highlights data-URI contents.",owner:"Golmote",noCSS:!0},toolbar:{title:"Toolbar",description:"Attach a toolbar for plugins to easily register buttons on the top of a code block.",owner:"mAAdhaTTah"},"copy-to-clipboard":{title:"Copy to Clipboard Button",description:"Add a button that copies the code block to the clipboard when clicked.",owner:"mAAdhaTTah",require:"toolbar",noCSS:!0},"download-button":{title:"Download Button",description:"A button in the toolbar of a code block adding a convenient way to download a code file.",owner:"Golmote",require:"toolbar",noCSS:!0},"match-braces":{title:"Match braces",description:"Highlights matching braces.",owner:"RunDevelopment"},"diff-highlight":{title:"Diff Highlight",description:"Highlights the code inside diff blocks.",owner:"RunDevelopment",require:"diff"},"filter-highlight-all":{title:"Filter highlightAll",description:"Filters the elements the highlightAll and highlightAllUnder methods actually highlight.",owner:"RunDevelopment",noCSS:!0},treeview:{title:"Treeview",description:"A language with special styles to highlight file system tree structures.",owner:"Golmote"}}})},7176:(e,t,n)=>{"use strict";var r,o=n(73126),a=n(75795);try{r=[].__proto__===Array.prototype}catch(c){if(!c||"object"!=typeof c||!("code"in c)||"ERR_PROTO_ACCESS"!==c.code)throw c}var i=!!r&&a&&a(Object.prototype,"__proto__"),l=Object,s=l.getPrototypeOf;e.exports=i&&"function"==typeof i.get?o([i.get]):"function"==typeof s&&function(e){return s(null==e?e:l(e))}},7463:(e,t,n)=>{"use strict";var r=n(96763);function o(e,t){var n=e.length;e.push(t);e:for(;0>>1,o=e[r];if(!(0>>1;rl(s,n))cl(u,s)?(e[r]=u,e[c]=n,r=c):(e[r]=s,e[i]=n,r=i);else{if(!(cl(u,n)))break e;e[r]=u,e[c]=n,r=c}}}return t}function l(e,t){var n=e.sortIndex-t.sortIndex;return 0!==n?n:e.id-t.id}if("object"==typeof performance&&"function"==typeof performance.now){var s=performance;t.unstable_now=function(){return s.now()}}else{var c=Date,u=c.now();t.unstable_now=function(){return c.now()-u}}var d=[],p=[],f=1,m=null,g=3,h=!1,y=!1,b=!1,v="function"==typeof setTimeout?setTimeout:null,w="function"==typeof clearTimeout?clearTimeout:null,k="undefined"!=typeof setImmediate?setImmediate:null;function x(e){for(var t=a(p);null!==t;){if(null===t.callback)i(p);else{if(!(t.startTime<=e))break;i(p),t.sortIndex=t.expirationTime,o(d,t)}t=a(p)}}function S(e){if(b=!1,x(e),!y)if(null!==a(d))y=!0,D(E);else{var t=a(p);null!==t&&L(S,t.startTime-e)}}function E(e,n){y=!1,b&&(b=!1,w(j),j=-1),h=!0;var r=g;try{for(x(n),m=a(d);null!==m&&(!(m.expirationTime>n)||e&&!T());){var o=m.callback;if("function"==typeof o){m.callback=null,g=m.priorityLevel;var l=o(m.expirationTime<=n);n=t.unstable_now(),"function"==typeof l?m.callback=l:m===a(d)&&i(d),x(n)}else i(d);m=a(d)}if(null!==m)var s=!0;else{var c=a(p);null!==c&&L(S,c.startTime-n),s=!1}return s}finally{m=null,g=r,h=!1}}"undefined"!=typeof navigator&&void 0!==navigator.scheduling&&void 0!==navigator.scheduling.isInputPending&&navigator.scheduling.isInputPending.bind(navigator.scheduling);var _,A=!1,P=null,j=-1,C=5,O=-1;function T(){return!(t.unstable_now()-Oe||125i?(e.sortIndex=r,o(p,e),null===a(d)&&e===a(p)&&(b?(w(j),j=-1):b=!0,L(S,r-i))):(e.sortIndex=l,o(d,e),y||h||(y=!0,D(E))),e},t.unstable_shouldYield=T,t.unstable_wrapCallback=function(e){var t=g;return function(){var n=g;g=t;try{return e.apply(this,arguments)}finally{g=n}}}},7699:(e,t,n)=>{"use strict";n.d(t,{A:()=>s,G:()=>c});var r=n(96540),o=n(26849),a=n(74848);const i=Symbol("EmptyContext"),l=r.createContext(i);function s(e){let{children:t}=e;const[n,o]=(0,r.useState)(null),i=(0,r.useMemo)((()=>({expandedItem:n,setExpandedItem:o})),[n]);return(0,a.jsx)(l.Provider,{value:i,children:t})}function c(){const e=(0,r.useContext)(l);if(e===i)throw new o.dV("DocSidebarItemsExpandedStateProvider");return e}},8532:(e,t,n)=>{"use strict";n.d(t,{G:()=>y,a:()=>h});var r=n(96540),o=n(61934),a=n(26849),i=n(78749),l=n(53115),s=n(74848);const c=r.createContext(void 0),u="theme",d=(0,i.Wf)(u),p={light:"light",dark:"dark"},f=e=>e===p.dark?p.dark:p.light,m=e=>o.default.canUseDOM?f(document.documentElement.getAttribute("data-theme")):f(e),g=e=>{d.set(f(e))};function h(e){let{children:t}=e;const n=function(){const{colorMode:{defaultMode:e,disableSwitch:t,respectPrefersColorScheme:n}}=(0,l.p)(),[o,a]=(0,r.useState)(m(e));(0,r.useEffect)((()=>{t&&d.del()}),[t]);const i=(0,r.useCallback)((function(t,r){void 0===r&&(r={});const{persist:o=!0}=r;t?(a(t),o&&g(t)):(a(n?window.matchMedia("(prefers-color-scheme: dark)").matches?p.dark:p.light:e),d.del())}),[n,e]);(0,r.useEffect)((()=>{document.documentElement.setAttribute("data-theme",f(o))}),[o]),(0,r.useEffect)((()=>{if(t)return;const e=e=>{if(e.key!==u)return;const t=d.get();null!==t&&i(f(t))};return window.addEventListener("storage",e),()=>window.removeEventListener("storage",e)}),[t,i]);const s=(0,r.useRef)(!1);return(0,r.useEffect)((()=>{if(t&&!n)return;const e=window.matchMedia("(prefers-color-scheme: dark)"),r=()=>{window.matchMedia("print").matches||s.current?s.current=window.matchMedia("print").matches:i(null)};return e.addListener(r),()=>e.removeListener(r)}),[i,t,n]),(0,r.useMemo)((()=>({colorMode:o,setColorMode:i,get isDarkTheme(){return o===p.dark},setLightTheme(){i(p.light)},setDarkTheme(){i(p.dark)}})),[o,i])}();return(0,s.jsx)(c.Provider,{value:n,children:t})}function y(){const e=(0,r.useContext)(c);if(null==e)throw new a.dV("ColorModeProvider","Please see https://docusaurus.io/docs/api/themes/configuration#use-color-mode.");return e}},8722:(e,t,n)=>{var r=n(96763);const o=n(6969),a=n(98380),i=new Set;function l(e){void 0===e?e=Object.keys(o.languages).filter((e=>"meta"!=e)):Array.isArray(e)||(e=[e]);const t=[...i,...Object.keys(Prism.languages)];a(o,e,t).load((e=>{if(!(e in o.languages))return void(l.silent||r.warn("Language does not exist: "+e));const t="./prism-"+e;delete n.c[n(63157).resolve(t)],delete Prism.languages[e],n(63157)(t),i.add(e)}))}l.silent=!1,e.exports=l},9136:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>a});var r=n(96540),o=n(84974);function a(){return(0,r.useContext)(o.o)}},9303:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>u});n(96540);var r=n(18215),o=n(50539),a=n(53115),i=n(56289),l=n(25246);const s={anchorWithStickyNavbar:"anchorWithStickyNavbar_LWe7",anchorWithHideOnScrollNavbar:"anchorWithHideOnScrollNavbar_WYt5"};var c=n(74848);function u(e){let{as:t,id:n,...u}=e;const d=(0,l.A)(),{navbar:{hideOnScroll:p}}=(0,a.p)();if("h1"===t||!n)return(0,c.jsx)(t,{...u,id:void 0});d.collectAnchor(n);const f=(0,o.translate)({id:"theme.common.headingLinkTitle",message:"Direct link to {heading}",description:"Title for link to heading"},{heading:"string"==typeof u.children?u.children:n});return(0,c.jsxs)(t,{...u,className:(0,r.A)("anchor",p?s.anchorWithHideOnScrollNavbar:s.anchorWithStickyNavbar,u.className),id:n,children:[u.children,(0,c.jsx)(i.default,{className:"hash-link",to:`#${n}`,"aria-label":f,title:f,children:"\u200b"})]})}},9394:(e,t,n)=>{"use strict";var r=n(89211);e.exports=function(){return"function"==typeof Object.is?Object.is:r}},9957:(e,t,n)=>{"use strict";var r=Function.prototype.call,o=Object.prototype.hasOwnProperty,a=n(66743);e.exports=a.call(r,o)},10076:e=>{"use strict";e.exports=Function.prototype.call},10487:(e,t,n)=>{"use strict";var r=n(96897),o=n(30655),a=n(73126),i=n(12205);e.exports=function(e){var t=a(arguments),n=e.length-(arguments.length-1);return r(t,1+(n>0?n:0),!0)},o?o(e.exports,"apply",{value:i}):e.exports.apply=i},11002:e=>{"use strict";e.exports=Function.prototype.apply},11514:(e,t,n)=>{"use strict";var r=n(38403);e.exports=function(){return Object.assign?function(){if(!Object.assign)return!1;for(var e="abcdefghijklmnopqrst",t=e.split(""),n={},r=0;r{"use strict";n.d(t,{A:()=>a});var r=!0,o="Invariant failed";function a(e,t){if(!e){if(r)throw new Error(o);var n="function"==typeof t?t():t,a=n?"".concat(o,": ").concat(n):o;throw new Error(a)}}},11861:(e,t,n)=>{"use strict";function r(e,t){return void 0===t&&(t=(e,t)=>e===t),e.filter(((n,r)=>e.findIndex((e=>t(e,n)))!==r))}function o(e){return Array.from(new Set(e))}function a(e,t){const n={};let r=0;for(const o of e){const e=t(o,r);n[e]??=[],n[e].push(o),r+=1}return n}n.d(t,{$z:()=>a,XI:()=>r,sb:()=>o})},12205:(e,t,n)=>{"use strict";var r=n(66743),o=n(11002),a=n(13144);e.exports=function(){return a(r,o,arguments)}},12862:(e,t,n)=>{"use strict";n.d(t,{A:()=>u});n(96540);var r=n(56289),o=n(29030),a=n(40797),i=n(53115),l=n(24475),s=n(74848);function c(e){let{logo:t,alt:n,imageClassName:r}=e;const a={light:(0,o.default)(t.src),dark:(0,o.default)(t.srcDark||t.src)},i=(0,s.jsx)(l.default,{className:t.className,sources:a,height:t.height,width:t.width,alt:n,style:t.style});return r?(0,s.jsx)("div",{className:r,children:i}):i}function u(e){const{siteConfig:{title:t}}=(0,a.default)(),{navbar:{title:n,logo:l}}=(0,i.p)(),{imageClassName:u,titleClassName:d,...p}=e,f=(0,o.default)(l?.href||"/"),m=n?"":t,g=l?.alt??m;return(0,s.jsxs)(r.default,{to:f,...p,...l?.target&&{target:l.target},children:[l&&(0,s.jsx)(c,{logo:l,alt:g,imageClassName:u}),null!=n&&(0,s.jsx)("b",{className:d,children:n})]})}},13003:e=>{"use strict";e.exports=function(e){return e!=e}},13144:(e,t,n)=>{"use strict";var r=n(66743),o=n(11002),a=n(10076),i=n(47119);e.exports=i||r.call(a,o)},13722:(e,t,n)=>{"use strict";n.d(t,{A:()=>o});const r=e=>"object"==typeof e&&!!e&&Object.keys(e).length>0;function o(e){const t={};return function e(n,o){Object.entries(n).forEach((n=>{let[a,i]=n;const l=o?`${o}.${a}`:a;r(i)?e(i,l):t[l]=i}))}(e),t}},14035:(e,t,n)=>{"use strict";var r,o=n(36556),a=n(49092)(),i=n(9957),l=n(75795);if(a){var s=o("RegExp.prototype.exec"),c={},u=function(){throw c},d={toString:u,valueOf:u};"symbol"==typeof Symbol.toPrimitive&&(d[Symbol.toPrimitive]=u),r=function(e){if(!e||"object"!=typeof e)return!1;var t=l(e,"lastIndex");if(!(t&&i(t,"value")))return!1;try{s(e,d)}catch(n){return n===c}}}else{var p=o("Object.prototype.toString");r=function(e){return!(!e||"object"!=typeof e&&"function"!=typeof e)&&"[object RegExp]"===p(e)}}e.exports=r},15066:(e,t,n)=>{"use strict";function r(e){var t,n,o="";if("string"==typeof e||"number"==typeof e)o+=e;else if("object"==typeof e)if(Array.isArray(e)){var a=e.length;for(t=0;to});const o=function(){for(var e,t,n=0,o="",a=arguments.length;n{"use strict";var n=Symbol.for("react.element"),r=Symbol.for("react.portal"),o=Symbol.for("react.fragment"),a=Symbol.for("react.strict_mode"),i=Symbol.for("react.profiler"),l=Symbol.for("react.provider"),s=Symbol.for("react.context"),c=Symbol.for("react.forward_ref"),u=Symbol.for("react.suspense"),d=Symbol.for("react.memo"),p=Symbol.for("react.lazy"),f=Symbol.iterator;var m={isMounted:function(){return!1},enqueueForceUpdate:function(){},enqueueReplaceState:function(){},enqueueSetState:function(){}},g=Object.assign,h={};function y(e,t,n){this.props=e,this.context=t,this.refs=h,this.updater=n||m}function b(){}function v(e,t,n){this.props=e,this.context=t,this.refs=h,this.updater=n||m}y.prototype.isReactComponent={},y.prototype.setState=function(e,t){if("object"!=typeof e&&"function"!=typeof e&&null!=e)throw Error("setState(...): takes an object of state variables to update or a function which returns an object of state variables.");this.updater.enqueueSetState(this,e,t,"setState")},y.prototype.forceUpdate=function(e){this.updater.enqueueForceUpdate(this,e,"forceUpdate")},b.prototype=y.prototype;var w=v.prototype=new b;w.constructor=v,g(w,y.prototype),w.isPureReactComponent=!0;var k=Array.isArray,x=Object.prototype.hasOwnProperty,S={current:null},E={key:!0,ref:!0,__self:!0,__source:!0};function _(e,t,r){var o,a={},i=null,l=null;if(null!=t)for(o in void 0!==t.ref&&(l=t.ref),void 0!==t.key&&(i=""+t.key),t)x.call(t,o)&&!E.hasOwnProperty(o)&&(a[o]=t[o]);var s=arguments.length-2;if(1===s)a.children=r;else if(1{"use strict";n.d(t,{A:()=>a});n(96540);const r={iconExternalLink:"iconExternalLink_nPIU"};var o=n(74848);function a(e){let{width:t=13.5,height:n=13.5}=e;return(0,o.jsx)("svg",{width:t,height:n,"aria-hidden":"true",viewBox:"0 0 24 24",className:r.iconExternalLink,children:(0,o.jsx)("path",{fill:"currentColor",d:"M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"})})}},17081:(e,t,n)=>{"use strict";n.d(t,{_:()=>l,u:()=>s});var r=n(96540),o=n(26849),a=n(74848);const i=r.createContext(null);function l(e){let{children:t,content:n}=e;const o=function(e){return(0,r.useMemo)((()=>({metadata:e.metadata,frontMatter:e.frontMatter,assets:e.assets,contentTitle:e.contentTitle,toc:e.toc})),[e])}(n);return(0,a.jsx)(i.Provider,{value:o,children:t})}function s(){const e=(0,r.useContext)(i);if(null===e)throw new o.dV("DocProvider");return e}},18215:(e,t,n)=>{"use strict";function r(e){var t,n,o="";if("string"==typeof e||"number"==typeof e)o+=e;else if("object"==typeof e)if(Array.isArray(e)){var a=e.length;for(t=0;to});const o=function(){for(var e,t,n=0,o="",a=arguments.length;n{var r={"./":8722};function o(e){var t=a(e);return n(t)}function a(e){if(!n.o(r,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return r[e]}o.keys=function(){return Object.keys(r)},o.resolve=a,e.exports=o,o.id=18692},19585:(e,t,n)=>{"use strict";n.d(t,{K:()=>p,j:()=>s});var r=n(96540),o=n(56347),a=n(50539),i=n(77685),l=n(74848);const s="__docusaurus_skipToContent_fallback";function c(e){e.setAttribute("tabindex","-1"),e.focus(),e.removeAttribute("tabindex")}function u(){const e=(0,r.useRef)(null),{action:t}=(0,o.W6)(),n=(0,r.useCallback)((e=>{e.preventDefault();const t=document.querySelector("main:first-of-type")??document.getElementById(s);t&&c(t)}),[]);return(0,i.$)((n=>{let{location:r}=n;e.current&&!r.hash&&"PUSH"===t&&c(e.current)})),{containerRef:e,onClick:n}}const d=(0,a.translate)({id:"theme.common.skipToMainContent",description:"The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation",message:"Skip to main content"});function p(e){const t=e.children??d,{containerRef:n,onClick:r}=u();return(0,l.jsx)("div",{ref:n,role:"region","aria-label":d,children:(0,l.jsx)("a",{...e,href:`#${s}`,onClick:r,children:t})})}},19700:()=>{!function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(n,r,o,a){if(n.language===r){var i=n.tokenStack=[];n.code=n.code.replace(o,(function(e){if("function"==typeof a&&!a(e))return e;for(var o,l=i.length;-1!==n.code.indexOf(o=t(r,l));)++l;return i[l]=e,o})),n.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(n,r){if(n.language===r&&n.tokenStack){n.grammar=e.languages[r];var o=0,a=Object.keys(n.tokenStack);!function i(l){for(var s=0;s=a.length);s++){var c=l[s];if("string"==typeof c||c.content&&"string"==typeof c.content){var u=a[o],d=n.tokenStack[u],p="string"==typeof c?c:c.content,f=t(r,u),m=p.indexOf(f);if(m>-1){++o;var g=p.substring(0,m),h=new e.Token(r,e.tokenize(d,n.grammar),"language-"+r,d),y=p.substring(m+f.length),b=[];g&&b.push.apply(b,i([g])),b.push(h),y&&b.push.apply(b,i([y])),"string"==typeof c?l.splice.apply(l,[s,1].concat(b)):c.content=b}}else c.content&&i(c.content)}return l}(n.tokens)}}}})}(Prism)},20311:e=>{"use strict";e.exports=function(e,t,n,r,o,a,i,l){if(!e){var s;if(void 0===t)s=new Error("Minified exception occurred; use the non-minified dev environment for the full error message and additional helpful warnings.");else{var c=[n,r,o,a,i,l],u=0;(s=new Error(t.replace(/%s/g,(function(){return c[u++]})))).name="Invariant Violation"}throw s.framesToPop=1,s}}},21020:(e,t,n)=>{"use strict";var r=n(96540),o=Symbol.for("react.element"),a=Symbol.for("react.fragment"),i=Object.prototype.hasOwnProperty,l=r.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED.ReactCurrentOwner,s={key:!0,ref:!0,__self:!0,__source:!0};function c(e,t,n){var r,a={},c=null,u=null;for(r in void 0!==n&&(c=""+n),void 0!==t.key&&(c=""+t.key),void 0!==t.ref&&(u=t.ref),t)i.call(t,r)&&!s.hasOwnProperty(r)&&(a[r]=t[r]);if(e&&e.defaultProps)for(r in t=e.defaultProps)void 0===a[r]&&(a[r]=t[r]);return{$$typeof:o,type:e,key:c,ref:u,props:a,_owner:l.current}}t.Fragment=a,t.jsx=c,t.jsxs=c},21858:(e,t,n)=>{"use strict";n.d(t,{n:()=>l,r:()=>s});var r=n(96540),o=n(26849),a=n(74848);const i=r.createContext(null);function l(e){let{children:t,version:n}=e;return(0,a.jsx)(i.Provider,{value:n,children:t})}function s(){const e=(0,r.useContext)(i);if(null===e)throw new o.dV("DocsVersionProvider");return e}},22306:(e,t,n)=>{"use strict";n.d(t,{V:()=>s,t:()=>c});var r=n(96540),o=n(26849),a=n(74848);const i=Symbol("EmptyContext"),l=r.createContext(i);function s(e){let{children:t,name:n,items:o}=e;const i=(0,r.useMemo)((()=>n&&o?{name:n,items:o}:null),[n,o]);return(0,a.jsx)(l.Provider,{value:i,children:t})}function c(){const e=(0,r.useContext)(l);if(e===i)throw new o.dV("DocsSidebarProvider");return e}},22551:(e,t,n)=>{"use strict";var r=n(96763),o=n(96540),a=n(69982);function i(e){for(var t="https://reactjs.org/docs/error-decoder.html?invariant="+e,n=1;n