From 8dfb9d26ed7887434ba0bb2aa3114e20ade556cb Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 26 Nov 2025 19:15:51 +0000 Subject: [PATCH] deploy: 694483aa2dae70bade43a0777540ea6ef3220c0f --- 404.html | 2 +- assets/js/03e06346.5a5ba93d.js | 1 - assets/js/03e06346.762cd141.js | 1 + assets/js/23f866da.3fe0f665.js | 1 - assets/js/23f866da.fcf2ccd3.js | 1 + assets/js/34593b53.44951b14.js | 1 + assets/js/34593b53.e344c6a7.js | 1 - assets/js/851f8f65.1639171f.js | 1 - assets/js/851f8f65.c0d7643e.js | 1 + assets/js/9c9cb35e.43034981.js | 1 + assets/js/9c9cb35e.886034c8.js | 1 - assets/js/c195e1f1.f990c3aa.js | 1 + assets/js/c195e1f1.faf5a05d.js | 1 - assets/js/c4fbe420.68ec300c.js | 1 - assets/js/c4fbe420.79cbf939.js | 1 + ...~main.d335bfe3.js => runtime~main.333f24ef.js} | 2 +- blog/archive/index.html | 2 +- blog/authors/index.html | 2 +- blog/first-blog-post/index.html | 2 +- blog/index.html | 2 +- blog/long-blog-post/index.html | 2 +- blog/mdx-blog-post/index.html | 2 +- blog/tags/docusaurus/index.html | 2 +- blog/tags/facebook/index.html | 2 +- blog/tags/hello/index.html | 2 +- blog/tags/hola/index.html | 2 +- blog/tags/index.html | 2 +- blog/welcome/index.html | 2 +- docs/API-docs/api-intro/index.html | 2 +- docs/API-docs/v1.1/contactlist/index.html | 2 +- docs/API-docs/v1.1/createcontact/index.html | 2 +- docs/API-docs/v1.1/createdocument/index.html | 15 ++++++++------- .../v1.1/createdocumentwithtemplateid/index.html | 15 ++++++++------- docs/API-docs/v1.1/createfolder/index.html | 2 +- docs/API-docs/v1.1/createtemplate/index.html | 15 ++++++++------- docs/API-docs/v1.1/delete-template/index.html | 2 +- docs/API-docs/v1.1/delete-webhook/index.html | 2 +- docs/API-docs/v1.1/deletecontact/index.html | 2 +- docs/API-docs/v1.1/deletedocument/index.html | 2 +- docs/API-docs/v1.1/deletefolder/index.html | 2 +- docs/API-docs/v1.1/draftdocument/index.html | 15 ++++++++------- docs/API-docs/v1.1/drafttemplate/index.html | 15 ++++++++------- docs/API-docs/v1.1/folderlist/index.html | 2 +- docs/API-docs/v1.1/get-template/index.html | 2 +- docs/API-docs/v1.1/get-user/index.html | 2 +- docs/API-docs/v1.1/get-webhook/index.html | 2 +- docs/API-docs/v1.1/getcontact/index.html | 2 +- docs/API-docs/v1.1/getcredits/index.html | 2 +- docs/API-docs/v1.1/getdocument/index.html | 2 +- docs/API-docs/v1.1/getdocumentlist/index.html | 2 +- docs/API-docs/v1.1/getfolder/index.html | 2 +- docs/API-docs/v1.1/getformdata/index.html | 2 +- docs/API-docs/v1.1/getsignerips/index.html | 2 +- docs/API-docs/v1.1/gettemplatelist/index.html | 2 +- docs/API-docs/v1.1/index.html | 2 +- docs/API-docs/v1.1/intro/index.html | 2 +- docs/API-docs/v1.1/opensign-api-v-1-1/index.html | 2 +- docs/API-docs/v1.1/publictemplate/index.html | 15 ++++++++------- docs/API-docs/v1.1/resendrequestmail/index.html | 2 +- docs/API-docs/v1.1/revokedocument/index.html | 2 +- docs/API-docs/v1.1/save-update-webhook/index.html | 2 +- docs/API-docs/v1.1/selfsign/index.html | 15 ++++++++------- docs/API-docs/v1.1/update-document/index.html | 2 +- docs/API-docs/v1.1/update-template/index.html | 2 +- docs/API-docs/v1.1/updatefolder/index.html | 2 +- docs/API-docs/v1/contactlist/index.html | 2 +- docs/API-docs/v1/createcontact/index.html | 2 +- docs/API-docs/v1/createdocument/index.html | 2 +- .../v1/createdocumentwithtemplateid/index.html | 2 +- docs/API-docs/v1/createfolder/index.html | 2 +- docs/API-docs/v1/createtemplate/index.html | 2 +- docs/API-docs/v1/delete-template/index.html | 2 +- docs/API-docs/v1/delete-webhook/index.html | 2 +- docs/API-docs/v1/deletecontact/index.html | 2 +- docs/API-docs/v1/deletedocument/index.html | 2 +- docs/API-docs/v1/deletefolder/index.html | 2 +- docs/API-docs/v1/draftdocument/index.html | 2 +- docs/API-docs/v1/drafttemplate/index.html | 2 +- docs/API-docs/v1/folderlist/index.html | 2 +- docs/API-docs/v1/get-template/index.html | 2 +- docs/API-docs/v1/get-user/index.html | 2 +- docs/API-docs/v1/get-webhook/index.html | 2 +- docs/API-docs/v1/getcontact/index.html | 2 +- docs/API-docs/v1/getdocument/index.html | 2 +- docs/API-docs/v1/getdocumentlist/index.html | 2 +- docs/API-docs/v1/getfolder/index.html | 2 +- docs/API-docs/v1/gettemplatelist/index.html | 2 +- docs/API-docs/v1/index.html | 2 +- docs/API-docs/v1/intro/index.html | 2 +- docs/API-docs/v1/opensign-api-v-1/index.html | 2 +- docs/API-docs/v1/resendrequestmail/index.html | 2 +- docs/API-docs/v1/revokedocument/index.html | 2 +- docs/API-docs/v1/save-update-webhook/index.html | 2 +- docs/API-docs/v1/selfsign/index.html | 2 +- docs/API-docs/v1/update-document/index.html | 2 +- docs/API-docs/v1/update-template/index.html | 2 +- docs/API-docs/v1/updatefolder/index.html | 2 +- docs/category/cloud-storage/index.html | 2 +- docs/category/console/index.html | 2 +- .../create-new-opensign-document/index.html | 2 +- docs/category/docker/index.html | 2 +- docs/category/documents/index.html | 2 +- docs/category/faqs/index.html | 2 +- docs/category/guides/index.html | 2 +- .../manage-docs-using-opensign-drive/index.html | 2 +- docs/category/settings/index.html | 2 +- docs/category/templates/index.html | 2 +- docs/category/user-menu/index.html | 2 +- docs/contribute/CODE_OF_CONDUCT/index.html | 2 +- docs/contribute/COMMUNITY/index.html | 2 +- docs/contribute/INSTALLATION/index.html | 2 +- docs/contribute/REPORTING_GUIDELINES/index.html | 2 +- docs/contribute/intro/index.html | 2 +- .../index.html | 2 +- docs/help/FAQs/Max File Upload Size/index.html | 2 +- docs/help/FAQs/User Deletion/index.html | 2 +- docs/help/FAQs/index.html | 2 +- .../edit-document-before-sending/index.html | 2 +- .../enforce-email-verification/index.html | 2 +- .../New-Document/request-signatures/index.html | 2 +- docs/help/New-Document/sign-yourself/index.html | 2 +- docs/help/New-Document/widgets/index.html | 2 +- .../OpenSign™ Drive/create-document/index.html | 2 +- .../OpenSign™ Drive/list-grid-view/index.html | 2 +- .../OpenSign™ Drive/organize-documents/index.html | 2 +- .../OpenSign™ Drive/rename-document/index.html | 2 +- docs/help/Reports/completed/index.html | 2 +- docs/help/Reports/contactbook/index.html | 2 +- docs/help/Reports/declined/index.html | 2 +- docs/help/Reports/drafts/index.html | 2 +- docs/help/Reports/expired/index.html | 2 +- docs/help/Reports/in-progress/index.html | 2 +- docs/help/Reports/need-your-sign/index.html | 2 +- docs/help/Settings/APIToken/index.html | 2 +- .../Settings/Custom-email-templates/index.html | 2 +- docs/help/Settings/Preferences/index.html | 2 +- docs/help/Settings/SecurityManagement/index.html | 2 +- docs/help/Settings/Teams/index.html | 2 +- docs/help/Settings/Webhook/index.html | 2 +- docs/help/Settings/disabledocumentid/index.html | 2 +- docs/help/Settings/manage-users/index.html | 2 +- docs/help/Settings/my-signature/index.html | 2 +- docs/help/Templates/create-template/index.html | 2 +- docs/help/Templates/embed-template/index.html | 2 +- docs/help/Templates/manage-templates/index.html | 2 +- docs/help/Templates/publicTemplate/index.html | 2 +- docs/help/Templates/quick-send/index.html | 2 +- docs/help/Templates/use-template/index.html | 2 +- docs/help/User Menu/Console/analystics/index.html | 2 +- docs/help/User Menu/Console/branding/index.html | 2 +- .../Console/custom_filestorage/index.html | 2 +- docs/help/User Menu/Console/emails/index.html | 2 +- docs/help/User Menu/Console/general/index.html | 2 +- docs/help/User Menu/Console/globalSMTP/index.html | 2 +- docs/help/User Menu/Console/orgadmin/index.html | 2 +- .../User Menu/Console/organizations/index.html | 2 +- .../Console/signing_certificate/index.html | 2 +- docs/help/User Menu/Profile/index.html | 2 +- docs/help/intro/index.html | 2 +- docs/intro/index.html | 2 +- .../One-click-Install/DigitalOcean/index.html | 2 +- docs/self-host/cloud-storage/s3/index.html | 2 +- docs/self-host/docker/run-locally/index.html | 2 +- .../docker/upgrade-deployment/index.html | 2 +- docs/self-host/guides/azure-vm-setup/index.html | 2 +- docs/self-host/guides/env-variables/index.html | 2 +- .../index.html | 2 +- .../self-host/guides/upgrade-to-v2.1.0/index.html | 2 +- docs/self-host/intro/index.html | 2 +- index.html | 2 +- markdown-page/index.html | 2 +- 171 files changed, 213 insertions(+), 206 deletions(-) delete mode 100644 assets/js/03e06346.5a5ba93d.js create mode 100644 assets/js/03e06346.762cd141.js delete mode 100644 assets/js/23f866da.3fe0f665.js create mode 100644 assets/js/23f866da.fcf2ccd3.js create mode 100644 assets/js/34593b53.44951b14.js delete mode 100644 assets/js/34593b53.e344c6a7.js delete mode 100644 assets/js/851f8f65.1639171f.js create mode 100644 assets/js/851f8f65.c0d7643e.js create mode 100644 assets/js/9c9cb35e.43034981.js delete mode 100644 assets/js/9c9cb35e.886034c8.js create mode 100644 assets/js/c195e1f1.f990c3aa.js delete mode 100644 assets/js/c195e1f1.faf5a05d.js delete mode 100644 assets/js/c4fbe420.68ec300c.js create mode 100644 assets/js/c4fbe420.79cbf939.js rename assets/js/{runtime~main.d335bfe3.js => runtime~main.333f24ef.js} (96%) diff --git a/404.html b/404.html index 0dbc0b408..a525e8d47 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/03e06346.5a5ba93d.js b/assets/js/03e06346.5a5ba93d.js deleted file mode 100644 index c3600eac6..000000000 --- a/assets/js/03e06346.5a5ba93d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3404],{48329:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>x,default:()=>f,frontMatter:()=>g,metadata:()=>s,toc:()=>b});const s=JSON.parse('{"id":"API-docs/v1.1/publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","source":"@site/docs/API-docs/v1.1/publictemplate.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/publictemplate","permalink":"/docs/API-docs/v1.1/publictemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","sidebar_label":"Public Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztPNlyHDeSv4Kt2AhLPdXVh0hJ5sTsLm1rbe1oJYZErWOX5NDoKnQXxCqgDKDYbDM6Yh7mD+ZpXufT/CUbmQDq6IuUSHmoifKDzC5ciURmIg9kXgeGznRwcBIcs7zIqGE6OAuDhOlY8cJwKYKD4Dhl5KicZDwmvhc5PHpJaJbJuSalZkoTI0msGDQZPxMxKTVEM3XJCNVkkpWsUFwYTaZSkRkTTFHDxYwkMi5zBg1zblJSKJawKRcsIdqoMjalYjoiP6ZMEFpNT7gmuoxjpvW0zLKFWz4JiUktfIqZUglNKCkF/7lkpNfzg8950usRKhJCSa9X4ObOS5X1ehGB7ba/wVL2d7YgFJfkk4zh+JwuyIQRnVLFEgs/FQtESkiYoJMMdmhSlgOK3KbtUM1norH3CdUsIVIg/B7QiPwg5+wSJmt+Jtxolk1JTIWQBgDIZcKnnCXEpEqWs5SYlGvy/u2r3xNuoB+RIkNQS1gGTsAvbTHHpaig4mIWnYpTccyLA/K+yCRNyEKWihx995/1MCMJfDvp9b5jk3JG3r/s9c4epcYU+mAwoEURyYIJmC+jEx3FMh8k0LFIpo9DMk+ZYjArAseo5oDcBHCYzJjRuGFBYlksSCylSrgAogpJQWeMiDKfMKVDewZSMcKBOBSjyaJvZL/UjPzXuzevYaM5NRE5ykodVsslXLHYANHA9IBZv6uv7EE83QPa42IWkpxewBFyQ34ueXwB29ZMJPB/R2mIq17vXVkUUhmWkB/tFg56PWj5hmVyTqhi2D+WeS4FKaiiOTPIOsAm0KzYzyWvySjLPC4OTkWf9HqC5uyg1yPvLTnzhAkDh67wOPHA7YDI9jeLAvu/FAmPHUcyAl+JnLa7AlKh67uCxTCl7dpANRDmPOVxijicU3v+RUZjuy3FdMFiwy9Ze+KrkCxg4u+YkB6CVCr+ixSGZnh8l0wZHtOsecwAIHTVhiqUEYXkwvivbgXyv+444bTxEB0dAmgJIDfnAls0I5c0K5l2UM1DkgJUb1mhmEb2c/Mi/yYkZXyWbl2PJh9KbVoTk1I7Rq+gcGv5U0X0MkTblGaaET5t4TKnF6yxGpEof2kWkW8WJGFTWmYmJBwo1KiSReS1NIQWRcZjCtIIaACYjYK87OMpO/KJ2uRzpOQlTxgIxoRPp0wBM0MjTuHGeOiALgscANtDTjMpSpOVg45lJtU6CeHnNh5JLIVhwkTk8JLyDIG3m9WEizgrE0YmGY0vQrwzQqJAqsOpLBhcOaHlD+wCF4vFOeKHaJYBFUoB8AvploerwkGVgIAHee75Dxo9qnERrptYdVw+lbAyoMCzJGE55VmIiAvJBzkhhpuMhcDgBRWLkCTUsJAYdmUm8iokccriC/xL0YRLMimNkcJuLFGySORcOFxOpTCa/7KBI33Lx2N0HJK9kDwNyfOQjIYhGY1DMtoLyehpSEbPQzIehmQ8Dsl4LyTjpxas8XOHa1ohuAnAaGyxbL4c7IKcfsU1cjYIWF3J7HlLZo8i0utV3ATffvrpp1NxfSoIOQ2AuU6DA3IaVF1Og9C2gcyEtpH7fQU/noyfuZ8L+Pl0/Nz9nGPX0Z77mcLP8ehULN2Cp2KMkBiaFzuggOZ7hcD9ckQE33BR+OblGXwEQRT6BjirFjzQsGzu5QnshQtuOM309u34Hg9oRzVIa5vag00huW7fETY/oO004YEWFJO2CcVqo8kzPEIxXtv9fuRulu2bt8s+mL03wLnb1p/C1kE0HYNo2r7/Sno9ICSswnQ3TDyLUAFAybwdD67DA8JCG6K74eA54AAupe0IgNYHtPsGONDgbnjbNtzrj/b74+F4r4UBsKVshzzvJ0l/sVjcB/ZA53HLg8rjNVSr2YG5O1Uy32B+oHVQ93I6Ef7tVfb/BkV94nVYloCdiIaF11gqC7GpZRuZ0MVX2k7lh1bKGfSvVbNFA0xsAjjQWo5TyWMHPPTxKtkEDMIIcNBHTA6SZNDAJHxMkn6e91c+ws8+Ir7xMc+jJIlWeq6djv2YkyQJyfrnjd+ThOR5vuWz/d76PMjz9V1Eee5gQ+Xr6widMKizbecT1+G3YpWaI9oL72Qj8DSARwUa0JzbzEcrl03KhWtwREVWOig2KzOq2BXYpZpLYXvfP495Fqs1e7RjnSeBecWaPHrjtPfHjvxhC+0J4MvN49Z2BpMckrjURuZEsRm7IgU1himBk13SjCfWLdXHD+yK5gWYAIM/nZ4mv/vXATogwMY31reV8BkHv9HgTyeH/f8729CjLAqmYqoZyRispEPCTByRk5RlRe26ms/n0fyJjlMpM+u3+qAVm9p/z+XkwzmCW0RUF4837dSSRsPgB9JZtfc1My2MUU38yA0mP9IY8tBoiLets3d2XLeuxwO6cVZAgkbrPYHmk9Mgp6iQACmz+m9pUqZOg7NqjDXyWXLD2LNbMGvKE5bRCcvWm27NaNXnjC5k6fjbO7XaW3UU3cAbNORcVH4L3M4wbDTSq5VG27bcwN8WIU3u9FeOZ09/AiTj2ntu2uhsjnauLXRQCsbQ5wnObjeATCoqvTMXVIDdjg2sJHJnd8MS0I9gx8qt6Fe7YYXWwTQRA3PkXPC8zCv/6LSa1aMsd7pHE18wEoIDfoXm6a6tQK9uWAGckdsXOBUj9GN4/8cOzdT1eECyYgWk3Wz8KVKkdU/f0wV7MwP6bTUZcMO1DF3thVwxn97OfRF5A9cb+GTtIPCyxTErDHjk7sqaFci3vqHQZ9X0w22nvGavB0R9G8D6zBTo+t337fNJRNrc/RdEqC2wb02s1imZ09kOyx2bHxB5OnjWnBAjdEba+2KHQw7bd29nNGxtZ7+9nafDT7CuWsve3bgaVh9rq+qFgJjD2kJgl5cZXRP1CYt5TjOMYiLU44/nvw0M5pYDqv1W5kVpmmyC3gAUBf5e9xE3G0H8XUj6IemFZBCSRyF5HJG3DGN0cRXPc9c8VzZqx+EVQQnhlLhUEONXsJ2QsGgWkevrn0sqDDeL5ZL0yPU1PD9YLiPgmwsh5zakd3LJNTcEQvK1GZTIWG8I4ctYD8BeGrxm8/53Lmw+cKA9Jo/kChPvNDodCj7Wytw27LOaXnYzDYqBVV5Xupk1PzH0zHWR0QWhU6BGG57EYTaKHcHJHJAx+cO/kdE4Gg5DMrR/k0ceL+PHwM4QrTpSbMqzrPGmgPhPnhwgRssylrs4tntNALorRra4MBJQ7t9t9HoTNpUQ1YJHDRAbbT5escqjldPNhxH2lYhUJKXaGtVoxcN+4dUGvHBx8bXX0jAbXNeFFJrZe6XYAHQdHO/1VoJzvlsdoOPCbxwk2+j+PEnjr4dNUTd6ut+S3PttWTfcJut2OJJAollceO87q5sakgZlof++LmZW5YyfFJBtJZ8nakvtsswSkvEL1iRKLrS/tx2UqwH8b1Mpdd3DxdAdX+uDdmxeKgjPP46qUOVdXeCjZ09aF8/ze/DrrXi624cx3BuM9gc7Xd0rDtqPvx8Iuc3JoQ/5VieHPeuj61zSn+qSvh/Cf3KfHrnRs3FLkXwyvDsD3JPjrck4N7jc7sOxdm8eria73dK39Zv5mO5OfXufw9peEcPPRvcghrcY1XelxDXb+d5oj9yX4byJAG9hOe80l+9MoE1gPzuR7t+PlT0atnS1r1uq2tfjJlHu79+KKJuLrlDWacD/55s3b+fDP34/k4eHh4ev371PX7yfHR4e5vA7iqKNDpZNp43LgA7rXhe7exnv+C2rRFEEKEyooQc4fFCI2e/t+HD7mMi9TPlMXt/9+wi0bnDu3l0KVF1/m4tmkyf38/H5XTkwCANZYMKFFC+T4CCwCQ0+oSAI0RvDtPlGJovg4DpwT0rhT/dgE4YOPmjICbkOdJyynMJf3oSDLJIpz2AqcBgwpYMwwDdGkFICVBccBHLygcUmCCH+XYCTkmmYA8cdXPte9ul9EDo1PDgILNUHYeCiwNUnwkQs4V1HkUyDpV9w11TVl3oqjX9U2RUwD7xW/8RpcOhyJYvmk2ZqzrCs0VpPRpWii2A1Ycc/U/dvDOy46h1utvCXAzfg+qjeTmO3IAy4YXlzlS2HpuTHYzpmEnaC7w8/diweC80/ek0YV6RSfNJA90TsU4Z+kJPzTyJHGOz8HxvO+panY1vXF26TyiE8vGaJ14b7dQZBSPAVb3QTpfr+iGU6a65pvXRrax5vyyxpPGjXKZrAtCgYVREmeHxyrhHmptEsLjFzqhLHrZ1VoFY7Gy3D4OrmzVyRWPZ92gp5lLGpsc9MSCyVYOpx8+3ag9nceG9vGQaLm7e3+CK39wwOb37z7n7EfJ86F+ofAeuT58swSG+G9YcqI+kfCOze02V9xwY247LKqZzIZHHu5dbypo7+MoN+kE/3UrxRCVMNREykzBgVa5h4ObUOfEm+Akvnq9A+7sJEEq60v8jIHNzNisUMktLwzaeXVcTpOjbLhLjH/eD8fwEfUD3T5URDL+Hn03bCCSNG8dmMgcvc9cDBLlWG0TiFBEH35KyOARSKXXJZag8e+NHhdsmYwbRNiOf45MuWNdbADnrrm3uPmqcDX+ByhaxT9ub46Ba4RFOxb3MHrX5gd2nnIG+OjyA9j0+d+heR97rChEctbXUhoI6RS059Ck8l2xf2QQyz/k5p81+bIYbIJcb1yTpACdcbIQptGjJEzqpE5LWJ63xPOCJZGghZcJeVpA0rdAuPCEWFyGNZ3oYqb8AkJbMS3x8bYFmfq4dPEOv0Oi5swjPaGUmpfEahIwvoCcnHNZ48VqBTY37IPNZ2OCVTqg3kD5eCA+ZVCVZFNSW7KpjiEF3ciALFLOogEfpmbaKdq/b+7SuX5ev34JlyAhxoJ2YJKQukGuSEKofSn9zq1tcUJeAOps63KYbrqgfGTJ0LpGBKSwFmklQzKvgvloRRIwEra8JSmtmuTlSAqxzgAQ5vA+Nl7a9/+XsDrq2a7jpgdgWaJPBA9gYI0ZS0BA+avmIFSEDZhgjmY+o/Vi8BgA6Z5twmjVtG0ren8SN8UqsruehCgFUIUpdxCoZFJW916GWsdmqlRtsUDViMIRawX3bFtWlkAfq3+uvy4S0DPMYNGFANAa4GmheLJoPXoVG5Mh3mKvJ2Bml1Da7xAi2NPFcs5+J291TTG2dkJQhKI3NqeEz8VDpq5wXbkI/n67wOCgM1XnKpHm9hVZjuXIqYnXNxDkUDbqHgNeLXdAHEbeaMiSZsHkn2OqtzN+dYj6GJk8bthBnKLWLcD4HucqZm7DwGMwUJj90Cj70ezNbrkb6FxYlVXSrnUnFp9Sg/QJTUswNELgG2yvyo79xmNYNGoYUiY/BEHMx4Oz+glCDkrrpEc4W6BINmkPYKE1fhtZzyusSDi3DjeeFuXlorPLYeHZgF0sBhnXDXnrwIrVJaKKRy+9UtR9jNgVuF0EwiS5m0lsNJG6iXmMWb4hWERwguYLuOT62Xc8HUr3/+m8ZAvn2PoiPYwtZWDPHTTEubItyc1VO0p3nroFojafdmYJOxu9vj4QWI1T2wwEQ+gZdo+PABNSq8aWTt9Ghbz5/N/N5lS7t4fGdJf0Gm5mg4/Ge2pJ8MvxxLem/4BVnSzwFY57S/WZps0243yg4fhNg94INk1r+ZSbW7J/j2l2EVMtmE4Jodxkv7X238eyF+g0PAegzqYIIzZv1mEA3j4RD+tyIEfU0kVwCqVRXqX4Lw9pGMGyR6XTtqN74OL58f5YXI4xQleVVIaveoJrG5r0hndjyQ3r97CHjyh/YaOdO6fWFsWMCV8DK70dU8JS4yLti5P4LzlZCRPea9TWfyTubM6hNzMOLmSkIlJadYGbUgdAaaEUyj7vGImFI3EfPHQbYLG3vD4fmoQsL+OhJeCsz4wlpkx/KCid92p83ljV0eQL3Ks1qiBNx2wvagtdnmd7tJzeJScbMIDk6ug6s+LXjfth+cnC3PgApNKjG0KDVCTE0aHASDtUgjloSDONbJdYB8URG/piKBJzNr0pYWfHA5ikbBMlwds1E67+jPyv7HDtGGzriY3TTurMbROzhHe1QtTNXqZMH/yECfdAfR7BUGHOgnZRQMTUA9kMfbOj77wh+yj5xuCobWh7ka3vTRzVbAcvWW3BCCbEQgT3z4DyN6VUAvqDcUVEG3IGiE0eBHIzAGPytd+6Qm5yqq5FXhEeqQ4709VLaejVArefIcL/y9p8szi/yGGxkTCpq+UPsQqOXUc5/aTq4gWHEqtTw7q46drU6WLT4Wt+SKL6ECZJMJD6bzRsvZjWpYSRtQ6RWDNiLhHQ0g8skQEbk3REQ+H7Z0Erf9eoZas0D1odIeUEVoagigBpwB4XIxlUj17rjfFEy8A/csSCXkmjVNkmWxzKvSUL2eH/LrX/5ejer1KgPW+qXBin1TKlLIOVPT0taammbsCgs1wjCWY5tGkxtzAGieMa0hGi4Mm6HtjG/4wSfsvI4xLeiEZxzErn1Hj69oG5LbFqbEdI6FLL9SNrnhkmUgrStnT6PIJZlLdTGFypkhoWQCSR/g7mMipSK2nkUrQtBDBpYreG0LxTVUw1MANbewSWEUjQ3JqaAzdHGFpImshGUc5CxRcgKOdy2z0rqWDeWZVPbNI24IH6UgEl9cFdCE6jAwrWIpEPal8y/r0Pr3rXRw9RcnEEopABYOZr+RpBSZhFKJEJIpM8h7MDZMAlp3E0YYbhQVGlRlC4s/gwphzvXLtHOgvNcMTvgVFxe2XFefnFR09SObaG5YO5l/lTkft8d8z80P5QSKAUrNjVSLevSMm7ScoJxvTlL9sDN978t6NqT47fNo3jEDFKIHh0cvUU94TH7981/JK0aVIKmcW2qNS8WyRbuCqD15i7bqmsfgAi2heqZBIhUzH+/yGPwxpQa9Na/ZHNxilqXsQ6OVSq+61zsg326s7OqTj232CER8qCuTSjIuLiJy6Aqh1s4n+I7jPqEQ6nFjdZZrll0y3fC+sYSbVvlT1gLGba6dTAN7O0yStdwU8MDW4FifEQawqHUeQT3RDeksrVyVdl07JhLM/dEHJFF0aur5w/U6rBs++eQcj47QTVMdieXEoq3ja+tXW9FA2vIW/XWwoG4XqC24I6cTT5akXSXj48na2pvC0Bj1X3+D0oJvjFFA/U79ZvqOqUseexNpC0cPsPMgCIOMx8wZv+7+Ovz+6BW5fBINg7Ch192CuQevXn774vW7FwAMCFKLsFE0jIZo2UltcioaK63wzurd1nhU1xVV7ooqd0WVu6LKXVHlrqhyV1S5K6rcFVXuiip3RZW7ospdUeWuqHJXVLkrqtwVVe4qWHRFlbuiyl1R5a6ocldUuSuq3BVV7ooqd0WVu6LKXVHlrqhyV1S5K6rcFVXuiip3RZW7ospdUeWuqHJXVLkrqvygXNJdUeWuqHJXVLkrqtwVVe6KKndFlbuiyv/MRZUbWZaDIqMcs6hdsr9NgD5ZLbV8FgYpZEgfnATX10B571W2XMLnn0tM+Dw5C4NLqji85sTk6tDnAkNe5wWDnNBv7ePU/jGsH9qDxlyalZxySGa2Iw5x7zv7NpO4j968Ow7CYOLKQecywVoQdA55oHRu82QbyaL47TrIqJiVmGga2DmXtnJW2s59vsDcZ/dHI1sVcoRrCNtJ0XYb8C9sauOA62ubV71cVv1t09YRDrG+N5zf2XK5/H8ge53R","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Template","permalink":"/docs/API-docs/v1.1/createtemplate"},"next":{"title":"Get Template","permalink":"/docs/API-docs/v1.1/get-template"}}');var i=t(74848),r=t(28453),l=t(33617),o=t.n(l),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:"publictemplate",title:"Public Template",description:"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.",sidebar_label:"Public Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPNlyHDeSv4Kt2AhLPdXVh0hJ5sTsLm1rbe1oJYZErWOX5NDoKnQXxCqgDKDYbDM6Yh7mD+ZpXufT/CUbmQDq6IuUSHmoifKDzC5ciURmIg9kXgeGznRwcBIcs7zIqGE6OAuDhOlY8cJwKYKD4Dhl5KicZDwmvhc5PHpJaJbJuSalZkoTI0msGDQZPxMxKTVEM3XJCNVkkpWsUFwYTaZSkRkTTFHDxYwkMi5zBg1zblJSKJawKRcsIdqoMjalYjoiP6ZMEFpNT7gmuoxjpvW0zLKFWz4JiUktfIqZUglNKCkF/7lkpNfzg8950usRKhJCSa9X4ObOS5X1ehGB7ba/wVL2d7YgFJfkk4zh+JwuyIQRnVLFEgs/FQtESkiYoJMMdmhSlgOK3KbtUM1norH3CdUsIVIg/B7QiPwg5+wSJmt+Jtxolk1JTIWQBgDIZcKnnCXEpEqWs5SYlGvy/u2r3xNuoB+RIkNQS1gGTsAvbTHHpaig4mIWnYpTccyLA/K+yCRNyEKWihx995/1MCMJfDvp9b5jk3JG3r/s9c4epcYU+mAwoEURyYIJmC+jEx3FMh8k0LFIpo9DMk+ZYjArAseo5oDcBHCYzJjRuGFBYlksSCylSrgAogpJQWeMiDKfMKVDewZSMcKBOBSjyaJvZL/UjPzXuzevYaM5NRE5ykodVsslXLHYANHA9IBZv6uv7EE83QPa42IWkpxewBFyQ34ueXwB29ZMJPB/R2mIq17vXVkUUhmWkB/tFg56PWj5hmVyTqhi2D+WeS4FKaiiOTPIOsAm0KzYzyWvySjLPC4OTkWf9HqC5uyg1yPvLTnzhAkDh67wOPHA7YDI9jeLAvu/FAmPHUcyAl+JnLa7AlKh67uCxTCl7dpANRDmPOVxijicU3v+RUZjuy3FdMFiwy9Ze+KrkCxg4u+YkB6CVCr+ixSGZnh8l0wZHtOsecwAIHTVhiqUEYXkwvivbgXyv+444bTxEB0dAmgJIDfnAls0I5c0K5l2UM1DkgJUb1mhmEb2c/Mi/yYkZXyWbl2PJh9KbVoTk1I7Rq+gcGv5U0X0MkTblGaaET5t4TKnF6yxGpEof2kWkW8WJGFTWmYmJBwo1KiSReS1NIQWRcZjCtIIaACYjYK87OMpO/KJ2uRzpOQlTxgIxoRPp0wBM0MjTuHGeOiALgscANtDTjMpSpOVg45lJtU6CeHnNh5JLIVhwkTk8JLyDIG3m9WEizgrE0YmGY0vQrwzQqJAqsOpLBhcOaHlD+wCF4vFOeKHaJYBFUoB8AvploerwkGVgIAHee75Dxo9qnERrptYdVw+lbAyoMCzJGE55VmIiAvJBzkhhpuMhcDgBRWLkCTUsJAYdmUm8iokccriC/xL0YRLMimNkcJuLFGySORcOFxOpTCa/7KBI33Lx2N0HJK9kDwNyfOQjIYhGY1DMtoLyehpSEbPQzIehmQ8Dsl4LyTjpxas8XOHa1ohuAnAaGyxbL4c7IKcfsU1cjYIWF3J7HlLZo8i0utV3ATffvrpp1NxfSoIOQ2AuU6DA3IaVF1Og9C2gcyEtpH7fQU/noyfuZ8L+Pl0/Nz9nGPX0Z77mcLP8ehULN2Cp2KMkBiaFzuggOZ7hcD9ckQE33BR+OblGXwEQRT6BjirFjzQsGzu5QnshQtuOM309u34Hg9oRzVIa5vag00huW7fETY/oO004YEWFJO2CcVqo8kzPEIxXtv9fuRulu2bt8s+mL03wLnb1p/C1kE0HYNo2r7/Sno9ICSswnQ3TDyLUAFAybwdD67DA8JCG6K74eA54AAupe0IgNYHtPsGONDgbnjbNtzrj/b74+F4r4UBsKVshzzvJ0l/sVjcB/ZA53HLg8rjNVSr2YG5O1Uy32B+oHVQ93I6Ef7tVfb/BkV94nVYloCdiIaF11gqC7GpZRuZ0MVX2k7lh1bKGfSvVbNFA0xsAjjQWo5TyWMHPPTxKtkEDMIIcNBHTA6SZNDAJHxMkn6e91c+ws8+Ir7xMc+jJIlWeq6djv2YkyQJyfrnjd+ThOR5vuWz/d76PMjz9V1Eee5gQ+Xr6widMKizbecT1+G3YpWaI9oL72Qj8DSARwUa0JzbzEcrl03KhWtwREVWOig2KzOq2BXYpZpLYXvfP495Fqs1e7RjnSeBecWaPHrjtPfHjvxhC+0J4MvN49Z2BpMckrjURuZEsRm7IgU1himBk13SjCfWLdXHD+yK5gWYAIM/nZ4mv/vXATogwMY31reV8BkHv9HgTyeH/f8729CjLAqmYqoZyRispEPCTByRk5RlRe26ms/n0fyJjlMpM+u3+qAVm9p/z+XkwzmCW0RUF4837dSSRsPgB9JZtfc1My2MUU38yA0mP9IY8tBoiLets3d2XLeuxwO6cVZAgkbrPYHmk9Mgp6iQACmz+m9pUqZOg7NqjDXyWXLD2LNbMGvKE5bRCcvWm27NaNXnjC5k6fjbO7XaW3UU3cAbNORcVH4L3M4wbDTSq5VG27bcwN8WIU3u9FeOZ09/AiTj2ntu2uhsjnauLXRQCsbQ5wnObjeATCoqvTMXVIDdjg2sJHJnd8MS0I9gx8qt6Fe7YYXWwTQRA3PkXPC8zCv/6LSa1aMsd7pHE18wEoIDfoXm6a6tQK9uWAGckdsXOBUj9GN4/8cOzdT1eECyYgWk3Wz8KVKkdU/f0wV7MwP6bTUZcMO1DF3thVwxn97OfRF5A9cb+GTtIPCyxTErDHjk7sqaFci3vqHQZ9X0w22nvGavB0R9G8D6zBTo+t337fNJRNrc/RdEqC2wb02s1imZ09kOyx2bHxB5OnjWnBAjdEba+2KHQw7bd29nNGxtZ7+9nafDT7CuWsve3bgaVh9rq+qFgJjD2kJgl5cZXRP1CYt5TjOMYiLU44/nvw0M5pYDqv1W5kVpmmyC3gAUBf5e9xE3G0H8XUj6IemFZBCSRyF5HJG3DGN0cRXPc9c8VzZqx+EVQQnhlLhUEONXsJ2QsGgWkevrn0sqDDeL5ZL0yPU1PD9YLiPgmwsh5zakd3LJNTcEQvK1GZTIWG8I4ctYD8BeGrxm8/53Lmw+cKA9Jo/kChPvNDodCj7Wytw27LOaXnYzDYqBVV5Xupk1PzH0zHWR0QWhU6BGG57EYTaKHcHJHJAx+cO/kdE4Gg5DMrR/k0ceL+PHwM4QrTpSbMqzrPGmgPhPnhwgRssylrs4tntNALorRra4MBJQ7t9t9HoTNpUQ1YJHDRAbbT5escqjldPNhxH2lYhUJKXaGtVoxcN+4dUGvHBx8bXX0jAbXNeFFJrZe6XYAHQdHO/1VoJzvlsdoOPCbxwk2+j+PEnjr4dNUTd6ut+S3PttWTfcJut2OJJAollceO87q5sakgZlof++LmZW5YyfFJBtJZ8nakvtsswSkvEL1iRKLrS/tx2UqwH8b1Mpdd3DxdAdX+uDdmxeKgjPP46qUOVdXeCjZ09aF8/ze/DrrXi624cx3BuM9gc7Xd0rDtqPvx8Iuc3JoQ/5VieHPeuj61zSn+qSvh/Cf3KfHrnRs3FLkXwyvDsD3JPjrck4N7jc7sOxdm8eria73dK39Zv5mO5OfXufw9peEcPPRvcghrcY1XelxDXb+d5oj9yX4byJAG9hOe80l+9MoE1gPzuR7t+PlT0atnS1r1uq2tfjJlHu79+KKJuLrlDWacD/55s3b+fDP34/k4eHh4ev371PX7yfHR4e5vA7iqKNDpZNp43LgA7rXhe7exnv+C2rRFEEKEyooQc4fFCI2e/t+HD7mMi9TPlMXt/9+wi0bnDu3l0KVF1/m4tmkyf38/H5XTkwCANZYMKFFC+T4CCwCQ0+oSAI0RvDtPlGJovg4DpwT0rhT/dgE4YOPmjICbkOdJyynMJf3oSDLJIpz2AqcBgwpYMwwDdGkFICVBccBHLygcUmCCH+XYCTkmmYA8cdXPte9ul9EDo1PDgILNUHYeCiwNUnwkQs4V1HkUyDpV9w11TVl3oqjX9U2RUwD7xW/8RpcOhyJYvmk2ZqzrCs0VpPRpWii2A1Ycc/U/dvDOy46h1utvCXAzfg+qjeTmO3IAy4YXlzlS2HpuTHYzpmEnaC7w8/diweC80/ek0YV6RSfNJA90TsU4Z+kJPzTyJHGOz8HxvO+panY1vXF26TyiE8vGaJ14b7dQZBSPAVb3QTpfr+iGU6a65pvXRrax5vyyxpPGjXKZrAtCgYVREmeHxyrhHmptEsLjFzqhLHrZ1VoFY7Gy3D4OrmzVyRWPZ92gp5lLGpsc9MSCyVYOpx8+3ag9nceG9vGQaLm7e3+CK39wwOb37z7n7EfJ86F+ofAeuT58swSG+G9YcqI+kfCOze02V9xwY247LKqZzIZHHu5dbypo7+MoN+kE/3UrxRCVMNREykzBgVa5h4ObUOfEm+Akvnq9A+7sJEEq60v8jIHNzNisUMktLwzaeXVcTpOjbLhLjH/eD8fwEfUD3T5URDL+Hn03bCCSNG8dmMgcvc9cDBLlWG0TiFBEH35KyOARSKXXJZag8e+NHhdsmYwbRNiOf45MuWNdbADnrrm3uPmqcDX+ByhaxT9ub46Ba4RFOxb3MHrX5gd2nnIG+OjyA9j0+d+heR97rChEctbXUhoI6RS059Ck8l2xf2QQyz/k5p81+bIYbIJcb1yTpACdcbIQptGjJEzqpE5LWJ63xPOCJZGghZcJeVpA0rdAuPCEWFyGNZ3oYqb8AkJbMS3x8bYFmfq4dPEOv0Oi5swjPaGUmpfEahIwvoCcnHNZ48VqBTY37IPNZ2OCVTqg3kD5eCA+ZVCVZFNSW7KpjiEF3ciALFLOogEfpmbaKdq/b+7SuX5ev34JlyAhxoJ2YJKQukGuSEKofSn9zq1tcUJeAOps63KYbrqgfGTJ0LpGBKSwFmklQzKvgvloRRIwEra8JSmtmuTlSAqxzgAQ5vA+Nl7a9/+XsDrq2a7jpgdgWaJPBA9gYI0ZS0BA+avmIFSEDZhgjmY+o/Vi8BgA6Z5twmjVtG0ren8SN8UqsruehCgFUIUpdxCoZFJW916GWsdmqlRtsUDViMIRawX3bFtWlkAfq3+uvy4S0DPMYNGFANAa4GmheLJoPXoVG5Mh3mKvJ2Bml1Da7xAi2NPFcs5+J291TTG2dkJQhKI3NqeEz8VDpq5wXbkI/n67wOCgM1XnKpHm9hVZjuXIqYnXNxDkUDbqHgNeLXdAHEbeaMiSZsHkn2OqtzN+dYj6GJk8bthBnKLWLcD4HucqZm7DwGMwUJj90Cj70ezNbrkb6FxYlVXSrnUnFp9Sg/QJTUswNELgG2yvyo79xmNYNGoYUiY/BEHMx4Oz+glCDkrrpEc4W6BINmkPYKE1fhtZzyusSDi3DjeeFuXlorPLYeHZgF0sBhnXDXnrwIrVJaKKRy+9UtR9jNgVuF0EwiS5m0lsNJG6iXmMWb4hWERwguYLuOT62Xc8HUr3/+m8ZAvn2PoiPYwtZWDPHTTEubItyc1VO0p3nroFojafdmYJOxu9vj4QWI1T2wwEQ+gZdo+PABNSq8aWTt9Ghbz5/N/N5lS7t4fGdJf0Gm5mg4/Ge2pJ8MvxxLem/4BVnSzwFY57S/WZps0243yg4fhNg94INk1r+ZSbW7J/j2l2EVMtmE4Jodxkv7X238eyF+g0PAegzqYIIzZv1mEA3j4RD+tyIEfU0kVwCqVRXqX4Lw9pGMGyR6XTtqN74OL58f5YXI4xQleVVIaveoJrG5r0hndjyQ3r97CHjyh/YaOdO6fWFsWMCV8DK70dU8JS4yLti5P4LzlZCRPea9TWfyTubM6hNzMOLmSkIlJadYGbUgdAaaEUyj7vGImFI3EfPHQbYLG3vD4fmoQsL+OhJeCsz4wlpkx/KCid92p83ljV0eQL3Ks1qiBNx2wvagtdnmd7tJzeJScbMIDk6ug6s+LXjfth+cnC3PgApNKjG0KDVCTE0aHASDtUgjloSDONbJdYB8URG/piKBJzNr0pYWfHA5ikbBMlwds1E67+jPyv7HDtGGzriY3TTurMbROzhHe1QtTNXqZMH/yECfdAfR7BUGHOgnZRQMTUA9kMfbOj77wh+yj5xuCobWh7ka3vTRzVbAcvWW3BCCbEQgT3z4DyN6VUAvqDcUVEG3IGiE0eBHIzAGPytd+6Qm5yqq5FXhEeqQ4709VLaejVArefIcL/y9p8szi/yGGxkTCpq+UPsQqOXUc5/aTq4gWHEqtTw7q46drU6WLT4Wt+SKL6ECZJMJD6bzRsvZjWpYSRtQ6RWDNiLhHQ0g8skQEbk3REQ+H7Z0Erf9eoZas0D1odIeUEVoagigBpwB4XIxlUj17rjfFEy8A/csSCXkmjVNkmWxzKvSUL2eH/LrX/5ejer1KgPW+qXBin1TKlLIOVPT0taammbsCgs1wjCWY5tGkxtzAGieMa0hGi4Mm6HtjG/4wSfsvI4xLeiEZxzErn1Hj69oG5LbFqbEdI6FLL9SNrnhkmUgrStnT6PIJZlLdTGFypkhoWQCSR/g7mMipSK2nkUrQtBDBpYreG0LxTVUw1MANbewSWEUjQ3JqaAzdHGFpImshGUc5CxRcgKOdy2z0rqWDeWZVPbNI24IH6UgEl9cFdCE6jAwrWIpEPal8y/r0Pr3rXRw9RcnEEopABYOZr+RpBSZhFKJEJIpM8h7MDZMAlp3E0YYbhQVGlRlC4s/gwphzvXLtHOgvNcMTvgVFxe2XFefnFR09SObaG5YO5l/lTkft8d8z80P5QSKAUrNjVSLevSMm7ScoJxvTlL9sDN978t6NqT47fNo3jEDFKIHh0cvUU94TH7981/JK0aVIKmcW2qNS8WyRbuCqD15i7bqmsfgAi2heqZBIhUzH+/yGPwxpQa9Na/ZHNxilqXsQ6OVSq+61zsg326s7OqTj232CER8qCuTSjIuLiJy6Aqh1s4n+I7jPqEQ6nFjdZZrll0y3fC+sYSbVvlT1gLGba6dTAN7O0yStdwU8MDW4FifEQawqHUeQT3RDeksrVyVdl07JhLM/dEHJFF0aur5w/U6rBs++eQcj47QTVMdieXEoq3ja+tXW9FA2vIW/XWwoG4XqC24I6cTT5akXSXj48na2pvC0Bj1X3+D0oJvjFFA/U79ZvqOqUseexNpC0cPsPMgCIOMx8wZv+7+Ovz+6BW5fBINg7Ch192CuQevXn774vW7FwAMCFKLsFE0jIZo2UltcioaK63wzurd1nhU1xVV7ooqd0WVu6LKXVHlrqhyV1S5K6rcFVXuiip3RZW7ospdUeWuqHJXVLkrqtwVVe4qWHRFlbuiyl1R5a6ocldUuSuq3BVV7ooqd0WVu6LKXVHlrqhyV1S5K6rcFVXuiip3RZW7ospdUeWuqHJXVLkrqvygXNJdUeWuqHJXVLkrqtwVVe6KKndFlbuiyv/MRZUbWZaDIqMcs6hdsr9NgD5ZLbV8FgYpZEgfnATX10B571W2XMLnn0tM+Dw5C4NLqji85sTk6tDnAkNe5wWDnNBv7ePU/jGsH9qDxlyalZxySGa2Iw5x7zv7NpO4j968Ow7CYOLKQecywVoQdA55oHRu82QbyaL47TrIqJiVmGga2DmXtnJW2s59vsDcZ/dHI1sVcoRrCNtJ0XYb8C9sauOA62ubV71cVv1t09YRDrG+N5zf2XK5/H8ge53R",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},x=void 0,y={},b=[];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:"Public Template"}),"\n",(0,i.jsx)(o(),{method:"post",path:"/publictemplate",context:"endpoint"}),"\n",(0,i.jsxs)(n.p,{children:["The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique ",(0,i.jsx)(n.strong,{children:"template_id"})," and a ",(0,i.jsx)(n.strong,{children:"public_url"}),". The ",(0,i.jsx)(n.strong,{children:"public_url"})," is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing."]}),"\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:"name:"})," Unique identifier for this widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/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",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\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:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (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 "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"14",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": "",\n "decimalplaces": 2,\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:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,i.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the number (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",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,i.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Note:"})," Responses for prefill widgets are ",(0,i.jsx)(n.strong,{children:"required"}),"."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,i.jsxs)(n.ol,{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": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\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:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",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": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "name": "date",\n "response": "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:"response:"})," Enter the date you would like to display inside the date box."]}),"\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:'"mm/dd/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",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",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": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\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:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\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 radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",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": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\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 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:""},company:{type:"string",format:"string",example:""},job_title:{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},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:"5,"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},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:100},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:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{template_id:{type:"string",example:"Av8Pmpnmch"},public_url:{type:"string",example:"https://app.example.com/publicsign?templateid=Av8Pmpnmch"},message:{type:"string",example:"Public template created successfully!"}},title:"inline_response_publictemplate"}}}},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 f(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 diff --git a/assets/js/03e06346.762cd141.js b/assets/js/03e06346.762cd141.js new file mode 100644 index 000000000..35e7440fa --- /dev/null +++ b/assets/js/03e06346.762cd141.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3404],{48329:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>b,contentTitle:()=>g,default:()=>f,frontMatter:()=>x,metadata:()=>s,toc:()=>y});const s=JSON.parse('{"id":"API-docs/v1.1/publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","source":"@site/docs/API-docs/v1.1/publictemplate.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/publictemplate","permalink":"/docs/API-docs/v1.1/publictemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","sidebar_label":"Public Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztPNlyHDlyvwJXOGKk3urqQ6Sk4cba5sxoZ+SVJYZEecImuVx0FboLYhVQA6DY7GF0xD7sH/jJr/tp8yWOTAB19EWKpLSSo+ZBwy5ciURmIg9kXgeGznRwcBIcs7zIqGE6OAuDhOlY8cJwKYKD4Dhl5KicZDwmvhc5PHpJaJbJuSalZkoTI0msGDQZPxMxKTVEM3XJCNVkkpWsUFwYTaZSkRkTTFHDxYwkMi5zBg1zblJSKJawKRcsIdqoMjalYjoiP6dMEFpNT7gmuoxjpvW0zLKFWz4JiUktfIqZUglNKCkF/6VkpNfzg8950usRKhJCSa9X4ObOS5X1ehGB7ba/wVL2d7YgFJfkk4zh+JwuyIQRnVLFEgs/FQtESkiYoJMMdmhSlgOK3KbtUM1norH3CdUsIVIg/B7QiPwk5+wSJmt+Jtxolk1JTIWQBgDIZcKnnCXEpEqWs5SYlGvy/u2r3xNuoB+RIkNQS1gGTsAvbTHHpaig4mIWnYpTccyLA/K+yCRNyEKWihz98Md6mJEEvp30ej+wSTkj71/2emePUmMKfTAY0KKIZMEEzJfRiY5imQ8S6Fgk08chmadMMZgVgWNUc0BuAjhMZsxo3LAgsSwWJJZSJVwAUYWkoDNGRJlPmNKhPQOpGOFAHIrRZNE3sl9qRv793ZvXsNGcmogcZaUOq+USrlhsgGhgesCs39U39iCe7gHtcTELSU4v4Ai5Ib+UPL6AbWsmEvi/ozTEVa/3riwKqQxLyM92Cwe9HrR8xzI5J1Qx7B/LPJeCFFTRnBlkHWATaFbsl5LXZJRlHhcHp6JPej1Bc3bQ65H3lpx5woSBQ1d4nHjgdkBk+5tFgf1fioTHjiMZga9ETttdAanQ9V3BYpjSdm2gGghznvI4RRzOqT3/IqOx3ZZiumCx4ZesPfFVSBYw8Q9MSA9BKhX/VQpDMzy+S6YMj2nWPGYAELpqQxXKiEJyYfxXtwL5L3eccNp4iI4OAbQEkJtzgS2akUualUw7qOYhSQGqt6xQTCP7uXmRfxOSMj5Lt65Hkw+lNq2JSakdo1dQuLX8qSJ6GaJtSjPNCJ+2cJnTC9ZYjUiUvzSLyHcLkrApLTMTEg4UalTJIvJaGkKLIuMxBWkENADMRkFe9vGUHflEbfI5UvKSJwwEY8KnU6aAmaERp3BjPHRAlwUOgO0hp5kUpcnKQccyk2qdhPBzG48klsIwYSJyeEl5hsDbzWrCRZyVCSOTjMYXId4ZIVEg1eFUFgyunNDyB3aBi8XiHPFDNMuACqUA+IV0y8NV4aBKQMCDPPf8B40e1bgI102sOi6fSlgZUOBZkrCc8ixExIXkg5wQw03GQmDwgopFSBJqWEgMuzITeRWSOGXxBf6laMIlmZTGSGE3lihZJHIuHC6nUhjNf93Akb7l4zE6DsleSJ6G5HlIRsOQjMYhGe2FZPQ0JKPnIRkPQzIeh2S8F5LxUwvW+LnDNa0Q3ARgNLZYNl8XdlOesHMYeA57O6faMMX1BYhrq2Tgte01Cejob2VgL5bUNyDXJOVJwgSZKpkTxWJecJQmVhpUU4cAD1GwKaGJ1VcuudUiHA6qSeVcAN5wRa7Im4KJd6Ap0DiWJZwxYtgiFdFZHznc8FKQY0ZzjTt/IQxTheKagagW2t1Ur7hG2QZXjK5urXnr1hpFpNer5Al8+8tf/nIqrk8FIacBiJfT4ICcBlWX0yC0bXBrQNvI/b6CH0/Gz9zPBfx8On7ufs6x62jP/Uzh53h0KpZuwVMxRkgMzYsdUEDzg0Lgfjk2gm+4KHzzEh0+gigOfQNQawseaFg29/IE9sIFN5xmevt2fI8vaEc1SGub2oNNIcNu3xE2f0HbacIDLXhR2Ca8WBpNXuQhFOPq8zYxAt3wgl/D037kbuHtaLIAfjFYaoDzuZD0FJAEAv8YBP52TFV3wheErlWYPhfOnkWogOHNuB1jrsMXhK82RJ8LW88BW6A+bEcVtH5BeGqAAw1OF7Ntw73+aL8/Ho73WrgCq9d2yPN+kvQXi8Wd8LyCPdCf3PKgLnlbwmow4JhARWjdUEQ7ru7ltFf82xtX/wEm1cRbGyxxKlCtW1a2fNMeMjKhi2+0ncoPrdRo6F8r0YsGmNgEcKBfI04ljx3w0McrzxMw3SPAQR8xOUiSQQOT8DFJ+nneX/kIP/uI+MbHPI+SJFrpuXY69mNOkiQk6583fk8Skuf5ls/2e+vzIM/XdxHluYMNlcRvI3SXoXa9nU9ch8/FKjVHtBfeyUbgEwLNuBIIm/lo5apLuXANjqjISgfFZmVGFbsCD4LmUtjen1WWrXCjZ8baWkPfhPMOMW8skUdvnEX2uLKIxMoE8OXmcWs4gEkOSVxqg+bQjF2RghrDlMDJLmnGE+tq7OMHdkXzAsy6wZ9PT5Pf/fMAnUrgtzHWmkn4jIMvcPDnk8P+f59t6FEWBVMx1YxkDFbSIWEmjshJyrKidkfO5/No/kTHqZSZ9UV+0IpN7b/ncvLhHMEtIqqLx5t2aomo4cQBIlv14WhmWhijmviRG9w4eKTIbaMh3uDOht1xhbseX9DdtAISNFqPGDSfnAY5RXUIiJ7Vf0uTMnUanFVjrOOGJTeMPbsFWwMXZXTCsvWmj2fJjC5k6SSBd1S2t+oouoE3aMi5qHxRuJ1h2GikVyuNtm25gb8tQprc6S8nz57+BEjGtffGtdHZHO3cleh0FoyhHxsCGG4AmVRUem8uqAC7HRt43wye3Q1LQD+CHStXsV/thhVaB9NEDMyRc8HzMq983tNqVo+y3GkpTXzBSAj4+BWap7u2Ar26YQVwMG9f4FSM0DPjfVo7dFjX4wuSFSsg7Wbju0iR1o3+QOruzQzot9VkwA3XMnS1F3LFfHo790XkjXXn+UHg6otjVhjwst6XNSuQb31DoReu6VvdTnnNXl8Q9W0A6xNToOv30LfPnYi0ufuviFBbYN+aWK2bNaezHTY+Nn9B5OngWXNXjNC9au+LHY5DbN+9ndGwtZ399naeDu9gh7WWvb8ZNqw+1vYXxjDI2kJgwZcZXRP1CYt5TjOMTCPU43vw310MMgcY0Pf3Mi9K02Qo9DCg0PAagI+32ojR70LSD0kvJIOQPArJ44i8ZRihjatorlMIuLIxWw5vSEoI/8SlghceCjYeEhbNInJ9/UtJheFmsVySHrm+hscny2UEHHYh5NwGdE8gFGUIPMioDaZExnrDAw4Z6wFYVoPXbN7/wcWsBg60x+SRXGH3neapQ8HH2qPbhn1SI81upkFbsMrrSouzhio+POC6yOiC0CnQrQ1O4zD7hiGCkzkgY/KHfyGjcTQchmRo/yaPPF7Gj4HxIVJ3pNiUZ1njRQnxnzw5QISeZSx3rxjcWxLQcjGqx4WRgHIfXuz1JmwqIaIHT1ogMt58umTVTCvRW1FJfCMkFUmptuY32vuwX3izA++bXGzxtTTMPq3QhRSa2Ruo2AB0/TSi11sJTPpudXCSC79xkIGjh/NOjb8dNoXi6Ol+S8bvt6XicJtU3OGcAtlnceGjBKxuasgklJr++7pauipn/KSAbCsjq3A1Ursss4Rk/II1iZIL7W94B+Xq843vUyl13cO9oHB8rQ/aLzOkgscZj6MqTHtft/ro2ZPWFfX8AXyFK97z9mEM9waj/cFO9/mK0/fj7QlCbnNy6Je+1clhz/roOjf3Xd3cD0P4Tx7Sdzd6Nm6pnE+G92eAB3LRNRnnBufcQ7jgHswX1mS3W3rBPps36v7Ut/cp7PIVMfxs9ABieIv5fV9KXLOyH4z2yEOZ2JsI8BY29k7D+t4E2gT2kxPp/sPY46NhS1f7tqWqfTtuEuX+/q2IsrnoCmWdBvw/v3vzdj78048zeXh4ePj63fv0xfvZ4eFhDr+jKNroitl02rgM6LDubbm7l/GO37JKFEWAwoQaeoDDB4WY/d6OD7ePidwLmk/kH95/iODtBjfw/aVA1fXzXDSbfL6fjs/vy4FBGMgC022keJkEB4FNZ/HpJEGIfhumzXcyWQQH14F7UAx/uue6MHTwQUNG0HWg45TlFP7yJhzkEE15BlPhK1mlgzDAt1CQUARUFxwEcvKBxSYIIaZegDuTaZgDxx1c+1428SIInRoeHASW6oMwcPHi6hNhIpbwVqRIpsHSL7hrqupLPZXGP6rcGpgHchXuOA0OXa7kUN1ppuYMyxqt9WRUKboIVtO1fJKCf7dgx1WvsLOFvxy4AddH9XIeuwVhwA3Lm6tsOTQlPx7TMZOwE3x7+bFj8Vho/tFrwrgileJOA90DtbsM/SAn53ciRxjs/B8bzvqWp2Nb1xduk8ohPLtnideG+3X+SEjwBXN0E6X6/ohlOmuuab10a2seb8sraqQz6BRNYFoUjKoI03vunGmGmYk0i0vMm6vEcWtnFajVzkbLMLi6eTNXJJZ9n7REHmVsauyDFBJLJZh63HwP98Vsbry3twyDxc3bW3yV23sGhze/eXc/Y7ZXnQn3j4D1yfNlGKQ3w/pTlY/2DwR27+myvmMDm29bZdROZLI493JreVNHf5lBP8imfCneqISpBiImUmaMijVMvJxaB74k34Cl801on4FhGhFX2l9kZA7uZsViBimJPnkHZRVxuo7NMSIusQGc/y/gA6pnupxo6CX8fNpOOGHEKD6bMXCZux442CVKMRqnkB7qHqfVMYBCsUsuS+3BAz863C4ZM5i0C/Ecn3rbssYa2EFvfXPvUfN04Atcrpi89Ob46Ba4RFOxbzNHXUIR7tLOQd4cH0FyJp869S8i73WFCY9a2upCQB0jl5z6BK5Kti/s0xlm/Z3SZj83QwyRS4vsk3WAEq43QhTaJHSInFVp6GsT19m+cESyNBCy4C4nTRtW6BYeEYoKkceyvA1V3oBJSmYlvmk2wLI+UxMfK9bJlVzYdHe0M5JS+XxSRxbQE1LPazx5rECnxvyQd67tcEqmGLMMIQUeMK9KsCqqKdlVwRSH6OJGFChmUQdp8DdrE+1MxfdvX7kc7ypzTlU85CdmCSkLpBrkhCqD1p/c6tbXFCXgDqbOtymG66oHxkydC6RgSksBZpJUMyr4r5aEUSMBK2vCUprZrk5UgKsc4AEObwPjZe1vf/t7A66tmu46YHYFmiTwlPYGCNGUtAQPmr5iBUhA2YYI5mPq31YvAYAOmebclgywjKRvT+NH+PhWV3LRhQCrEKQu4xQMi0re6tDLWO3USo22aZVZKQvYL7vi2jRyQP37/3X58JYBHuMGDKiGAFcDzYtFk8Hr0KhcmQ7zKHk7f7i6Btd4gZZGniuWc3G7e6rpjTOyEgSlkTk1PCZ+Kh21s8JtyMfzdV4HhYEaL7lUj7ewKkx3LkXMzrk4h5IRt1DwGvFrugDiNnPGRBM2jyR7ndWZu3OsxtHESeN2wvz0FjHuh0B3OVMzdh6DmYKEx26Bx14PZuv1SN/C4sSqLpVzqbiiCig/QJTUswNELv25yiap79xmLYtGmY0iY/CYHMx4Oz+glCDkLiO4uUJdgEMzSHqGiavwGmT71kvYCDeeF+7mpbXCY+vRgVmgCACsE+7akxehVZoMhUR+v7pPUYbNgVuF0EwiS5l0UwYzAvUSc7hTvILwCMEFbNfxhRUwJ/m3v/6vxkC+fY+iI9jC1lYM8dNMS5sg3pzVU7SneeugWiNp92Zgk7G72+PhBYjVPbC8SD6BN2v48AE1KrxpZO30aFvPn8z83mVLu3h8Z0l/RabmaDj8/2xJPxl+PZb03vArsqSfA7DOaX+zNNmm3W6UHT4IsXvAB8msfzOTandP8O0vwypksgnBNTuMl/a/2vj3QvwGh4D1GNTBBGfM+s0gGsbDIfxvRQj6iliu/FerJtg/BeHtIxk3SPS6cthufB1ePj/KC5HHKUryqozY7lFNYnNfkc7seCC9f/UQ8OQP7TVypnX7wtiwgCvgZnajq3lKXGRcsHN/BOcrISN7zHubzuSdzJnVJ+ZgxM2VhDpaTrEyakHoDDQjmEY94BExpW4i5o+DbBc29obD81GFhP11JLwUmBuGleiO5QUTn3enzeWNXR5AvcqzWqIE3HbC9qC12eZ3u0nN4lJxswgOTq6Dqz4teN+2H5ycLc+ACk0qMbQoNUJMTRocBIO1SCMWBIQ41sl1gHxREb+mIoEnM2vSlhZ8cDmKRsEyXB2zUTrv6M/K/scO0YbOuJjdNO6sxtE7OEd7VC1M1epkwf/EQJ90B9HsFQYc6CdlFAxNQD2Qx9s6PvvCH7KPnG4KhtaHuRre9NHNVsBy9ZbcEIJsRCBPfPgPI3pVQC+oNxRUQbcgaITR4EcjMAY/K137pCbnKqrkVeER6pDjvT1Utp6NUCt58hwv/L2nyzOL/IYbGVMPmr5Q+xCo5dRzn9pOriBYcSq1PDurjp2tTpYtPha35IovoQJkkwkPpvNGy9mNalhJG1DpFYM2IuEdDSDyyRARuTdERD4ftnQSt/16hlqzQPWh0h5QRWhqCKAGnAHhcjGVSPXuuKtaViCVkGvWNEmWxTKvimL1en7Ib3/7ezWq16sMWOuXBiv2TalIIedMTUtbaWyasSsssAXDWI5tGk1uzAGgeca0hmi4MGyGtjO+4QefsPM6xrSgE55xELv2HT2+om1IbluWFNM5FrL8RtnkhkuWgbSunD2NEqdkLtXFFOqmhoSSCSR9gLuPiZSK2HoWrQhBDxlYrnUFL20UQM0tbFIYRWNDciroDF1cIWkiK2EZBzlLlJyA413LrLSuZUN5JpV984gbwkcpiMQXVwU0oToMTKtYCoR96fzLOrT+fSsdXPXNCYRSCoCFg9lvJClFJqFQJoRkygzyHowNk4DW3YQRhhtFhQZV2cLiz6BCmHP9Ml+77L1mcMKvuLiwpcr65KSiq5/ZRHPD2mn/q8z5uD3mR25+KidQClJqbqRa1KNn3KTlBOV8c5Lqh53pR1/UtSHFb59H844ZoBA9ODx6iXrCY/LbX/+HvGJUCZLKuaXWuFQsW7Trx9qTt2irrnkMLtASaqcaJFIx8/Euj8GfU2rQW/OazcEtZlnKPjRaqfOre70D8v3Gur4+Tdlmj0DEh7oiuSTj4iIih64Mbu18gu847g5lcI8bq7Ncs+yS6Yb3jSXctIrfshYwbnPtZBrY22GSrOWmgAe2Bsf6jDCARa3zCKrJbkhnaeWqtKsaMpFg7o8+IImiU1PPH65X4d3wySfneHSEbprqSCwnFm0dX1u/2ooG0pa36K+DBXW7PHHBHTmdeLIk7XoaH0/W1t4Uhsao//oblBZ8Y4wCqrfqN9N3TF3y2JtIWzh6gJ0HQRhkPGbO+HX31+GPR6/I5ZNoGIQNve4WzD149fL7F6/fvQBgQJBahI2iYTREy05qk1PRWGmFd1bvtsajuq6kdldSuyup3ZXU7kpqdyW1u5LaXUntrqR2V1K7K6ndldTuSmp3JbW7ktpdSe174Ksrqd2V1O5Kan+BtUa6ktpdSe2upHZXUrsrqd2V1O5KancltbuS2l1J7a6kdldSuyup/enIsyup3ZXU7kpqdyW1u5LaXUntrqR2V1K7K6ndldTuSmp3JbW7ktpdSe2upHZXUrsrqd2V1L5HSe1Gju2gyCjHHHpX6sGmv5+sFto+C4MU8uMPToLra6C89ypbLuHzLyWm+56chcElVRxen2JqfegzwSGr94JBRvD39mly/xjWD+1BYybVSkUBSGW3Iw5x7zv7NlP4j968Ow7CYOKKgecywUogdA5ZwHRus6QbqcL47TrIqJiVmGYc2DmXtm5a2s58v8DMd/dHI1cZMsRrCNsp8XYb8C9sauOA62ubVb9cVv1t09YRDrG+N5zf2XK5/D9/uA3d","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Template","permalink":"/docs/API-docs/v1.1/createtemplate"},"next":{"title":"Get Template","permalink":"/docs/API-docs/v1.1/get-template"}}');var i=t(74848),r=t(28453),l=t(33617),o=t.n(l),a=t(17543),d=t.n(a),c=t(86013),h=t.n(c),p=t(63723),u=t.n(p),m=(t(18766),t(79329),t(9303));const x={id:"publictemplate",title:"Public Template",description:"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.",sidebar_label:"Public Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPNlyHDlyvwJXOGKk3urqQ6Sk4cba5sxoZ+SVJYZEecImuVx0FboLYhVQA6DY7GF0xD7sH/jJr/tp8yWOTAB19EWKpLSSo+ZBwy5ciURmIg9kXgeGznRwcBIcs7zIqGE6OAuDhOlY8cJwKYKD4Dhl5KicZDwmvhc5PHpJaJbJuSalZkoTI0msGDQZPxMxKTVEM3XJCNVkkpWsUFwYTaZSkRkTTFHDxYwkMi5zBg1zblJSKJawKRcsIdqoMjalYjoiP6dMEFpNT7gmuoxjpvW0zLKFWz4JiUktfIqZUglNKCkF/6VkpNfzg8950usRKhJCSa9X4ObOS5X1ehGB7ba/wVL2d7YgFJfkk4zh+JwuyIQRnVLFEgs/FQtESkiYoJMMdmhSlgOK3KbtUM1norH3CdUsIVIg/B7QiPwk5+wSJmt+Jtxolk1JTIWQBgDIZcKnnCXEpEqWs5SYlGvy/u2r3xNuoB+RIkNQS1gGTsAvbTHHpaig4mIWnYpTccyLA/K+yCRNyEKWihz98Md6mJEEvp30ej+wSTkj71/2emePUmMKfTAY0KKIZMEEzJfRiY5imQ8S6Fgk08chmadMMZgVgWNUc0BuAjhMZsxo3LAgsSwWJJZSJVwAUYWkoDNGRJlPmNKhPQOpGOFAHIrRZNE3sl9qRv793ZvXsNGcmogcZaUOq+USrlhsgGhgesCs39U39iCe7gHtcTELSU4v4Ai5Ib+UPL6AbWsmEvi/ozTEVa/3riwKqQxLyM92Cwe9HrR8xzI5J1Qx7B/LPJeCFFTRnBlkHWATaFbsl5LXZJRlHhcHp6JPej1Bc3bQ65H3lpx5woSBQ1d4nHjgdkBk+5tFgf1fioTHjiMZga9ETttdAanQ9V3BYpjSdm2gGghznvI4RRzOqT3/IqOx3ZZiumCx4ZesPfFVSBYw8Q9MSA9BKhX/VQpDMzy+S6YMj2nWPGYAELpqQxXKiEJyYfxXtwL5L3eccNp4iI4OAbQEkJtzgS2akUualUw7qOYhSQGqt6xQTCP7uXmRfxOSMj5Lt65Hkw+lNq2JSakdo1dQuLX8qSJ6GaJtSjPNCJ+2cJnTC9ZYjUiUvzSLyHcLkrApLTMTEg4UalTJIvJaGkKLIuMxBWkENADMRkFe9vGUHflEbfI5UvKSJwwEY8KnU6aAmaERp3BjPHRAlwUOgO0hp5kUpcnKQccyk2qdhPBzG48klsIwYSJyeEl5hsDbzWrCRZyVCSOTjMYXId4ZIVEg1eFUFgyunNDyB3aBi8XiHPFDNMuACqUA+IV0y8NV4aBKQMCDPPf8B40e1bgI102sOi6fSlgZUOBZkrCc8ixExIXkg5wQw03GQmDwgopFSBJqWEgMuzITeRWSOGXxBf6laMIlmZTGSGE3lihZJHIuHC6nUhjNf93Akb7l4zE6DsleSJ6G5HlIRsOQjMYhGe2FZPQ0JKPnIRkPQzIeh2S8F5LxUwvW+LnDNa0Q3ARgNLZYNl8XdlOesHMYeA57O6faMMX1BYhrq2Tgte01Cejob2VgL5bUNyDXJOVJwgSZKpkTxWJecJQmVhpUU4cAD1GwKaGJ1VcuudUiHA6qSeVcAN5wRa7Im4KJd6Ap0DiWJZwxYtgiFdFZHznc8FKQY0ZzjTt/IQxTheKagagW2t1Ur7hG2QZXjK5urXnr1hpFpNer5Al8+8tf/nIqrk8FIacBiJfT4ICcBlWX0yC0bXBrQNvI/b6CH0/Gz9zPBfx8On7ufs6x62jP/Uzh53h0KpZuwVMxRkgMzYsdUEDzg0Lgfjk2gm+4KHzzEh0+gigOfQNQawseaFg29/IE9sIFN5xmevt2fI8vaEc1SGub2oNNIcNu3xE2f0HbacIDLXhR2Ca8WBpNXuQhFOPq8zYxAt3wgl/D037kbuHtaLIAfjFYaoDzuZD0FJAEAv8YBP52TFV3wheErlWYPhfOnkWogOHNuB1jrsMXhK82RJ8LW88BW6A+bEcVtH5BeGqAAw1OF7Ntw73+aL8/Ho73WrgCq9d2yPN+kvQXi8Wd8LyCPdCf3PKgLnlbwmow4JhARWjdUEQ7ru7ltFf82xtX/wEm1cRbGyxxKlCtW1a2fNMeMjKhi2+0ncoPrdRo6F8r0YsGmNgEcKBfI04ljx3w0McrzxMw3SPAQR8xOUiSQQOT8DFJ+nneX/kIP/uI+MbHPI+SJFrpuXY69mNOkiQk6583fk8Skuf5ls/2e+vzIM/XdxHluYMNlcRvI3SXoXa9nU9ch8/FKjVHtBfeyUbgEwLNuBIIm/lo5apLuXANjqjISgfFZmVGFbsCD4LmUtjen1WWrXCjZ8baWkPfhPMOMW8skUdvnEX2uLKIxMoE8OXmcWs4gEkOSVxqg+bQjF2RghrDlMDJLmnGE+tq7OMHdkXzAsy6wZ9PT5Pf/fMAnUrgtzHWmkn4jIMvcPDnk8P+f59t6FEWBVMx1YxkDFbSIWEmjshJyrKidkfO5/No/kTHqZSZ9UV+0IpN7b/ncvLhHMEtIqqLx5t2aomo4cQBIlv14WhmWhijmviRG9w4eKTIbaMh3uDOht1xhbseX9DdtAISNFqPGDSfnAY5RXUIiJ7Vf0uTMnUanFVjrOOGJTeMPbsFWwMXZXTCsvWmj2fJjC5k6SSBd1S2t+oouoE3aMi5qHxRuJ1h2GikVyuNtm25gb8tQprc6S8nz57+BEjGtffGtdHZHO3cleh0FoyhHxsCGG4AmVRUem8uqAC7HRt43wye3Q1LQD+CHStXsV/thhVaB9NEDMyRc8HzMq983tNqVo+y3GkpTXzBSAj4+BWap7u2Ar26YQVwMG9f4FSM0DPjfVo7dFjX4wuSFSsg7Wbju0iR1o3+QOruzQzot9VkwA3XMnS1F3LFfHo790XkjXXn+UHg6otjVhjwst6XNSuQb31DoReu6VvdTnnNXl8Q9W0A6xNToOv30LfPnYi0ufuviFBbYN+aWK2bNaezHTY+Nn9B5OngWXNXjNC9au+LHY5DbN+9ndGwtZ399naeDu9gh7WWvb8ZNqw+1vYXxjDI2kJgwZcZXRP1CYt5TjOMTCPU43vw310MMgcY0Pf3Mi9K02Qo9DCg0PAagI+32ojR70LSD0kvJIOQPArJ44i8ZRihjatorlMIuLIxWw5vSEoI/8SlghceCjYeEhbNInJ9/UtJheFmsVySHrm+hscny2UEHHYh5NwGdE8gFGUIPMioDaZExnrDAw4Z6wFYVoPXbN7/wcWsBg60x+SRXGH3neapQ8HH2qPbhn1SI81upkFbsMrrSouzhio+POC6yOiC0CnQrQ1O4zD7hiGCkzkgY/KHfyGjcTQchmRo/yaPPF7Gj4HxIVJ3pNiUZ1njRQnxnzw5QISeZSx3rxjcWxLQcjGqx4WRgHIfXuz1JmwqIaIHT1ogMt58umTVTCvRW1FJfCMkFUmptuY32vuwX3izA++bXGzxtTTMPq3QhRSa2Ruo2AB0/TSi11sJTPpudXCSC79xkIGjh/NOjb8dNoXi6Ol+S8bvt6XicJtU3OGcAtlnceGjBKxuasgklJr++7pauipn/KSAbCsjq3A1Ursss4Rk/II1iZIL7W94B+Xq843vUyl13cO9oHB8rQ/aLzOkgscZj6MqTHtft/ro2ZPWFfX8AXyFK97z9mEM9waj/cFO9/mK0/fj7QlCbnNy6Je+1clhz/roOjf3Xd3cD0P4Tx7Sdzd6Nm6pnE+G92eAB3LRNRnnBufcQ7jgHswX1mS3W3rBPps36v7Ut/cp7PIVMfxs9ABieIv5fV9KXLOyH4z2yEOZ2JsI8BY29k7D+t4E2gT2kxPp/sPY46NhS1f7tqWqfTtuEuX+/q2IsrnoCmWdBvw/v3vzdj78048zeXh4ePj63fv0xfvZ4eFhDr+jKNroitl02rgM6LDubbm7l/GO37JKFEWAwoQaeoDDB4WY/d6OD7ePidwLmk/kH95/iODtBjfw/aVA1fXzXDSbfL6fjs/vy4FBGMgC022keJkEB4FNZ/HpJEGIfhumzXcyWQQH14F7UAx/uue6MHTwQUNG0HWg45TlFP7yJhzkEE15BlPhK1mlgzDAt1CQUARUFxwEcvKBxSYIIaZegDuTaZgDxx1c+1428SIInRoeHASW6oMwcPHi6hNhIpbwVqRIpsHSL7hrqupLPZXGP6rcGpgHchXuOA0OXa7kUN1ppuYMyxqt9WRUKboIVtO1fJKCf7dgx1WvsLOFvxy4AddH9XIeuwVhwA3Lm6tsOTQlPx7TMZOwE3x7+bFj8Vho/tFrwrgileJOA90DtbsM/SAn53ciRxjs/B8bzvqWp2Nb1xduk8ohPLtnideG+3X+SEjwBXN0E6X6/ohlOmuuab10a2seb8sraqQz6BRNYFoUjKoI03vunGmGmYk0i0vMm6vEcWtnFajVzkbLMLi6eTNXJJZ9n7REHmVsauyDFBJLJZh63HwP98Vsbry3twyDxc3bW3yV23sGhze/eXc/Y7ZXnQn3j4D1yfNlGKQ3w/pTlY/2DwR27+myvmMDm29bZdROZLI493JreVNHf5lBP8imfCneqISpBiImUmaMijVMvJxaB74k34Cl801on4FhGhFX2l9kZA7uZsViBimJPnkHZRVxuo7NMSIusQGc/y/gA6pnupxo6CX8fNpOOGHEKD6bMXCZux442CVKMRqnkB7qHqfVMYBCsUsuS+3BAz863C4ZM5i0C/Ecn3rbssYa2EFvfXPvUfN04Atcrpi89Ob46Ba4RFOxbzNHXUIR7tLOQd4cH0FyJp869S8i73WFCY9a2upCQB0jl5z6BK5Kti/s0xlm/Z3SZj83QwyRS4vsk3WAEq43QhTaJHSInFVp6GsT19m+cESyNBCy4C4nTRtW6BYeEYoKkceyvA1V3oBJSmYlvmk2wLI+UxMfK9bJlVzYdHe0M5JS+XxSRxbQE1LPazx5rECnxvyQd67tcEqmGLMMIQUeMK9KsCqqKdlVwRSH6OJGFChmUQdp8DdrE+1MxfdvX7kc7ypzTlU85CdmCSkLpBrkhCqD1p/c6tbXFCXgDqbOtymG66oHxkydC6RgSksBZpJUMyr4r5aEUSMBK2vCUprZrk5UgKsc4AEObwPjZe1vf/t7A66tmu46YHYFmiTwlPYGCNGUtAQPmr5iBUhA2YYI5mPq31YvAYAOmebclgywjKRvT+NH+PhWV3LRhQCrEKQu4xQMi0re6tDLWO3USo22aZVZKQvYL7vi2jRyQP37/3X58JYBHuMGDKiGAFcDzYtFk8Hr0KhcmQ7zKHk7f7i6Btd4gZZGniuWc3G7e6rpjTOyEgSlkTk1PCZ+Kh21s8JtyMfzdV4HhYEaL7lUj7ewKkx3LkXMzrk4h5IRt1DwGvFrugDiNnPGRBM2jyR7ndWZu3OsxtHESeN2wvz0FjHuh0B3OVMzdh6DmYKEx26Bx14PZuv1SN/C4sSqLpVzqbiiCig/QJTUswNELv25yiap79xmLYtGmY0iY/CYHMx4Oz+glCDkLiO4uUJdgEMzSHqGiavwGmT71kvYCDeeF+7mpbXCY+vRgVmgCACsE+7akxehVZoMhUR+v7pPUYbNgVuF0EwiS5l0UwYzAvUSc7hTvILwCMEFbNfxhRUwJ/m3v/6vxkC+fY+iI9jC1lYM8dNMS5sg3pzVU7SneeugWiNp92Zgk7G72+PhBYjVPbC8SD6BN2v48AE1KrxpZO30aFvPn8z83mVLu3h8Z0l/RabmaDj8/2xJPxl+PZb03vArsqSfA7DOaX+zNNmm3W6UHT4IsXvAB8msfzOTandP8O0vwypksgnBNTuMl/a/2vj3QvwGh4D1GNTBBGfM+s0gGsbDIfxvRQj6iliu/FerJtg/BeHtIxk3SPS6cthufB1ePj/KC5HHKUryqozY7lFNYnNfkc7seCC9f/UQ8OQP7TVypnX7wtiwgCvgZnajq3lKXGRcsHN/BOcrISN7zHubzuSdzJnVJ+ZgxM2VhDpaTrEyakHoDDQjmEY94BExpW4i5o+DbBc29obD81GFhP11JLwUmBuGleiO5QUTn3enzeWNXR5AvcqzWqIE3HbC9qC12eZ3u0nN4lJxswgOTq6Dqz4teN+2H5ycLc+ACk0qMbQoNUJMTRocBIO1SCMWBIQ41sl1gHxREb+mIoEnM2vSlhZ8cDmKRsEyXB2zUTrv6M/K/scO0YbOuJjdNO6sxtE7OEd7VC1M1epkwf/EQJ90B9HsFQYc6CdlFAxNQD2Qx9s6PvvCH7KPnG4KhtaHuRre9NHNVsBy9ZbcEIJsRCBPfPgPI3pVQC+oNxRUQbcgaITR4EcjMAY/K137pCbnKqrkVeER6pDjvT1Utp6NUCt58hwv/L2nyzOL/IYbGVMPmr5Q+xCo5dRzn9pOriBYcSq1PDurjp2tTpYtPha35IovoQJkkwkPpvNGy9mNalhJG1DpFYM2IuEdDSDyyRARuTdERD4ftnQSt/16hlqzQPWh0h5QRWhqCKAGnAHhcjGVSPXuuKtaViCVkGvWNEmWxTKvimL1en7Ib3/7ezWq16sMWOuXBiv2TalIIedMTUtbaWyasSsssAXDWI5tGk1uzAGgeca0hmi4MGyGtjO+4QefsPM6xrSgE55xELv2HT2+om1IbluWFNM5FrL8RtnkhkuWgbSunD2NEqdkLtXFFOqmhoSSCSR9gLuPiZSK2HoWrQhBDxlYrnUFL20UQM0tbFIYRWNDciroDF1cIWkiK2EZBzlLlJyA413LrLSuZUN5JpV984gbwkcpiMQXVwU0oToMTKtYCoR96fzLOrT+fSsdXPXNCYRSCoCFg9lvJClFJqFQJoRkygzyHowNk4DW3YQRhhtFhQZV2cLiz6BCmHP9Ml+77L1mcMKvuLiwpcr65KSiq5/ZRHPD2mn/q8z5uD3mR25+KidQClJqbqRa1KNn3KTlBOV8c5Lqh53pR1/UtSHFb59H844ZoBA9ODx6iXrCY/LbX/+HvGJUCZLKuaXWuFQsW7Trx9qTt2irrnkMLtASaqcaJFIx8/Euj8GfU2rQW/OazcEtZlnKPjRaqfOre70D8v3Gur4+Tdlmj0DEh7oiuSTj4iIih64Mbu18gu847g5lcI8bq7Ncs+yS6Yb3jSXctIrfshYwbnPtZBrY22GSrOWmgAe2Bsf6jDCARa3zCKrJbkhnaeWqtKsaMpFg7o8+IImiU1PPH65X4d3wySfneHSEbprqSCwnFm0dX1u/2ooG0pa36K+DBXW7PHHBHTmdeLIk7XoaH0/W1t4Uhsao//oblBZ8Y4wCqrfqN9N3TF3y2JtIWzh6gJ0HQRhkPGbO+HX31+GPR6/I5ZNoGIQNve4WzD149fL7F6/fvQBgQJBahI2iYTREy05qk1PRWGmFd1bvtsajuq6kdldSuyup3ZXU7kpqdyW1u5LaXUntrqR2V1K7K6ndldTuSmp3JbW7ktpdSe174Ksrqd2V1O5Kan+BtUa6ktpdSe2upHZXUrsrqd2V1O5KancltbuS2l1J7a6kdldSuyup/enIsyup3ZXU7kpqdyW1u5LaXUntrqR2V1K7K6ndldTuSmp3JbW7ktpdSe2upHZXUrsrqd2V1L5HSe1Gju2gyCjHHHpX6sGmv5+sFto+C4MU8uMPToLra6C89ypbLuHzLyWm+56chcElVRxen2JqfegzwSGr94JBRvD39mly/xjWD+1BYybVSkUBSGW3Iw5x7zv7NlP4j968Ow7CYOKKgecywUogdA5ZwHRus6QbqcL47TrIqJiVmGYc2DmXtm5a2s58v8DMd/dHI1cZMsRrCNsp8XYb8C9sauOA62ubVb9cVv1t09YRDrG+N5zf2XK5/D9/uA3d",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,b={},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:"Public Template"}),"\n",(0,i.jsx)(o(),{method:"post",path:"/publictemplate",context:"endpoint"}),"\n",(0,i.jsxs)(n.p,{children:["The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique ",(0,i.jsx)(n.strong,{children:"template_id"})," and a ",(0,i.jsx)(n.strong,{children:"public_url"}),". The ",(0,i.jsx)(n.strong,{children:"public_url"})," is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing."]}),"\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:"name:"})," Unique identifier for this widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\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 "hide_text_with_asterisks": false\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 "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\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 "hide_text_with_asterisks": false\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:'"mm/dd/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",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\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 "hide_text_with_asterisks": false\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:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (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 "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"14",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,i.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the number (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",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,i.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Note:"})," Responses for prefill widgets are ",(0,i.jsx)(n.strong,{children:"required"}),"."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,i.jsxs)(n.ol,{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": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\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:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",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": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "name": "date",\n "response": "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:"response:"})," Enter the date you would like to display inside the date box."]}),"\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:'"mm/dd/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",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",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": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\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:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\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 radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",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": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\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)(h(),{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 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:""},company:{type:"string",format:"string",example:""},job_title:{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},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:"5,"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},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:100},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:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{template_id:{type:"string",example:"Av8Pmpnmch"},public_url:{type:"string",example:"https://app.example.com/publicsign?templateid=Av8Pmpnmch"},message:{type:"string",example:"Public template created successfully!"}},title:"inline_response_publictemplate"}}}},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 f(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 diff --git a/assets/js/23f866da.3fe0f665.js b/assets/js/23f866da.3fe0f665.js deleted file mode 100644 index 231b2a766..000000000 --- a/assets/js/23f866da.3fe0f665.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[285],{64658:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>x,contentTitle:()=>f,default:()=>w,frontMatter:()=>g,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/selfsign.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/selfsign","permalink":"/docs/API-docs/v1.1/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":"eJztPF1zG0dyf6WzlSpJuAVAQJSssHSq00k+m4kisUyqVBeSRw92G9gRd2fWM7MEYRaq/HD/IE+pSl7up+mXpLpndrELgqRoOz4lgR9kYj67e7p7+mvnKnJiZqO94+i1TqoClbPRaRylaBMjSye1ivaiowzBYj61cqbg5cE+zFChEQ4tCHj/3RtwmXCASkxytDA1iNYtcgQaL9UM9BQEpGH9AfxZV5AIBSK3GqRK8ipF0LyZyKE02E9xKhWmMJfpDJ2NYZ7JJAOX+TXR8HxMpQNtAC9LoVKoSq1AWFCIKaYDOMqkhdLoC5kyoDU0eFmikagSWqyQuTDgNK/96af/PCQU/6wrQ/h++um/YJrrOUjF/e9KVDxAlOXgRJ2oI1nuwfsy1yKFha4MHLz+U4MorUptx73ea5xUM3i/3+udPsycK+3ecEhr6BIVgZWLiR0kuhimNLBMp48IZTRIq3pchZX5AkTaIorLUEGiywUkWptUKjqRGEoxQ1BVMUFjYyDKFNog4SDAoEgXfaf7lUX458N3b2GqTSHcAA7yysbNdqk0mLh84Zcn3GusHliYCItPd8E6I9UshkKcE1mlgx8qmZwT2hZVWhP15cE+06rXO6zKUhuHKXzwKOz1etTzRyQaC4M8PtFFoRWUwogCHRrruYu6Df5QScN84TIQeV7TYu9E9aHXU6LAvV4P3iv5Q4UgU1ROTiUawhIc8YOfMPDj3aLk8fsqlQmzMwFArcSynaFEVBp6WGJCS/qhLVKDVoFLiYZz4c+/zEXi0TJoS0ycvMDuwpcxLGjh16h0DUGmjfxRKydyPr4LNE4mIm8fMwHI4uCEcUT+Ukvl6tawQyNpdNp8iIEPCbSUiFtIxT0W4ULkFdoA1TyGjKD6DkuDlrRCvS4RXqWQoZxlN+4n0o+VdZ2FobIEZhuKsFd9qkxeZLJNRW4R5LRDy0KcY2u3RmMM4I8LSHEqqtzFIIlDnalwAG+1I0nNZUKKiXmAhE24ymCfTzmwz6DLPgcrnZHK6RQNCTN18hJhTg0d8aVXMoQeS5rLhAKt1g460bk211mIm7t0hEQrx5ry5YWQOQPvkbWNupzkIjmPYZJXGIPB1Av6AvNcz2MvHzyEFKKnOdOH1DhxoVYEv9Jhe2nBBqgaxVnLH3U2ypk2kbZN1SDlU007EwlqkQQshMxjJlwMH/UEnHQ5xiTgpVCLGFLhMAaHl26iL2NIMkzOJ/oy0GuqlbPyxw1SV/fcn2rjGHZjeBrDsxhGOzGMxjGMdmMYPY1h9CyG8U4M43EM490Yxk89TcfPAj1FQ8Q2AKOxp6T7sihI+vaNtCyhpChto3vnHd07GkCv10gFtX3//fcn6upEAZxEJCQn0R6cRM2Qkyj2faT7qG8Ufl/Sj8fjr8LPBf18On4Wfs556Gg3/Mzo53h0opZhwxM1ZkicKMpboKDuXxWC8CswCrXxptRW6yVqJIUS1x10Hh14qGPZxuUx4SKVdFLk9mZ06hFfEEYrkK4htUtIMUvejBF3f0HotOGhHlZ3vovVY6urFmqGYnwN+yeDcEPcjLzf9ovBvQXOL0P9KaFO6ueI1M/N+Dca6gsiwjpMv4wSXw34ImftezMdwoAviApdiH4ZDZ4RDejiuZkA1PsFYd8ChzrCLe77dnb7oyf98c54t0MB8on8gKLop2l/sVj8GtQjuyZsT2ZNbWl6C004hKnRxQY3gq381ahg9/Dften9r2RwT2pbFNPaZ22sksbTa1vLTqdi8cD6peqpjQFG41fm16IFJncRHOz1JpmWSQCextRm14QcuwHRoM+UHKbpsEVJakzTflH01xrpZ58J32osikGaDtZGXjsd31hAmsZwvXlje5pCURQ3NPv2TvOwKK5jMSiKABvje6L+icQkWGY3S0oY8FsJy0omuhvfKkgUM9Aq573ZMdssSWvXTSZV6AhsBWsDDM6qXBi8JA/TSq386F9fymohW9nv7JGGmADW5jM8fBds9EdBAAiF7gLUcve8a5jRIi8hqazTBRic4SWUwjk0ihe7ELlMBTtlfW7AS1GUZOgP/3Jykv7uH4ccSiBv3QGdBKRyJikCNPzL8cv+v51uGFGVJZpEWIQcaScbA7pkAMcZ5uUqCDWfzwfzxzbJtM59BOqjNTj1/57pycczBrccCFs+2oSpZ42W606ss+65W3QdigkL9cwNzjvzGLswox2+b4NXc8uFG0Z8QXfOGkjU6eMg1H18EhWCTRJiZVz9rV2G5iQ6beZ4dx3TO+aefoawZjLFXEwwv9712YLWNOdioasg33V4qotq4OgW3aijkKqJQDA6O3GrU1yudfq+5Qb59gRpS2d96dTiWZ8A5NLWMZguOduzQ5CKQ40UQCa2nSDUE2DScOkvloIGsM8TA6+JwtndsQWNAx7YBAibmMDtO3QOpk0YWqOQShZV0UQ6p82qNcmKYH206UUzK4um3qF9utd2EJd37EBhxZs3OFEjjmTIQsxuMUy5+wvSEgGeazb2iIMhnhi3+Jvcfzs6o50OOk+66Dzd+RmmQ2fbWxFt2Qc7LY1iiioX1277FBNZiJwj5rz1+P76aYOiCNsRw73SRVk5z3DBBCCLlZVuzXl1dNdHq38XQz+GXgzDGB7G8GgA3yHHg5MmdhwYURofIZYKUl1RWC+pTL6AiSF0YsDBbABXVz9UQjnpFssl9ODqinJoy+WARPdc6bkPHx9fSCsdUPpndVGnOrEb0kU6sUO60Ydvcd6vM3jDANojeKjXVNWtZlEgwTX91jkZmvq2kVJviHA6QdoyFwsQU4p4+pAzT/OZiQFRYA/G8PsXMBoPdnZi2PF/w8N6//GjExXFkS4ptyi12k+jvajOO0Yx8xla90edLqK9qyjEe+nPEE2lScOPlnKWV5FNMiwE/VXzJ2U5pzLHKI58FtFGccTBAUp5klxFe5GefMTERTGZrSXdbGhpDZ63d1WP8rmvKA6uYrQX+aRYFEfBeGuaAFWiySEr02m0rDe8bammZbWU5T+aJBytQ+min7nMW5q6XMvy/qyVXrdWYNwKPNIkZzk6fC0WtrWuZ69oPblMc4iBkjALUrGwFCKvrL+GE5EnVU5uJ16W0iwaH5h9z4YkLXibnRp4R0+W9aG3ILrhrI2+/wElqIkAHG+879yPGieIfwgNJNh8vqK4NxQfNcIE+WzLTKt7zx+NH4/Go8ejMa0Qgkb3XaNWUrTERz05+1n8nuIFzQ+KrDVbGCMWURxJh4W9+yh97/W9uyz4kjIvmNZGYH+VJoyBQ/yDu6ShHs+UFzO8m+2PbkoftzJaNtNVnlKuCIUZcBb3ZxcUdCWpuQIHd8jNMo4u70bmEhLdr3PT8DDHqfMeKCTaKDSP2oGtLwa58e7uMo4Wd6O3+F+J3ld0ePO7sfvASf1VwcPfA9bHz5ZxlN0N67dN2cHfEdjdp8vVPR4lBoVDh0VJi5xNdLo4q/XWsj2wtmTqG8sPDZfSknbMUzRk9FzXVytVQyOpvOZs/aqZaJ2jUBsUTScXLUjXWfYayScNkd15hmwFN84kr24bLzh4sN5qovw2rgXTpCXXxFR4Eg1gf9qysdkPXU+H12M5Ha40POD9zmzFavzBMPwmCj1olwJRtcUqol2DwIOhPgIq8slzgpssiAE0/7F12VCSAKhv7Hrju6+KVz6IxxuGSd3CEghW6gBeCdUUHnQT/HB11TABc8dyCVdXdKpozujeXy7jVQPt1Wngq923GExQXnRmNU24mti0taZ6Y+osZReEGsJ93wbAV8ydVSasQzbncjnoMOQa4JBxWINpgGnDZ1Q1dx3rxmTik/5s6l8jduAAWuT/Dd2fly++lRtAeT4sXzwvX3ygMrISvex58kylSr3kzzHPB/DcOqPV7MUaCZ4PQ/vmozR4IXHOgsunulplnbbNQoMAE9VVtg5PWkhMlUiRc/Ta6ATr2j46N4WXDqzD0lKkTDpfwMlVQGz5i5lB5EJLgkVUjsvm2AmsN3wuIDM4/f2DNZo+eMFlnORiPx+KF2H0vg+mZeICQagFMOIcU9TGBwWnlWE1meTCyGnwOGMoc6RIOzmkIvFBPk/RGo6jTKhzGz+fmBdHKIqmkPTTX/9GI1gMuHr2SFfmM3Q6x/76/my9i+91nl8EBMwqzgE6olOtnjgJsCpVk8o6U/lwHKSVqavz6jJZPg9rB6EYr08evq9XyrC9fgyorJ8uYCqsQxNDpaRyaExVEudcr7ztsDJvsCT/3ped0hndrQu6NWFUhewrZltFwvU9UC+MoUg4uJpNPWJdsLuO+saLN8jJ3QDSJckxoRCJLdFYrYiXtJkJFVjVG/7akuOWidwP9fIqKYNK8ND9O9joZH36699acN3ofV4HzO8g0pRSVHdAyPFXCrRajsIaLPMFON2FiNZD84d1W4ugK9DM8Cwhr4xlBj+Dw3s94vFeD/q+mC6wt618faWrS4X5HOlIV6sT3YL+b7LgdXAh7VRoD+BbPccLYtggwqRo/fqaYnwMeRr7JVo7JEJRxR+bRmSd0MJN9rsQHAQMW/hSPGZxxiYoGcq4+f24tJX2iW/DqWblJr0vuKQ97O4Z3iNHkSoQueZCQtcqmk+7QO1z1WLGqsBScoKyAn6fulxYzxWaTz/9B5XR13FP25h3G3vZQuPCfi6JbK9aW2t1fe+ga495LXCXvexN6lVEL1hxVF2tlfVO/3hnh/7XZag6OAreXk/BVgkJ+bTK88U/RPHnhxNvjzj45s1W/G0hhOyjHP94mVyMD0hkbtCAty4QPJ7K5FTgT5TrNwfOktiirVS5VHhWk+1svLNzNiLaLuNodxP5DnWBnlnmRMQ53euN1DizADEjtif72/yK1ERjtLndIbofZLcRYbdDhCfXibCvOLHJn8Ac6XNUvy2m7e2d355AvSyYV/ylFEk/iPujDrLtdo+kxaQy0i2iveOr6LIvStn3/XvHp8tTUtwu0xSEL7VliIXLor1o2IrJWzQXFEinFZhpGz60QqWUd7zmfYtSDi9Gg1G0jNfnbPTWbxmPVf++U6wTM6lmd807XVHnkE7QH1KHRquYZCn/BSkoGY6gPSqOJHFOhiIlL59iolar71aZjK/r461zDJvSBi2luJYIqPMAndD++mW6IVi/OVY/etKOkvs4OIe2m8j2pmB1g3gdfm6iz62AciuevAoRdyLEHPRtxXyPV7LQhFfr6OqIw5Lj3V2O33014kDX42ccQ9p9ujzthFOiqBsy4RzluuP/y/zYrhu79c3+D/lmXdfMF86suSo1gzWuQcc+XzfPbzSVN1rKtXMk1VSzzgnC0nyLSLcB66xrcV3ME10035f0ei3Mmlm9XqNL/OmQafiuMlDqOZpp5T9YmeZ4Kcn3o2lYcN8qhoiiyNHafAHk9M3YIOXEsMgblyoRpZjIXNJ1R8N04JPVjWkH8GEVhXxgfGb6AnO6JYmFdCHYZWvctbk25/R5Jn3lCBPK2JMvgyoTKvFuk1fgMfEIfUNJLmlppKXP5gxBLT1sWjlDzFEIJWbMtnGbDSDFnKTYgtETKnSxOq888zkhc218npIRIla0TMSvL0vq4uA0qT6DGZ33RXCeLX3GkyJ43Rw+1JxQLKskWCTZ0k5DpXJN31RSHKvKKZlOxgaJpZ52YKTpzghlyUYMqdFwBg3Bgl+LNngl7y3SCb+R6tx/D9SH44avPuDESofdWsF1nn3UnfONdN9WE/pqUFvptFmsZs+ky6oJ37LtRZoffqVvwofF0LpDP78I4hAdcYgdvjzYZ/vsEXz66d/hDQqjINNzz61JZTBfNN8w+y9k+eQ92RrziiMnpLuI4olnvqByawp+yIRjF+gt8lfCXqR82cRBNcllAkd1WLrX24NX7Hy0QtWd2qZMECtdSAECSj87l+p8AC/Vgh3wlQKmdp7XQYOVfn3c/kPdFLQKxZd+z8EKImovLOYXaFsuLX1WTRydGV3N/G5tYAJyBqfk1IUveQm3l2nKnqBcfZfLhSErcHDqP4/EhQ/kswt+sDaFe5qv1YL/vorhokq5oMTuQWrE1K3Wj1eMzj4eq/9rTfW3fDU54rBMcyReEgPGTat3Vtfsv66+ZSeYNmS0V+dSysBOxzVbQrcI9/5s7dPzfKOx7xAuFlHKjQEY+tDXvpseormQSe0r3iDRQx48jOIolwkqiy3f4uU3B2/g4vFgJ4pbVvVnCPfwzf6rr98efk3AkCL1BBsNdgY7nDHX1hVCtXY6xHwKh95EXKtSafyt7bME22cJts8SbJ8l2D5LsH2WYPsswfZZgl+vqH/7LMH2WYLtswTbZwn+54iwfZZg+yzB9lmC7bME22cJYPsswfZZgu2zBL/Vjbt9lmD7LMH2WYLtswTbZwm2zxJsnyW4z7MEoRaNjIVhmQupWnW6vjDyePVYwWkcZVQzuXccXV1RYuo9lTZR8w8VGiq4PI2jC2EkhVq53DKuawSp7u0cqYrslY8c949o59hf1JzlXasypSJHP+NlkmDpbh3bLus8eHd4FMVR/e1VoVOaY8ScHlsQc1/YFKSOCwIFf06aCzWruAwv8mtSWSPVSXRrIs+5JjL80armoxrAFYTdYkmPBv1LSG2ccHXl6y256s6P9103zgiErUfTyZ0ul8v/Bpeu4V4=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact list","permalink":"/docs/API-docs/v1.1/contactlist"},"next":{"title":"Draft Document","permalink":"/docs/API-docs/v1.1/draftdocument"}}');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),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:"eJztPF1zG0dyf6WzlSpJuAVAQJSssHSq00k+m4kisUyqVBeSRw92G9gRd2fWM7MEYRaq/HD/IE+pSl7up+mXpLpndrELgqRoOz4lgR9kYj67e7p7+mvnKnJiZqO94+i1TqoClbPRaRylaBMjSye1ivaiowzBYj61cqbg5cE+zFChEQ4tCHj/3RtwmXCASkxytDA1iNYtcgQaL9UM9BQEpGH9AfxZV5AIBSK3GqRK8ipF0LyZyKE02E9xKhWmMJfpDJ2NYZ7JJAOX+TXR8HxMpQNtAC9LoVKoSq1AWFCIKaYDOMqkhdLoC5kyoDU0eFmikagSWqyQuTDgNK/96af/PCQU/6wrQ/h++um/YJrrOUjF/e9KVDxAlOXgRJ2oI1nuwfsy1yKFha4MHLz+U4MorUptx73ea5xUM3i/3+udPsycK+3ecEhr6BIVgZWLiR0kuhimNLBMp48IZTRIq3pchZX5AkTaIorLUEGiywUkWptUKjqRGEoxQ1BVMUFjYyDKFNog4SDAoEgXfaf7lUX458N3b2GqTSHcAA7yysbNdqk0mLh84Zcn3GusHliYCItPd8E6I9UshkKcE1mlgx8qmZwT2hZVWhP15cE+06rXO6zKUhuHKXzwKOz1etTzRyQaC4M8PtFFoRWUwogCHRrruYu6Df5QScN84TIQeV7TYu9E9aHXU6LAvV4P3iv5Q4UgU1ROTiUawhIc8YOfMPDj3aLk8fsqlQmzMwFArcSynaFEVBp6WGJCS/qhLVKDVoFLiYZz4c+/zEXi0TJoS0ycvMDuwpcxLGjh16h0DUGmjfxRKydyPr4LNE4mIm8fMwHI4uCEcUT+Ukvl6tawQyNpdNp8iIEPCbSUiFtIxT0W4ULkFdoA1TyGjKD6DkuDlrRCvS4RXqWQoZxlN+4n0o+VdZ2FobIEZhuKsFd9qkxeZLJNRW4R5LRDy0KcY2u3RmMM4I8LSHEqqtzFIIlDnalwAG+1I0nNZUKKiXmAhE24ymCfTzmwz6DLPgcrnZHK6RQNCTN18hJhTg0d8aVXMoQeS5rLhAKt1g460bk211mIm7t0hEQrx5ry5YWQOQPvkbWNupzkIjmPYZJXGIPB1Av6AvNcz2MvHzyEFKKnOdOH1DhxoVYEv9Jhe2nBBqgaxVnLH3U2ypk2kbZN1SDlU007EwlqkQQshMxjJlwMH/UEnHQ5xiTgpVCLGFLhMAaHl26iL2NIMkzOJ/oy0GuqlbPyxw1SV/fcn2rjGHZjeBrDsxhGOzGMxjGMdmMYPY1h9CyG8U4M43EM490Yxk89TcfPAj1FQ8Q2AKOxp6T7sihI+vaNtCyhpChto3vnHd07GkCv10gFtX3//fcn6upEAZxEJCQn0R6cRM2Qkyj2faT7qG8Ufl/Sj8fjr8LPBf18On4Wfs556Gg3/Mzo53h0opZhwxM1ZkicKMpboKDuXxWC8CswCrXxptRW6yVqJIUS1x10Hh14qGPZxuUx4SKVdFLk9mZ06hFfEEYrkK4htUtIMUvejBF3f0HotOGhHlZ3vovVY6urFmqGYnwN+yeDcEPcjLzf9ovBvQXOL0P9KaFO6ueI1M/N+Dca6gsiwjpMv4wSXw34ImftezMdwoAviApdiH4ZDZ4RDejiuZkA1PsFYd8ChzrCLe77dnb7oyf98c54t0MB8on8gKLop2l/sVj8GtQjuyZsT2ZNbWl6C004hKnRxQY3gq381ahg9/Dften9r2RwT2pbFNPaZ22sksbTa1vLTqdi8cD6peqpjQFG41fm16IFJncRHOz1JpmWSQCextRm14QcuwHRoM+UHKbpsEVJakzTflH01xrpZ58J32osikGaDtZGXjsd31hAmsZwvXlje5pCURQ3NPv2TvOwKK5jMSiKABvje6L+icQkWGY3S0oY8FsJy0omuhvfKkgUM9Aq573ZMdssSWvXTSZV6AhsBWsDDM6qXBi8JA/TSq386F9fymohW9nv7JGGmADW5jM8fBds9EdBAAiF7gLUcve8a5jRIi8hqazTBRic4SWUwjk0ihe7ELlMBTtlfW7AS1GUZOgP/3Jykv7uH4ccSiBv3QGdBKRyJikCNPzL8cv+v51uGFGVJZpEWIQcaScbA7pkAMcZ5uUqCDWfzwfzxzbJtM59BOqjNTj1/57pycczBrccCFs+2oSpZ42W606ss+65W3QdigkL9cwNzjvzGLswox2+b4NXc8uFG0Z8QXfOGkjU6eMg1H18EhWCTRJiZVz9rV2G5iQ6beZ4dx3TO+aefoawZjLFXEwwv9712YLWNOdioasg33V4qotq4OgW3aijkKqJQDA6O3GrU1yudfq+5Qb59gRpS2d96dTiWZ8A5NLWMZguOduzQ5CKQ40UQCa2nSDUE2DScOkvloIGsM8TA6+JwtndsQWNAx7YBAibmMDtO3QOpk0YWqOQShZV0UQ6p82qNcmKYH206UUzK4um3qF9utd2EJd37EBhxZs3OFEjjmTIQsxuMUy5+wvSEgGeazb2iIMhnhi3+Jvcfzs6o50OOk+66Dzd+RmmQ2fbWxFt2Qc7LY1iiioX1277FBNZiJwj5rz1+P76aYOiCNsRw73SRVk5z3DBBCCLlZVuzXl1dNdHq38XQz+GXgzDGB7G8GgA3yHHg5MmdhwYURofIZYKUl1RWC+pTL6AiSF0YsDBbABXVz9UQjnpFssl9ODqinJoy+WARPdc6bkPHx9fSCsdUPpndVGnOrEb0kU6sUO60Ydvcd6vM3jDANojeKjXVNWtZlEgwTX91jkZmvq2kVJviHA6QdoyFwsQU4p4+pAzT/OZiQFRYA/G8PsXMBoPdnZi2PF/w8N6//GjExXFkS4ptyi12k+jvajOO0Yx8xla90edLqK9qyjEe+nPEE2lScOPlnKWV5FNMiwE/VXzJ2U5pzLHKI58FtFGccTBAUp5klxFe5GefMTERTGZrSXdbGhpDZ63d1WP8rmvKA6uYrQX+aRYFEfBeGuaAFWiySEr02m0rDe8bammZbWU5T+aJBytQ+min7nMW5q6XMvy/qyVXrdWYNwKPNIkZzk6fC0WtrWuZ69oPblMc4iBkjALUrGwFCKvrL+GE5EnVU5uJ16W0iwaH5h9z4YkLXibnRp4R0+W9aG3ILrhrI2+/wElqIkAHG+879yPGieIfwgNJNh8vqK4NxQfNcIE+WzLTKt7zx+NH4/Go8ejMa0Qgkb3XaNWUrTERz05+1n8nuIFzQ+KrDVbGCMWURxJh4W9+yh97/W9uyz4kjIvmNZGYH+VJoyBQ/yDu6ShHs+UFzO8m+2PbkoftzJaNtNVnlKuCIUZcBb3ZxcUdCWpuQIHd8jNMo4u70bmEhLdr3PT8DDHqfMeKCTaKDSP2oGtLwa58e7uMo4Wd6O3+F+J3ld0ePO7sfvASf1VwcPfA9bHz5ZxlN0N67dN2cHfEdjdp8vVPR4lBoVDh0VJi5xNdLo4q/XWsj2wtmTqG8sPDZfSknbMUzRk9FzXVytVQyOpvOZs/aqZaJ2jUBsUTScXLUjXWfYayScNkd15hmwFN84kr24bLzh4sN5qovw2rgXTpCXXxFR4Eg1gf9qysdkPXU+H12M5Ha40POD9zmzFavzBMPwmCj1olwJRtcUqol2DwIOhPgIq8slzgpssiAE0/7F12VCSAKhv7Hrju6+KVz6IxxuGSd3CEghW6gBeCdUUHnQT/HB11TABc8dyCVdXdKpozujeXy7jVQPt1Wngq923GExQXnRmNU24mti0taZ6Y+osZReEGsJ93wbAV8ydVSasQzbncjnoMOQa4JBxWINpgGnDZ1Q1dx3rxmTik/5s6l8jduAAWuT/Dd2fly++lRtAeT4sXzwvX3ygMrISvex58kylSr3kzzHPB/DcOqPV7MUaCZ4PQ/vmozR4IXHOgsunulplnbbNQoMAE9VVtg5PWkhMlUiRc/Ta6ATr2j46N4WXDqzD0lKkTDpfwMlVQGz5i5lB5EJLgkVUjsvm2AmsN3wuIDM4/f2DNZo+eMFlnORiPx+KF2H0vg+mZeICQagFMOIcU9TGBwWnlWE1meTCyGnwOGMoc6RIOzmkIvFBPk/RGo6jTKhzGz+fmBdHKIqmkPTTX/9GI1gMuHr2SFfmM3Q6x/76/my9i+91nl8EBMwqzgE6olOtnjgJsCpVk8o6U/lwHKSVqavz6jJZPg9rB6EYr08evq9XyrC9fgyorJ8uYCqsQxNDpaRyaExVEudcr7ztsDJvsCT/3ped0hndrQu6NWFUhewrZltFwvU9UC+MoUg4uJpNPWJdsLuO+saLN8jJ3QDSJckxoRCJLdFYrYiXtJkJFVjVG/7akuOWidwP9fIqKYNK8ND9O9joZH36699acN3ofV4HzO8g0pRSVHdAyPFXCrRajsIaLPMFON2FiNZD84d1W4ugK9DM8Cwhr4xlBj+Dw3s94vFeD/q+mC6wt618faWrS4X5HOlIV6sT3YL+b7LgdXAh7VRoD+BbPccLYtggwqRo/fqaYnwMeRr7JVo7JEJRxR+bRmSd0MJN9rsQHAQMW/hSPGZxxiYoGcq4+f24tJX2iW/DqWblJr0vuKQ97O4Z3iNHkSoQueZCQtcqmk+7QO1z1WLGqsBScoKyAn6fulxYzxWaTz/9B5XR13FP25h3G3vZQuPCfi6JbK9aW2t1fe+ga495LXCXvexN6lVEL1hxVF2tlfVO/3hnh/7XZag6OAreXk/BVgkJ+bTK88U/RPHnhxNvjzj45s1W/G0hhOyjHP94mVyMD0hkbtCAty4QPJ7K5FTgT5TrNwfOktiirVS5VHhWk+1svLNzNiLaLuNodxP5DnWBnlnmRMQ53euN1DizADEjtif72/yK1ERjtLndIbofZLcRYbdDhCfXibCvOLHJn8Ac6XNUvy2m7e2d355AvSyYV/ylFEk/iPujDrLtdo+kxaQy0i2iveOr6LIvStn3/XvHp8tTUtwu0xSEL7VliIXLor1o2IrJWzQXFEinFZhpGz60QqWUd7zmfYtSDi9Gg1G0jNfnbPTWbxmPVf++U6wTM6lmd807XVHnkE7QH1KHRquYZCn/BSkoGY6gPSqOJHFOhiIlL59iolar71aZjK/r461zDJvSBi2luJYIqPMAndD++mW6IVi/OVY/etKOkvs4OIe2m8j2pmB1g3gdfm6iz62AciuevAoRdyLEHPRtxXyPV7LQhFfr6OqIw5Lj3V2O33014kDX42ccQ9p9ujzthFOiqBsy4RzluuP/y/zYrhu79c3+D/lmXdfMF86suSo1gzWuQcc+XzfPbzSVN1rKtXMk1VSzzgnC0nyLSLcB66xrcV3ME10035f0ei3Mmlm9XqNL/OmQafiuMlDqOZpp5T9YmeZ4Kcn3o2lYcN8qhoiiyNHafAHk9M3YIOXEsMgblyoRpZjIXNJ1R8N04JPVjWkH8GEVhXxgfGb6AnO6JYmFdCHYZWvctbk25/R5Jn3lCBPK2JMvgyoTKvFuk1fgMfEIfUNJLmlppKXP5gxBLT1sWjlDzFEIJWbMtnGbDSDFnKTYgtETKnSxOq888zkhc218npIRIla0TMSvL0vq4uA0qT6DGZ33RXCeLX3GkyJ43Rw+1JxQLKskWCTZ0k5DpXJN31RSHKvKKZlOxgaJpZ52YKTpzghlyUYMqdFwBg3Bgl+LNngl7y3SCb+R6tx/D9SH44avPuDESofdWsF1nn3UnfONdN9WE/pqUFvptFmsZs+ky6oJ37LtRZoffqVvwofF0LpDP78I4hAdcYgdvjzYZ/vsEXz66d/hDQqjINNzz61JZTBfNN8w+y9k+eQ92RrziiMnpLuI4olnvqByawp+yIRjF+gt8lfCXqR82cRBNcllAkd1WLrX24NX7Hy0QtWd2qZMECtdSAECSj87l+p8AC/Vgh3wlQKmdp7XQYOVfn3c/kPdFLQKxZd+z8EKImovLOYXaFsuLX1WTRydGV3N/G5tYAJyBqfk1IUveQm3l2nKnqBcfZfLhSErcHDqP4/EhQ/kswt+sDaFe5qv1YL/vorhokq5oMTuQWrE1K3Wj1eMzj4eq/9rTfW3fDU54rBMcyReEgPGTat3Vtfsv66+ZSeYNmS0V+dSysBOxzVbQrcI9/5s7dPzfKOx7xAuFlHKjQEY+tDXvpseormQSe0r3iDRQx48jOIolwkqiy3f4uU3B2/g4vFgJ4pbVvVnCPfwzf6rr98efk3AkCL1BBsNdgY7nDHX1hVCtXY6xHwKh95EXKtSafyt7bME22cJts8SbJ8l2D5LsH2WYPsswfZZgl+vqH/7LMH2WYLtswTbZwn+54iwfZZg+yzB9lmC7bME22cJYPsswfZZgu2zBL/Vjbt9lmD7LMH2WYLtswTbZwm2zxJsnyW4z7MEoRaNjIVhmQupWnW6vjDyePVYwWkcZVQzuXccXV1RYuo9lTZR8w8VGiq4PI2jC2EkhVq53DKuawSp7u0cqYrslY8c949o59hf1JzlXasypSJHP+NlkmDpbh3bLus8eHd4FMVR/e1VoVOaY8ScHlsQc1/YFKSOCwIFf06aCzWruAwv8mtSWSPVSXRrIs+5JjL80armoxrAFYTdYkmPBv1LSG2ccHXl6y256s6P9103zgiErUfTyZ0ul8v/Bpeu4V4=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,x={},y=[];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)(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:"name:"})," Unique identifier for this widget."]}),"\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:'"mm/dd/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",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\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:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (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 "layout": "vertical",\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.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "default": 0,\n "formula": "",\n "decimalplaces": 2,\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:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\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"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},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:"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}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},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}}, {{note}}.",example:"

Hi {{receiver_name}},

We hope this email finds you well. {{sender_name}} has requested you to review and sign {{document_title}}.

Your signature is crucial to proceed with the next steps as it signifies your agreement and authorization.

Sign here

If you have any questions or need further clarification, please contact the sender.

Thanks,
Team OpenSign\u2122

"},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"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1}},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 w(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/23f866da.fcf2ccd3.js b/assets/js/23f866da.fcf2ccd3.js new file mode 100644 index 000000000..9ba689d27 --- /dev/null +++ b/assets/js/23f866da.fcf2ccd3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[285],{64658:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>x,contentTitle:()=>f,default:()=>b,frontMatter:()=>g,metadata:()=>i,toc:()=>j});const i=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/selfsign.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/selfsign","permalink":"/docs/API-docs/v1.1/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":"eJztPF1zG0dyf6WzlSpJuAVAQJSssHSqky3HVqJIKpMq1YXk0YPdBjDi7sx6ZpYgzEKVH+4f5ClVycv9NP2SVPfMLHbBL0n2yUoCP8jEfHb3dPf01+xF4sTMJnuHyTOd1SUqZ5PjNMnRZkZWTmqV7CUHcwSLxdTKmYKnr5/DDBUa4dCCgDc/vAA3Fw5QiUmBFqYG0bplgUDjpZqBnoKAPKw/gD/rGjKhQBRWg1RZUecImjcTBVQG+zlOpcIcFjKfobMpLOYym4Ob+zXR8HzMpQNtAM8roXKoK61AWFCIOeYDOJhLC5XRZzJnQCM0eF6hkagyWqyUhTDgNK/9/pf/2icU/6xrQ/i+/+W/YVroBUjF/a8qVDxAVNXgSB2pA1ntwZuq0CKHpa4NvH72zw2itCq1HfZ6z3BSz+DN817v+O7cucruDYe0hq5QEViFmNhBpsthTgOrfHqPUEaDtKrHVVhZLEHkLaK4OSrIdLWETGuTS0UnkkIlZgiqLidobApEmVIbJBwEGBT5su90v7YI/7L/6iVMtSmFG8DrorZps10uDWauWPrlCfeI1R0LE2Hx4S5YZ6SapVCKUyKrdPBTLbNTQtuiyiNRn75+zrTq9fbrqtLGYQ5vPQp7vR71fI1EY2GQx2e6LLWCShhRokNjPXdRt8GfammYL9wcRFFEWuwdqT70ekqUuNfrwRslf6oRZI7KyalEQ1iCI37wEwZ+vFtWPP65ymXG7EwAUCuxbGcoEZWG7leY0ZJ+aIvUoFXgUqLhQvjzrwqRebQM2gozJ8+wu/B5Ckta+BkqHSGYayN/1sqJgo/vDI2TmSjax0wAsjg4YRyRv9JSudgadmgkjU6bDzHwIYGWE3FLqbjHIpyJokYboFqkMCeofsDKoCWtENclwqsc5ihn82v3E/m72rrOwlBbArMNRdgrniqTF5lsU1FYBDnt0LIUp9jardEYA/h6CTlORV24FCRxqDM1DuCldiSphcxIMTEPkLAJVxvs8ykH9hl02ef1WmfkcjpFQ8JMnbxEmBOhI770SobQY0lzc6FAq42DznShzWUW4uYuHSHTyrGmfHomZMHAe2Rtoy4nhchOU5gUNaZgMPeCvsSi0IvUywcPIYXoac70ITVOXKgVwa902F5asAGqRnFG+aPORjnTJtK2qRqkfKppZyJBFEnAUsgiZcKl8E5PwElXYEoCXgm1TCEXDlNweO4m+jyFbI7Z6USfB3pNtXJW/nyF1MWej6faOIXdFB6m8CiF0U4Ko3EKo90URg9TGD1KYbyTwnicwng3hfFDT9Pxo0BP0RCxDcBo7CnpvjwKzmWOJ9R5QvCfCOvQSHtKahfe0t3hb+w89WoPzx0pseaSzdc3mbQwl3mOCqZGl2Awk5VkreClulk6hUntwBDgysK0LoolnEkrW3g2i+oFXeT+apWmdblmma7pHJmKnnBMsvWxqmJJoB6gKC1T9Fvl0FRGWiSVq2y4cV5IyzqKrgrb3D6Lzu0zGkCv1+gFavvxxx+P1MWRAjhKSE0cJXtwlDRDjpLU95H2p75R+H1OP+6Pvwo/l/Tz4fhR+LngoaPd8HNOP8ejI7UKGx6pMUPiRFndAAV1/6YQhF9BVKiNN6W2qJmpkVRqGjuIIzvwUMeqjct9wkUq6aQo7PXoxBFfEEZrkC4htUtIsVBejxF3f0HotOGhHlb4vosviFZXVGsMxbhpvk6N0DC+qC/R6cEg3KbXk8kD+MVQqQXO5yLSQyISKfUDUurXU6rR+18QuTZh+lw0+2rAhhTfftdTLAz4gujVhehzUesRUYtMhOtJRb1fEJ1a4FBHsLd8385uf/SgP94Z73ZoRd6rH1CW/TzvL5fLT6LzBvXIfgrbk7kUfQJvwQiH3hC67PCxP7YeFSxU/js6Sf9GrtEkeg2Yx+hCYz82Pnnbr3E6F8s71i8VpzamMo1fG8rLFpjcRXBwfCKba5kF4GlMNJAn5IIPiAZ9puQwz4ctSlJjnvfLsr/RSD/7TPhWY1kO8nywMfLS6fjGEvI8hcvNV7bnOZRleU2zb+80D8vyMhaDsgywMb5H6p9ITIINfb2khAGfS1jWMtHd+EZBougO2caNSrhakjYuu7lUoSOwFWwMMDirC2HwnGIBVmrlR39WbbYhj1Ec1z4ZRxlCnAejSwR3XwW/617jE6mNBajl9nmXaECLPIWsto4dohmeQyWcQ6N4sTNRyFyw69LnBjwXZUXO2/AvR0f5H/5xyOEhisA478/kciYpqjf8y+HT/r8fXzGirio0mbAIBdJONgV02QAO51hU68DiYrEYLO7bbK514aOK76zBqf/3RE/enTC41UDY6t5VmHomaoVjiMk2ozEWXYdiwkKceUVAho+UnbLRDt/hwVO94RIPI76g22kDJOr0sS3qPjxKSsEGETE9rv/Wbo7mKDlu5vgQDOa3zD3+ALEmKSrEBIvLXR8vkoVY6jpoghhy7KIaOLpFN+oopWqiSozOTtrqFOcbnb5vdYV8e4K0pTNeT1E84wlAIW2Mq3XJ2Z4dAo8cPqakALHtBCFOgEnDpb9aChrAPkwMYnSGz+6WLWgc8MAm6NvEeW7eoXMwbcLQGqVUsqzLJno9bVaNJCuDndKmF82sLZq4Q/t0L+0gzm/ZgULF129wpEYcm5GlmN1gwnL3F6QlAjyXrPERh3c8MW7wi7n/ZnRGOx10HnTRebjzCUZGZ9sbEW1ZEjstjWLKuhCX7IIcM1mKgrMgvPX4V+inTzEZAmDEmt/osqqdZ81gLJAVzOo58miM7fuo5h9S6KfQS2GYwt0U7g3gB+RsQNZkDgLLSuPzA1JBrmsKUWa1KZYwMYR4CjiYDeDi4qdaKCfdcrWCHlxcUAZ1tRqQkJ8qvfDJg0MKlzqg5N/6Ss91Zq9IFurMDunuH77ERT/mb4cBtHtwV28otRsNqECCS5qwc4Y09WUjz95k4WSStFUhliCmFO/2CQee5vNSA6LAHozhj09gNB7s7KSw4/+Gu3H/8b0jlaSJriizLLV6nid7Scw6JylzJFr3tc6Xyd5FEqL99GeIpdOk4TtLGeuLxGZzLAX9FTmZctxTWWCSJj6HbJM04SAGJbxJApO9RE/eYeaSlEzhiu5AtLQGz9u7iKN85jNJg/uZ7CU+JZqkSTDzmiZAlWly8qp8mqzihjct1bSsl7L8RxM5p3UoWfiJy7ykqauNHP8nrfSstQLjVuKBJjkr0OEzsbStdT17JZulBTSHGCgLsyAXS0vR/tr6CzsTRVYX5MrieSXNsvGr2Z9tSNKCt9mpgXf0YBUPvQXRNWdt9McfUIaaCMCx1o+d+07jBPFPoYEEm89XlB8NxTuNMEE+22qu1UfPH43vj8aj+6MxrRBCVh+7RlRStMQ7PTn5JH7P8YzmB0XWmi2MEcskTaTD0t5+lL738t5dFnxKeTfMo7nYXyeJU+D0xuA2aYjjmfJihrez/cF1xQOtfKad67rIKVOIwgw4h//J5SRdSWquwMEtcrNKk/PbkTmHTPdjZQLcLXDqvK8KmTYKzb12sOyLQW68u7tKk+Xt6C3/V6L3FR3e4nbs3nJJx7rc5feA9f6jVZrMb4f1+6bo5HcEdvfhan2PJ5lB4dBhWdEiJxOdL0+i3lq1B0ZLJt5Yfmi4lFa0Y5GjIaPnsr5aqxoaScVVJ5tXzUTrAoW6QtF0KhEE6TrL/iV5ryFavJgjW8GN28mr28ZfDr6ut5ooL48bYTdpyYkxNR4lA3g+bdnY7LFuFkPEsZy6Vxru8H4ntmY1fmcYfhOF7rQLwajWZh0ljyDwYIhHQCVeRUFwkwUxgOY/ti4bShIA8caOG99+VXzjw328YZjULSuCYKUO4BuhmrKTbnkHXFw0TMDcsVrBxQWdKpoTuvdXq3TdQHt1Gvhq9y0GM5RnnVlNE64nNm2tqd6YOsnZBaGGcN+3AfD1kie1CeuQzblaDToMuQE4zDkAwjTAvOEzKuu4jHVjMvFJfzD1LxE7cAAt8v+G7o+rJ9/LK0B5PKyePK6evKUiwgq97HnyTKXKveQvsCgG8Ng6o9XsyQYJHg9D+9VHafBM4oIFl091vcombZuFBgEmqqptHZ60kJk6k6LgOLfRGcbKTjo3ReVI1mFlKaYmnS/f5RowtvzFzCByHRHBImrHRZPsBMYNHwuYG5z+8c4GTe884TojcrEfD8WTMPq5D7vNxRmCUEtgxDn6qI0PH05rw2oyK4SR0+BxplAVSDF5ckhF5sOBnqIRjoO5UKc2fTwxT6hiqal0ev/Xv9EIFgOuxDrQtfkAnc5Rwr4/21AexTrPLwICZjXnFR3RKaonThesCxWlss7UPnAHeW1ibWYskubzsHYQSjH75OH7arU5ttdPAZX10wVMOSaTQq0k1WOZuiLOuVx33WFl3mBF/r0vOqYzul0XdCsCqQbd10u3SsTjPRAXxlAiHlzNpho11qNton7lxRvk5HYA6ZLkmFCI2VZorFbES9rMhAqs6g1/bclxm4vCD/XyKikrS/DQ/Tu40sl6/9e/teC61vu8DJjfQeQ5JbNugZAjtRSStRyvNVgVS3C6CxGth+ZPm7YWQVeimeFJRl4Zywx+AIf3esTjvR70fRFgYG9b++paFwvF+RzpSNerE92C/m8y6zG4kHfq8wfwvV7gGTFsEGFStH59TTE+hjxUR7Z3yISiek82jcg6oYWbjDpVPq638GWIzOKMTVAylJvz+3FhM+2T3oRTZOWmZEDwg4aweyzXJOQoUgWi0FxG6lpPJvIuUM+5ZnXOqsBSGoPyB36fWCzO9Znvf/lPekQR4562Me+u7GULjZ91cEFse9VorcXq7kHXHvNa4DZ72ZvU64hesOKotl4r653+8c4O/a/LUDE4Ct5ez8HWGQk5V6j+Q5J+eDjx5oiDb77air8phDB/J8c/n2dn49ckMtdowBsXCB5PbQp63kGU6zcHzpLYoq1UhVR4Esl2Mt7ZORkRbVdpsnsV+fZ1iZ5ZFkTEBd3rjdQ4swQxI7Yn+9v8htREY7S52SH6OMhuIsJuhwgPLhPhueIUKD+AOtCnqD4vpu3tnd+eQD0vmVf8pZRIP4j7kw6y7XaPpMWsNtItk73Di+S8LyrZ9/17h8erY1Lcbq4pCF9pyxALN0/2kmErJm/RnFEgnVZgpm340AqVU4bykvctKjk8Gw1GySrdnHOlt37DeKz7HzvFOjGTanbbvOM1dfbpBP0hdWi0jklW8l+RgpLhCNqj0kQS58xR5OTlU0zUavXDOpPxbTzemGO4Km3QUoobiYCYB+iE9jcv0yuC9VfH6kcP2lFyHwfn0HYT2b4qWN0gHsPPTfS5FVBuxZPXIeJOhJiDvq2Y7+FaFprwaoyujjgsOd7d5fjdVyMOdN1/xDGk3Yer4044JUm6IRPOZm46/r/Oj+26sVvf7P+Qb9Z1zXyJzYarEhmscQ069vmmeX6tqXylpRydI6mmmnVOEJbmsQzdBqyzLsV1sch02by66fVamDWzer1Gl/jTIdPwVW2g0gs009o/V5oWeM4veGgalty3jiGiKAu0tlgCOX0zNkg5MSyKxqXKRCUmspB03dEwHfhkfWPaAT1JilHIO8Znps+woFuSWEiXgl22xl1baHNKj3PpjStMKGNPvgyquVCZd5u8Ak+JR+gF7fqJkHWGoJYeNq2cIeYohRIzZtu0zQaQY0FSbMHoCZXEWF3UnvmckIU2Pk/JCBEr+rdH355X1MXBaVJ9Bud03mfBebb0iCtH8Lo5PNOdUCyrIlgk2dJOQ60KTS9qKY5VF5RMJ2ODxFJPOzDSdGeEsmQjhtRoOIOGYMGvxfg46o1FOuEXUp36t1B9OGz46i1OrHTYrSrc5Nl73TnfSfd9PaE3o9pKp81yPXsm3bye8C3bXqT54Vf6Ljwrh9Yd+uFFEPvoiEPs8Onr52yf3YP3v/wHvEBhFMz1wnNrVhssls0Ldv8+mk/ek60xrzhyQrqLKJ555gsqN1Lw7Vw4doFeIr8R9yLlyyZe15NCZnAQw9K93h58w85HK1TdqYKaC2KlMylAQOVnF1KdDuCpWrIDvlbA1M7zOmiw0o/H7Z9p5/FFX9xzsIaI2kuLxRnalktLj+qJo+dG1zO/WxuYgJzBKTl14R034fY0z9kTlOtX2VwYsgYHp/5xLC59IJ9d8NcbU7ineakX/Pd1DBdVzgUldg9yI6ZuvX66ZnT28Vj9X2qKLzkjOdKwTHMkXhIDxk2rd1Y37L+uvmUnmDZktNfnUsnAToeRLaFbrvvxbO3T83yjse8QLhZRySsDMPTM276a7qM5k1n0Fa+R6CEPHiZpUsgMlcWWb/H0u9cv4Oz+YCdJW1b1Bwj38MXzb759uf8tAUOK1BNsNNgZ7HDGXFtXCtXaaR+LKex7E3GjSqXxt7Yfpdh+lGL7UYrtRym2H6XYfpRi+1GK7Ucpth+l+O0eQGw/SrH9KMX2oxS/O5W2H6XYfpTi7/mcdftRiu1HKbYfpdh+lOIT3otuP0qx/SjF9qMUX8LttP0oxfajFNuPUmw/SrH9KMX2oxTbj1L8nT5KESoR6ZyHVSGkalVp+7LYw/WnKo7TZE4Vs3uHycUFpSXfUGEbNf9Uo6Fy2+M0ORNGUtiYi23TWCFKVY+nSDWE3/i8Qf+Adk79lc45/o0aYypx9TOeZhlW7sax7aLe16/2D5I0iS/vSp3THCMW9KkNsfBlbUE+uRxU8GPiQqhZzUWYiV+TilqpSqZbEXvKFbHhj1YtJ1WAriHslsp6NOhfQurKCRcXvtqWay79eN917YxA2DiaTu54tVr9D2ZAUWo=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact list","permalink":"/docs/API-docs/v1.1/contactlist"},"next":{"title":"Draft Document","permalink":"/docs/API-docs/v1.1/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:"eJztPF1zG0dyf6WzlSpJuAVAQJSssHSqky3HVqJIKpMq1YXk0YPdBjDi7sx6ZpYgzEKVH+4f5ClVycv9NP2SVPfMLHbBL0n2yUoCP8jEfHb3dPf01+xF4sTMJnuHyTOd1SUqZ5PjNMnRZkZWTmqV7CUHcwSLxdTKmYKnr5/DDBUa4dCCgDc/vAA3Fw5QiUmBFqYG0bplgUDjpZqBnoKAPKw/gD/rGjKhQBRWg1RZUecImjcTBVQG+zlOpcIcFjKfobMpLOYym4Ob+zXR8HzMpQNtAM8roXKoK61AWFCIOeYDOJhLC5XRZzJnQCM0eF6hkagyWqyUhTDgNK/9/pf/2icU/6xrQ/i+/+W/YVroBUjF/a8qVDxAVNXgSB2pA1ntwZuq0CKHpa4NvH72zw2itCq1HfZ6z3BSz+DN817v+O7cucruDYe0hq5QEViFmNhBpsthTgOrfHqPUEaDtKrHVVhZLEHkLaK4OSrIdLWETGuTS0UnkkIlZgiqLidobApEmVIbJBwEGBT5su90v7YI/7L/6iVMtSmFG8DrorZps10uDWauWPrlCfeI1R0LE2Hx4S5YZ6SapVCKUyKrdPBTLbNTQtuiyiNRn75+zrTq9fbrqtLGYQ5vPQp7vR71fI1EY2GQx2e6LLWCShhRokNjPXdRt8GfammYL9wcRFFEWuwdqT70ekqUuNfrwRslf6oRZI7KyalEQ1iCI37wEwZ+vFtWPP65ymXG7EwAUCuxbGcoEZWG7leY0ZJ+aIvUoFXgUqLhQvjzrwqRebQM2gozJ8+wu/B5Ckta+BkqHSGYayN/1sqJgo/vDI2TmSjax0wAsjg4YRyRv9JSudgadmgkjU6bDzHwIYGWE3FLqbjHIpyJokYboFqkMCeofsDKoCWtENclwqsc5ihn82v3E/m72rrOwlBbArMNRdgrniqTF5lsU1FYBDnt0LIUp9jardEYA/h6CTlORV24FCRxqDM1DuCldiSphcxIMTEPkLAJVxvs8ykH9hl02ef1WmfkcjpFQ8JMnbxEmBOhI770SobQY0lzc6FAq42DznShzWUW4uYuHSHTyrGmfHomZMHAe2Rtoy4nhchOU5gUNaZgMPeCvsSi0IvUywcPIYXoac70ITVOXKgVwa902F5asAGqRnFG+aPORjnTJtK2qRqkfKppZyJBFEnAUsgiZcKl8E5PwElXYEoCXgm1TCEXDlNweO4m+jyFbI7Z6USfB3pNtXJW/nyF1MWej6faOIXdFB6m8CiF0U4Ko3EKo90URg9TGD1KYbyTwnicwng3hfFDT9Pxo0BP0RCxDcBo7CnpvjwKzmWOJ9R5QvCfCOvQSHtKahfe0t3hb+w89WoPzx0pseaSzdc3mbQwl3mOCqZGl2Awk5VkreClulk6hUntwBDgysK0LoolnEkrW3g2i+oFXeT+apWmdblmma7pHJmKnnBMsvWxqmJJoB6gKC1T9Fvl0FRGWiSVq2y4cV5IyzqKrgrb3D6Lzu0zGkCv1+gFavvxxx+P1MWRAjhKSE0cJXtwlDRDjpLU95H2p75R+H1OP+6Pvwo/l/Tz4fhR+LngoaPd8HNOP8ejI7UKGx6pMUPiRFndAAV1/6YQhF9BVKiNN6W2qJmpkVRqGjuIIzvwUMeqjct9wkUq6aQo7PXoxBFfEEZrkC4htUtIsVBejxF3f0HotOGhHlb4vosviFZXVGsMxbhpvk6N0DC+qC/R6cEg3KbXk8kD+MVQqQXO5yLSQyISKfUDUurXU6rR+18QuTZh+lw0+2rAhhTfftdTLAz4gujVhehzUesRUYtMhOtJRb1fEJ1a4FBHsLd8385uf/SgP94Z73ZoRd6rH1CW/TzvL5fLT6LzBvXIfgrbk7kUfQJvwQiH3hC67PCxP7YeFSxU/js6Sf9GrtEkeg2Yx+hCYz82Pnnbr3E6F8s71i8VpzamMo1fG8rLFpjcRXBwfCKba5kF4GlMNJAn5IIPiAZ9puQwz4ctSlJjnvfLsr/RSD/7TPhWY1kO8nywMfLS6fjGEvI8hcvNV7bnOZRleU2zb+80D8vyMhaDsgywMb5H6p9ITIINfb2khAGfS1jWMtHd+EZBougO2caNSrhakjYuu7lUoSOwFWwMMDirC2HwnGIBVmrlR39WbbYhj1Ec1z4ZRxlCnAejSwR3XwW/617jE6mNBajl9nmXaECLPIWsto4dohmeQyWcQ6N4sTNRyFyw69LnBjwXZUXO2/AvR0f5H/5xyOEhisA478/kciYpqjf8y+HT/r8fXzGirio0mbAIBdJONgV02QAO51hU68DiYrEYLO7bbK514aOK76zBqf/3RE/enTC41UDY6t5VmHomaoVjiMk2ozEWXYdiwkKceUVAho+UnbLRDt/hwVO94RIPI76g22kDJOr0sS3qPjxKSsEGETE9rv/Wbo7mKDlu5vgQDOa3zD3+ALEmKSrEBIvLXR8vkoVY6jpoghhy7KIaOLpFN+oopWqiSozOTtrqFOcbnb5vdYV8e4K0pTNeT1E84wlAIW2Mq3XJ2Z4dAo8cPqakALHtBCFOgEnDpb9aChrAPkwMYnSGz+6WLWgc8MAm6NvEeW7eoXMwbcLQGqVUsqzLJno9bVaNJCuDndKmF82sLZq4Q/t0L+0gzm/ZgULF129wpEYcm5GlmN1gwnL3F6QlAjyXrPERh3c8MW7wi7n/ZnRGOx10HnTRebjzCUZGZ9sbEW1ZEjstjWLKuhCX7IIcM1mKgrMgvPX4V+inTzEZAmDEmt/osqqdZ81gLJAVzOo58miM7fuo5h9S6KfQS2GYwt0U7g3gB+RsQNZkDgLLSuPzA1JBrmsKUWa1KZYwMYR4CjiYDeDi4qdaKCfdcrWCHlxcUAZ1tRqQkJ8qvfDJg0MKlzqg5N/6Ss91Zq9IFurMDunuH77ERT/mb4cBtHtwV28otRsNqECCS5qwc4Y09WUjz95k4WSStFUhliCmFO/2CQee5vNSA6LAHozhj09gNB7s7KSw4/+Gu3H/8b0jlaSJriizLLV6nid7Scw6JylzJFr3tc6Xyd5FEqL99GeIpdOk4TtLGeuLxGZzLAX9FTmZctxTWWCSJj6HbJM04SAGJbxJApO9RE/eYeaSlEzhiu5AtLQGz9u7iKN85jNJg/uZ7CU+JZqkSTDzmiZAlWly8qp8mqzihjct1bSsl7L8RxM5p3UoWfiJy7ykqauNHP8nrfSstQLjVuKBJjkr0OEzsbStdT17JZulBTSHGCgLsyAXS0vR/tr6CzsTRVYX5MrieSXNsvGr2Z9tSNKCt9mpgXf0YBUPvQXRNWdt9McfUIaaCMCx1o+d+07jBPFPoYEEm89XlB8NxTuNMEE+22qu1UfPH43vj8aj+6MxrRBCVh+7RlRStMQ7PTn5JH7P8YzmB0XWmi2MEcskTaTD0t5+lL738t5dFnxKeTfMo7nYXyeJU+D0xuA2aYjjmfJihrez/cF1xQOtfKad67rIKVOIwgw4h//J5SRdSWquwMEtcrNKk/PbkTmHTPdjZQLcLXDqvK8KmTYKzb12sOyLQW68u7tKk+Xt6C3/V6L3FR3e4nbs3nJJx7rc5feA9f6jVZrMb4f1+6bo5HcEdvfhan2PJ5lB4dBhWdEiJxOdL0+i3lq1B0ZLJt5Yfmi4lFa0Y5GjIaPnsr5aqxoaScVVJ5tXzUTrAoW6QtF0KhEE6TrL/iV5ryFavJgjW8GN28mr28ZfDr6ut5ooL48bYTdpyYkxNR4lA3g+bdnY7LFuFkPEsZy6Vxru8H4ntmY1fmcYfhOF7rQLwajWZh0ljyDwYIhHQCVeRUFwkwUxgOY/ti4bShIA8caOG99+VXzjw328YZjULSuCYKUO4BuhmrKTbnkHXFw0TMDcsVrBxQWdKpoTuvdXq3TdQHt1Gvhq9y0GM5RnnVlNE64nNm2tqd6YOsnZBaGGcN+3AfD1kie1CeuQzblaDToMuQE4zDkAwjTAvOEzKuu4jHVjMvFJfzD1LxE7cAAt8v+G7o+rJ9/LK0B5PKyePK6evKUiwgq97HnyTKXKveQvsCgG8Ng6o9XsyQYJHg9D+9VHafBM4oIFl091vcombZuFBgEmqqptHZ60kJk6k6LgOLfRGcbKTjo3ReVI1mFlKaYmnS/f5RowtvzFzCByHRHBImrHRZPsBMYNHwuYG5z+8c4GTe884TojcrEfD8WTMPq5D7vNxRmCUEtgxDn6qI0PH05rw2oyK4SR0+BxplAVSDF5ckhF5sOBnqIRjoO5UKc2fTwxT6hiqal0ev/Xv9EIFgOuxDrQtfkAnc5Rwr4/21AexTrPLwICZjXnFR3RKaonThesCxWlss7UPnAHeW1ibWYskubzsHYQSjH75OH7arU5ttdPAZX10wVMOSaTQq0k1WOZuiLOuVx33WFl3mBF/r0vOqYzul0XdCsCqQbd10u3SsTjPRAXxlAiHlzNpho11qNton7lxRvk5HYA6ZLkmFCI2VZorFbES9rMhAqs6g1/bclxm4vCD/XyKikrS/DQ/Tu40sl6/9e/teC61vu8DJjfQeQ5JbNugZAjtRSStRyvNVgVS3C6CxGth+ZPm7YWQVeimeFJRl4Zywx+AIf3esTjvR70fRFgYG9b++paFwvF+RzpSNerE92C/m8y6zG4kHfq8wfwvV7gGTFsEGFStH59TTE+hjxUR7Z3yISiek82jcg6oYWbjDpVPq638GWIzOKMTVAylJvz+3FhM+2T3oRTZOWmZEDwg4aweyzXJOQoUgWi0FxG6lpPJvIuUM+5ZnXOqsBSGoPyB36fWCzO9Znvf/lPekQR4562Me+u7GULjZ91cEFse9VorcXq7kHXHvNa4DZ72ZvU64hesOKotl4r653+8c4O/a/LUDE4Ct5ez8HWGQk5V6j+Q5J+eDjx5oiDb77air8phDB/J8c/n2dn49ckMtdowBsXCB5PbQp63kGU6zcHzpLYoq1UhVR4Esl2Mt7ZORkRbVdpsnsV+fZ1iZ5ZFkTEBd3rjdQ4swQxI7Yn+9v8htREY7S52SH6OMhuIsJuhwgPLhPhueIUKD+AOtCnqD4vpu3tnd+eQD0vmVf8pZRIP4j7kw6y7XaPpMWsNtItk73Di+S8LyrZ9/17h8erY1Lcbq4pCF9pyxALN0/2kmErJm/RnFEgnVZgpm340AqVU4bykvctKjk8Gw1GySrdnHOlt37DeKz7HzvFOjGTanbbvOM1dfbpBP0hdWi0jklW8l+RgpLhCNqj0kQS58xR5OTlU0zUavXDOpPxbTzemGO4Km3QUoobiYCYB+iE9jcv0yuC9VfH6kcP2lFyHwfn0HYT2b4qWN0gHsPPTfS5FVBuxZPXIeJOhJiDvq2Y7+FaFprwaoyujjgsOd7d5fjdVyMOdN1/xDGk3Yer4044JUm6IRPOZm46/r/Oj+26sVvf7P+Qb9Z1zXyJzYarEhmscQ069vmmeX6tqXylpRydI6mmmnVOEJbmsQzdBqyzLsV1sch02by66fVamDWzer1Gl/jTIdPwVW2g0gs009o/V5oWeM4veGgalty3jiGiKAu0tlgCOX0zNkg5MSyKxqXKRCUmspB03dEwHfhkfWPaAT1JilHIO8Znps+woFuSWEiXgl22xl1baHNKj3PpjStMKGNPvgyquVCZd5u8Ak+JR+gF7fqJkHWGoJYeNq2cIeYohRIzZtu0zQaQY0FSbMHoCZXEWF3UnvmckIU2Pk/JCBEr+rdH355X1MXBaVJ9Bud03mfBebb0iCtH8Lo5PNOdUCyrIlgk2dJOQ60KTS9qKY5VF5RMJ2ODxFJPOzDSdGeEsmQjhtRoOIOGYMGvxfg46o1FOuEXUp36t1B9OGz46i1OrHTYrSrc5Nl73TnfSfd9PaE3o9pKp81yPXsm3bye8C3bXqT54Vf6Ljwrh9Yd+uFFEPvoiEPs8Onr52yf3YP3v/wHvEBhFMz1wnNrVhssls0Ldv8+mk/ek60xrzhyQrqLKJ555gsqN1Lw7Vw4doFeIr8R9yLlyyZe15NCZnAQw9K93h58w85HK1TdqYKaC2KlMylAQOVnF1KdDuCpWrIDvlbA1M7zOmiw0o/H7Z9p5/FFX9xzsIaI2kuLxRnalktLj+qJo+dG1zO/WxuYgJzBKTl14R034fY0z9kTlOtX2VwYsgYHp/5xLC59IJ9d8NcbU7ineakX/Pd1DBdVzgUldg9yI6ZuvX66ZnT28Vj9X2qKLzkjOdKwTHMkXhIDxk2rd1Y37L+uvmUnmDZktNfnUsnAToeRLaFbrvvxbO3T83yjse8QLhZRySsDMPTM276a7qM5k1n0Fa+R6CEPHiZpUsgMlcWWb/H0u9cv4Oz+YCdJW1b1Bwj38MXzb759uf8tAUOK1BNsNNgZ7HDGXFtXCtXaaR+LKex7E3GjSqXxt7Yfpdh+lGL7UYrtRym2H6XYfpRi+1GK7Ucpth+l+O0eQGw/SrH9KMX2oxS/O5W2H6XYfpTi7/mcdftRiu1HKbYfpdh+lOIT3otuP0qx/SjF9qMUX8LttP0oxfajFNuPUmw/SrH9KMX2oxTbj1L8nT5KESoR6ZyHVSGkalVp+7LYw/WnKo7TZE4Vs3uHycUFpSXfUGEbNf9Uo6Fy2+M0ORNGUtiYi23TWCFKVY+nSDWE3/i8Qf+Adk79lc45/o0aYypx9TOeZhlW7sax7aLe16/2D5I0iS/vSp3THCMW9KkNsfBlbUE+uRxU8GPiQqhZzUWYiV+TilqpSqZbEXvKFbHhj1YtJ1WAriHslsp6NOhfQurKCRcXvtqWay79eN917YxA2DiaTu54tVr9D2ZAUWo=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,x={},j=[];function y(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:"name:"})," Unique identifier for this widget."]}),"\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",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\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 "hide_text_with_asterisks": false\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 "hide_text_with_asterisks": false\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 "hide_text_with_asterisks": false\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 "hide_text_with_asterisks": false\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:'"mm/dd/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",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\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 "hide_text_with_asterisks": false\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:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (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 "layout": "vertical",\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.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "default": 0,\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\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"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},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:"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}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},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}}, {{note}}.",example:"

Hi {{receiver_name}},

We hope this email finds you well. {{sender_name}} has requested you to review and sign {{document_title}}.

Your signature is crucial to proceed with the next steps as it signifies your agreement and authorization.

Sign here

If you have any questions or need further clarification, please contact the sender.

Thanks,
Team OpenSign\u2122

"},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"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1}},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 b(e={}){const{wrapper:n}={...(0,r.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/34593b53.44951b14.js b/assets/js/34593b53.44951b14.js new file mode 100644 index 000000000..044fb71ec --- /dev/null +++ b/assets/js/34593b53.44951b14.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9099],{85203:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>f,contentTitle:()=>g,default:()=>j,frontMatter:()=>x,metadata:()=>s,toc:()=>y});const s=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/createdocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createdocument","permalink":"/docs/API-docs/v1.1/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":"eJztPdlyHDeSv4Kt2AhZPcXqQ9RhrkYxtKS1teOVFBa1jllSw0FXZXdDrALKAIrNNqMj5mH+YJ/2dT7NX7KRCaCOPkhKojXybPtBZqNwJBKZiUQewGVk+dREB8fRM5VWBUhrondxlIFJtSitUDI6iI5mwJ5q4BZYqMUOX79gPM/V3LDKgDbMKjYFCRprSZizLPTHxgtWanUuMiGnLOOWs7mwMzbmBh7sM5CpyiBjE5FDciJP5JEoD9jbMlc8YwtVafb62b/XveEwWHbc6z2DcTVlb1/0eu++mllbmoN+n5dlokqQRkxlzscmSVXRz7BimU3uxmw+Aw3YK0u5ZMCNyBeMZxmbi2wK1sTMzkCyVJULliqlMyG5BROzkk+ByaoYgzYx4zJjhdLAhGScaeDZYs+qvcoA+483r16yidIFtwl7nVcmrofLhIbU5gvXvZ1BPas7JmDDWC3kNGYFP0NsCct+qkR6htM2IDP8PzY8fP2CcNXrvanKUmkLGfvRTeGg18Mv30Cu5oxroPqpKgolWck1L8DScs24pc8afqqEhswtCs/zgIuDE7nHej3JCzjo9dhbKX6qgIkMpBUTARpnyexMGN8gcfXtoqT6L2QmUkQeAYClTE26VRGpWPVNCSl26aq2UM2UZPOZSGeEwzl361/mPHXT0mBKSK04h27HFzFbYMfPQKoAwUxp8bOSlue0fOegrUh53l5mBBCrGsu1RfSXSkgbSv0I7E9+OXG1aRE9HSJoGSK3EJK+GGDnPK/AeKjmMZshVD9AqcEQa/h+EfEyYzMQ09nW8Xj2vjK20zGrDILZhsKPFVaV0AuEtgnPDTAx6eCy4GfQGo0p4nmeJ+ybBctgwqvcxkwghVpdQcJeKst4WeYi5eMciAaQ2bitNOzRKnvySbrk85okABjGWSYmE9DIzPiRuvBtAnRIl43IIE6zMy6ZkisLnapc6XUSouIuHlmqpAVpE3Z4zkVOwLvJGiZkmlcZsHHO07OYjfMKYqYhc4y+ABRzsRdaWIVx43FO+GEGcqRCJRF+qfzwwjDjocoSdoSMUvMffgyopkGEaWPVc/lE4ciIgsCSDAou8pgQF7P3asyssDnEyOAll4sY5SvEzMKFHauLmKUzSM/oL80zodi4slZJN7FMqzJTc+lxOVHSGvHzBo4MXz4co6OY7cfsQcwexWw4iNlwFLPhfsyGD2I2fBSz0SBmo1HMRvsxGz1wYI0eeVzzGsFtAIYjh2X728LuTGRwig1PcW6n3FjQwpyhuGY/4p4DEoHLYicu4cKi8CNpJKYSsmYHFIbNRJaBZBOtCqYhFaUgaeKkQd11jPAwjZOShk2qPF+wc2FECwd1p2ouEW80otDsVQnyjZhKxtNUVbjGhGGHVEJns+QyXyCoR8ALQzN/Li3oUgsDKKql8TvV98KQbMMtxtS71ryzaw0T1uvV8gTL/vKXv5zIyxPJ2EmE4uUkOmAnUV3lJIrdN9w18NvQ/77AH/dGD/3PBf58MHrkf86p6nDf/5zhz9HwRC79gCdyRJBYXpRXQIGfbxUC/8uzEZbRoFgWJDoWoiiOwwek1g48+GHZnss9nIuQwgqem+3TCTW+oBk1IK1Nah8nRQy7fUb0+QuaThse/EIbhftEG0vrUxB5BMWoLt4mRrAabfBreLqf+F14O5ocgF8MllrgfC4kPUAkocA/QoG/HVP1nvAFoWsVps+Fs4cJKWC0M27HmK/wBeGrC9HnwtYjxBaqD9tRhV+/IDy1wMEPXhdz3wb7e8P7e6PBaL+DKzz1ugpFsZdle4vF4qPwvII91J/88KguhbOE02DQ3kCK0PpBkc5xTS2vvdLf4XD1n3ikGofTBmReBWp0y/os3z4PWZXxxR3jugpNazUa6zdK9KIFJn1COMiukc6USD3wWCcoz2M8uieIgz3CZD/L+i1MYmGW7RXF3koh/twjxLcKiyLJsmSl5trquMKCZVnM1os3lmcZK4piS7Er7xT3i2J9FklReNhISfwamcRr19v5xFf4XKzScER34CvZCG1CqBnXAmEzH61sdTMh/QdPVGylgoZplXMNF2hBMEJJV/uzyrIVbgzM2JzWyDbhrUMQDkvsq1f+RHa3PhHJlQ6w5Pp2azjATg5ZWhlLx6EpXLCSWwtaUmfnPBcZp4PLHhXABS9KPNb1/3xykv3uX/tkVEK7jXWnmUxMBdoC+38+Ptz773cbalRlCTrlBlgOOJKJGdg0YcczyMvGHDmfz5P5PZPOlMqdLfK90TBx/56q8ftTArdMuCnvbpqpI6KWEQeJbNWGY8B2MMYNCy03mHFoSYnbhgPawf0Z9oot3Nf4gvamFZDwo7OI4efjk6jgpA4h0UPzt7Iz0CfRu7qNM9xAdk3bdzdga+SinI8hX//04SyZ84WqvCQIhsruVD1Ft/CGHwoha1sUTWcQtz7yi5WP7ttyA387hLS5M2xOgT3DCrBcmGCN66Kz3dqbK8noLAHIjj0GFhqgiyBIj0/lghqwm7FBsM3Q2l0zBNZjVLE2FYfRrhmhszBtxGAfhZCiqIra5j2pew0oK7yW0sYXtkTPSxihvbprI/CLa0ZAA/P2AU7kkCwzwaZ1hQ7ra3xBsmIFpKvZ+GOkSGdHvyV193oGDNNqM+CGbRmrug25Zj6znfsS9sqZ80IjNPWlKZQWrayfypo1yDfeocgK17atbqe8dq0viPo2gPUrU6Cvd9u7z0cRaXv2vyFC7YB9Y2J1ZtaCT68449PnL4g8PTxr5oohmVfdfnGF4ZC+Xz2d4aAznfvd6TwYfMQ5rDPspx/DBnVhc/4iHwZbGwhP8FXO10R9BqkoeE6eaYJ69An89zEHMg8Y0vdTVZSVbTMUWRhIaAQNIPhbncfodzHbi1kvZv2YfRWzuwn7AchDm9beXK8QCO18tkKyTFXo/kkrnS/YWOPEYwbJNGGXlz9VXFphF8sl67HLS4wJWS4T5LAzqebOoXuMrijLMCCjOTBlKjUbAjhUavp4suq/hPleCEHpe9Dusq/UCrtfeTz1KPjQ8+i2Zr/qIc1NpkVbOMrLWotzB1UKPBCmzPmC8QnSrXNOUzMXw5DgyhywEfv9EzYcJYNBzAbub/ZVwMvorvPTvdYwEXneiidhoSgQA/rnIYfCxzD4SBLUccmnJ6RViPDgXOz1xjBR6M/DgBb0i894E3HilEwnzzs+yRRDjpRmM27c4ZtO+zhbjNixMyi8Z/GlsuACK0yppAG3/5QbgG4CI3q9FbdkqNa4JoUME0cJOLw929To60FbJA4f3O9I+PtdmTjYJhOvME2h5HO4CD4CaD61JBLJzFC+rpSuSpnQKSLbScjaWU20rqo8Y7k4gzZJCmnC/u6hXA3eeDpTyjQ1fPyE52pz0I3LUBpDM+4mtZP2U43qw4f3OhvUo1uwFK7YzruLMdjvD+/3rzSer5h8P/w0wdhNVo6s0jdaOarZLN3OyP2xRu7bIfx7t2m5Gz4cdRTOe4NPZ4BbMtC1Geca09xtGOBuzRLWZrcb2sA+my3q06lv/9c4la+I4YfDWxDDWw7fn0qJa2fsW6M9dlsH7E0EeIMT9pXH6k8m0DawvzqR3r+d0/hw0NHVvu6oal+P2kR5//6NiLI96AplnUTiv7559cN88Mdvp+rw8PDw5Zu3s+dvp4eHhwX+TpJkoyFm02rTMKjD+shyvy/THr9llCRJEIUYon9AzfulnP6bax9vb5OcyCiOVImx/0LJF1l0EJHuDkGVj2I6ooOx36hsER1cRj52FP/0kZnYtP/eYMLBZWTSGRQc/wr6OqYoYIpAFFPwH2gTxRGFvWC+Ai5pdBCp8XtIcbRSIzhWgME+qN3BZajlYuyj2Otc0UHkphjFkXcN1kV1dkKZTaJlGPCqruqSpitDf9TnGuwHw9I/shs87GAXnRSNj+rpWasHmlsBRwqtBzlYeMYXptWvO/1Gq5kh2AaZPfWtWMYXBoVGZdwGl/I8rXLUC+GiFHpRR2KQctiijxreeqQa3uH9ZbPoDUhca76I4khYKNrlW4hAqw9fuRQUYobC9j607XsFY4A/+AK0Y9DC8+KDoXivgI2BFr2cKfnB7Yeje8PR8N5whD346KcP7SPYZLCL92p8+lGMkME5tvcn7Y9fSvd1fewubR5ieDdkQe/aa/IUYkaRssl1bBLqE+b5FK7nh6Nt+SutsHkzo8MWL0vgOqE0ko/OaOqyWL3BJ9cw1DKOLq6fzAVL1V5IjmFf5TCxLvCBpUpL0HfbcVdfzORG+/vLOFpcP73Fb3J6D3Hx5tfP7kfKKmoyrv4RsN57tIyj2fWwflfnPf0Dgd1/sGw2+BX95XSsssVpkFvL6yqGvQrrTVSegUadaF1eNaIGJQzm952ubjVjpXLgcoOg6SS8+ExM1L/R1uxtMvMZkNG/Vsup90bn95ZpBy2meMBKDJcwqC7rCk6ihL2YtE4QpNGv5tyEupQFIhW7Q+OdmorE+J2+/404utPORUTLbBNwGUCgysxCUeaUnDdHY+6YYhKyhNX/kfJZYxIBCDt2GPj6reKpix2jAX2jbmYb8+prwp5yWWc3dbOI2OVlTQZEHcslu7zEVQV9ivv+chk3BThWp4C2dleiIQVx3mlVF0HTsC5rNXVa1mlGHhcs8Pt9GwAxlUJOTyvt+0FldLlMOgS5AjjZ4D0OIKvpDDOE1mddq0y00jfG/hqyPQVgJ/9v8P64fPKd2ADK43755HH55EfMYy3B8Z5Dz0TIzHH+HPI8YY+N1UpOn6yg4HHfl29eSg3nAubEuLSqTS+ruK07SjxMf0JB3SyeMCzVVSp4TkGTWqUQXD3kRsNDvLFQGnSBCUstXaohHQn4VAM5lggWXlnK26XTYRjwMWczDZPf31nB6Z0nlLKGHsXHff7E137hzBIzfg6MywWjiZMNRWlnh5tUmsRkmnMtJv4oGrMyBwzwxJMqT53zzmE0wHE04/LMxI/H+gkmv9VJc7/87e9YI8j0F/KVzkDfQKi/mDg3oWJ3UI7diV2wKZG70MZ6Ue0koaeQOkVwE+v49Cl0MT6vRb+pxgZrydBfI1qtFtMpoGvO16DGPh0TeDpzmwZB1XgaSyQeVZkAHhJYOBBm3mvsF6pr9Wlhh7yC7bknm6Q6pUi+Onp9A1ySSWrPMYpPW6RZuj7Yq6PXmAJeL3fC3poaEwG1vFOFoSWAnQse0kRrzX7hAvTA+VW8XGy7MhOffL3H1gHKhNkIUew2dZRw9QULax03dwrgEqnKomtU+MxX4rIOHgmKGpFHqroJVV6DSc6mFWVOWGTfsGtSSHSTwi2ksbpywYksq3TIWvdk4cSEMQ2eAlawUqv/mIE0rjlnE4qMiFklBWJeV2ilrLuEixK0wBiGjSjQ4FCHouP6LaqbD/32h+/9TRJ1fq6ueSh0DBmrSqIa4oQ6Tz+s3OrUN+qDXnxfDyDqbhSZ4U2tJWijJIo4padcegnqzqNoTx3DjOeuqhcV6JJDeJDDk41n/1/+9vcWXFuNIuuAuRF4lmHA/jUQkmnaETzGpGooUQKqLkTYH+g/rB4BEDpimtNCZTUjmZvT+GsK8Te1XPShBnWog6nSGW5btbw1cZCxxhsVDFmh6/xtVeJ84UIY28o0D1lG6/LhB0A8pi0Y6BCKXI00LxdtBm9CMNRKd3Q8EN1bCupD0Bov8MqqUw2FkDfbp9pWf6tqQVBZVXArUha6Mkn37gnnWg58XTShJ0iN50Lpu1tYFbs7VTKFUyFP4Rz0DY73rSgZtEmOwc4BZBu2gCS3nTX3A8wxHb+Dk9buRLdgtKFE42QBegqnKVqoiOrgBkjs9bCrXo/tOUC8TDWV9v4Zf28LCQ+UI03vCI7XheuEtWbDbV+Xk7Dv1BwRVqszqHS6/hGfjCD3lw60R0i5xCsW6JiIJzXsuPbh44UCzRAujIYWi2bjFa7UOW6wF7xnBMeJr5pTkJ91Jh7Hu0LC6OEWBJwcmvMZzxXxk1crVy5JIKBe0DURM9p/aP3Qz+TGCXe30LUHv/z1fw1FC7mQN1MfdTd+pdMqz41yd1C0ew3kHAg+6Z5NAz37wKRNds4uiYSbX0IyWJAeTvGgG4yKMYbFUnQVqVO0zYQz/Zrh9FezvF5lRvVBPzsj6m/IyjgcDP6Zjaj3Br8dI+r+4DdkRH2EwHr39/XSZJtqu1F2BB/31Q3eK3Berlzpq2uiT5nssy4IYxOCG3YYLd1/jd03CPFrbMHOWNw4sf1JNkyG0DAaDPB/3eV81omCxXNNleI5ga7x+ZcovrkH/eo1cMWb7dNXSfXZezH6+SI9H72OvHe2e5D6wI3lo1ys2GbVwbrlOHflVDxDVDrHW/xwLnu1IkHdttZYyFxIOA0LeJqp9DTMfkmqoDHdXe5GMNTLTQaW7lpfM3zkCHN/ExW9UQU4DWiO/c7RcFerglYvGJ+iLoc8rm+RqEDr69jvwyC7CgX7g8HpsEbC/XUkvJCUMEtXVh6pM5Cfd6bt4a0bHkG9KPJGBkbCVaLvUWey7XI3SQNppYVdRAfHl9HFHi/Fnvt+cPxu+Q5J0M4UBuGUyhDE3M6ig6i/FpNjQJ9TTMXxpeObmhUMlxlGEq7tD7wU/fNhMoyW8WqbjfvJFfWh2vvQJsbyqZDT69q9a3D0BtfRLVUHU42cKsUfAQWVX4h2rTgSSD8z4HguRtQjefzQRDI9D4scYow2hQ01i7kaCBTigDqhPav7+oZgnc2xOsP7rSiZ4xDwQjEsdQjLpqiUeuohzqQOM2lFjrQCR5pYkE4oCEV3tII7jhueqOMowglgSKrzaH+fdMyHQ1LG7j0iPWf/wZKouHGcRlHXOUoZXqsuvk/zWHUdVjsvzD+RF2bFCeOJp/EkuHDdjkncF3VNxIEKa5Nsxy66ahbdaqLcYqH0Q65Y4mpANhnA7m+0O/kmLRvDBo4ManWXHzHUFfnx3oD4cX9A/Pho0NHo/dybHhq9nJTvWvcmBbutX6MS/Q6FqJATRRLYC476skncIUmCr53DIE9VUd9a2eu1Frlu1evVktURKtqAXlWalWoOelK5q0AnOVzQDZjYDAr61gROAC9yMCbH3BcLU7I8UZIdulO8wT7lJR+LXKAK4FLdHMs0WoRJ8ErPEHpxR7vsw3PIUXOo7aR4GXbQ+uZKn00whCNmnI0xKxMt5SBnXKbOKO+2MzIuo92nuWLTWI1QCwebklYjnxRc8ilxcNzmCJZBjgLNMK3G6LMyKq8cH1oucqVd1CZNiOLDCYnPL0r8RIdJ3AY0zJCqz71rxsTONeZ2Kn899hi9kCXCItBoZhWrZK7wJmv0ZlY5JiZa52HEM2sbRmxuNZcGFWYfKOrXoEaY95pAuFz0rQFc4e+FPHN3ie6x45qufoSxERa69/Kscubdbptvhf2uGuNdzcoIq/SiaT0VdlaNSedod1L/cD19Gy5Db2kUN090fQMWKcT0D1+/IJ31Lvvlr//DvgeuJZupuaPWtNKQL5p71+leclp5h7Za5SS/HIpxxHjqiM/vPgGDP864JVvnS5ijUdmxlIsvf12Nc5GyoxCL0+sdhAvhm/iczj0iLsETnaWcla51LuRZwg7lgtw7zV6E5dSuMw3a/1p3yHMMKPY34oYxkwYicigYyM/BtGzXkAnngtaqmrrR2sD4yXXzXXFuh1m2lj6KzosGHGdxJd8vd6ZXvO59Q8ZpJ520G7gCMqPkXHPAMs0ntuk/XkmCpZ1wrSjkzwZ0xL6bekkcJ/oZ16XOKr2iDXflLVm7ccDutf68FJ6cjgNZsu6FVx9O1s5aQ5t7yw6AavlG9x5er25eTd6APhdpOLxv4eg+Ve5HcZSLFLzpyO9fh9++/p6d30sGUdw6Y9yAufvfv3j6/OWb5wgMClKHsGEySAZk4VbGFly2Rlp5OGF1b2ulQuzeWdi9s7B7Z2H3zsLunYXdOwu7dxZ27yzs3lnYvbPwua4B272zsHtnYffOwu6dhVvE1+6dhd07C7t3Fr7AK6h27yzs3lnYvbOwe2dh987C7p2F3TsLu3cWdu8s7N5Z2L2zsHtnYffOwq9Hnrt3FnbvLOzeWdi9s7B7Z2H3zsLunYWT3TsLu3cWdu8s7N5Z2L2zsHtnYffOwu6dhd07Czd+Z6GVwtcvcy5k69YDl+l9vPr6wrs4mmEq+MFxdHmJw7zFRE0s/qmiVMLjd3F0zrXAQEPKIo9D0jMmDZ4B5sQ+dVGoe0c4fux4mxI1VpLnMWvbtTgkgr6ybjtb/fWrN0dRHIU7YwuV0TUdfI5JhnzuMjBbmYhUdhnlXE4rymKMXJ9Ld6PZrJvkfUZJ3v6PViokpjQ3EHazv9008F+c1MYGl5cugZxyiF1992lrC4/YUBvX791yufw/0HMqKA==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Document","permalink":"/docs/API-docs/v1.1/draftdocument"},"next":{"title":"Create Document from Template","permalink":"/docs/API-docs/v1.1/createdocumentwithtemplateid"}}');var i=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),u=t.n(p),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:"eJztPdlyHDeSv4Kt2AhZPcXqQ9RhrkYxtKS1teOVFBa1jllSw0FXZXdDrALKAIrNNqMj5mH+YJ/2dT7NX7KRCaCOPkhKojXybPtBZqNwJBKZiUQewGVk+dREB8fRM5VWBUhrondxlIFJtSitUDI6iI5mwJ5q4BZYqMUOX79gPM/V3LDKgDbMKjYFCRprSZizLPTHxgtWanUuMiGnLOOWs7mwMzbmBh7sM5CpyiBjE5FDciJP5JEoD9jbMlc8YwtVafb62b/XveEwWHbc6z2DcTVlb1/0eu++mllbmoN+n5dlokqQRkxlzscmSVXRz7BimU3uxmw+Aw3YK0u5ZMCNyBeMZxmbi2wK1sTMzkCyVJULliqlMyG5BROzkk+ByaoYgzYx4zJjhdLAhGScaeDZYs+qvcoA+483r16yidIFtwl7nVcmrofLhIbU5gvXvZ1BPas7JmDDWC3kNGYFP0NsCct+qkR6htM2IDP8PzY8fP2CcNXrvanKUmkLGfvRTeGg18Mv30Cu5oxroPqpKgolWck1L8DScs24pc8afqqEhswtCs/zgIuDE7nHej3JCzjo9dhbKX6qgIkMpBUTARpnyexMGN8gcfXtoqT6L2QmUkQeAYClTE26VRGpWPVNCSl26aq2UM2UZPOZSGeEwzl361/mPHXT0mBKSK04h27HFzFbYMfPQKoAwUxp8bOSlue0fOegrUh53l5mBBCrGsu1RfSXSkgbSv0I7E9+OXG1aRE9HSJoGSK3EJK+GGDnPK/AeKjmMZshVD9AqcEQa/h+EfEyYzMQ09nW8Xj2vjK20zGrDILZhsKPFVaV0AuEtgnPDTAx6eCy4GfQGo0p4nmeJ+ybBctgwqvcxkwghVpdQcJeKst4WeYi5eMciAaQ2bitNOzRKnvySbrk85okABjGWSYmE9DIzPiRuvBtAnRIl43IIE6zMy6ZkisLnapc6XUSouIuHlmqpAVpE3Z4zkVOwLvJGiZkmlcZsHHO07OYjfMKYqYhc4y+ABRzsRdaWIVx43FO+GEGcqRCJRF+qfzwwjDjocoSdoSMUvMffgyopkGEaWPVc/lE4ciIgsCSDAou8pgQF7P3asyssDnEyOAll4sY5SvEzMKFHauLmKUzSM/oL80zodi4slZJN7FMqzJTc+lxOVHSGvHzBo4MXz4co6OY7cfsQcwexWw4iNlwFLPhfsyGD2I2fBSz0SBmo1HMRvsxGz1wYI0eeVzzGsFtAIYjh2X728LuTGRwig1PcW6n3FjQwpyhuGY/4p4DEoHLYicu4cKi8CNpJKYSsmYHFIbNRJaBZBOtCqYhFaUgaeKkQd11jPAwjZOShk2qPF+wc2FECwd1p2ouEW80otDsVQnyjZhKxtNUVbjGhGGHVEJns+QyXyCoR8ALQzN/Li3oUgsDKKql8TvV98KQbMMtxtS71ryzaw0T1uvV8gTL/vKXv5zIyxPJ2EmE4uUkOmAnUV3lJIrdN9w18NvQ/77AH/dGD/3PBf58MHrkf86p6nDf/5zhz9HwRC79gCdyRJBYXpRXQIGfbxUC/8uzEZbRoFgWJDoWoiiOwwek1g48+GHZnss9nIuQwgqem+3TCTW+oBk1IK1Nah8nRQy7fUb0+QuaThse/EIbhftEG0vrUxB5BMWoLt4mRrAabfBreLqf+F14O5ocgF8MllrgfC4kPUAkocA/QoG/HVP1nvAFoWsVps+Fs4cJKWC0M27HmK/wBeGrC9HnwtYjxBaqD9tRhV+/IDy1wMEPXhdz3wb7e8P7e6PBaL+DKzz1ugpFsZdle4vF4qPwvII91J/88KguhbOE02DQ3kCK0PpBkc5xTS2vvdLf4XD1n3ikGofTBmReBWp0y/os3z4PWZXxxR3jugpNazUa6zdK9KIFJn1COMiukc6USD3wWCcoz2M8uieIgz3CZD/L+i1MYmGW7RXF3koh/twjxLcKiyLJsmSl5trquMKCZVnM1os3lmcZK4piS7Er7xT3i2J9FklReNhISfwamcRr19v5xFf4XKzScER34CvZCG1CqBnXAmEzH61sdTMh/QdPVGylgoZplXMNF2hBMEJJV/uzyrIVbgzM2JzWyDbhrUMQDkvsq1f+RHa3PhHJlQ6w5Pp2azjATg5ZWhlLx6EpXLCSWwtaUmfnPBcZp4PLHhXABS9KPNb1/3xykv3uX/tkVEK7jXWnmUxMBdoC+38+Ptz773cbalRlCTrlBlgOOJKJGdg0YcczyMvGHDmfz5P5PZPOlMqdLfK90TBx/56q8ftTArdMuCnvbpqpI6KWEQeJbNWGY8B2MMYNCy03mHFoSYnbhgPawf0Z9oot3Nf4gvamFZDwo7OI4efjk6jgpA4h0UPzt7Iz0CfRu7qNM9xAdk3bdzdga+SinI8hX//04SyZ84WqvCQIhsruVD1Ft/CGHwoha1sUTWcQtz7yi5WP7ttyA387hLS5M2xOgT3DCrBcmGCN66Kz3dqbK8noLAHIjj0GFhqgiyBIj0/lghqwm7FBsM3Q2l0zBNZjVLE2FYfRrhmhszBtxGAfhZCiqIra5j2pew0oK7yW0sYXtkTPSxihvbprI/CLa0ZAA/P2AU7kkCwzwaZ1hQ7ra3xBsmIFpKvZ+GOkSGdHvyV193oGDNNqM+CGbRmrug25Zj6znfsS9sqZ80IjNPWlKZQWrayfypo1yDfeocgK17atbqe8dq0viPo2gPUrU6Cvd9u7z0cRaXv2vyFC7YB9Y2J1ZtaCT68449PnL4g8PTxr5oohmVfdfnGF4ZC+Xz2d4aAznfvd6TwYfMQ5rDPspx/DBnVhc/4iHwZbGwhP8FXO10R9BqkoeE6eaYJ69An89zEHMg8Y0vdTVZSVbTMUWRhIaAQNIPhbncfodzHbi1kvZv2YfRWzuwn7AchDm9beXK8QCO18tkKyTFXo/kkrnS/YWOPEYwbJNGGXlz9VXFphF8sl67HLS4wJWS4T5LAzqebOoXuMrijLMCCjOTBlKjUbAjhUavp4suq/hPleCEHpe9Dusq/UCrtfeTz1KPjQ8+i2Zr/qIc1NpkVbOMrLWotzB1UKPBCmzPmC8QnSrXNOUzMXw5DgyhywEfv9EzYcJYNBzAbub/ZVwMvorvPTvdYwEXneiidhoSgQA/rnIYfCxzD4SBLUccmnJ6RViPDgXOz1xjBR6M/DgBb0i894E3HilEwnzzs+yRRDjpRmM27c4ZtO+zhbjNixMyi8Z/GlsuACK0yppAG3/5QbgG4CI3q9FbdkqNa4JoUME0cJOLw929To60FbJA4f3O9I+PtdmTjYJhOvME2h5HO4CD4CaD61JBLJzFC+rpSuSpnQKSLbScjaWU20rqo8Y7k4gzZJCmnC/u6hXA3eeDpTyjQ1fPyE52pz0I3LUBpDM+4mtZP2U43qw4f3OhvUo1uwFK7YzruLMdjvD+/3rzSer5h8P/w0wdhNVo6s0jdaOarZLN3OyP2xRu7bIfx7t2m5Gz4cdRTOe4NPZ4BbMtC1Geca09xtGOBuzRLWZrcb2sA+my3q06lv/9c4la+I4YfDWxDDWw7fn0qJa2fsW6M9dlsH7E0EeIMT9pXH6k8m0DawvzqR3r+d0/hw0NHVvu6oal+P2kR5//6NiLI96AplnUTiv7559cN88Mdvp+rw8PDw5Zu3s+dvp4eHhwX+TpJkoyFm02rTMKjD+shyvy/THr9llCRJEIUYon9AzfulnP6bax9vb5OcyCiOVImx/0LJF1l0EJHuDkGVj2I6ooOx36hsER1cRj52FP/0kZnYtP/eYMLBZWTSGRQc/wr6OqYoYIpAFFPwH2gTxRGFvWC+Ai5pdBCp8XtIcbRSIzhWgME+qN3BZajlYuyj2Otc0UHkphjFkXcN1kV1dkKZTaJlGPCqruqSpitDf9TnGuwHw9I/shs87GAXnRSNj+rpWasHmlsBRwqtBzlYeMYXptWvO/1Gq5kh2AaZPfWtWMYXBoVGZdwGl/I8rXLUC+GiFHpRR2KQctiijxreeqQa3uH9ZbPoDUhca76I4khYKNrlW4hAqw9fuRQUYobC9j607XsFY4A/+AK0Y9DC8+KDoXivgI2BFr2cKfnB7Yeje8PR8N5whD346KcP7SPYZLCL92p8+lGMkME5tvcn7Y9fSvd1fewubR5ieDdkQe/aa/IUYkaRssl1bBLqE+b5FK7nh6Nt+SutsHkzo8MWL0vgOqE0ko/OaOqyWL3BJ9cw1DKOLq6fzAVL1V5IjmFf5TCxLvCBpUpL0HfbcVdfzORG+/vLOFpcP73Fb3J6D3Hx5tfP7kfKKmoyrv4RsN57tIyj2fWwflfnPf0Dgd1/sGw2+BX95XSsssVpkFvL6yqGvQrrTVSegUadaF1eNaIGJQzm952ubjVjpXLgcoOg6SS8+ExM1L/R1uxtMvMZkNG/Vsup90bn95ZpBy2meMBKDJcwqC7rCk6ihL2YtE4QpNGv5tyEupQFIhW7Q+OdmorE+J2+/404utPORUTLbBNwGUCgysxCUeaUnDdHY+6YYhKyhNX/kfJZYxIBCDt2GPj6reKpix2jAX2jbmYb8+prwp5yWWc3dbOI2OVlTQZEHcslu7zEVQV9ivv+chk3BThWp4C2dleiIQVx3mlVF0HTsC5rNXVa1mlGHhcs8Pt9GwAxlUJOTyvt+0FldLlMOgS5AjjZ4D0OIKvpDDOE1mddq0y00jfG/hqyPQVgJ/9v8P64fPKd2ADK43755HH55EfMYy3B8Z5Dz0TIzHH+HPI8YY+N1UpOn6yg4HHfl29eSg3nAubEuLSqTS+ruK07SjxMf0JB3SyeMCzVVSp4TkGTWqUQXD3kRsNDvLFQGnSBCUstXaohHQn4VAM5lggWXlnK26XTYRjwMWczDZPf31nB6Z0nlLKGHsXHff7E137hzBIzfg6MywWjiZMNRWlnh5tUmsRkmnMtJv4oGrMyBwzwxJMqT53zzmE0wHE04/LMxI/H+gkmv9VJc7/87e9YI8j0F/KVzkDfQKi/mDg3oWJ3UI7diV2wKZG70MZ6Ue0koaeQOkVwE+v49Cl0MT6vRb+pxgZrydBfI1qtFtMpoGvO16DGPh0TeDpzmwZB1XgaSyQeVZkAHhJYOBBm3mvsF6pr9Wlhh7yC7bknm6Q6pUi+Onp9A1ySSWrPMYpPW6RZuj7Yq6PXmAJeL3fC3poaEwG1vFOFoSWAnQse0kRrzX7hAvTA+VW8XGy7MhOffL3H1gHKhNkIUew2dZRw9QULax03dwrgEqnKomtU+MxX4rIOHgmKGpFHqroJVV6DSc6mFWVOWGTfsGtSSHSTwi2ksbpywYksq3TIWvdk4cSEMQ2eAlawUqv/mIE0rjlnE4qMiFklBWJeV2ilrLuEixK0wBiGjSjQ4FCHouP6LaqbD/32h+/9TRJ1fq6ueSh0DBmrSqIa4oQ6Tz+s3OrUN+qDXnxfDyDqbhSZ4U2tJWijJIo4padcegnqzqNoTx3DjOeuqhcV6JJDeJDDk41n/1/+9vcWXFuNIuuAuRF4lmHA/jUQkmnaETzGpGooUQKqLkTYH+g/rB4BEDpimtNCZTUjmZvT+GsK8Te1XPShBnWog6nSGW5btbw1cZCxxhsVDFmh6/xtVeJ84UIY28o0D1lG6/LhB0A8pi0Y6BCKXI00LxdtBm9CMNRKd3Q8EN1bCupD0Bov8MqqUw2FkDfbp9pWf6tqQVBZVXArUha6Mkn37gnnWg58XTShJ0iN50Lpu1tYFbs7VTKFUyFP4Rz0DY73rSgZtEmOwc4BZBu2gCS3nTX3A8wxHb+Dk9buRLdgtKFE42QBegqnKVqoiOrgBkjs9bCrXo/tOUC8TDWV9v4Zf28LCQ+UI03vCI7XheuEtWbDbV+Xk7Dv1BwRVqszqHS6/hGfjCD3lw60R0i5xCsW6JiIJzXsuPbh44UCzRAujIYWi2bjFa7UOW6wF7xnBMeJr5pTkJ91Jh7Hu0LC6OEWBJwcmvMZzxXxk1crVy5JIKBe0DURM9p/aP3Qz+TGCXe30LUHv/z1fw1FC7mQN1MfdTd+pdMqz41yd1C0ew3kHAg+6Z5NAz37wKRNds4uiYSbX0IyWJAeTvGgG4yKMYbFUnQVqVO0zYQz/Zrh9FezvF5lRvVBPzsj6m/IyjgcDP6Zjaj3Br8dI+r+4DdkRH2EwHr39/XSZJtqu1F2BB/31Q3eK3Berlzpq2uiT5nssy4IYxOCG3YYLd1/jd03CPFrbMHOWNw4sf1JNkyG0DAaDPB/3eV81omCxXNNleI5ga7x+ZcovrkH/eo1cMWb7dNXSfXZezH6+SI9H72OvHe2e5D6wI3lo1ys2GbVwbrlOHflVDxDVDrHW/xwLnu1IkHdttZYyFxIOA0LeJqp9DTMfkmqoDHdXe5GMNTLTQaW7lpfM3zkCHN/ExW9UQU4DWiO/c7RcFerglYvGJ+iLoc8rm+RqEDr69jvwyC7CgX7g8HpsEbC/XUkvJCUMEtXVh6pM5Cfd6bt4a0bHkG9KPJGBkbCVaLvUWey7XI3SQNppYVdRAfHl9HFHi/Fnvt+cPxu+Q5J0M4UBuGUyhDE3M6ig6i/FpNjQJ9TTMXxpeObmhUMlxlGEq7tD7wU/fNhMoyW8WqbjfvJFfWh2vvQJsbyqZDT69q9a3D0BtfRLVUHU42cKsUfAQWVX4h2rTgSSD8z4HguRtQjefzQRDI9D4scYow2hQ01i7kaCBTigDqhPav7+oZgnc2xOsP7rSiZ4xDwQjEsdQjLpqiUeuohzqQOM2lFjrQCR5pYkE4oCEV3tII7jhueqOMowglgSKrzaH+fdMyHQ1LG7j0iPWf/wZKouHGcRlHXOUoZXqsuvk/zWHUdVjsvzD+RF2bFCeOJp/EkuHDdjkncF3VNxIEKa5Nsxy66ahbdaqLcYqH0Q65Y4mpANhnA7m+0O/kmLRvDBo4ManWXHzHUFfnx3oD4cX9A/Pho0NHo/dybHhq9nJTvWvcmBbutX6MS/Q6FqJATRRLYC476skncIUmCr53DIE9VUd9a2eu1Frlu1evVktURKtqAXlWalWoOelK5q0AnOVzQDZjYDAr61gROAC9yMCbH3BcLU7I8UZIdulO8wT7lJR+LXKAK4FLdHMs0WoRJ8ErPEHpxR7vsw3PIUXOo7aR4GXbQ+uZKn00whCNmnI0xKxMt5SBnXKbOKO+2MzIuo92nuWLTWI1QCwebklYjnxRc8ilxcNzmCJZBjgLNMK3G6LMyKq8cH1oucqVd1CZNiOLDCYnPL0r8RIdJ3AY0zJCqz71rxsTONeZ2Kn899hi9kCXCItBoZhWrZK7wJmv0ZlY5JiZa52HEM2sbRmxuNZcGFWYfKOrXoEaY95pAuFz0rQFc4e+FPHN3ie6x45qufoSxERa69/Kscubdbptvhf2uGuNdzcoIq/SiaT0VdlaNSedod1L/cD19Gy5Db2kUN090fQMWKcT0D1+/IJ31Lvvlr//DvgeuJZupuaPWtNKQL5p71+leclp5h7Za5SS/HIpxxHjqiM/vPgGDP864JVvnS5ijUdmxlIsvf12Nc5GyoxCL0+sdhAvhm/iczj0iLsETnaWcla51LuRZwg7lgtw7zV6E5dSuMw3a/1p3yHMMKPY34oYxkwYicigYyM/BtGzXkAnngtaqmrrR2sD4yXXzXXFuh1m2lj6KzosGHGdxJd8vd6ZXvO59Q8ZpJ520G7gCMqPkXHPAMs0ntuk/XkmCpZ1wrSjkzwZ0xL6bekkcJ/oZ16XOKr2iDXflLVm7ccDutf68FJ6cjgNZsu6FVx9O1s5aQ5t7yw6AavlG9x5er25eTd6APhdpOLxv4eg+Ve5HcZSLFLzpyO9fh9++/p6d30sGUdw6Y9yAufvfv3j6/OWb5wgMClKHsGEySAZk4VbGFly2Rlp5OGF1b2ulQuzeWdi9s7B7Z2H3zsLunYXdOwu7dxZ27yzs3lnYvbPwua4B272zsHtnYffOwu6dhVvE1+6dhd07C7t3Fr7AK6h27yzs3lnYvbOwe2dh987C7p2F3TsLu3cWdu8s7N5Z2L2zsHtnYffOwq9Hnrt3FnbvLOzeWdi9s7B7Z2H3zsLunYWT3TsLu3cWdu8s7N5Z2L2zsHtnYffOwu6dhd07Czd+Z6GVwtcvcy5k69YDl+l9vPr6wrs4mmEq+MFxdHmJw7zFRE0s/qmiVMLjd3F0zrXAQEPKIo9D0jMmDZ4B5sQ+dVGoe0c4fux4mxI1VpLnMWvbtTgkgr6ybjtb/fWrN0dRHIU7YwuV0TUdfI5JhnzuMjBbmYhUdhnlXE4rymKMXJ9Ld6PZrJvkfUZJ3v6PViokpjQ3EHazv9008F+c1MYGl5cugZxyiF1992lrC4/YUBvX791yufw/0HMqKA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=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,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Document"}),"\n",(0,i.jsx)(l(),{method:"post",path:"/createdocument",context:"endpoint"}),"\n",(0,i.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\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 "hide_text_with_asterisks": false\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 "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\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 "hide_text_with_asterisks": false\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:'"mm/dd/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",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\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 "hide_text_with_asterisks": false\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:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (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 "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"14",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,i.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the number (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",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,i.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Note:"})," Responses for prefill widgets are ",(0,i.jsx)(n.strong,{children:"required"}),"."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,i.jsxs)(n.ol,{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": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\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:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",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": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "name": "date",\n "response": "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:"response:"})," Enter the date you would like to display inside the date box."]}),"\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:'"mm/dd/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",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",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": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\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:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\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 radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",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": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\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)(h(),{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"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},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}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},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}}, {{note}}.",example:"

Hi {{receiver_name}},

We hope this email finds you well. {{sender_name}} has requested you to review and sign {{document_title}}.

Your signature is crucial to proceed with the next steps as it signifies your agreement and authorization.

Sign here

If you have any questions or need further clarification, please contact the sender.

Thanks,
Team OpenSign\u2122

"},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},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},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:100},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:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createdocument_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"},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 j(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/34593b53.e344c6a7.js b/assets/js/34593b53.e344c6a7.js deleted file mode 100644 index 733b76821..000000000 --- a/assets/js/34593b53.e344c6a7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9099],{85203:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>y,default:()=>b,frontMatter:()=>x,metadata:()=>r,toc:()=>f});const r=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/createdocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createdocument","permalink":"/docs/API-docs/v1.1/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":"eJztPNlyHDeSv4Kt2AhZPdXVB0lJ5moUQ0tamzteiWFR65glNRx0VXY3xCqgDFSx2WZ0xDzMH+zTvs6n+Us2MgHU0QcPkfZIs+0HmY3CkUhkJhJ5XQUFn5hg/yR4peIyA1mY4EMYJGBiLfJCKBnsB8dTYC818AKY78UOjg4ZT1M1M6w0oA0rFJuABI29JMxY4udjoznLtboQiZATlvCCs5kopmzEDTzZZSBjlUDCxiKF6FSeymOR77P3eap4wuaq1Ozo1b9Xs+Ey2HbS6byCUTlh7w87nQ9fTYsiN/u9Hs/zSOUgjZjIlI9MFKusl2DHPBk/DtlsChpwVhZzyYAbkc4ZTxI2E8kEChOyYgqSxSqfs1gpnQjJCzAhy/kEmCyzEWgTMi4TlikNTEjGmQaezLuF6pYG2H+8e/uGjZXOeBGxo7Q0YbVcIjTERTq30xdTqHb1yHhsmEILOQlZxs8RW6JgP5UiPsdtG5AJ/h8HHhwdEq46nXdlnitdQMJ+tFvY73TwyzeQqhnjGqh/rLJMSZZzzTMo6LimvKDPGn4qhYbEHgpPU4+L/VPZZZ2O5BnsdzrsvRQ/lcBEArIQYwEad8mKqTBuQGT7F/Oc+h/KRMSIPAIAW5kat7siUrHruxxinNJ2baCaKclmUxFPCYczbs8/T3lst6XB5BAX4gLaE1+GbI4TvwKpPARTpcXPShY8peO7AF2ImKfNY0YAsaspuC4Q/bkSsvCtbgX2J3eceNp0iI4OEbQEkZsJSV8MsAuelmAcVLOQTRGqHyDXYIg13LyIeJmwKYjJdON6PPlYmqI1MSsNgtmEwq3lT5XQC4S2MU8NMDFu4TLj59BYjSnieZ5G7Js5S2DMy7QImUAKLXQJEXujCsbzPBUxH6VANIDMxotSQ5dO2ZFP1CafI5IAYBhniRiPQSMz40eawo3x0CFd1iKDOK2YcsmUXDroWKVKr5IQNbfxyGIlC5BFxA4uuEgJeLtZw4SM0zIBNkp5fB6yUVpCyDQkltHngGIudEILuzBuHM4JP8xAilSoJMIvlVteGGYcVEnEjpFRKv7Djx7VtIgwTaw6Lh8rXBlR4FmSQcZFGhLiQvZRjVghihRCZPCcy3mI8hVCVsBlMVKXIYunEJ/TX5onQrFRWRRK2o0lWuWJmkmHy7GShRE/r+FI/+XuGB2GbDdkT0L2LGSDfsgGw5ANdkM2eBKywbOQDfshGw5DNtwN2fCJBWv4zOGaVwhuAjAYWiwXXw52UU5/LwxxNgpYU8nsWUtmDyLW6VTchG1/+ctfTuXVqWTsNEDmOg322WlQdTkNQvsNZSZ+G7jfl/hjZ/jU/ZzjzyfDZ+7njLoOdt3PKf4cDk7lwi14KocEScGz/Boo8PODQuB+OSLCNloU27w8w0YURKH/gGfVggc/LJp72cG9CCkKwVOzeTu+x2e0oxqklU3t4qaIXDfviD5/RttpwoNfSEzaTyRWG588wxMUw5Xd70XuZtm8ebvsZ7P3Bjj32/oT3DqKpmMUTZv3X0mvzwgJyzDdDxNPI1IASDJvxoPr8BlhoQ3R/XDwDHGAl9JmBODXz2j3DXDwg7vh7bf+bnew1x32h7stDOBbynbIsm6SdOfz+UNgD3UetzyqPF5DtZodvmLHWmVrnh/0Oqh7OZ2I/vYq+3+ioj7yOiwk+E6kh4XXWKoXYlPLLlTC54+MncoPrZQz7F+rZvMGmPQJ4aDXcjxVInbAYx+vko3wQRghDrqEyV6S9BqYxMYk6WZZd6kRf3YJ8Y3GLIuSJFrquXI6tjFjSRKy1ea17UnCsizb0GzbW829LFvdRZRlDjZSvr5GJnE622Y+cR1+K1apOaK98LVshJYGJVNam55z6/lo6bKZCuk+OKJiSx00TMqUa7jEd6kRStreD89jnsVqzZ7esc6SAF6xZl+9ddr7Y0f+uIX2BNhy87iVneEkBywuTaEypmEClyznRQFa0mQXPBUJp6dclxrgkmc5PgF6fz49TX73rz0yQOAbv2B4EiwRE4F2o96fTw66//1hTY8yz0HH3ABLAVcyIYMijtjJFNK8Nl3NZrNotmPiqVKptVt9NBrG9t8zNfp4RuDmETf543U7taTRePAj6Sy/9w0ULYxxw/zINU9+ojHioUGfblv33rnmunU9PqMbZwkk/GitJ/j55DTIOCkkSMpQ/62KKejT4EM1xj7yIblh7IdbMOtUJJDyEaSrn27NaFVzyueqdPztjVrtrTqKbuANP2RCVnYL2k4/bHzkl0sf7bfFGv62CGlyp79yPHv6E2CpMN5y00Znc7QzbZGBUgKQzXMEzA9Ac7KXHvflggqw27GBlUTu7G5YAvsx6liZFf1qN6zQOpgmYnCOTEiRlVllHx1Xs3qUZU73aOILR6KV3q/QPN2VFfjlDSugMXLzAqdyQHYMb/+4RjN1PT4jWbEE0vVs/ClSpHVPP9AFezMD+m01GXDNtYxd7YVcMZ/ZzH0Re4vXG9pk7SC0ssUx5AVa5O7LmhXIt76hyGbVtMNtprxmr8+I+taA9StToOv30LfPJxFpc/dfEKG2wL41sVqjZMYn17zc6fNnRJ4OnhUjxICMkfa+uMYgR9+v386g39rOXns7T/qf8LpqLXv/x1W/aqxfVa8l+hxWFsJ3eZnyFVGfQCwynpIXk6Ae3p3/1jCYWw6p9qXK8rJosglZA0gU+Hvde9ysB/F3IeuGrBOyXsi+CtnjiP0A5KOLK3+eu+aFtl47IVmiSnSnxKVO52ykcTshg2gSsaurn0ouC1HMFwvWYVdXGBWwWETIN+dSzaxL7+RCGFEwdMnXz6BExWaNC1/Fpofvpd4bmHV9EELPgfaYfaWWmPjaR6dDwV1fmZuG/apPL7uZBsXgKm8q3cw+P8n1LEye8jnjY6RG656kYdaLHeHJ7LMh+/0LNhhG/X7I+vZv9pXHy/Cx9VUdaRiLNG1EFDDf5IkBPbSQQua82C6WADVX8msJWShEuI/a6HRGMFbo08KQBvSMTnkdc2BVRyulm2ERLMagE6XZlBv7pKY3PO4WYzaKKWTOu/ZGFWBd6yZX0oC9VfI1QNeu8U5nyTXnu9XuOSH9xlGuDR7OjjT8ut8UdIMney25vdeWdP1Nku4aMxLKM4sLb3uH+lNDzpAk9O2rQmZZyvhJEdlW7nmStrSuyjRhqTiHJkkKafyt7aBcdt+/nCpl6h7Og+642uy3PfNKo3P+cVQ5Ku9rAB883WldO88ewKq3ZOduH0Z/tzfY611r6F4yz979dmDsNidHFuRbnRz1rI9ua5D+VIP0wxD+zkPa4wZPhy01cqd/fwZ4ILNbk3FuMLg9hFntwexbTXa7pWXrN7Mw3Z/6dn+Nt/aSGH46eAAxvOFJfV9KXHk5PxjtsYd6Nq8jwFu8m699LN+bQJvA/upEuvcwb+xBv6Wrfd1S1b4eNolyb+9WRNlcdImyTgPxX9+8/WHW/+O3E3VwcHDw5t376ev3k4ODgwx/R1G01ryy7rRpGdRhXWyxu5fpjt+wShRFiEIM0t6n4b1cTv7Njg83j4lOZRAGKsfob6HkYRLsB6S7g1flg5Ae3mCKb1QyD/avAhc9iH+62Dwc2vtoMOT8KjDxFDKOf3l9HYPUMUg8CCkADrQJwoDCSTBiHY802A/U6CPEuFquEZxCgME5aNz+le9lo6yD0OlcwX5gtxiEgXP4VU1VfHqejIOFX/C6qaqWeipDf1TvGpwHA5M/cRp87OAUrSD9T5rpVWMG2lsGxwqtBykU8IrPTWNe+/oNlnMDcAwye+xGsYTPDQqN0tgLLuZpXKaoF8JlLvS8ipog5bBBHxW81UoVvIO9RX3oNUhcaz4PwkAUkDXbNxCBVnc/uRgUYoZC1+469qOCEcAfXAPaMejgeXZnKD4qYCOgQ8+nSt55/GC4MxgOdgZDnMHFH911Dm+TwSk+qtHZJzFCAhc43r20P/0o7dfVtdu0eYABvpB4vatbR6qHjKJFo5vYxPcnzPMJ3MwPx5syGBqB02ZKjy2e58B1RIkEn5zT0max6oKPbmCoRRhc3ryZSxarrk+PYF+lMC5sOAOLlZagHzdjpD6bzQ13dxdhML95e/MvcntP8fBmN+/uR8orqXNu/hGw7jxbhMH0Zli/qzJf/oHA7j5Z1Bf8kv5yNlLJ/MzLrcVNHf1dhf3GKk1Ao060Kq9qUYMSBjO8zpavmpFSKXC5RtC0Uh5cLh7q32hrdjaZ2RTI6F+p5TR7rfM7y7SFFtMoYCkySxhUl3UJp0HEDseNFwRp9MtZF74vZUBIxR7RememJDH+qOd+I44eNbPR0DJbB0d6EKgzKyDLU0rPmqExd0SRBknEqv9I+awwiQD4G9svfPNV8dJGhNGCblA7t4k59TViL7ms8lvaeSTs6qoiA6KOxYJdXeGpgj7De3+xCOsGXKvVQFe7bdEQg7hojaqaoB5YtTWGWi3rLCGPCza4+74JgJhIISdnpXbzoDK6WEQtglwCnGzwDgeQVHQmJnLNriuViU761thfQbajAJzk/w3en+cvvhNrQHney188z1/8iJmMOVjes+gZC5lYzp9BmkbsuSm0kpMXSyh43nPt649Sw4WAGTEunWo9yzJuq4kiB9OfUFDXhycMi3UZC55SKKRWMXhXD7nR8BFvCsgNusBEQSNtshk9CfhEAzmWCBZeFpS5Sa9Dv+BzzqYaxr9/tITTRy/eIejoUXze4y9c70NrlpjyC2BczhltnGwoSls73LjUJCbjlGsxdk/RkOUpYNgmvlR5bJ13FqMejuMpl+cmfD7SL46BZ+xtDhIh+OVvf8ceXqYfyrc6AX0LoX44tm5CxR6hHHsU2hBSInehTeFEtZWEjkIsXBtYx6UQoYvxdSX6TTky2Ev6+WrRWmgxmQC65lwPGuwS8oDHU3tpEFS1pzFH4lGl8eAhgfkHYeK8xu6g2lafBnbIK9jce7ROqkvM4Ht7fHQLXJJJqmsZxdpj7C7tHOzt8REmAVfHHbH3psKERy1vdWFoCWAXgvtEwUqzn9uwO7B+FScXm67MyKXfdtkqQIkwayEK7aWOEq5KsV+ZuM4qxyNSZYGuUeFyH4nLWngkKCpEHqvyNlR5AyY5m5SU5VAg+/pbkwKd6yReIU2hSxtyyJJS+7xlRxZWTBhT48ljBTs15g8ZSGOHczbmpgAdslIKxLwu0UpZTQmXOWiBMQxrUaDBog5Fx81XVDsj9v0P37taAn4PnilHyIF2YkhYmRPVECdUmdr+5Ja3vlYfdOL7ZgBRd6PIDGdqzUEbJVHEKT3h0klQ+x5Fe+oIpjy1XZ2oQJccwoMcHq19+//yt7834NpoFFkFzK7AkwTD8G+AkEzTluAx0lRDjhJQtSHC+UD/YfkJgNAR05xlKqkYydyexo8ocN9UctGFGlShDqaMp3htVfLWhF7GGmdUMGSFJlM1xSrkuF+4FKZo5Br7jKBV+fADIB7jBgz0CEWuRpqX8yaD1yEYamk6eh6Idp569Qha4QVeFupMQybk7e6pptW/UJUgKAuV8ULEzE9lonb1Aeta9nyd1aEnSI0XQunHG1gVpztTMoYzIc/gAvQtnveNKBm0SY6gmAHIJmweSfY6qzPEZ1gEpIWTxu1EdRCaUKJxMgM9gbMYLVREdXALJHY6OFWnw7oWECdTTamdf8ZV7iDhgXKknh3BcbpwlVxWX7jNgikR+07NEGGVOoNKp50f8ckI8iS0UzRWiLnEJHt6JuJLDSeufPgZp/gvt4QNo6HDot04hSu2jhucBStN4DrhdXvy8rPKmuNYLcKvbtnBbg7N+YynivjJqZXucwuoQyoUMKX7h84P/Ux2HV+9Q80k6F/++r+GooVsyJupnrprv9JrladG2SoEzVk9OXuCj9pvU0/PLjBpnZ2zTSK+9odP3PLSwyoeVMMmG2GwK0VXkTpF14x/068YTn81y+t1ZlQX9LM1on5BVsZBv//PbETd6X85RtTd/hdkRH2GwDr3983SZJNqu1Z2eB/39QM+KrBerlTp63uiT5nsszYIYx2Ca3YYLux/td3XC/EbbMHWWFw7sd1L1m+G0DDs9/F/7eN81YqCxXdNGeM7YVym6fxfgvD2HvTrz8A2r7dPXyfVpx/F8OfL+GJ4FDjvbPshdceL5ZNcrDhm2cG64Tl37VYcQ5Q6xTpuuJdupUjQtI0zFjIVEs78AZ4lKj7zu1+QKmhM+5a7FQzVcZOBpX3WNywfWMLcXUdF71QGVgOa4bwzNNxVqmCh54xPUJdDHtcPSFSg9U3sdzfIrkPBbr9/NqiQsLeKhENJabBUtPBYnYP8bXfaXL6wyyOol1lay8BA2E70PWhtttluN2kgLrUo5sH+yVVw2eW56Nrv+ycfFh+QBIupwiCcXBmCmBfTYD/orcTkGNAXFFNxcmX5pmIFw2WCkYQr9wPPRe9iEA2CRbg8Zu19ck1/KLt3HWIKPhFyctO4DzWO3uE52qNqYaqWU7n4I6CgcgfR7BUGAulnChzfxYh6JI8f6kim1/6QfYzRurCh+jCXA4F8HFArtGf5Xl8TrLM+Vmew14iSOfEBLxTDUoWwrItKqbbu40yqMJNG5EgjcKSOBWmFglB0RyO446TmiSqOwr8ABqQ6D3d3Scd8OiBlbOcZ6Tm7TxZExbXjNAjazlHK21p28d3PY9V2WG29MP9EXpglJ4wjntqTYMN1WyZx19Q2EXsqrEyyLbvosll0o4lyg4XSLblkiasAWWcA21trd3JDGjaGNRzp1eo2P2KoK/LjTp/4cbdP/Pis39Lo3d7rGWq9nJTvSvcmBbupX6MS/QGFqJBjRRLYCQ5/YnRDkgRfeYdBGqusqt3Y6TQOuRrV6VSS1RIq2oDelprlagZ6XNpikOMULgVa+XAYZPStDpwAnqVgTIq5LwVMyPJESXboTnEG+5jnfCRSgSqATXWzLFNrESZiP9ahF4+0zT68gBQ1h8pOiuWQvdY3U/p8jCEcIeNshFmZaCkHOeUytkZ5e52RcRntPujwyLUwWK5WI9TCwqZkoZFPMi75hDg4bHIESyBFgWaYViP0WRmVlpYPCy5SpW3UJm2I4sMJia8vc/xEj0m8BjRMkaovnGvGhNY1Zm8qVyB5hF7IHGERaDQrFCtlqrCWMXozyxQTEwvrYcQ3axNGHF5oLg0qzC5Q1J1BhTDnNQHjzI/vDeAJfy/kua2n2WUnFV39CCMjCmhX21nmzMftMd+K4rtyhNV6lRGF0vN69EQU03JEOkdzkuqHnelbXw67oVHcPtH1HRRIIaZ3cHRIOutj9stf/4d9D1xLNlUzS61xqSGd15W3qTI1nbxFW6Vykl8OxThiPLbE524fj8Efp7wgW+cbmKFR2bKUjS8/KkepiNmxj8XpdPZ9SfA6PqdVHcQmeKKzlLPcjk6FPI/YgZyTe6e+i7CdxrW2Qfdfo4o4x4BiJV0igF0zqiEih4KB9AJMw3YNibAuaK3KiV2tCYzbXDvfFfd2kCQr6aPovKjBsRZX8v1ya3rFgt9rMk5b6aTtwBWQCSXnmn2WaD4u6vnDpSRYuglXmnz+rEdH6KapjsRyottx1Wqt0kvacFvekrUbF2wXdue5cOR04smStctY3Z2srbWGLveGHQDV8rXuPSywbd6O34G+ELF/vG/g6B517gVhkIoYnOnI3V8H3x59zy52on4QNt4Yt2Du3veHL1+/efcagUFBahE2iPpRnyzcyhQZl42VlkrnL99tjVSIbaX9baX9baX9baX9baX9baX9baX9baX9baX936q01bbS/rbS/rbS/gZMbCvtbyvt37eKyrbS/j99YaNtpf1tpf1tpf1tpf1tpf1tpf1tpf1tpf1tpf0vooD5ttL+b0GB20r720r720r720r720r720r720r720r720r720r720r720r720r720r720r720r720r720r7t66030ji6uUpF7KR925zfU+W6+9/CIMpJgPvnwRXV7jMe0zVw+afSkomO/kQBhdcCwzcozzi0Ke9YtrYOWBW5Esbh9g9xvVDy9sUqr+UPo15u3bEARH0tX2b+cpHb98dB2Hgq4ZmKqFCDXyGaWZ8ZnPwGrlo1HYVpFxOSspjC+ycC1vTatpO8z2nNF/3RyMZDpNaawjb+b92G/gvbmrtgKsrm0JMWaS2v/20cYRDrO+N5/dhsVj8H9OOuhw=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Document","permalink":"/docs/API-docs/v1.1/draftdocument"},"next":{"title":"Create Document from Template","permalink":"/docs/API-docs/v1.1/createdocumentwithtemplateid"}}');var s=t(74848),i=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 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:"eJztPNlyHDeSv4Kt2AhZPdXVB0lJ5moUQ0tamzteiWFR65glNRx0VXY3xCqgDFSx2WZ0xDzMH+zTvs6n+Us2MgHU0QcPkfZIs+0HmY3CkUhkJhJ5XQUFn5hg/yR4peIyA1mY4EMYJGBiLfJCKBnsB8dTYC818AKY78UOjg4ZT1M1M6w0oA0rFJuABI29JMxY4udjoznLtboQiZATlvCCs5kopmzEDTzZZSBjlUDCxiKF6FSeymOR77P3eap4wuaq1Ozo1b9Xs+Ey2HbS6byCUTlh7w87nQ9fTYsiN/u9Hs/zSOUgjZjIlI9MFKusl2DHPBk/DtlsChpwVhZzyYAbkc4ZTxI2E8kEChOyYgqSxSqfs1gpnQjJCzAhy/kEmCyzEWgTMi4TlikNTEjGmQaezLuF6pYG2H+8e/uGjZXOeBGxo7Q0YbVcIjTERTq30xdTqHb1yHhsmEILOQlZxs8RW6JgP5UiPsdtG5AJ/h8HHhwdEq46nXdlnitdQMJ+tFvY73TwyzeQqhnjGqh/rLJMSZZzzTMo6LimvKDPGn4qhYbEHgpPU4+L/VPZZZ2O5BnsdzrsvRQ/lcBEArIQYwEad8mKqTBuQGT7F/Oc+h/KRMSIPAIAW5kat7siUrHruxxinNJ2baCaKclmUxFPCYczbs8/T3lst6XB5BAX4gLaE1+GbI4TvwKpPARTpcXPShY8peO7AF2ImKfNY0YAsaspuC4Q/bkSsvCtbgX2J3eceNp0iI4OEbQEkZsJSV8MsAuelmAcVLOQTRGqHyDXYIg13LyIeJmwKYjJdON6PPlYmqI1MSsNgtmEwq3lT5XQC4S2MU8NMDFu4TLj59BYjSnieZ5G7Js5S2DMy7QImUAKLXQJEXujCsbzPBUxH6VANIDMxotSQ5dO2ZFP1CafI5IAYBhniRiPQSMz40eawo3x0CFd1iKDOK2YcsmUXDroWKVKr5IQNbfxyGIlC5BFxA4uuEgJeLtZw4SM0zIBNkp5fB6yUVpCyDQkltHngGIudEILuzBuHM4JP8xAilSoJMIvlVteGGYcVEnEjpFRKv7Djx7VtIgwTaw6Lh8rXBlR4FmSQcZFGhLiQvZRjVghihRCZPCcy3mI8hVCVsBlMVKXIYunEJ/TX5onQrFRWRRK2o0lWuWJmkmHy7GShRE/r+FI/+XuGB2GbDdkT0L2LGSDfsgGw5ANdkM2eBKywbOQDfshGw5DNtwN2fCJBWv4zOGaVwhuAjAYWiwXXw52UU5/LwxxNgpYU8nsWUtmDyLW6VTchG1/+ctfTuXVqWTsNEDmOg322WlQdTkNQvsNZSZ+G7jfl/hjZ/jU/ZzjzyfDZ+7njLoOdt3PKf4cDk7lwi14KocEScGz/Boo8PODQuB+OSLCNloU27w8w0YURKH/gGfVggc/LJp72cG9CCkKwVOzeTu+x2e0oxqklU3t4qaIXDfviD5/RttpwoNfSEzaTyRWG588wxMUw5Xd70XuZtm8ebvsZ7P3Bjj32/oT3DqKpmMUTZv3X0mvzwgJyzDdDxNPI1IASDJvxoPr8BlhoQ3R/XDwDHGAl9JmBODXz2j3DXDwg7vh7bf+bnew1x32h7stDOBbynbIsm6SdOfz+UNgD3UetzyqPF5DtZodvmLHWmVrnh/0Oqh7OZ2I/vYq+3+ioj7yOiwk+E6kh4XXWKoXYlPLLlTC54+MncoPrZQz7F+rZvMGmPQJ4aDXcjxVInbAYx+vko3wQRghDrqEyV6S9BqYxMYk6WZZd6kRf3YJ8Y3GLIuSJFrquXI6tjFjSRKy1ea17UnCsizb0GzbW829LFvdRZRlDjZSvr5GJnE622Y+cR1+K1apOaK98LVshJYGJVNam55z6/lo6bKZCuk+OKJiSx00TMqUa7jEd6kRStreD89jnsVqzZ7esc6SAF6xZl+9ddr7Y0f+uIX2BNhy87iVneEkBywuTaEypmEClyznRQFa0mQXPBUJp6dclxrgkmc5PgF6fz49TX73rz0yQOAbv2B4EiwRE4F2o96fTw66//1hTY8yz0HH3ABLAVcyIYMijtjJFNK8Nl3NZrNotmPiqVKptVt9NBrG9t8zNfp4RuDmETf543U7taTRePAj6Sy/9w0ULYxxw/zINU9+ojHioUGfblv33rnmunU9PqMbZwkk/GitJ/j55DTIOCkkSMpQ/62KKejT4EM1xj7yIblh7IdbMOtUJJDyEaSrn27NaFVzyueqdPztjVrtrTqKbuANP2RCVnYL2k4/bHzkl0sf7bfFGv62CGlyp79yPHv6E2CpMN5y00Znc7QzbZGBUgKQzXMEzA9Ac7KXHvflggqw27GBlUTu7G5YAvsx6liZFf1qN6zQOpgmYnCOTEiRlVllHx1Xs3qUZU73aOILR6KV3q/QPN2VFfjlDSugMXLzAqdyQHYMb/+4RjN1PT4jWbEE0vVs/ClSpHVPP9AFezMD+m01GXDNtYxd7YVcMZ/ZzH0Re4vXG9pk7SC0ssUx5AVa5O7LmhXIt76hyGbVtMNtprxmr8+I+taA9StToOv30LfPJxFpc/dfEKG2wL41sVqjZMYn17zc6fNnRJ4OnhUjxICMkfa+uMYgR9+v386g39rOXns7T/qf8LpqLXv/x1W/aqxfVa8l+hxWFsJ3eZnyFVGfQCwynpIXk6Ae3p3/1jCYWw6p9qXK8rJosglZA0gU+Hvde9ysB/F3IeuGrBOyXsi+CtnjiP0A5KOLK3+eu+aFtl47IVmiSnSnxKVO52ykcTshg2gSsaurn0ouC1HMFwvWYVdXGBWwWETIN+dSzaxL7+RCGFEwdMnXz6BExWaNC1/Fpofvpd4bmHV9EELPgfaYfaWWmPjaR6dDwV1fmZuG/apPL7uZBsXgKm8q3cw+P8n1LEye8jnjY6RG656kYdaLHeHJ7LMh+/0LNhhG/X7I+vZv9pXHy/Cx9VUdaRiLNG1EFDDf5IkBPbSQQua82C6WADVX8msJWShEuI/a6HRGMFbo08KQBvSMTnkdc2BVRyulm2ERLMagE6XZlBv7pKY3PO4WYzaKKWTOu/ZGFWBd6yZX0oC9VfI1QNeu8U5nyTXnu9XuOSH9xlGuDR7OjjT8ut8UdIMney25vdeWdP1Nku4aMxLKM4sLb3uH+lNDzpAk9O2rQmZZyvhJEdlW7nmStrSuyjRhqTiHJkkKafyt7aBcdt+/nCpl6h7Og+642uy3PfNKo3P+cVQ5Ku9rAB883WldO88ewKq3ZOduH0Z/tzfY611r6F4yz979dmDsNidHFuRbnRz1rI9ua5D+VIP0wxD+zkPa4wZPhy01cqd/fwZ4ILNbk3FuMLg9hFntwexbTXa7pWXrN7Mw3Z/6dn+Nt/aSGH46eAAxvOFJfV9KXHk5PxjtsYd6Nq8jwFu8m699LN+bQJvA/upEuvcwb+xBv6Wrfd1S1b4eNolyb+9WRNlcdImyTgPxX9+8/WHW/+O3E3VwcHDw5t376ev3k4ODgwx/R1G01ryy7rRpGdRhXWyxu5fpjt+wShRFiEIM0t6n4b1cTv7Njg83j4lOZRAGKsfob6HkYRLsB6S7g1flg5Ae3mCKb1QyD/avAhc9iH+62Dwc2vtoMOT8KjDxFDKOf3l9HYPUMUg8CCkADrQJwoDCSTBiHY802A/U6CPEuFquEZxCgME5aNz+le9lo6yD0OlcwX5gtxiEgXP4VU1VfHqejIOFX/C6qaqWeipDf1TvGpwHA5M/cRp87OAUrSD9T5rpVWMG2lsGxwqtBykU8IrPTWNe+/oNlnMDcAwye+xGsYTPDQqN0tgLLuZpXKaoF8JlLvS8ipog5bBBHxW81UoVvIO9RX3oNUhcaz4PwkAUkDXbNxCBVnc/uRgUYoZC1+469qOCEcAfXAPaMejgeXZnKD4qYCOgQ8+nSt55/GC4MxgOdgZDnMHFH911Dm+TwSk+qtHZJzFCAhc43r20P/0o7dfVtdu0eYABvpB4vatbR6qHjKJFo5vYxPcnzPMJ3MwPx5syGBqB02ZKjy2e58B1RIkEn5zT0max6oKPbmCoRRhc3ryZSxarrk+PYF+lMC5sOAOLlZagHzdjpD6bzQ13dxdhML95e/MvcntP8fBmN+/uR8orqXNu/hGw7jxbhMH0Zli/qzJf/oHA7j5Z1Bf8kv5yNlLJ/MzLrcVNHf1dhf3GKk1Ao060Kq9qUYMSBjO8zpavmpFSKXC5RtC0Uh5cLh7q32hrdjaZ2RTI6F+p5TR7rfM7y7SFFtMoYCkySxhUl3UJp0HEDseNFwRp9MtZF74vZUBIxR7RememJDH+qOd+I44eNbPR0DJbB0d6EKgzKyDLU0rPmqExd0SRBknEqv9I+awwiQD4G9svfPNV8dJGhNGCblA7t4k59TViL7ms8lvaeSTs6qoiA6KOxYJdXeGpgj7De3+xCOsGXKvVQFe7bdEQg7hojaqaoB5YtTWGWi3rLCGPCza4+74JgJhIISdnpXbzoDK6WEQtglwCnGzwDgeQVHQmJnLNriuViU761thfQbajAJzk/w3en+cvvhNrQHney188z1/8iJmMOVjes+gZC5lYzp9BmkbsuSm0kpMXSyh43nPt649Sw4WAGTEunWo9yzJuq4kiB9OfUFDXhycMi3UZC55SKKRWMXhXD7nR8BFvCsgNusBEQSNtshk9CfhEAzmWCBZeFpS5Sa9Dv+BzzqYaxr9/tITTRy/eIejoUXze4y9c70NrlpjyC2BczhltnGwoSls73LjUJCbjlGsxdk/RkOUpYNgmvlR5bJ13FqMejuMpl+cmfD7SL46BZ+xtDhIh+OVvf8ceXqYfyrc6AX0LoX44tm5CxR6hHHsU2hBSInehTeFEtZWEjkIsXBtYx6UQoYvxdSX6TTky2Ev6+WrRWmgxmQC65lwPGuwS8oDHU3tpEFS1pzFH4lGl8eAhgfkHYeK8xu6g2lafBnbIK9jce7ROqkvM4Ht7fHQLXJJJqmsZxdpj7C7tHOzt8REmAVfHHbH3psKERy1vdWFoCWAXgvtEwUqzn9uwO7B+FScXm67MyKXfdtkqQIkwayEK7aWOEq5KsV+ZuM4qxyNSZYGuUeFyH4nLWngkKCpEHqvyNlR5AyY5m5SU5VAg+/pbkwKd6yReIU2hSxtyyJJS+7xlRxZWTBhT48ljBTs15g8ZSGOHczbmpgAdslIKxLwu0UpZTQmXOWiBMQxrUaDBog5Fx81XVDsj9v0P37taAn4PnilHyIF2YkhYmRPVECdUmdr+5Ja3vlYfdOL7ZgBRd6PIDGdqzUEbJVHEKT3h0klQ+x5Fe+oIpjy1XZ2oQJccwoMcHq19+//yt7834NpoFFkFzK7AkwTD8G+AkEzTluAx0lRDjhJQtSHC+UD/YfkJgNAR05xlKqkYydyexo8ocN9UctGFGlShDqaMp3htVfLWhF7GGmdUMGSFJlM1xSrkuF+4FKZo5Br7jKBV+fADIB7jBgz0CEWuRpqX8yaD1yEYamk6eh6Idp569Qha4QVeFupMQybk7e6pptW/UJUgKAuV8ULEzE9lonb1Aeta9nyd1aEnSI0XQunHG1gVpztTMoYzIc/gAvQtnveNKBm0SY6gmAHIJmweSfY6qzPEZ1gEpIWTxu1EdRCaUKJxMgM9gbMYLVREdXALJHY6OFWnw7oWECdTTamdf8ZV7iDhgXKknh3BcbpwlVxWX7jNgikR+07NEGGVOoNKp50f8ckI8iS0UzRWiLnEJHt6JuJLDSeufPgZp/gvt4QNo6HDot04hSu2jhucBStN4DrhdXvy8rPKmuNYLcKvbtnBbg7N+YynivjJqZXucwuoQyoUMKX7h84P/Ux2HV+9Q80k6F/++r+GooVsyJupnrprv9JrladG2SoEzVk9OXuCj9pvU0/PLjBpnZ2zTSK+9odP3PLSwyoeVMMmG2GwK0VXkTpF14x/068YTn81y+t1ZlQX9LM1on5BVsZBv//PbETd6X85RtTd/hdkRH2GwDr3983SZJNqu1Z2eB/39QM+KrBerlTp63uiT5nsszYIYx2Ca3YYLux/td3XC/EbbMHWWFw7sd1L1m+G0DDs9/F/7eN81YqCxXdNGeM7YVym6fxfgvD2HvTrz8A2r7dPXyfVpx/F8OfL+GJ4FDjvbPshdceL5ZNcrDhm2cG64Tl37VYcQ5Q6xTpuuJdupUjQtI0zFjIVEs78AZ4lKj7zu1+QKmhM+5a7FQzVcZOBpX3WNywfWMLcXUdF71QGVgOa4bwzNNxVqmCh54xPUJdDHtcPSFSg9U3sdzfIrkPBbr9/NqiQsLeKhENJabBUtPBYnYP8bXfaXL6wyyOol1lay8BA2E70PWhtttluN2kgLrUo5sH+yVVw2eW56Nrv+ycfFh+QBIupwiCcXBmCmBfTYD/orcTkGNAXFFNxcmX5pmIFw2WCkYQr9wPPRe9iEA2CRbg8Zu19ck1/KLt3HWIKPhFyctO4DzWO3uE52qNqYaqWU7n4I6CgcgfR7BUGAulnChzfxYh6JI8f6kim1/6QfYzRurCh+jCXA4F8HFArtGf5Xl8TrLM+Vmew14iSOfEBLxTDUoWwrItKqbbu40yqMJNG5EgjcKSOBWmFglB0RyO446TmiSqOwr8ABqQ6D3d3Scd8OiBlbOcZ6Tm7TxZExbXjNAjazlHK21p28d3PY9V2WG29MP9EXpglJ4wjntqTYMN1WyZx19Q2EXsqrEyyLbvosll0o4lyg4XSLblkiasAWWcA21trd3JDGjaGNRzp1eo2P2KoK/LjTp/4cbdP/Pis39Lo3d7rGWq9nJTvSvcmBbupX6MS/QGFqJBjRRLYCQ5/YnRDkgRfeYdBGqusqt3Y6TQOuRrV6VSS1RIq2oDelprlagZ6XNpikOMULgVa+XAYZPStDpwAnqVgTIq5LwVMyPJESXboTnEG+5jnfCRSgSqATXWzLFNrESZiP9ahF4+0zT68gBQ1h8pOiuWQvdY3U/p8jCEcIeNshFmZaCkHOeUytkZ5e52RcRntPujwyLUwWK5WI9TCwqZkoZFPMi75hDg4bHIESyBFgWaYViP0WRmVlpYPCy5SpW3UJm2I4sMJia8vc/xEj0m8BjRMkaovnGvGhNY1Zm8qVyB5hF7IHGERaDQrFCtlqrCWMXozyxQTEwvrYcQ3axNGHF5oLg0qzC5Q1J1BhTDnNQHjzI/vDeAJfy/kua2n2WUnFV39CCMjCmhX21nmzMftMd+K4rtyhNV6lRGF0vN69EQU03JEOkdzkuqHnelbXw67oVHcPtH1HRRIIaZ3cHRIOutj9stf/4d9D1xLNlUzS61xqSGd15W3qTI1nbxFW6Vykl8OxThiPLbE524fj8Efp7wgW+cbmKFR2bKUjS8/KkepiNmxj8XpdPZ9SfA6PqdVHcQmeKKzlLPcjk6FPI/YgZyTe6e+i7CdxrW2Qfdfo4o4x4BiJV0igF0zqiEih4KB9AJMw3YNibAuaK3KiV2tCYzbXDvfFfd2kCQr6aPovKjBsRZX8v1ya3rFgt9rMk5b6aTtwBWQCSXnmn2WaD4u6vnDpSRYuglXmnz+rEdH6KapjsRyottx1Wqt0kvacFvekrUbF2wXdue5cOR04smStctY3Z2srbWGLveGHQDV8rXuPSywbd6O34G+ELF/vG/g6B517gVhkIoYnOnI3V8H3x59zy52on4QNt4Yt2Du3veHL1+/efcagUFBahE2iPpRnyzcyhQZl42VlkrnL99tjVSIbaX9baX9baX9baX9baX9baX9baX9baX9baX936q01bbS/rbS/rbS/gZMbCvtbyvt37eKyrbS/j99YaNtpf1tpf1tpf1tpf1tpf1tpf1tpf1tpf1tpf0vooD5ttL+b0GB20r720r720r720r720r720r720r720r720r720r720r720r720r720r720r720r720r720r7t66030ji6uUpF7KR925zfU+W6+9/CIMpJgPvnwRXV7jMe0zVw+afSkomO/kQBhdcCwzcozzi0Ke9YtrYOWBW5Esbh9g9xvVDy9sUqr+UPo15u3bEARH0tX2b+cpHb98dB2Hgq4ZmKqFCDXyGaWZ8ZnPwGrlo1HYVpFxOSspjC+ycC1vTatpO8z2nNF/3RyMZDpNaawjb+b92G/gvbmrtgKsrm0JMWaS2v/20cYRDrO+N5/dhsVj8H9OOuhw=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-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,i.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:"name:"})," Unique identifier for this widget."]}),"\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:'"mm/dd/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",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\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:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (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 "layout": "vertical",\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 "layout": "vertical"\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.jsxs)(n.ol,{start:"14",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": "",\n "decimalplaces": 2,\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:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the number (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",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,s.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Note:"})," Responses for prefill widgets are ",(0,s.jsx)(n.strong,{children:"required"}),"."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{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": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\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:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",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": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "name": "date",\n "response": "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:"response:"})," Enter the date you would like to display inside the date box."]}),"\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:'"mm/dd/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",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",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": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\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 checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\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:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",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": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\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:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\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 radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",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": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\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"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},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}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},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}}, {{note}}.",example:"

Hi {{receiver_name}},

We hope this email finds you well. {{sender_name}} has requested you to review and sign {{document_title}}.

Your signature is crucial to proceed with the next steps as it signifies your agreement and authorization.

Sign here

If you have any questions or need further clarification, please contact the sender.

Thanks,
Team OpenSign\u2122

"},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},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},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:100},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:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},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,i.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/851f8f65.1639171f.js b/assets/js/851f8f65.1639171f.js deleted file mode 100644 index 9225af4c8..000000000 --- a/assets/js/851f8f65.1639171f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9070],{72700:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>f,default:()=>j,frontMatter:()=>m,metadata:()=>r,toc:()=>y});const r=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/draftdocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/draftdocument","permalink":"/docs/API-docs/v1.1/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":"eJztPNlyHDeSv4Kt2AhZPcXqQ9RhrkYxtKS1teOVFBa1jllSw0FXZXdDrALKAIrNNqMj5mH+YJ/2dT7NX7KRCaCOPkhKoj3SbPtBZqNwJBKZiURel5HlUxMdHEfPVFoVIK2J3sVRBibVorRCyeggOpoBe6b5xLLQiR2+fsF4nqu5YZUBbZhVbAoSNLfAJMxZFqZj4wUrtToXmZBTlnHL2VzYGeNszA082GcgU5VBxiYih+REnsgjUR6wt2WueMYWqtLs9bN/r+fDhbDtuNd7BuNqyt6+6PXefTWztjQH/T4vy0SVII2YypyPTZKqop9hxzKb3I3ZfAYacFaWcsmAG5EvGM8yNhfZFKyJmZ2BZKkqFyxVSmdCcgsmZiWfApNVMQZtYsZlxgqlgQnJONPAs8WeVXuVAfYfb169ZBOlC24T9jqvTFwvlwkNqc0Xbno7g3pXd0zAhrFayGnMCn6G+BKW/VSJ9Ay3bUBm+H8cePj6BeGq13tTlaXSFjL2o9vCQa+HX76BXM0Z10D9U1UUSrKSa16ApQObcUufNfxUCQ2ZP5Y8D7g4OJF7rNeTvICDXo+9leKnCpjIQFoxEaBxl8zOhPEDEtffLkrq/0JmIkXkEQDYytSk2xWRil3flJDilK5rC9VMSTafiXRGOJxzd/5lzlO3LQ2mhNSKc+hOfBGzBU78DKQKEMyUFj8raXlOx3cO2oqU5+1jRgCxq7FcW0R/qYS0odWvwP7kjxNPmw7R0yGCliFyCyHpiwF2zvMKjIdqHrMZQvUDlBoMMYefFxEvMzYDMZ1tXY9n7ytjOxOzyiCYbSj8WuFUCb1AaJvw3AATkw4uC34GrdWYIqbnecK+WbAMJrzKbcwEUqjVFSTspbKMl2UuUj7OgWgAmY3bSsMenbInn6RLPq9JBoBhnGViMgGNzIwfaQo/JkCHdNkIDeI0O+OSKbly0KnKlV4nIWru4pGlSlqQNmGH51zkBLzbrGFCpnmVARvnPD2L2TivIGYaMsfoC0BBFzv+oC6MG49zwg8zkCMVKonwS+WXF4YZD1WWsCNklJr/8GNANS0iTBurnssnCldGFASWZFBwkceEuJi9V2Nmhc0hRgYvuVzEKGEhZhYu7FhdxCydQXpGf2meCcXGlbVKuo1lWpWZmkuPy4mS1oifN3Bk+PLhGB3FbD9mD2L2KGbDQcyGo5gN92M2fBCz4aOYjQYxG41iNtqP2eiBA2v0KA5XREBwG4DhyGHZfjnYRTn9vTDE2ShgTS2z5x2ZPUxYr1dzE7b95S9/OZGXJ5KxkwiZ6yQ6YCdR3eUkit03lJn4beh/X+CPe6OH/ucCfz4YPfI/59R1uO9/zvDnaHgil37BEzkiSCwvyiugwM+3CoH/5YkI22hRbAvyDBtREMXhA55VBx78sGzv5R7uRUhhBc/N9u2EHp/RjhqQ1ja1j5sict2+I/r8GW2nDQ9+ITHpPpFYbX0KDE9QjNZ2fz/xN8v2zbtlP5u9t8D5tK0/wK2jaDpC0bR9/7X0+oyQsArTp2HiYUIKAEnm7XjwHT4jLHQh+jQcPEIc4KW0HQH49TPafQsc/OBvePdtsL83vL83Goz2OxjAt5TrUBR7Wba3WCxuA3uo8/jlUeUJGqrT7PAdO9Gq2PD8oNdB08vrRPR3UNn/ExX1cdBhIcN3Ij0sgsZSvxDbWrZVGV/cMW6qMLRWzrB/o5otWmDSJ4SDXsvpTInUA499gko2xgdhgjjYI0z2s6zfwiQ2ZtleUeytNOLPPUJ8q7EokixLVnqunY5rLFiWxWy9eWN7lrGiKLY0u/ZOc78o1neRFIWHjZSvr5FJvM62nU98h9+KVRqO6C58JRuhpUHJnNam59xmPlq5bGZC+g+eqNhKBw3TKucaLvBdaoSSrvft81hgsUazp3estyRAUKzZV6+89n7Xkz9uoTsBtlw/bm1nOMkhSytjVcE0TOGCldxa0JImO+e5yDg95faoAS54UeIToP/nk5Psd//aJwMEvvEtw5NgmZgKtBv1/3x8uPff7zb0qMoSdMoNsBxwJRMzsGnCjmeQl43paj6fJ/N7Jp0plTu71XujYeL+PVXj96cEbplwU97dtFNHGq0HP5LO6nvfgO1gjBsWRm548hONEQ8NB3Tb+vfOFdet7/EZ3TgrIOFHZz3Bz8cnUcFJIUFShuZvZWegT6J39Rj3yIfsmrHvbsCsM5FBzseQr3+6MaPVzTlfqMrzdzBqdbfqKbqFN/xQCFnbLWg7g7j1kV+sfHTflhv42yGkzZ3hygnsGU6A5cIEy00Xne3R3rRFBkoJQDbPMbAwAA3KQXp8KhfUgN2MDZwk8md3zRLYj1HH2qwYVrtmhc7BtBGDcxRCiqIqavvopJ41oKzwukcbXzgS7fRhhfbprq3AL65ZAY2R2xc4kUOyYwT7xxWaqe/xGcmKFZCuZuOPkSKde/qWLtjrGTBsq82AG65l7Oou5Jr5zHbuS9grvN7QJusGoZUtTaG0aJH7VNasQb7xDUU2K2eH+4bscNspr22t+4yobwNYvzIF+n63fft8FJG2d/8FEWoH7BsTqzNKFnx6xcudPn9G5OnhWTNCDMkY6e6LKwxy9P3q7QwHne3c727nweAjXledZT/9cTWoG5tX1XOJPoe1hfBdXuV8TdRnkIqC5+TFJKhHH85/GxjML4dU+1QVZWXbbELWABIF4V4PHjfnQfxdzPZi1otZP2Zfxexuwn4A8tGltT/PX/NCO6+dkCxTFbpT0krnCzbWuJ2YQTJN2OXlTxWXVtjFcsl67PIS4wKWywT55kyquXPpHZ8LIyxDl3zzDMpUaja48FVq+vhe6r+E+V4IQ+h70O6yr9QKE1/56PQo+NBX5rZhv+rTy22mRTG4ystaN3PPT3I9C1PmfMH4BKnRuSdpmPNiJ3gyB2zEfv+EDUfJYBCzgfubfRXwMrrrfFWvNUxEnrciClhoCsSAHlrIofBebB9LgJor+bWEtAoRHqI2er0xTBT6tDCkAT2jM97EHDjV0UnpdlgESzVwqzSbceOe1PSGx91izIadQeG9ay+VBedaN6WSBtytUm4AunGN93orrrnQrXHPCRk2jnJteHt2pNHXg7agGz6435Hb97uSbrBN0l1hRkJ55nARbO/QfGrJGZKEoX1dyKxKmTApItvJvUDSjtZVlWcsF2fQJkkhTbi1PZSr7vunM6VM08N70D1Xm4OuZ15pdM7fTWpH5acawIcP73WunUe3YNVbsXN3D2Ow3x/e719p6F4xz3747cDYTU6OLMg3Ojnq2RzdziD9sQbp2yH8e7dpjxs+HHXUyHuDT2eAWzK7tRnnGoPbbZjVbs2+1Wa3G1q2fjML06dT337z1h7f2lt7RQw/HN6CGN7ypP5USlx7Od8a7bHbejZvIsAbvJuvfCx/MoG2gf3VifT+7byxh4OOrvZ1R1X7etQmyvv3b0SU7UVXKOskEv/1zasf5oM/fjtVh4eHhy/fvJ09fzs9PDws8HeSJBvNK5tOm5ZBHdbHFvt7me74LaskSYIoxDDtAxreL+X039z4ePuY5ERGcaRKjP8WSr7IooMow4jxoMlHMb27wdhvVLaIDi4jHzyIf/rQPBzZf28w5PwyMukMCo5/BXUdg9QxRjyKI4ohwTh1PMfoIFLj95DiGqVGGKwAgyOp98Fl6OVCq6PYK1rRQeT2FcWR9/LVTXVQeplNomVY8Kqp6pZmKkN/1I8ZnAejkT9yGnzh4BSd0PyPmulZawbaWwFHCk0GOVh4xhemNa978karGQE4Bjk89aNYxhcGJUVl3K2W8jytclQG4aIUelGHSpBG2KKKGt56pRre4f1lTKGOoNsgca35IoojYaFot28hAq0+/ORSUIgZilf70LHvFYwB/uAb0HhBB8+LD4bivQI2Bjr0cqbkB48fju4NR8N7wxHO4IOOPnSOYIjBKd6r8elHMUIG5zjeP68//ijd1/W1u7R5iFG9kAVla68JT48ZhYgm17FJ6E+Y51O4nh+OtqUttKKlzYxeWLwsgeuEsgc+OpGly2L1rZ5cw1DLOLq4fjMXLFV7ISeCfZXDxLoYBpYqLUHfbQdGfTabG+3vL+Nocf32Fl/k9h7i4c2v392PlEzSJNr8I2C992gZR7PrYf2uTnf5BwK7/2DZXPARGRwh3E+nY5UtToPcWl7XMdxV2G+i8gw0KkLr8qoRNShhMK3rdPWqGSuVA5cbBE0nz8Gn4KHSjQZmb4iZz4As/bUuTrM3ir43RztoMXcCVsKxhEEdWVdwEiXsxaT1bCA1fjXVIvSltAep2B1a79RUJMbv9P1vxNGddgoammObiMgAAnVmFooyp5ysOVpwxxRekCWs/o80zhqTCEC4scPC118VT10YGC3oB3UTmphXWhP2lMs6qaWbPMIuL2syIOpYLtnlJZ4q6FO895fLuGnAtToNdLW7Fg0piPPOqLoJmoF1W2uo07JOM3KzYIO/79sAiKkUcnpaaT8PKqPLZdIhyBXAyfDucQBZTWdiKjfsulaZ6KRvjP01ZHsKwEn+3+D9cfnkO7EBlMf98snj8smPmL5YguM9h56JkJnj/DnkecIeG6uVnD5ZQcHjvm/ffJQazgXMiXHpVJtZVnFbT5R4mP6Egro5PGFYqqtU8JziH7VKIfh3yHeGL3djoTTo9xKWRroMM3oS8KkG8iYRLLyylK5Jb8Kw4GPOZhomv7+zgtM7T94g6OhGfNznT3zvF84WMePnwLhcMNo4GU6Udsa3SaVJTKY512LiH6AxK3PAWE18n/LUeewcRgMcRzMuz0z8eKyfHAEv2KsSJELwy9/+jj2CTH8hX+kM9A2E+ouJ8w0qdgfl2J3YxY0SuQttrBfVThJ6CnFwbWEdnzeEfsXnteg31dhgLxnma0Sr1WI6BfTH+R402GfhAU9n7tIgqBr3YonEoyoTwEMCCw/CzLuK/UF1TT0t7JArsL33ZJNUl5i29+ro9Q1wSXaoPccozgjjdunmYK+OXmPmb33cCXtrakwE1PJOF4aWAHYueMgOrDX7hYu1A+dM8XKx7b9MfM7tHlsHKBNmI0Sxu9RRwtWZ9WsTN6nkeESqsugPFT7hkbisg0eCokbkkapuQpXXYJKzaUWpDRbZN9yaFN3cZO4KaayuXJwhyyodkpU9WTgxYUyDp4AV7NSaP2YgjRvO2YQbCzpmlRSIeV2habKeEi5K0AIDFzaiQINDHYqO66+obhrs2x++9wUEwh4CU46RA93EkLGqJKohTqjTs8PJrW59oz7oxff1AKLuRuEY3r5agjZKoohTesqll6DuPYpG1DHMeO66elGBfjiEBzk82fj2/+Vvf2/BtdUosg6YW4FnGcbeXwMh2aMdwWN4qYYSJaDqQoTzgf7D6hMAoSOmOS1UVjOSuTmNv6ZofVPLRR9fUMc3mCqd4bVVy1sTBxlrvFHBkOmZ7NMUoFDifuFCGNtKMA5pQOvy4QdAPKYtGOgRilyNNC8XbQZv4i7UynT0PBDd5PT6EbTGC7yy6lRDIeTN7qm2qd+qWhBUVhXcipSFqUzSLTng/MmBr4sm3gSp8VwofXcLq+J0p0qmcCrkKZyDvsHzvhUagzbJMdg5gGzDFpDkrrMmLXyOlT86OGndTlT8oEOM92OkuwL0FE5TNFIR4cEN8Njr4Wy9HttzsHixairt/TK+YgfJDxQlzewIkVeH66Sy5s5tF0pJ2HdqjjirNRrUO938iFJGkGexm6K1QsolJtfTSxEfazhx7bsvOMV9+SVc+AydF+3G61ypc9jgLFhhAteJr9pTEKF1thzHKhFhdccRbnNo0Wc8V8RSXrP0nztAvaACATO6gugI0b/k1glVO9Rcgv7lr/9rKErIhbqZ+rW78Ss9WHlulKs+0J41UHSg+aT7PA0k7QOSNpk6uyQSan6EhK0gQJzuQbVrijEGuVJUFWlUdNOEZ/2a7fRXM75eZUn1wT47O+oXZGgcDgb/zHbUe4Mvx466P/iC7KiPEFjv9r5emmzTbjfKjuDbvnrAewXO0ZUrfXVPdCaTidYFX2xCcMMOo6X7rzH9BiHebus4u539i8Y0zmv/lg17ISyMBgP8X/c0n3WCX/FlU6X4UphUeb74lyi+uef86iOooRUbjdRXyfXZezH6+SI9H71GPG55SV05gSfESudYNw2vr736AieNvoVbIXMh4ZRQfJqp9FSDOR0NBqfDyB3M/iY0vlEFOA1gjsico+2qVoWsXjA+RV0GaVzfIlZB6+vI78Mg24CJQEOn+x0k3F9HwgtJ6Z9Uru9InYH8bXfaXt665RHUiyJvZEAkXCf6HnU22253mzSQVlrYRXRwfBld7PFS7LnvB8fvlu9QG7czhcEnpTIEMbez6CDqr8aiGNDnFFVwfOnIt6ZIw2WGAXRr4pGXon8+TIbRMl4ds1GcXtEfqr0PHWIsnwo5vW7cuwZFb/AY3Ul1ENXof6X4I6AC6M+h3SuOBJLPDDi+DBHzSB0/NBE8z8MZhyibTYEzzVmuhsKESJhOcMvqtbYhXGVztMrwfitO5DiEfFAURx3EsSkuo956iLSoAy1asROt0IkmGqITDEHxDa3whuOGJepIgqAAD0lzHO3vk4r1cEi6yL1HdM3vP1gSETeuwyjqugcpXWnVyfVpPpuuy2bnh/gn8kOsuCE88TS2dBel2jEK+6aukTRQYW2U7FgGVw2DW410W2x0fskVW1QNyCYTEJpeNlpe/KjWK3sDUwbFssuSGOSJLHlvQCy5PyCWfDTo6LR++80MjWZK6metfZKK2dYwUY18h3JUyIkiIexlRzg0uiNJiK+9RCBPVVFXLez1Wudcj+r1auHqaBWtIK8qzUo1Bz2pXBnESQ4XAk1dOAwK+tZEDwAvcjAmx6wPC1OyvVB6GfoUvNU65SUfi1ygEuCSvBzXNHqESdiPTfzBHe3y7s4hR92hNhZiKeCg586VPptgHEOMRYExHxHNxSBnXKbOMu1uNLKwouUDrf6lFgYLtWqEWjjYlLQaWaXgkk+JieM2U7AMcpRphmk1RseNUXnlWNFykSvtQhdpQxQZTUh8flHiJ3pO4U2gYYaEfe79EyZ2/iF3WfnSwGN0xZUIi0CzkVWskrnCKr7o0qtyTMmzzs2Gr7Y2jDjcai4Nqs8+WtKfQY0w7zoA4w1wbw3gCX8v5JmrJLnHjmu6+hHGRljo1plZZc673THfCvtdNcY6tcoIq/SiGT0VdlaNSe1oT1L/cDN9G0pBt5SKm6d4vgGLFGL6h69fkNZ6l/3y1/9h3wPXks3U3FFrWmnIF03VaarJTCfv0FYrneScQkmOGE8d8fkLKGDwxxm3ZO17CXM0qzqWcpHVr6txLlJ2FAJSer0D9pSeZq0glU5dDJfaiB5Dzko3OhfyLGGHckE+juY6wnYa19kGXYGtCtoco2qV9CHwbs2kgYis6gbyczAt6y1kwvlhtaqmbrU2MH5z3UxP3Nthlq0lTqIFvwHH2RzJAcqd8RFLXW/ItewkUnajN0BmlJZqDhgp58388Ur6J12Ga00hczSgI/bT1EfiONHvuG51dtkVhbgrb8neiwt2i5rzUnhyOg5kyboFnD6crJ29gu53elH5G5SXYqOPC0tLm1eTN6DPRRqe0Vs4uk+d+1Ec5SIFbzzx99fht6+/Z+f3kkEUt54ZN2Du/vcvnj5/+eY5AoOC1CFsmAySAdl4lbEFl62VulXjV6+2VhLArsb8rsb8rsb8rsb8rsb8rsb8rsb8rsb8rsb8b1bUaVdjfldjfldjfgsmdjXmdzXmP7V+yK7G/D99SZ9djfldjfldjfldjfldjfldjfldjfldjfldjfkvonT3rsb8b0GBuxrzuxrzuxrzuxrzuxrzuxrzuxrzuxrzuxrzuxrzuxrzuxrzuxrzuxrzuxrzuxrzuxrzuxrzN64x30ri6pc5F7KVge6yfY9XKs+/i6MZZgMfHEeXl7jKW0zWw+afKkonO34XR+dcC4zbo0TiOCS+YtbYGWDG2VMXhrh3hMvHjrUpUn8lfxozd92IQ6LnK/u2E5Zfv3pzFMVRqJxZqIwqFfA5ZpnxucvCa6WiUdtllHM5rSiNLXJzLl1dp1k30feMEn39H61cOExrbSDsZgC7beC/uKmNAy4vXRIx5ZG6/u7T1hEesaE3Ht+75XL5fzBCW7g=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Self Sign","permalink":"/docs/API-docs/v1.1/selfsign"},"next":{"title":"Create Document","permalink":"/docs/API-docs/v1.1/createdocument"}}');var s=t(74848),i=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),u=t.n(p),x=(t(18766),t(79329),t(9303));const m={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:"eJztPNlyHDeSv4Kt2AhZPcXqQ9RhrkYxtKS1teOVFBa1jllSw0FXZXdDrALKAIrNNqMj5mH+YJ/2dT7NX7KRCaCOPkhKoj3SbPtBZqNwJBKZiURel5HlUxMdHEfPVFoVIK2J3sVRBibVorRCyeggOpoBe6b5xLLQiR2+fsF4nqu5YZUBbZhVbAoSNLfAJMxZFqZj4wUrtToXmZBTlnHL2VzYGeNszA082GcgU5VBxiYih+REnsgjUR6wt2WueMYWqtLs9bN/r+fDhbDtuNd7BuNqyt6+6PXefTWztjQH/T4vy0SVII2YypyPTZKqop9hxzKb3I3ZfAYacFaWcsmAG5EvGM8yNhfZFKyJmZ2BZKkqFyxVSmdCcgsmZiWfApNVMQZtYsZlxgqlgQnJONPAs8WeVXuVAfYfb169ZBOlC24T9jqvTFwvlwkNqc0Xbno7g3pXd0zAhrFayGnMCn6G+BKW/VSJ9Ay3bUBm+H8cePj6BeGq13tTlaXSFjL2o9vCQa+HX76BXM0Z10D9U1UUSrKSa16ApQObcUufNfxUCQ2ZP5Y8D7g4OJF7rNeTvICDXo+9leKnCpjIQFoxEaBxl8zOhPEDEtffLkrq/0JmIkXkEQDYytSk2xWRil3flJDilK5rC9VMSTafiXRGOJxzd/5lzlO3LQ2mhNSKc+hOfBGzBU78DKQKEMyUFj8raXlOx3cO2oqU5+1jRgCxq7FcW0R/qYS0odWvwP7kjxNPmw7R0yGCliFyCyHpiwF2zvMKjIdqHrMZQvUDlBoMMYefFxEvMzYDMZ1tXY9n7ytjOxOzyiCYbSj8WuFUCb1AaJvw3AATkw4uC34GrdWYIqbnecK+WbAMJrzKbcwEUqjVFSTspbKMl2UuUj7OgWgAmY3bSsMenbInn6RLPq9JBoBhnGViMgGNzIwfaQo/JkCHdNkIDeI0O+OSKbly0KnKlV4nIWru4pGlSlqQNmGH51zkBLzbrGFCpnmVARvnPD2L2TivIGYaMsfoC0BBFzv+oC6MG49zwg8zkCMVKonwS+WXF4YZD1WWsCNklJr/8GNANS0iTBurnssnCldGFASWZFBwkceEuJi9V2Nmhc0hRgYvuVzEKGEhZhYu7FhdxCydQXpGf2meCcXGlbVKuo1lWpWZmkuPy4mS1oifN3Bk+PLhGB3FbD9mD2L2KGbDQcyGo5gN92M2fBCz4aOYjQYxG41iNtqP2eiBA2v0KA5XREBwG4DhyGHZfjnYRTn9vTDE2ShgTS2z5x2ZPUxYr1dzE7b95S9/OZGXJ5KxkwiZ6yQ6YCdR3eUkit03lJn4beh/X+CPe6OH/ucCfz4YPfI/59R1uO9/zvDnaHgil37BEzkiSCwvyiugwM+3CoH/5YkI22hRbAvyDBtREMXhA55VBx78sGzv5R7uRUhhBc/N9u2EHp/RjhqQ1ja1j5sict2+I/r8GW2nDQ9+ITHpPpFYbX0KDE9QjNZ2fz/xN8v2zbtlP5u9t8D5tK0/wK2jaDpC0bR9/7X0+oyQsArTp2HiYUIKAEnm7XjwHT4jLHQh+jQcPEIc4KW0HQH49TPafQsc/OBvePdtsL83vL83Goz2OxjAt5TrUBR7Wba3WCxuA3uo8/jlUeUJGqrT7PAdO9Gq2PD8oNdB08vrRPR3UNn/ExX1cdBhIcN3Ij0sgsZSvxDbWrZVGV/cMW6qMLRWzrB/o5otWmDSJ4SDXsvpTInUA499gko2xgdhgjjYI0z2s6zfwiQ2ZtleUeytNOLPPUJ8q7EokixLVnqunY5rLFiWxWy9eWN7lrGiKLY0u/ZOc78o1neRFIWHjZSvr5FJvM62nU98h9+KVRqO6C58JRuhpUHJnNam59xmPlq5bGZC+g+eqNhKBw3TKucaLvBdaoSSrvft81hgsUazp3estyRAUKzZV6+89n7Xkz9uoTsBtlw/bm1nOMkhSytjVcE0TOGCldxa0JImO+e5yDg95faoAS54UeIToP/nk5Psd//aJwMEvvEtw5NgmZgKtBv1/3x8uPff7zb0qMoSdMoNsBxwJRMzsGnCjmeQl43paj6fJ/N7Jp0plTu71XujYeL+PVXj96cEbplwU97dtFNHGq0HP5LO6nvfgO1gjBsWRm548hONEQ8NB3Tb+vfOFdet7/EZ3TgrIOFHZz3Bz8cnUcFJIUFShuZvZWegT6J39Rj3yIfsmrHvbsCsM5FBzseQr3+6MaPVzTlfqMrzdzBqdbfqKbqFN/xQCFnbLWg7g7j1kV+sfHTflhv42yGkzZ3hygnsGU6A5cIEy00Xne3R3rRFBkoJQDbPMbAwAA3KQXp8KhfUgN2MDZwk8md3zRLYj1HH2qwYVrtmhc7BtBGDcxRCiqIqavvopJ41oKzwukcbXzgS7fRhhfbprq3AL65ZAY2R2xc4kUOyYwT7xxWaqe/xGcmKFZCuZuOPkSKde/qWLtjrGTBsq82AG65l7Oou5Jr5zHbuS9grvN7QJusGoZUtTaG0aJH7VNasQb7xDUU2K2eH+4bscNspr22t+4yobwNYvzIF+n63fft8FJG2d/8FEWoH7BsTqzNKFnx6xcudPn9G5OnhWTNCDMkY6e6LKwxy9P3q7QwHne3c727nweAjXledZT/9cTWoG5tX1XOJPoe1hfBdXuV8TdRnkIqC5+TFJKhHH85/GxjML4dU+1QVZWXbbELWABIF4V4PHjfnQfxdzPZi1otZP2Zfxexuwn4A8tGltT/PX/NCO6+dkCxTFbpT0krnCzbWuJ2YQTJN2OXlTxWXVtjFcsl67PIS4wKWywT55kyquXPpHZ8LIyxDl3zzDMpUaja48FVq+vhe6r+E+V4IQ+h70O6yr9QKE1/56PQo+NBX5rZhv+rTy22mRTG4ystaN3PPT3I9C1PmfMH4BKnRuSdpmPNiJ3gyB2zEfv+EDUfJYBCzgfubfRXwMrrrfFWvNUxEnrciClhoCsSAHlrIofBebB9LgJor+bWEtAoRHqI2er0xTBT6tDCkAT2jM97EHDjV0UnpdlgESzVwqzSbceOe1PSGx91izIadQeG9ay+VBedaN6WSBtytUm4AunGN93orrrnQrXHPCRk2jnJteHt2pNHXg7agGz6435Hb97uSbrBN0l1hRkJ55nARbO/QfGrJGZKEoX1dyKxKmTApItvJvUDSjtZVlWcsF2fQJkkhTbi1PZSr7vunM6VM08N70D1Xm4OuZ15pdM7fTWpH5acawIcP73WunUe3YNVbsXN3D2Ow3x/e719p6F4xz3747cDYTU6OLMg3Ojnq2RzdziD9sQbp2yH8e7dpjxs+HHXUyHuDT2eAWzK7tRnnGoPbbZjVbs2+1Wa3G1q2fjML06dT337z1h7f2lt7RQw/HN6CGN7ypP5USlx7Od8a7bHbejZvIsAbvJuvfCx/MoG2gf3VifT+7byxh4OOrvZ1R1X7etQmyvv3b0SU7UVXKOskEv/1zasf5oM/fjtVh4eHhy/fvJ09fzs9PDws8HeSJBvNK5tOm5ZBHdbHFvt7me74LaskSYIoxDDtAxreL+X039z4ePuY5ERGcaRKjP8WSr7IooMow4jxoMlHMb27wdhvVLaIDi4jHzyIf/rQPBzZf28w5PwyMukMCo5/BXUdg9QxRjyKI4ohwTh1PMfoIFLj95DiGqVGGKwAgyOp98Fl6OVCq6PYK1rRQeT2FcWR9/LVTXVQeplNomVY8Kqp6pZmKkN/1I8ZnAejkT9yGnzh4BSd0PyPmulZawbaWwFHCk0GOVh4xhemNa978karGQE4Bjk89aNYxhcGJUVl3K2W8jytclQG4aIUelGHSpBG2KKKGt56pRre4f1lTKGOoNsgca35IoojYaFot28hAq0+/ORSUIgZilf70LHvFYwB/uAb0HhBB8+LD4bivQI2Bjr0cqbkB48fju4NR8N7wxHO4IOOPnSOYIjBKd6r8elHMUIG5zjeP68//ijd1/W1u7R5iFG9kAVla68JT48ZhYgm17FJ6E+Y51O4nh+OtqUttKKlzYxeWLwsgeuEsgc+OpGly2L1rZ5cw1DLOLq4fjMXLFV7ISeCfZXDxLoYBpYqLUHfbQdGfTabG+3vL+Nocf32Fl/k9h7i4c2v392PlEzSJNr8I2C992gZR7PrYf2uTnf5BwK7/2DZXPARGRwh3E+nY5UtToPcWl7XMdxV2G+i8gw0KkLr8qoRNShhMK3rdPWqGSuVA5cbBE0nz8Gn4KHSjQZmb4iZz4As/bUuTrM3ir43RztoMXcCVsKxhEEdWVdwEiXsxaT1bCA1fjXVIvSltAep2B1a79RUJMbv9P1vxNGddgoammObiMgAAnVmFooyp5ysOVpwxxRekCWs/o80zhqTCEC4scPC118VT10YGC3oB3UTmphXWhP2lMs6qaWbPMIuL2syIOpYLtnlJZ4q6FO895fLuGnAtToNdLW7Fg0piPPOqLoJmoF1W2uo07JOM3KzYIO/79sAiKkUcnpaaT8PKqPLZdIhyBXAyfDucQBZTWdiKjfsulaZ6KRvjP01ZHsKwEn+3+D9cfnkO7EBlMf98snj8smPmL5YguM9h56JkJnj/DnkecIeG6uVnD5ZQcHjvm/ffJQazgXMiXHpVJtZVnFbT5R4mP6Egro5PGFYqqtU8JziH7VKIfh3yHeGL3djoTTo9xKWRroMM3oS8KkG8iYRLLyylK5Jb8Kw4GPOZhomv7+zgtM7T94g6OhGfNznT3zvF84WMePnwLhcMNo4GU6Udsa3SaVJTKY512LiH6AxK3PAWE18n/LUeewcRgMcRzMuz0z8eKyfHAEv2KsSJELwy9/+jj2CTH8hX+kM9A2E+ouJ8w0qdgfl2J3YxY0SuQttrBfVThJ6CnFwbWEdnzeEfsXnteg31dhgLxnma0Sr1WI6BfTH+R402GfhAU9n7tIgqBr3YonEoyoTwEMCCw/CzLuK/UF1TT0t7JArsL33ZJNUl5i29+ro9Q1wSXaoPccozgjjdunmYK+OXmPmb33cCXtrakwE1PJOF4aWAHYueMgOrDX7hYu1A+dM8XKx7b9MfM7tHlsHKBNmI0Sxu9RRwtWZ9WsTN6nkeESqsugPFT7hkbisg0eCokbkkapuQpXXYJKzaUWpDRbZN9yaFN3cZO4KaayuXJwhyyodkpU9WTgxYUyDp4AV7NSaP2YgjRvO2YQbCzpmlRSIeV2habKeEi5K0AIDFzaiQINDHYqO66+obhrs2x++9wUEwh4CU46RA93EkLGqJKohTqjTs8PJrW59oz7oxff1AKLuRuEY3r5agjZKoohTesqll6DuPYpG1DHMeO66elGBfjiEBzk82fj2/+Vvf2/BtdUosg6YW4FnGcbeXwMh2aMdwWN4qYYSJaDqQoTzgf7D6hMAoSOmOS1UVjOSuTmNv6ZofVPLRR9fUMc3mCqd4bVVy1sTBxlrvFHBkOmZ7NMUoFDifuFCGNtKMA5pQOvy4QdAPKYtGOgRilyNNC8XbQZv4i7UynT0PBDd5PT6EbTGC7yy6lRDIeTN7qm2qd+qWhBUVhXcipSFqUzSLTng/MmBr4sm3gSp8VwofXcLq+J0p0qmcCrkKZyDvsHzvhUagzbJMdg5gGzDFpDkrrMmLXyOlT86OGndTlT8oEOM92OkuwL0FE5TNFIR4cEN8Njr4Wy9HttzsHixairt/TK+YgfJDxQlzewIkVeH66Sy5s5tF0pJ2HdqjjirNRrUO938iFJGkGexm6K1QsolJtfTSxEfazhx7bsvOMV9+SVc+AydF+3G61ypc9jgLFhhAteJr9pTEKF1thzHKhFhdccRbnNo0Wc8V8RSXrP0nztAvaACATO6gugI0b/k1glVO9Rcgv7lr/9rKErIhbqZ+rW78Ss9WHlulKs+0J41UHSg+aT7PA0k7QOSNpk6uyQSan6EhK0gQJzuQbVrijEGuVJUFWlUdNOEZ/2a7fRXM75eZUn1wT47O+oXZGgcDgb/zHbUe4Mvx466P/iC7KiPEFjv9r5emmzTbjfKjuDbvnrAewXO0ZUrfXVPdCaTidYFX2xCcMMOo6X7rzH9BiHebus4u539i8Y0zmv/lg17ISyMBgP8X/c0n3WCX/FlU6X4UphUeb74lyi+uef86iOooRUbjdRXyfXZezH6+SI9H71GPG55SV05gSfESudYNw2vr736AieNvoVbIXMh4ZRQfJqp9FSDOR0NBqfDyB3M/iY0vlEFOA1gjsico+2qVoWsXjA+RV0GaVzfIlZB6+vI78Mg24CJQEOn+x0k3F9HwgtJ6Z9Uru9InYH8bXfaXt665RHUiyJvZEAkXCf6HnU22253mzSQVlrYRXRwfBld7PFS7LnvB8fvlu9QG7czhcEnpTIEMbez6CDqr8aiGNDnFFVwfOnIt6ZIw2WGAXRr4pGXon8+TIbRMl4ds1GcXtEfqr0PHWIsnwo5vW7cuwZFb/AY3Ul1ENXof6X4I6AC6M+h3SuOBJLPDDi+DBHzSB0/NBE8z8MZhyibTYEzzVmuhsKESJhOcMvqtbYhXGVztMrwfitO5DiEfFAURx3EsSkuo956iLSoAy1asROt0IkmGqITDEHxDa3whuOGJepIgqAAD0lzHO3vk4r1cEi6yL1HdM3vP1gSETeuwyjqugcpXWnVyfVpPpuuy2bnh/gn8kOsuCE88TS2dBel2jEK+6aukTRQYW2U7FgGVw2DW410W2x0fskVW1QNyCYTEJpeNlpe/KjWK3sDUwbFssuSGOSJLHlvQCy5PyCWfDTo6LR++80MjWZK6metfZKK2dYwUY18h3JUyIkiIexlRzg0uiNJiK+9RCBPVVFXLez1Wudcj+r1auHqaBWtIK8qzUo1Bz2pXBnESQ4XAk1dOAwK+tZEDwAvcjAmx6wPC1OyvVB6GfoUvNU65SUfi1ygEuCSvBzXNHqESdiPTfzBHe3y7s4hR92hNhZiKeCg586VPptgHEOMRYExHxHNxSBnXKbOMu1uNLKwouUDrf6lFgYLtWqEWjjYlLQaWaXgkk+JieM2U7AMcpRphmk1RseNUXnlWNFykSvtQhdpQxQZTUh8flHiJ3pO4U2gYYaEfe79EyZ2/iF3WfnSwGN0xZUIi0CzkVWskrnCKr7o0qtyTMmzzs2Gr7Y2jDjcai4Nqs8+WtKfQY0w7zoA4w1wbw3gCX8v5JmrJLnHjmu6+hHGRljo1plZZc673THfCvtdNcY6tcoIq/SiGT0VdlaNSe1oT1L/cDN9G0pBt5SKm6d4vgGLFGL6h69fkNZ6l/3y1/9h3wPXks3U3FFrWmnIF03VaarJTCfv0FYrneScQkmOGE8d8fkLKGDwxxm3ZO17CXM0qzqWcpHVr6txLlJ2FAJSer0D9pSeZq0glU5dDJfaiB5Dzko3OhfyLGGHckE+juY6wnYa19kGXYGtCtoco2qV9CHwbs2kgYis6gbyczAt6y1kwvlhtaqmbrU2MH5z3UxP3Nthlq0lTqIFvwHH2RzJAcqd8RFLXW/ItewkUnajN0BmlJZqDhgp58388Ur6J12Ga00hczSgI/bT1EfiONHvuG51dtkVhbgrb8neiwt2i5rzUnhyOg5kyboFnD6crJ29gu53elH5G5SXYqOPC0tLm1eTN6DPRRqe0Vs4uk+d+1Ec5SIFbzzx99fht6+/Z+f3kkEUt54ZN2Du/vcvnj5/+eY5AoOC1CFsmAySAdl4lbEFl62VulXjV6+2VhLArsb8rsb8rsb8rsb8rsb8rsb8rsb8rsb8rsb8b1bUaVdjfldjfldjfgsmdjXmdzXmP7V+yK7G/D99SZ9djfldjfldjfldjfldjfldjfldjfldjfldjfkvonT3rsb8b0GBuxrzuxrzuxrzuxrzuxrzuxrzuxrzuxrzuxrzuxrzuxrzuxrzuxrzuxrzuxrzuxrzuxrzuxrzN64x30ri6pc5F7KVge6yfY9XKs+/i6MZZgMfHEeXl7jKW0zWw+afKkonO34XR+dcC4zbo0TiOCS+YtbYGWDG2VMXhrh3hMvHjrUpUn8lfxozd92IQ6LnK/u2E5Zfv3pzFMVRqJxZqIwqFfA5ZpnxucvCa6WiUdtllHM5rSiNLXJzLl1dp1k30feMEn39H61cOExrbSDsZgC7beC/uKmNAy4vXRIx5ZG6/u7T1hEesaE3Ht+75XL5fzBCW7g=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,g={},y=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(x.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:"name:"})," Unique identifier for this widget."]}),"\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:'"mm/dd/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",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\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:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (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 "layout": "vertical",\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 "layout": "vertical"\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.jsxs)(n.ol,{start:"14",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": "",\n "decimalplaces": 2,\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:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the number (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",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,s.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Note:"})," Responses for prefill widgets are ",(0,s.jsx)(n.strong,{children:"required"}),"."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{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": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\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:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",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": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "name": "date",\n "response": "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:"response:"})," Enter the date you would like to display inside the date box."]}),"\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:'"mm/dd/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",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",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": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\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 checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\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:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",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": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\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:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\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 radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",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": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsx)(x.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"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},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}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},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}}, {{note}}.",example:"

Hi {{receiver_name}},

We hope this email finds you well. {{sender_name}} has requested you to review and sign {{document_title}}.

Your signature is crucial to proceed with the next steps as it signifies your agreement and authorization.

Sign here

If you have any questions or need further clarification, please contact the sender.

Thanks,
Team OpenSign\u2122

"},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},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:"5,"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},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:100},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:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"draftdocument_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:{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,i.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/851f8f65.c0d7643e.js b/assets/js/851f8f65.c0d7643e.js new file mode 100644 index 000000000..b55289e9d --- /dev/null +++ b/assets/js/851f8f65.c0d7643e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9070],{72700:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>f,contentTitle:()=>g,default:()=>b,frontMatter:()=>x,metadata:()=>i,toc:()=>j});const i=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/draftdocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/draftdocument","permalink":"/docs/API-docs/v1.1/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":"eJztPdlyHDeSv4Kt2AhZPcXqQ9RhrkYxtKS1teOVFBa1jllSw0FXZXdDrALKAIrNNqMj5mH+YJ/2dT7NX7KRCaCOPkhKojXybPtBZqNwJBKZicxEJnAZWT410cFx9EylVQHSmuhdHGVgUi1KK5SMDqKjGbBnmk8sC5XY4esXjOe5mhtWGdCGWcWmIEFzC0zCnGWhOzZesFKrc5EJOWUZt5zNhZ0xzsbcwIN9BjJVGWRsInJITuSJPBLlAXtb5opnbKEqzV4/+/e6PxwIy457vWcwrqbs7Yte791XM2tLc9Dv87JMVAnSiKnM+dgkqSr6GVYss8ndmM1noAF7ZSmXDLgR+YLxLGNzkU3BmpjZGUiWqnLBUqV0JiS3YGJW8ikwWRVj0CZmXGasUBqYkIwzDTxb7Fm1Vxlg//Hm1Us2UbrgNmGv88rE9XCZ0JDafOG6tzOoZ3XHBGwYq4WcxqzgZ4gvYdlPlUjPcNoGZIb/x4aHr18Qrnq9N1VZKm0hYz+6KRz0evjlG8jVnHENVD9VRaEkK7nmBVhasBm39FnDT5XQkPllyfOAi4MTucd6PckLOOj12FspfqqAiQykFRMBGmfJ7EwY3yBx9e2ipPovZCZSRB4BgKVMTbpVEalY9U0JKXbpqrZQzZRk85lIZ4TDOXfrX+Y8ddPSYEpIrTiHbscXMVtgx89AqgDBTGnxs5KW57R856CtSHneXmYEEKsay7VF9JdKSBtK/QjsT345cbVpET0dImgZIrcQkr4YYOc8r8B4qOYxmyFUP0CpwRBz+H4R8TJjMxDT2dbxePa+MrbTMasMgtmGwo8VVpXQC4S2Cc8NMDHp4LLgZ9AajSliep4n7JsFy2DCq9zGTCCFWl1Bwl4qy3hZ5iLl4xyIBpDZuK007NEqe/JJuuTzmmQAGMZZJiYT0MjM+JG68G0CdEiXjdAgTrMzLpmSKwudqlzpdRKi4i4eWaqkBWkTdnjORU7Au8kaJmSaVxmwcc7Ts5iN8wpipiFzjL4AFHSx4w+qwrjxOCf8MAM5UqGSCL9UfnhhmPFQZQk7Qkap+Q8/BlTTIMK0seq5fKJwZERBYEkGBRd5TIiL2Xs1ZlbYHGJk8JLLRYwSFmJm4cKO1UXM0hmkZ/SX5plQbFxZq6SbWKZVmam59LicKGmN+HkDR4YvH47RUcz2Y/YgZo9iNhzEbDiK2XA/ZsMHMRs+itloELPRKGaj/ZiNHjiwRo/isEUEBLcBGI4clu1vC7szkcEpNjzFuZ1yY0ELc4bimv2Iew5IBC6LnbiEC4vCj6SRmErImh1QGDYTWQaSTbQqmIZUlIKkiZMGddcxwsM0TkoaNqnyfMHOhREtHNSdqrlEvNGIQrNXJcg3YioZT1NV4RoThh1SCZ3Nkst8gaAeAS8Mzfy5tKBLLQygqJbG71TfC0OyDbcYU+9a886uNUxYr1fLEyz7y1/+ciIvTyRjJxGKl5PogJ1EdZWTKHbfcNfAb0P/+wJ/3Bs99D8X+PPB6JH/Oaeqw33/c4Y/R8MTufQDnsgRQWJ5UV4BBX6+VQj8L89GWEaDYlmQ6FiIojgOH5BaO/Dgh2V7LvdwLkIKK3hutk8n1PiCZtSAtDapfZwUMez2GdHnL2g6bXjwC20U7hNtLK1PQeQRFKO6eJsYwWq0wa/h6X7id+HtaHIAfjFYaoHzuZD0AJGEAv8IBf52TNV7wheErlWYPhfOHiakgNHOuB1jvsIXhK8uRJ8LW48QW6g+bEcVfv2C8NQCBz94Xcx9G+zvDe/vjQaj/Q6u0Op1FYpiL8v2FovFR+F5BXuoP/nhUV0KtoTTYNDjQIrQuqFIdlxTy2uv9Hcwrv4TTapxsDYg8ypQo1vWtnzbHrIq44s7xnUVmtZqNNZvlOhFC0z6hHCQXyOdKZF64LFOUJ7HaLoniIM9wmQ/y/otTGJhlu0Vxd5KIf7cI8S3CosiybJkpeba6rjCgmVZzNaLN5ZnGSuKYkuxK+8U94tifRZJUXjYSEn8GpnEa9fb+cRX+Fys0nBEd+Ar2Qh9QqgZ1wJhMx+tbHUzIf0HT1RspYKGaZVzDRfoQTBCSVf7s8qyFW4MzNhYa+Sb8N4hCMYS++qVt8ju1haRXOkAS65vt4YD7OSQpZWxZA5N4YKV3FrQkjo757nIOBkue1QAF7wo0azr//nkJPvdv/bJqYR+G+usmUxMBfoC+38+Ptz773cbalRlCTrlBlgOOJKJGdg0YcczyMvGHTmfz5P5PZPOlMqdL/K90TBx/56q8ftTArdMuCnvbpqpI6KWEweJbNWHY8B2MMYNCy03uHFoSYnbhgPawb0Ne8UW7mt8QXvTCkj40XnE8PPxSVRwUoeQ6KH5W9kZ6JPoXd3GOW4gu6btuxuwNXJRzseQr3/6cJbM+UJVXhIER2V3qp6iW3jDD4WQtS+KpjOIWx/5xcpH9225gb8dQtrcGTanwJ5hBVguTPDGddHZbu3dleR0lgDkxx4DCw3wkCBIj0/lghqwm7FB8M3Q2l0zBNZjVLF2FYfRrhmhszBtxGAfhZCiqIra5z2pew0oK7yW0sYXtsSzlzBCe3XXRuAX14yADubtA5zIIXlmgk/rCh3W1/iCZMUKSFez8cdIkc6Ofkvq7vUMGKbVZsAN2zJWdRtyzXxmO/cl7JVz54VG6OpLUygtelk/lTVrkG+8Q5EXzvlWvyHf6nbKa3tgvyDq2wDWr0yBvt5t7z4fRaTt2f+GCLUD9o2J1blZCz69wsanz18QeXp41twVQ3Kvuv3iCschfb96OsNBZzr3u9N5MPgIO6wz7KebYYO6sLG/6AyDrQ2EFnyV8zVRn0EqCp7TyTRBPfoE/vsYg8wDhvT9VBVlZdsMRR4GEhpBAwjnre7E6Hcx24tZL2b9mH0Vs7sJ+wHohDatT3O9QiC0O7MVkmWqwuOftNL5go01TjxmkEwTdnn5U8WlFXaxXLIeu7zEqJDlMkEOO5Nq7g50j/EoyjIMyGgMpkylZkMAh0pNHy2r/kuY74UglL4H7S77Sq2w+5XmqUfBh9qj25r9qkaam0yLtnCUl7UW5wxVCjwQpsz5gvEJ0q07nKZmLoYhwZU5YCP2+ydsOEoGg5gN3N/sq4CX0V13Tvdaw0TkeSuehIWiQAx4Pg85FD6GwUeSoI5LZ3pCWoUID4eLvd4YJgrP8zCgBc/FZ7yJOHFKppPnnTPJVAO3SrMZN874JmsfZ4sRO3YGhT9ZfKksuMAKUyppwO0/5Qagm8CIXm/lWDJUa44mhQwTRwk4vD3f1OjrQVskDh/c70j4+12ZONgmE69wTaHkc7gIZwTQfGpJJJKZoXxdKV2VMqFTRLaTkPVhNdG6qvKM5eIM2iQppAn7u4dyNXjj6Uwp09Tw8ROeq81BNy5DaQzNuJvUh7Sf6lQfPrzX2aAe3YKncMV33l2MwX5/eL9/pfN8xeX74dYEYzdZOfJK32jlqGazdDsn98c6uW+H8O/dpudu+HDUUTjvDT6dAW7JQddmnGtcc7fhgLs1T1ib3W7oA/tsvqhPp779xiof35pVviKGHw5vQQxvMb4/lRLXbOxboz12Wwb2JgK8gYV9pVn9yQTaBvZXJ9L7t2ONDwcdXe3rjqr29ahNlPfv34go24OuUNZJJP7rm1c/zAd//HaqDg8PD1++eTt7/nZ6eHhY4O8kSTY6YjatNg2DOqyPLPf7Mu3xW0ZJkgRRiEH6B9S8X8rpv7n28fY2yYmM4kiVGP0vlHyRRQdRhvkCQZOPYrLQwdhvVLaIDi4jHzqKf/rATGzZf28w4eAyMukMCo5/BXUdUxQwQyCKI4p1wSwFXMfoIFLj95DiGKVGGKwAgy2p9sFlqOUC66PYK1rRQeTmFcWRPw+si+qUhDKbRMsw4FVd1SVNV4b+qI0Z7Adj0T+yG7RwsItOYsZH9fSs1QPNrYAjhS6DHCw84wvT6teZvNFqPgi2QQ5PfSuW8YVBSVEZt6ulPE+rHJVBuCiFXtThF6QRtqiihrceqYZ3eH8ZU5gn6DZIXGu+iOJIWCja5VuIQKsPX7kUFGKGYvU+tO17BWOAP/gCdF7QwvPig6F4r4CNgRa9nCn5we2Ho3vD0fDecIQ9+JCnD+0jOGKwi/dqfPpRjJDBObb35vXHL6X7uj52lzYPMaYbsqBs7TXJCTGj8NjkOjYJ9QnzfArX88PRtqSVVqy8mZGFxcsSuE4od+Sj05i6LFbv6sk1DLWMo4vrJ3PBUrUXMmLYVzlMrIt2YKnSEvTddrDVFzO50f7+Mo4W109v8Zuc3kNcvPn1s/uRUomaNKt/BKz3Hi3jaHY9rN/VyU7/QGD3HyybDT4ihyOE/el0rLLFaZBby+sqhr0K601UnoFGRWhdXjWiBiUMJvWdrm41Y6Vy4HKDoOlkufgETFS60cHsHTHzGZCnv9bFqfdG0ffuaAct5nXASuCWMKgj6wpOooS9mLTMBlLjVxNtQl1K/ZCK3aHxTk1FYvxO3/9GHN1pJyCiO7aJsgwgUGVmoShzysibowd3TIEIWcLq/0jjrDGJAIQdOwx8/Vbx1AWM0YC+UTedjXmlNWFPuaxTmrqpQ+zysiYDoo7lkl1e4qqCPsV9f7mMmwIcq1NAW7sr0ZCCOO+0qougaViXtZo6Les0o2MWLPD7fRsAMZVCTk8r7ftBZXS5TDoEuQI4Od49DiCr6QzTgtZnXatMtNI3xv4asj0FYCf/b/D+uHzyndgAyuN++eRx+eRHTF4twfGeQ89EyMxx/hzyPGGPjdVKTp+soOBx35dvXkoN5wLmxLi0qk0vq7itO0o8TH9CQd0snjAs1VUqeE6RklqlEM536OwMLXdjoTR47iUstXT5hWQS8KkGOk0iWHhlKVmXbMIw4GPOZhomv7+zgtM7TyhPDY8RH/f5E1/7hfNFzPg5MC4XjCZOjhOlnfNtUmkSk2nOtZh4AzRmZQ4Y1Yn2KU/diZ3DaIDjaMblmYkfj/UTzHirM+V++dvfsUaQ6S/kK52BvoFQfzFxZ4OK3UE5did2EaZE7kIb60W1k4SeQuq8wE2s43Om8FzxeS36TTU2WEuG/hrRarWYTgHP43wNauxzMIGnM7dpEFTN8WKJxKMqE8BDAgsGYeaPiv1CdV09LezQUWB77skmqU55ka+OXt8Al+SH2nOM4nMVaZauD/bq6DXmfdfLnbC3psZEQC3vVGHoCWDngofc0FqzX7ioPHCHKV4uts8vE59xvcfWAcqE2QhR7DZ1lHD1vQprHTcXCeASqcrieajw6a7EZR08EhQ1Io9UdROqvAaTnE0rSpewyL5h16Q46CZvW0hjdeUiEllW6ZCq7snCiQljGjwFrGClVv8xA2lcc84mFA4Rs0oKxLyu0DVZdwkXJWiBgQsbUaDBoQ5Fx/VbVDcJ+u0P3/vrI+qkXF3zUOgYMlaVRDXECXVyfli51alv1Ae9+L4eQNTdKBzD+1dL0EZJFHFKT7n0EtTZo+hEHcOM566qFxV4DofwIIcnG23/X/729xZcW50i64C5EXiWYZT+NRCSP9oRPAaiaihRAqouRNgf6D+smgAIHTHNaaGympHMzWn8NcX1m1ou+viCOr7BVOkMt61a3po4yFjjnQqGXM910rYqcb5wIYxtpZeH1KJ1+fADIB7TFgxkhCJXI83LRZvBm7gLtdIdmQeiezVBbQSt8QKvrDrVUAh5s32q7eq3qhYElVUFtyJloSuTdC+ccOfJga+LJt4EqfFcKH13C6tid6dKpnAq5Cmcg76Bed8KjUGf5BjsHEC2YQtIcttZcynAHHPwOzhp7U509UWHGO/HSHcF6CmcpuikIsKDG+Cx18Peej2252DxYtVU2p/L+PtaSH6gKGl6R4i8OlwnqjV7bvuanIR9p+aIs1qjQb3T9Y8oZQS5v2ygPULKJV6tQJYiGmvYcX12jxcJNEO48BlaL5qN17lSd2CDveD9IjhOfNWcggitM/A43hESRg+3H+Dk0KPPeK6IpbxmuXI5AgH1gq6HmNEWREuI50tunHBnC1138Mtf/9dQlJALdTO1tbvxKxmsPDfK3T3R7jVQdKD5pGueBpL2AUmbXJ1dEgk3voQksCBAnO5BNxcVYwyHpagq0qhopwlm/Zrv9Fdzvl7lSfXBPjs/6m/I0TgcDP6Z/aj3Br8dP+r+4DfkR32EwPpj7+ulyTbtdqPsCGfbVzd4r8AddOVKX10TD5PJReuCLzYhuGGH0dL917h+gxBvl3UOu53/i9o0h9felg1zISyMBgP8X3c1n3WCX9GyqVK0FOj2nn+J4pufnF+9BDW0YqOT+iq5PnsvRj9fpOej14jHLZbUlR14Qqx0jrfm4fa1V2/gpNG3cCtkLiScEopPM5WeajCno8HgdBi5hdnfhMY3qgCnAcwRmXP0XdWqkNULxqeoyyCN61vEKmh9Hfl9GGQbMBFo6HS/g4T760h4ISlRlC5rPFJnID/vTNvDWzc8gnpR5I0MiISrRN+jzmTb5W6SBtJKC7uIDo4vo4s9Xoo99/3g+N3yHWrjdqYw+KRUhiDmdhYdRP3VWBQD+pyiCo4vHfnWFGm4zDCAbk088lL0z4fJMFrGq202itMr6kO196FNjOVTIafXtXvXoOgNLqNbqQ6iGv2vFH8EVAD9OrRrxZFA8pkBR8sQMY/U8UMTwfM8rHGIstkUONOs5WooTIiE6QS3rG5rG8JVNkerDO+34kSOQ8gHRXHUQRyb4jLqqYdIizrQohU70QqdaKIhOsEQFN/QCm84bliijiQICvCQNMfR/j6pWA+HpIvce0Tb/P6DJRFxc3QYRd3jQUpsWj3k+rQzm+6Rze4c4p/oHGLlGMITT+NLd1GqHaewL+o6SQMV1k7Jjmdw1TG41Um3xUfnh1zxRdWAbHIBoetlo+fFt2pZ2RuYMiiWXZbEIE9kyXsDYsn9AbHko0FHp/XTb3poNFNSP2vtk1TMtoaJauQ7lKNCThQJYS876msWcY8kIb5miUCeqqK+r7HXa61z3arXq4Wro1X0gryqNCvVHPSkcpdgTnK4oLsfsRkU9K2JHgBe5GBMjlkfFqbke6H0MjxT8F7rlJd8LHKBSoBL8nJc0+gRJsHLLEP8wR3t8u7OIUfdoXYW4kXQQc+dK302wTiGGK+ExnxEdBeDnHGZOs+029HIw4qej+ZySWM1Qi0cbEpajaxScMmnxMRxmylYBjnKNMO0GuPBjVF55VjRcpEr7UIXaUIUGU1IfH5R4icyp3An0DBDwj735xMmdudDbrPyF0OP8SiuRFgEuo2sYpXMFd7hjEd6VY4pedYds6HV1oYRm1vNpUH12UdL+jWoEeaPDiBcq/nWAK7w90KeuVs099hxTVc/wtgIC90baVaZ8263zbfCfleN8ZZiZYRVetG0ngo7q8akdrQ7qX+4nr4NF4G3lIqbp3i+AYsUYvqHr1+Q1nqX/fLX/2HfA9eSzdTcUWtaacgXzZ3jdCM3rbxDW6100uEUSnLEeOqIz29AAYM/zrglb99LmKNb1bGUi6x+XY1zkbKjEJDS6x2wp2SatYJUOjdouNRGPDHkrHStcyHPEnYoF3TG0WxHWE7tOtOgLbB1fzrHqFp/F2wYM2kgIq+6gfwcTMt7C5lw57BaVVM3WhsYP7lupifO7TDL1hIn0YPfgON8jnQAyp3zES8635Br2Umk7EZvgMwoLdUcMFLOm/7jlfRP2gzXikLmaEBH7Lupl8Rxop9xXer8sisKcVfekr8XB+xeac9L4cnpOJAl61719OFk7fwVtL+TReV3UF6KjWdceLG4eTV5A/pcpMGM3sLRfarcj+IoFyl454nfvw6/ff09O7+XDKK4ZWbcgLn73794+vzlm+cIDApSh7BhMkgG5ONVxhZctkbqvhmwurW1kgB2LwzsXhjYvTCwe2Fg98LA7oWB3QsDuxcGdi8M7F4Y+GwXYO1eGNi9MLB7YWD3wsAt4mv3wsDuhYHdCwNf4OVLuxcGdi8M7F4Y2L0wsHthYPfCwO6Fgd0LA7sXBnYvDOxeGNi9MLB7YeDXI8/dCwO7FwZ2LwzsXhjYvTCwe2Fg98LAye6Fgd0LA7sXBnYvDOxeGNi9MLB7YWD3wsDuhYEbvzDQSuHrlzkXsnX/gMv1Pl55d+BdHM0wF/zgOLq8xFHeYqomFv9UUTLh8bs4OudaYJwhpZHHIe0ZcwbPAPMNn7og1L0jHD52rE15GivZ85i37VocEj1fWbedrv761ZujKI7CvamFyuieCj7HHEM+dzmYrUREKruMci6nFSUxRq7PpbvVa9ZN8z6jNG//RysTEpOaGwi7+d9uGvgvTmpjg8tLl0JOWcSuvvu0tYVHbKiNy/duuVz+H4tey7U=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Self Sign","permalink":"/docs/API-docs/v1.1/selfsign"},"next":{"title":"Create Document","permalink":"/docs/API-docs/v1.1/createdocument"}}');var s=t(74848),r=t(28453),o=t(33617),l=t.n(o),d=t(17543),a=t.n(d),c=t(86013),h=t.n(c),p=t(63723),m=t.n(p),u=(t(18766),t(79329),t(9303));const x={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:"eJztPdlyHDeSv4Kt2AhZPcXqQ9RhrkYxtKS1teOVFBa1jllSw0FXZXdDrALKAIrNNqMj5mH+YJ/2dT7NX7KRCaCOPkhKojXybPtBZqNwJBKZicxEJnAZWT410cFx9EylVQHSmuhdHGVgUi1KK5SMDqKjGbBnmk8sC5XY4esXjOe5mhtWGdCGWcWmIEFzC0zCnGWhOzZesFKrc5EJOWUZt5zNhZ0xzsbcwIN9BjJVGWRsInJITuSJPBLlAXtb5opnbKEqzV4/+/e6PxwIy457vWcwrqbs7Yte791XM2tLc9Dv87JMVAnSiKnM+dgkqSr6GVYss8ndmM1noAF7ZSmXDLgR+YLxLGNzkU3BmpjZGUiWqnLBUqV0JiS3YGJW8ikwWRVj0CZmXGasUBqYkIwzDTxb7Fm1Vxlg//Hm1Us2UbrgNmGv88rE9XCZ0JDafOG6tzOoZ3XHBGwYq4WcxqzgZ4gvYdlPlUjPcNoGZIb/x4aHr18Qrnq9N1VZKm0hYz+6KRz0evjlG8jVnHENVD9VRaEkK7nmBVhasBm39FnDT5XQkPllyfOAi4MTucd6PckLOOj12FspfqqAiQykFRMBGmfJ7EwY3yBx9e2ipPovZCZSRB4BgKVMTbpVEalY9U0JKXbpqrZQzZRk85lIZ4TDOXfrX+Y8ddPSYEpIrTiHbscXMVtgx89AqgDBTGnxs5KW57R856CtSHneXmYEEKsay7VF9JdKSBtK/QjsT345cbVpET0dImgZIrcQkr4YYOc8r8B4qOYxmyFUP0CpwRBz+H4R8TJjMxDT2dbxePa+MrbTMasMgtmGwo8VVpXQC4S2Cc8NMDHp4LLgZ9AajSliep4n7JsFy2DCq9zGTCCFWl1Bwl4qy3hZ5iLl4xyIBpDZuK007NEqe/JJuuTzmmQAGMZZJiYT0MjM+JG68G0CdEiXjdAgTrMzLpmSKwudqlzpdRKi4i4eWaqkBWkTdnjORU7Au8kaJmSaVxmwcc7Ts5iN8wpipiFzjL4AFHSx4w+qwrjxOCf8MAM5UqGSCL9UfnhhmPFQZQk7Qkap+Q8/BlTTIMK0seq5fKJwZERBYEkGBRd5TIiL2Xs1ZlbYHGJk8JLLRYwSFmJm4cKO1UXM0hmkZ/SX5plQbFxZq6SbWKZVmam59LicKGmN+HkDR4YvH47RUcz2Y/YgZo9iNhzEbDiK2XA/ZsMHMRs+itloELPRKGaj/ZiNHjiwRo/isEUEBLcBGI4clu1vC7szkcEpNjzFuZ1yY0ELc4bimv2Iew5IBC6LnbiEC4vCj6SRmErImh1QGDYTWQaSTbQqmIZUlIKkiZMGddcxwsM0TkoaNqnyfMHOhREtHNSdqrlEvNGIQrNXJcg3YioZT1NV4RoThh1SCZ3Nkst8gaAeAS8Mzfy5tKBLLQygqJbG71TfC0OyDbcYU+9a886uNUxYr1fLEyz7y1/+ciIvTyRjJxGKl5PogJ1EdZWTKHbfcNfAb0P/+wJ/3Bs99D8X+PPB6JH/Oaeqw33/c4Y/R8MTufQDnsgRQWJ5UV4BBX6+VQj8L89GWEaDYlmQ6FiIojgOH5BaO/Dgh2V7LvdwLkIKK3hutk8n1PiCZtSAtDapfZwUMez2GdHnL2g6bXjwC20U7hNtLK1PQeQRFKO6eJsYwWq0wa/h6X7id+HtaHIAfjFYaoHzuZD0AJGEAv8IBf52TNV7wheErlWYPhfOHiakgNHOuB1jvsIXhK8uRJ8LW48QW6g+bEcVfv2C8NQCBz94Xcx9G+zvDe/vjQaj/Q6u0Op1FYpiL8v2FovFR+F5BXuoP/nhUV0KtoTTYNDjQIrQuqFIdlxTy2uv9Hcwrv4TTapxsDYg8ypQo1vWtnzbHrIq44s7xnUVmtZqNNZvlOhFC0z6hHCQXyOdKZF64LFOUJ7HaLoniIM9wmQ/y/otTGJhlu0Vxd5KIf7cI8S3CosiybJkpeba6rjCgmVZzNaLN5ZnGSuKYkuxK+8U94tifRZJUXjYSEn8GpnEa9fb+cRX+Fys0nBEd+Ar2Qh9QqgZ1wJhMx+tbHUzIf0HT1RspYKGaZVzDRfoQTBCSVf7s8qyFW4MzNhYa+Sb8N4hCMYS++qVt8ju1haRXOkAS65vt4YD7OSQpZWxZA5N4YKV3FrQkjo757nIOBkue1QAF7wo0azr//nkJPvdv/bJqYR+G+usmUxMBfoC+38+Ptz773cbalRlCTrlBlgOOJKJGdg0YcczyMvGHTmfz5P5PZPOlMqdL/K90TBx/56q8ftTArdMuCnvbpqpI6KWEweJbNWHY8B2MMYNCy03uHFoSYnbhgPawb0Ne8UW7mt8QXvTCkj40XnE8PPxSVRwUoeQ6KH5W9kZ6JPoXd3GOW4gu6btuxuwNXJRzseQr3/6cJbM+UJVXhIER2V3qp6iW3jDD4WQtS+KpjOIWx/5xcpH9225gb8dQtrcGTanwJ5hBVguTPDGddHZbu3dleR0lgDkxx4DCw3wkCBIj0/lghqwm7FB8M3Q2l0zBNZjVLF2FYfRrhmhszBtxGAfhZCiqIra5z2pew0oK7yW0sYXtsSzlzBCe3XXRuAX14yADubtA5zIIXlmgk/rCh3W1/iCZMUKSFez8cdIkc6Ofkvq7vUMGKbVZsAN2zJWdRtyzXxmO/cl7JVz54VG6OpLUygtelk/lTVrkG+8Q5EXzvlWvyHf6nbKa3tgvyDq2wDWr0yBvt5t7z4fRaTt2f+GCLUD9o2J1blZCz69wsanz18QeXp41twVQ3Kvuv3iCschfb96OsNBZzr3u9N5MPgIO6wz7KebYYO6sLG/6AyDrQ2EFnyV8zVRn0EqCp7TyTRBPfoE/vsYg8wDhvT9VBVlZdsMRR4GEhpBAwjnre7E6Hcx24tZL2b9mH0Vs7sJ+wHohDatT3O9QiC0O7MVkmWqwuOftNL5go01TjxmkEwTdnn5U8WlFXaxXLIeu7zEqJDlMkEOO5Nq7g50j/EoyjIMyGgMpkylZkMAh0pNHy2r/kuY74UglL4H7S77Sq2w+5XmqUfBh9qj25r9qkaam0yLtnCUl7UW5wxVCjwQpsz5gvEJ0q07nKZmLoYhwZU5YCP2+ydsOEoGg5gN3N/sq4CX0V13Tvdaw0TkeSuehIWiQAx4Pg85FD6GwUeSoI5LZ3pCWoUID4eLvd4YJgrP8zCgBc/FZ7yJOHFKppPnnTPJVAO3SrMZN874JmsfZ4sRO3YGhT9ZfKksuMAKUyppwO0/5Qagm8CIXm/lWDJUa44mhQwTRwk4vD3f1OjrQVskDh/c70j4+12ZONgmE69wTaHkc7gIZwTQfGpJJJKZoXxdKV2VMqFTRLaTkPVhNdG6qvKM5eIM2iQppAn7u4dyNXjj6Uwp09Tw8ROeq81BNy5DaQzNuJvUh7Sf6lQfPrzX2aAe3YKncMV33l2MwX5/eL9/pfN8xeX74dYEYzdZOfJK32jlqGazdDsn98c6uW+H8O/dpudu+HDUUTjvDT6dAW7JQddmnGtcc7fhgLs1T1ib3W7oA/tsvqhPp779xiof35pVviKGHw5vQQxvMb4/lRLXbOxboz12Wwb2JgK8gYV9pVn9yQTaBvZXJ9L7t2ONDwcdXe3rjqr29ahNlPfv34go24OuUNZJJP7rm1c/zAd//HaqDg8PD1++eTt7/nZ6eHhY4O8kSTY6YjatNg2DOqyPLPf7Mu3xW0ZJkgRRiEH6B9S8X8rpv7n28fY2yYmM4kiVGP0vlHyRRQdRhvkCQZOPYrLQwdhvVLaIDi4jHzqKf/rATGzZf28w4eAyMukMCo5/BXUdUxQwQyCKI4p1wSwFXMfoIFLj95DiGKVGGKwAgy2p9sFlqOUC66PYK1rRQeTmFcWRPw+si+qUhDKbRMsw4FVd1SVNV4b+qI0Z7Adj0T+yG7RwsItOYsZH9fSs1QPNrYAjhS6DHCw84wvT6teZvNFqPgi2QQ5PfSuW8YVBSVEZt6ulPE+rHJVBuCiFXtThF6QRtqiihrceqYZ3eH8ZU5gn6DZIXGu+iOJIWCja5VuIQKsPX7kUFGKGYvU+tO17BWOAP/gCdF7QwvPig6F4r4CNgRa9nCn5we2Ho3vD0fDecIQ9+JCnD+0jOGKwi/dqfPpRjJDBObb35vXHL6X7uj52lzYPMaYbsqBs7TXJCTGj8NjkOjYJ9QnzfArX88PRtqSVVqy8mZGFxcsSuE4od+Sj05i6LFbv6sk1DLWMo4vrJ3PBUrUXMmLYVzlMrIt2YKnSEvTddrDVFzO50f7+Mo4W109v8Zuc3kNcvPn1s/uRUomaNKt/BKz3Hi3jaHY9rN/VyU7/QGD3HyybDT4ihyOE/el0rLLFaZBby+sqhr0K601UnoFGRWhdXjWiBiUMJvWdrm41Y6Vy4HKDoOlkufgETFS60cHsHTHzGZCnv9bFqfdG0ffuaAct5nXASuCWMKgj6wpOooS9mLTMBlLjVxNtQl1K/ZCK3aHxTk1FYvxO3/9GHN1pJyCiO7aJsgwgUGVmoShzysibowd3TIEIWcLq/0jjrDGJAIQdOwx8/Vbx1AWM0YC+UTedjXmlNWFPuaxTmrqpQ+zysiYDoo7lkl1e4qqCPsV9f7mMmwIcq1NAW7sr0ZCCOO+0qougaViXtZo6Les0o2MWLPD7fRsAMZVCTk8r7ftBZXS5TDoEuQI4Od49DiCr6QzTgtZnXatMtNI3xv4asj0FYCf/b/D+uHzyndgAyuN++eRx+eRHTF4twfGeQ89EyMxx/hzyPGGPjdVKTp+soOBx35dvXkoN5wLmxLi0qk0vq7itO0o8TH9CQd0snjAs1VUqeE6RklqlEM536OwMLXdjoTR47iUstXT5hWQS8KkGOk0iWHhlKVmXbMIw4GPOZhomv7+zgtM7TyhPDY8RH/f5E1/7hfNFzPg5MC4XjCZOjhOlnfNtUmkSk2nOtZh4AzRmZQ4Y1Yn2KU/diZ3DaIDjaMblmYkfj/UTzHirM+V++dvfsUaQ6S/kK52BvoFQfzFxZ4OK3UE5did2EaZE7kIb60W1k4SeQuq8wE2s43Om8FzxeS36TTU2WEuG/hrRarWYTgHP43wNauxzMIGnM7dpEFTN8WKJxKMqE8BDAgsGYeaPiv1CdV09LezQUWB77skmqU55ka+OXt8Al+SH2nOM4nMVaZauD/bq6DXmfdfLnbC3psZEQC3vVGHoCWDngofc0FqzX7ioPHCHKV4uts8vE59xvcfWAcqE2QhR7DZ1lHD1vQprHTcXCeASqcrieajw6a7EZR08EhQ1Io9UdROqvAaTnE0rSpewyL5h16Q46CZvW0hjdeUiEllW6ZCq7snCiQljGjwFrGClVv8xA2lcc84mFA4Rs0oKxLyu0DVZdwkXJWiBgQsbUaDBoQ5Fx/VbVDcJ+u0P3/vrI+qkXF3zUOgYMlaVRDXECXVyfli51alv1Ae9+L4eQNTdKBzD+1dL0EZJFHFKT7n0EtTZo+hEHcOM566qFxV4DofwIIcnG23/X/729xZcW50i64C5EXiWYZT+NRCSP9oRPAaiaihRAqouRNgf6D+smgAIHTHNaaGympHMzWn8NcX1m1ou+viCOr7BVOkMt61a3po4yFjjnQqGXM910rYqcb5wIYxtpZeH1KJ1+fADIB7TFgxkhCJXI83LRZvBm7gLtdIdmQeiezVBbQSt8QKvrDrVUAh5s32q7eq3qhYElVUFtyJloSuTdC+ccOfJga+LJt4EqfFcKH13C6tid6dKpnAq5Cmcg76Bed8KjUGf5BjsHEC2YQtIcttZcynAHHPwOzhp7U509UWHGO/HSHcF6CmcpuikIsKDG+Cx18Peej2252DxYtVU2p/L+PtaSH6gKGl6R4i8OlwnqjV7bvuanIR9p+aIs1qjQb3T9Y8oZQS5v2ygPULKJV6tQJYiGmvYcX12jxcJNEO48BlaL5qN17lSd2CDveD9IjhOfNWcggitM/A43hESRg+3H+Dk0KPPeK6IpbxmuXI5AgH1gq6HmNEWREuI50tunHBnC1138Mtf/9dQlJALdTO1tbvxKxmsPDfK3T3R7jVQdKD5pGueBpL2AUmbXJ1dEgk3voQksCBAnO5BNxcVYwyHpagq0qhopwlm/Zrv9Fdzvl7lSfXBPjs/6m/I0TgcDP6Z/aj3Br8dP+r+4DfkR32EwPpj7+ulyTbtdqPsCGfbVzd4r8AddOVKX10TD5PJReuCLzYhuGGH0dL917h+gxBvl3UOu53/i9o0h9felg1zISyMBgP8X3c1n3WCX9GyqVK0FOj2nn+J4pufnF+9BDW0YqOT+iq5PnsvRj9fpOej14jHLZbUlR14Qqx0jrfm4fa1V2/gpNG3cCtkLiScEopPM5WeajCno8HgdBi5hdnfhMY3qgCnAcwRmXP0XdWqkNULxqeoyyCN61vEKmh9Hfl9GGQbMBFo6HS/g4T760h4ISlRlC5rPFJnID/vTNvDWzc8gnpR5I0MiISrRN+jzmTb5W6SBtJKC7uIDo4vo4s9Xoo99/3g+N3yHWrjdqYw+KRUhiDmdhYdRP3VWBQD+pyiCo4vHfnWFGm4zDCAbk088lL0z4fJMFrGq202itMr6kO196FNjOVTIafXtXvXoOgNLqNbqQ6iGv2vFH8EVAD9OrRrxZFA8pkBR8sQMY/U8UMTwfM8rHGIstkUONOs5WooTIiE6QS3rG5rG8JVNkerDO+34kSOQ8gHRXHUQRyb4jLqqYdIizrQohU70QqdaKIhOsEQFN/QCm84bliijiQICvCQNMfR/j6pWA+HpIvce0Tb/P6DJRFxc3QYRd3jQUpsWj3k+rQzm+6Rze4c4p/oHGLlGMITT+NLd1GqHaewL+o6SQMV1k7Jjmdw1TG41Um3xUfnh1zxRdWAbHIBoetlo+fFt2pZ2RuYMiiWXZbEIE9kyXsDYsn9AbHko0FHp/XTb3poNFNSP2vtk1TMtoaJauQ7lKNCThQJYS876msWcY8kIb5miUCeqqK+r7HXa61z3arXq4Wro1X0gryqNCvVHPSkcpdgTnK4oLsfsRkU9K2JHgBe5GBMjlkfFqbke6H0MjxT8F7rlJd8LHKBSoBL8nJc0+gRJsHLLEP8wR3t8u7OIUfdoXYW4kXQQc+dK302wTiGGK+ExnxEdBeDnHGZOs+029HIw4qej+ZySWM1Qi0cbEpajaxScMmnxMRxmylYBjnKNMO0GuPBjVF55VjRcpEr7UIXaUIUGU1IfH5R4icyp3An0DBDwj735xMmdudDbrPyF0OP8SiuRFgEuo2sYpXMFd7hjEd6VY4pedYds6HV1oYRm1vNpUH12UdL+jWoEeaPDiBcq/nWAK7w90KeuVs099hxTVc/wtgIC90baVaZ8263zbfCfleN8ZZiZYRVetG0ngo7q8akdrQ7qX+4nr4NF4G3lIqbp3i+AYsUYvqHr1+Q1nqX/fLX/2HfA9eSzdTcUWtaacgXzZ3jdCM3rbxDW6100uEUSnLEeOqIz29AAYM/zrglb99LmKNb1bGUi6x+XY1zkbKjEJDS6x2wp2SatYJUOjdouNRGPDHkrHStcyHPEnYoF3TG0WxHWE7tOtOgLbB1fzrHqFp/F2wYM2kgIq+6gfwcTMt7C5lw57BaVVM3WhsYP7lupifO7TDL1hIn0YPfgON8jnQAyp3zES8635Br2Umk7EZvgMwoLdUcMFLOm/7jlfRP2gzXikLmaEBH7Lupl8Rxop9xXer8sisKcVfekr8XB+xeac9L4cnpOJAl61719OFk7fwVtL+TReV3UF6KjWdceLG4eTV5A/pcpMGM3sLRfarcj+IoFyl454nfvw6/ff09O7+XDKK4ZWbcgLn73794+vzlm+cIDApSh7BhMkgG5ONVxhZctkbqvhmwurW1kgB2LwzsXhjYvTCwe2Fg98LA7oWB3QsDuxcGdi8M7F4Y+GwXYO1eGNi9MLB7YWD3wsAt4mv3wsDuhYHdCwNf4OVLuxcGdi8M7F4Y2L0wsHthYPfCwO6Fgd0LA7sXBnYvDOxeGNi9MLB7YeDXI8/dCwO7FwZ2LwzsXhjYvTCwe2Fg98LAye6Fgd0LA7sXBnYvDOxeGNi9MLB7YWD3wsDuhYEbvzDQSuHrlzkXsnX/gMv1Pl55d+BdHM0wF/zgOLq8xFHeYqomFv9UUTLh8bs4OudaYJwhpZHHIe0ZcwbPAPMNn7og1L0jHD52rE15GivZ85i37VocEj1fWbedrv761ZujKI7CvamFyuieCj7HHEM+dzmYrUREKruMci6nFSUxRq7PpbvVa9ZN8z6jNG//RysTEpOaGwi7+d9uGvgvTmpjg8tLl0JOWcSuvvu0tYVHbKiNy/duuVz+H4tey7U=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,f={},j=[];function y(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:"name:"})," Unique identifier for this widget."]}),"\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",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\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 "hide_text_with_asterisks": false\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 "hide_text_with_asterisks": false\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 "hide_text_with_asterisks": false\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 "hide_text_with_asterisks": false\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:'"mm/dd/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",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\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 "hide_text_with_asterisks": false\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:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (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 "layout": "vertical",\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 "layout": "vertical"\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.jsxs)(n.ol,{start:"14",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the number (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",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,s.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Note:"})," Responses for prefill widgets are ",(0,s.jsx)(n.strong,{children:"required"}),"."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{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": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\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:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",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": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "name": "date",\n "response": "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:"response:"})," Enter the date you would like to display inside the date box."]}),"\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:'"mm/dd/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",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",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": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\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 checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\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:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",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": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\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:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\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 radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",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": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(a(),{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"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},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}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},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}}, {{note}}.",example:"

Hi {{receiver_name}},

We hope this email finds you well. {{sender_name}} has requested you to review and sign {{document_title}}.

Your signature is crucial to proceed with the next steps as it signifies your agreement and authorization.

Sign here

If you have any questions or need further clarification, please contact the sender.

Thanks,
Team OpenSign\u2122

"},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},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:"5,"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},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:100},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:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},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 b(e={}){const{wrapper:n}={...(0,r.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/9c9cb35e.43034981.js b/assets/js/9c9cb35e.43034981.js new file mode 100644 index 000000000..acf001414 --- /dev/null +++ b/assets/js/9c9cb35e.43034981.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4240],{19068:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>j,contentTitle:()=>g,default:()=>b,frontMatter:()=>m,metadata:()=>s,toc:()=>y});const s=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/createtemplate.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createtemplate","permalink":"/docs/API-docs/v1.1/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":"eJztPNtyHLdyv4JMpcrWntnh7oqUZKaSCm0rtnIcSWVRcSUkD42d6d2FOAOMAQyXa9ZWnYfzB3nK6/k0f0mqG8Bc9kJSEiXTqfWDzB3cGo3uRl/QfR1ZPjXR4Ul0DEWZcwsmOoujDEyqRWmFktFhdDwDFprZNxo4fmdHr18wnudqblhlQBtmFUuxEVhaGasK8Ssf58BsmDhm85lIZ8yAvgTGDRvnFZRaSGvYRGk2BQmaWyGnLFNpVQA2zIWdsVJDBhMhIWPG6iq1lQaTsLelksxUaQrGTKq8XsmBIZSMmZ0BAarBVloaxlklxS8VsF4v9D4XWa/H7IxblnLJxoDbyXA3HiBogTPm2KYkTWxKSMVEYGc/V3IqT+WxKA/Z2zJXPGMLVWn2+tt/q6fAefHbSa/3LYyrKXv7otc7+3JmbWkO9/Z4WSaqBGnEVOZ8bJJUFXsZdiyzySPEIGjAWQlW4EbkC8azjM1FNgVraMeSpapcsFQpnQnpUF/yKTBZFWPQJmZcZqxQGpiQjDMNPFv0repXBti/v3n1Eo+j4DZhr/PKxPVymdCQ2nzhpkcMhF194TDzZB/PR8hpzAp+gQcpLPulEukFbtuAJLT6MyFc9XpvqrJU2kLGfnJbOOz1sOVryNWccQ3UP1VFoSQrueYFWKI2PDBs1vBLJTRkjlR4ngdcHJ7KPuv1JC/gsNdjb93BiwykxVPTRHR2JowfkLj+dlFS/xcyEykijwDAr0xNul0Rqdj1jScE17WFaqQUR/SIwzl351/mPHXb0oA0ZMUldCe+itkCJ/4WpAoQzJQWvyppeU7HdwnaipTn7WNGAIkwLdfER6US0oavfgX2X/448bTpED0dImgZIrcQkloMsEueV2A8VPOYzRCqH6HUYIgf/LyIeJmxGYjpbOt6PHtXGduZmFUGwWxD4dcKp0roBULbhOcGmJh0cFnwC2itxhQJLZ4n7OsFy2DCq9zGTCCFWl1Bwl4qy3hZ5iIl6YQ0gMzGUab06ZQ9+SRd8nmt1aXIAEVIJiYT0MjM2EhT+DEBOqTLkgbg9ojT7IxLpuTKQacqV3qdhOhzF48sVdKCtAk7uuQiJ+DdZg0TMs2rDNg45+lFTHI1Zhoyx+gLQCkdO/6gLih8Hc4JP8xAjlSoJMIvlV9emEbCJewYGaXmP2wMqKZFhGlj1XP5ROHKiILAkgwKLvKYEBezd2rMrLA5xMjgJZeLmGXcQswsXNmxuopZOoP0gv7SPBOKjStrUbDjmplWZabm0uNyoqQ14tcNHBla3h+jo5jtx+xJzJ7FbDiI2XAUs+F+zIZPYjZ8FrPRIGajUcxG+zEbPXFgjZ55XPMawW0AhiOHZfvHwu5MZHCOA89xb+fcWNDCXKC4Zj/hnQMSgcvcnYsd62tSTPHmrm9AYdhMZBlINtGqYBpSUQqSJk4a1FPHCA/TuClp2KTK8wW7FEa0cFBPquYS8UYrCs1elSDfiKlkPE1VhWdMGHZIJXQ2Ry7zBYJ6DLwwtPPn0oIutTCAoloaf1P9IAzJNrxiTH1rzTu31jBhvV4tT/Dbzz//fCqvTyVjpxGKl9PokJ1GdZfTKHZteGtg29D/vsIfj0dP/c8F/nwyeuZ/zqnrcN//nOHP0fBULv2Cp3JEkFhelDdAgc33CoH/5dkIv9Gi+C1IdPyIojgODUitHXiwYdney2Pci5DCCp6b7dsJPR7QjhqQ1ja1j5siht2+I2p+QNtpw4MtdFG4JrpYWk1B5BEUo/rzNjGC3eiCX8PTQeJv4e1ocgA+GCy1wPlcSHqCSEKBf4wCfzum6jvhAaFrFabPhbOnCSlgdDNux5jv8IDw1YXoc2HrGWIL1YftqMLWB4SnFjjY4HUx1zbY7w8P+qPBaL+DK7R6XYei6GdZf7FYfBCeV7CH+pNfHtWlYEs4DQYdDKQIrRuKZMc1vbz2Sn8H4+o/0KQaB2sDMq8CtXwTwZZv20NWZXzxhXFThaG1Go39GyV60QKTmhAO8mukMyVSDzz2CcrzGE33BHHQJ0zuZdleC5P4Mcv6RdFf+Yg/+4T41seiSLIsWem5djruY8GyLGbrnzd+zzJWFMWWz+575/NeUazvIikKDxspiV8l5Fgi7Xo7n/gOn4tVGo7oLnwjG6FPCDXjWiBs5qOVq24mpG/wRMVWOmiYVjnXcIUeBCOUdL0/qyxb4cbAjI21Rr4J7x2CYCyxL195i+xRbRHJlQnwy+3j1nCAkxx5pynTMIUrVnJrQUua7JLnInM+1z59gCtelGjW7f3l9DT70z/ukVMJ/TbWWTOZmAr0Be795eSo/99nG3pUZQk65QZYDriSiRnYNGEnM8jLxh05n8+T+WOTzpTKnS/yndEwcf+eq/G7cwK3TLgpH23aqSOilhMHiWzVh2PAdjDGDQsjN7hx6EiJ24YDusG9DXvDFe57PKC7aQUkbHQeMWw+OY0KTuoQEj00fys7A30andVjnOMGslvGnt2BrZGLcj6GfL3p/Vky5wtVeUkQHJXdrXqKbuENGwoha18UbWcQtxr51Uqja1tu4G+HkDZ3hsspsGc4AZYLE7xxXXS2R3t3JTmdJbjwwBhYGMDGNZV+NBfUgN2NDYJvhs7uliWwH6OOtas4rHbLCp2DaSMG5yiEFEVV1D7vST1rQFnhtZQ2vnAkBo7CCu3TXVuBX92ygg/dbFngVA7JMxN8WjfosL7HA5IVKyDdzMYfIkU6N/o9qbu3M2DYVpsBN1zL2NVdyDXzme3cl7BXzp0XBqGrL02htOhl/VjWrEG+8w1FXri2b3U75bV7PSDq2wDWJ6ZA3+++b58PItL27v9AhNoB+87E6tysBZ/eYONT8wMiTw/PmrtiSO5Vd1/c4Dik9pu3Mxx0tnPQ3c6TwQfYYZ1lP94MG9QfG/uLYhhsbSG04Kucr4n6DFJR8Jwi0wT16CP470MMMg8Y0vc3qigr22Yo8jCQ0AgaQIi3uojRn2LWj1kvZnsx+zJmjxL2I1CENq2juV4hENrFbIVkmaow/JNWOl+wscaNxwySacKur3+puLTCLpZL1mPX1/gIZLlMkMMupJq7gO4JhqIswwcZjcGUqdRseMChUrOHltXeS5j3v/Uxqz0P2iP2pVph9xvNU4+C97VHtw37pEaa20yLtnCVl7UW5wxVenggTJnzBeMTpFsXnKZh7g1DgidzyEbsn/+FDUfJYBCzgfubfRnwMnqEjI+RutcaJiLPWy9KWPgUyAEj9JBD4V8x+LckqOVSVE9IqxDlIbzY641hojCih09aMDI+482bE6dmOoneiUrSQySl2YwbZ36TvY/7xTc7dgaFjy2+VBbc0wpTKmnA3UDlBqCbpxG93kpgMnRrgpNCho2jDBzen3dq9NWgLRSHTw46Mv6gKxUH26TiDc4plH0OFyFKAE1TSyaR1Azf19XSVTkTJkVkOxlZh6uJ2lWVZywXF9AmSiFNuOE9lKvPN76ZKWWaHv4Fhedrc9h9maE0Ps54lNRh2o91qw+fPu5cUc/uwVe44j3vHsZgf294sHej+3zF6fv+9gRjdzk58kvf6eSoZ3N0Ozf3h7q574fwH9+n7274dNRROR8PPp4B7slF12acW5xz9+GCuzdfWJvd7ugF+2zeqI+nvv1PYZeviOGnw3sQw1vM74+lxDUr+95oj92Xib2JAO9gY99oWH80gbaB/eREenA/9vhw0NHVvuqoal+N2kR5cHAnomwvukJZp5H4z69f/Tgf/Pm7qTo6Ojp6+ebt7Pnb6dHRUYG/kyTZ6IrZdNq0DOqw/m25v5fpjt+ySpIkiMKMW35Iw/dKOf0nNz7ePibxL2g+kX/44D6CtxvcwB8vBequn+ei2eTz/XR8/nEcyPx/pzKKI1VSaoqSL7LoMHJpLiHpI4rJfwPGfq2yRXR4HfmHxfinf7aLQ/feGUynuY5MOoOC41/BlMMEnInIcSp6LatNFEf0JgqzcZD6osNIjd9BaqMYY+slujXB4Bw07vA69HIJGFHs1fHoMHLUH8WRjxvXnxjIVOGbkTKbRMuw4E1T1V+aqQz9UWfA4DyYs/CB09DQ5UoC0gfN1J5h2aC1mYxrzRfRaq5TSFYI7xfcuPo1dr4Il4Sw6AKpX9BTtyiOhIWivcqWQ9Pq/TGdgsKd0BvM9x1Lx8KL914Tx5UzJT9ooH+o9iFD36nx+QeRIw72fpANZ33H03Gt6wt3SeUIn99DFrTifpNHEjN6yZzcRqmhP2GZT9trOm/d2prH2/KLWmkNZkamMC9L4DqhNJ8PzjijpD6epxXl1dViubOzGtR6Z8NlHF3dvpkrlqp+SF5iX+Ywse5hCkuVlqAftd/FPZjNjfb3l3G0uH17iz/k9p7i4c1v391PlPXVZMT9HrA+fraMo9ntsH5f56X9jsDuP1k2d+yKCnE+VtniPMit5W0dw2WG/TCr8oV8pTPQLUSMlcqByzVMvJg4R75iX6DF80XsnoNROpHQJlxkbI5uZw0pYGpiSOIhWcW8ruNyjZhPcMAgwHP8QGqaqcYGe8kwn3ETjoFZLaZTQNe570GDfcIUcEoPlv6RWhMLKDVcClWZAB760/F2yQG93C6ug01CTrtWWQs75LVv7z1pnw5+wcuVkpheHb++Ay7JZOy7DFKfWES7dHOwV8evMUlTTLz6l7C3psZEQC3vdGGojrFLwUMiVy3bF+4JDTi/p6LNdkINiU+P7LN1gDJhNkIUu/xtjKDVGdxrEzdZv3hEqrIYuhA+N81YKE0HjwRFjchjVd2FKm/BJGfTit42W2TZkLFJjxabJEshXWo42RtZpUNeqScL7Il54g2eAlawU2v+mIE0bjhnE4pdxpg0jpjXFVoX9ZRwVYIWGGXciAINDnXnld6or3Vx0M1YfPvjDz7Xu86g0zUPhYkhY1VJVEOcUGfShpNb3fqaooTcAfp8m2K4rnpQ7NS7QkrQRkk0l5Secil+dSRMGglaW2OY8dx19aICXeYID3J4F5gga3/7299bcG3VdNcBcyvwLMMntbdASCalI3jU9DWUKAFVFyKcD/S/rl4CCB0xzXmhspqRzN1p/DU9wjW1XPShwDoUaap0hoZFLW9NHGSs8WqlIRu1zrBUJe4XroSxrVzQkAewLh9+BMRj2oKB1BDkaqR5uWgzeBMiVSvTUT6l6OYR19fgGi/wyqpzDYWQd7un2l45q2pBUFlVcCtSFqYySTc73IV+Al8XTXAYqfFSKP1oC6vidOdKpnAu5Dlcgr6DgteKY/MFEredA8g2bAFJ7jprMnjnmDDbwUnrdqI89Q4xHsRIdwXoKZynaKYQ4cEd8Njr4Wy9Hus7WLxYNZX2rhVfXIHkB4qSZnaEyKdB11klzZ3brmmRsO/VHHEWszIHfFSOZrybH1HKCHKfGdxeIeUS86DJq4PJzzhxHWbDrN9mCRfppvOi3bxwVnjqPDs4CxYDwHXim/YURGidLsMxoT+sHlKVcXPoVmE8V8RSdrYpk5mAekG53DO6gugI0RXs1gkFFig3+be//q+hgL57l2IS3MLWVgr189wolyjenjVQdKD5hBxUayTt3w5sMnZv9ngEAeJ0DyozUozx7Ro9gCCNim4a1Tg9utbzJzO/b7KlfVx+Z0n/gUzN4WDw/9mSfjz441jS+4M/kCX9DIH1zvvbpck27Xaj7AjBiJsHvFPg/Ju50jf3RN/+Mq5DJ5sQ3LDDaOn+a4z/IMRvcQg4j0ETTPDGbNgMoWE0GOD/VoRgp2IWmjZ1Na188Q9RfPdIxs1n4D5j7OQmZH09G31vSlmkM6fuGNOV5BuG3LKBNt6EzIWE84CU89FgcH4QOXzvb0LOG1WAu9jnaE3NtcLCVl7DsXrB+BRVFFxe3yOuQOvbqOr9ILsJCfuDwfmwRsLBOhJeSErWoiJqx+oC5OfdaXt565ZHUK+KvGHtSLhO1B51Ntv+7jZpIK20sIvo8OQ6uurzUvRd++HJ2fIMqc7OFMb4SmUIYm5n0WG0txbyoyp2GFA6uY7IwI+CyDNcZviGZU3s8VLsXQ6TYbSMV8dsFJM39Ieq/75DjOVTIae3jTtrcPQGz9EdVQdTjV5Xij8DKnb+INq94kgg/cyAo8WHqEfy+LEJlD4PhxxCmJuiks1hrsYZQ5ixEzlcva42xAJbocCTEIej0FodWYuaDUV19CuKWvEs/NGKUOHPWuk9aci5Du8EnXRIytxof5+0nqdDUg8eP6Obd//J8swhv+XPpVyAtlPSvczpeNf8p663KYpWvDsdF8uqh2Wrt2OLs8MvuWLU14BssqXRht1owvpRLXNlAyrDDd1FJD5sQUQ+HhAi9weEyGeDjnLgt9/M0FzxdI/X1zjd1e2rGu/jMyRcISeKqN4fd11cCqUScc2aSgd5qoq6SlWvF4b89re/16N6vdqSdA5iNCdfVZqVag4aC1piMapJDldU8QqHQUFthmxfepTPixyMwbC0tDB11SrxUT06Z737L+UlH4tcoNh1D9vpWWtLcpsES3hRfsVCVV9ol21wCTlK69rr0qrLyeZKX0yw9mfMOBtjFgb63UDOuEydi8+JEHJVoQnZlNQyViPUwsGmpNU8tazgkk/J1xSzNrIyyAXKWabVGD3gRuWV8/FaLnKl3SNE2hC9EiEkPr8qsYn0UmRaDTMk7Evv6DWxc7Q76eDLYY4xplEiLALtb6tYJXOFlSsxNlLlmIhgXbwC1d82jDjcai4N6qwOlnAGNcK8DxZCMbG3BvCEfxDywtUO67OTmq5+grERFrp5+KvM+ag75jthv6/GWJtRGWGVXjSjp8LOqjHJ+fYk9Q8303eh2mlLit89seUNWKQQs3f0+gXpCY/Yb3/9H/YDcC3ZTM0dtaaVhnzRFFalOqR08g5t9TVPXn5eYTFTS0QqpyHwFDD404xbcpu8hDn6pxxLuZc/r6txLtK6aK3p9Q5d4dpWOdpu3rBL58DQC2elG50LeZGwI7kgZ3HjBcLvNK6zDQqcbCkUW5eHbSAi96SB/BJMyw0GmXABLa2qqVutDYzfXDe7Bfd2lGVrySLoCm3Acc4biiRx58XB8q4b8ks6ySPdMoMgM0rGMYcs03xim/njlZQXCi6tfQrZMgEdsZ+mVSEYMel3XH91Dq4VDaQrb8lxhguaTt1eXgpPTieBLFm3wMX7k7Uz/KTlKem/4QblpdgYLMByqubV5A3oS5GCV8e2cPQedd6L4igXKXgr1N9fR9+9/oFdPk4GUdzS6+7A3Hs/vPjm+cs3zxEYFKQOYcNkkAzIWaaMLbhsreT55LhRtFYeY9Xa/64w9K4w9K4w9K4w9K4w9K4w9EMuXbwrDL0rDL0rDL0rDL0rDP3JtrMrDL0rDL0rDP17F5XcFYbeFYbeFYZ+eBUzdoWhd4Whd4Whd4Whd4Whd4Whd4Whd4Whd4Whd4Whd4Whd4Whd4WhPx157gpD7wpD7wpD7wpD7wpD7wpD7wpD7wpD7wpD7wpD7wpD7wpD7wpD7wpD7wpD7wpD7wpD7wpD30Nh6FaC6l6Zc0EJ6L7gm8sdP1ktF30WRzNMLj88ia6vkQLf6ny5xM+/VJQre3IWR5dcC3yFSnnpcUijxpTYC8B02m/cE+X+Ma4fuwOnNKSVdHzMA3cjjggHN/Zt57+/fvXmOIqjsS9pXaiM6lnwOabQ8rlLMW7l2dK36yjnclpRjm7k5ly66l+zbtr4BaWN+z9aib6YXt1A2M0nd9vAf3FTGwdcX7uU9OWy7u+ato7wiA298fzOlsvl/wGWZFSg","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Template","permalink":"/docs/API-docs/v1.1/drafttemplate"},"next":{"title":"Public Template","permalink":"/docs/API-docs/v1.1/publictemplate"}}');var i=t(74848),r=t(28453),l=t(33617),o=t.n(l),d=t(17543),a=t.n(d),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),x=(t(18766),t(79329),t(9303));const m={id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPNtyHLdyv4JMpcrWntnh7oqUZKaSCm0rtnIcSWVRcSUkD42d6d2FOAOMAQyXa9ZWnYfzB3nK6/k0f0mqG8Bc9kJSEiXTqfWDzB3cGo3uRl/QfR1ZPjXR4Ul0DEWZcwsmOoujDEyqRWmFktFhdDwDFprZNxo4fmdHr18wnudqblhlQBtmFUuxEVhaGasK8Ssf58BsmDhm85lIZ8yAvgTGDRvnFZRaSGvYRGk2BQmaWyGnLFNpVQA2zIWdsVJDBhMhIWPG6iq1lQaTsLelksxUaQrGTKq8XsmBIZSMmZ0BAarBVloaxlklxS8VsF4v9D4XWa/H7IxblnLJxoDbyXA3HiBogTPm2KYkTWxKSMVEYGc/V3IqT+WxKA/Z2zJXPGMLVWn2+tt/q6fAefHbSa/3LYyrKXv7otc7+3JmbWkO9/Z4WSaqBGnEVOZ8bJJUFXsZdiyzySPEIGjAWQlW4EbkC8azjM1FNgVraMeSpapcsFQpnQnpUF/yKTBZFWPQJmZcZqxQGpiQjDMNPFv0repXBti/v3n1Eo+j4DZhr/PKxPVymdCQ2nzhpkcMhF194TDzZB/PR8hpzAp+gQcpLPulEukFbtuAJLT6MyFc9XpvqrJU2kLGfnJbOOz1sOVryNWccQ3UP1VFoSQrueYFWKI2PDBs1vBLJTRkjlR4ngdcHJ7KPuv1JC/gsNdjb93BiwykxVPTRHR2JowfkLj+dlFS/xcyEykijwDAr0xNul0Rqdj1jScE17WFaqQUR/SIwzl351/mPHXb0oA0ZMUldCe+itkCJ/4WpAoQzJQWvyppeU7HdwnaipTn7WNGAIkwLdfER6US0oavfgX2X/448bTpED0dImgZIrcQkloMsEueV2A8VPOYzRCqH6HUYIgf/LyIeJmxGYjpbOt6PHtXGduZmFUGwWxD4dcKp0roBULbhOcGmJh0cFnwC2itxhQJLZ4n7OsFy2DCq9zGTCCFWl1Bwl4qy3hZ5iIl6YQ0gMzGUab06ZQ9+SRd8nmt1aXIAEVIJiYT0MjM2EhT+DEBOqTLkgbg9ojT7IxLpuTKQacqV3qdhOhzF48sVdKCtAk7uuQiJ+DdZg0TMs2rDNg45+lFTHI1Zhoyx+gLQCkdO/6gLih8Hc4JP8xAjlSoJMIvlV9emEbCJewYGaXmP2wMqKZFhGlj1XP5ROHKiILAkgwKLvKYEBezd2rMrLA5xMjgJZeLmGXcQswsXNmxuopZOoP0gv7SPBOKjStrUbDjmplWZabm0uNyoqQ14tcNHBla3h+jo5jtx+xJzJ7FbDiI2XAUs+F+zIZPYjZ8FrPRIGajUcxG+zEbPXFgjZ55XPMawW0AhiOHZfvHwu5MZHCOA89xb+fcWNDCXKC4Zj/hnQMSgcvcnYsd62tSTPHmrm9AYdhMZBlINtGqYBpSUQqSJk4a1FPHCA/TuClp2KTK8wW7FEa0cFBPquYS8UYrCs1elSDfiKlkPE1VhWdMGHZIJXQ2Ry7zBYJ6DLwwtPPn0oIutTCAoloaf1P9IAzJNrxiTH1rzTu31jBhvV4tT/Dbzz//fCqvTyVjpxGKl9PokJ1GdZfTKHZteGtg29D/vsIfj0dP/c8F/nwyeuZ/zqnrcN//nOHP0fBULv2Cp3JEkFhelDdAgc33CoH/5dkIv9Gi+C1IdPyIojgODUitHXiwYdney2Pci5DCCp6b7dsJPR7QjhqQ1ja1j5siht2+I2p+QNtpw4MtdFG4JrpYWk1B5BEUo/rzNjGC3eiCX8PTQeJv4e1ocgA+GCy1wPlcSHqCSEKBf4wCfzum6jvhAaFrFabPhbOnCSlgdDNux5jv8IDw1YXoc2HrGWIL1YftqMLWB4SnFjjY4HUx1zbY7w8P+qPBaL+DK7R6XYei6GdZf7FYfBCeV7CH+pNfHtWlYEs4DQYdDKQIrRuKZMc1vbz2Sn8H4+o/0KQaB2sDMq8CtXwTwZZv20NWZXzxhXFThaG1Go39GyV60QKTmhAO8mukMyVSDzz2CcrzGE33BHHQJ0zuZdleC5P4Mcv6RdFf+Yg/+4T41seiSLIsWem5djruY8GyLGbrnzd+zzJWFMWWz+575/NeUazvIikKDxspiV8l5Fgi7Xo7n/gOn4tVGo7oLnwjG6FPCDXjWiBs5qOVq24mpG/wRMVWOmiYVjnXcIUeBCOUdL0/qyxb4cbAjI21Rr4J7x2CYCyxL195i+xRbRHJlQnwy+3j1nCAkxx5pynTMIUrVnJrQUua7JLnInM+1z59gCtelGjW7f3l9DT70z/ukVMJ/TbWWTOZmAr0Be795eSo/99nG3pUZQk65QZYDriSiRnYNGEnM8jLxh05n8+T+WOTzpTKnS/yndEwcf+eq/G7cwK3TLgpH23aqSOilhMHiWzVh2PAdjDGDQsjN7hx6EiJ24YDusG9DXvDFe57PKC7aQUkbHQeMWw+OY0KTuoQEj00fys7A30andVjnOMGslvGnt2BrZGLcj6GfL3p/Vky5wtVeUkQHJXdrXqKbuENGwoha18UbWcQtxr51Uqja1tu4G+HkDZ3hsspsGc4AZYLE7xxXXS2R3t3JTmdJbjwwBhYGMDGNZV+NBfUgN2NDYJvhs7uliWwH6OOtas4rHbLCp2DaSMG5yiEFEVV1D7vST1rQFnhtZQ2vnAkBo7CCu3TXVuBX92ygg/dbFngVA7JMxN8WjfosL7HA5IVKyDdzMYfIkU6N/o9qbu3M2DYVpsBN1zL2NVdyDXzme3cl7BXzp0XBqGrL02htOhl/VjWrEG+8w1FXri2b3U75bV7PSDq2wDWJ6ZA3+++b58PItL27v9AhNoB+87E6tysBZ/eYONT8wMiTw/PmrtiSO5Vd1/c4Dik9pu3Mxx0tnPQ3c6TwQfYYZ1lP94MG9QfG/uLYhhsbSG04Kucr4n6DFJR8Jwi0wT16CP470MMMg8Y0vc3qigr22Yo8jCQ0AgaQIi3uojRn2LWj1kvZnsx+zJmjxL2I1CENq2juV4hENrFbIVkmaow/JNWOl+wscaNxwySacKur3+puLTCLpZL1mPX1/gIZLlMkMMupJq7gO4JhqIswwcZjcGUqdRseMChUrOHltXeS5j3v/Uxqz0P2iP2pVph9xvNU4+C97VHtw37pEaa20yLtnCVl7UW5wxVenggTJnzBeMTpFsXnKZh7g1DgidzyEbsn/+FDUfJYBCzgfubfRnwMnqEjI+RutcaJiLPWy9KWPgUyAEj9JBD4V8x+LckqOVSVE9IqxDlIbzY641hojCih09aMDI+482bE6dmOoneiUrSQySl2YwbZ36TvY/7xTc7dgaFjy2+VBbc0wpTKmnA3UDlBqCbpxG93kpgMnRrgpNCho2jDBzen3dq9NWgLRSHTw46Mv6gKxUH26TiDc4plH0OFyFKAE1TSyaR1Azf19XSVTkTJkVkOxlZh6uJ2lWVZywXF9AmSiFNuOE9lKvPN76ZKWWaHv4Fhedrc9h9maE0Ps54lNRh2o91qw+fPu5cUc/uwVe44j3vHsZgf294sHej+3zF6fv+9gRjdzk58kvf6eSoZ3N0Ozf3h7q574fwH9+n7274dNRROR8PPp4B7slF12acW5xz9+GCuzdfWJvd7ugF+2zeqI+nvv1PYZeviOGnw3sQw1vM74+lxDUr+95oj92Xib2JAO9gY99oWH80gbaB/eREenA/9vhw0NHVvuqoal+N2kR5cHAnomwvukJZp5H4z69f/Tgf/Pm7qTo6Ojp6+ebt7Pnb6dHRUYG/kyTZ6IrZdNq0DOqw/m25v5fpjt+ySpIkiMKMW35Iw/dKOf0nNz7ePibxL2g+kX/44D6CtxvcwB8vBequn+ei2eTz/XR8/nEcyPx/pzKKI1VSaoqSL7LoMHJpLiHpI4rJfwPGfq2yRXR4HfmHxfinf7aLQ/feGUynuY5MOoOC41/BlMMEnInIcSp6LatNFEf0JgqzcZD6osNIjd9BaqMYY+slujXB4Bw07vA69HIJGFHs1fHoMHLUH8WRjxvXnxjIVOGbkTKbRMuw4E1T1V+aqQz9UWfA4DyYs/CB09DQ5UoC0gfN1J5h2aC1mYxrzRfRaq5TSFYI7xfcuPo1dr4Il4Sw6AKpX9BTtyiOhIWivcqWQ9Pq/TGdgsKd0BvM9x1Lx8KL914Tx5UzJT9ooH+o9iFD36nx+QeRIw72fpANZ33H03Gt6wt3SeUIn99DFrTifpNHEjN6yZzcRqmhP2GZT9trOm/d2prH2/KLWmkNZkamMC9L4DqhNJ8PzjijpD6epxXl1dViubOzGtR6Z8NlHF3dvpkrlqp+SF5iX+Ywse5hCkuVlqAftd/FPZjNjfb3l3G0uH17iz/k9p7i4c1v391PlPXVZMT9HrA+fraMo9ntsH5f56X9jsDuP1k2d+yKCnE+VtniPMit5W0dw2WG/TCr8oV8pTPQLUSMlcqByzVMvJg4R75iX6DF80XsnoNROpHQJlxkbI5uZw0pYGpiSOIhWcW8ruNyjZhPcMAgwHP8QGqaqcYGe8kwn3ETjoFZLaZTQNe570GDfcIUcEoPlv6RWhMLKDVcClWZAB760/F2yQG93C6ug01CTrtWWQs75LVv7z1pnw5+wcuVkpheHb++Ay7JZOy7DFKfWES7dHOwV8evMUlTTLz6l7C3psZEQC3vdGGojrFLwUMiVy3bF+4JDTi/p6LNdkINiU+P7LN1gDJhNkIUu/xtjKDVGdxrEzdZv3hEqrIYuhA+N81YKE0HjwRFjchjVd2FKm/BJGfTit42W2TZkLFJjxabJEshXWo42RtZpUNeqScL7Il54g2eAlawU2v+mIE0bjhnE4pdxpg0jpjXFVoX9ZRwVYIWGGXciAINDnXnld6or3Vx0M1YfPvjDz7Xu86g0zUPhYkhY1VJVEOcUGfShpNb3fqaooTcAfp8m2K4rnpQ7NS7QkrQRkk0l5Secil+dSRMGglaW2OY8dx19aICXeYID3J4F5gga3/7299bcG3VdNcBcyvwLMMntbdASCalI3jU9DWUKAFVFyKcD/S/rl4CCB0xzXmhspqRzN1p/DU9wjW1XPShwDoUaap0hoZFLW9NHGSs8WqlIRu1zrBUJe4XroSxrVzQkAewLh9+BMRj2oKB1BDkaqR5uWgzeBMiVSvTUT6l6OYR19fgGi/wyqpzDYWQd7un2l45q2pBUFlVcCtSFqYySTc73IV+Al8XTXAYqfFSKP1oC6vidOdKpnAu5Dlcgr6DgteKY/MFEredA8g2bAFJ7jprMnjnmDDbwUnrdqI89Q4xHsRIdwXoKZynaKYQ4cEd8Njr4Wy9Hus7WLxYNZX2rhVfXIHkB4qSZnaEyKdB11klzZ3brmmRsO/VHHEWszIHfFSOZrybH1HKCHKfGdxeIeUS86DJq4PJzzhxHWbDrN9mCRfppvOi3bxwVnjqPDs4CxYDwHXim/YURGidLsMxoT+sHlKVcXPoVmE8V8RSdrYpk5mAekG53DO6gugI0RXs1gkFFig3+be//q+hgL57l2IS3MLWVgr189wolyjenjVQdKD5hBxUayTt3w5sMnZv9ngEAeJ0DyozUozx7Ro9gCCNim4a1Tg9utbzJzO/b7KlfVx+Z0n/gUzN4WDw/9mSfjz441jS+4M/kCX9DIH1zvvbpck27Xaj7AjBiJsHvFPg/Ju50jf3RN/+Mq5DJ5sQ3LDDaOn+a4z/IMRvcQg4j0ETTPDGbNgMoWE0GOD/VoRgp2IWmjZ1Na188Q9RfPdIxs1n4D5j7OQmZH09G31vSlmkM6fuGNOV5BuG3LKBNt6EzIWE84CU89FgcH4QOXzvb0LOG1WAu9jnaE3NtcLCVl7DsXrB+BRVFFxe3yOuQOvbqOr9ILsJCfuDwfmwRsLBOhJeSErWoiJqx+oC5OfdaXt565ZHUK+KvGHtSLhO1B51Ntv+7jZpIK20sIvo8OQ6uurzUvRd++HJ2fIMqc7OFMb4SmUIYm5n0WG0txbyoyp2GFA6uY7IwI+CyDNcZviGZU3s8VLsXQ6TYbSMV8dsFJM39Ieq/75DjOVTIae3jTtrcPQGz9EdVQdTjV5Xij8DKnb+INq94kgg/cyAo8WHqEfy+LEJlD4PhxxCmJuiks1hrsYZQ5ixEzlcva42xAJbocCTEIej0FodWYuaDUV19CuKWvEs/NGKUOHPWuk9aci5Du8EnXRIytxof5+0nqdDUg8eP6Obd//J8swhv+XPpVyAtlPSvczpeNf8p663KYpWvDsdF8uqh2Wrt2OLs8MvuWLU14BssqXRht1owvpRLXNlAyrDDd1FJD5sQUQ+HhAi9weEyGeDjnLgt9/M0FzxdI/X1zjd1e2rGu/jMyRcISeKqN4fd11cCqUScc2aSgd5qoq6SlWvF4b89re/16N6vdqSdA5iNCdfVZqVag4aC1piMapJDldU8QqHQUFthmxfepTPixyMwbC0tDB11SrxUT06Z737L+UlH4tcoNh1D9vpWWtLcpsES3hRfsVCVV9ol21wCTlK69rr0qrLyeZKX0yw9mfMOBtjFgb63UDOuEydi8+JEHJVoQnZlNQyViPUwsGmpNU8tazgkk/J1xSzNrIyyAXKWabVGD3gRuWV8/FaLnKl3SNE2hC9EiEkPr8qsYn0UmRaDTMk7Evv6DWxc7Q76eDLYY4xplEiLALtb6tYJXOFlSsxNlLlmIhgXbwC1d82jDjcai4N6qwOlnAGNcK8DxZCMbG3BvCEfxDywtUO67OTmq5+grERFrp5+KvM+ag75jthv6/GWJtRGWGVXjSjp8LOqjHJ+fYk9Q8303eh2mlLit89seUNWKQQs3f0+gXpCY/Yb3/9H/YDcC3ZTM0dtaaVhnzRFFalOqR08g5t9TVPXn5eYTFTS0QqpyHwFDD404xbcpu8hDn6pxxLuZc/r6txLtK6aK3p9Q5d4dpWOdpu3rBL58DQC2elG50LeZGwI7kgZ3HjBcLvNK6zDQqcbCkUW5eHbSAi96SB/BJMyw0GmXABLa2qqVutDYzfXDe7Bfd2lGVrySLoCm3Acc4biiRx58XB8q4b8ks6ySPdMoMgM0rGMYcs03xim/njlZQXCi6tfQrZMgEdsZ+mVSEYMel3XH91Dq4VDaQrb8lxhguaTt1eXgpPTieBLFm3wMX7k7Uz/KTlKem/4QblpdgYLMByqubV5A3oS5GCV8e2cPQedd6L4igXKXgr1N9fR9+9/oFdPk4GUdzS6+7A3Hs/vPjm+cs3zxEYFKQOYcNkkAzIWaaMLbhsreT55LhRtFYeY9Xa/64w9K4w9K4w9K4w9K4w9K4w9EMuXbwrDL0rDL0rDL0rDL0rDP3JtrMrDL0rDL0rDP17F5XcFYbeFYbeFYZ+eBUzdoWhd4Whd4Whd4Whd4Whd4Whd4Whd4Whd4Whd4Whd4Whd4Whd4WhPx157gpD7wpD7wpD7wpD7wpD7wpD7wpD7wpD7wpD7wpD7wpD7wpD7wpD7wpD7wpD7wpD7wpD7wpD30Nh6FaC6l6Zc0EJ6L7gm8sdP1ktF30WRzNMLj88ia6vkQLf6ny5xM+/VJQre3IWR5dcC3yFSnnpcUijxpTYC8B02m/cE+X+Ma4fuwOnNKSVdHzMA3cjjggHN/Zt57+/fvXmOIqjsS9pXaiM6lnwOabQ8rlLMW7l2dK36yjnclpRjm7k5ly66l+zbtr4BaWN+z9aib6YXt1A2M0nd9vAf3FTGwdcX7uU9OWy7u+ato7wiA298fzOlsvl/wGWZFSg",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,j={},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,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(x.default,{as:"h1",className:"openapi__heading",children:"Create Template"}),"\n",(0,i.jsx)(o(),{method:"post",path:"/createtemplate",context:"endpoint"}),"\n",(0,i.jsxs)(n.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,i.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\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 "hide_text_with_asterisks": false\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 "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\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 "hide_text_with_asterisks": false\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:'"mm/dd/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",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\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 "hide_text_with_asterisks": false\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:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (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 "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"14",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,i.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the number (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",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,i.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Note:"})," Responses for prefill widgets are ",(0,i.jsx)(n.strong,{children:"required"}),"."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,i.jsxs)(n.ol,{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": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\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:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",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": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "name": "date",\n "response": "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:"response:"})," Enter the date you would like to display inside the date box."]}),"\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:'"mm/dd/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",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",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": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\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:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\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 radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",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": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsx)(x.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(a(),{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 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:""},company:{type:"string",format:"string",example:""},job_title:{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},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:"5,"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},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:100},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:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,i.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,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/9c9cb35e.886034c8.js b/assets/js/9c9cb35e.886034c8.js deleted file mode 100644 index aa1c9f731..000000000 --- a/assets/js/9c9cb35e.886034c8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4240],{19068:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>b,contentTitle:()=>g,default:()=>j,frontMatter:()=>x,metadata:()=>s,toc:()=>f});const s=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/createtemplate.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createtemplate","permalink":"/docs/API-docs/v1.1/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":"eJztPNtyHLdyv4JMpcrWntnh7oqUZKaSCm0rtnIcSWVRcSUkDw92pncX4gwwBjBcrllbdR7OH+Qpr+fT/CWpbgBz2QtJiZQPnVo/yNzBrdHobvQF3deR5VMTHZ5Ex1CUObdgorM4ysCkWpRWKBkdRsczYKGZfaOB43d29PYV43mu5oZVBrRhVrEUG4GllbGqEL/wcQ7MholjNp+JdMYM6Etg3LBxXkGphbSGTZRmU5CguRVyyjKVVgVgw1zYGSs1ZDAREjJmrK5SW2kwCXtfKslMlaZgzKTK65UcGELJmNkZEKAabKWlYZxVUvxcAev1Qu9zkfV6zM64ZSmXbAy4nQx34wGCFjhjjm1K0sSmhFRMBHb2cyWn8lQei/KQvS9zxTO2UJVmb7/9t3oKnBe/nfR638K4mrL3r3q9sy9n1pbmcG+Pl2WiSpBGTGXOxyZJVbGXYccymzxBDIIGnJVgBW5EvmA8y9hcZFOwhnYsWarKBUuV0pmQDvUlnwKTVTEGbWLGZcYKpYEJyTjTwLNF36p+ZYD9+7s3r/E4Cm4T9javTFwvlwkNqc0XbnrEQNjVFw4zz/bxfIScxqzgF3iQwrKfK5Fe4LYNSEKrPxPCVa/3ripLpS1k7Ce3hcNeD1u+hlzNGddA/VNVFEqykmtegCVqwwPDZg0/V0JD5kiF53nAxeGp7LNeT/ICDns99t4dvMhAWjw1TURnZ8L4AYnrbxcl9X8lM5Ei8ggA/MrUpNsVkYpd33lCcF1bqEZKcUSPOJxzd/5lzlO3LQ1IQ1ZcQnfiq5gtcOJvQaoAwUxp8YuSlud0fJegrUh53j5mBJAI03JNfFQqIW346ldg/+WPE0+bDtHTIYKWIXILIanFALvkeQXGQzWP2Qyh+hFKDYb4wc+LiJcZm4GYzraux7MPlbGdiVllEMw2FH6tcKqEXiC0TXhugIlJB5cFv4DWakyR0OJ5wr5esAwmvMptzARSqNUVJOy1soyXZS5Skk5IA8hsHGVKn07Zk0/SJZ+3Wl2KDFCEZGIyAY3MjI00hR8ToEO6LGkAbo84zc64ZEquHHSqcqXXSYg+d/HIUiUtSJuwo0sucgLebdYwIdO8yoCNc55exCRXY6Yhc4y+AJTSseMP6oLC1+Gc8MMM5EiFSiL8UvnlhWkkXMKOkVFq/sPGgGpaRJg2Vj2XTxSujCgILMmg4CKPCXEx+6DGzAqbQ4wMXnK5iFnGLcTMwpUdq6uYpTNIL+gvzTOh2LiyFgU7rplpVWZqLj0uJ0paI37ZwJGh5eMxOorZfsyexexFzIaDmA1HMRvux2z4LGbDFzEbDWI2GsVstB+z0TMH1uiFxzWvEdwGYDhyWLa/H+yinP5BGOJsFLCmltnzjsweJqzXq7kJv/35z38+ldenkrHTCJnrNDpkp1Hd5TSKXRvKTGwb+t9X+OPp6Ln/ucCfz0Yv/M85dR3u+58z/DkansqlX/BUjggSy4vyBiiw+UEh8L88EeE3WhS/BXmGH1EQxaEBz6oDDzYs23t5insRUljBc7N9O6HHI9pRA9LapvZxU0Su23dEzY9oO214sIXEpGsisdpqCgxPUIzWdn+Q+Jtl++bdso9m7y1w7rf1Z7h1FE3HKJq277+WXo8ICasw3Q8TzxNSAEgyb8eD7/CIsNCF6H44eIE4wEtpOwKw9RHtvgUONvgb3rUN9vvDg/5oMNrvYABtKdehKPpZ1l8sFg+BPdR5/PKo8gQN1Wl2aLZOtCo2mB9kHTS9vE5EfweV/T9QUR8HHRYytBO7Fm+wENtatlUZX3xh3FRhaK2cYf9GNVu0wKQmhIOs5XSmROqBxz5BJRujQZggDvqEyb0s22thEj9mWb8o+isf8WefEN/6WBRJliUrPddOx30sWJbFbP3zxu9Zxoqi2PLZfe983iuK9V0kReFhI+Xrq4TcFaSzbecT3+G3YpWGI7oL38hG6GlQMqe1yZzbzEcrl81MSN/giYqtdNAwrXKu4QrtUiOUdL0fnscCizWaPdmx3pMAQbFmX77x2vsTT/64he4E+OX2cWs7w0mOvIONaZjCFSu5taAlTXbJc5E5/1yfPsAVL0o0Afb+dHqa/eEf98gBgTa+ZXgSLBNTgX6jvT+dHPX/+2xDj6osQafcAMsBVzIxA5sm7GQGedm4rubzeTJ/atKZUrnzW30wGibu33M1/nBO4JYJN+WTTTt1pNEy+JF0Vu19A7aDMW5YGLnB5CcaIx4aDui29fbODdet7/GIbpwVkLDReU+w+eQ0KjgpJEjK0Pyt7Az0aXRWj3FGPmS3jD27A7PORAY5H0O+3nRnRqs/53yhKs/fwanV3aqn6BbesKEQsvZb0HYGcauRX600urblBv52CGlzZ7hyAnuGE2C5MMFz00Vne7R3bZGDUoJzJY+BhQFsXFPpvbmgBuxubOAkkT+7W5bAfow61m7FsNotK3QOpo0YnKMQUhRVUftHJ/WsAWWF1z3a+MKRGGQIK7RPd20FfnXLCt7Nv2WBUzkkP0bwf9ygmfoej0hWrIB0Mxt/ihTp3NMPdMHezoBhW20G3HAtY1d3IdfMZ7ZzX8Le4PWGPlk3CL1saQqlRY/cfVmzBvnONxT5rNp+uO2U1+71iKhvA1ifmQJ9v4e+fT6JSNu7/x0RagfsOxOrc0oWfHqD5U7Nj4g8PTxrToghOSPdfXGDQ47ab97OcNDZzkF3O88Gn2BddZa9v3E1qD82VtVLiTGHtYXQLq9yvibqM0hFwXOKYhLUo4/nvw0M5pdDqv1GFWVl22xC3gASBeFeDxE3F0H8Q8z6MevFbC9mX8bsScJ+BIrRpXU8z1/zQruonZAsUxWGU9JK5ws21ridmEEyTdj19c8Vl1bYxXLJeuz6Gp8BLJcJ8s2FVHMX0ju5FEZYhiH5xgzKVGo2hPBVavbQXtp7DfP+tz5svudBe8K+VCtMfKPR6VHwsVbmtmGf1fRym2lRDK7yutbNnPlJoWdhypwvGJ8gNbrwJA1zUewET+aQjdg//wsbjpLBIGYD9zf7MuBl9ATZGaNVbzVMRJ633hSw8CmQA8ZoIYfCx7H9awLUXSmyJaRViPLwbqPXG8NEYVQLHzVgbHTGm1cHTnl0crr9MMI9RVGazbhxRjVZ8bhffLVhZ1D4+NprZcEF102ppAF3r5QbgG6C473eSnAudGsCdEKGjaNkGz6cJ2n01aAt6obPDjqS+6Ar6wbbZN0NjiSUaA4XwfsOTVNL0pAsDN/XxcyqnAmTIrKd5AtE7ahdVXnGcnEBbaIU0oR720O5GsD/ZqaUaXr4GLrna3PYjc0rjeH5J0kdqryvC3z4/Gnn4nnxAH69FU939zAG+3vDg70bXd0rDtqPvx8Yu8vJkQ/5TidHPZuj27mkP9Ul/TCE//QhPXLD56OOIvl0cH8GeCDHW5txbnG5PYRj7cE8XG12u6Nv6zfzMd2f+vY/h7W9IoafDx9ADG8xqu9LiWu284PRHnsow3kTAd7Bcr7RXL43gbaB/exEevAwVvZw0NHVvuqoal+N2kR5cHAnomwvukJZp5H4z6/f/Dgf/PG7qTo6Ojp6/e797OX76dHRUYG/kyTZ6GDZdNq0DOqw/nWxv5fpjt+ySpIkiMKMW35Iw/dKOf0nNz7ePibxL1M+k9f34CECrRucu/eXAnXX3+ai2eTJ/Xx8fj8OZP6/UxnFkSopOUHJV1l0GLlEh/DsP4rJKwPGfq2yRXR4Hfmnpfinf7iJQ/c+GEyouI5MOoOC41/BlMMUjInIcSp0HIA2URzRWyPMx0Dqiw4jNf4AqY1ijIOX6KwEg3PQuMPr0Ms9wY9ir45Hh5Gj/iiOfDS4/sRApgrfd5TZJFqGBW+aqv7STGXojzoHAufBV+ufOA0NXa6koHzSTO0Zlg1am8m41nwRrWa7hOfq4a2BG1e/x80X4ZIQFl0g9Rtq6hbFkbBQtFfZcmhafTymU1C4E3qH+LFj6Vh48dFr4rhypuQnDfRPxT5l6Ac1Pv8kcsTB3g+y4azveDqudX3hLqkc4QNsyIJW3G8yCWJGr3mT2yg19Ccs82l7TeetW1vzeFuGSethu5mRKczLErhOKNHjk3OOKK2L52lFmVW1WO7srAa13tlwGUdXt2/miqWqH9JX2Jc5TKx7bsJSpSXoJ+03bI9mc6P9/WUcLW7f3uJ3ub3neHjz23f3E+X9NDlRfw9Yn75YxtHsdli/rzOT/o7A7j9bNnfsigpxPlbZ4jzIreVtHcNlhv0wr+6VfKMz0C1EjJXKgcs1TLyaOEe+Yl+gxfNF7B55UUKJ0CZcZGyObmcNKWByGr39DLKKeV3HZZsw/8gfgwAv8QOpaaYaG+wlw3zGTTgGZrWYTgFd574HDfYpM8ApQVT6p2dNLKDUcClUZQJ46E/H2yUH9HK7uA42CTntWmUt7JDXvr33pH06+AUvV4k5Nm+O394Bl2Qy9l0OodMP3C7dHOzN8VtM0xMTr/4l7L2pMRFQyztdGKpj7FLwkMpTy/aFexgDzu+paLOdUEPiE+T6bB2gTJiNEMUugxcjaHUO79rETd4nHpGqLIYuhM9OMhZK08EjQVEj8lhVd6HKWzDJ2bSid8gWWTbk7NFTxCbNTkiXHEz2RlbpkFnoyQJ7YqZwg6eAFezUmj9mII0bztmEGws6xrRhxLyu0Lqop4SrErTAKONGFGhwqDuv9EZ9rYuDbs7a+x9/8Nm+YQ+BKcfIgW5iyFhVEtUQJ9S5lOHkVre+pighd4A+36YYrqseFDv1rpAStFESzSWlp1yKXxwJk0aC1tYYZjx3Xb2oQJc5woMc3gUmyNpf//q3FlxbNd11wNwKPMvwoewtEJJJ6QgeNX0NJUpA1YUI5wP9r6uXAEJHTHNeqKxmJHN3Gn9LT2tNLRd9KLAORZoqnaFhUctbEwcZa7xaachGJUOWYokl7heuhLGtbMDwZn9dPvwIiMe0BQOpIcjVSPNy0WbwJkSqVqajnEXRzSStr8E1XuCVVecaCiHvdk+1vXJW1YKgsqrgVqQsTGWSbn6wC/0Evi6a4DBS46VQ+skWVsXpzpVM4VzIc7gEfQcFrxXH5gskbjsHkG3YApLcddbkcM4xTb+Dk9btRJnKHWI8iJHuCtBTOE/RTCHCgzvgsdfD2Xo91neweLFqKu1dKz69nuQHipJmdoTIJ8LWGSDNnduuapCw79UccRazMgd8Ko5mvJsfUcoI8szVY2ivkHKJmbDk1cH0V5y4DrMVnB5p+CVcpJvOi3bzylnhqfPs4CyYDo7rxDftKYjQOrWFY0p3WN1xhNsculUYzxWxlJ01cjjrAvWKsnlndAXREaIr2K0TUuzVXIL+9S//ayig796lmAS3sLWVQv08N8qlCrdnDRQdaD4hB9UaSfu3A5uM3Zs9HkGAON2DCk0UY3yRRg8gSKOim0Y1To+u9fzZzO+bbGkfl99Z0r8jU3M4GPx/tqSfDn4/lvT+4HdkSb9AYL3z/nZpsk273Sg7QjDi5gEfFDj/Zq70zT3Rt7+M69DJJgQ37DBauv8a4z8I8VscAs5j0AQTvDEbNkNoGA0G+L8VIdipmYSmTV1PKV/8QxTfPZJx8xm4zxg7uQlZX89G35tSFunMqTvGdCX5hiG3bKCNNyFzIeE8IOV8NBicH0QO3/ubkPNOFeAu9jlaU3OtsLSR13CsXjA+RRUFl9cPiCvQ+jaq+jjIbkLC/mBwPqyRcLCOhFeSUrCojNaxugD52+60vbx1yyOoV0XesHYkXCdqjzqbbX93mzSQVlrYRXR4ch1d9Xkp+q798ORseYZUZ2cKY3ylMgQxt7PoMNpbC/lRHTMMKJ1cR2TgR0HkGS4zfMOyJvZ4KfYuh8kwWsarYzaKyRv6Q9X/2CHG8qmQ09vGnTU4eofn6I6qg6lGryvFHwEVO38Q7V5xJJB+ZsDR4kPUI3n82ARKX4ZDDiHMTVHJ5jBX44whzNiJHK5eVxtiga1Q4EmIw1ForY6sRc2Gojr6FUWteBb+aEWo8Get9J405FyHd4JOOiRlbrS/T1rP8yGpB09f0M27/2x55pDf8ufSC/+2U9K9zOl41/ynrrcpila8Ox0Xy6qHZau3Y4uzwy+5YtTXgGyypdGG3WjC+lEtc2UDKsMN3UUkPmxBRD4dECL3B4TIF4OOcuC338zQXPF0j9fXON3V7asa7+MzJFwhJ4qo3h/3mxLkO/STolQirllT6SBPVVHXaur1wpBf//q3elSvV1uSzkGM5uSbSrNSzUFjSUMsxDTJ4UqgzwCHQUFthmxfepTPixyMwbC0tDB19QrxUT06Z737L+UlH4tcoNh1D9vpWWtLcpuE/TQDyq9YqOoL7bINLiFHaV17XVqVGdlc6YsJVn+MGWdjzMJAvxvIGZepc/E5EUKuKjQh0X1aamGwPJ1GqIWDTUmreWpZwSWfkq8pZm1kZZALlLNMqzF6wI3KK+fjtVzkSrtHiLQheiVCSHx5VWIT6aXItBpmSNiX3tFrYudod9LBF0QcY0yjRFgE2t9WsUrmCmsXYmykyjERwbp4Baq/bRhxuNVcGtRZHSzhDGqEeR8sGO/JeG8AT/gHIS9c/aw+O6np6icYG2Ghm12/ypxPumO+E/b7aozV+ZQRVulFM3oq7Kwak5xvT1L/cDN9F+pdtqT43RNb3oFFCjF7R29fkZ7whP36l/9hPwDXks3U3FFrWmnIF01pTapESSfv0FZf8+Tl5xWWs7REpHIaAk8Bgz/NuCW3yWuYo3/KsZR7+fO2GucircuWml7v0JUubRUk7WYDu3QODL1wVrrRuZAXCTuSC3IWN14g/E7jOtugwMmWUqF1gdAGInJPGsgvwbTcYJAJF9DSqpq61drA+M11s1twb0dZtpYsgq7QBhznvKFIEndeHCzwuSG/pJM80i00BzKjZBxzyDLNJ7aZP15JeaHg0tqnkC0T0BH7aVo1YhGTfsf1V+fgWtFAuvKWHGe4oOlUbuWl8OR0EsiSdctWfDxZO8NPWp6S/htuUF6KjcECLKhp3kzegb4UKXh1bAtH71HnvSiOcpGCt0L9/XX03dsf2OXTZBDFLb3uDsy998Orb16+fvcSgUFB6hA2TAbJgJxlytiCy9ZKnk+OG0Vr5TFWrf3vSgPvSgPvSgPvSgPvSgPvSgM/1uK1u9LAu9LAu9LAu9LAu9LAu9LAnw8Ju9LAu9LAu9LAu9LAu9LAu9LAu9LAu9LAu9LAu9LAu9LAu9LAj0dW7EoDP5aKq7vSwL8FBe5KA+9KA+9KA+9KA+9KA+9KA+9KA+9KA+9KA+9KA+9KA+9KA+9KA+9KA+9KA+9KA+9KA5/uSgPvSgPvSgPfuzRwK0Vxr8y5oBRkX/LLZQ+frBYMPoujGaYXH55E19dIge91vlzi558rypY8OYujS64FvuqkzOQ4JNJiUuQFYELlN+6Rav8Y14/dgVMiykpCNmYCuxFHhIMb+7YzoN++eXccxdHYFzUuVEYVDfgckyj53CWZtjIt6dt1lHM5rShLM3JzLl39p1k3cfiCEof9H61UT0ywbSDsZhS7beC/uKmNA66vXVLycln3d01bR3jEht54fmfL5fL/AN7d5JQ=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Template","permalink":"/docs/API-docs/v1.1/drafttemplate"},"next":{"title":"Public Template","permalink":"/docs/API-docs/v1.1/publictemplate"}}');var r=t(74848),i=t(28453),l=t(33617),o=t.n(l),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:"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:"eJztPNtyHLdyv4JMpcrWntnh7oqUZKaSCm0rtnIcSWVRcSUkDw92pncX4gwwBjBcrllbdR7OH+Qpr+fT/CWpbgBz2QtJiZQPnVo/yNzBrdHobvQF3deR5VMTHZ5Ex1CUObdgorM4ysCkWpRWKBkdRsczYKGZfaOB43d29PYV43mu5oZVBrRhVrEUG4GllbGqEL/wcQ7MholjNp+JdMYM6Etg3LBxXkGphbSGTZRmU5CguRVyyjKVVgVgw1zYGSs1ZDAREjJmrK5SW2kwCXtfKslMlaZgzKTK65UcGELJmNkZEKAabKWlYZxVUvxcAev1Qu9zkfV6zM64ZSmXbAy4nQx34wGCFjhjjm1K0sSmhFRMBHb2cyWn8lQei/KQvS9zxTO2UJVmb7/9t3oKnBe/nfR638K4mrL3r3q9sy9n1pbmcG+Pl2WiSpBGTGXOxyZJVbGXYccymzxBDIIGnJVgBW5EvmA8y9hcZFOwhnYsWarKBUuV0pmQDvUlnwKTVTEGbWLGZcYKpYEJyTjTwLNF36p+ZYD9+7s3r/E4Cm4T9javTFwvlwkNqc0XbnrEQNjVFw4zz/bxfIScxqzgF3iQwrKfK5Fe4LYNSEKrPxPCVa/3ripLpS1k7Ce3hcNeD1u+hlzNGddA/VNVFEqykmtegCVqwwPDZg0/V0JD5kiF53nAxeGp7LNeT/ICDns99t4dvMhAWjw1TURnZ8L4AYnrbxcl9X8lM5Ei8ggA/MrUpNsVkYpd33lCcF1bqEZKcUSPOJxzd/5lzlO3LQ1IQ1ZcQnfiq5gtcOJvQaoAwUxp8YuSlud0fJegrUh53j5mBJAI03JNfFQqIW346ldg/+WPE0+bDtHTIYKWIXILIanFALvkeQXGQzWP2Qyh+hFKDYb4wc+LiJcZm4GYzraux7MPlbGdiVllEMw2FH6tcKqEXiC0TXhugIlJB5cFv4DWakyR0OJ5wr5esAwmvMptzARSqNUVJOy1soyXZS5Skk5IA8hsHGVKn07Zk0/SJZ+3Wl2KDFCEZGIyAY3MjI00hR8ToEO6LGkAbo84zc64ZEquHHSqcqXXSYg+d/HIUiUtSJuwo0sucgLebdYwIdO8yoCNc55exCRXY6Yhc4y+AJTSseMP6oLC1+Gc8MMM5EiFSiL8UvnlhWkkXMKOkVFq/sPGgGpaRJg2Vj2XTxSujCgILMmg4CKPCXEx+6DGzAqbQ4wMXnK5iFnGLcTMwpUdq6uYpTNIL+gvzTOh2LiyFgU7rplpVWZqLj0uJ0paI37ZwJGh5eMxOorZfsyexexFzIaDmA1HMRvux2z4LGbDFzEbDWI2GsVstB+z0TMH1uiFxzWvEdwGYDhyWLa/H+yinP5BGOJsFLCmltnzjsweJqzXq7kJv/35z38+ldenkrHTCJnrNDpkp1Hd5TSKXRvKTGwb+t9X+OPp6Ln/ucCfz0Yv/M85dR3u+58z/DkansqlX/BUjggSy4vyBiiw+UEh8L88EeE3WhS/BXmGH1EQxaEBz6oDDzYs23t5insRUljBc7N9O6HHI9pRA9LapvZxU0Su23dEzY9oO214sIXEpGsisdpqCgxPUIzWdn+Q+Jtl++bdso9m7y1w7rf1Z7h1FE3HKJq277+WXo8ICasw3Q8TzxNSAEgyb8eD7/CIsNCF6H44eIE4wEtpOwKw9RHtvgUONvgb3rUN9vvDg/5oMNrvYABtKdehKPpZ1l8sFg+BPdR5/PKo8gQN1Wl2aLZOtCo2mB9kHTS9vE5EfweV/T9QUR8HHRYytBO7Fm+wENtatlUZX3xh3FRhaK2cYf9GNVu0wKQmhIOs5XSmROqBxz5BJRujQZggDvqEyb0s22thEj9mWb8o+isf8WefEN/6WBRJliUrPddOx30sWJbFbP3zxu9Zxoqi2PLZfe983iuK9V0kReFhI+Xrq4TcFaSzbecT3+G3YpWGI7oL38hG6GlQMqe1yZzbzEcrl81MSN/giYqtdNAwrXKu4QrtUiOUdL0fnscCizWaPdmx3pMAQbFmX77x2vsTT/64he4E+OX2cWs7w0mOvIONaZjCFSu5taAlTXbJc5E5/1yfPsAVL0o0Afb+dHqa/eEf98gBgTa+ZXgSLBNTgX6jvT+dHPX/+2xDj6osQafcAMsBVzIxA5sm7GQGedm4rubzeTJ/atKZUrnzW30wGibu33M1/nBO4JYJN+WTTTt1pNEy+JF0Vu19A7aDMW5YGLnB5CcaIx4aDui29fbODdet7/GIbpwVkLDReU+w+eQ0KjgpJEjK0Pyt7Az0aXRWj3FGPmS3jD27A7PORAY5H0O+3nRnRqs/53yhKs/fwanV3aqn6BbesKEQsvZb0HYGcauRX600urblBv52CGlzZ7hyAnuGE2C5MMFz00Vne7R3bZGDUoJzJY+BhQFsXFPpvbmgBuxubOAkkT+7W5bAfow61m7FsNotK3QOpo0YnKMQUhRVUftHJ/WsAWWF1z3a+MKRGGQIK7RPd20FfnXLCt7Nv2WBUzkkP0bwf9ygmfoej0hWrIB0Mxt/ihTp3NMPdMHezoBhW20G3HAtY1d3IdfMZ7ZzX8Le4PWGPlk3CL1saQqlRY/cfVmzBvnONxT5rNp+uO2U1+71iKhvA1ifmQJ9v4e+fT6JSNu7/x0RagfsOxOrc0oWfHqD5U7Nj4g8PTxrToghOSPdfXGDQ47ab97OcNDZzkF3O88Gn2BddZa9v3E1qD82VtVLiTGHtYXQLq9yvibqM0hFwXOKYhLUo4/nvw0M5pdDqv1GFWVl22xC3gASBeFeDxE3F0H8Q8z6MevFbC9mX8bsScJ+BIrRpXU8z1/zQruonZAsUxWGU9JK5ws21ridmEEyTdj19c8Vl1bYxXLJeuz6Gp8BLJcJ8s2FVHMX0ju5FEZYhiH5xgzKVGo2hPBVavbQXtp7DfP+tz5svudBe8K+VCtMfKPR6VHwsVbmtmGf1fRym2lRDK7yutbNnPlJoWdhypwvGJ8gNbrwJA1zUewET+aQjdg//wsbjpLBIGYD9zf7MuBl9ATZGaNVbzVMRJ633hSw8CmQA8ZoIYfCx7H9awLUXSmyJaRViPLwbqPXG8NEYVQLHzVgbHTGm1cHTnl0crr9MMI9RVGazbhxRjVZ8bhffLVhZ1D4+NprZcEF102ppAF3r5QbgG6C473eSnAudGsCdEKGjaNkGz6cJ2n01aAt6obPDjqS+6Ar6wbbZN0NjiSUaA4XwfsOTVNL0pAsDN/XxcyqnAmTIrKd5AtE7ahdVXnGcnEBbaIU0oR720O5GsD/ZqaUaXr4GLrna3PYjc0rjeH5J0kdqryvC3z4/Gnn4nnxAH69FU939zAG+3vDg70bXd0rDtqPvx8Yu8vJkQ/5TidHPZuj27mkP9Ul/TCE//QhPXLD56OOIvl0cH8GeCDHW5txbnG5PYRj7cE8XG12u6Nv6zfzMd2f+vY/h7W9IoafDx9ADG8xqu9LiWu284PRHnsow3kTAd7Bcr7RXL43gbaB/exEevAwVvZw0NHVvuqoal+N2kR5cHAnomwvukJZp5H4z6/f/Dgf/PG7qTo6Ojp6/e797OX76dHRUYG/kyTZ6GDZdNq0DOqw/nWxv5fpjt+ySpIkiMKMW35Iw/dKOf0nNz7ePibxL1M+k9f34CECrRucu/eXAnXX3+ai2eTJ/Xx8fj8OZP6/UxnFkSopOUHJV1l0GLlEh/DsP4rJKwPGfq2yRXR4Hfmnpfinf7iJQ/c+GEyouI5MOoOC41/BlMMUjInIcSp0HIA2URzRWyPMx0Dqiw4jNf4AqY1ijIOX6KwEg3PQuMPr0Ms9wY9ir45Hh5Gj/iiOfDS4/sRApgrfd5TZJFqGBW+aqv7STGXojzoHAufBV+ufOA0NXa6koHzSTO0Zlg1am8m41nwRrWa7hOfq4a2BG1e/x80X4ZIQFl0g9Rtq6hbFkbBQtFfZcmhafTymU1C4E3qH+LFj6Vh48dFr4rhypuQnDfRPxT5l6Ac1Pv8kcsTB3g+y4azveDqudX3hLqkc4QNsyIJW3G8yCWJGr3mT2yg19Ccs82l7TeetW1vzeFuGSethu5mRKczLErhOKNHjk3OOKK2L52lFmVW1WO7srAa13tlwGUdXt2/miqWqH9JX2Jc5TKx7bsJSpSXoJ+03bI9mc6P9/WUcLW7f3uJ3ub3neHjz23f3E+X9NDlRfw9Yn75YxtHsdli/rzOT/o7A7j9bNnfsigpxPlbZ4jzIreVtHcNlhv0wr+6VfKMz0C1EjJXKgcs1TLyaOEe+Yl+gxfNF7B55UUKJ0CZcZGyObmcNKWByGr39DLKKeV3HZZsw/8gfgwAv8QOpaaYaG+wlw3zGTTgGZrWYTgFd574HDfYpM8ApQVT6p2dNLKDUcClUZQJ46E/H2yUH9HK7uA42CTntWmUt7JDXvr33pH06+AUvV4k5Nm+O394Bl2Qy9l0OodMP3C7dHOzN8VtM0xMTr/4l7L2pMRFQyztdGKpj7FLwkMpTy/aFexgDzu+paLOdUEPiE+T6bB2gTJiNEMUugxcjaHUO79rETd4nHpGqLIYuhM9OMhZK08EjQVEj8lhVd6HKWzDJ2bSid8gWWTbk7NFTxCbNTkiXHEz2RlbpkFnoyQJ7YqZwg6eAFezUmj9mII0bztmEGws6xrRhxLyu0Lqop4SrErTAKONGFGhwqDuv9EZ9rYuDbs7a+x9/8Nm+YQ+BKcfIgW5iyFhVEtUQJ9S5lOHkVre+pighd4A+36YYrqseFDv1rpAStFESzSWlp1yKXxwJk0aC1tYYZjx3Xb2oQJc5woMc3gUmyNpf//q3FlxbNd11wNwKPMvwoewtEJJJ6QgeNX0NJUpA1YUI5wP9r6uXAEJHTHNeqKxmJHN3Gn9LT2tNLRd9KLAORZoqnaFhUctbEwcZa7xaachGJUOWYokl7heuhLGtbMDwZn9dPvwIiMe0BQOpIcjVSPNy0WbwJkSqVqajnEXRzSStr8E1XuCVVecaCiHvdk+1vXJW1YKgsqrgVqQsTGWSbn6wC/0Evi6a4DBS46VQ+skWVsXpzpVM4VzIc7gEfQcFrxXH5gskbjsHkG3YApLcddbkcM4xTb+Dk9btRJnKHWI8iJHuCtBTOE/RTCHCgzvgsdfD2Xo91neweLFqKu1dKz69nuQHipJmdoTIJ8LWGSDNnduuapCw79UccRazMgd8Ko5mvJsfUcoI8szVY2ivkHKJmbDk1cH0V5y4DrMVnB5p+CVcpJvOi3bzylnhqfPs4CyYDo7rxDftKYjQOrWFY0p3WN1xhNsculUYzxWxlJ01cjjrAvWKsnlndAXREaIr2K0TUuzVXIL+9S//ayig796lmAS3sLWVQv08N8qlCrdnDRQdaD4hB9UaSfu3A5uM3Zs9HkGAON2DCk0UY3yRRg8gSKOim0Y1To+u9fzZzO+bbGkfl99Z0r8jU3M4GPx/tqSfDn4/lvT+4HdkSb9AYL3z/nZpsk273Sg7QjDi5gEfFDj/Zq70zT3Rt7+M69DJJgQ37DBauv8a4z8I8VscAs5j0AQTvDEbNkNoGA0G+L8VIdipmYSmTV1PKV/8QxTfPZJx8xm4zxg7uQlZX89G35tSFunMqTvGdCX5hiG3bKCNNyFzIeE8IOV8NBicH0QO3/ubkPNOFeAu9jlaU3OtsLSR13CsXjA+RRUFl9cPiCvQ+jaq+jjIbkLC/mBwPqyRcLCOhFeSUrCojNaxugD52+60vbx1yyOoV0XesHYkXCdqjzqbbX93mzSQVlrYRXR4ch1d9Xkp+q798ORseYZUZ2cKY3ylMgQxt7PoMNpbC/lRHTMMKJ1cR2TgR0HkGS4zfMOyJvZ4KfYuh8kwWsarYzaKyRv6Q9X/2CHG8qmQ09vGnTU4eofn6I6qg6lGryvFHwEVO38Q7V5xJJB+ZsDR4kPUI3n82ARKX4ZDDiHMTVHJ5jBX44whzNiJHK5eVxtiga1Q4EmIw1ForY6sRc2Gojr6FUWteBb+aEWo8Get9J405FyHd4JOOiRlbrS/T1rP8yGpB09f0M27/2x55pDf8ufSC/+2U9K9zOl41/ynrrcpila8Ox0Xy6qHZau3Y4uzwy+5YtTXgGyypdGG3WjC+lEtc2UDKsMN3UUkPmxBRD4dECL3B4TIF4OOcuC338zQXPF0j9fXON3V7asa7+MzJFwhJ4qo3h/3mxLkO/STolQirllT6SBPVVHXaur1wpBf//q3elSvV1uSzkGM5uSbSrNSzUFjSUMsxDTJ4UqgzwCHQUFthmxfepTPixyMwbC0tDB19QrxUT06Z737L+UlH4tcoNh1D9vpWWtLcpuE/TQDyq9YqOoL7bINLiFHaV17XVqVGdlc6YsJVn+MGWdjzMJAvxvIGZepc/E5EUKuKjQh0X1aamGwPJ1GqIWDTUmreWpZwSWfkq8pZm1kZZALlLNMqzF6wI3KK+fjtVzkSrtHiLQheiVCSHx5VWIT6aXItBpmSNiX3tFrYudod9LBF0QcY0yjRFgE2t9WsUrmCmsXYmykyjERwbp4Baq/bRhxuNVcGtRZHSzhDGqEeR8sGO/JeG8AT/gHIS9c/aw+O6np6icYG2Ghm12/ypxPumO+E/b7aozV+ZQRVulFM3oq7Kwak5xvT1L/cDN9F+pdtqT43RNb3oFFCjF7R29fkZ7whP36l/9hPwDXks3U3FFrWmnIF01pTapESSfv0FZf8+Tl5xWWs7REpHIaAk8Bgz/NuCW3yWuYo3/KsZR7+fO2GucircuWml7v0JUubRUk7WYDu3QODL1wVrrRuZAXCTuSC3IWN14g/E7jOtugwMmWUqF1gdAGInJPGsgvwbTcYJAJF9DSqpq61drA+M11s1twb0dZtpYsgq7QBhznvKFIEndeHCzwuSG/pJM80i00BzKjZBxzyDLNJ7aZP15JeaHg0tqnkC0T0BH7aVo1YhGTfsf1V+fgWtFAuvKWHGe4oOlUbuWl8OR0EsiSdctWfDxZO8NPWp6S/htuUF6KjcECLKhp3kzegb4UKXh1bAtH71HnvSiOcpGCt0L9/XX03dsf2OXTZBDFLb3uDsy998Orb16+fvcSgUFB6hA2TAbJgJxlytiCy9ZKnk+OG0Vr5TFWrf3vSgPvSgPvSgPvSgPvSgPvSgM/1uK1u9LAu9LAu9LAu9LAu9LAu9LAnw8Ju9LAu9LAu9LAu9LAu9LAu9LAu9LAu9LAu9LAu9LAu9LAu9LAj0dW7EoDP5aKq7vSwL8FBe5KA+9KA+9KA+9KA+9KA+9KA+9KA+9KA+9KA+9KA+9KA+9KA+9KA+9KA+9KA+9KA+9KA5/uSgPvSgPvSgPfuzRwK0Vxr8y5oBRkX/LLZQ+frBYMPoujGaYXH55E19dIge91vlzi558rypY8OYujS64FvuqkzOQ4JNJiUuQFYELlN+6Rav8Y14/dgVMiykpCNmYCuxFHhIMb+7YzoN++eXccxdHYFzUuVEYVDfgckyj53CWZtjIt6dt1lHM5rShLM3JzLl39p1k3cfiCEof9H61UT0ywbSDsZhS7beC/uKmNA66vXVLycln3d01bR3jEht54fmfL5fL/AN7d5JQ=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,b={},f=[];function y(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Template"}),"\n",(0,r.jsx)(o(),{method:"post",path:"/createtemplate",context:"endpoint"}),"\n",(0,r.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,r.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,r.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,r.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,r.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,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,r.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.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,r.jsxs)(n.li,{children:[(0,r.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,r.jsxs)(n.li,{children:[(0,r.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,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.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,r.jsxs)(n.li,{children:[(0,r.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,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.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,r.jsxs)(n.ol,{start:"2",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.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,r.jsxs)(n.ol,{start:"3",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.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,r.jsxs)(n.ol,{start:"4",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.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,r.jsxs)(n.ol,{start:"5",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.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,r.jsxs)(n.ol,{start:"6",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.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,r.jsxs)(n.ol,{start:"7",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.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,r.jsxs)(n.ol,{start:"8",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.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,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.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,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,r.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"9",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.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,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,r.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.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,r.jsxs)(n.ol,{start:"10",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.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 "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"11",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.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,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.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,r.jsxs)(n.ol,{start:"12",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.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 "layout": "vertical"\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.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,r.jsxs)(n.ol,{start:"13",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.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,r.jsxs)(n.ol,{start:"14",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,r.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"hint:"})," Provide a hint for the number (Optional)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,r.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Note:"})," Responses for prefill widgets are ",(0,r.jsx)(n.strong,{children:"required"}),"."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"2",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,r.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,r.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"3",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"4",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"5",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{start:"6",children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,r.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.jsx)(d(),{parameters:void 0}),"\n",(0,r.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 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:""},company:{type:"string",format:"string",example:""},job_title:{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},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:"5,"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},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:100},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:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,r.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,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/c195e1f1.f990c3aa.js b/assets/js/c195e1f1.f990c3aa.js new file mode 100644 index 000000000..17f29f8e3 --- /dev/null +++ b/assets/js/c195e1f1.f990c3aa.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6192],{19115:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>j,contentTitle:()=>g,default:()=>b,frontMatter:()=>x,metadata:()=>i,toc:()=>f});const i=JSON.parse('{"id":"API-docs/v1.1/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","source":"@site/docs/API-docs/v1.1/createdocumentwithtemplateid.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createdocumentwithtemplateid","permalink":"/docs/API-docs/v1.1/createdocumentwithtemplateid","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar_label":"Create Document from Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztW19zGzly/yrIvHjNGpGSbG8SleM6re3sqs5Zq2w5ritRxQVnmhxYGGAOwJDiqVh1D/cN8pTX+2j7SVLdwMxgKFL/znlJtLW1K2KARqO70ej+NXCdOD63ydF58k5ndQnK2eQiTXKwmRGVE1olR8lZAeytAe6ANb3YzOiSOSgric3HpyeMS6mXlq10zZxmc1Bg8JOCJcsb2my6Yt9q61hl9ELkQs1bGhORM6GsA54zPWN1JTWnDpxIzISEH4RirgA206bEPlNu4ceXTBs2FYqb1XMGCzAr5kQJxIcCyJGZzDPPW0aG7CxMa5EaM1Bhj1yuWG0hp9ksy7hiUwijc7/k2oJhQjkwM54B446dDwbvYFrP2ZeTweDih8K5yh6NRryqhroCZcVcST61w0yXoxw7VvnsOTJdW1p/J9yzSJzDsRqrP+mamPDSApbDjNfSsQWXNYkBhc6WIp8DypYj65pkJAxTvITed1tXlTaOwVUGlWPIGHe1gZRZx8sqZUIJJ7i0KRMlnwOxMBgUIoeJgys3WQpXTLh1YIS9tEeDAftagGKg+FRCntJSsGPggWaAvBU6E5YVIs9BeVEayEQlyCy8KFrSKZvWjhkouVCWzWopV2whrJhKQHUi7ZaoXirSSFj1xwrUZzFXjGeZrknThbBMky0jB3zBhUSGmVZyhayeAS8t4ypn71GvlREWWCW5siSBgyEbDJAVORiM1W+//TZW12PF2DhBCY+TIzZO6PM4SX27AZ4jcfw249JCaA/qi4b8Aa54WUlA42iH7xJ4S26s1oGRsTpE7pCR3cz5vx7C2zcNj+PmBXLzTU/ZmXDyFpawi8MuD+MrA/04vl4iX5kuK65Wu7kKHR6oR69BVi0cky5/HH+vkL+cu1tEhl8fxtnBwd7+q73D/cNX4ySe7EecDDmb6qvd84UOD5uyXJEDeJwQ/pmUVEB2eStjTY+HcHY+TrwH2DscJxfdpHsodt8N3Vnjbwu+QPcA6KVLbYC5gitq8J7XFdzR4WLRHU2BWZCQ4RkxXTVOmnzHv5Beja5yvVS36Db0eJiw/YoO+sr9V5zR8Fxo9KFO3zIr9foOUx7skw+qyymYW7wQfX/IdPuhCY/7WnJPpiWQQyZKLivJMyB7OnyMzQ0GpwZmQkr21Z+SaAZNU3NwcgMMJPgIhnSPLUJZMKhzoZyOYgs2hRnajKADzxbcQM6QFcYpehiyj3jw9A4xCjG0YQW3rAJTCmvxuEK6eY5dy3AYG7CVVhY8mz4qQEqRXdpC1zLHkAZFQ1/hSliHJ2wzPFD7IKzDQGojQqA1NVJAjR7c7TG2OQw/F33kKjewZFOA2HYOH+z2WpJsnOy/HB28Gh3uH76Mab54tBfpaJ+Pk5LT4YTmB/7vDbcRa+I/MKTFSLHQtoluenIn9VgUdTMvugmhvKR93ORjv2F7XD1gE4deO+Tk2f8u3Mez7VwBC/+EY41iyd0LoM/bjUb8508fPy33//jzXB8fHx//+vlL8f7L/Pj4uMTfw+EwrCqQ/vHRzjaWVqPu7yKvZq7dshqrJE10hbmS0OokT46SkG8E34Ceo+ku8iRNKm54CQ4Mpm3XtLDkKInSqCRNBKZtFXdFspnL6ek3yNwJ5VhNvpGkiYE/18JAnhw5U0OaWLeSSNYKDG6SNIGrSuockiPvrBObFVDy5Og6cauKejoj1DxJyV1zF7eEEAlZ+uVgWmSHRTVN1usLPy1Y95POV0gq08qBcvgnryopMhLK6JtF1q+jOTt2zxPKMgylrYEVv0YUlUHJOgGWGMWA86Ec/xqlrz5kvSHSYxXSCy5ZqxxmK8jEbNWkeDSUUjb8pWApV21i2WWlJzOmS+Fcl015Df3+1/+2gcQST6Yp+Dy1F24k67QVRrdKbgxfoUk4KOP2HUIyeruMOokcY2LlFFcOJ6Q05lahUoeYwDcNcd6DVLwR3zbrNw14emDnqtDqjt4Hhy/w3xcH2D+E9Q/VfJO8I4lvejp5lPnksMDx4YB9vFruFlA4fie05Ca6ioZMtZbAVTyGtvI6bWKu2+mH0H6qr5L1Om0204azirzQ5LM3xUmz9vWDhtEkMy1zMOgUb+OM7B5UPtm0xW7Jm3iWsNFO7QNXYd+yZQGuAEPNS64cI+pdwI/uQLOw3xBl2IRnhMUsytQwTmhjd2Gaxh89FqK+BEQozZ7RfBNbk0E8G4XfU52vnnUjfXDqeRboSgIL1Ll1H7bnNYbjnhXgtM1GbqbbJvC+DN/W1umS0TRhEHm3FlViwbcP2VuumFCZrEOsOtMocHSM7Pq6MQG/vdZrdn2NugQzQZNfr9OuAefqNZAj8C0GMhCL3qi2CbqBbVs0FK4qYVYTDDR9Q/AXMQNiroSaT2oT6CiNnYc9M9xgnGL5IAPIW+tCaOrmqltPSvq9t/RvCDvoHYn8v5H76+rNL2ILK69H1ZvX1ZuvwApdgd9xXjwzoXK/35cg5ZC9ts5oNX+zIYLXo9C+XZUGFgKWtF1Jqx2VTdm2hIaBpz/pOt4pwrLM1JngEulWRmfQpIw+WLhyzDqoLOMW00oSy0wArcEwPjdAySnxwmtXaCP+QqFTM+FrzgoDs397tiHTZ28IKy3AwOsRfxN6n8xojYSCcLVitHChlUU8hDD1WW3IOWaSGzELcVrKKgncAsMwjmfOY8Ak0YaPs4KrS5u+npo3iLq2aO3vf/s79mg8+Yn6aHIw93DlJzNmgTzxM/Rjz1KP6pK5C2NdcNDe/wULabHpbVsnYOByNWTvW4dv66nFXqqh1zlUZ8R8Dpjihx40OPXaA54V/qggrvgMfT3OXqHx6No27KGBoflLQAPzSHZQ1JD91AZ5KYukQ+hCvPbhFq+OpZAz/TaQfsdXcazhIZkbMqXyCVZNwiiW85XF2SjkxA9cZjUVKvweZriH8VQjc2ysP46M2pla/g5eocujysHHs9N7aBoXxPb8Ng5oPunA02Afz07ZAjpjHLIvttVTo3je68IynQNbCO5Vn7JlITLacitWYo4HivQVvHYM2Aw9ksT22E2GcmG3cpT6QAP9b02sbSPMcmEgc3JFBqRrhwCQCMkF+YDhtgjOC+FM1/fZM3dIkrN5LXLSdG3aMx2MTaOqHVbqTJ15r5DXpklzgtF6J2ZtJ6dGKtgpop8yUNYP52xGWF3KakUFNlNXuBsaknBVgRGgMtgqgsh1331+YrRG9THt47IKjNUK3Zs2c66C98Ti0BKTfDaFgkvfNbgJy6aAXOHuHm7NG37/29+Tjq+dedJNxvwMPM8NWHsHh4T4eXNC4BpBvxVzus8R0gPzh81qJHJHJjkpdd6aqb2/BZ0iUuls6xMDXNlCpbbOCjyyWl9r4xojFR1tiktqi4a6wvW2QEqDS4pdu+8ToByziAdCY3DPoEWpVbx9OghXb5CjhEBY3xoH8VstDYvDd2sSawklX7W1W6QdCtag0PPk7PTdv1Ol2UcTW+BazHMjL+qH38h9eO30xEAp1P3OzM/+0CAlOt1u+9rpkjuRsYaUHbLQ1Yvb6XgXl+yHRlS4OxZCm+dbxeXJTbTKYCLUhEr0dx9Cv1IzYWh4+kzBLQFUzFujNH+0ergIeVtiTbonk+ikxEX3N8erFGVYgpnDJMOEmzYC3EOOgwFSGwzYnuclOFFbm4DEoy7DIUrHTUcdOQqheYsJduc/2kVnnL/oJcqsja4wBvb0UaSMOA9wUTxDxpXSzueqmC62NxiwIxbWuyl8MYD0RasJ8V9WaO3nQ8nRPOlta2pComDxOW593s7e3AZojZ5LTVs8RLkblwWIqZMZzl7QgUMqTDH8pXlq6/cKlf8JHqsMzMDg+WDbfHvrV0qZubSaltaj2lh0Y/MbqXJj0pUvjdwN2/yv4T63YU4tTJO20PZDSXTlGoRt1rdAN5MYu6HklTr38eSIE1rV4f4+/q+/nd71imF48NcZxhB0/eOfkvT+6PDtIm0Q8IfKpPgmDv9ylS0OTxugtTby8Zq9GzjdBsJt3BlBTvpc3G8p4Y5SbeSe03u4lr124xHZSN9CSaFg0ihwkuts0qx+Ta7TWj5/sIm16qb8qK/rO6ZPvEG+3GZFUe6qnlH03JVxQ6aOYQL63Oa2FSa12rUHddOl75+EYQiN00gy8+9mj2CMNg+V3qk/Cyy4uupW4gnfJcGX+/uTrBPiqy1CVAsuRU7X+s70JajvuP12LrdbXDy989Mjq1el7FxiInwn+p70Vhu3+0VayGoj3IoKZld7vBJ7/vvR+QWWoUpwhcbSW6UtcYyVs6Nk1Hd1o+vI160TJGsWTRmOdmG7sSxX+VRf3bwAyCsxWhwMEaTfHLP1wuAt/aHee+gQ6/hcqPld4y46iX1GrXrF9eTWeb1K/BFwNwS1xL1CHbIAjoEpKgKN5VNX83vfqLwtzm2vt7VVrfOmQBVXodoi1I3KUstVUz1qi0dRhSgqEHU1n17Jh6o4UREnrro2RZe45hJKpG1ZpVc7IYPrChtJ0i9e+PLrBhj/j2HLfWj5CS/9P4SXbsCl3ni2YX4Hr3poW7DQGDZq6voxjNLDMjahjJ2wwg5UIUzgs2c0+428NXzfni5imrY1Swujooh89zZN4oC4F+NeoHMSaqZjV9ReJcZziDzjZgb4FWSmy/ZO8mAQ6acdNRi0Ds3bGGY2H2vDKr0EM6slmeFMwhXdb8ZhUNK3riYJvJRgrVzR1fM55VO5mAuHqGDAxzJe8amQAg9afyfNW3t3VtshXthuqprPDN2IhwVIPJ9bAEDNOwe81OZyhtXRlHE2xVvaCEmBKrjKPPrljwlCcbjyiKm/QG2dQa6F500rZ9DES674nDZfGhszy0GiL7LM6ClCr1bL2m8hx4XUxgPPtCC6d0lCfI93UgwwbEUfbqBAU1wEhNGmHuG1dCDgElTOpkCvD3jmBKaCTrNaSZ1d+pJBLSWrtPMwPoIPMY843BmuLL0/8Fh30EErsIB7gg1J9RcLqOEPQtGFebxMdN7a1VeYWuGgezOwXC5vnMvP+2N+Fu6Xeso+QaWtcNqsutFz4Yp6Smd5TKT94Sn93DzMiE7qjkauM7vl2YLO7KgAWY0+g0MLsaPj0xOKDJ+z3//6X+wDcKNYoZfeWrPagFx1b0BQcl7zXmxtYOffMNSuQIlnPNxRJP/ZSPBrwR1l8BgZCBW2lL+VdVpPpci6txyDwVHzlqIrfRNUEp5yhNuYiPlzVvnRUqjLITtWK/+2oz1GsJ3G9ZZBR1f0niV6cxHd6jqLZofSglz45yQBkYFc+DqP0fXczxYzExbXv5iKazvOc1ZtXE5FVK5jx189pRIGXQwgBGnbfdbeVc9+dRhUXmmhnD1iueEz19FPN26s0iF2o6m57NqIIw1kWpX4nRhW3LZ6rGUjyuz7W8JwcELbe2LEKxHM6bwxS4bW+o+Ytb84ROdylK1juLsVR3dgSvtx9hnMQmRNir1jR4+o8yhJEykyCOhMOKmOfz79wBYvhvtJGsXu99jcow8nb9//+vk9MoOO1AvsYLg/3Kc7U9q6kqtopq0PuqIbgT3JR1fznl6DPb0Ge3oN9vQa7Ok12NNrsKfXYE+vwZ5egz29Bnt6Dfb0GuzpNdj3eg0WKiu4g0aV5EJFVV5fmTrfKMInaXIUPwC7SJMCK1lH58n1NSYCXxC8xuY/1wSnnl+kyYIbgZEvAaXhYk8eFS92pH8/fAql/edsx1uyrfw35SKFtSISiQeBL2G18XptfbFOm5oRsuZ7vPUM7J0hnY7CjUokFr38iOMME5tb+8alv9OPn8+SNGnu35f02C0xfImoMV96bv2J5x9KYdt1Irma11T+TjzNtb+RVfRrZJdUIwt/4Kq2yqNfPPPLwP/iorYOuL729Teq8vj+/tPOEUGwTW9UzsV6vf4fJQKnCw==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Document","permalink":"/docs/API-docs/v1.1/createdocument"},"next":{"title":"Get Document","permalink":"/docs/API-docs/v1.1/getdocument"}}');var s=n(74848),r=n(28453),o=n(33617),a=n.n(o),l=n(17543),d=n.n(l),c=n(86013),p=n.n(c),m=n(63723),h=n.n(m),u=(n(18766),n(79329),n(9303));const x={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztW19zGzly/yrIvHjNGpGSbG8SleM6re3sqs5Zq2w5ritRxQVnmhxYGGAOwJDiqVh1D/cN8pTX+2j7SVLdwMxgKFL/znlJtLW1K2KARqO70ej+NXCdOD63ydF58k5ndQnK2eQiTXKwmRGVE1olR8lZAeytAe6ANb3YzOiSOSgric3HpyeMS6mXlq10zZxmc1Bg8JOCJcsb2my6Yt9q61hl9ELkQs1bGhORM6GsA54zPWN1JTWnDpxIzISEH4RirgA206bEPlNu4ceXTBs2FYqb1XMGCzAr5kQJxIcCyJGZzDPPW0aG7CxMa5EaM1Bhj1yuWG0hp9ksy7hiUwijc7/k2oJhQjkwM54B446dDwbvYFrP2ZeTweDih8K5yh6NRryqhroCZcVcST61w0yXoxw7VvnsOTJdW1p/J9yzSJzDsRqrP+mamPDSApbDjNfSsQWXNYkBhc6WIp8DypYj65pkJAxTvITed1tXlTaOwVUGlWPIGHe1gZRZx8sqZUIJJ7i0KRMlnwOxMBgUIoeJgys3WQpXTLh1YIS9tEeDAftagGKg+FRCntJSsGPggWaAvBU6E5YVIs9BeVEayEQlyCy8KFrSKZvWjhkouVCWzWopV2whrJhKQHUi7ZaoXirSSFj1xwrUZzFXjGeZrknThbBMky0jB3zBhUSGmVZyhayeAS8t4ypn71GvlREWWCW5siSBgyEbDJAVORiM1W+//TZW12PF2DhBCY+TIzZO6PM4SX27AZ4jcfw249JCaA/qi4b8Aa54WUlA42iH7xJ4S26s1oGRsTpE7pCR3cz5vx7C2zcNj+PmBXLzTU/ZmXDyFpawi8MuD+MrA/04vl4iX5kuK65Wu7kKHR6oR69BVi0cky5/HH+vkL+cu1tEhl8fxtnBwd7+q73D/cNX4ySe7EecDDmb6qvd84UOD5uyXJEDeJwQ/pmUVEB2eStjTY+HcHY+TrwH2DscJxfdpHsodt8N3Vnjbwu+QPcA6KVLbYC5gitq8J7XFdzR4WLRHU2BWZCQ4RkxXTVOmnzHv5Beja5yvVS36Db0eJiw/YoO+sr9V5zR8Fxo9KFO3zIr9foOUx7skw+qyymYW7wQfX/IdPuhCY/7WnJPpiWQQyZKLivJMyB7OnyMzQ0GpwZmQkr21Z+SaAZNU3NwcgMMJPgIhnSPLUJZMKhzoZyOYgs2hRnajKADzxbcQM6QFcYpehiyj3jw9A4xCjG0YQW3rAJTCmvxuEK6eY5dy3AYG7CVVhY8mz4qQEqRXdpC1zLHkAZFQ1/hSliHJ2wzPFD7IKzDQGojQqA1NVJAjR7c7TG2OQw/F33kKjewZFOA2HYOH+z2WpJsnOy/HB28Gh3uH76Mab54tBfpaJ+Pk5LT4YTmB/7vDbcRa+I/MKTFSLHQtoluenIn9VgUdTMvugmhvKR93ORjv2F7XD1gE4deO+Tk2f8u3Mez7VwBC/+EY41iyd0LoM/bjUb8508fPy33//jzXB8fHx//+vlL8f7L/Pj4uMTfw+EwrCqQ/vHRzjaWVqPu7yKvZq7dshqrJE10hbmS0OokT46SkG8E34Ceo+ku8iRNKm54CQ4Mpm3XtLDkKInSqCRNBKZtFXdFspnL6ek3yNwJ5VhNvpGkiYE/18JAnhw5U0OaWLeSSNYKDG6SNIGrSuockiPvrBObFVDy5Og6cauKejoj1DxJyV1zF7eEEAlZ+uVgWmSHRTVN1usLPy1Y95POV0gq08qBcvgnryopMhLK6JtF1q+jOTt2zxPKMgylrYEVv0YUlUHJOgGWGMWA86Ec/xqlrz5kvSHSYxXSCy5ZqxxmK8jEbNWkeDSUUjb8pWApV21i2WWlJzOmS+Fcl015Df3+1/+2gcQST6Yp+Dy1F24k67QVRrdKbgxfoUk4KOP2HUIyeruMOokcY2LlFFcOJ6Q05lahUoeYwDcNcd6DVLwR3zbrNw14emDnqtDqjt4Hhy/w3xcH2D+E9Q/VfJO8I4lvejp5lPnksMDx4YB9vFruFlA4fie05Ca6ioZMtZbAVTyGtvI6bWKu2+mH0H6qr5L1Om0204azirzQ5LM3xUmz9vWDhtEkMy1zMOgUb+OM7B5UPtm0xW7Jm3iWsNFO7QNXYd+yZQGuAEPNS64cI+pdwI/uQLOw3xBl2IRnhMUsytQwTmhjd2Gaxh89FqK+BEQozZ7RfBNbk0E8G4XfU52vnnUjfXDqeRboSgIL1Ll1H7bnNYbjnhXgtM1GbqbbJvC+DN/W1umS0TRhEHm3FlViwbcP2VuumFCZrEOsOtMocHSM7Pq6MQG/vdZrdn2NugQzQZNfr9OuAefqNZAj8C0GMhCL3qi2CbqBbVs0FK4qYVYTDDR9Q/AXMQNiroSaT2oT6CiNnYc9M9xgnGL5IAPIW+tCaOrmqltPSvq9t/RvCDvoHYn8v5H76+rNL2ILK69H1ZvX1ZuvwApdgd9xXjwzoXK/35cg5ZC9ts5oNX+zIYLXo9C+XZUGFgKWtF1Jqx2VTdm2hIaBpz/pOt4pwrLM1JngEulWRmfQpIw+WLhyzDqoLOMW00oSy0wArcEwPjdAySnxwmtXaCP+QqFTM+FrzgoDs397tiHTZ28IKy3AwOsRfxN6n8xojYSCcLVitHChlUU8hDD1WW3IOWaSGzELcVrKKgncAsMwjmfOY8Ak0YaPs4KrS5u+npo3iLq2aO3vf/s79mg8+Yn6aHIw93DlJzNmgTzxM/Rjz1KP6pK5C2NdcNDe/wULabHpbVsnYOByNWTvW4dv66nFXqqh1zlUZ8R8Dpjihx40OPXaA54V/qggrvgMfT3OXqHx6No27KGBoflLQAPzSHZQ1JD91AZ5KYukQ+hCvPbhFq+OpZAz/TaQfsdXcazhIZkbMqXyCVZNwiiW85XF2SjkxA9cZjUVKvweZriH8VQjc2ysP46M2pla/g5eocujysHHs9N7aBoXxPb8Ng5oPunA02Afz07ZAjpjHLIvttVTo3je68IynQNbCO5Vn7JlITLacitWYo4HivQVvHYM2Aw9ksT22E2GcmG3cpT6QAP9b02sbSPMcmEgc3JFBqRrhwCQCMkF+YDhtgjOC+FM1/fZM3dIkrN5LXLSdG3aMx2MTaOqHVbqTJ15r5DXpklzgtF6J2ZtJ6dGKtgpop8yUNYP52xGWF3KakUFNlNXuBsaknBVgRGgMtgqgsh1331+YrRG9THt47IKjNUK3Zs2c66C98Ti0BKTfDaFgkvfNbgJy6aAXOHuHm7NG37/29+Tjq+dedJNxvwMPM8NWHsHh4T4eXNC4BpBvxVzus8R0gPzh81qJHJHJjkpdd6aqb2/BZ0iUuls6xMDXNlCpbbOCjyyWl9r4xojFR1tiktqi4a6wvW2QEqDS4pdu+8ToByziAdCY3DPoEWpVbx9OghXb5CjhEBY3xoH8VstDYvDd2sSawklX7W1W6QdCtag0PPk7PTdv1Ol2UcTW+BazHMjL+qH38h9eO30xEAp1P3OzM/+0CAlOt1u+9rpkjuRsYaUHbLQ1Yvb6XgXl+yHRlS4OxZCm+dbxeXJTbTKYCLUhEr0dx9Cv1IzYWh4+kzBLQFUzFujNH+0ergIeVtiTbonk+ikxEX3N8erFGVYgpnDJMOEmzYC3EOOgwFSGwzYnuclOFFbm4DEoy7DIUrHTUcdOQqheYsJduc/2kVnnL/oJcqsja4wBvb0UaSMOA9wUTxDxpXSzueqmC62NxiwIxbWuyl8MYD0RasJ8V9WaO3nQ8nRPOlta2pComDxOW593s7e3AZojZ5LTVs8RLkblwWIqZMZzl7QgUMqTDH8pXlq6/cKlf8JHqsMzMDg+WDbfHvrV0qZubSaltaj2lh0Y/MbqXJj0pUvjdwN2/yv4T63YU4tTJO20PZDSXTlGoRt1rdAN5MYu6HklTr38eSIE1rV4f4+/q+/nd71imF48NcZxhB0/eOfkvT+6PDtIm0Q8IfKpPgmDv9ylS0OTxugtTby8Zq9GzjdBsJt3BlBTvpc3G8p4Y5SbeSe03u4lr124xHZSN9CSaFg0ihwkuts0qx+Ta7TWj5/sIm16qb8qK/rO6ZPvEG+3GZFUe6qnlH03JVxQ6aOYQL63Oa2FSa12rUHddOl75+EYQiN00gy8+9mj2CMNg+V3qk/Cyy4uupW4gnfJcGX+/uTrBPiqy1CVAsuRU7X+s70JajvuP12LrdbXDy989Mjq1el7FxiInwn+p70Vhu3+0VayGoj3IoKZld7vBJ7/vvR+QWWoUpwhcbSW6UtcYyVs6Nk1Hd1o+vI160TJGsWTRmOdmG7sSxX+VRf3bwAyCsxWhwMEaTfHLP1wuAt/aHee+gQ6/hcqPld4y46iX1GrXrF9eTWeb1K/BFwNwS1xL1CHbIAjoEpKgKN5VNX83vfqLwtzm2vt7VVrfOmQBVXodoi1I3KUstVUz1qi0dRhSgqEHU1n17Jh6o4UREnrro2RZe45hJKpG1ZpVc7IYPrChtJ0i9e+PLrBhj/j2HLfWj5CS/9P4SXbsCl3ni2YX4Hr3poW7DQGDZq6voxjNLDMjahjJ2wwg5UIUzgs2c0+428NXzfni5imrY1Swujooh89zZN4oC4F+NeoHMSaqZjV9ReJcZziDzjZgb4FWSmy/ZO8mAQ6acdNRi0Ds3bGGY2H2vDKr0EM6slmeFMwhXdb8ZhUNK3riYJvJRgrVzR1fM55VO5mAuHqGDAxzJe8amQAg9afyfNW3t3VtshXthuqprPDN2IhwVIPJ9bAEDNOwe81OZyhtXRlHE2xVvaCEmBKrjKPPrljwlCcbjyiKm/QG2dQa6F500rZ9DES674nDZfGhszy0GiL7LM6ClCr1bL2m8hx4XUxgPPtCC6d0lCfI93UgwwbEUfbqBAU1wEhNGmHuG1dCDgElTOpkCvD3jmBKaCTrNaSZ1d+pJBLSWrtPMwPoIPMY843BmuLL0/8Fh30EErsIB7gg1J9RcLqOEPQtGFebxMdN7a1VeYWuGgezOwXC5vnMvP+2N+Fu6Xeso+QaWtcNqsutFz4Yp6Smd5TKT94Sn93DzMiE7qjkauM7vl2YLO7KgAWY0+g0MLsaPj0xOKDJ+z3//6X+wDcKNYoZfeWrPagFx1b0BQcl7zXmxtYOffMNSuQIlnPNxRJP/ZSPBrwR1l8BgZCBW2lL+VdVpPpci6txyDwVHzlqIrfRNUEp5yhNuYiPlzVvnRUqjLITtWK/+2oz1GsJ3G9ZZBR1f0niV6cxHd6jqLZofSglz45yQBkYFc+DqP0fXczxYzExbXv5iKazvOc1ZtXE5FVK5jx189pRIGXQwgBGnbfdbeVc9+dRhUXmmhnD1iueEz19FPN26s0iF2o6m57NqIIw1kWpX4nRhW3LZ6rGUjyuz7W8JwcELbe2LEKxHM6bwxS4bW+o+Ytb84ROdylK1juLsVR3dgSvtx9hnMQmRNir1jR4+o8yhJEykyCOhMOKmOfz79wBYvhvtJGsXu99jcow8nb9//+vk9MoOO1AvsYLg/3Kc7U9q6kqtopq0PuqIbgT3JR1fznl6DPb0Ge3oN9vQa7Ok12NNrsKfXYE+vwZ5egz29Bnt6Dfb0GuzpNdj3eg0WKiu4g0aV5EJFVV5fmTrfKMInaXIUPwC7SJMCK1lH58n1NSYCXxC8xuY/1wSnnl+kyYIbgZEvAaXhYk8eFS92pH8/fAql/edsx1uyrfw35SKFtSISiQeBL2G18XptfbFOm5oRsuZ7vPUM7J0hnY7CjUokFr38iOMME5tb+8alv9OPn8+SNGnu35f02C0xfImoMV96bv2J5x9KYdt1Irma11T+TjzNtb+RVfRrZJdUIwt/4Kq2yqNfPPPLwP/iorYOuL729Teq8vj+/tPOEUGwTW9UzsV6vf4fJQKnCw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,j={},f=[];function y(e){const t={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:"Create Document from Template"}),"\n",(0,s.jsx)(a(),{method:"post",path:"/createdocument/{template_id}",context:"endpoint"}),"\n",(0,s.jsxs)(t.p,{children:["The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at ",(0,s.jsx)(t.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(t.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,s.jsx)(t.p,{children:"You can provide default value for all widgets based on their name all widgets support except signature, stamp, initials, image."}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(t.ol,{children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "email",\n "readonly": false,\n "default": "email@example.com",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"2",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "name",\n "readonly": false,\n "default": "joe",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"3",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "job title",\n "readonly": false,\n "default": "ceo",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"4",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "company",\n "readonly": false,\n "default": "example pvt ltd",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"5",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "date",\n "readonly": false,\n "default": "11-05-2025"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"6",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "textbox",\n "readonly": false,\n "default": "my text",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"7",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "checkbox",\n "readonly": false,\n "default": ["option-2"]\n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"default:"})," You can have one or more than one value that needs to be selected by default."]}),"\n"]}),"\n",(0,s.jsxs)(t.ol,{start:"8",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "dropdown",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"9",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "radio",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"10",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "number",\n "readonly": false,\n "default": 0,\n "formula": "",\n "decimalplaces": 2,\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document before it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"response:"})," Provide the value that should replace the existing response."]}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(t.ol,{children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name":"textbox",\n "response":"andrew bee"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"2",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "date",\n "response": "04/15/2024"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"3",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "checkbox",\n "response": ["male", "female"]\n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"response:"})," Must be chosen from the existing values of checkbox defined in the template."]}),"\n"]}),"\n",(0,s.jsxs)(t.ol,{start:"4",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "radio button",\n "response": "male"\n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"response:"})," Must be chosen from the existing values of radio button defined in the template."]}),"\n"]}),"\n",(0,s.jsxs)(t.ol,{start:"5",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n}\n\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"6",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "dropdown",\n "response": "female"\n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"response:"})," Must be chosen from the existing values of dropdown defined in the template."]}),"\n"]}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:[{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["signers"],type:"object",properties:{title:{type:"string",format:"string",example:"New document title",description:"An optional parameter specifying the title for the newly created document. If omitted, the template\u2019s title will be used by default.\n"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"Accoutnant"},email:{type:"string",format:"mail",example:"joe@example.com"},name:{type:"string",example:"joe bee"},phone:{type:"string",example:"123123131"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},widgets:{type:"array",items:{type:"object",properties:{name:{type:"string",example:"textbox_1"},readonly:{type:"boolean",example:!1},default:{type:"string",example:"my textbox"}},title:"createdocumenttemplate_id_Signers_widgets"}}},title:"createdocumenttemplate_id_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}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},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}}, {{note}}.",example:"

Hi {{receiver_name}},

We hope this email finds you well. {{sender_name}} has requested you to review and sign {{document_title}}.

Your signature is crucial to proceed with the next steps as it signifies your agreement and authorization.

Sign here

If you have any questions or need further clarification, please contact the sender.

Thanks,
Team OpenSign\u2122

"},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},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},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},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},file:{type:"string",description:"You may provide the base64 encoded PDF file to replace the existing one",format:"base64",example:""},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:"5,"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",properties:{widgets:{type:"array",items:{type:"object",properties:{name:{type:"string",format:"string",example:"textbox"},response:{type:"string",format:"string",example:"andrew bee"}}}}}}},title:"createdocument_template_id_body"}}},required:!0}}),"\n",(0,s.jsx)(h(),{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:"If you haven't add widgets and signers in template or not provide signers along with their roles in body",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please setup template properly!"}},title:"inline_response_400_cc"}}}},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,r.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/c195e1f1.faf5a05d.js b/assets/js/c195e1f1.faf5a05d.js deleted file mode 100644 index 5773fdcb6..000000000 --- a/assets/js/c195e1f1.faf5a05d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6192],{19115:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>x,contentTitle:()=>f,default:()=>b,frontMatter:()=>g,metadata:()=>r,toc:()=>j});const r=JSON.parse('{"id":"API-docs/v1.1/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","source":"@site/docs/API-docs/v1.1/createdocumentwithtemplateid.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createdocumentwithtemplateid","permalink":"/docs/API-docs/v1.1/createdocumentwithtemplateid","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar_label":"Create Document from Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztW91yG7mxfhWcufGaNSIl2d6TqHxc0drOrio+a5Utx5USVVxwpsmBhQEmAIYUo2JVLvIGucptHm2fJNUNzAyGIvXjODfnaGtrV5wBuhuN/sPXmOvE8blNjs6TNzqrS1DOJhdpkoPNjKic0Co5Ss4KYK8NcAesGcVmRpfMQVlJfHx8esK4lHpp2UrXzGk2BwUGXylYsryhzaYr9qW2jlVGL0Qu1LylMRE5E8o64DnTM1ZXUnMawInETEj4TijmCmAzbUocM+UWvn/OtGFTobhZPWWwALNiTpRAciiAHIXJvPC8FWTIzgJbi9SYgQpH5HLFags5cbMs44pNIczO/ZJrC4YJ5cDMeAaMO3Y+GLyBaT1nn04Gg4vvCucqezQa8aoa6gqUFXMl+dQOM12OchxY5bOnKHRtaf2dcs8idQ7Haqz+pGsSwmsLWA4zXkvHFlzWpAZUOluKfA6oW46ia9KRMEzxEnrvbV1V2jgGVxlUjqFg3NUGUmYdL6uUCSWc4NKmTJR8DsOxOhiywQBKLuRgMFa//PLLWF2PFWPjBKmPkyM2Tuj1OEn9cwM810qu8N2MSwvheRA9mvI7uOJlJQEVM07Gah0YjNUhckUGu5n6vx7C84uGPpdnyOWLnrIz4eQtrHCIwyEP45eB7vN7jvwyXVZcrXZzCwMeqE+vSVYtHJMu7/N9gXxz7m5ZIr59GMeDg739F3uH+4cv+sy+R2YOrtxUX+3mFwY8jGW5Yjivz++/SakFZJe3MmxGPITj+TjRFAH3DsfJRcd0D9Xphx0NBqzx0YIvgGkF6NmlNsBcwRU98N7qCu4oIFmMSFNgFiRkGFemq8axyel/Q/tldJXrpbplz8KIhynRr+igr8TfIkfDc6HZtHZO38KVRn0Dlgf75ON1OQVzi5fT+4ew2w+PMEXUknsyLYEcMlFyWUmegcV3h2ks1GBwamAmpGSffcjE/W0eNVGUG2Agwacz2lR8IpQFg5splNNRomFTmKExCMeEZbbgBnK2FK5gnFLJkL1XckVJoJ1C+UYbVnDLKjClsFZgVNeM5zkOLYdeWgO20sqCF9OnCKQUGZwtdC1zzG+4ZnoLV8I6zDzN9EDtnbAOs+pGuqA1NVrArTq428W3ebjnRS+5yg0s2RR6EfnwwXGqJcnGyf7z0cGL0eH+4fOY5rOvDg8d7fNxUnKK/mhX4P/eiAfxTvwv1jdYNhTaggqFUqx32h6Lqm74ov8L5TWNQ5uaaNjmjQd4Zxi1Q09e/G8ifcxt5wpY+CfkISosdi+AXm83GvHHH95/WO7/4ce5Pj4+Pv7546fi7af58fFxib+Hw2FYVSD9/VdH0VhbzXZ/E301vHbraqySNNEVFs5Cq5M8OUpC8RliA0aOZrjIkzSpuOElODBYw1/TwpKjJKqpkzQRWMNX3BXJZmGvp18gcydUcDfFZ5ImBv5cCwN5cuRMDWli3UoiWSuwykjSBK4qqXNIjnwUTmxWQMmTo+vErSoa6YxQ8ySlOMxd/CTUKijSTwfTIjssqmmyXl94tmDdDzpfIalMKwfK4Z+8qqTISCmjLxZFv454duKeJ1jUojIu0kYUv0ZUlUHNOgGWBMWK7qES/xydZXxNeEOlx4r5hMclazeH2QoyMVs19T5NpfodfylYylV7yuiOKCczpkvhHORpz05+/es/bCCxxMw0BX9o6dURyTptldGtkhvDV2gSDsr4+Q4lGb1dR51GjrNM105x5ZAh1fW3KpUGxAS+aIgPAkjFG/FtXL9owOyBg6tCqztGHxw+w3+fHeD4UF8/dOebkxyS+KKnk68ynxwWOD8k2K/flrsVFNLvhJbclE3RlKnWEriK55Arr9OmmLqdfqjFp/oqWa/Txpk2glUUhSYfvSlOmrWvHzSNmMy0zMFgULxNMrJ7UPlk0xa7JW+CG8JGntpHMYLfsmUBrgBDj5dcOUbUu0oew4Fmwd+GDAGT/lldWDz2mBrGCTl2V6Zp/NETIRrLuMqZ0uwJ8ZvYmgziySj8nup89aSb6YtTL7PAUBJEoMFt+LC9qDEc96wA2TaO3LDbpvC+Dl/X1umSEZswiaJbCzGwENuH7DVXTKhM1qFWnWlUOAZGdn3dmIB3r/WaXV/jXoKZoMmv12n3AHn1HlAg8E8MZCAWvVntI+gmts+iqXBVCbOaYKHpH4R4EQsg5kqo+aQ2gY7SOHjYM8MNwamWDzqAvLUuMVdbVt1GUtrfe2v/hrLDviOR/zd6f1m9+klsEeXlqHr1snr1GVihK/Ae59UzEyr3/r4EKYfspXVGq/mrDRW8HIXn27fSwELAktyVdrWjsqnbltAwyPQnXceeIizLTJ0JLpFuZXQGzZHRFwtXjlkHlWXc4rGS1DITQGswjM8N0OGUZOG1K7QRf6HSqWH4krPCwOx/nmzo9MkrDLesAAMvR/xVGH0yozUSvMHVitHChVYWgQ4CWGe1oeCYSW7ELNRpKaskcAsMyzieORLea7SR46zg6tKmL6fm1Rnwkr2vQKEEv/7tnziiieQn6r3JwdwjlJ/MmAWKxE8wjj1JmW4O1zNhrAsB2se/YCFerh2uEwBRuRqyt23At/XU4ijV0OsCqjNiPgc84ocRNDn1uwc8K3yqIKn4DGM9cq/QeHRtG/HQwND8JaCBeTA3bNSQ/dAWeSmLtEPoQrz24Zaojrj4mX4dSL/hq7jW8FjLDZ0Slo4QepjFcr6yyI1KTnzBZVYTau19mKEPY1Yjc2ysP66MWk6tfAcvMOQpPpXw/uz0HjuNC2J73o19ue33wNNg789O2QI6YxyyT7bdp2bjeW8Iy3QObCG43/qULQuRkcutWIlnPFC0XyFqx4DN0INRbI/dFCgXdqtEqS80MP7WJNo2wiwXBjInV2RAunYIAIlwuKAYMNxWwXklnOn6Pj5zhyY5m9cip52uTZvTwdg0auFg28bUmY8KeW2aY04wWh/ErO301GgFB0X0UwbK+umczbh1YFJWK+q2mLpCb2hIwlUFRoDKYKsKotB9d/7Eao2aJdrXZRUYqxWGN23mXIXoiY2VJR7y2RQKLv3QECYsmwJKhd493Hpu+PVv/0w6uXaek24K5jnwPDdg7R0SEuLnzQkRaQT9VszpvkRID8zvNltTKB2Z5KTUeWum9v4WdIpIpbNtTAxwZQuV2jorMGW1sdbGDSfqQNkUl4QHC+pi6QrX2wIpDS4pdnnfB0A9ZpEMhMagz6BFqVXsPh2EqzfI0YFAWP80LuK3Whp2Cu/eSWwSlHzVNvKQduhegsLIk7PTN7+ntqOvJrbAtXjOjaKon37j7MNrpycGSqHulzM/+qRBm+h06/a10yV3ImMNKTtkYahXt9OxF5fsu0ZV6B0Loc3Trery5CZaZTARakL92ruT0M/0mDA0zD5TcEsAFcvWbJpPrR4uQtmWBSjW00mUKXHRfed4kaIOSzBzmGR44CZHgHvocTBAaoMB2/OyhCBqaxOQeNzLkEQp3XTUUaJQmreYYJf/0S464/xJL1FnbXWFNbCnjyplJHmAi2IOGVdKO39WxeNi287GgSUXqmPhmwG0X7SaUP9lhdaeH2qO+KS3rakpiYLF5+j6vOXuPTQyei41uXiocsPrnlAnM+ReUMKhLUyx/CU+tfW+opcKDMFjlYEZGMwPtj1vb31LR2Yuraal9ag2Ft3Y/MZRuTHpyrdG7oZt/mO4z22YUwvTpC20/VASXbsGYZv1LdDNJMZu6PBKg/t4ciQJrepwfx//13enN71mGCb+OsMaYlZLufqvJL0/Ony7ShsE/KE6Kb6Iw79cZYvD0wZorY38+p29GzjdBsJtXKJASfpS3G8p4cJKbeSe03u4lr3W8YhstN9CSaFg0mzgJNfZpFn9mkKntXz+YBNrt5vOR/29voN94g3y+TYris6u6glVz10bN5zUsUzAmNtcvcFDrXZtom6G9OOTMAyhcZpJZv7N7BGM0eah2jv1ucCCq6tuJZ7wXRp8vr8/yTolvtiiRLXgUuR0x+tMX4L6hu63c7nd4mL2zrNHUa9K2YXERPhB9D7prTZ+7hdpIauNcCtqmF3t8Urs+fdH5xfYhirBFRpbb5W2JDF2zo6SUT/Uja6jWLdOkKxZNG048sLWsSxX+VRf3bwNxisxWhwMEaTfnLP19tgt46Hee+gU6/hcqPld8y46jX3EXfUb19NbF/Uq8QdAbwjbEo8KfcgCOBamuBFoLB+6nt/bZsvb5tz2flvb1TpvGlRxF6ptQt3oLLVSNd2jtnkUdYiiBlHX8+m1fKiLEzVx4q5r03SJey6hRdq2VXq9EzK4rrGRJP3mhW+/boDx/x623IeWH/HS/0N46QZc6o1nG+Z38KKHtgULjWGjpq8fwyg9LGMTytgJK+xAFQIDf3pGs984t4b324+LeEzbekoLs6KKfLebJnFB3KtxLzA4CTXTcShqlE15iCLj5gnwM8hMe7AU924wiPannTUYtAHN2xiebN7XhlV6CWZWSzLDmYQrgcdXnAYlvet6ksBLCdbKFd1DntN5Khdz4RAVDPhYxis+FVJgovV30ry1d7naDtnnrqv5xND1aFiAxPzcAgBq3gXgpTaXM+yOpoyzKd5eRkgKVMFV5tEvnyYIxeHKI6aVEViaOINSCy+bVs6giZdc8Tk5XxobM8tBYiyyzOgpQq9Wy9q7kONCauOBZ1oQXagkJb7FOykGGD7FGG6gQFNcBITRph7htZQQcAkqZ1Ogq+g8cwKPgk6zWkmdXfqWQS0lq7TzMD6CD7GMON0ZrixdRvdYd9iDVmEB9wQbDtWfLOAOvxPqEq8W4mWi89auPsPUCgfdBfLlcnkjLz/tz/lRuJ/qKfsAlbbCabPqZs+FK+op5fKYSPvDU/qxuaUfZeqORq4zu+UOu87sqABZjT6CQwuxo+PTE6oMn7Jf//p39g64UazQS2+tWW1ArroPAlBzfue92trCzl9or12BGs94uKNI8bPR4OeCOzrBY2UgVHApfyvrtJ5KkXUX+weDo+Zifdf6Jqgk3OsPtzER8+es8rOlUJdDdqxW/qJ/m0bwOc3rLYNSV/RxQ3QBP7rVdRZxh9KCXPhvCwIiA7nwfR6j67nnFgsTFte/mIprO85zVm1cTkVUrhPHXz2lFgZdDCAEadt91t5Vz353GFReaaGcPWK54TPX0U83bqxSErvxqLns2qgjDWTaLfGeGFbcPvVYy0aV2Y+3hOEgQ9v73oRXIpjTeWOWDK313zFrf3GI8nJ0WsdydyuO7sCU9v3sI5iFyJoj9g6PHtHgUZImUmQQ0JmQqY5/PH3HFs+G+0ka1e73cO7Ru5PXb3/++BaFwUDqFXYw3B/u050pbV3JVcRp69c90Y3Anuajq3mPnwY9fhr0+GnQ46dBj58GPX4a9Php0OOnQY+fBj1+GvT4adB/7NOgALOjB40qyYWKWn6+TXG+0ZFN0uQo/hroIk0KbGscnSfX11gVfkIkEx//uSZs7fwiTRbcCMQCCTULtzzyCMnecRb47kPo8z5lOz4s2ip/0ztQ2DgglXhE8BJWG58yrS/WadNAQNH8iNdegL0zpNNRuNGWwg6In3GcYZV769i4D3T6/uNZkibNZeySvnxKDF8ihMiXXlqfyvxXM/jsOpFczWvqhSae5tpfzyn6DZNLapiEP3BVW/XR76T4ZeB/cVFbJ1xf+2YMQf5+vH+1c0ZQbDMaN+divV7/C/oIN9g=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Document","permalink":"/docs/API-docs/v1.1/createdocument"},"next":{"title":"Get Document","permalink":"/docs/API-docs/v1.1/getdocument"}}');var s=t(74848),i=t(28453),a=t(33617),o=t.n(a),l=t(17543),d=t.n(l),c=t(86013),p=t.n(c),m=t(63723),u=t.n(m),h=(t(18766),t(79329),t(9303));const g={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztW91yG7mxfhWcufGaNSIl2d6TqHxc0drOrio+a5Utx5USVVxwpsmBhQEmAIYUo2JVLvIGucptHm2fJNUNzAyGIvXjODfnaGtrV5wBuhuN/sPXmOvE8blNjs6TNzqrS1DOJhdpkoPNjKic0Co5Ss4KYK8NcAesGcVmRpfMQVlJfHx8esK4lHpp2UrXzGk2BwUGXylYsryhzaYr9qW2jlVGL0Qu1LylMRE5E8o64DnTM1ZXUnMawInETEj4TijmCmAzbUocM+UWvn/OtGFTobhZPWWwALNiTpRAciiAHIXJvPC8FWTIzgJbi9SYgQpH5HLFags5cbMs44pNIczO/ZJrC4YJ5cDMeAaMO3Y+GLyBaT1nn04Gg4vvCucqezQa8aoa6gqUFXMl+dQOM12OchxY5bOnKHRtaf2dcs8idQ7Haqz+pGsSwmsLWA4zXkvHFlzWpAZUOluKfA6oW46ia9KRMEzxEnrvbV1V2jgGVxlUjqFg3NUGUmYdL6uUCSWc4NKmTJR8DsOxOhiywQBKLuRgMFa//PLLWF2PFWPjBKmPkyM2Tuj1OEn9cwM810qu8N2MSwvheRA9mvI7uOJlJQEVM07Gah0YjNUhckUGu5n6vx7C84uGPpdnyOWLnrIz4eQtrHCIwyEP45eB7vN7jvwyXVZcrXZzCwMeqE+vSVYtHJMu7/N9gXxz7m5ZIr59GMeDg739F3uH+4cv+sy+R2YOrtxUX+3mFwY8jGW5Yjivz++/SakFZJe3MmxGPITj+TjRFAH3DsfJRcd0D9Xphx0NBqzx0YIvgGkF6NmlNsBcwRU98N7qCu4oIFmMSFNgFiRkGFemq8axyel/Q/tldJXrpbplz8KIhynRr+igr8TfIkfDc6HZtHZO38KVRn0Dlgf75ON1OQVzi5fT+4ew2w+PMEXUknsyLYEcMlFyWUmegcV3h2ks1GBwamAmpGSffcjE/W0eNVGUG2Agwacz2lR8IpQFg5splNNRomFTmKExCMeEZbbgBnK2FK5gnFLJkL1XckVJoJ1C+UYbVnDLKjClsFZgVNeM5zkOLYdeWgO20sqCF9OnCKQUGZwtdC1zzG+4ZnoLV8I6zDzN9EDtnbAOs+pGuqA1NVrArTq428W3ebjnRS+5yg0s2RR6EfnwwXGqJcnGyf7z0cGL0eH+4fOY5rOvDg8d7fNxUnKK/mhX4P/eiAfxTvwv1jdYNhTaggqFUqx32h6Lqm74ov8L5TWNQ5uaaNjmjQd4Zxi1Q09e/G8ifcxt5wpY+CfkISosdi+AXm83GvHHH95/WO7/4ce5Pj4+Pv7546fi7af58fFxib+Hw2FYVSD9/VdH0VhbzXZ/E301vHbraqySNNEVFs5Cq5M8OUpC8RliA0aOZrjIkzSpuOElODBYw1/TwpKjJKqpkzQRWMNX3BXJZmGvp18gcydUcDfFZ5ImBv5cCwN5cuRMDWli3UoiWSuwykjSBK4qqXNIjnwUTmxWQMmTo+vErSoa6YxQ8ySlOMxd/CTUKijSTwfTIjssqmmyXl94tmDdDzpfIalMKwfK4Z+8qqTISCmjLxZFv454duKeJ1jUojIu0kYUv0ZUlUHNOgGWBMWK7qES/xydZXxNeEOlx4r5hMclazeH2QoyMVs19T5NpfodfylYylV7yuiOKCczpkvhHORpz05+/es/bCCxxMw0BX9o6dURyTptldGtkhvDV2gSDsr4+Q4lGb1dR51GjrNM105x5ZAh1fW3KpUGxAS+aIgPAkjFG/FtXL9owOyBg6tCqztGHxw+w3+fHeD4UF8/dOebkxyS+KKnk68ynxwWOD8k2K/flrsVFNLvhJbclE3RlKnWEriK55Arr9OmmLqdfqjFp/oqWa/Txpk2glUUhSYfvSlOmrWvHzSNmMy0zMFgULxNMrJ7UPlk0xa7JW+CG8JGntpHMYLfsmUBrgBDj5dcOUbUu0oew4Fmwd+GDAGT/lldWDz2mBrGCTl2V6Zp/NETIRrLuMqZ0uwJ8ZvYmgziySj8nup89aSb6YtTL7PAUBJEoMFt+LC9qDEc96wA2TaO3LDbpvC+Dl/X1umSEZswiaJbCzGwENuH7DVXTKhM1qFWnWlUOAZGdn3dmIB3r/WaXV/jXoKZoMmv12n3AHn1HlAg8E8MZCAWvVntI+gmts+iqXBVCbOaYKHpH4R4EQsg5kqo+aQ2gY7SOHjYM8MNwamWDzqAvLUuMVdbVt1GUtrfe2v/hrLDviOR/zd6f1m9+klsEeXlqHr1snr1GVihK/Ae59UzEyr3/r4EKYfspXVGq/mrDRW8HIXn27fSwELAktyVdrWjsqnbltAwyPQnXceeIizLTJ0JLpFuZXQGzZHRFwtXjlkHlWXc4rGS1DITQGswjM8N0OGUZOG1K7QRf6HSqWH4krPCwOx/nmzo9MkrDLesAAMvR/xVGH0yozUSvMHVitHChVYWgQ4CWGe1oeCYSW7ELNRpKaskcAsMyzieORLea7SR46zg6tKmL6fm1Rnwkr2vQKEEv/7tnziiieQn6r3JwdwjlJ/MmAWKxE8wjj1JmW4O1zNhrAsB2se/YCFerh2uEwBRuRqyt23At/XU4ijV0OsCqjNiPgc84ocRNDn1uwc8K3yqIKn4DGM9cq/QeHRtG/HQwND8JaCBeTA3bNSQ/dAWeSmLtEPoQrz24Zaojrj4mX4dSL/hq7jW8FjLDZ0Slo4QepjFcr6yyI1KTnzBZVYTau19mKEPY1Yjc2ysP66MWk6tfAcvMOQpPpXw/uz0HjuNC2J73o19ue33wNNg789O2QI6YxyyT7bdp2bjeW8Iy3QObCG43/qULQuRkcutWIlnPFC0XyFqx4DN0INRbI/dFCgXdqtEqS80MP7WJNo2wiwXBjInV2RAunYIAIlwuKAYMNxWwXklnOn6Pj5zhyY5m9cip52uTZvTwdg0auFg28bUmY8KeW2aY04wWh/ErO301GgFB0X0UwbK+umczbh1YFJWK+q2mLpCb2hIwlUFRoDKYKsKotB9d/7Eao2aJdrXZRUYqxWGN23mXIXoiY2VJR7y2RQKLv3QECYsmwJKhd493Hpu+PVv/0w6uXaek24K5jnwPDdg7R0SEuLnzQkRaQT9VszpvkRID8zvNltTKB2Z5KTUeWum9v4WdIpIpbNtTAxwZQuV2jorMGW1sdbGDSfqQNkUl4QHC+pi6QrX2wIpDS4pdnnfB0A9ZpEMhMagz6BFqVXsPh2EqzfI0YFAWP80LuK3Whp2Cu/eSWwSlHzVNvKQduhegsLIk7PTN7+ntqOvJrbAtXjOjaKon37j7MNrpycGSqHulzM/+qRBm+h06/a10yV3ImMNKTtkYahXt9OxF5fsu0ZV6B0Loc3Trery5CZaZTARakL92ruT0M/0mDA0zD5TcEsAFcvWbJpPrR4uQtmWBSjW00mUKXHRfed4kaIOSzBzmGR44CZHgHvocTBAaoMB2/OyhCBqaxOQeNzLkEQp3XTUUaJQmreYYJf/0S464/xJL1FnbXWFNbCnjyplJHmAi2IOGVdKO39WxeNi287GgSUXqmPhmwG0X7SaUP9lhdaeH2qO+KS3rakpiYLF5+j6vOXuPTQyei41uXiocsPrnlAnM+ReUMKhLUyx/CU+tfW+opcKDMFjlYEZGMwPtj1vb31LR2Yuraal9ag2Ft3Y/MZRuTHpyrdG7oZt/mO4z22YUwvTpC20/VASXbsGYZv1LdDNJMZu6PBKg/t4ciQJrepwfx//13enN71mGCb+OsMaYlZLufqvJL0/Ony7ShsE/KE6Kb6Iw79cZYvD0wZorY38+p29GzjdBsJtXKJASfpS3G8p4cJKbeSe03u4lr3W8YhstN9CSaFg0mzgJNfZpFn9mkKntXz+YBNrt5vOR/29voN94g3y+TYris6u6glVz10bN5zUsUzAmNtcvcFDrXZtom6G9OOTMAyhcZpJZv7N7BGM0eah2jv1ucCCq6tuJZ7wXRp8vr8/yTolvtiiRLXgUuR0x+tMX4L6hu63c7nd4mL2zrNHUa9K2YXERPhB9D7prTZ+7hdpIauNcCtqmF3t8Urs+fdH5xfYhirBFRpbb5W2JDF2zo6SUT/Uja6jWLdOkKxZNG048sLWsSxX+VRf3bwNxisxWhwMEaTfnLP19tgt46Hee+gU6/hcqPld8y46jX3EXfUb19NbF/Uq8QdAbwjbEo8KfcgCOBamuBFoLB+6nt/bZsvb5tz2flvb1TpvGlRxF6ptQt3oLLVSNd2jtnkUdYiiBlHX8+m1fKiLEzVx4q5r03SJey6hRdq2VXq9EzK4rrGRJP3mhW+/boDx/x623IeWH/HS/0N46QZc6o1nG+Z38KKHtgULjWGjpq8fwyg9LGMTytgJK+xAFQIDf3pGs984t4b324+LeEzbekoLs6KKfLebJnFB3KtxLzA4CTXTcShqlE15iCLj5gnwM8hMe7AU924wiPannTUYtAHN2xiebN7XhlV6CWZWSzLDmYQrgcdXnAYlvet6ksBLCdbKFd1DntN5Khdz4RAVDPhYxis+FVJgovV30ry1d7naDtnnrqv5xND1aFiAxPzcAgBq3gXgpTaXM+yOpoyzKd5eRkgKVMFV5tEvnyYIxeHKI6aVEViaOINSCy+bVs6giZdc8Tk5XxobM8tBYiyyzOgpQq9Wy9q7kONCauOBZ1oQXagkJb7FOykGGD7FGG6gQFNcBITRph7htZQQcAkqZ1Ogq+g8cwKPgk6zWkmdXfqWQS0lq7TzMD6CD7GMON0ZrixdRvdYd9iDVmEB9wQbDtWfLOAOvxPqEq8W4mWi89auPsPUCgfdBfLlcnkjLz/tz/lRuJ/qKfsAlbbCabPqZs+FK+op5fKYSPvDU/qxuaUfZeqORq4zu+UOu87sqABZjT6CQwuxo+PTE6oMn7Jf//p39g64UazQS2+tWW1ArroPAlBzfue92trCzl9or12BGs94uKNI8bPR4OeCOzrBY2UgVHApfyvrtJ5KkXUX+weDo+Zifdf6Jqgk3OsPtzER8+es8rOlUJdDdqxW/qJ/m0bwOc3rLYNSV/RxQ3QBP7rVdRZxh9KCXPhvCwIiA7nwfR6j67nnFgsTFte/mIprO85zVm1cTkVUrhPHXz2lFgZdDCAEadt91t5Vz353GFReaaGcPWK54TPX0U83bqxSErvxqLns2qgjDWTaLfGeGFbcPvVYy0aV2Y+3hOEgQ9v73oRXIpjTeWOWDK313zFrf3GI8nJ0WsdydyuO7sCU9v3sI5iFyJoj9g6PHtHgUZImUmQQ0JmQqY5/PH3HFs+G+0ka1e73cO7Ru5PXb3/++BaFwUDqFXYw3B/u050pbV3JVcRp69c90Y3Anuajq3mPnwY9fhr0+GnQ46dBj58GPX4a9Php0OOnQY+fBj1+GvT4adB/7NOgALOjB40qyYWKWn6+TXG+0ZFN0uQo/hroIk0KbGscnSfX11gVfkIkEx//uSZs7fwiTRbcCMQCCTULtzzyCMnecRb47kPo8z5lOz4s2ip/0ztQ2DgglXhE8BJWG58yrS/WadNAQNH8iNdegL0zpNNRuNGWwg6In3GcYZV769i4D3T6/uNZkibNZeySvnxKDF8ihMiXXlqfyvxXM/jsOpFczWvqhSae5tpfzyn6DZNLapiEP3BVW/XR76T4ZeB/cVFbJ1xf+2YMQf5+vH+1c0ZQbDMaN+divV7/C/oIN9g=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,x={},j=[];function y(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Create Document from Template"}),"\n",(0,s.jsx)(o(),{method:"post",path:"/createdocument/{template_id}",context:"endpoint"}),"\n",(0,s.jsxs)(n.p,{children:["The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,s.jsx)(n.p,{children:"You can provide default value for all widgets based on their name all widgets support except signature, stamp, initials, image."}),"\n",(0,s.jsxs)(n.ol,{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 "name": "email",\n "readonly": false,\n "default": "email@example.com"\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",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 "name": "name",\n "readonly": false,\n "default": "joe"\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",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 "name": "job title",\n "readonly": false,\n "default": "ceo"\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",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 "name": "company",\n "readonly": false,\n "default": "example pvt ltd"\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",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 "name": "date",\n "readonly": false,\n "default": "11-05-2025"\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",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 "name": "textbox",\n "readonly": false,\n "default": "my text"\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",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 "name": "checkbox",\n "readonly": false,\n "default": ["option-2"]\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," You can have one or more than one value that needs to be selected by default."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"8",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 "name": "dropdown",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"9",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 "name": "radio",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "name": "number",\n "readonly": false,\n "default": 0,\n "formula": "",\n "decimalplaces": 2,\n}\n'})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document before it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that should replace the existing response."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{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 "name":"textbox",\n "response":"andrew bee"\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",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 "name": "date",\n "response": "04/15/2024"\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",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 "name": "checkbox",\n "response": ["male", "female"]\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Must be chosen from the existing values of checkbox defined in the template."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",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 "name": "radio button",\n "response": "male"\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Must be chosen from the existing values of radio button defined in the template."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",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 "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\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:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "name": "dropdown",\n "response": "female"\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Must be chosen from the existing values of dropdown defined in the template."]}),"\n"]}),"\n",(0,s.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:[{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["signers"],type:"object",properties:{title:{type:"string",format:"string",example:"New document title",description:"An optional parameter specifying the title for the newly created document. If omitted, the template\u2019s title will be used by default.\n"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"Accoutnant"},email:{type:"string",format:"mail",example:"joe@example.com"},name:{type:"string",example:"joe bee"},phone:{type:"string",example:"123123131"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},widgets:{type:"array",items:{type:"object",properties:{name:{type:"string",example:"textbox_1"},readonly:{type:"boolean",example:!1},default:{type:"string",example:"my textbox"}},title:"createdocumenttemplate_id_Signers_widgets"}}},title:"createdocumenttemplate_id_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}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},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}}, {{note}}.",example:"

Hi {{receiver_name}},

We hope this email finds you well. {{sender_name}} has requested you to review and sign {{document_title}}.

Your signature is crucial to proceed with the next steps as it signifies your agreement and authorization.

Sign here

If you have any questions or need further clarification, please contact the sender.

Thanks,
Team OpenSign\u2122

"},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},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},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},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},file:{type:"string",description:"You may provide the base64 encoded PDF file to replace the existing one",format:"base64",example:""},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:"5,"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",properties:{widgets:{type:"array",items:{type:"object",properties:{name:{type:"string",format:"string",example:"textbox"},response:{type:"string",format:"string",example:"andrew bee"}}}}}}},title:"createdocument_template_id_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:"If you haven't add widgets and signers in template or not provide signers along with their roles in body",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please setup template properly!"}},title:"inline_response_400_cc"}}}},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,i.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/c4fbe420.68ec300c.js b/assets/js/c4fbe420.68ec300c.js deleted file mode 100644 index 738c8c4b3..000000000 --- a/assets/js/c4fbe420.68ec300c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3795],{7258:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>j,contentTitle:()=>g,default:()=>b,frontMatter:()=>x,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/drafttemplate.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/drafttemplate","permalink":"/docs/API-docs/v1.1/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":"eJztPNtyG7eSv4KdOlWJeYYjkpZkW1u7tYqtOHJsSWvJcWxJRwFnQBLWDDAGMKJoFavOw/mDfdrX82n5kq1uAHPhRZJtOUfZYh5icXBrNLobfUH3VWDoUAdbx8ERy/KUGqaD0zBImI4Vzw2XItgKjkaM+GbyTNGB4WJItg92CRO0nzJNCs2UJkaSWDHoFBfayIx/glZi/Mwh0UxdwFiqST8tWK64MJoMpCJDJpiiOHEi4yJj0DDmZkRyxRI24IIlRBtVxKZQTEfkTS4F0UUcM60HRWpX5lIQOSC0XDMkZsQQVMVMoYQmlBSCfywYabVk/wOLzW7SapHvE6b5UFDDEgDODz/jyYOQjEc8HpGYCtJnsNUEduoAZjVw+xTapMA1dc5iPuDQ2U0Wke0k4QAjTdNJSChptQqVtlqEa5IrecETlvjV5GAAKKWIWsKFYWpAY4a4YjCLGOIyfnJCRUIGNOYpN000koRro3i/gJWjE3Eijni+Rd7kqaQJmchCkYNnP1bdjSTw7bjVesb6xZC82W21Tr8fGZPrrbU1mueRzJkAbKW0r6NYZmsJdMyTAeKKKQazIr4Y1TydEJokZMyTITMaD0SQWOYTEkupEi4saeR0yIgosj5TOsTdZFIxwgWhRDGaTNpGtgvNyIvD/T1AQ0ZNRA7SQoflcglXLDbpxE4P6PG7+s6ezuY60BAXw5Bk9BywxA35WPD4HLatmcCjdSSDuGq13gK8JXa4djSeEGJGXJMx64+kPCfsAprHPE2JUXw4ZKrVOhG//fbbibg6EYScBNjjJNgiJ4Gb4iQIbZOZ5My2PNt/+ubVzt7R2dG7g52y3VPqTJ/dZ2WPAU9nZ3jz+mXZLGg227y3/apaQEjj2g9SRjUjil1wNsZzgKO2e/VYKIfV5IQdXbbAIKY0fD2GL4Rc2X+a0BzuPt/beV2HxfZgGeVpo8vOq+3dl40++UiK5jQHP+3vNecpVG2W3b3nFim2fQr/nDp43YlsuwM62n21c3i0/eoAOk/dOQI1HBZ5LhUc/1tL0FtwzCfiB5bKMaGKIfXEMsukIDlVNGMGZeOIGmxW7GPBFUuscKNp6jlj60S0SasFuNlqtcgbK6V4woQBOaKQ9S3J4YDI9gfSgf67IuExsJIVC5OcgSRsdAUWg66HTjTZrjXGA9llxQ9w1JhaaZCnIHigq2Ig1Qy/YM2JL0MygYmfMaAjO+1IKv5JCkNTJKILpgyPaVpnegAQRaWhCkVWLrkw/qtbgbxzzA28jyztpBKAlgByMy6wRTNyQdOCaQfVOCQjgOo1yxXTKKHdvIB4kZAR48PR0vVo8qHQpjExKbSXux4Kt5Y/VUQvQ7QNaKoZ4YMGLjN6zmqrEZnb+yAiP0xIwga0SE1IOMgrowoWkT1pCM3zlMd4lwIN2IuqUKyNp+zIJ2qSz4G9T+AGSTjcJSCdoBGncGM8dECX9gKC7aHcNSMqiBQzBx3LVKp5EsLPTTySWArDhInI9gXlKQJvN6sJF3FaJIz0Uxqfh6gJhETB3QenMmFpKseh5Q/sgjcy4hzxQzRLgQqlAPiFdMtzXd25ETkCRin5Dxo9qnERrutYdTJ/IGFlQIFnSYJyKETEheSD7BPDTcpCYPCciklIEqtksEvTl5chiUcsPse/FE24JP3CGCnsxhIl80SOhcPlQAqj+acFHOlbPh+jvZCsh2QzJI9D0u2EpNsLSXc9JN3NkHQfh6TXCUmvF5Leekh6mxas3mOHa1oiuA5At2exbP482AU5/ZJr5GwQsLqU2eOGzO5GpNUquWn2uq7u5LJLebuBzIS2rvt9CT8e9h65nxP4udl77H6OsWt33f0cwc9et36v9BASQ7P8Giig+U4h8MqFJSL45u7ok8DLM/gIgij0DdXV7eCBhml9Lw9hL1xww2mql2/H97hHO6pAmtvUOmwKyXX5jpzOcm+2U4cHVRwQk7YJxWqtyTM8QtGb2/1G5G6W5Zu3y96bvdfA+bqtb8LWQTQdgWhavv9Set0jJMzC9HWYeBShAoCSeTkeXId7hIUmRF+Hg8eAA7iUliMAWu/R7mvgWIMNb3jb1llvdzfavU5vvYEBsKxthyxrJ0l7MpncBfZA53HLg8rjNVSr2YEHY6BktsD8QOug6uV0Ivzbq+yvQFHvs9KJAl6Dpg/G+wvqWraRCZ18p+1UfmipnEH/SjWb1MDEJoADfSfxSPLYAQ99vErWB4MwAhy0EZNrSbJWwyR8TJJ2lrVnPsLPNiK+9jHLoiSJZnrOnY79mJEkCcn854Xfk4RkWbbks/3e+LyWZfO7iLLMwYbK1xNgEqezLecT1+GPYpWKI5oLX8tG4HeSIsW10ZxbzEczl82IezePIyoy00GxYZFSxS7BLtWzvpM75DHPYpVmj3as8yQwr1iT7/ed9v7AkT9soTkBfLl53NzOYJJt5w4mig3ZJcmpMUwJnOyCpjyxbtu2dW1e0iwHE2DtbycnyV//soYOCLDxDYGTIAkfcvAirv3teLv9/nRBjyLPmYrBh5UyWEmHhJk4IscjluaVI3M8HkfjhzoeSZlaL+YHrdjA/v9M9j+cIbh5RHX+YNFOLWnUDH4gnVl7XzPTwBjVxI9cYPIjjSEPdTt42zp755rr1vW4RzfODEjQaL0n1hcYZBQVEiBlVv0tzYipk+C0HGONfJbcMPb0Fsw64glLaZ+l8023ZrTyc0onsnD87Z1aza06iq7hDRoyLkq/BW6nU3NTZvRypvGkclHO8LdFSJ07/ZXj2dOfAEm59p6bJjrro51rCx2UgtngRp8RP4D0Syr9ai4oAbsdG1hJ5M7uhiWgH8GOpVvRr3bDCo2DqSMG5si44FmRlf7RQTmrR1nmdI86vmAkxG38CvXTnVuBXt6wggs8LVngRHTRj+H9H9dopq7HPZIVMyBdz8ZfIkUa9/QdXbA3M6DfVp0BF1zL0NVeyCXz6eXcF5F9uN7AJ2sHgZctjlluwCP3taxZgnzrGwp9VnU/3HLKq/e6R9S3AKxvTIGu313fPl9EpPXd/4kItQH2rYnVOiUzOrzGcsfme0SeDp45J0QXnZH2vrjGIYft12+n22lsZ6O5nc3OF1hXjWW/3rjqlB8rq2oHHkOQuYXALi9SOifqExbzjKYYxUSoe5/PfwsYzC0HVPtUZnlh6myC3gAUBf5e9xE3G0H8a0jaIWmFZC0k34fkQUReM4zRxWU8z13zXNmoHYc3CAWEU+JCpRPSV7CdkLBoGJGrq48FFYabyXRKWuTqCh6mTKcR8M25kGMb0ju+4JobAg80KjMokbFe8KBDxnoN7KW1PTZuP3Nh/zUH2gPyvZxh4muNToeCz7Uylw37pqaX3UyNYmCVvVI3s+Ynhp65zlM6IXQA1GjDkzjMRrEjOJkt0iP/8Z+k24s6nZB07N/w1sjipfcA2BmiVQeKDeDlSPWmgPhPnhwgRstSlrk4tntNALorRra4MBJQ7t+ptFp9NpAQ1YInLhAbHdHq1YFVHq2crj+TsW9bpCIjqq1RjVY87Bfe8JgRy1x8bU8aZoPrOpdCM3uv5AuAroLjrdZMcM53qwJ0XPiNg2Tr3p0nqfekUxd13c2NhuTeaMq6zjJZd40jCSSaxYX3vrOqqSZpVPnuZ6GYmZUzflJAtpV8nqgttcsiTUjKz1mdKLnQ/t52UM4G8J+OpNRVDxdDd3ytt5qxeakgPP8gKkOVX+sC7z562Lh4Ht+BX2/G0908jM76Wndj7VpX94yD9vPvB0Juc3LoQ77VyWHP6uhWLukvdUnfDeE/vEuPXPdRr6FIPux8PQPckeOtzjg3uNzuwrF2Zx6uOrvd0rf1h/mYvp761r+FtT0jhh9170AMLzGqv5YS52znO6M9cleG8yICvIXlfK25/NUEWgf2mxPpxt1Y2d1OQ1d70lDVnvTqRLmxcSuirC86Q1knAf/lh/3X487Pz4dye3t7e+/wzWjnzXB7ezuD31EULXSwLDptXAZ0WPfW3N3LeMcvWSWKIkBhQg3dwuFruRj+ux0fLh8TuZcp38jru3EXgdYFzt2vlwJl1z/molnkyf12fP61HBiEgcwxjUaK3STYChJI1vEpIkGIzhimzQ8ymQRbV4F7UQp/uveaMHLtg4a0n6tAxyOWUfjLW3CQKASZBkHoH/gHYYBPjCBrCIgu2HLJCkEI4e8cfJRMwxw4buvK97J5GEHotPBgK7BEH4SBCwKXnwgTsYRnHXkyCKZ+weumKr9UU2n8o8yXgXngsfoXToNDpzOJUl80U32GaYXWajKqFJ0EszlZ/pW6f2Jgx5XPcNOJvxu4Ac9H+XQauwVhwA3L6qssOTQlPx/TMZOwE3x++Llj8Vho9tlrwjjMB/mSge6F2JcM/SD7Z19EjjDYuT8WnPUtT8e2zi/cJJVteHfNEq8Mt6sEgpDgI97oJkr1/RHLdFhf0zrp5tY8WpZYUnvPrkdoAdM8Z1RFmN/xxYlnmHtI07jAXLhSGjd2VoJa7qw7DYPLmzdzSWLZ9lkr5PuUDYx9ZUJiqQRTD+pP1+7N5nrr69MwmNy8vcmfcnuP4PDGN+/uLab7VKlQ/wpYHz6ehsHoZlh/KhOS/oXArm9OqzvW5cWV+bB9mUzOvNya3tTRX2bQD5Ird8W+SpiqIaIvZcqomMPE7sD67yX5Dgyd70L7tgvzSLjS/iKz+ZaKxQxy0vDJp5dVxOk6NsmEuLf94PvfgQ+onemir6GX8PNpO2Gf+RxOSDq2PbhN2kX/OaPxCLJF3YuzKgSQQ9qkLLQHD9zocLukDJzbNpwDTVwMm8ZYDTvorK/vPaqfDnyByxUTr/ePDm6BS7QU2zZ10OoHdpd2DrJ/dADZeXzg1L+IvNElJjxqaaMLAXWMXHDqM3hK2T6x72GYdXdKnztaRRgilxfXJvMAJVwvhCiELB6bOlQmms9NXCX/whHJwkDEwmVbE21Yrht4RChKRB7J4jZUeQMmKRkW+PzYAMv6VD18gVhl13Fhs9jRzEgK5RMKHVlAT0hpr/DksQKdavOHhAlth1MyoNowFUJqO2BeFWBUlFOyy5wpDsHFhShQzKLurFAL9bUmDpqpam9ev3Qp334Pnin7wIF2YpaQIkeqQU4oUyj9yc1ufU5RAu5g6myZYjivemDI1HlAcqY0lAVQRKohFfyTKxMAGgkYWX02oqnt6kQFeMoBHuDwJjBe1v7+j3/W4Fqq6c4DZlegSQLvY2+AEC1JS/Cg6SuWgwSUTYhgPqb+a/YSAOiQac4ymZSMpG9P4wf4olaXctFFAMsIpC7iERgWpbzVoZex2qmVGk1TtF8xhJjDftkl16aWBOif6s/Lh9cM8BjXYEA1BLgaaF5M6gxeRUblzHSYqsibCaTlNTjHC7Qw8kyxjIvb3VN1Z5yRpSAojMyo4THxU+momRZsIz6er7MqJgzUeMGlerCEVWG6MylidsbFGbtg6hYKXi18TSdA3GbMmKjD5pFkr7MqdXMMtQ8aOKndTpig3CDGjRDoLmNqyM5iMFOQ8Ngt8NhqwWytFmlbWJxY1YVyHhWXVY/yA0RJNTtA5PJfy8SP6s6tl7aIyE9yDDgLSW6rHIAZb+cHlBKEPLE1Q+orxFRAAiw6cyDrFSYuo2sZ5VV9CBfgxvPC3exaKzy2Dh2YBbLAYZ3wuj15EVpmtFDI5ParW46wmwO3CqGpRJYyo0oOJ02gdjGJd4RXEB4heIDtOj6zXo4FU7///X81xvHtcxQdwRaWtmKEn6Za2gzh+qyeoj3NW//UHEm7JwOLjN3rPR5egFTVWVjWh4do+O4BNSq8aWTl9Ghaz9/M/L7Olnbh+JUl/ScyNbudzv9nS/ph589jSa93/kSW9GMA1vnsb5Ymy7TbhbLDxyCuH/BBMuvfTKW6vif49qdhGTFZhOCKHXpT+19l/HshfoNDwHoMqmCCM2b9ZhANvU4H/pkRgr7Kla+9VBX+Sif/FoS3j2Rcfwa+ztL1yPph1PtJ5yKLR4CzJVZT1f16EqtHaNbY5MWo/zzm+/zF7ptPu909vqt3xeuN+Onu5u55/usvT188idjkRTfu/TL5tfeLefc21bsfJI9/ejF6L37R/acbxbtf36t3v+6qd29fG/p2Y7svRqL//EceTzY+9Hsd/vLpi877t91x//mPnfe/PMnf4+Q/dt6fn3fibO9pX2xDn/zdr//N9z/sPHz1aefTq6Ody1ef0icR3fv44ell/OTV+c5m+/2uar/a7//84aPJX28kD/d+5ZuP2Sv2Vhx1XsYNauAi5YKd+aM+w32fwWFbSlpfdOyHMmNWZRljcS0loXKX092MmhA6BOULUKfukAqYUjfxy+dBdh0i1juds26JhI15JOwKzCnDInZH8pyJP3an9eWNXR5AvczSSmgF3HbC9qCx2fp3u0nN4kJxMwm2jq+CyzbNedu2bx2fTk/BfDAjCcHLXGqEmJpRsBWszcYyoZYgRsqOrywPloymqUjgTc4cs9Gcr110o24wDWfHLGTOa/qzov25Q7ShQy6GN407rVB0CMdoT6qBqEphzfnPDDRWdw71XmHAgXxGjIIpC5gH6nhdRYB3/Bn72OyicGt1lrMBVB8/bYREZ+/hBUHOWozz2AcYMWZYhgyDakNBGdYLglqgDn7UQm/ws9TmjytqLuNWXtnuopbaW19Hde5RF/Weh49RpVjfnJ5a5Ncc1ZixUPe22pdGDbeh+9R0owXBjNuq4TuadR0tdeMs8eK4JWe8FSUgi5wEYJwvtM3dqJodtgCVXvVoIhIe6gAiH3YQkesdROTjTkPrcduvZqh0F1RQSv0ElZC6DgKKxikQLhcDiVTvjns/Z+IQHMAglJBr5nRVlsYyK2tPtVp+yO//+Gc5qtUqTWRaFsfcLxTJ5ZgpKCqKRTVTdsnBGYIFTzNs02jUY5IBzVKmNcTbhWFDWxEUkgTA6+z8mjHNaR8Kc4LXFB/q4zPdmuDWEXk7YpgvMpHFd8pmT1ywFIR16U6qF/UcS3U+SOUYamWSPmSVgEORiREVsfVdWhGCPjiwjcEvnCuuodyeAqi5hU0Ko2hsSEYFHaITLSR1ZCUs5SBniZJ9cO1rmRbWeW0oT6WyjypxQ/jqBZG4c5lDEyrcwLSKjYCwL5wHW4c2gmClgyv32YdgTQ6wcHAsGEkKkUqozAlBnyKFxApjAzGg19dhhOFGUaFBGbew+DMoEeacy0w7F80bzeCEX3JxbuuBtclxSVdvWV9zw5rVAmaZ80FzzHNufir6UG1Qam6kmlSjh9yMij7K+fok5Q8703NfUbYmxW+fqHPIDFCIXts+2EU14QH5/e//Q14yqgQZybGl1rhQLJ1UxWuxziqevEVbectj+IIWUKzVIJGKoY+o6bIwKjXoD9pjY3C8WZayL5kOin7K47JqsG61tshTWxu4LAfczG626SkQU6Ikt6NTLs4jsi0mtghu6d6C7ziusQ2MCC0pxluV4D2qrc4yzdILpmv+PSiti5E6JYuhXa0OjNtcM1sH9radJHPJL+DjrcCxXikMkVHrnoLytQvyZRrJMM3CeUwkmFyktwhqQ9X84UwKD0bN5j757J+qOrKdplahGTDpdlx+tZ67GQ2kKW/RIwgL6kZtZJpzR07HnixJswzH55O1tWiFoTGqv/4GpTlfGAWBAqF6f3AIladjb44t4eg17LwWhEHKY+bMa3d/bT8/eEkuHkadIKzpdbdg7rWXu0939g53ABgQpBZh3agTddALKLXJqKithBW2S0Kdvdpqr/ZWhblXhblXhblXhblXhblXhblXhblXhblXhblXhbnvNXZXhblXhblXhblXhblXhblXhblXhblXhblXhblXhblXhblXhblXhblXhblXhblXhblXhbnvi6xYFea+L/WOV4W5/wgKXBXmXhXmXhXmXhXmXhXmXhXmXhXmXhXmXhXmXhXmXhXmXhXmXhXmXhXmXhXmXhXmXhXmPlkV5l4V5l4V5v7iwty1RNq1PKVc1GpH2BT345ly3adhMIIU+K3j4OoKCO+NSqdT+PyxwJTe49MwuKCKw2NOzJ4PfbY3ZO6eM8j6fWrfpraPYPnQnjNmS80UDYB0dTtiG7d+bd96lv7B/uFREAZ9V1I8kwnWE6FjyPSlY5sJXUsHxm9XQUrFsMBU4sDOObXV10bN7PZzzG53f9TykSELvIKwmfZutwH/h00tHHB1ZTPnp9Oyv21aOsIh1veG4zudTqf/B77s3gA=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Formdata","permalink":"/docs/API-docs/v1.1/getformdata"},"next":{"title":"Create Template","permalink":"/docs/API-docs/v1.1/createtemplate"}}');var s=t(74848),r=t(28453),l=t(33617),o=t.n(l),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 x={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:"eJztPNtyG7eSv4KdOlWJeYYjkpZkW1u7tYqtOHJsSWvJcWxJRwFnQBLWDDAGMKJoFavOw/mDfdrX82n5kq1uAHPhRZJtOUfZYh5icXBrNLobfUH3VWDoUAdbx8ERy/KUGqaD0zBImI4Vzw2XItgKjkaM+GbyTNGB4WJItg92CRO0nzJNCs2UJkaSWDHoFBfayIx/glZi/Mwh0UxdwFiqST8tWK64MJoMpCJDJpiiOHEi4yJj0DDmZkRyxRI24IIlRBtVxKZQTEfkTS4F0UUcM60HRWpX5lIQOSC0XDMkZsQQVMVMoYQmlBSCfywYabVk/wOLzW7SapHvE6b5UFDDEgDODz/jyYOQjEc8HpGYCtJnsNUEduoAZjVw+xTapMA1dc5iPuDQ2U0Wke0k4QAjTdNJSChptQqVtlqEa5IrecETlvjV5GAAKKWIWsKFYWpAY4a4YjCLGOIyfnJCRUIGNOYpN000koRro3i/gJWjE3Eijni+Rd7kqaQJmchCkYNnP1bdjSTw7bjVesb6xZC82W21Tr8fGZPrrbU1mueRzJkAbKW0r6NYZmsJdMyTAeKKKQazIr4Y1TydEJokZMyTITMaD0SQWOYTEkupEi4saeR0yIgosj5TOsTdZFIxwgWhRDGaTNpGtgvNyIvD/T1AQ0ZNRA7SQoflcglXLDbpxE4P6PG7+s6ezuY60BAXw5Bk9BywxA35WPD4HLatmcCjdSSDuGq13gK8JXa4djSeEGJGXJMx64+kPCfsAprHPE2JUXw4ZKrVOhG//fbbibg6EYScBNjjJNgiJ4Gb4iQIbZOZ5My2PNt/+ubVzt7R2dG7g52y3VPqTJ/dZ2WPAU9nZ3jz+mXZLGg227y3/apaQEjj2g9SRjUjil1wNsZzgKO2e/VYKIfV5IQdXbbAIKY0fD2GL4Rc2X+a0BzuPt/beV2HxfZgGeVpo8vOq+3dl40++UiK5jQHP+3vNecpVG2W3b3nFim2fQr/nDp43YlsuwM62n21c3i0/eoAOk/dOQI1HBZ5LhUc/1tL0FtwzCfiB5bKMaGKIfXEMsukIDlVNGMGZeOIGmxW7GPBFUuscKNp6jlj60S0SasFuNlqtcgbK6V4woQBOaKQ9S3J4YDI9gfSgf67IuExsJIVC5OcgSRsdAUWg66HTjTZrjXGA9llxQ9w1JhaaZCnIHigq2Ig1Qy/YM2JL0MygYmfMaAjO+1IKv5JCkNTJKILpgyPaVpnegAQRaWhCkVWLrkw/qtbgbxzzA28jyztpBKAlgByMy6wRTNyQdOCaQfVOCQjgOo1yxXTKKHdvIB4kZAR48PR0vVo8qHQpjExKbSXux4Kt5Y/VUQvQ7QNaKoZ4YMGLjN6zmqrEZnb+yAiP0xIwga0SE1IOMgrowoWkT1pCM3zlMd4lwIN2IuqUKyNp+zIJ2qSz4G9T+AGSTjcJSCdoBGncGM8dECX9gKC7aHcNSMqiBQzBx3LVKp5EsLPTTySWArDhInI9gXlKQJvN6sJF3FaJIz0Uxqfh6gJhETB3QenMmFpKseh5Q/sgjcy4hzxQzRLgQqlAPiFdMtzXd25ETkCRin5Dxo9qnERrutYdTJ/IGFlQIFnSYJyKETEheSD7BPDTcpCYPCciklIEqtksEvTl5chiUcsPse/FE24JP3CGCnsxhIl80SOhcPlQAqj+acFHOlbPh+jvZCsh2QzJI9D0u2EpNsLSXc9JN3NkHQfh6TXCUmvF5Leekh6mxas3mOHa1oiuA5At2exbP482AU5/ZJr5GwQsLqU2eOGzO5GpNUquWn2uq7u5LJLebuBzIS2rvt9CT8e9h65nxP4udl77H6OsWt33f0cwc9et36v9BASQ7P8Giig+U4h8MqFJSL45u7ok8DLM/gIgij0DdXV7eCBhml9Lw9hL1xww2mql2/H97hHO6pAmtvUOmwKyXX5jpzOcm+2U4cHVRwQk7YJxWqtyTM8QtGb2/1G5G6W5Zu3y96bvdfA+bqtb8LWQTQdgWhavv9Set0jJMzC9HWYeBShAoCSeTkeXId7hIUmRF+Hg8eAA7iUliMAWu/R7mvgWIMNb3jb1llvdzfavU5vvYEBsKxthyxrJ0l7MpncBfZA53HLg8rjNVSr2YEHY6BktsD8QOug6uV0Ivzbq+yvQFHvs9KJAl6Dpg/G+wvqWraRCZ18p+1UfmipnEH/SjWb1MDEJoADfSfxSPLYAQ99vErWB4MwAhy0EZNrSbJWwyR8TJJ2lrVnPsLPNiK+9jHLoiSJZnrOnY79mJEkCcn854Xfk4RkWbbks/3e+LyWZfO7iLLMwYbK1xNgEqezLecT1+GPYpWKI5oLX8tG4HeSIsW10ZxbzEczl82IezePIyoy00GxYZFSxS7BLtWzvpM75DHPYpVmj3as8yQwr1iT7/ed9v7AkT9soTkBfLl53NzOYJJt5w4mig3ZJcmpMUwJnOyCpjyxbtu2dW1e0iwHE2DtbycnyV//soYOCLDxDYGTIAkfcvAirv3teLv9/nRBjyLPmYrBh5UyWEmHhJk4IscjluaVI3M8HkfjhzoeSZlaL+YHrdjA/v9M9j+cIbh5RHX+YNFOLWnUDH4gnVl7XzPTwBjVxI9cYPIjjSEPdTt42zp755rr1vW4RzfODEjQaL0n1hcYZBQVEiBlVv0tzYipk+C0HGONfJbcMPb0Fsw64glLaZ+l8023ZrTyc0onsnD87Z1aza06iq7hDRoyLkq/BW6nU3NTZvRypvGkclHO8LdFSJ07/ZXj2dOfAEm59p6bJjrro51rCx2UgtngRp8RP4D0Syr9ai4oAbsdG1hJ5M7uhiWgH8GOpVvRr3bDCo2DqSMG5si44FmRlf7RQTmrR1nmdI86vmAkxG38CvXTnVuBXt6wggs8LVngRHTRj+H9H9dopq7HPZIVMyBdz8ZfIkUa9/QdXbA3M6DfVp0BF1zL0NVeyCXz6eXcF5F9uN7AJ2sHgZctjlluwCP3taxZgnzrGwp9VnU/3HLKq/e6R9S3AKxvTIGu313fPl9EpPXd/4kItQH2rYnVOiUzOrzGcsfme0SeDp45J0QXnZH2vrjGIYft12+n22lsZ6O5nc3OF1hXjWW/3rjqlB8rq2oHHkOQuYXALi9SOifqExbzjKYYxUSoe5/PfwsYzC0HVPtUZnlh6myC3gAUBf5e9xE3G0H8a0jaIWmFZC0k34fkQUReM4zRxWU8z13zXNmoHYc3CAWEU+JCpRPSV7CdkLBoGJGrq48FFYabyXRKWuTqCh6mTKcR8M25kGMb0ju+4JobAg80KjMokbFe8KBDxnoN7KW1PTZuP3Nh/zUH2gPyvZxh4muNToeCz7Uylw37pqaX3UyNYmCVvVI3s+Ynhp65zlM6IXQA1GjDkzjMRrEjOJkt0iP/8Z+k24s6nZB07N/w1sjipfcA2BmiVQeKDeDlSPWmgPhPnhwgRstSlrk4tntNALorRra4MBJQ7t+ptFp9NpAQ1YInLhAbHdHq1YFVHq2crj+TsW9bpCIjqq1RjVY87Bfe8JgRy1x8bU8aZoPrOpdCM3uv5AuAroLjrdZMcM53qwJ0XPiNg2Tr3p0nqfekUxd13c2NhuTeaMq6zjJZd40jCSSaxYX3vrOqqSZpVPnuZ6GYmZUzflJAtpV8nqgttcsiTUjKz1mdKLnQ/t52UM4G8J+OpNRVDxdDd3ytt5qxeakgPP8gKkOVX+sC7z562Lh4Ht+BX2/G0908jM76Wndj7VpX94yD9vPvB0Juc3LoQ77VyWHP6uhWLukvdUnfDeE/vEuPXPdRr6FIPux8PQPckeOtzjg3uNzuwrF2Zx6uOrvd0rf1h/mYvp761r+FtT0jhh9170AMLzGqv5YS52znO6M9cleG8yICvIXlfK25/NUEWgf2mxPpxt1Y2d1OQ1d70lDVnvTqRLmxcSuirC86Q1knAf/lh/3X487Pz4dye3t7e+/wzWjnzXB7ezuD31EULXSwLDptXAZ0WPfW3N3LeMcvWSWKIkBhQg3dwuFruRj+ux0fLh8TuZcp38jru3EXgdYFzt2vlwJl1z/molnkyf12fP61HBiEgcwxjUaK3STYChJI1vEpIkGIzhimzQ8ymQRbV4F7UQp/uveaMHLtg4a0n6tAxyOWUfjLW3CQKASZBkHoH/gHYYBPjCBrCIgu2HLJCkEI4e8cfJRMwxw4buvK97J5GEHotPBgK7BEH4SBCwKXnwgTsYRnHXkyCKZ+weumKr9UU2n8o8yXgXngsfoXToNDpzOJUl80U32GaYXWajKqFJ0EszlZ/pW6f2Jgx5XPcNOJvxu4Ac9H+XQauwVhwA3L6qssOTQlPx/TMZOwE3x++Llj8Vho9tlrwjjMB/mSge6F2JcM/SD7Z19EjjDYuT8WnPUtT8e2zi/cJJVteHfNEq8Mt6sEgpDgI97oJkr1/RHLdFhf0zrp5tY8WpZYUnvPrkdoAdM8Z1RFmN/xxYlnmHtI07jAXLhSGjd2VoJa7qw7DYPLmzdzSWLZ9lkr5PuUDYx9ZUJiqQRTD+pP1+7N5nrr69MwmNy8vcmfcnuP4PDGN+/uLab7VKlQ/wpYHz6ehsHoZlh/KhOS/oXArm9OqzvW5cWV+bB9mUzOvNya3tTRX2bQD5Ird8W+SpiqIaIvZcqomMPE7sD67yX5Dgyd70L7tgvzSLjS/iKz+ZaKxQxy0vDJp5dVxOk6NsmEuLf94PvfgQ+onemir6GX8PNpO2Gf+RxOSDq2PbhN2kX/OaPxCLJF3YuzKgSQQ9qkLLQHD9zocLukDJzbNpwDTVwMm8ZYDTvorK/vPaqfDnyByxUTr/ePDm6BS7QU2zZ10OoHdpd2DrJ/dADZeXzg1L+IvNElJjxqaaMLAXWMXHDqM3hK2T6x72GYdXdKnztaRRgilxfXJvMAJVwvhCiELB6bOlQmms9NXCX/whHJwkDEwmVbE21Yrht4RChKRB7J4jZUeQMmKRkW+PzYAMv6VD18gVhl13Fhs9jRzEgK5RMKHVlAT0hpr/DksQKdavOHhAlth1MyoNowFUJqO2BeFWBUlFOyy5wpDsHFhShQzKLurFAL9bUmDpqpam9ev3Qp334Pnin7wIF2YpaQIkeqQU4oUyj9yc1ufU5RAu5g6myZYjivemDI1HlAcqY0lAVQRKohFfyTKxMAGgkYWX02oqnt6kQFeMoBHuDwJjBe1v7+j3/W4Fqq6c4DZlegSQLvY2+AEC1JS/Cg6SuWgwSUTYhgPqb+a/YSAOiQac4ymZSMpG9P4wf4olaXctFFAMsIpC7iERgWpbzVoZex2qmVGk1TtF8xhJjDftkl16aWBOif6s/Lh9cM8BjXYEA1BLgaaF5M6gxeRUblzHSYqsibCaTlNTjHC7Qw8kyxjIvb3VN1Z5yRpSAojMyo4THxU+momRZsIz6er7MqJgzUeMGlerCEVWG6MylidsbFGbtg6hYKXi18TSdA3GbMmKjD5pFkr7MqdXMMtQ8aOKndTpig3CDGjRDoLmNqyM5iMFOQ8Ngt8NhqwWytFmlbWJxY1YVyHhWXVY/yA0RJNTtA5PJfy8SP6s6tl7aIyE9yDDgLSW6rHIAZb+cHlBKEPLE1Q+orxFRAAiw6cyDrFSYuo2sZ5VV9CBfgxvPC3exaKzy2Dh2YBbLAYZ3wuj15EVpmtFDI5ParW46wmwO3CqGpRJYyo0oOJ02gdjGJd4RXEB4heIDtOj6zXo4FU7///X81xvHtcxQdwRaWtmKEn6Za2gzh+qyeoj3NW//UHEm7JwOLjN3rPR5egFTVWVjWh4do+O4BNSq8aWTl9Ghaz9/M/L7Olnbh+JUl/ScyNbudzv9nS/ph589jSa93/kSW9GMA1vnsb5Ymy7TbhbLDxyCuH/BBMuvfTKW6vif49qdhGTFZhOCKHXpT+19l/HshfoNDwHoMqmCCM2b9ZhANvU4H/pkRgr7Kla+9VBX+Sif/FoS3j2Rcfwa+ztL1yPph1PtJ5yKLR4CzJVZT1f16EqtHaNbY5MWo/zzm+/zF7ptPu909vqt3xeuN+Onu5u55/usvT188idjkRTfu/TL5tfeLefc21bsfJI9/ejF6L37R/acbxbtf36t3v+6qd29fG/p2Y7svRqL//EceTzY+9Hsd/vLpi877t91x//mPnfe/PMnf4+Q/dt6fn3fibO9pX2xDn/zdr//N9z/sPHz1aefTq6Ody1ef0icR3fv44ell/OTV+c5m+/2uar/a7//84aPJX28kD/d+5ZuP2Sv2Vhx1XsYNauAi5YKd+aM+w32fwWFbSlpfdOyHMmNWZRljcS0loXKX092MmhA6BOULUKfukAqYUjfxy+dBdh0i1juds26JhI15JOwKzCnDInZH8pyJP3an9eWNXR5AvczSSmgF3HbC9qCx2fp3u0nN4kJxMwm2jq+CyzbNedu2bx2fTk/BfDAjCcHLXGqEmJpRsBWszcYyoZYgRsqOrywPloymqUjgTc4cs9Gcr110o24wDWfHLGTOa/qzov25Q7ShQy6GN407rVB0CMdoT6qBqEphzfnPDDRWdw71XmHAgXxGjIIpC5gH6nhdRYB3/Bn72OyicGt1lrMBVB8/bYREZ+/hBUHOWozz2AcYMWZYhgyDakNBGdYLglqgDn7UQm/ws9TmjytqLuNWXtnuopbaW19Hde5RF/Weh49RpVjfnJ5a5Ncc1ZixUPe22pdGDbeh+9R0owXBjNuq4TuadR0tdeMs8eK4JWe8FSUgi5wEYJwvtM3dqJodtgCVXvVoIhIe6gAiH3YQkesdROTjTkPrcduvZqh0F1RQSv0ElZC6DgKKxikQLhcDiVTvjns/Z+IQHMAglJBr5nRVlsYyK2tPtVp+yO//+Gc5qtUqTWRaFsfcLxTJ5ZgpKCqKRTVTdsnBGYIFTzNs02jUY5IBzVKmNcTbhWFDWxEUkgTA6+z8mjHNaR8Kc4LXFB/q4zPdmuDWEXk7YpgvMpHFd8pmT1ywFIR16U6qF/UcS3U+SOUYamWSPmSVgEORiREVsfVdWhGCPjiwjcEvnCuuodyeAqi5hU0Ko2hsSEYFHaITLSR1ZCUs5SBniZJ9cO1rmRbWeW0oT6WyjypxQ/jqBZG4c5lDEyrcwLSKjYCwL5wHW4c2gmClgyv32YdgTQ6wcHAsGEkKkUqozAlBnyKFxApjAzGg19dhhOFGUaFBGbew+DMoEeacy0w7F80bzeCEX3JxbuuBtclxSVdvWV9zw5rVAmaZ80FzzHNufir6UG1Qam6kmlSjh9yMij7K+fok5Q8703NfUbYmxW+fqHPIDFCIXts+2EU14QH5/e//Q14yqgQZybGl1rhQLJ1UxWuxziqevEVbectj+IIWUKzVIJGKoY+o6bIwKjXoD9pjY3C8WZayL5kOin7K47JqsG61tshTWxu4LAfczG626SkQU6Ikt6NTLs4jsi0mtghu6d6C7ziusQ2MCC0pxluV4D2qrc4yzdILpmv+PSiti5E6JYuhXa0OjNtcM1sH9radJHPJL+DjrcCxXikMkVHrnoLytQvyZRrJMM3CeUwkmFyktwhqQ9X84UwKD0bN5j757J+qOrKdplahGTDpdlx+tZ67GQ2kKW/RIwgL6kZtZJpzR07HnixJswzH55O1tWiFoTGqv/4GpTlfGAWBAqF6f3AIladjb44t4eg17LwWhEHKY+bMa3d/bT8/eEkuHkadIKzpdbdg7rWXu0939g53ABgQpBZh3agTddALKLXJqKithBW2S0Kdvdpqr/ZWhblXhblXhblXhblXhblXhblXhblXhblXhblXhbnvNXZXhblXhblXhblXhblXhblXhblXhblXhblXhblXhblXhblXhblXhblXhblXhblXhblXhbnvi6xYFea+L/WOV4W5/wgKXBXmXhXmXhXmXhXmXhXmXhXmXhXmXhXmXhXmXhXmXhXmXhXmXhXmXhXmXhXmXhXmXhXmPlkV5l4V5l4V5v7iwty1RNq1PKVc1GpH2BT345ly3adhMIIU+K3j4OoKCO+NSqdT+PyxwJTe49MwuKCKw2NOzJ4PfbY3ZO6eM8j6fWrfpraPYPnQnjNmS80UDYB0dTtiG7d+bd96lv7B/uFREAZ9V1I8kwnWE6FjyPSlY5sJXUsHxm9XQUrFsMBU4sDOObXV10bN7PZzzG53f9TykSELvIKwmfZutwH/h00tHHB1ZTPnp9Oyv21aOsIh1veG4zudTqf/B77s3gA=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,j={},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)(u.default,{as:"h1",className:"openapi__heading",children:"Draft Template"}),"\n",(0,s.jsx)(o(),{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:"name:"})," Unique identifier for this widget."]}),"\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:'"mm/dd/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",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\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:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (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 "layout": "vertical",\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 "layout": "vertical"\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.jsxs)(n.ol,{start:"14",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": "",\n "decimalplaces": 2,\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:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the number (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",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,s.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Note:"})," Responses for prefill widgets are ",(0,s.jsx)(n.strong,{children:"required"}),"."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{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": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\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:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",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": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "name": "date",\n "response": "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:"response:"})," Enter the date you would like to display inside the date box."]}),"\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:'"mm/dd/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",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",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": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\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 checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\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:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",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": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\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:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\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 radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",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": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"6",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": 528,\n "w": 114,\n "h": 21,\n "options": {\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\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:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\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","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},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:""},company:{type:"string",format:"string",example:""},job_title:{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},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:"5,"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},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:100},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:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,s.jsx)(m(),{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 b(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/c4fbe420.79cbf939.js b/assets/js/c4fbe420.79cbf939.js new file mode 100644 index 000000000..c201e5d04 --- /dev/null +++ b/assets/js/c4fbe420.79cbf939.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3795],{7258:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>x,default:()=>b,frontMatter:()=>g,metadata:()=>i,toc:()=>j});const i=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/drafttemplate.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/drafttemplate","permalink":"/docs/API-docs/v1.1/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":"eJztPNlyGzmSv4KtmIhuc4oUSUk+tLEbq7bVbnlsSWtJ7bYljQasAklYVUAZQImiFYyYh/mDfdrX+bT+ko1MAHXwkGRb9rg3qh/aYuFKJDITeSDzOjB0pIOtk+CIpVlCDdPBWRjETEeKZ4ZLEWwFR2NGfDN5pujQcDEi2we7hAk6SJgmuWZKEyNJpBh0inJtZMo/QisxfuaQaKYuYSzVZJDkLFNcGE2GUpERE0xRnDiWUZ4yaJhwMyaZYjEbcsFioo3KI5MrpjvkOJOC6DyKmNbDPLErcymIHBJarBkSM2YIqmImV0ITSnLBP+SMtFpy8J5FZjdutciPMdN8JKhhMQDnh5/z+EFIJmMejUlEBRkw2GoMO3UAswq4AwptUuCaOmMRH3Lo7CbrkO045gAjTZJpSChptXKVtFqEa5IpecljFvvV5HAIKKWIWsKFYWpII4a4YjCLGOEyfnJCRUyGNOIJN3U0kphro/ggh5U7p+JUHPFsixxniaQxmcpckYNnP5fdjSTw7aTVesYG+Ygc77ZaZz+Ojcn01toazbKOzJgAbCV0oDuRTNdi6JjFQ8QVUwxmRXwxqnkyJTSOyYTHI2Y0HoggkcymJJJSxVxY0sjoiBGRpwOmdIi7SaVihAtCiWI0nraNbOeakReH+3uAhpSaDjlIch0Wy8VcscgkUzs9oMfv6gd7Og83gIa4GIUkpReAJW7Ih5xHF7BtzQQerSMZxFWr9QbgLbDDtaPxmBAz5ppM2GAs5QVhl9A84UlCjOKjEVOt1qn429/+diquTwUhpwH2OA22yGngpjgNQttkphmzLc/2nx6/2tk7Oj96e7BTtHtKneuz+6zoMeTJ/AzHr18WzYKm881726/KBYQ0rv0gYVQzotglZxM8Bzhqu1ePhWJYRU7Y0UULDGJKw9cT+ELItf2nDs3h7vO9nddVWGwPllKe1LrsvNrefVnrk42lqE9z8Mv+Xn2eXFVm2d17bpFi22fwz5mD153Itjugo91XO4dH268OoPPMnSNQw2GeZVLB8b+xBL0Fx3wqfmKJnBCqGFJPJNNUCpJRRVNmUDaOqcFmxT7kXLHYCjeaJJ4ztk5Fm7RagJutVoscWynFYyYMyBGFrG9JDgd0bH8gHei/K2IeAStZsTDNGEjCWldgMeh66EST7VphPJBdVvwAR02olQZZAoIHuioGUs3wS1af+CokU5j4GQM6stOOpeIfpTA0QSK6ZMrwiCZVpgcAUVQaqlBkZZIL47+6Fchbx9zA+8jSTioBaDEgN+UCWzQjlzTJmXZQTUIyBqhes0wxjRLazQuIFzEZMz4ar1yPxu9zbWoTk1x7ueuhcGv5U0X0MkTbkCaaET6s4TKlF6yyGpGZvQ865KcpidmQ5okJCQd5ZVTOOmRPGkKzLOER3qVAA/aiyhVr4yk78unUyefA3idwg8Qc7hKQTtCIU7gxHjqgS3sBwfZQ7poxFUSKuYOOZCLVIgnh5zoeSSSFYcJ0yPYl5QkCbzerCRdRkseMDBIaXYSoCYREwd0HpzJlSSInoeUP7II3MuIc8UM0S4AKpQD4hXTLc13euR1yBIxS8B80elTjIlxXsepk/lDCyoACz5IE5VCIiAvJezkghpuEhcDgGRXTkMRWyWBXZiCvQhKNWXSBfykac0kGuTFS2I3FSmaxnAiHy6EURvOPSzjSt3w6Rvsh2QjJw5A8DkmvG5JePyS9jZD0Hoak9zgk/W5I+v2Q9DdC0n9oweo/drimBYKrAPT6Fsvmj4XdMY/ZOQw8h72dU22Y4voCxDXBG92qrnHotKgrUyhucHPFtRt/zOOYCTJUMiWKRTzjKE2sNCimDgEeomBTQpNhniRTcsk1r+CgmFROBKp18JUrsp8xcQjXLI0imcMZI4YtUhGd5ZGLZAqgHjGaatz5DiiHmeKagagW2uktL7lG2QZXjC5urUnt1up1SKtVyJN5haXUSoouxf0Otwa09dzvK/ix3n/kfk7h58P+Y/dzgl17G+7nGH72e9WbtY+QGJpmN0ABzfcKgVevLBvBN6elnAZeosNHEMWhbyiVFwcPNMyqe1mHvXDBDaeJXr0d3+M72lEJ0sKmNmBTyLCrd+S0tu9mO1V4UMmDi8I24cVSafIiD6HoF59XiRHohhf8Ap42O+4WXo0mC+B3g6UKON8KSQ8BSSDwj0Dgr8ZUcSd8R+iah+lb4exRBxUwvBlXY8x1+I7wVYfoW2HrMWAL1IfVqILW7whPFXCsaY26mG3rbrR7m+1+t79RwxX4QGyHNG3HcXs6nX4WnuewB/qTWx7UJW9LWA0GfE2oCC0aimjHlb2c9op/e+PqFZhUA1a4u5wKVPGWec9O1R4yMqbTH7Sdyg8t1GjoXyrR0wqY2ARwoJcrGkseOeChj1eeB2C6dwAHbcTkWhyvVTAJH+O4nabtuY/ws42Ir3xM004cd+Z6LpyO/ZiSOA7J4uel3+OYpGm64rP9Xvu8lqaLu+ikqYMNlcQnwCROu17NJ67Dt2KVkiPqC9/IRuAhBM24EAjL+Wjuqhtz75BzREXmOig2yhOq2BV4EPS8l+vbyLI5bvTMWFpr6Jtw3iHmjSXy476zyB4UFpGYmwC+3D5uAQcwybZz8RPFRuyKZNQYpgROdkkTHltXfNu6q69omoFZt/bX09P4z39aQ6cS+G2MtWZiPuLgGV7768l2+93Zkh55ljEVgV8yYbCSDgkzUYecjFmSlc7pyWTSmazraCxlYj3T77ViQ/v/czl4f47gZh2qswfLdmqJqOLEASKb9+FoZmoYo5r4kUvcOHikyG29Lt7gzoa94Qp3Pb6ju2kOJGi0HjHr3w1SiuoQED0r/5ZmzNRpcFaMsY4bFt8y9uwObA1clNABSxabPp0lEzqVuZME3lFZ36qj6AreoCHlovBF4Xa6FddzSq/mGk9Lt/Mcf1uEVLnTX06ePf0JkIRr742ro7M62rkr0eksmA1YDRjxA8igoNIv5oICsLuxgffN4NndsgT0I9ixcBX71W5ZoXYwVcTAHCkXPM3Twuc9LGb1KEudllLFF4yEWJxfoXq6CyvQq1tWcMHEFQucih56ZrxP6wYd1vX4jmTFHEg3s/HnSJHajX5P6u7tDOi3VWXAJdcydLUXcsF8ejX3dci+def5QeDqiyKWGfCyfilrFiDf+YZCL1zVt7qa8qq9viPqWwLWV6ZA1+++b5/PItLq7v9AhFoD+87Eat2sKR3dYONj83dEng6eBXdFD92r9r64wXGI7Tdvp9etbWezvp2H3c+ww2rLfrkZ1i0+lvYXxjDIwkJgwecJXRD1MYt4ShOMTCPU/S/gv88xyBxgQN9PZZrlpspQ6GFAoeE1AB9vtRGjP4ekHZJWSNZC8mNIHnTIa4YR2qiI5jqFgCsbs+XwAiWH8E+Uq2RKBgo2HhLWGXXI9fWHnArDzXQ2Iy1yfQ3PkmazDnDYhZATG9A9gVCUIfA8pzSYYhnpJc95ZKTXwLJa22OT9jMXs1pzoD0gP8o5dr/RPHUo+FR7dNWwr2qk2c1UaAtW2Su0OGuo4sMDrrOETgkdAt3a4DQOs28YOnAyW6RP/uM/Sa/f6XZD0rV/w0szi5f+A2B8iNQdKDaEd0PlixLiP3lygAg9S1jqXjG4tySg5WJUjwsjAeU+vNhqDdhQQkQPHjhBZHxMyzcnVs20Er0WlcRHMFKRMdXW/EZ7H/YLL7jMmKUutrgnDbNPK3QmhWb2BsqWAF0+jWi15gKTvlsZnOTCbxxkYO/+vFP9J92qUOw93KzJ+M26VOyukoo3OKdA9llc+CgBK5sqMkkVr76WqqXzcsZPCsi2MrIIVyO1yzyJScIvWJUoudD+hndQzj/feDqWUpc93AsKx9d6q/4yQyp4nPGgU4Rpv9St3nu0XruiHt+Dr3DOe14/jO7GWm9z7Ub3+ZzT99PtCULucnLol77TyWHP8ugaN/fnurnvh/DX79N313vUr6mc690vZ4B7ctFVGecW59x9uODuzRdWZbc7esG+mTfqy6lv42vY5XNi+FHvHsTwCvP7Sylxwcq+N9oj92ViLyPAO9jYNxrWX0ygVWC/OpFu3o893uvWdLUnNVXtSb9KlJubdyLK6qJzlHUa8F9/2n896f7l+Uhub29v7x0ej3eOR9vb2yn87nQ6S10xy04blwEd1mUauHsZ7/gVq3Q6HUBhTA3dwuFrmRj9ux0frh7TcS9ovpJ/ePM+grdL3MBfLgWKrt/molnm8/16fP6lHBiEgcwwiUqK3TjYCmJI1fIJQkGIbhumzU8yngZb14F7Twx/ute6MHLtvYakr+tAR2OWUvjLW3CQJgZ5JkHo0zuCMMCnUJAzBkQXbLlUlSCEkHoG3kymYQ4ct3Xte9ksnCB0WniwFViiD8LAhYuLT4SJSMJTkSweBjO/4E1TFV/KqTT+UWRLwTyQqvCZ0+DQ2Vya3GfNVJ1hVqK1nIwqRafBfEaez1HwzxbsuOIRdjL1dwM34PkoHs5jtyAMuGFpdZUVh6bkp2M6YhJ2gk8vP3UsHgtNP3lNGIfZQJ8z0L1P+5yh7+Xg/LPIEQY798eSs77j6djWxYXrpLINr+5Z7JXhdpk+EhJ8wNy5jVJ9f8QyHVXXtE66hTWPVqUVVbIZ9BgtYJpljKoOZvd8dtohZp7SJMoxE7KQxrWdFaAWO+vNwuDq9s1ckUi2fc4S+TFhQ2Pfo5BIKsHUg+pzuO9mc/2NjVkYTG/f3vQPub1HcHiT23f3BpO9ykS4fwWs649nYTC+HdZfinS0fyGwGw9n5R3rsiKLbOiBjKfnXm7NbuvoLzPoB6m1u2JfxUxVEDGQMmFULGBid2j995L8AIbOD6F9BYZZRFxpf5HZbFvFIgYZiT53B2UVcbqOTTEiLq8BfP878AG1M50PNPQSfj5tJxwwn8ELKee2B7cp2+g/ZzQaQ66we5tWhgAySJqVufbggRsdbpeEgXPbhnOgiYtR3RirYAed9dW9d6qnA1/gcsXcpf2jgzvgEi3Ftk0cdflEuEs7B9k/OoDcTD506l+HHOsCEx61tNaFgDpGLjn1+VuFbJ/alzPMujulzxwuIwwdlxXZJosAxVwvhSiEDCabOFaUGViYuEz9hiOSuYGIhcu1J9qwTNfwiFAUiDyS+V2o8hZMUjLK8UmzAZb1iZr4VrHMreTC1jBAMyPOlU8ndWQBPaGgQYknjxXoVJk/JExoO5ySIYYsQyhsAJhXORgVxZTsKmOKQ3BxKQoUs6g7z9VSfa2Og3qi4vHrly7hv0icUwUP+YlZTPIMqQY5oUig9Sc3v/UFRQm4g6nzVYrhouqBIVPnAcmY0lAUQhGpRlTwj65IBGgkYGQN2JgmtqsTFeApB3iAw+vAeFn7+z/+WYFrpaa7CJhdgcYxvKS9BUK0JC3Bg6avWAYSUNYhgvmY+q/5SwCgQ6Y5T2VcMJK+O40f4NtbXchFFwEsIpA6j8ZgWBTyVodexmqnVmo0TYvESpnBftkV16aSAuqf/y/Kh9cM8BhVYEA1BLgaaF5MqwxeRkbl3HSYRsnr6cPFNbjACzQ38lyxlIu73VNVZ5yRhSDIjUyp4RHxU+lOPSncRnw8X6dlTBio8ZJL9WAFq8J051JE7JyLc3bJ1B0UvEr4mk6BuM2EMVGFzSPJXmdl4u4E8mRrOKncTpieXiPGzRDoLmVqxM4jMFOQ8Ngd8NhqwWytFmlbWJxY1blyHhVXUwHlB4iScnaAyGU/F8kk5Z1bLWzSIb/ICeAsJJmtcQFmvJ0fUEoQcpcQXF0hogLSn9GZAznPMHERXYNk33IJG+DG88Ld7ForPLIOHZgFagDAOuFNe/IitMiSoZDH71f3GcqwOXCrEJpIZCkzXpbAjEDtYgr3GK8gPELwANt1fF0FTEn+/e//qzGOb5+j6A5sYWUrRvhpoqXND6/O6ina07z1Ty2QtHsysMzYvdnj4QVIWZuHpQN4sobvHlCjwptGlk6PuvX81czvm2xpF45vLOk/kKnZ63b/P1vS690/jiW90f0DWdKPAVjns79dmqzSbpfKDh+DuHnAe8msfzOR6uae4NufhUXEZBmCS3boz+x/pfHvhfgtDgHrMSiDCc6Y9ZtBNPS7XfhnTgj6Gme+8lZZ9i2Z/lsQ3j2ScfMZ+CpbNyPrp3H/F52JNBoDzlZYTWX3m0msGqFZY9MX48HziO/zF7vHH3d7e3xX74rXm9HT3Ye7F9lvvz598aTDpi96Uf/X6W/9X83bN4nefS959MuL8Tvxqx483czf/vZOvf1tV71989rQN5vbAzEWg+c/82i6+X7Q7/KXT190373pTQbPf+6++/VJ9g4n/7n77uKiG6V7TwdiG/pkb3/7b77/fmf91cedj6+Odq5efUyedOjeh/dPr6Inry52Hrbf7ar2q/3BX95/MNnrzXh97zf+8DF7xd6Io+7LqEYNXCRcsHN/1Oe473M4bEtJG8uO/VCmzKosEyytpiTUbXO6m1FTQkegfAHq1D1SAVPqNn75NMhuQsRGt3veK5CwuYiEXYHZZ1jC8EheMPFtd1pd3tjlAdSrNCmFVsBtJ2wPaputfreb1CzKFTfTYOvkOrhq04y3bfvWydnsDMwHM5YQvMykRoipGQdbwdp8LBMqSWKk7OTa8mDBaJqKGN7kLDAbzfjaZa/TC2bh/JilzHlDf5a3P3WINnTExei2cWclig7hGO1J1RBVKqwZ/wsDjdWdQ7VXGHAgnzGjYMoC5oE6XpcR4B1/xj42uyzcWp7lfADVx09rIdH5e3hJkLMS4zzxAUaMGRYhw6DcUFCE9YKgEqiDH5XQG/wstPmTkpqLuJVXtnuopfY3NlCde9RDvWf9MaoUGw9nZxb5FUc15jZUva32pVHNbeg+1d1oQTDntqr5juZdRyvdOCu8OG7JOW9FAcgyJwEY50ttczeqYoctQaVXPeqIhIc6gMj1LiJyo4uIfNytaT1u++UMpe6CCkqhn6ASUtVBQNE4A8LlYiiR6t1xF8WyQCgh1yzoqiyJZFpU3Wq1/JDf//HPYlSrVZjItCiNup8rkskJU1BSFkuqJuwKK3hhudsU2zQa9ZhkQNOEaQ3xdmHYyNaDhSQB8Do7v2ZEMzqAsqzgNcWH+vhMtyK4dQdKkmG+yFTmPyibPXHJEhDWhTupWtJ1ItXFMJETqJRKBpBVAg5FJsZURNZ3aUUI+uDANi5LhGmjAGpuYZPCKBoZklJBR+hEC0kVWTFLOMhZouQAXPtaJrl1XhvKE6nso0rcEL56QSTuXGXQhAo3MK1iYyDsS+fB1qGNIFjp4Iq9DiBYkwEsHBwLRpJcJBLqskLQJ08gscLYQAzo9VUYYbhRVGhQxi0s/gwKhDnnMvPF0Y41gxN+ycWFrYXWJicFXb1hA80Nq9cVmGfOB/Uxz7n5JR9ArUmpuZFqWo4ecTPOByjnq5MUP+xMz3094YoUv3uiziEzQCF6bftgF9WEB+T3v/8PecmoEmQsJ5Zao1yxZFqWLsYqu3jyFm3FLY/hC5pDqV6DRCpGPqKmi7K41KA/aI9NwPFmWcq+ZDrIBwmPiprRutXaIk9tZeiiGHQ9D9qmp0BMiZLMjk64uOiQbTG1JZAL9xZ8x3G1bWBEaEUp5rIA81FldZZqllwyXfHvQWFljNQpmY/salVg3Obq2Tqwt+04Xkh+AR9vCY71SmGIjFr3FBQvXpIvU0uGqZdNZCLG5CK9RVAbKucP51J4MGq28Mln/5S1se00lfrcgEm34+Kr9dzNaSB1eYseQVhQ1ypj04w7cjrxZEnqBTs+naytRSsMjVD99TcozfjSKAiUh9X7w0OoOx55c2wFR69h57UgDBIeMWdeu/tr+/nBS3K53ukGYUWvuwNzr73cfbqzd7gDwIAgtQjrdbqdLnoBpTYpFZWVsL56QajzV1vl1V5Tlr0py96UZW/Ksjdl2Zuy7E1Z9qYse1OWvSnL/t1jtynL3pRlb8qyf3LVoKYse1OWvSnL3pRlv0d8NWXZm7LsTVn277BeTVOWvSnL3pRlb8qyN2XZm7LsTVn2pix7U5a9KcvelGVvyrI3Zdm/Hnk2ZdmbsuxNWfamLHtTlr0py96UZW/Ksjdl2Zuy7E1Z9qYse1OWvSnL3pRlb8qyN2XZm7LsX1CWvZJGvZYllItK5RBb4OBkrlj7WRiMoQDC1klwfQ2Ed6yS2Qw+f8gxofvkLAwuqeLw+BRrJ4Q+1x/yti8Y5Hw/tS+T20ewfGjPGXPl5kpGQLECO2Ibt35j32qNhoP9w6MgDAauoHwqY6wmQyeQ500nNg++kgyO366DhIpRjonkgZ1zZmvvjeu1DS6wtoH7o5KNDjUASgjrRQ/sNuD/sKmlA66vbd2E2azob5tWjnCI9b3h+M5ms9n/ARrMTgw=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Formdata","permalink":"/docs/API-docs/v1.1/getformdata"},"next":{"title":"Create Template","permalink":"/docs/API-docs/v1.1/createtemplate"}}');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),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:"eJztPNlyGzmSv4KtmIhuc4oUSUk+tLEbq7bVbnlsSWtJ7bYljQasAklYVUAZQImiFYyYh/mDfdrX+bT+ko1MAHXwkGRb9rg3qh/aYuFKJDITeSDzOjB0pIOtk+CIpVlCDdPBWRjETEeKZ4ZLEWwFR2NGfDN5pujQcDEi2we7hAk6SJgmuWZKEyNJpBh0inJtZMo/QisxfuaQaKYuYSzVZJDkLFNcGE2GUpERE0xRnDiWUZ4yaJhwMyaZYjEbcsFioo3KI5MrpjvkOJOC6DyKmNbDPLErcymIHBJarBkSM2YIqmImV0ITSnLBP+SMtFpy8J5FZjdutciPMdN8JKhhMQDnh5/z+EFIJmMejUlEBRkw2GoMO3UAswq4AwptUuCaOmMRH3Lo7CbrkO045gAjTZJpSChptXKVtFqEa5IpecljFvvV5HAIKKWIWsKFYWpII4a4YjCLGOEyfnJCRUyGNOIJN3U0kphro/ggh5U7p+JUHPFsixxniaQxmcpckYNnP5fdjSTw7aTVesYG+Ygc77ZaZz+Ojcn01toazbKOzJgAbCV0oDuRTNdi6JjFQ8QVUwxmRXwxqnkyJTSOyYTHI2Y0HoggkcymJJJSxVxY0sjoiBGRpwOmdIi7SaVihAtCiWI0nraNbOeakReH+3uAhpSaDjlIch0Wy8VcscgkUzs9oMfv6gd7Og83gIa4GIUkpReAJW7Ih5xHF7BtzQQerSMZxFWr9QbgLbDDtaPxmBAz5ppM2GAs5QVhl9A84UlCjOKjEVOt1qn429/+diquTwUhpwH2OA22yGngpjgNQttkphmzLc/2nx6/2tk7Oj96e7BTtHtKneuz+6zoMeTJ/AzHr18WzYKm881726/KBYQ0rv0gYVQzotglZxM8Bzhqu1ePhWJYRU7Y0UULDGJKw9cT+ELItf2nDs3h7vO9nddVWGwPllKe1LrsvNrefVnrk42lqE9z8Mv+Xn2eXFVm2d17bpFi22fwz5mD153Itjugo91XO4dH268OoPPMnSNQw2GeZVLB8b+xBL0Fx3wqfmKJnBCqGFJPJNNUCpJRRVNmUDaOqcFmxT7kXLHYCjeaJJ4ztk5Fm7RagJutVoscWynFYyYMyBGFrG9JDgd0bH8gHei/K2IeAStZsTDNGEjCWldgMeh66EST7VphPJBdVvwAR02olQZZAoIHuioGUs3wS1af+CokU5j4GQM6stOOpeIfpTA0QSK6ZMrwiCZVpgcAUVQaqlBkZZIL47+6Fchbx9zA+8jSTioBaDEgN+UCWzQjlzTJmXZQTUIyBqhes0wxjRLazQuIFzEZMz4ar1yPxu9zbWoTk1x7ueuhcGv5U0X0MkTbkCaaET6s4TKlF6yyGpGZvQ865KcpidmQ5okJCQd5ZVTOOmRPGkKzLOER3qVAA/aiyhVr4yk78unUyefA3idwg8Qc7hKQTtCIU7gxHjqgS3sBwfZQ7poxFUSKuYOOZCLVIgnh5zoeSSSFYcJ0yPYl5QkCbzerCRdRkseMDBIaXYSoCYREwd0HpzJlSSInoeUP7II3MuIc8UM0S4AKpQD4hXTLc13euR1yBIxS8B80elTjIlxXsepk/lDCyoACz5IE5VCIiAvJezkghpuEhcDgGRXTkMRWyWBXZiCvQhKNWXSBfykac0kGuTFS2I3FSmaxnAiHy6EURvOPSzjSt3w6Rvsh2QjJw5A8DkmvG5JePyS9jZD0Hoak9zgk/W5I+v2Q9DdC0n9oweo/drimBYKrAPT6Fsvmj4XdMY/ZOQw8h72dU22Y4voCxDXBG92qrnHotKgrUyhucHPFtRt/zOOYCTJUMiWKRTzjKE2sNCimDgEeomBTQpNhniRTcsk1r+CgmFROBKp18JUrsp8xcQjXLI0imcMZI4YtUhGd5ZGLZAqgHjGaatz5DiiHmeKagagW2uktL7lG2QZXjC5urUnt1up1SKtVyJN5haXUSoouxf0Otwa09dzvK/ix3n/kfk7h58P+Y/dzgl17G+7nGH72e9WbtY+QGJpmN0ABzfcKgVevLBvBN6elnAZeosNHEMWhbyiVFwcPNMyqe1mHvXDBDaeJXr0d3+M72lEJ0sKmNmBTyLCrd+S0tu9mO1V4UMmDi8I24cVSafIiD6HoF59XiRHohhf8Ap42O+4WXo0mC+B3g6UKON8KSQ8BSSDwj0Dgr8ZUcSd8R+iah+lb4exRBxUwvBlXY8x1+I7wVYfoW2HrMWAL1IfVqILW7whPFXCsaY26mG3rbrR7m+1+t79RwxX4QGyHNG3HcXs6nX4WnuewB/qTWx7UJW9LWA0GfE2oCC0aimjHlb2c9op/e+PqFZhUA1a4u5wKVPGWec9O1R4yMqbTH7Sdyg8t1GjoXyrR0wqY2ARwoJcrGkseOeChj1eeB2C6dwAHbcTkWhyvVTAJH+O4nabtuY/ws42Ir3xM004cd+Z6LpyO/ZiSOA7J4uel3+OYpGm64rP9Xvu8lqaLu+ikqYMNlcQnwCROu17NJ67Dt2KVkiPqC9/IRuAhBM24EAjL+Wjuqhtz75BzREXmOig2yhOq2BV4EPS8l+vbyLI5bvTMWFpr6Jtw3iHmjSXy476zyB4UFpGYmwC+3D5uAQcwybZz8RPFRuyKZNQYpgROdkkTHltXfNu6q69omoFZt/bX09P4z39aQ6cS+G2MtWZiPuLgGV7768l2+93Zkh55ljEVgV8yYbCSDgkzUYecjFmSlc7pyWTSmazraCxlYj3T77ViQ/v/czl4f47gZh2qswfLdmqJqOLEASKb9+FoZmoYo5r4kUvcOHikyG29Lt7gzoa94Qp3Pb6ju2kOJGi0HjHr3w1SiuoQED0r/5ZmzNRpcFaMsY4bFt8y9uwObA1clNABSxabPp0lEzqVuZME3lFZ36qj6AreoCHlovBF4Xa6FddzSq/mGk9Lt/Mcf1uEVLnTX06ePf0JkIRr742ro7M62rkr0eksmA1YDRjxA8igoNIv5oICsLuxgffN4NndsgT0I9ixcBX71W5ZoXYwVcTAHCkXPM3Twuc9LGb1KEudllLFF4yEWJxfoXq6CyvQq1tWcMHEFQucih56ZrxP6wYd1vX4jmTFHEg3s/HnSJHajX5P6u7tDOi3VWXAJdcydLUXcsF8ejX3dci+def5QeDqiyKWGfCyfilrFiDf+YZCL1zVt7qa8qq9viPqWwLWV6ZA1+++b5/PItLq7v9AhFoD+87Eat2sKR3dYONj83dEng6eBXdFD92r9r64wXGI7Tdvp9etbWezvp2H3c+ww2rLfrkZ1i0+lvYXxjDIwkJgwecJXRD1MYt4ShOMTCPU/S/gv88xyBxgQN9PZZrlpspQ6GFAoeE1AB9vtRGjP4ekHZJWSNZC8mNIHnTIa4YR2qiI5jqFgCsbs+XwAiWH8E+Uq2RKBgo2HhLWGXXI9fWHnArDzXQ2Iy1yfQ3PkmazDnDYhZATG9A9gVCUIfA8pzSYYhnpJc95ZKTXwLJa22OT9jMXs1pzoD0gP8o5dr/RPHUo+FR7dNWwr2qk2c1UaAtW2Su0OGuo4sMDrrOETgkdAt3a4DQOs28YOnAyW6RP/uM/Sa/f6XZD0rV/w0szi5f+A2B8iNQdKDaEd0PlixLiP3lygAg9S1jqXjG4tySg5WJUjwsjAeU+vNhqDdhQQkQPHjhBZHxMyzcnVs20Er0WlcRHMFKRMdXW/EZ7H/YLL7jMmKUutrgnDbNPK3QmhWb2BsqWAF0+jWi15gKTvlsZnOTCbxxkYO/+vFP9J92qUOw93KzJ+M26VOyukoo3OKdA9llc+CgBK5sqMkkVr76WqqXzcsZPCsi2MrIIVyO1yzyJScIvWJUoudD+hndQzj/feDqWUpc93AsKx9d6q/4yQyp4nPGgU4Rpv9St3nu0XruiHt+Dr3DOe14/jO7GWm9z7Ub3+ZzT99PtCULucnLol77TyWHP8ugaN/fnurnvh/DX79N313vUr6mc690vZ4B7ctFVGecW59x9uODuzRdWZbc7esG+mTfqy6lv42vY5XNi+FHvHsTwCvP7Sylxwcq+N9oj92ViLyPAO9jYNxrWX0ygVWC/OpFu3o893uvWdLUnNVXtSb9KlJubdyLK6qJzlHUa8F9/2n896f7l+Uhub29v7x0ej3eOR9vb2yn87nQ6S10xy04blwEd1mUauHsZ7/gVq3Q6HUBhTA3dwuFrmRj9ux0frh7TcS9ovpJ/ePM+grdL3MBfLgWKrt/molnm8/16fP6lHBiEgcwwiUqK3TjYCmJI1fIJQkGIbhumzU8yngZb14F7Twx/ute6MHLtvYakr+tAR2OWUvjLW3CQJgZ5JkHo0zuCMMCnUJAzBkQXbLlUlSCEkHoG3kymYQ4ct3Xte9ksnCB0WniwFViiD8LAhYuLT4SJSMJTkSweBjO/4E1TFV/KqTT+UWRLwTyQqvCZ0+DQ2Vya3GfNVJ1hVqK1nIwqRafBfEaez1HwzxbsuOIRdjL1dwM34PkoHs5jtyAMuGFpdZUVh6bkp2M6YhJ2gk8vP3UsHgtNP3lNGIfZQJ8z0L1P+5yh7+Xg/LPIEQY798eSs77j6djWxYXrpLINr+5Z7JXhdpk+EhJ8wNy5jVJ9f8QyHVXXtE66hTWPVqUVVbIZ9BgtYJpljKoOZvd8dtohZp7SJMoxE7KQxrWdFaAWO+vNwuDq9s1ckUi2fc4S+TFhQ2Pfo5BIKsHUg+pzuO9mc/2NjVkYTG/f3vQPub1HcHiT23f3BpO9ykS4fwWs649nYTC+HdZfinS0fyGwGw9n5R3rsiKLbOiBjKfnXm7NbuvoLzPoB6m1u2JfxUxVEDGQMmFULGBid2j995L8AIbOD6F9BYZZRFxpf5HZbFvFIgYZiT53B2UVcbqOTTEiLq8BfP878AG1M50PNPQSfj5tJxwwn8ELKee2B7cp2+g/ZzQaQ66we5tWhgAySJqVufbggRsdbpeEgXPbhnOgiYtR3RirYAed9dW9d6qnA1/gcsXcpf2jgzvgEi3Ftk0cdflEuEs7B9k/OoDcTD506l+HHOsCEx61tNaFgDpGLjn1+VuFbJ/alzPMujulzxwuIwwdlxXZJosAxVwvhSiEDCabOFaUGViYuEz9hiOSuYGIhcu1J9qwTNfwiFAUiDyS+V2o8hZMUjLK8UmzAZb1iZr4VrHMreTC1jBAMyPOlU8ndWQBPaGgQYknjxXoVJk/JExoO5ySIYYsQyhsAJhXORgVxZTsKmOKQ3BxKQoUs6g7z9VSfa2Og3qi4vHrly7hv0icUwUP+YlZTPIMqQY5oUig9Sc3v/UFRQm4g6nzVYrhouqBIVPnAcmY0lAUQhGpRlTwj65IBGgkYGQN2JgmtqsTFeApB3iAw+vAeFn7+z/+WYFrpaa7CJhdgcYxvKS9BUK0JC3Bg6avWAYSUNYhgvmY+q/5SwCgQ6Y5T2VcMJK+O40f4NtbXchFFwEsIpA6j8ZgWBTyVodexmqnVmo0TYvESpnBftkV16aSAuqf/y/Kh9cM8BhVYEA1BLgaaF5MqwxeRkbl3HSYRsnr6cPFNbjACzQ38lyxlIu73VNVZ5yRhSDIjUyp4RHxU+lOPSncRnw8X6dlTBio8ZJL9WAFq8J051JE7JyLc3bJ1B0UvEr4mk6BuM2EMVGFzSPJXmdl4u4E8mRrOKncTpieXiPGzRDoLmVqxM4jMFOQ8Ngd8NhqwWytFmlbWJxY1blyHhVXUwHlB4iScnaAyGU/F8kk5Z1bLWzSIb/ICeAsJJmtcQFmvJ0fUEoQcpcQXF0hogLSn9GZAznPMHERXYNk33IJG+DG88Ld7ForPLIOHZgFagDAOuFNe/IitMiSoZDH71f3GcqwOXCrEJpIZCkzXpbAjEDtYgr3GK8gPELwANt1fF0FTEn+/e//qzGOb5+j6A5sYWUrRvhpoqXND6/O6ina07z1Ty2QtHsysMzYvdnj4QVIWZuHpQN4sobvHlCjwptGlk6PuvX81czvm2xpF45vLOk/kKnZ63b/P1vS690/jiW90f0DWdKPAVjns79dmqzSbpfKDh+DuHnAe8msfzOR6uae4NufhUXEZBmCS3boz+x/pfHvhfgtDgHrMSiDCc6Y9ZtBNPS7XfhnTgj6Gme+8lZZ9i2Z/lsQ3j2ScfMZ+CpbNyPrp3H/F52JNBoDzlZYTWX3m0msGqFZY9MX48HziO/zF7vHH3d7e3xX74rXm9HT3Ye7F9lvvz598aTDpi96Uf/X6W/9X83bN4nefS959MuL8Tvxqx483czf/vZOvf1tV71989rQN5vbAzEWg+c/82i6+X7Q7/KXT190373pTQbPf+6++/VJ9g4n/7n77uKiG6V7TwdiG/pkb3/7b77/fmf91cedj6+Odq5efUyedOjeh/dPr6Inry52Hrbf7ar2q/3BX95/MNnrzXh97zf+8DF7xd6Io+7LqEYNXCRcsHN/1Oe473M4bEtJG8uO/VCmzKosEyytpiTUbXO6m1FTQkegfAHq1D1SAVPqNn75NMhuQsRGt3veK5CwuYiEXYHZZ1jC8EheMPFtd1pd3tjlAdSrNCmFVsBtJ2wPaputfreb1CzKFTfTYOvkOrhq04y3bfvWydnsDMwHM5YQvMykRoipGQdbwdp8LBMqSWKk7OTa8mDBaJqKGN7kLDAbzfjaZa/TC2bh/JilzHlDf5a3P3WINnTExei2cWclig7hGO1J1RBVKqwZ/wsDjdWdQ7VXGHAgnzGjYMoC5oE6XpcR4B1/xj42uyzcWp7lfADVx09rIdH5e3hJkLMS4zzxAUaMGRYhw6DcUFCE9YKgEqiDH5XQG/wstPmTkpqLuJVXtnuopfY3NlCde9RDvWf9MaoUGw9nZxb5FUc15jZUva32pVHNbeg+1d1oQTDntqr5juZdRyvdOCu8OG7JOW9FAcgyJwEY50ttczeqYoctQaVXPeqIhIc6gMj1LiJyo4uIfNytaT1u++UMpe6CCkqhn6ASUtVBQNE4A8LlYiiR6t1xF8WyQCgh1yzoqiyJZFpU3Wq1/JDf//HPYlSrVZjItCiNup8rkskJU1BSFkuqJuwKK3hhudsU2zQa9ZhkQNOEaQ3xdmHYyNaDhSQB8Do7v2ZEMzqAsqzgNcWH+vhMtyK4dQdKkmG+yFTmPyibPXHJEhDWhTupWtJ1ItXFMJETqJRKBpBVAg5FJsZURNZ3aUUI+uDANi5LhGmjAGpuYZPCKBoZklJBR+hEC0kVWTFLOMhZouQAXPtaJrl1XhvKE6nso0rcEL56QSTuXGXQhAo3MK1iYyDsS+fB1qGNIFjp4Iq9DiBYkwEsHBwLRpJcJBLqskLQJ08gscLYQAzo9VUYYbhRVGhQxi0s/gwKhDnnMvPF0Y41gxN+ycWFrYXWJicFXb1hA80Nq9cVmGfOB/Uxz7n5JR9ArUmpuZFqWo4ecTPOByjnq5MUP+xMz3094YoUv3uiziEzQCF6bftgF9WEB+T3v/8PecmoEmQsJ5Zao1yxZFqWLsYqu3jyFm3FLY/hC5pDqV6DRCpGPqKmi7K41KA/aI9NwPFmWcq+ZDrIBwmPiprRutXaIk9tZeiiGHQ9D9qmp0BMiZLMjk64uOiQbTG1JZAL9xZ8x3G1bWBEaEUp5rIA81FldZZqllwyXfHvQWFljNQpmY/salVg3Obq2Tqwt+04Xkh+AR9vCY71SmGIjFr3FBQvXpIvU0uGqZdNZCLG5CK9RVAbKucP51J4MGq28Mln/5S1se00lfrcgEm34+Kr9dzNaSB1eYseQVhQ1ypj04w7cjrxZEnqBTs+naytRSsMjVD99TcozfjSKAiUh9X7w0OoOx55c2wFR69h57UgDBIeMWdeu/tr+/nBS3K53ukGYUWvuwNzr73cfbqzd7gDwIAgtQjrdbqdLnoBpTYpFZWVsL56QajzV1vl1V5Tlr0py96UZW/Ksjdl2Zuy7E1Z9qYse1OWvSnL/t1jtynL3pRlb8qyf3LVoKYse1OWvSnL3pRlv0d8NWXZm7LsTVn277BeTVOWvSnL3pRlb8qyN2XZm7LsTVn2pix7U5a9KcvelGVvyrI3Zdm/Hnk2ZdmbsuxNWfamLHtTlr0py96UZW/Ksjdl2Zuy7E1Z9qYse1OWvSnL3pRlb8qyN2XZm7LsX1CWvZJGvZYllItK5RBb4OBkrlj7WRiMoQDC1klwfQ2Ed6yS2Qw+f8gxofvkLAwuqeLw+BRrJ4Q+1x/yti8Y5Hw/tS+T20ewfGjPGXPl5kpGQLECO2Ibt35j32qNhoP9w6MgDAauoHwqY6wmQyeQ500nNg++kgyO366DhIpRjonkgZ1zZmvvjeu1DS6wtoH7o5KNDjUASgjrRQ/sNuD/sKmlA66vbd2E2azob5tWjnCI9b3h+M5ms9n/ARrMTgw=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},x=void 0,y={},j=[];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)(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:"name:"})," Unique identifier for this widget."]}),"\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",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\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 "hide_text_with_asterisks": false\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 "hide_text_with_asterisks": false\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 "hide_text_with_asterisks": false\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 "hide_text_with_asterisks": false\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:'"mm/dd/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",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\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 "hide_text_with_asterisks": false\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:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (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 "layout": "vertical",\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 "layout": "vertical"\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.jsxs)(n.ol,{start:"14",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the number (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",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,s.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Note:"})," Responses for prefill widgets are ",(0,s.jsx)(n.strong,{children:"required"}),"."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{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": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\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:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",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": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "name": "date",\n "response": "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:"response:"})," Enter the date you would like to display inside the date box."]}),"\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:'"mm/dd/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",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",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": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\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 checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\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:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",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": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\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:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\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 radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",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": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"6",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": 528,\n "w": 114,\n "h": 21,\n "options": {\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\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:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\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 pdf"},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:""},company:{type:"string",format:"string",example:""},job_title:{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},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:"5,"},merge_certificate:{type:"boolean",description:"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\n\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\n",example:!1},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},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:100},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:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},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 b(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/runtime~main.d335bfe3.js b/assets/js/runtime~main.333f24ef.js similarity index 96% rename from assets/js/runtime~main.d335bfe3.js rename to assets/js/runtime~main.333f24ef.js index 600393e1b..5e2d18a50 100644 --- a/assets/js/runtime~main.d335bfe3.js +++ b/assets/js/runtime~main.333f24ef.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,f,d,b={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return b[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=b,t.c=r,e=[],t.O=(a,c,f,d)=>{if(!c){var b=1/0;for(n=0;n=d)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,d0&&e[n-1][2]>d;n--)e[n]=e[n-1];e[n]=[c,f,d]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var d=Object.create(null);t.r(d);var b={};a=a||[null,c({}),c([]),c(c)];for(var r=2&f&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,t.d(d,b),d},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({33:"7ad5624c",89:"3009d411",108:"1b14d97a",157:"8001f939",225:"0a7196e9",284:"107ddcf4",285:"23f866da",291:"4f7a2d40",300:"833eda7d",419:"e5d81aec",448:"d77fb6a8",490:"ce589067",539:"cfb1e6eb",560:"500027af",636:"eaa24e23",746:"cf03142d",791:"4acb0154",841:"d1393a72",849:"0058b4c6",850:"c6b74119",930:"05729a5b",956:"19e4dfff",962:"046910c8",1170:"c1e4445e",1179:"489b8a4d",1235:"a7456010",1440:"277a78f5",1477:"2f6ff211",1640:"c9fa5aa5",1651:"19e5ad2a",1665:"7357a3c5",1679:"138cee78",1688:"9640838e",1706:"18b84479",1903:"acecf23e",1924:"d8b805fb",1972:"73664a40",2042:"reactPlayerTwitch",2043:"ac7da374",2075:"5c485335",2089:"c7b98810",2131:"299c7a47",2264:"17e5210b",2634:"c4f5d8e4",2661:"8bd80e56",2703:"da66eb9c",2711:"9e4087bc",2723:"reactPlayerMux",2908:"2c416566",3021:"4cff09f6",3073:"e9e778b7",3128:"c674cfb4",3148:"1e1b513c",3230:"d480dde9",3249:"ccc49370",3276:"e5aefb32",3333:"e48228d1",3381:"42f80fc5",3392:"reactPlayerVidyard",3404:"03e06346",3460:"5ce6d213",3522:"e785206d",3633:"b97a0b7b",3637:"f4f34a3a",3694:"8717b14a",3724:"2ffc1e57",3795:"c4fbe420",3841:"56b5f4f8",3891:"8e4d0438",3976:"0e384e19",3979:"64218a31",4001:"d281bdbe",4106:"882238ec",4134:"393be207",4212:"621db11d",4232:"5a144266",4240:"9c9cb35e",4372:"9cd612ce",4466:"56b0ffe9",4504:"5a9dd378",4584:"f82cd581",4813:"6875c492",4833:"c7e3ab5f",4865:"7ef59f7a",4952:"6bef026b",5277:"8320e026",5305:"87a6df42",5314:"88a819d0",5342:"4227e71a",5373:"02e5f5c4",5506:"01274ace",5510:"02d4f5c5",5524:"21f05a2f",5550:"14716de7",5557:"d9f32620",5597:"b18842e4",5742:"aba21aa0",5752:"6d2e526e",5794:"3b49dc44",5855:"444a2573",5881:"63d7f7ab",5939:"837d4f04",5970:"0f8cf55d",6007:"611db08b",6011:"56f1c106",6061:"1f391b9e",6157:"3973fcf3",6173:"reactPlayerVimeo",6192:"c195e1f1",6235:"d0524430",6288:"eedafdee",6295:"d91ad230",6302:"873e7b96",6318:"bb4fa758",6328:"reactPlayerDailyMotion",6353:"5e1bb91e",6463:"reactPlayerKaltura",6473:"4c5e977b",6505:"cd2b86eb",6648:"0c0943c7",6653:"f214d5ff",6743:"e226bb09",6827:"0edab2fb",6841:"f22c5875",6887:"reactPlayerFacebook",6940:"a000203c",6969:"14eb3368",7024:"98334e25",7068:"e92d0461",7075:"4d139b56",7098:"a7bd4aaa",7318:"e76c28ee",7381:"20f41f87",7458:"reactPlayerFilePlayer",7472:"814f3328",7477:"36994c47",7570:"reactPlayerMixcloud",7574:"70276854",7627:"reactPlayerStreamable",7643:"a6aa9e1f",7696:"1ee58ee1",7757:"eb56c656",7797:"767ebc75",7904:"5144c8d4",7910:"e4f5c862",7960:"b2e6bd40",7968:"489197af",8e3:"54a7b8f4",8025:"5e90a9b3",8045:"fff7b69d",8046:"6621d3c0",8097:"ab2a161b",8110:"825a5e83",8121:"3a2db09e",8130:"f81c1134",8146:"c15d9823",8168:"6c0cc40d",8209:"01a85c17",8446:"reactPlayerYouTube",8462:"3217192f",8474:"652d83be",8503:"012b45bf",8564:"58abd73c",8609:"925b3f96",8734:"reactPlayerPreview",8737:"7661071f",8749:"b93339ed",8901:"1c57a399",8927:"b0378e01",8947:"ef8b811a",9024:"e5a49157",9048:"a94703ab",9070:"851f8f65",9099:"34593b53",9144:"dc8c216b",9190:"6cb65baf",9239:"0c806540",9241:"11b7b3d8",9260:"96f83544",9325:"59362658",9328:"e273c56f",9340:"reactPlayerWistia",9350:"62b755e6",9426:"38ec836e",9429:"fa501e35",9490:"02fcf422",9570:"a3008c1e",9611:"06b6ef6a",9647:"5e95c892",9858:"1f7895dc",9979:"reactPlayerSoundCloud"}[e]||e)+"."+{33:"04d03f97",89:"67599f09",108:"b9723cd9",157:"77f58424",225:"5354ae5c",284:"55b197b1",285:"3fe0f665",291:"4d88e708",300:"d5462c6f",419:"26112334",448:"3492c614",490:"a197b5a8",539:"ddb32cf1",560:"183f80db",636:"23fdfdd6",746:"49f86803",791:"cc896e9f",841:"71ea2b9a",849:"eb124f08",850:"3ac080ec",930:"9f35584c",956:"e6fef687",962:"0758599a",1170:"9b7be45e",1179:"955bead1",1235:"e0fce024",1440:"5dc69857",1463:"6c989e27",1477:"c7a939ea",1640:"d2ce80bf",1651:"e44b2367",1665:"6005cc6b",1679:"27742ef4",1688:"1d12e479",1706:"33c9f705",1903:"9c2000d9",1924:"fdb8fe31",1936:"3329227e",1972:"6aa170c8",2042:"ccdbba13",2043:"4a1b8c9b",2075:"fe1bbef5",2089:"4267cecd",2131:"920ad619",2264:"03a17636",2489:"a212f802",2634:"b5502b21",2661:"881ab85e",2703:"717af639",2711:"999c03aa",2723:"ad84c6fe",2908:"9a88f7fa",3021:"8265c79a",3042:"040aac0d",3073:"cff2425c",3128:"e29762a5",3148:"9a6039c4",3230:"a2cfa06b",3249:"d6c50b29",3276:"00ab24d9",3333:"099c2226",3381:"dfcbba2f",3392:"a7951473",3404:"5a5ba93d",3460:"827e01c6",3522:"16f87a1e",3633:"d2a8f664",3637:"ffa80471",3694:"4d710693",3724:"8970445f",3795:"68ec300c",3841:"cf1c6a97",3891:"c8de3ba8",3976:"2d4c4f66",3979:"562ac819",4001:"183be27c",4106:"d9d3f988",4132:"a5c6ef5a",4134:"7b436152",4212:"5dccb1c7",4232:"804e9e11",4240:"886034c8",4372:"b75be620",4466:"8b9f41be",4504:"d5dc6808",4584:"a7d307eb",4622:"420bc0ab",4813:"1198d246",4833:"cf9a081c",4865:"4a732e7a",4952:"32a88040",5013:"b10f6f78",5277:"b2de11fb",5305:"760fdd56",5314:"2ddf281e",5342:"3f44a353",5373:"60be571e",5506:"9d141ac4",5510:"92a4db7d",5524:"47dbdaaf",5550:"4dd81245",5557:"dffbf1c4",5597:"3dcd4c42",5742:"ac359952",5752:"9f2d8c5b",5794:"c75a31d7",5855:"84d22ac9",5881:"3782c030",5939:"7f698217",5970:"91dc704f",6007:"fefe155f",6011:"1a38abf2",6061:"bb03b217",6157:"fccfe0be",6173:"40e527dc",6192:"faf5a05d",6235:"5aa106b8",6288:"cb1b5f05",6295:"958608f5",6302:"92260858",6318:"213b74ab",6328:"a2ec01b1",6353:"c48fddc9",6463:"665cb544",6473:"0243df4f",6505:"c6903d64",6648:"2847553a",6653:"fdbc0c47",6743:"a3fe848c",6827:"4331c92d",6841:"50291cb3",6887:"f478ac9c",6940:"fd8689e0",6969:"408561bf",7024:"163938f2",7054:"cab4fa5c",7068:"0704c01e",7075:"8d0aa3f2",7085:"2efbf216",7098:"c920e4e4",7318:"2bd572be",7381:"cae02e9b",7458:"e1cdf442",7472:"909d2cac",7477:"4aaebd1d",7570:"086b8299",7574:"d5e60f67",7627:"df6df631",7643:"4bb958af",7696:"d7f04e0f",7757:"13e692a4",7797:"0c1174cc",7904:"8aab2983",7910:"5b11649a",7960:"db82425f",7968:"14065b3d",8e3:"58f8ce85",8025:"18e81984",8045:"d0d6b88a",8046:"7015e218",8097:"43a7d9e8",8110:"f2fff490",8121:"adb9cf78",8130:"29afdc55",8146:"bdf3ab1c",8160:"4a1cc722",8168:"11595f0e",8209:"b9e31ef1",8446:"594ab8ca",8462:"d040ed86",8474:"97c5edc0",8503:"45b8fe0a",8564:"7661f930",8609:"6bdc8628",8734:"1f259505",8737:"f138d21c",8749:"bc214206",8901:"e05f6301",8927:"cee13eea",8947:"19410731",9024:"331564b7",9048:"9a2fc095",9070:"1639171f",9099:"e344c6a7",9144:"6c7e6a5b",9190:"dd359a70",9239:"cb86fd3c",9241:"c62c9d6a",9260:"bf4629a4",9325:"cc9232ad",9328:"18a92a49",9340:"91290ba6",9350:"4db3ade4",9426:"4597631d",9429:"b5d6e41a",9490:"9b8fc054",9570:"4cdcbf30",9611:"6c00e256",9647:"2f22c378",9858:"678dd4bc",9979:"84827225"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},d="OpenSign-Docs:",t.l=(e,a,c,b)=>{if(f[e])f[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var d=f[e];if(delete f[e],r.parentNode&&r.parentNode.removeChild(r),d&&d.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"9325",70276854:"7574","7ad5624c":"33","3009d411":"89","1b14d97a":"108","8001f939":"157","0a7196e9":"225","107ddcf4":"284","23f866da":"285","4f7a2d40":"291","833eda7d":"300",e5d81aec:"419",d77fb6a8:"448",ce589067:"490",cfb1e6eb:"539","500027af":"560",eaa24e23:"636",cf03142d:"746","4acb0154":"791",d1393a72:"841","0058b4c6":"849",c6b74119:"850","05729a5b":"930","19e4dfff":"956","046910c8":"962",c1e4445e:"1170","489b8a4d":"1179",a7456010:"1235","277a78f5":"1440","2f6ff211":"1477",c9fa5aa5:"1640","19e5ad2a":"1651","7357a3c5":"1665","138cee78":"1679","9640838e":"1688","18b84479":"1706",acecf23e:"1903",d8b805fb:"1924","73664a40":"1972",reactPlayerTwitch:"2042",ac7da374:"2043","5c485335":"2075",c7b98810:"2089","299c7a47":"2131","17e5210b":"2264",c4f5d8e4:"2634","8bd80e56":"2661",da66eb9c:"2703","9e4087bc":"2711",reactPlayerMux:"2723","2c416566":"2908","4cff09f6":"3021",e9e778b7:"3073",c674cfb4:"3128","1e1b513c":"3148",d480dde9:"3230",ccc49370:"3249",e5aefb32:"3276",e48228d1:"3333","42f80fc5":"3381",reactPlayerVidyard:"3392","03e06346":"3404","5ce6d213":"3460",e785206d:"3522",b97a0b7b:"3633",f4f34a3a:"3637","8717b14a":"3694","2ffc1e57":"3724",c4fbe420:"3795","56b5f4f8":"3841","8e4d0438":"3891","0e384e19":"3976","64218a31":"3979",d281bdbe:"4001","882238ec":"4106","393be207":"4134","621db11d":"4212","5a144266":"4232","9c9cb35e":"4240","9cd612ce":"4372","56b0ffe9":"4466","5a9dd378":"4504",f82cd581:"4584","6875c492":"4813",c7e3ab5f:"4833","7ef59f7a":"4865","6bef026b":"4952","8320e026":"5277","87a6df42":"5305","88a819d0":"5314","4227e71a":"5342","02e5f5c4":"5373","01274ace":"5506","02d4f5c5":"5510","21f05a2f":"5524","14716de7":"5550",d9f32620:"5557",b18842e4:"5597",aba21aa0:"5742","6d2e526e":"5752","3b49dc44":"5794","444a2573":"5855","63d7f7ab":"5881","837d4f04":"5939","0f8cf55d":"5970","611db08b":"6007","56f1c106":"6011","1f391b9e":"6061","3973fcf3":"6157",reactPlayerVimeo:"6173",c195e1f1:"6192",d0524430:"6235",eedafdee:"6288",d91ad230:"6295","873e7b96":"6302",bb4fa758:"6318",reactPlayerDailyMotion:"6328","5e1bb91e":"6353",reactPlayerKaltura:"6463","4c5e977b":"6473",cd2b86eb:"6505","0c0943c7":"6648",f214d5ff:"6653",e226bb09:"6743","0edab2fb":"6827",f22c5875:"6841",reactPlayerFacebook:"6887",a000203c:"6940","14eb3368":"6969","98334e25":"7024",e92d0461:"7068","4d139b56":"7075",a7bd4aaa:"7098",e76c28ee:"7318","20f41f87":"7381",reactPlayerFilePlayer:"7458","814f3328":"7472","36994c47":"7477",reactPlayerMixcloud:"7570",reactPlayerStreamable:"7627",a6aa9e1f:"7643","1ee58ee1":"7696",eb56c656:"7757","767ebc75":"7797","5144c8d4":"7904",e4f5c862:"7910",b2e6bd40:"7960","489197af":"7968","54a7b8f4":"8000","5e90a9b3":"8025",fff7b69d:"8045","6621d3c0":"8046",ab2a161b:"8097","825a5e83":"8110","3a2db09e":"8121",f81c1134:"8130",c15d9823:"8146","6c0cc40d":"8168","01a85c17":"8209",reactPlayerYouTube:"8446","3217192f":"8462","652d83be":"8474","012b45bf":"8503","58abd73c":"8564","925b3f96":"8609",reactPlayerPreview:"8734","7661071f":"8737",b93339ed:"8749","1c57a399":"8901",b0378e01:"8927",ef8b811a:"8947",e5a49157:"9024",a94703ab:"9048","851f8f65":"9070","34593b53":"9099",dc8c216b:"9144","6cb65baf":"9190","0c806540":"9239","11b7b3d8":"9241","96f83544":"9260",e273c56f:"9328",reactPlayerWistia:"9340","62b755e6":"9350","38ec836e":"9426",fa501e35:"9429","02fcf422":"9490",a3008c1e:"9570","06b6ef6a":"9611","5e95c892":"9647","1f7895dc":"9858",reactPlayerSoundCloud:"9979"}[e]||e,t.p+t.u(e)},(()=>{var e={5354:0,1869:0};t.f.j=(a,c)=>{var f=t.o(e,a)?e[a]:void 0;if(0!==f)if(f)c.push(f[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var d=new Promise(((c,d)=>f=e[a]=[c,d]));c.push(f[2]=d);var b=t.p+t.u(a),r=new Error;t.l(b,(c=>{if(t.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var d=c&&("load"===c.type?"missing":c.type),b=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+d+": "+b+")",r.name="ChunkLoadError",r.type=d,r.request=b,f[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var f,d,b=c[0],r=c[1],o=c[2],l=0;if(b.some((a=>0!==e[a]))){for(f in r)t.o(r,f)&&(t.m[f]=r[f]);if(o)var n=o(t)}for(a&&a(c);l{"use strict";var e,a,c,f,d,b={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return b[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=b,t.c=r,e=[],t.O=(a,c,f,d)=>{if(!c){var b=1/0;for(n=0;n=d)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,d0&&e[n-1][2]>d;n--)e[n]=e[n-1];e[n]=[c,f,d]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var d=Object.create(null);t.r(d);var b={};a=a||[null,c({}),c([]),c(c)];for(var r=2&f&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,t.d(d,b),d},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({33:"7ad5624c",89:"3009d411",108:"1b14d97a",157:"8001f939",225:"0a7196e9",284:"107ddcf4",285:"23f866da",291:"4f7a2d40",300:"833eda7d",419:"e5d81aec",448:"d77fb6a8",490:"ce589067",539:"cfb1e6eb",560:"500027af",636:"eaa24e23",746:"cf03142d",791:"4acb0154",841:"d1393a72",849:"0058b4c6",850:"c6b74119",930:"05729a5b",956:"19e4dfff",962:"046910c8",1170:"c1e4445e",1179:"489b8a4d",1235:"a7456010",1440:"277a78f5",1477:"2f6ff211",1640:"c9fa5aa5",1651:"19e5ad2a",1665:"7357a3c5",1679:"138cee78",1688:"9640838e",1706:"18b84479",1903:"acecf23e",1924:"d8b805fb",1972:"73664a40",2042:"reactPlayerTwitch",2043:"ac7da374",2075:"5c485335",2089:"c7b98810",2131:"299c7a47",2264:"17e5210b",2634:"c4f5d8e4",2661:"8bd80e56",2703:"da66eb9c",2711:"9e4087bc",2723:"reactPlayerMux",2908:"2c416566",3021:"4cff09f6",3073:"e9e778b7",3128:"c674cfb4",3148:"1e1b513c",3230:"d480dde9",3249:"ccc49370",3276:"e5aefb32",3333:"e48228d1",3381:"42f80fc5",3392:"reactPlayerVidyard",3404:"03e06346",3460:"5ce6d213",3522:"e785206d",3633:"b97a0b7b",3637:"f4f34a3a",3694:"8717b14a",3724:"2ffc1e57",3795:"c4fbe420",3841:"56b5f4f8",3891:"8e4d0438",3976:"0e384e19",3979:"64218a31",4001:"d281bdbe",4106:"882238ec",4134:"393be207",4212:"621db11d",4232:"5a144266",4240:"9c9cb35e",4372:"9cd612ce",4466:"56b0ffe9",4504:"5a9dd378",4584:"f82cd581",4813:"6875c492",4833:"c7e3ab5f",4865:"7ef59f7a",4952:"6bef026b",5277:"8320e026",5305:"87a6df42",5314:"88a819d0",5342:"4227e71a",5373:"02e5f5c4",5506:"01274ace",5510:"02d4f5c5",5524:"21f05a2f",5550:"14716de7",5557:"d9f32620",5597:"b18842e4",5742:"aba21aa0",5752:"6d2e526e",5794:"3b49dc44",5855:"444a2573",5881:"63d7f7ab",5939:"837d4f04",5970:"0f8cf55d",6007:"611db08b",6011:"56f1c106",6061:"1f391b9e",6157:"3973fcf3",6173:"reactPlayerVimeo",6192:"c195e1f1",6235:"d0524430",6288:"eedafdee",6295:"d91ad230",6302:"873e7b96",6318:"bb4fa758",6328:"reactPlayerDailyMotion",6353:"5e1bb91e",6463:"reactPlayerKaltura",6473:"4c5e977b",6505:"cd2b86eb",6648:"0c0943c7",6653:"f214d5ff",6743:"e226bb09",6827:"0edab2fb",6841:"f22c5875",6887:"reactPlayerFacebook",6940:"a000203c",6969:"14eb3368",7024:"98334e25",7068:"e92d0461",7075:"4d139b56",7098:"a7bd4aaa",7318:"e76c28ee",7381:"20f41f87",7458:"reactPlayerFilePlayer",7472:"814f3328",7477:"36994c47",7570:"reactPlayerMixcloud",7574:"70276854",7627:"reactPlayerStreamable",7643:"a6aa9e1f",7696:"1ee58ee1",7757:"eb56c656",7797:"767ebc75",7904:"5144c8d4",7910:"e4f5c862",7960:"b2e6bd40",7968:"489197af",8e3:"54a7b8f4",8025:"5e90a9b3",8045:"fff7b69d",8046:"6621d3c0",8097:"ab2a161b",8110:"825a5e83",8121:"3a2db09e",8130:"f81c1134",8146:"c15d9823",8168:"6c0cc40d",8209:"01a85c17",8446:"reactPlayerYouTube",8462:"3217192f",8474:"652d83be",8503:"012b45bf",8564:"58abd73c",8609:"925b3f96",8734:"reactPlayerPreview",8737:"7661071f",8749:"b93339ed",8901:"1c57a399",8927:"b0378e01",8947:"ef8b811a",9024:"e5a49157",9048:"a94703ab",9070:"851f8f65",9099:"34593b53",9144:"dc8c216b",9190:"6cb65baf",9239:"0c806540",9241:"11b7b3d8",9260:"96f83544",9325:"59362658",9328:"e273c56f",9340:"reactPlayerWistia",9350:"62b755e6",9426:"38ec836e",9429:"fa501e35",9490:"02fcf422",9570:"a3008c1e",9611:"06b6ef6a",9647:"5e95c892",9858:"1f7895dc",9979:"reactPlayerSoundCloud"}[e]||e)+"."+{33:"04d03f97",89:"67599f09",108:"b9723cd9",157:"77f58424",225:"5354ae5c",284:"55b197b1",285:"fcf2ccd3",291:"4d88e708",300:"d5462c6f",419:"26112334",448:"3492c614",490:"a197b5a8",539:"ddb32cf1",560:"183f80db",636:"23fdfdd6",746:"49f86803",791:"cc896e9f",841:"71ea2b9a",849:"eb124f08",850:"3ac080ec",930:"9f35584c",956:"e6fef687",962:"0758599a",1170:"9b7be45e",1179:"955bead1",1235:"e0fce024",1440:"5dc69857",1463:"6c989e27",1477:"c7a939ea",1640:"d2ce80bf",1651:"e44b2367",1665:"6005cc6b",1679:"27742ef4",1688:"1d12e479",1706:"33c9f705",1903:"9c2000d9",1924:"fdb8fe31",1936:"3329227e",1972:"6aa170c8",2042:"ccdbba13",2043:"4a1b8c9b",2075:"fe1bbef5",2089:"4267cecd",2131:"920ad619",2264:"03a17636",2489:"a212f802",2634:"b5502b21",2661:"881ab85e",2703:"717af639",2711:"999c03aa",2723:"ad84c6fe",2908:"9a88f7fa",3021:"8265c79a",3042:"040aac0d",3073:"cff2425c",3128:"e29762a5",3148:"9a6039c4",3230:"a2cfa06b",3249:"d6c50b29",3276:"00ab24d9",3333:"099c2226",3381:"dfcbba2f",3392:"a7951473",3404:"762cd141",3460:"827e01c6",3522:"16f87a1e",3633:"d2a8f664",3637:"ffa80471",3694:"4d710693",3724:"8970445f",3795:"79cbf939",3841:"cf1c6a97",3891:"c8de3ba8",3976:"2d4c4f66",3979:"562ac819",4001:"183be27c",4106:"d9d3f988",4132:"a5c6ef5a",4134:"7b436152",4212:"5dccb1c7",4232:"804e9e11",4240:"43034981",4372:"b75be620",4466:"8b9f41be",4504:"d5dc6808",4584:"a7d307eb",4622:"420bc0ab",4813:"1198d246",4833:"cf9a081c",4865:"4a732e7a",4952:"32a88040",5013:"b10f6f78",5277:"b2de11fb",5305:"760fdd56",5314:"2ddf281e",5342:"3f44a353",5373:"60be571e",5506:"9d141ac4",5510:"92a4db7d",5524:"47dbdaaf",5550:"4dd81245",5557:"dffbf1c4",5597:"3dcd4c42",5742:"ac359952",5752:"9f2d8c5b",5794:"c75a31d7",5855:"84d22ac9",5881:"3782c030",5939:"7f698217",5970:"91dc704f",6007:"fefe155f",6011:"1a38abf2",6061:"bb03b217",6157:"fccfe0be",6173:"40e527dc",6192:"f990c3aa",6235:"5aa106b8",6288:"cb1b5f05",6295:"958608f5",6302:"92260858",6318:"213b74ab",6328:"a2ec01b1",6353:"c48fddc9",6463:"665cb544",6473:"0243df4f",6505:"c6903d64",6648:"2847553a",6653:"fdbc0c47",6743:"a3fe848c",6827:"4331c92d",6841:"50291cb3",6887:"f478ac9c",6940:"fd8689e0",6969:"408561bf",7024:"163938f2",7054:"cab4fa5c",7068:"0704c01e",7075:"8d0aa3f2",7085:"2efbf216",7098:"c920e4e4",7318:"2bd572be",7381:"cae02e9b",7458:"e1cdf442",7472:"909d2cac",7477:"4aaebd1d",7570:"086b8299",7574:"d5e60f67",7627:"df6df631",7643:"4bb958af",7696:"d7f04e0f",7757:"13e692a4",7797:"0c1174cc",7904:"8aab2983",7910:"5b11649a",7960:"db82425f",7968:"14065b3d",8e3:"58f8ce85",8025:"18e81984",8045:"d0d6b88a",8046:"7015e218",8097:"43a7d9e8",8110:"f2fff490",8121:"adb9cf78",8130:"29afdc55",8146:"bdf3ab1c",8160:"4a1cc722",8168:"11595f0e",8209:"b9e31ef1",8446:"594ab8ca",8462:"d040ed86",8474:"97c5edc0",8503:"45b8fe0a",8564:"7661f930",8609:"6bdc8628",8734:"1f259505",8737:"f138d21c",8749:"bc214206",8901:"e05f6301",8927:"cee13eea",8947:"19410731",9024:"331564b7",9048:"9a2fc095",9070:"c0d7643e",9099:"44951b14",9144:"6c7e6a5b",9190:"dd359a70",9239:"cb86fd3c",9241:"c62c9d6a",9260:"bf4629a4",9325:"cc9232ad",9328:"18a92a49",9340:"91290ba6",9350:"4db3ade4",9426:"4597631d",9429:"b5d6e41a",9490:"9b8fc054",9570:"4cdcbf30",9611:"6c00e256",9647:"2f22c378",9858:"678dd4bc",9979:"84827225"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},d="OpenSign-Docs:",t.l=(e,a,c,b)=>{if(f[e])f[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var d=f[e];if(delete f[e],r.parentNode&&r.parentNode.removeChild(r),d&&d.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"9325",70276854:"7574","7ad5624c":"33","3009d411":"89","1b14d97a":"108","8001f939":"157","0a7196e9":"225","107ddcf4":"284","23f866da":"285","4f7a2d40":"291","833eda7d":"300",e5d81aec:"419",d77fb6a8:"448",ce589067:"490",cfb1e6eb:"539","500027af":"560",eaa24e23:"636",cf03142d:"746","4acb0154":"791",d1393a72:"841","0058b4c6":"849",c6b74119:"850","05729a5b":"930","19e4dfff":"956","046910c8":"962",c1e4445e:"1170","489b8a4d":"1179",a7456010:"1235","277a78f5":"1440","2f6ff211":"1477",c9fa5aa5:"1640","19e5ad2a":"1651","7357a3c5":"1665","138cee78":"1679","9640838e":"1688","18b84479":"1706",acecf23e:"1903",d8b805fb:"1924","73664a40":"1972",reactPlayerTwitch:"2042",ac7da374:"2043","5c485335":"2075",c7b98810:"2089","299c7a47":"2131","17e5210b":"2264",c4f5d8e4:"2634","8bd80e56":"2661",da66eb9c:"2703","9e4087bc":"2711",reactPlayerMux:"2723","2c416566":"2908","4cff09f6":"3021",e9e778b7:"3073",c674cfb4:"3128","1e1b513c":"3148",d480dde9:"3230",ccc49370:"3249",e5aefb32:"3276",e48228d1:"3333","42f80fc5":"3381",reactPlayerVidyard:"3392","03e06346":"3404","5ce6d213":"3460",e785206d:"3522",b97a0b7b:"3633",f4f34a3a:"3637","8717b14a":"3694","2ffc1e57":"3724",c4fbe420:"3795","56b5f4f8":"3841","8e4d0438":"3891","0e384e19":"3976","64218a31":"3979",d281bdbe:"4001","882238ec":"4106","393be207":"4134","621db11d":"4212","5a144266":"4232","9c9cb35e":"4240","9cd612ce":"4372","56b0ffe9":"4466","5a9dd378":"4504",f82cd581:"4584","6875c492":"4813",c7e3ab5f:"4833","7ef59f7a":"4865","6bef026b":"4952","8320e026":"5277","87a6df42":"5305","88a819d0":"5314","4227e71a":"5342","02e5f5c4":"5373","01274ace":"5506","02d4f5c5":"5510","21f05a2f":"5524","14716de7":"5550",d9f32620:"5557",b18842e4:"5597",aba21aa0:"5742","6d2e526e":"5752","3b49dc44":"5794","444a2573":"5855","63d7f7ab":"5881","837d4f04":"5939","0f8cf55d":"5970","611db08b":"6007","56f1c106":"6011","1f391b9e":"6061","3973fcf3":"6157",reactPlayerVimeo:"6173",c195e1f1:"6192",d0524430:"6235",eedafdee:"6288",d91ad230:"6295","873e7b96":"6302",bb4fa758:"6318",reactPlayerDailyMotion:"6328","5e1bb91e":"6353",reactPlayerKaltura:"6463","4c5e977b":"6473",cd2b86eb:"6505","0c0943c7":"6648",f214d5ff:"6653",e226bb09:"6743","0edab2fb":"6827",f22c5875:"6841",reactPlayerFacebook:"6887",a000203c:"6940","14eb3368":"6969","98334e25":"7024",e92d0461:"7068","4d139b56":"7075",a7bd4aaa:"7098",e76c28ee:"7318","20f41f87":"7381",reactPlayerFilePlayer:"7458","814f3328":"7472","36994c47":"7477",reactPlayerMixcloud:"7570",reactPlayerStreamable:"7627",a6aa9e1f:"7643","1ee58ee1":"7696",eb56c656:"7757","767ebc75":"7797","5144c8d4":"7904",e4f5c862:"7910",b2e6bd40:"7960","489197af":"7968","54a7b8f4":"8000","5e90a9b3":"8025",fff7b69d:"8045","6621d3c0":"8046",ab2a161b:"8097","825a5e83":"8110","3a2db09e":"8121",f81c1134:"8130",c15d9823:"8146","6c0cc40d":"8168","01a85c17":"8209",reactPlayerYouTube:"8446","3217192f":"8462","652d83be":"8474","012b45bf":"8503","58abd73c":"8564","925b3f96":"8609",reactPlayerPreview:"8734","7661071f":"8737",b93339ed:"8749","1c57a399":"8901",b0378e01:"8927",ef8b811a:"8947",e5a49157:"9024",a94703ab:"9048","851f8f65":"9070","34593b53":"9099",dc8c216b:"9144","6cb65baf":"9190","0c806540":"9239","11b7b3d8":"9241","96f83544":"9260",e273c56f:"9328",reactPlayerWistia:"9340","62b755e6":"9350","38ec836e":"9426",fa501e35:"9429","02fcf422":"9490",a3008c1e:"9570","06b6ef6a":"9611","5e95c892":"9647","1f7895dc":"9858",reactPlayerSoundCloud:"9979"}[e]||e,t.p+t.u(e)},(()=>{var e={5354:0,1869:0};t.f.j=(a,c)=>{var f=t.o(e,a)?e[a]:void 0;if(0!==f)if(f)c.push(f[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var d=new Promise(((c,d)=>f=e[a]=[c,d]));c.push(f[2]=d);var b=t.p+t.u(a),r=new Error;t.l(b,(c=>{if(t.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var d=c&&("load"===c.type?"missing":c.type),b=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+d+": "+b+")",r.name="ChunkLoadError",r.type=d,r.request=b,f[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var f,d,b=c[0],r=c[1],o=c[2],l=0;if(b.some((a=>0!==e[a]))){for(f in r)t.o(r,f)&&(t.m[f]=r[f]);if(o)var n=o(t)}for(a&&a(c);l Archive | OpenSign™ - + diff --git a/blog/authors/index.html b/blog/authors/index.html index fd0990725..3faaee278 100644 --- a/blog/authors/index.html +++ b/blog/authors/index.html @@ -5,7 +5,7 @@ Authors | OpenSign™ - + diff --git a/blog/first-blog-post/index.html b/blog/first-blog-post/index.html index 16ff88617..a3482c221 100644 --- a/blog/first-blog-post/index.html +++ b/blog/first-blog-post/index.html @@ -5,7 +5,7 @@ First Blog Post | OpenSign™ - + diff --git a/blog/index.html b/blog/index.html index b79ce1889..c71ec641e 100644 --- a/blog/index.html +++ b/blog/index.html @@ -5,7 +5,7 @@ Blog | OpenSign™ - + diff --git a/blog/long-blog-post/index.html b/blog/long-blog-post/index.html index 0948e747d..50b0b4fd2 100644 --- a/blog/long-blog-post/index.html +++ b/blog/long-blog-post/index.html @@ -5,7 +5,7 @@ Long Blog Post | OpenSign™ - + diff --git a/blog/mdx-blog-post/index.html b/blog/mdx-blog-post/index.html index 342e3f318..561485721 100644 --- a/blog/mdx-blog-post/index.html +++ b/blog/mdx-blog-post/index.html @@ -5,7 +5,7 @@ MDX Blog Post | OpenSign™ - + diff --git a/blog/tags/docusaurus/index.html b/blog/tags/docusaurus/index.html index aa19246a3..b0dd2db7a 100644 --- a/blog/tags/docusaurus/index.html +++ b/blog/tags/docusaurus/index.html @@ -5,7 +5,7 @@ 4 posts tagged with "docusaurus" | OpenSign™ - + diff --git a/blog/tags/facebook/index.html b/blog/tags/facebook/index.html index 05289ad37..e2d1e23f0 100644 --- a/blog/tags/facebook/index.html +++ b/blog/tags/facebook/index.html @@ -5,7 +5,7 @@ One post tagged with "facebook" | OpenSign™ - + diff --git a/blog/tags/hello/index.html b/blog/tags/hello/index.html index 55c219c65..52e694034 100644 --- a/blog/tags/hello/index.html +++ b/blog/tags/hello/index.html @@ -5,7 +5,7 @@ 2 posts tagged with "hello" | OpenSign™ - + diff --git a/blog/tags/hola/index.html b/blog/tags/hola/index.html index d7322c288..c82163b7c 100644 --- a/blog/tags/hola/index.html +++ b/blog/tags/hola/index.html @@ -5,7 +5,7 @@ One post tagged with "hola" | OpenSign™ - + diff --git a/blog/tags/index.html b/blog/tags/index.html index ab9abd842..f6e07c7f6 100644 --- a/blog/tags/index.html +++ b/blog/tags/index.html @@ -5,7 +5,7 @@ Tags | OpenSign™ - + diff --git a/blog/welcome/index.html b/blog/welcome/index.html index e6a70eb98..c90bded01 100644 --- a/blog/welcome/index.html +++ b/blog/welcome/index.html @@ -5,7 +5,7 @@ Welcome | OpenSign™ - + diff --git a/docs/API-docs/api-intro/index.html b/docs/API-docs/api-intro/index.html index 40139360d..77a9ef6d7 100644 --- a/docs/API-docs/api-intro/index.html +++ b/docs/API-docs/api-intro/index.html @@ -5,7 +5,7 @@ OpenSign APIs | OpenSign™ - + diff --git a/docs/API-docs/v1.1/contactlist/index.html b/docs/API-docs/v1.1/contactlist/index.html index f18b2d453..f9836c416 100644 --- a/docs/API-docs/v1.1/contactlist/index.html +++ b/docs/API-docs/v1.1/contactlist/index.html @@ -5,7 +5,7 @@ Get Contact list | OpenSign™ - + diff --git a/docs/API-docs/v1.1/createcontact/index.html b/docs/API-docs/v1.1/createcontact/index.html index cd049ebfa..23cfe5904 100644 --- a/docs/API-docs/v1.1/createcontact/index.html +++ b/docs/API-docs/v1.1/createcontact/index.html @@ -5,7 +5,7 @@ Create Contact | OpenSign™ - + diff --git a/docs/API-docs/v1.1/createdocument/index.html b/docs/API-docs/v1.1/createdocument/index.html index 535b34ce3..e9dcb953f 100644 --- a/docs/API-docs/v1.1/createdocument/index.html +++ b/docs/API-docs/v1.1/createdocument/index.html @@ -5,7 +5,7 @@ Create Document | OpenSign™ - + @@ -25,6 +25,7 @@
  • name: Provides a different name for widgets if you are providing more than one widget.
  • 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.
  • 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.
  • +
  • hide_text_with_asterisks: When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans.
  • List of all supported widgets:

      @@ -42,19 +43,19 @@
      1. email
      -
      {
      "type": "email",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
      "required": true,
      "name": "email",
      "color": "black",
      "fontsize": 12
      }
      }
      +
      {
      "type": "email",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
      "required": true,
      "name": "email",
      "color": "black",
      "fontsize": 12,
      "hide_text_with_asterisks": false
      }
      }
      1. name
      -
      {
      "type": "name",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
      "required": true,
      "name": "name",
      "color": "black",
      "fontsize": 12
      }
      }
      +
      {
      "type": "name",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
      "required": true,
      "name": "name",
      "color": "black",
      "fontsize": 12,
      "hide_text_with_asterisks": false
      }
      }
      1. job Title
      -
      {
      "type": "job title",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
      "required": true,
      "name": "job title",
      "color": "black",
      "fontsize": 12
      }
      }
      +
      {
      "type": "job title",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
      "required": true,
      "name": "job title",
      "color": "black",
      "fontsize": 12,
      "hide_text_with_asterisks": false
      }
      }
      1. company
      -
      {
      "type": "company",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
      "required": true,
      "name": "company",
      "color": "black",
      "fontsize": 12
      }
      }
      +
      {
      "type": "company",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
      "required": true,
      "name": "company",
      "color": "black",
      "fontsize": 12,
      "hide_text_with_asterisks": false
      }
      }
      1. date
      @@ -80,7 +81,7 @@
      1. textbox
      -
      {
      "type": "textbox",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
      "name": "textbox",
      "required": true,
      "readonly": false,
      "default": "name",
      "hint": "provide name",
      "regularexpression": "",
      "color": "black",
      "fontsize": 12
      }
      }
      +
      {
      "type": "textbox",
      "page": 1,
      "x": 327,
      "y": 628,
      "w": 114,
      "h": 21,
      "options": {
      "name": "textbox",
      "required": true,
      "readonly": false,
      "default": "name",
      "hint": "provide name",
      "regularexpression": "",
      "color": "black",
      "fontsize": 12,
      "hide_text_with_asterisks": false
      }
      }
      • default: Provide a default value for the textbox (Optional).
      • hint: Provide a hint for the textbox (Optional).
      • @@ -124,7 +125,7 @@
        1. number
        -
        {
        "type": "number",
        "page": 1,
        "x": 107,
        "y": 528,
        "w": 60,
        "h": 21,
        "options": {
        "name": "number",
        "required": true,
        "readonly": false,
        "default": 0,
        "hint": "Enter number",
        "formula": "",
        "decimalplaces": 2,
        "color": "black",
        "fontsize": 12
        }
        }
        +
        {
        "type": "number",
        "page": 1,
        "x": 107,
        "y": 528,
        "w": 60,
        "h": 21,
        "options": {
        "name": "number",
        "required": true,
        "readonly": false,
        "default": 0,
        "hint": "Enter number",
        "formula": "",
        "decimalplaces": 2,
        "color": "black",
        "fontsize": 12,
        "hide_text_with_asterisks": false
        }
        }
        • formula: Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more visit here (optional).
        • default: Provide a default number (Optional).
        • diff --git a/docs/API-docs/v1.1/createdocumentwithtemplateid/index.html b/docs/API-docs/v1.1/createdocumentwithtemplateid/index.html index d30b3c30f..0194e1679 100644 --- a/docs/API-docs/v1.1/createdocumentwithtemplateid/index.html +++ b/docs/API-docs/v1.1/createdocumentwithtemplateid/index.html @@ -5,7 +5,7 @@ Create Document from Template | OpenSign™ - + @@ -13,22 +13,23 @@
          POST 

          /createdocument/:template_id

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

          You can provide default value for all widgets based on their name all widgets support except signature, stamp, initials, image.

          +

          hide_text_with_asterisks: When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans.

          1. email
          -
          {
          "name": "email",
          "readonly": false,
          "default": "email@example.com"
          }
          +
          {
          "name": "email",
          "readonly": false,
          "default": "email@example.com",
          "hide_text_with_asterisks": false
          }
          1. name
          -
          {
          "name": "name",
          "readonly": false,
          "default": "joe"
          }
          +
          {
          "name": "name",
          "readonly": false,
          "default": "joe",
          "hide_text_with_asterisks": false
          }
          1. job Title
          -
          {
          "name": "job title",
          "readonly": false,
          "default": "ceo"
          }
          +
          {
          "name": "job title",
          "readonly": false,
          "default": "ceo",
          "hide_text_with_asterisks": false
          }
          1. company
          -
          {
          "name": "company",
          "readonly": false,
          "default": "example pvt ltd"
          }
          +
          {
          "name": "company",
          "readonly": false,
          "default": "example pvt ltd",
          "hide_text_with_asterisks": false
          }
          1. date
          @@ -36,7 +37,7 @@
          1. textbox
          -
          {
          "name": "textbox",
          "readonly": false,
          "default": "my text"
          }
          +
          {
          "name": "textbox",
          "readonly": false,
          "default": "my text",
          "hide_text_with_asterisks": false
          }
          1. checkbox
          @@ -55,7 +56,7 @@
          1. number
          -
          {
          "name": "number",
          "readonly": false,
          "default": 0,
          "formula": "",
          "decimalplaces": 2,
          }
          +
          {
          "name": "number",
          "readonly": false,
          "default": 0,
          "formula": "",
          "decimalplaces": 2,
          "hide_text_with_asterisks": false
          }

          Prefill Widgets: Prefill widgets are elements that are inserted into a document before it is shared with a user. Only the document creator has permission to add them.

          response: Provide the value that should replace the existing response.

          List of widgets supported in Prefill

          diff --git a/docs/API-docs/v1.1/createfolder/index.html b/docs/API-docs/v1.1/createfolder/index.html index a2897e793..5bd3cec0f 100644 --- a/docs/API-docs/v1.1/createfolder/index.html +++ b/docs/API-docs/v1.1/createfolder/index.html @@ -5,7 +5,7 @@ Create Folder | OpenSign™ - + diff --git a/docs/API-docs/v1.1/createtemplate/index.html b/docs/API-docs/v1.1/createtemplate/index.html index 8c3aac1cb..6c24bd4b7 100644 --- a/docs/API-docs/v1.1/createtemplate/index.html +++ b/docs/API-docs/v1.1/createtemplate/index.html @@ -5,7 +5,7 @@ Create Template | OpenSign™ - + @@ -25,6 +25,7 @@
        • name: Provides a different name for widgets if you are providing more than one widget.
        • 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.
        • 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.
        • +
        • hide_text_with_asterisks: When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans.

        List of all supported widgets:

          @@ -42,19 +43,19 @@
          1. email
          -
          {
          "type": "email",
          "page": 1,
          "x": 327,
          "y": 628,
          "w": 114,
          "h": 21,
          "options": {
          "required": true,
          "name": "email",
          "color": "black",
          "fontsize": 12
          }
          }
          +
          {
          "type": "email",
          "page": 1,
          "x": 327,
          "y": 628,
          "w": 114,
          "h": 21,
          "options": {
          "required": true,
          "name": "email",
          "color": "black",
          "fontsize": 12,
          "hide_text_with_asterisks": false
          }
          }
          1. name
          -
          {
          "type": "name",
          "page": 1,
          "x": 327,
          "y": 628,
          "w": 114,
          "h": 21,
          "options": {
          "required": true,
          "name": "name",
          "color": "black",
          "fontsize": 12
          }
          }
          +
          {
          "type": "name",
          "page": 1,
          "x": 327,
          "y": 628,
          "w": 114,
          "h": 21,
          "options": {
          "required": true,
          "name": "name",
          "color": "black",
          "fontsize": 12,
          "hide_text_with_asterisks": false
          }
          }
          1. job Title
          -
          {
          "type": "job title",
          "page": 1,
          "x": 327,
          "y": 628,
          "w": 114,
          "h": 21,
          "options": {
          "required": true,
          "name": "job title",
          "color": "black",
          "fontsize": 12
          }
          }
          +
          {
          "type": "job title",
          "page": 1,
          "x": 327,
          "y": 628,
          "w": 114,
          "h": 21,
          "options": {
          "required": true,
          "name": "job title",
          "color": "black",
          "fontsize": 12,
          "hide_text_with_asterisks": false
          }
          }
          1. company
          -
          {
          "type": "company",
          "page": 1,
          "x": 327,
          "y": 628,
          "w": 114,
          "h": 21,
          "options": {
          "required": true,
          "name": "company",
          "color": "black",
          "fontsize": 12
          }
          }
          +
          {
          "type": "company",
          "page": 1,
          "x": 327,
          "y": 628,
          "w": 114,
          "h": 21,
          "options": {
          "required": true,
          "name": "company",
          "color": "black",
          "fontsize": 12,
          "hide_text_with_asterisks": false
          }
          }
          1. date
          @@ -80,7 +81,7 @@
          1. textbox
          -
          {
          "type": "textbox",
          "page": 1,
          "x": 327,
          "y": 628,
          "w": 114,
          "h": 21,
          "options": {
          "name": "textbox",
          "required": true,
          "readonly": false,
          "default": "name",
          "hint": "provide name",
          "regularexpression": "",
          "color": "black",
          "fontsize": 12
          }
          }
          +
          {
          "type": "textbox",
          "page": 1,
          "x": 327,
          "y": 628,
          "w": 114,
          "h": 21,
          "options": {
          "name": "textbox",
          "required": true,
          "readonly": false,
          "default": "name",
          "hint": "provide name",
          "regularexpression": "",
          "color": "black",
          "fontsize": 12,
          "hide_text_with_asterisks": false
          }
          }
          • default: Provide a default value for the textbox (Optional).
          • hint: Provide a hint for the textbox (Optional).
          • @@ -124,7 +125,7 @@
            1. number
            -
            {
            "type": "number",
            "page": 1,
            "x": 107,
            "y": 528,
            "w": 60,
            "h": 21,
            "options": {
            "name": "number",
            "required": true,
            "readonly": false,
            "default": 0,
            "hint": "Enter number",
            "formula": "",
            "decimalplaces": 2,
            "color": "black",
            "fontsize": 12
            }
            }
            +
            {
            "type": "number",
            "page": 1,
            "x": 107,
            "y": 528,
            "w": 60,
            "h": 21,
            "options": {
            "name": "number",
            "required": true,
            "readonly": false,
            "default": 0,
            "hint": "Enter number",
            "formula": "",
            "decimalplaces": 2,
            "color": "black",
            "fontsize": 12,
            "hide_text_with_asterisks": false
            }
            }
            • formula: Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more visit here (optional).
            • default: Provide a default number (Optional).
            • diff --git a/docs/API-docs/v1.1/delete-template/index.html b/docs/API-docs/v1.1/delete-template/index.html index 89bfcf8af..f27ffd6af 100644 --- a/docs/API-docs/v1.1/delete-template/index.html +++ b/docs/API-docs/v1.1/delete-template/index.html @@ -5,7 +5,7 @@ Delete Template | OpenSign™ - + diff --git a/docs/API-docs/v1.1/delete-webhook/index.html b/docs/API-docs/v1.1/delete-webhook/index.html index 3ae5ecba6..b2a9a2dd9 100644 --- a/docs/API-docs/v1.1/delete-webhook/index.html +++ b/docs/API-docs/v1.1/delete-webhook/index.html @@ -5,7 +5,7 @@ Delete Webhook | OpenSign™ - + diff --git a/docs/API-docs/v1.1/deletecontact/index.html b/docs/API-docs/v1.1/deletecontact/index.html index 27e47c93d..3037d7584 100644 --- a/docs/API-docs/v1.1/deletecontact/index.html +++ b/docs/API-docs/v1.1/deletecontact/index.html @@ -5,7 +5,7 @@ Delete Contact | OpenSign™ - + diff --git a/docs/API-docs/v1.1/deletedocument/index.html b/docs/API-docs/v1.1/deletedocument/index.html index 6f13bafb4..536e22215 100644 --- a/docs/API-docs/v1.1/deletedocument/index.html +++ b/docs/API-docs/v1.1/deletedocument/index.html @@ -5,7 +5,7 @@ Delete Document | OpenSign™ - + diff --git a/docs/API-docs/v1.1/deletefolder/index.html b/docs/API-docs/v1.1/deletefolder/index.html index 814cf06b4..080c0cb51 100644 --- a/docs/API-docs/v1.1/deletefolder/index.html +++ b/docs/API-docs/v1.1/deletefolder/index.html @@ -5,7 +5,7 @@ Delete Folder | OpenSign™ - + diff --git a/docs/API-docs/v1.1/draftdocument/index.html b/docs/API-docs/v1.1/draftdocument/index.html index 0485de522..b7426956e 100644 --- a/docs/API-docs/v1.1/draftdocument/index.html +++ b/docs/API-docs/v1.1/draftdocument/index.html @@ -5,7 +5,7 @@ Draft Document | OpenSign™ - + @@ -25,6 +25,7 @@
            • name: Provides a different name for widgets if you are providing more than one widget.
            • 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.
            • 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.
            • +
            • hide_text_with_asterisks: When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans.

            List of all supported widgets:

              @@ -42,19 +43,19 @@
              1. email
              -
              {
              "type": "email",
              "page": 1,
              "x": 327,
              "y": 628,
              "w": 114,
              "h": 21,
              "options": {
              "required": true,
              "name": "email",
              "color": "black",
              "fontsize": 12
              }
              }
              +
              {
              "type": "email",
              "page": 1,
              "x": 327,
              "y": 628,
              "w": 114,
              "h": 21,
              "options": {
              "required": true,
              "name": "email",
              "color": "black",
              "fontsize": 12,
              "hide_text_with_asterisks": false
              }
              }
              1. name
              -
              {
              "type": "name",
              "page": 1,
              "x": 327,
              "y": 628,
              "w": 114,
              "h": 21,
              "options": {
              "required": true,
              "name": "name",
              "color": "black",
              "fontsize": 12
              }
              }
              +
              {
              "type": "name",
              "page": 1,
              "x": 327,
              "y": 628,
              "w": 114,
              "h": 21,
              "options": {
              "required": true,
              "name": "name",
              "color": "black",
              "fontsize": 12,
              "hide_text_with_asterisks": false
              }
              }
              1. job Title
              -
              {
              "type": "job title",
              "page": 1,
              "x": 327,
              "y": 628,
              "w": 114,
              "h": 21,
              "options": {
              "required": true,
              "name": "job title",
              "color": "black",
              "fontsize": 12
              }
              }
              +
              {
              "type": "job title",
              "page": 1,
              "x": 327,
              "y": 628,
              "w": 114,
              "h": 21,
              "options": {
              "required": true,
              "name": "job title",
              "color": "black",
              "fontsize": 12,
              "hide_text_with_asterisks": false
              }
              }
              1. company
              -
              {
              "type": "company",
              "page": 1,
              "x": 327,
              "y": 628,
              "w": 114,
              "h": 21,
              "options": {
              "required": true,
              "name": "company",
              "color": "black",
              "fontsize": 12
              }
              }
              +
              {
              "type": "company",
              "page": 1,
              "x": 327,
              "y": 628,
              "w": 114,
              "h": 21,
              "options": {
              "required": true,
              "name": "company",
              "color": "black",
              "fontsize": 12,
              "hide_text_with_asterisks": false
              }
              }
              1. date
              @@ -80,7 +81,7 @@
              1. textbox
              -
              {
              "type": "textbox",
              "page": 1,
              "x": 327,
              "y": 628,
              "w": 114,
              "h": 21,
              "options": {
              "name": "textbox",
              "required": true,
              "readonly": false,
              "default": "name",
              "hint": "provide name",
              "regularexpression": "",
              "color": "black",
              "fontsize": 12
              }
              }
              +
              {
              "type": "textbox",
              "page": 1,
              "x": 327,
              "y": 628,
              "w": 114,
              "h": 21,
              "options": {
              "name": "textbox",
              "required": true,
              "readonly": false,
              "default": "name",
              "hint": "provide name",
              "regularexpression": "",
              "color": "black",
              "fontsize": 12,
              "hide_text_with_asterisks": false
              }
              }
              • default: Provide a default value for the textbox (Optional).
              • hint: Provide a hint for the textbox (Optional).
              • @@ -124,7 +125,7 @@
                1. number
                -
                {
                "type": "number",
                "page": 1,
                "x": 107,
                "y": 528,
                "w": 60,
                "h": 21,
                "options": {
                "name": "number",
                "required": true,
                "readonly": false,
                "default": 0,
                "hint": "Enter number",
                "formula": "",
                "decimalplaces": 2,
                "color": "black",
                "fontsize": 12
                }
                }
                +
                {
                "type": "number",
                "page": 1,
                "x": 107,
                "y": 528,
                "w": 60,
                "h": 21,
                "options": {
                "name": "number",
                "required": true,
                "readonly": false,
                "default": 0,
                "hint": "Enter number",
                "formula": "",
                "decimalplaces": 2,
                "color": "black",
                "fontsize": 12,
                "hide_text_with_asterisks": false
                }
                }
                • formula: Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more visit here (optional).
                • default: Provide a default number (Optional).
                • diff --git a/docs/API-docs/v1.1/drafttemplate/index.html b/docs/API-docs/v1.1/drafttemplate/index.html index 6a67ae14d..51f2ff5a8 100644 --- a/docs/API-docs/v1.1/drafttemplate/index.html +++ b/docs/API-docs/v1.1/drafttemplate/index.html @@ -5,7 +5,7 @@ Draft Template | OpenSign™ - + @@ -27,6 +27,7 @@
                • name: Provides a different name for widgets if you are providing more than one widget.
                • 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.
                • 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.
                • +
                • hide_text_with_asterisks: When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans.

                List of all supported widgets:

                  @@ -44,19 +45,19 @@
                  1. email
                  -
                  {
                  "type": "email",
                  "page": 1,
                  "x": 327,
                  "y": 628,
                  "w": 114,
                  "h": 21,
                  "options": {
                  "required": true,
                  "name": "email",
                  "color": "black",
                  "fontsize": 12
                  }
                  }
                  +
                  {
                  "type": "email",
                  "page": 1,
                  "x": 327,
                  "y": 628,
                  "w": 114,
                  "h": 21,
                  "options": {
                  "required": true,
                  "name": "email",
                  "color": "black",
                  "fontsize": 12,
                  "hide_text_with_asterisks": false
                  }
                  }
                  1. name
                  -
                  {
                  "type": "name",
                  "page": 1,
                  "x": 327,
                  "y": 628,
                  "w": 114,
                  "h": 21,
                  "options": {
                  "required": true,
                  "name": "name",
                  "color": "black",
                  "fontsize": 12
                  }
                  }
                  +
                  {
                  "type": "name",
                  "page": 1,
                  "x": 327,
                  "y": 628,
                  "w": 114,
                  "h": 21,
                  "options": {
                  "required": true,
                  "name": "name",
                  "color": "black",
                  "fontsize": 12,
                  "hide_text_with_asterisks": false
                  }
                  }
                  1. job Title
                  -
                  {
                  "type": "job title",
                  "page": 1,
                  "x": 327,
                  "y": 628,
                  "w": 114,
                  "h": 21,
                  "options": {
                  "required": true,
                  "name": "job title",
                  "color": "black",
                  "fontsize": 12
                  }
                  }
                  +
                  {
                  "type": "job title",
                  "page": 1,
                  "x": 327,
                  "y": 628,
                  "w": 114,
                  "h": 21,
                  "options": {
                  "required": true,
                  "name": "job title",
                  "color": "black",
                  "fontsize": 12,
                  "hide_text_with_asterisks": false
                  }
                  }
                  1. company
                  -
                  {
                  "type": "company",
                  "page": 1,
                  "x": 327,
                  "y": 628,
                  "w": 114,
                  "h": 21,
                  "options": {
                  "required": true,
                  "name": "company",
                  "color": "black",
                  "fontsize": 12
                  }
                  }
                  +
                  {
                  "type": "company",
                  "page": 1,
                  "x": 327,
                  "y": 628,
                  "w": 114,
                  "h": 21,
                  "options": {
                  "required": true,
                  "name": "company",
                  "color": "black",
                  "fontsize": 12,
                  "hide_text_with_asterisks": false
                  }
                  }
                  1. date
                  @@ -82,7 +83,7 @@
                  1. textbox
                  -
                  {
                  "type": "textbox",
                  "page": 1,
                  "x": 327,
                  "y": 628,
                  "w": 114,
                  "h": 21,
                  "options": {
                  "name": "textbox",
                  "required": true,
                  "readonly": false,
                  "default": "name",
                  "hint": "provide name",
                  "regularexpression": "",
                  "color": "black",
                  "fontsize": 12
                  }
                  }
                  +
                  {
                  "type": "textbox",
                  "page": 1,
                  "x": 327,
                  "y": 628,
                  "w": 114,
                  "h": 21,
                  "options": {
                  "name": "textbox",
                  "required": true,
                  "readonly": false,
                  "default": "name",
                  "hint": "provide name",
                  "regularexpression": "",
                  "color": "black",
                  "fontsize": 12,
                  "hide_text_with_asterisks": false
                  }
                  }
                  • default: Provide a default value for the textbox (Optional).
                  • hint: Provide a hint for the textbox (Optional).
                  • @@ -126,7 +127,7 @@
                    1. number
                    -
                    {
                    "type": "number",
                    "page": 1,
                    "x": 107,
                    "y": 528,
                    "w": 60,
                    "h": 21,
                    "options": {
                    "name": "number",
                    "required": true,
                    "readonly": false,
                    "default": 0,
                    "hint": "Enter number",
                    "formula": "",
                    "decimalplaces": 2,
                    "color": "black",
                    "fontsize": 12
                    }
                    }
                    +
                    {
                    "type": "number",
                    "page": 1,
                    "x": 107,
                    "y": 528,
                    "w": 60,
                    "h": 21,
                    "options": {
                    "name": "number",
                    "required": true,
                    "readonly": false,
                    "default": 0,
                    "hint": "Enter number",
                    "formula": "",
                    "decimalplaces": 2,
                    "color": "black",
                    "fontsize": 12,
                    "hide_text_with_asterisks": false
                    }
                    }
                    • formula: Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more visit here (optional).
                    • default: Provide a default number (Optional).
                    • diff --git a/docs/API-docs/v1.1/folderlist/index.html b/docs/API-docs/v1.1/folderlist/index.html index 056f1ad99..92aa0d8ed 100644 --- a/docs/API-docs/v1.1/folderlist/index.html +++ b/docs/API-docs/v1.1/folderlist/index.html @@ -5,7 +5,7 @@ Get folder list | OpenSign™ - + diff --git a/docs/API-docs/v1.1/get-template/index.html b/docs/API-docs/v1.1/get-template/index.html index fc5dbf240..d486a70f7 100644 --- a/docs/API-docs/v1.1/get-template/index.html +++ b/docs/API-docs/v1.1/get-template/index.html @@ -5,7 +5,7 @@ Get Template | OpenSign™ - + diff --git a/docs/API-docs/v1.1/get-user/index.html b/docs/API-docs/v1.1/get-user/index.html index 9dfed1832..6b2e322c4 100644 --- a/docs/API-docs/v1.1/get-user/index.html +++ b/docs/API-docs/v1.1/get-user/index.html @@ -5,7 +5,7 @@ Get your account details | OpenSign™ - + diff --git a/docs/API-docs/v1.1/get-webhook/index.html b/docs/API-docs/v1.1/get-webhook/index.html index 2b5ec9d9c..91fc90032 100644 --- a/docs/API-docs/v1.1/get-webhook/index.html +++ b/docs/API-docs/v1.1/get-webhook/index.html @@ -5,7 +5,7 @@ Get Webhook | OpenSign™ - + diff --git a/docs/API-docs/v1.1/getcontact/index.html b/docs/API-docs/v1.1/getcontact/index.html index a37452c9e..964a1e919 100644 --- a/docs/API-docs/v1.1/getcontact/index.html +++ b/docs/API-docs/v1.1/getcontact/index.html @@ -5,7 +5,7 @@ Get Contact | OpenSign™ - + diff --git a/docs/API-docs/v1.1/getcredits/index.html b/docs/API-docs/v1.1/getcredits/index.html index 87e5f9fd7..714324f0e 100644 --- a/docs/API-docs/v1.1/getcredits/index.html +++ b/docs/API-docs/v1.1/getcredits/index.html @@ -5,7 +5,7 @@ Get your API credits | OpenSign™ - + diff --git a/docs/API-docs/v1.1/getdocument/index.html b/docs/API-docs/v1.1/getdocument/index.html index 4fede556c..1bd44e3fd 100644 --- a/docs/API-docs/v1.1/getdocument/index.html +++ b/docs/API-docs/v1.1/getdocument/index.html @@ -5,7 +5,7 @@ Get Document | OpenSign™ - + diff --git a/docs/API-docs/v1.1/getdocumentlist/index.html b/docs/API-docs/v1.1/getdocumentlist/index.html index fae51a3d6..9875c2437 100644 --- a/docs/API-docs/v1.1/getdocumentlist/index.html +++ b/docs/API-docs/v1.1/getdocumentlist/index.html @@ -5,7 +5,7 @@ Get Document list from status | OpenSign™ - + diff --git a/docs/API-docs/v1.1/getfolder/index.html b/docs/API-docs/v1.1/getfolder/index.html index 2028ba5d5..a2c7c5cc7 100644 --- a/docs/API-docs/v1.1/getfolder/index.html +++ b/docs/API-docs/v1.1/getfolder/index.html @@ -5,7 +5,7 @@ Get Folder | OpenSign™ - + diff --git a/docs/API-docs/v1.1/getformdata/index.html b/docs/API-docs/v1.1/getformdata/index.html index c1977a257..1e9983fae 100644 --- a/docs/API-docs/v1.1/getformdata/index.html +++ b/docs/API-docs/v1.1/getformdata/index.html @@ -5,7 +5,7 @@ Get Formdata | OpenSign™ - + diff --git a/docs/API-docs/v1.1/getsignerips/index.html b/docs/API-docs/v1.1/getsignerips/index.html index d6b4d1acb..501fe49ce 100644 --- a/docs/API-docs/v1.1/getsignerips/index.html +++ b/docs/API-docs/v1.1/getsignerips/index.html @@ -5,7 +5,7 @@ Get Signer IPs | OpenSign™ - + diff --git a/docs/API-docs/v1.1/gettemplatelist/index.html b/docs/API-docs/v1.1/gettemplatelist/index.html index 00dc6a9c6..352b46552 100644 --- a/docs/API-docs/v1.1/gettemplatelist/index.html +++ b/docs/API-docs/v1.1/gettemplatelist/index.html @@ -5,7 +5,7 @@ Get Template list | OpenSign™ - + diff --git a/docs/API-docs/v1.1/index.html b/docs/API-docs/v1.1/index.html index b3e30a9bf..f762bf8e6 100644 --- a/docs/API-docs/v1.1/index.html +++ b/docs/API-docs/v1.1/index.html @@ -5,7 +5,7 @@ OpenSign API v1.1 | OpenSign™ - + diff --git a/docs/API-docs/v1.1/intro/index.html b/docs/API-docs/v1.1/intro/index.html index 5ce334218..a25aec160 100644 --- a/docs/API-docs/v1.1/intro/index.html +++ b/docs/API-docs/v1.1/intro/index.html @@ -5,7 +5,7 @@ Overview | OpenSign™ - + diff --git a/docs/API-docs/v1.1/opensign-api-v-1-1/index.html b/docs/API-docs/v1.1/opensign-api-v-1-1/index.html index f005dd519..a82ffe779 100644 --- a/docs/API-docs/v1.1/opensign-api-v-1-1/index.html +++ b/docs/API-docs/v1.1/opensign-api-v-1-1/index.html @@ -5,7 +5,7 @@ OpenSign API v1.1 | OpenSign™ - + diff --git a/docs/API-docs/v1.1/publictemplate/index.html b/docs/API-docs/v1.1/publictemplate/index.html index 52ae21811..1985fbb43 100644 --- a/docs/API-docs/v1.1/publictemplate/index.html +++ b/docs/API-docs/v1.1/publictemplate/index.html @@ -5,7 +5,7 @@ Public Template | OpenSign™ - + @@ -25,6 +25,7 @@
                    • name: Provides a different name for widgets if you are providing more than one widget.
                    • 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.
                    • 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.
                    • +
                    • hide_text_with_asterisks: When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans.

                    List of all supported widgets:

                      @@ -42,19 +43,19 @@
                      1. email
                      -
                      {
                      "type": "email",
                      "page": 1,
                      "x": 327,
                      "y": 628,
                      "w": 114,
                      "h": 21,
                      "options": {
                      "required": true,
                      "name": "email",
                      "color": "black",
                      "fontsize": 12
                      }
                      }
                      +
                      {
                      "type": "email",
                      "page": 1,
                      "x": 327,
                      "y": 628,
                      "w": 114,
                      "h": 21,
                      "options": {
                      "required": true,
                      "name": "email",
                      "color": "black",
                      "fontsize": 12,
                      "hide_text_with_asterisks": false
                      }
                      }
                      1. name
                      -
                      {
                      "type": "name",
                      "page": 1,
                      "x": 327,
                      "y": 628,
                      "w": 114,
                      "h": 21,
                      "options": {
                      "required": true,
                      "name": "name",
                      "color": "black",
                      "fontsize": 12
                      }
                      }
                      +
                      {
                      "type": "name",
                      "page": 1,
                      "x": 327,
                      "y": 628,
                      "w": 114,
                      "h": 21,
                      "options": {
                      "required": true,
                      "name": "name",
                      "color": "black",
                      "fontsize": 12,
                      "hide_text_with_asterisks": false
                      }
                      }
                      1. job Title
                      -
                      {
                      "type": "job title",
                      "page": 1,
                      "x": 327,
                      "y": 628,
                      "w": 114,
                      "h": 21,
                      "options": {
                      "required": true,
                      "name": "job title",
                      "color": "black",
                      "fontsize": 12
                      }
                      }
                      +
                      {
                      "type": "job title",
                      "page": 1,
                      "x": 327,
                      "y": 628,
                      "w": 114,
                      "h": 21,
                      "options": {
                      "required": true,
                      "name": "job title",
                      "color": "black",
                      "fontsize": 12,
                      "hide_text_with_asterisks": false
                      }
                      }
                      1. company
                      -
                      {
                      "type": "company",
                      "page": 1,
                      "x": 327,
                      "y": 628,
                      "w": 114,
                      "h": 21,
                      "options": {
                      "required": true,
                      "name": "company",
                      "color": "black",
                      "fontsize": 12
                      }
                      }
                      +
                      {
                      "type": "company",
                      "page": 1,
                      "x": 327,
                      "y": 628,
                      "w": 114,
                      "h": 21,
                      "options": {
                      "required": true,
                      "name": "company",
                      "color": "black",
                      "fontsize": 12,
                      "hide_text_with_asterisks": false
                      }
                      }
                      1. date
                      @@ -80,7 +81,7 @@
                      1. textbox
                      -
                      {
                      "type": "textbox",
                      "page": 1,
                      "x": 327,
                      "y": 628,
                      "w": 114,
                      "h": 21,
                      "options": {
                      "name": "textbox",
                      "required": true,
                      "readonly": false,
                      "default": "name",
                      "hint": "provide name",
                      "regularexpression": "",
                      "color": "black",
                      "fontsize": 12
                      }
                      }
                      +
                      {
                      "type": "textbox",
                      "page": 1,
                      "x": 327,
                      "y": 628,
                      "w": 114,
                      "h": 21,
                      "options": {
                      "name": "textbox",
                      "required": true,
                      "readonly": false,
                      "default": "name",
                      "hint": "provide name",
                      "regularexpression": "",
                      "color": "black",
                      "fontsize": 12,
                      "hide_text_with_asterisks": false
                      }
                      }
                      • default: Provide a default value for the textbox (Optional).
                      • hint: Provide a hint for the textbox (Optional).
                      • @@ -124,7 +125,7 @@
                        1. number
                        -
                        {
                        "type": "number",
                        "page": 1,
                        "x": 107,
                        "y": 528,
                        "w": 60,
                        "h": 21,
                        "options": {
                        "name": "number",
                        "required": true,
                        "readonly": false,
                        "default": 0,
                        "hint": "Enter number",
                        "formula": "",
                        "decimalplaces": 2,
                        "color": "black",
                        "fontsize": 12
                        }
                        }
                        +
                        {
                        "type": "number",
                        "page": 1,
                        "x": 107,
                        "y": 528,
                        "w": 60,
                        "h": 21,
                        "options": {
                        "name": "number",
                        "required": true,
                        "readonly": false,
                        "default": 0,
                        "hint": "Enter number",
                        "formula": "",
                        "decimalplaces": 2,
                        "color": "black",
                        "fontsize": 12,
                        "hide_text_with_asterisks": false
                        }
                        }
                        • formula: Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more visit here (optional).
                        • default: Provide a default number (Optional).
                        • diff --git a/docs/API-docs/v1.1/resendrequestmail/index.html b/docs/API-docs/v1.1/resendrequestmail/index.html index d8986ce53..db5a7a1ff 100644 --- a/docs/API-docs/v1.1/resendrequestmail/index.html +++ b/docs/API-docs/v1.1/resendrequestmail/index.html @@ -5,7 +5,7 @@ Resend request mail | OpenSign™ - + diff --git a/docs/API-docs/v1.1/revokedocument/index.html b/docs/API-docs/v1.1/revokedocument/index.html index f1544c087..3738e3762 100644 --- a/docs/API-docs/v1.1/revokedocument/index.html +++ b/docs/API-docs/v1.1/revokedocument/index.html @@ -5,7 +5,7 @@ Revoke Document | OpenSign™ - + diff --git a/docs/API-docs/v1.1/save-update-webhook/index.html b/docs/API-docs/v1.1/save-update-webhook/index.html index e79f0e168..c50cef913 100644 --- a/docs/API-docs/v1.1/save-update-webhook/index.html +++ b/docs/API-docs/v1.1/save-update-webhook/index.html @@ -5,7 +5,7 @@ Save or Update Webhook | OpenSign™ - + diff --git a/docs/API-docs/v1.1/selfsign/index.html b/docs/API-docs/v1.1/selfsign/index.html index 30245a1a0..25be0fc85 100644 --- a/docs/API-docs/v1.1/selfsign/index.html +++ b/docs/API-docs/v1.1/selfsign/index.html @@ -5,7 +5,7 @@ Self Sign | OpenSign™ - + @@ -25,6 +25,7 @@
                        • name: Provides a different name for widgets if you are providing more than one widget.
                        • 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.
                        • 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.
                        • +
                        • hide_text_with_asterisks: When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans.

                        List of all supported widgets:

                          @@ -42,19 +43,19 @@
                          1. email
                          -
                          {
                          "type": "email",
                          "page": 1,
                          "x": 327,
                          "y": 628,
                          "w": 114,
                          "h": 21,
                          "options": {
                          "required": true,
                          "name": "email",
                          "color": "black",
                          "fontsize": 12
                          }
                          }
                          +
                          {
                          "type": "email",
                          "page": 1,
                          "x": 327,
                          "y": 628,
                          "w": 114,
                          "h": 21,
                          "options": {
                          "required": true,
                          "name": "email",
                          "color": "black",
                          "fontsize": 12,
                          "hide_text_with_asterisks": false
                          }
                          }
                          1. name
                          -
                          {
                          "type": "name",
                          "page": 1,
                          "x": 327,
                          "y": 628,
                          "w": 114,
                          "h": 21,
                          "options": {
                          "required": true,
                          "name": "name",
                          "color": "black",
                          "fontsize": 12
                          }
                          }
                          +
                          {
                          "type": "name",
                          "page": 1,
                          "x": 327,
                          "y": 628,
                          "w": 114,
                          "h": 21,
                          "options": {
                          "required": true,
                          "name": "name",
                          "color": "black",
                          "fontsize": 12,
                          "hide_text_with_asterisks": false
                          }
                          }
                          1. job Title
                          -
                          {
                          "type": "job title",
                          "page": 1,
                          "x": 327,
                          "y": 628,
                          "w": 114,
                          "h": 21,
                          "options": {
                          "required": true,
                          "name": "job title",
                          "color": "black",
                          "fontsize": 12
                          }
                          }
                          +
                          {
                          "type": "job title",
                          "page": 1,
                          "x": 327,
                          "y": 628,
                          "w": 114,
                          "h": 21,
                          "options": {
                          "required": true,
                          "name": "job title",
                          "color": "black",
                          "fontsize": 12,
                          "hide_text_with_asterisks": false
                          }
                          }
                          1. company
                          -
                          {
                          "type": "company",
                          "page": 1,
                          "x": 327,
                          "y": 628,
                          "w": 114,
                          "h": 21,
                          "options": {
                          "required": true,
                          "name": "company",
                          "color": "black",
                          "fontsize": 12
                          }
                          }
                          +
                          {
                          "type": "company",
                          "page": 1,
                          "x": 327,
                          "y": 628,
                          "w": 114,
                          "h": 21,
                          "options": {
                          "required": true,
                          "name": "company",
                          "color": "black",
                          "fontsize": 12,
                          "hide_text_with_asterisks": false
                          }
                          }
                          1. date
                          @@ -80,7 +81,7 @@
                          1. textbox
                          -
                          {
                          "type": "textbox",
                          "page": 1,
                          "x": 327,
                          "y": 628,
                          "w": 114,
                          "h": 21,
                          "options": {
                          "name": "textbox",
                          "required": true,
                          "readonly": false,
                          "default": "name",
                          "hint": "provide name",
                          "regularexpression": "",
                          "color": "black",
                          "fontsize": 12
                          }
                          }
                          +
                          {
                          "type": "textbox",
                          "page": 1,
                          "x": 327,
                          "y": 628,
                          "w": 114,
                          "h": 21,
                          "options": {
                          "name": "textbox",
                          "required": true,
                          "readonly": false,
                          "default": "name",
                          "hint": "provide name",
                          "regularexpression": "",
                          "color": "black",
                          "fontsize": 12,
                          "hide_text_with_asterisks": false
                          }
                          }
                          • default: Provide a default value for the textbox (Optional).
                          • hint: Provide a hint for the textbox (Optional).
                          • @@ -106,7 +107,7 @@
                            1. number
                            -
                            {
                            "type": "number",
                            "page": 1,
                            "x": 107,
                            "y": 528,
                            "w": 60,
                            "h": 21,
                            "options": {
                            "name": "number",
                            "required": true,
                            "default": 0,
                            "formula": "",
                            "decimalplaces": 2,
                            "color": "black",
                            "fontsize": 12
                            }
                            }
                            +
                            {
                            "type": "number",
                            "page": 1,
                            "x": 107,
                            "y": 528,
                            "w": 60,
                            "h": 21,
                            "options": {
                            "name": "number",
                            "required": true,
                            "default": 0,
                            "formula": "",
                            "decimalplaces": 2,
                            "color": "black",
                            "fontsize": 12,
                            "hide_text_with_asterisks": false
                            }
                            }
                            • formula: Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more visit here (optional).
                            • default: Provide a default number (Optional).
                            • diff --git a/docs/API-docs/v1.1/update-document/index.html b/docs/API-docs/v1.1/update-document/index.html index 97be5926c..8efb139c5 100644 --- a/docs/API-docs/v1.1/update-document/index.html +++ b/docs/API-docs/v1.1/update-document/index.html @@ -5,7 +5,7 @@ Update Document | OpenSign™ - + diff --git a/docs/API-docs/v1.1/update-template/index.html b/docs/API-docs/v1.1/update-template/index.html index e0752bb4b..d528a2c6c 100644 --- a/docs/API-docs/v1.1/update-template/index.html +++ b/docs/API-docs/v1.1/update-template/index.html @@ -5,7 +5,7 @@ Update Template | OpenSign™ - + diff --git a/docs/API-docs/v1.1/updatefolder/index.html b/docs/API-docs/v1.1/updatefolder/index.html index dd1dfe1cd..a4a606d99 100644 --- a/docs/API-docs/v1.1/updatefolder/index.html +++ b/docs/API-docs/v1.1/updatefolder/index.html @@ -5,7 +5,7 @@ Update Folder | OpenSign™ - + diff --git a/docs/API-docs/v1/contactlist/index.html b/docs/API-docs/v1/contactlist/index.html index 1227317ee..857f428eb 100644 --- a/docs/API-docs/v1/contactlist/index.html +++ b/docs/API-docs/v1/contactlist/index.html @@ -5,7 +5,7 @@ Get Contact list | OpenSign™ - + diff --git a/docs/API-docs/v1/createcontact/index.html b/docs/API-docs/v1/createcontact/index.html index 43a15772d..150ad60f6 100644 --- a/docs/API-docs/v1/createcontact/index.html +++ b/docs/API-docs/v1/createcontact/index.html @@ -5,7 +5,7 @@ Create Contact | OpenSign™ - + diff --git a/docs/API-docs/v1/createdocument/index.html b/docs/API-docs/v1/createdocument/index.html index ff449e051..bee204fa3 100644 --- a/docs/API-docs/v1/createdocument/index.html +++ b/docs/API-docs/v1/createdocument/index.html @@ -5,7 +5,7 @@ Create Document | OpenSign™ - + diff --git a/docs/API-docs/v1/createdocumentwithtemplateid/index.html b/docs/API-docs/v1/createdocumentwithtemplateid/index.html index 6730e6c9b..65a6f52c5 100644 --- a/docs/API-docs/v1/createdocumentwithtemplateid/index.html +++ b/docs/API-docs/v1/createdocumentwithtemplateid/index.html @@ -5,7 +5,7 @@ Create Document from Template | OpenSign™ - + diff --git a/docs/API-docs/v1/createfolder/index.html b/docs/API-docs/v1/createfolder/index.html index c608a54bf..005e87d4d 100644 --- a/docs/API-docs/v1/createfolder/index.html +++ b/docs/API-docs/v1/createfolder/index.html @@ -5,7 +5,7 @@ Create Folder | OpenSign™ - + diff --git a/docs/API-docs/v1/createtemplate/index.html b/docs/API-docs/v1/createtemplate/index.html index 598b78c3c..b3203b591 100644 --- a/docs/API-docs/v1/createtemplate/index.html +++ b/docs/API-docs/v1/createtemplate/index.html @@ -5,7 +5,7 @@ Create Template | OpenSign™ - + diff --git a/docs/API-docs/v1/delete-template/index.html b/docs/API-docs/v1/delete-template/index.html index bdc494272..e109682dc 100644 --- a/docs/API-docs/v1/delete-template/index.html +++ b/docs/API-docs/v1/delete-template/index.html @@ -5,7 +5,7 @@ Delete Template | OpenSign™ - + diff --git a/docs/API-docs/v1/delete-webhook/index.html b/docs/API-docs/v1/delete-webhook/index.html index 996e20368..aabd000d6 100644 --- a/docs/API-docs/v1/delete-webhook/index.html +++ b/docs/API-docs/v1/delete-webhook/index.html @@ -5,7 +5,7 @@ Delete Webhook | OpenSign™ - + diff --git a/docs/API-docs/v1/deletecontact/index.html b/docs/API-docs/v1/deletecontact/index.html index 37ae64919..31556189b 100644 --- a/docs/API-docs/v1/deletecontact/index.html +++ b/docs/API-docs/v1/deletecontact/index.html @@ -5,7 +5,7 @@ Delete Contact | OpenSign™ - + diff --git a/docs/API-docs/v1/deletedocument/index.html b/docs/API-docs/v1/deletedocument/index.html index dc7c7a30a..d2906b00d 100644 --- a/docs/API-docs/v1/deletedocument/index.html +++ b/docs/API-docs/v1/deletedocument/index.html @@ -5,7 +5,7 @@ Delete Document | OpenSign™ - + diff --git a/docs/API-docs/v1/deletefolder/index.html b/docs/API-docs/v1/deletefolder/index.html index a675eabee..6c05ac62b 100644 --- a/docs/API-docs/v1/deletefolder/index.html +++ b/docs/API-docs/v1/deletefolder/index.html @@ -5,7 +5,7 @@ Delete Folder | OpenSign™ - + diff --git a/docs/API-docs/v1/draftdocument/index.html b/docs/API-docs/v1/draftdocument/index.html index ebba14970..eb9bce19c 100644 --- a/docs/API-docs/v1/draftdocument/index.html +++ b/docs/API-docs/v1/draftdocument/index.html @@ -5,7 +5,7 @@ Draft Document | OpenSign™ - + diff --git a/docs/API-docs/v1/drafttemplate/index.html b/docs/API-docs/v1/drafttemplate/index.html index 39b9bbd9b..67b8a184d 100644 --- a/docs/API-docs/v1/drafttemplate/index.html +++ b/docs/API-docs/v1/drafttemplate/index.html @@ -5,7 +5,7 @@ Draft Template | OpenSign™ - + diff --git a/docs/API-docs/v1/folderlist/index.html b/docs/API-docs/v1/folderlist/index.html index 930135843..2b1adbee5 100644 --- a/docs/API-docs/v1/folderlist/index.html +++ b/docs/API-docs/v1/folderlist/index.html @@ -5,7 +5,7 @@ Get folder list | OpenSign™ - + diff --git a/docs/API-docs/v1/get-template/index.html b/docs/API-docs/v1/get-template/index.html index 5ecbb3214..b23df02c1 100644 --- a/docs/API-docs/v1/get-template/index.html +++ b/docs/API-docs/v1/get-template/index.html @@ -5,7 +5,7 @@ Get Template | OpenSign™ - + diff --git a/docs/API-docs/v1/get-user/index.html b/docs/API-docs/v1/get-user/index.html index f3bd767c0..5993f5538 100644 --- a/docs/API-docs/v1/get-user/index.html +++ b/docs/API-docs/v1/get-user/index.html @@ -5,7 +5,7 @@ Get your account details | OpenSign™ - + diff --git a/docs/API-docs/v1/get-webhook/index.html b/docs/API-docs/v1/get-webhook/index.html index e5d454945..bd94f0a8b 100644 --- a/docs/API-docs/v1/get-webhook/index.html +++ b/docs/API-docs/v1/get-webhook/index.html @@ -5,7 +5,7 @@ Get Webhook | OpenSign™ - + diff --git a/docs/API-docs/v1/getcontact/index.html b/docs/API-docs/v1/getcontact/index.html index 01179efc2..33d7ff77a 100644 --- a/docs/API-docs/v1/getcontact/index.html +++ b/docs/API-docs/v1/getcontact/index.html @@ -5,7 +5,7 @@ Get Contact | OpenSign™ - + diff --git a/docs/API-docs/v1/getdocument/index.html b/docs/API-docs/v1/getdocument/index.html index 5f7248a0c..3e3ff1b0f 100644 --- a/docs/API-docs/v1/getdocument/index.html +++ b/docs/API-docs/v1/getdocument/index.html @@ -5,7 +5,7 @@ Get Document | OpenSign™ - + diff --git a/docs/API-docs/v1/getdocumentlist/index.html b/docs/API-docs/v1/getdocumentlist/index.html index 6624f817f..a523feb7a 100644 --- a/docs/API-docs/v1/getdocumentlist/index.html +++ b/docs/API-docs/v1/getdocumentlist/index.html @@ -5,7 +5,7 @@ Get Document list from status | OpenSign™ - + diff --git a/docs/API-docs/v1/getfolder/index.html b/docs/API-docs/v1/getfolder/index.html index 3a66c1602..f77ca89cd 100644 --- a/docs/API-docs/v1/getfolder/index.html +++ b/docs/API-docs/v1/getfolder/index.html @@ -5,7 +5,7 @@ Get Folder | OpenSign™ - + diff --git a/docs/API-docs/v1/gettemplatelist/index.html b/docs/API-docs/v1/gettemplatelist/index.html index 21334b563..0f7628a9e 100644 --- a/docs/API-docs/v1/gettemplatelist/index.html +++ b/docs/API-docs/v1/gettemplatelist/index.html @@ -5,7 +5,7 @@ Get Template list | OpenSign™ - + diff --git a/docs/API-docs/v1/index.html b/docs/API-docs/v1/index.html index 946cda0e6..89c2113ee 100644 --- a/docs/API-docs/v1/index.html +++ b/docs/API-docs/v1/index.html @@ -5,7 +5,7 @@ OpenSign API v1 | OpenSign™ - + diff --git a/docs/API-docs/v1/intro/index.html b/docs/API-docs/v1/intro/index.html index 4f26760eb..e4eb75bb4 100644 --- a/docs/API-docs/v1/intro/index.html +++ b/docs/API-docs/v1/intro/index.html @@ -5,7 +5,7 @@ Overview | OpenSign™ - + diff --git a/docs/API-docs/v1/opensign-api-v-1/index.html b/docs/API-docs/v1/opensign-api-v-1/index.html index 5b85988bf..e14c33f73 100644 --- a/docs/API-docs/v1/opensign-api-v-1/index.html +++ b/docs/API-docs/v1/opensign-api-v-1/index.html @@ -5,7 +5,7 @@ OpenSign API v1 | OpenSign™ - + diff --git a/docs/API-docs/v1/resendrequestmail/index.html b/docs/API-docs/v1/resendrequestmail/index.html index 76ee67e17..83717132d 100644 --- a/docs/API-docs/v1/resendrequestmail/index.html +++ b/docs/API-docs/v1/resendrequestmail/index.html @@ -5,7 +5,7 @@ Resend request mail | OpenSign™ - + diff --git a/docs/API-docs/v1/revokedocument/index.html b/docs/API-docs/v1/revokedocument/index.html index c0d336c5d..2a1b10479 100644 --- a/docs/API-docs/v1/revokedocument/index.html +++ b/docs/API-docs/v1/revokedocument/index.html @@ -5,7 +5,7 @@ Revoke Document | OpenSign™ - + diff --git a/docs/API-docs/v1/save-update-webhook/index.html b/docs/API-docs/v1/save-update-webhook/index.html index f40221d26..3159a50cf 100644 --- a/docs/API-docs/v1/save-update-webhook/index.html +++ b/docs/API-docs/v1/save-update-webhook/index.html @@ -5,7 +5,7 @@ Save or Update Webhook | OpenSign™ - + diff --git a/docs/API-docs/v1/selfsign/index.html b/docs/API-docs/v1/selfsign/index.html index 9dfda646d..95699aa6e 100644 --- a/docs/API-docs/v1/selfsign/index.html +++ b/docs/API-docs/v1/selfsign/index.html @@ -5,7 +5,7 @@ Self Sign | OpenSign™ - + diff --git a/docs/API-docs/v1/update-document/index.html b/docs/API-docs/v1/update-document/index.html index 6421bfdfa..e24a37039 100644 --- a/docs/API-docs/v1/update-document/index.html +++ b/docs/API-docs/v1/update-document/index.html @@ -5,7 +5,7 @@ Update Document | OpenSign™ - + diff --git a/docs/API-docs/v1/update-template/index.html b/docs/API-docs/v1/update-template/index.html index 4e31bfdd6..ee6c4f7ed 100644 --- a/docs/API-docs/v1/update-template/index.html +++ b/docs/API-docs/v1/update-template/index.html @@ -5,7 +5,7 @@ Update Template | OpenSign™ - + diff --git a/docs/API-docs/v1/updatefolder/index.html b/docs/API-docs/v1/updatefolder/index.html index f61c9606d..b53ba7670 100644 --- a/docs/API-docs/v1/updatefolder/index.html +++ b/docs/API-docs/v1/updatefolder/index.html @@ -5,7 +5,7 @@ Update Folder | OpenSign™ - + diff --git a/docs/category/cloud-storage/index.html b/docs/category/cloud-storage/index.html index 9e5d2d922..91fbfab88 100644 --- a/docs/category/cloud-storage/index.html +++ b/docs/category/cloud-storage/index.html @@ -5,7 +5,7 @@ Cloud Storage | OpenSign™ - + diff --git a/docs/category/console/index.html b/docs/category/console/index.html index e236e7703..00697759e 100644 --- a/docs/category/console/index.html +++ b/docs/category/console/index.html @@ -5,7 +5,7 @@ Console | OpenSign™ - + diff --git a/docs/category/create-new-opensign-document/index.html b/docs/category/create-new-opensign-document/index.html index f23f46fc7..98c6a414e 100644 --- a/docs/category/create-new-opensign-document/index.html +++ b/docs/category/create-new-opensign-document/index.html @@ -5,7 +5,7 @@ Create New OpenSign Document | OpenSign™ - + diff --git a/docs/category/docker/index.html b/docs/category/docker/index.html index ae74ef8a3..c83fc4c52 100644 --- a/docs/category/docker/index.html +++ b/docs/category/docker/index.html @@ -5,7 +5,7 @@ Docker | OpenSign™ - + diff --git a/docs/category/documents/index.html b/docs/category/documents/index.html index b3e742863..8a07cef6f 100644 --- a/docs/category/documents/index.html +++ b/docs/category/documents/index.html @@ -5,7 +5,7 @@ Documents | OpenSign™ - + diff --git a/docs/category/faqs/index.html b/docs/category/faqs/index.html index 5ea2fd21d..25c944d20 100644 --- a/docs/category/faqs/index.html +++ b/docs/category/faqs/index.html @@ -5,7 +5,7 @@ FAQs | OpenSign™ - + diff --git a/docs/category/guides/index.html b/docs/category/guides/index.html index 526f79072..230274088 100644 --- a/docs/category/guides/index.html +++ b/docs/category/guides/index.html @@ -5,7 +5,7 @@ Guides | OpenSign™ - + diff --git a/docs/category/manage-docs-using-opensign-drive/index.html b/docs/category/manage-docs-using-opensign-drive/index.html index 8c9d52b15..dd944a0a5 100644 --- a/docs/category/manage-docs-using-opensign-drive/index.html +++ b/docs/category/manage-docs-using-opensign-drive/index.html @@ -5,7 +5,7 @@ Manage Docs using OpenSign™ Drive | OpenSign™ - + diff --git a/docs/category/settings/index.html b/docs/category/settings/index.html index d7d3cb87d..cea57eec0 100644 --- a/docs/category/settings/index.html +++ b/docs/category/settings/index.html @@ -5,7 +5,7 @@ Settings | OpenSign™ - + diff --git a/docs/category/templates/index.html b/docs/category/templates/index.html index d96ead4b9..87ac43446 100644 --- a/docs/category/templates/index.html +++ b/docs/category/templates/index.html @@ -5,7 +5,7 @@ Templates | OpenSign™ - + diff --git a/docs/category/user-menu/index.html b/docs/category/user-menu/index.html index f8292e871..725dbef2b 100644 --- a/docs/category/user-menu/index.html +++ b/docs/category/user-menu/index.html @@ -5,7 +5,7 @@ User Menu | OpenSign™ - + diff --git a/docs/contribute/CODE_OF_CONDUCT/index.html b/docs/contribute/CODE_OF_CONDUCT/index.html index 70ce8b1db..1ea2d47d8 100644 --- a/docs/contribute/CODE_OF_CONDUCT/index.html +++ b/docs/contribute/CODE_OF_CONDUCT/index.html @@ -5,7 +5,7 @@ Code of conduct | OpenSign™ - + diff --git a/docs/contribute/COMMUNITY/index.html b/docs/contribute/COMMUNITY/index.html index 85bc8646d..ad1508d43 100644 --- a/docs/contribute/COMMUNITY/index.html +++ b/docs/contribute/COMMUNITY/index.html @@ -5,7 +5,7 @@ Community at OpenSign™ | OpenSign™ - + diff --git a/docs/contribute/INSTALLATION/index.html b/docs/contribute/INSTALLATION/index.html index d08ef5c0e..995b36840 100644 --- a/docs/contribute/INSTALLATION/index.html +++ b/docs/contribute/INSTALLATION/index.html @@ -5,7 +5,7 @@ Installation instructions | OpenSign™ - + diff --git a/docs/contribute/REPORTING_GUIDELINES/index.html b/docs/contribute/REPORTING_GUIDELINES/index.html index 7b50d1444..8b055b5e9 100644 --- a/docs/contribute/REPORTING_GUIDELINES/index.html +++ b/docs/contribute/REPORTING_GUIDELINES/index.html @@ -5,7 +5,7 @@ OpenSign™ Reporting Guidelines | OpenSign™ - + diff --git a/docs/contribute/intro/index.html b/docs/contribute/intro/index.html index 75db36753..b3eb702cb 100644 --- a/docs/contribute/intro/index.html +++ b/docs/contribute/intro/index.html @@ -5,7 +5,7 @@ Contributing to OpenSign | OpenSign™ - + diff --git a/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html b/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html index 054493847..880ddd041 100644 --- a/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html +++ b/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html @@ -5,7 +5,7 @@ Why am I getting 'Ensure this field is accurately filled and meets all requirements'? | OpenSign™ - + diff --git a/docs/help/FAQs/Max File Upload Size/index.html b/docs/help/FAQs/Max File Upload Size/index.html index 369f4d638..b1c9253cc 100644 --- a/docs/help/FAQs/Max File Upload Size/index.html +++ b/docs/help/FAQs/Max File Upload Size/index.html @@ -5,7 +5,7 @@ Max File Upload Size | OpenSign™ - + diff --git a/docs/help/FAQs/User Deletion/index.html b/docs/help/FAQs/User Deletion/index.html index 9ffadea45..0c8a2ac3d 100644 --- a/docs/help/FAQs/User Deletion/index.html +++ b/docs/help/FAQs/User Deletion/index.html @@ -5,7 +5,7 @@ User Deletion | OpenSign™ - + diff --git a/docs/help/FAQs/index.html b/docs/help/FAQs/index.html index b6e157977..2634c1e14 100644 --- a/docs/help/FAQs/index.html +++ b/docs/help/FAQs/index.html @@ -5,7 +5,7 @@ Why is there no dropdown list when I sign a document myself? | OpenSign™ - + diff --git a/docs/help/New-Document/edit-document-before-sending/index.html b/docs/help/New-Document/edit-document-before-sending/index.html index 755b6f165..6d7e8ae15 100644 --- a/docs/help/New-Document/edit-document-before-sending/index.html +++ b/docs/help/New-Document/edit-document-before-sending/index.html @@ -5,7 +5,7 @@ Editing Your Document Before Sending | OpenSign™ - + diff --git a/docs/help/New-Document/enforce-email-verification/index.html b/docs/help/New-Document/enforce-email-verification/index.html index 10ce6dd22..b7c7da34c 100644 --- a/docs/help/New-Document/enforce-email-verification/index.html +++ b/docs/help/New-Document/enforce-email-verification/index.html @@ -5,7 +5,7 @@ Enforce email OTP verification | OpenSign™ - + diff --git a/docs/help/New-Document/request-signatures/index.html b/docs/help/New-Document/request-signatures/index.html index 72ddaf77f..d89907a35 100644 --- a/docs/help/New-Document/request-signatures/index.html +++ b/docs/help/New-Document/request-signatures/index.html @@ -5,7 +5,7 @@ Request signatures | OpenSign™ - + diff --git a/docs/help/New-Document/sign-yourself/index.html b/docs/help/New-Document/sign-yourself/index.html index 24774c114..8c95bd795 100644 --- a/docs/help/New-Document/sign-yourself/index.html +++ b/docs/help/New-Document/sign-yourself/index.html @@ -5,7 +5,7 @@ Sign your-self | OpenSign™ - + diff --git a/docs/help/New-Document/widgets/index.html b/docs/help/New-Document/widgets/index.html index 012c0acc4..6e04ac755 100644 --- a/docs/help/New-Document/widgets/index.html +++ b/docs/help/New-Document/widgets/index.html @@ -5,7 +5,7 @@ Widgets in OpenSign | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/create-document/index.html b/docs/help/OpenSign™ Drive/create-document/index.html index 5b407e9ec..cbd951812 100644 --- a/docs/help/OpenSign™ Drive/create-document/index.html +++ b/docs/help/OpenSign™ Drive/create-document/index.html @@ -5,7 +5,7 @@ Create Docs & Folders | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/list-grid-view/index.html b/docs/help/OpenSign™ Drive/list-grid-view/index.html index b1f704bff..71ecfe3e1 100644 --- a/docs/help/OpenSign™ Drive/list-grid-view/index.html +++ b/docs/help/OpenSign™ Drive/list-grid-view/index.html @@ -5,7 +5,7 @@ Grid vs List view | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/organize-documents/index.html b/docs/help/OpenSign™ Drive/organize-documents/index.html index c7fa62139..9f922df45 100644 --- a/docs/help/OpenSign™ Drive/organize-documents/index.html +++ b/docs/help/OpenSign™ Drive/organize-documents/index.html @@ -5,7 +5,7 @@ OpenSign™ Drive Interface Documentation | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/rename-document/index.html b/docs/help/OpenSign™ Drive/rename-document/index.html index c771260da..c6022eced 100644 --- a/docs/help/OpenSign™ Drive/rename-document/index.html +++ b/docs/help/OpenSign™ Drive/rename-document/index.html @@ -5,7 +5,7 @@ Rename documents from OpenSign™ Drive | OpenSign™ - + diff --git a/docs/help/Reports/completed/index.html b/docs/help/Reports/completed/index.html index a5788c7d6..d00d45df0 100644 --- a/docs/help/Reports/completed/index.html +++ b/docs/help/Reports/completed/index.html @@ -5,7 +5,7 @@ Completed | OpenSign™ - + diff --git a/docs/help/Reports/contactbook/index.html b/docs/help/Reports/contactbook/index.html index 2276905bc..ff4f3e212 100644 --- a/docs/help/Reports/contactbook/index.html +++ b/docs/help/Reports/contactbook/index.html @@ -5,7 +5,7 @@ Contactbook | OpenSign™ - + diff --git a/docs/help/Reports/declined/index.html b/docs/help/Reports/declined/index.html index feb2be87c..af56d8de5 100644 --- a/docs/help/Reports/declined/index.html +++ b/docs/help/Reports/declined/index.html @@ -5,7 +5,7 @@ Declined | OpenSign™ - + diff --git a/docs/help/Reports/drafts/index.html b/docs/help/Reports/drafts/index.html index 4a8b27e38..99f0e1a4a 100644 --- a/docs/help/Reports/drafts/index.html +++ b/docs/help/Reports/drafts/index.html @@ -5,7 +5,7 @@ Drafts | OpenSign™ - + diff --git a/docs/help/Reports/expired/index.html b/docs/help/Reports/expired/index.html index 4ffd26148..5c24426f1 100644 --- a/docs/help/Reports/expired/index.html +++ b/docs/help/Reports/expired/index.html @@ -5,7 +5,7 @@ Expired | OpenSign™ - + diff --git a/docs/help/Reports/in-progress/index.html b/docs/help/Reports/in-progress/index.html index 31cad6f23..f3182b04c 100644 --- a/docs/help/Reports/in-progress/index.html +++ b/docs/help/Reports/in-progress/index.html @@ -5,7 +5,7 @@ In Progress | OpenSign™ - + diff --git a/docs/help/Reports/need-your-sign/index.html b/docs/help/Reports/need-your-sign/index.html index 7a101be39..6d7a551f8 100644 --- a/docs/help/Reports/need-your-sign/index.html +++ b/docs/help/Reports/need-your-sign/index.html @@ -5,7 +5,7 @@ Need your sign | OpenSign™ - + diff --git a/docs/help/Settings/APIToken/index.html b/docs/help/Settings/APIToken/index.html index afaffe271..047255235 100644 --- a/docs/help/Settings/APIToken/index.html +++ b/docs/help/Settings/APIToken/index.html @@ -5,7 +5,7 @@ API Token | OpenSign™ - + diff --git a/docs/help/Settings/Custom-email-templates/index.html b/docs/help/Settings/Custom-email-templates/index.html index ad07ed769..c7cfddfbb 100644 --- a/docs/help/Settings/Custom-email-templates/index.html +++ b/docs/help/Settings/Custom-email-templates/index.html @@ -5,7 +5,7 @@ Custom email templates | OpenSign™ - + diff --git a/docs/help/Settings/Preferences/index.html b/docs/help/Settings/Preferences/index.html index 5b51c63c5..f581dc965 100644 --- a/docs/help/Settings/Preferences/index.html +++ b/docs/help/Settings/Preferences/index.html @@ -5,7 +5,7 @@ Preferences | OpenSign™ - + diff --git a/docs/help/Settings/SecurityManagement/index.html b/docs/help/Settings/SecurityManagement/index.html index 3e151daa9..73510477c 100644 --- a/docs/help/Settings/SecurityManagement/index.html +++ b/docs/help/Settings/SecurityManagement/index.html @@ -5,7 +5,7 @@ Security | OpenSign™ - + diff --git a/docs/help/Settings/Teams/index.html b/docs/help/Settings/Teams/index.html index e8319d346..1fa6f18a3 100644 --- a/docs/help/Settings/Teams/index.html +++ b/docs/help/Settings/Teams/index.html @@ -5,7 +5,7 @@ Manage Teams | OpenSign™ - + diff --git a/docs/help/Settings/Webhook/index.html b/docs/help/Settings/Webhook/index.html index 7c56d60e9..7fafc07be 100644 --- a/docs/help/Settings/Webhook/index.html +++ b/docs/help/Settings/Webhook/index.html @@ -5,7 +5,7 @@ Webhook | OpenSign™ - + diff --git a/docs/help/Settings/disabledocumentid/index.html b/docs/help/Settings/disabledocumentid/index.html index 4e18e0ece..cc2684ae6 100644 --- a/docs/help/Settings/disabledocumentid/index.html +++ b/docs/help/Settings/disabledocumentid/index.html @@ -5,7 +5,7 @@ Disable DocumentId | OpenSign™ - + diff --git a/docs/help/Settings/manage-users/index.html b/docs/help/Settings/manage-users/index.html index e4fa555a4..d79f92a39 100644 --- a/docs/help/Settings/manage-users/index.html +++ b/docs/help/Settings/manage-users/index.html @@ -5,7 +5,7 @@ Manage users | OpenSign™ - + diff --git a/docs/help/Settings/my-signature/index.html b/docs/help/Settings/my-signature/index.html index 312f92247..d41335dbd 100644 --- a/docs/help/Settings/my-signature/index.html +++ b/docs/help/Settings/my-signature/index.html @@ -5,7 +5,7 @@ My Signature | OpenSign™ - + diff --git a/docs/help/Templates/create-template/index.html b/docs/help/Templates/create-template/index.html index 712cb84d3..b3b7eff21 100644 --- a/docs/help/Templates/create-template/index.html +++ b/docs/help/Templates/create-template/index.html @@ -5,7 +5,7 @@ Create Templates | OpenSign™ - + diff --git a/docs/help/Templates/embed-template/index.html b/docs/help/Templates/embed-template/index.html index 68c0f5c71..9d8e6c232 100644 --- a/docs/help/Templates/embed-template/index.html +++ b/docs/help/Templates/embed-template/index.html @@ -5,7 +5,7 @@ Embedding OpenSign templates | OpenSign™ - + diff --git a/docs/help/Templates/manage-templates/index.html b/docs/help/Templates/manage-templates/index.html index b20ecdad5..40e086115 100644 --- a/docs/help/Templates/manage-templates/index.html +++ b/docs/help/Templates/manage-templates/index.html @@ -5,7 +5,7 @@ Manage Templates | OpenSign™ - + diff --git a/docs/help/Templates/publicTemplate/index.html b/docs/help/Templates/publicTemplate/index.html index d548b2015..566fecc70 100644 --- a/docs/help/Templates/publicTemplate/index.html +++ b/docs/help/Templates/publicTemplate/index.html @@ -5,7 +5,7 @@ Setting up an OpenSign template for public signing | OpenSign™ - + diff --git a/docs/help/Templates/quick-send/index.html b/docs/help/Templates/quick-send/index.html index da41d581b..6ec197015 100644 --- a/docs/help/Templates/quick-send/index.html +++ b/docs/help/Templates/quick-send/index.html @@ -5,7 +5,7 @@ Quickly Send the Document for Signature Using Template | OpenSign™ - + diff --git a/docs/help/Templates/use-template/index.html b/docs/help/Templates/use-template/index.html index 099b89425..7d51cdeb3 100644 --- a/docs/help/Templates/use-template/index.html +++ b/docs/help/Templates/use-template/index.html @@ -5,7 +5,7 @@ Use template to create documents | OpenSign™ - + diff --git a/docs/help/User Menu/Console/analystics/index.html b/docs/help/User Menu/Console/analystics/index.html index 9cb13f92d..4fec6f324 100644 --- a/docs/help/User Menu/Console/analystics/index.html +++ b/docs/help/User Menu/Console/analystics/index.html @@ -5,7 +5,7 @@ Analytics | OpenSign™ - + diff --git a/docs/help/User Menu/Console/branding/index.html b/docs/help/User Menu/Console/branding/index.html index 45fd85f40..814a5441b 100644 --- a/docs/help/User Menu/Console/branding/index.html +++ b/docs/help/User Menu/Console/branding/index.html @@ -5,7 +5,7 @@ Branding | OpenSign™ - + diff --git a/docs/help/User Menu/Console/custom_filestorage/index.html b/docs/help/User Menu/Console/custom_filestorage/index.html index e466b8ae8..a4904864b 100644 --- a/docs/help/User Menu/Console/custom_filestorage/index.html +++ b/docs/help/User Menu/Console/custom_filestorage/index.html @@ -5,7 +5,7 @@ Custom File Storage | OpenSign™ - + diff --git a/docs/help/User Menu/Console/emails/index.html b/docs/help/User Menu/Console/emails/index.html index 6636b1a83..065ee9802 100644 --- a/docs/help/User Menu/Console/emails/index.html +++ b/docs/help/User Menu/Console/emails/index.html @@ -5,7 +5,7 @@ Mail | OpenSign™ - + diff --git a/docs/help/User Menu/Console/general/index.html b/docs/help/User Menu/Console/general/index.html index 0b6fdc25f..ffb0025ff 100644 --- a/docs/help/User Menu/Console/general/index.html +++ b/docs/help/User Menu/Console/general/index.html @@ -5,7 +5,7 @@ General | OpenSign™ - + diff --git a/docs/help/User Menu/Console/globalSMTP/index.html b/docs/help/User Menu/Console/globalSMTP/index.html index c65fba4b7..52ed6166d 100644 --- a/docs/help/User Menu/Console/globalSMTP/index.html +++ b/docs/help/User Menu/Console/globalSMTP/index.html @@ -5,7 +5,7 @@ Global SMTP | OpenSign™ - + diff --git a/docs/help/User Menu/Console/orgadmin/index.html b/docs/help/User Menu/Console/orgadmin/index.html index 07dc8f55e..c3d350d49 100644 --- a/docs/help/User Menu/Console/orgadmin/index.html +++ b/docs/help/User Menu/Console/orgadmin/index.html @@ -5,7 +5,7 @@ Org Admins | OpenSign™ - + diff --git a/docs/help/User Menu/Console/organizations/index.html b/docs/help/User Menu/Console/organizations/index.html index 3ad21348d..d20fbeb11 100644 --- a/docs/help/User Menu/Console/organizations/index.html +++ b/docs/help/User Menu/Console/organizations/index.html @@ -5,7 +5,7 @@ Organizations | OpenSign™ - + diff --git a/docs/help/User Menu/Console/signing_certificate/index.html b/docs/help/User Menu/Console/signing_certificate/index.html index 4fd05f4cb..47e3d0b6d 100644 --- a/docs/help/User Menu/Console/signing_certificate/index.html +++ b/docs/help/User Menu/Console/signing_certificate/index.html @@ -5,7 +5,7 @@ Custom Signing Certificate | OpenSign™ - + diff --git a/docs/help/User Menu/Profile/index.html b/docs/help/User Menu/Profile/index.html index 0e1ea32e8..52eb203be 100644 --- a/docs/help/User Menu/Profile/index.html +++ b/docs/help/User Menu/Profile/index.html @@ -5,7 +5,7 @@ Profile | OpenSign™ - + diff --git a/docs/help/intro/index.html b/docs/help/intro/index.html index 3dbb277d2..4fb5f1151 100644 --- a/docs/help/intro/index.html +++ b/docs/help/intro/index.html @@ -5,7 +5,7 @@ Intro | OpenSign™ - + diff --git a/docs/intro/index.html b/docs/intro/index.html index 03a368da9..cbc68ea4d 100644 --- a/docs/intro/index.html +++ b/docs/intro/index.html @@ -5,7 +5,7 @@ Tutorial Intro | OpenSign™ - + diff --git a/docs/self-host/One-click-Install/DigitalOcean/index.html b/docs/self-host/One-click-Install/DigitalOcean/index.html index 98a144abe..da5c88199 100644 --- a/docs/self-host/One-click-Install/DigitalOcean/index.html +++ b/docs/self-host/One-click-Install/DigitalOcean/index.html @@ -5,7 +5,7 @@ Digital Ocean | OpenSign™ - + diff --git a/docs/self-host/cloud-storage/s3/index.html b/docs/self-host/cloud-storage/s3/index.html index 5a987fcdd..2c118b74a 100644 --- a/docs/self-host/cloud-storage/s3/index.html +++ b/docs/self-host/cloud-storage/s3/index.html @@ -5,7 +5,7 @@ AWS S3 | OpenSign™ - + diff --git a/docs/self-host/docker/run-locally/index.html b/docs/self-host/docker/run-locally/index.html index eda484161..149795bff 100644 --- a/docs/self-host/docker/run-locally/index.html +++ b/docs/self-host/docker/run-locally/index.html @@ -5,7 +5,7 @@ Self-host OpenSign™ with Docker on Linux/MacOS/Windows | OpenSign™ - + diff --git a/docs/self-host/docker/upgrade-deployment/index.html b/docs/self-host/docker/upgrade-deployment/index.html index 34adf59ba..69dbd8ece 100644 --- a/docs/self-host/docker/upgrade-deployment/index.html +++ b/docs/self-host/docker/upgrade-deployment/index.html @@ -5,7 +5,7 @@ OpenSign™ Self-Hosted 'Upgrade Deployment' Guide Using Docker on Linux, macOS, or Windows | OpenSign™ - + diff --git a/docs/self-host/guides/azure-vm-setup/index.html b/docs/self-host/guides/azure-vm-setup/index.html index 8097df657..f0e69e8a6 100644 --- a/docs/self-host/guides/azure-vm-setup/index.html +++ b/docs/self-host/guides/azure-vm-setup/index.html @@ -5,7 +5,7 @@ OpenSign Deployment Guide on Azure VM via command-line | OpenSign™ - + diff --git a/docs/self-host/guides/env-variables/index.html b/docs/self-host/guides/env-variables/index.html index 2be1083f2..28c3e5796 100644 --- a/docs/self-host/guides/env-variables/index.html +++ b/docs/self-host/guides/env-variables/index.html @@ -5,7 +5,7 @@ ENV variables which are used to setup OpenSign™ with Docker on Localhost | OpenSign™ - + diff --git a/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate/index.html b/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate/index.html index 5ca75ca27..aff7089d5 100644 --- a/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate/index.html +++ b/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate/index.html @@ -5,7 +5,7 @@ How to generate self-signed document signing certificate? | OpenSign™ - + diff --git a/docs/self-host/guides/upgrade-to-v2.1.0/index.html b/docs/self-host/guides/upgrade-to-v2.1.0/index.html index 79937b117..9b0d796fd 100644 --- a/docs/self-host/guides/upgrade-to-v2.1.0/index.html +++ b/docs/self-host/guides/upgrade-to-v2.1.0/index.html @@ -5,7 +5,7 @@ How to upgrade self-hosted OpenSign to v2.1.0? | OpenSign™ - + diff --git a/docs/self-host/intro/index.html b/docs/self-host/intro/index.html index 077d83c51..cf0578ce3 100644 --- a/docs/self-host/intro/index.html +++ b/docs/self-host/intro/index.html @@ -5,7 +5,7 @@ Self-Hosting OpenSign | OpenSign™ - + diff --git a/index.html b/index.html index 3f2f1fb57..c973f7718 100644 --- a/index.html +++ b/index.html @@ -5,7 +5,7 @@ Official OpenSign™ Docs - tutorials, API documentation, self-host help & much more. | OpenSign™ - + diff --git a/markdown-page/index.html b/markdown-page/index.html index 526fce243..ddc8342b0 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +