diff --git a/404.html b/404.html index 2f39790d5..698f9f95b 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/03e06346.b31c41dc.js b/assets/js/03e06346.b31c41dc.js new file mode 100644 index 000000000..da39821b1 --- /dev/null +++ b/assets/js/03e06346.b31c41dc.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:()=>y,contentTitle:()=>g,default:()=>f,frontMatter:()=>x,metadata:()=>i,toc:()=>j});const i=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":"eJztPNtyHLdyv4JMpcrWZrjc5UWieSqV0LaOzRxFYllUXAnJw4Od6d2BOAOMAQyXa9ZWnYfzB3nK6/k0f0mqG8Bc9kJSEm1TyfpB5g5ujUZ3oy/ovo0sn5jo8Cw6haLMuQUTXcRRCibRorRCyegwOs2AnVSjXCQs9GJHJ8eM57maGlYZ0IZZxRIN2GTDTMxm3DID+hoYN2yUV1BqIa1hY6XZBCRoboWcsFQlVQHYMBU2Y6WGFMZCQsqM1VViKw2mz37MQDJeT8+EYaZKEjBmXOX5zC+fxsxmDj4NttLSMM4qKX6qgPV6YfClSHs9xmXKOOv1StrcZaXzXq/PcLvdb7iU+53PGKclxSgHGl/wGRsBMxnXkDr4uZwRUmIGko9y3KHNoEAU+U27oUZMZGvvI24gZUoS/AHQPvteTeEaJ2t/ZsIayMcs4VIqiwAUKhVjASmzmVbVJGM2E4a9++HVH5iw2I8pmROoFS6DJxCWdpgTStZQCTnpn8tzeSrKQ/auzBVP2UxVmp18+8dmmFUMv531et/CqJqwd8e93sWXmbWlOdze5mXZVyVInC/nI9NPVLGdYscyHT+L2TQDDTgrAQfcCERuijhMJ2ANbViyRJUzliilUyGRqGJW8gkwWRUj0CZ2Z6A0MIHEoYGnsy2rtioD7N/evnmNGy247bOTvDJxvVwqNCQWiQanR8yGXX3hDuL5HtKekJOYFfwKj1BY9lMlkivctgGZ4v89pRGuer23VVkqbSFlP7otHPZ62PI15GrKuAbqn6iiUJKVXPMCLLEOsgk2a/ipEg0Z5XnAxeG53ELqnZVw2OuxY5mKxHMYMPzK1Nj37buuiCTs+raEBOnCdW2hDgltmokkI5xMuTvPMueJA1ODKSGx4hq6E9/EbIYTfwtSBQgypcXPSlqe03Fcg7Yi4Xn72BBA7Gos18TzpRLShq9+Bfaf/njw9OhQPF0haCkiqxCSWgywa55XYDxU05hlCNUPUGowxE5+XuLHlGUgJtna9Xj6vjK2MzGrjGfcGgq/VjglQi8Q2sY8N8DEuIPLgl9BazWmSJ7yvM++nrEUxrzKbcwEUpzVFfTZa2UZL8tcJBylC7IoMg9H+bdFp+zJwQMieUFnfKLVtUgBBV0qxmPQyJzYSFP4MQE6pLOSBuD2iHNsRtJh4aATlSu9TEL0uYtHlihpQdo+O7rmIifg3WYNEzLJqxTYKOfJVUx3QMw0Smk8lRngFRI7eqcueFE4nBN+mIEcqVBJhF8qvzyKfg9VigIb5XPgJ2wMqKZFhGlj1XPtWOHKiILAYgwKLvKYEBez92rErLA5xMiwJZezmKXcQsws3NiRuolZkkFyRX9pngrFRpW1SrqNpVqVqZpKj8uxktaIn1dwZGj5cIzuxGwvZs9jdhCz4SBmw52YDfdiNnwes+FBzHYGMdvZidnOXsx2njuwdg48rnmN4DYAwx2HZfv5YBfl7ithiLNRYJpaBk87MnjYZ71ezU347S9/+cu5vD2XjJ1HyFzn0SE7j+ou51Hs2lBmYtvQ/77BH7s7L/zPGf58vnPgf06p63DP/8zw587wXM79gudyhyCxvCjvgAKbHxUC/8sTEX6jRfFbkGf4EQVRHBrwrDrwYMO8vZdd3IuQwgqem/XbCT2e0I4akJY2tYebInJdvyNqfkLbacODLSQmXROJ1VZTYHiCYmdp9/t9f7Os37xb9snsvQXOp239OW4dRdMpiqb1+6+l1xNCwiJMn4aJF31SAEgyr8eD7/CEsNCF6NNwcIA4wEtpPQKw9QntvgUONvgb3rUN9raG+1s7g529DgbQNnIdimIrTbdms9ljYA91Hr88qjxBQ3WaHZqvY62KFeYHWQdNL68T0d9BZf93VNRHQYeFFO0+MiyCxlJbfG0t26qUz74wbqowtFbOsH+jms1aYFITwkHWb5IpkXjgsU9QyUZo4PURB1uEye003W5hEj+m6VZRbC18xJ9bhPjWx6Lop2l/oefS6biPBUvTmC1/Xvk9TVlRFGs+u++dz9tFsbyLflF42Ej5+qpPThXS2dbzie/wW7FKwxHdhe9kI/QcoIcEG8icW81HC5dNJqRv8ETFFjpomFQ513CDdqkRSrrej89jgcUazZ7sWDIBneeIUMG+fOO192ee/HEL3Qnwy/3jlnaGkxyxpDJWFUzDBG5Yya0FLWmya56L1LmZtugD3PCiRBNg+8/n5+k//eM2OSDQxrfOV5WKiUA/0Pafz462/utiRY+qLEEn3ADLAVcyMQOb9NlZBnnZuKKm02l/umuSTKnc+aHeGw1j9++lGr2/JHDLPjfls1U7daTRMviRdBbtfQO2gzFuWBi5wuQnGiMeGg7otvX2zh3Xre/xhG6cBZCw0XlPsPnsPCo4KSRIytD8rWwG+jy6qMc4Ix/Se8ZePIBZM5FCzkeQLzc9mNHqzzmfqcrzd3BqdbfqKbqFN2wohKz9FrSdQdxq5DcLja5tvoK/HULa3BmunMCe4QRYLkzw3HTR2R7tXVvkcJQA5MNE57UfwEY1lX4yF9SAPYwNnCTyZ3fPEtiPUcfarRhWu2eFzsG0EYNzFEKKoipq/+i4njWgrPC6RxtfOBKd/WGF9ukurcBv7lkBnZHrFziXQ/JjBP/HHZqp7/GEZMUCSHez8cdIkc49/UgX7P0MGLbVZsAV1zJ2dRdyzXxmPff12Ru83tAn6wahly1JoLTokftU1qxBfvANRT6rth9uPeW1ez0h6lsB1q9Mgb7fY98+H0Wk7d1/RoTaAfvBxOqckgWf3GG5U/MTIk8Pz5ITotc70TAWed4KKbLwKUR2MKQDORQ+7OWDiXjVkSNcSKvQLAhh2xGMKV5qKYzSjlu7e8YdaTsm6gLESrOMG6d/k8KPR4UBWwxuL7jiA2iNO17IADeeyvDx7Madrwbtcxo+3++c0/6gc06Dded0h9mIJ2hKJU3ta4OmqcXXdMTh+/LVssi2YVI80pcSYyvBenDMoKo8Zbm4oqhKKkyZ8xmeauBSD+ViuO6bTCnT9PARsy/9hg+7kTilMRj3rF8HJh7i8Fo4jNZZDF/sto5i/+CgyzEdhnmI/d6st3wKg73t4f6282itdmg1bpj1QvgOTYCxh5wX+YkedF7UszmwjdvpY91Oj0Puu49pdQ9f7HQui93Bx14Wj25ct7nmHrP6MYznR7Ni2+z2QPv1N7MjP5369n4NjXr4YrdNhS+Gj+BCXaM4fyolLunHj0Z77LGU41UE+ADt+E6V+JMJtA3sr06k+4+jSQ8HHQ3tq46C9tVOmyj39x9ElO1FFyjrPBL/8fWbH6aDP303UUdHR0ev377LXr6bHB0dFfi73++vNKJWnTYtg5qrfxHo72W649es0u/3EYUpt/yQhm+XcvIHNz5eP6bvo8+/kmdn/zGCKSscOJ8uBequv5+35tfj80/lwCiOVEmPpJU8TqPDyD1CDo+Ao5hMSzD2a5XOosPbyD8bwz/9oywcuv3e4Dvu28gkGRQc/womKb78Hoscp8KXT6BNFEf0jgCfgSPVRYeRGr2HxEYxxrhKdESAwTlo3OFt6OWey0axV8Kjw8hRfRRHPtJTf2IgE4Wx2zIdR/Ow4F1T1V+aqQz9Ub+IxnnwRepHTkND5wsv3z9qpvYM8watzWRcaz6LFh/Zh6eoIY7oxtVv7fJZuByERVdI/T6SukVxJCwU7VXWHJpWH47pBBTuhN4YfehYOhZefPCaOK7MlPyogf4ZyMcMfa9Glx9FjjjYez1WnPUDT8e1Li/cJZUjfFwJadCGt5pXwjGjl3r9+yg19Ccs80l7TRebWFrzdN3r8dajVZORCczLErju0yPuj84PoHwSnicVZTvU4rizsxrUemfDeRzd3L+ZG5aorfA0nX2Zw9i6UDJLlJagn7XfpzyZze3s7c3jaHb/9maf5fZe4OFN79/dj/Smv8l3+D1g3T2Yx1F2P6zf11kHvyOwe8/nzR0buSypOg9qpNLZZZBb8/s6hssM+2EOzLF8o1PQLUSMlMqByyVMHI+dV1+xL9DS+SJ2DzjosbjQJlxkbIqObQ0JYOIJvesKsop5Xce9JGf+AS8GA17iB1LPTDUy2EuG+YybcATMajGZAPq6fQ8a7J/DA08yTOrxz0r4OHj3Sg3XQlUmgIcOcLxdcrCUagVC1wlTHWushR1ys7f33m+fDn7ByxUzxeDN6ckDcEmm4pZL8HL6gdulm4O9OT3BFBwx9upfn70zNSYCanmnC0N1jF0LHp7p17J95oLe4PydyuWstWMDfZ/8ssWWAUqFWQlR7FIHMT+gTh5cmrjJ0cIjUpXFWIPwmQfGQmk6eCQoakSequohVHkPJjmbVPTG0CLLhnwcembUpNAI6ZIUyc5IKx2yhjxZYE9MGGzwFLCCnVrzY7agccM5G3NjMeevkgIxryu0Kuop4aYELUAmsBIFGhzqMHnxfm2im4/y7odXPjMv7CEw5Qg50E0MKatKohrihDpPKpzc4taXFCXkDtCX6xTDZdWDspm8C6QEbZREM0npCZfiZ0fCpJGglTWCjOeuqxcV6CpHeJDDu8AEWfvL3/7egmutprsMmFuBpyk+grsHQjIlHcGjpq+hRAmouhDhfKD/dfESQOiIaS5doqdjJPNwGj+hZ3Omlos+dlfHDU2VZGhY1PLWxEHGGq9WGrJNyYCl4F+J+4UbYWwr0ye8x12WDz8A4jFpwUBqCHI10ryctRm8iWeqhekoH0l0s8Tqa3CJF3hl1aWGQsiH3VNtb5xVtSCorCq4FQkLU5l+N/fPhXwCXxfsywAaUuO1UPrZGlbF6S6VTOBSyEtM9H2Agve6fj+U8hkSt50CyDZsAUnuOmvys6aUQ93GSet2oizEDjHux0h3BegJXCZophDhwcOpjuDwItVU2rtTfBosyQ4UI83MCI1PcKtfdo8FEkQ787iVFF3mgM8/0Xx3cyMqGUHsM8Hbszfp0gYwpQ0lWR1WK7ho0rHJ/xko99hZ3onz4uAMmN6Ja8R37SWIzfqpOscUzbAy7Qh9KIznivjHZo3QTbuQHFNaXkb3DZ0X+nvdAiFXVk0l6F/++j8GlRZKAk0wa/54vL6V3gnw3CiX89eeNZBvIPA+RkPJXHRB/FW27N0OjSAfnGpBOd/FCB+TuOcIKHrpIlGNT6NrHH8u1rWPy29s68/I+BwOBv+XbevdwedjW+8NPiPb+gCB9W78+wXQOn13pewIYYm7B7xX4DyeudJ390Rv/zyugyirENyww87c/de4A4Lcv8dF4HwITXjBm7dhM4SGncEA/7cgBENlE1/GpVPb5R+i+OGxjXsugaYCzN34Oro+OClKWSQZSfK6HMzdo9rE5r8SnbnxSHr/EiAQ6T931yjAmO6FsWIBX4jH3o2u9ikJmQsJl+EILheCSO6Y91adyVtVgFM6pmjWTbXCeihe5bJ6xvgEdSacRj/iEYHW9xHzh0F2Fzb2BoPLYY2E/WUkHEvK86CKQqfqCuRvu9P28tYtj6DeFHkjUSLhOlF71Nls+7vbpIGk0sLOosOz2+hmi5diy7Ufnl3ML5AKbaYo2KgMQcxtFh1G20uxRyrshJGts9uI+KImfsNlio9olqQtL8X29bA/jObx4piV0vmO/lBtfegQY/lEyMl94y4aHL3Fc3RH1cFUo4GW4k+AKqg/iHavOBJIPxlwND0R9UgePzQR25fhkEMsdVV4tDnMxYBniHd2QpiLt+SKoGQrJnkWAoIU46tDfFGzoagOw0VRK7CGP1qhMvxZq+dnDTnXcaagCg9Jh9zZ2yNl68WQtJLdA7rw957PLxzyW45lei/d9o66p0EdN5//1HV7RdGCm6nj61l09ax1u6zxuvglF7wLNSCrjHo0plfa0m6LLbtqBSaDXtDFIz6sQTzuDgiPewPC48Ggo5L43TczNIoFaQ+18kAaQltBQC3gAulWyLEioven/aYE+Rb9tSiUiGmWFEnIE1XU9WB6vTDkl7/9vR7V69VGrnNUo6X7ptKsVFPQ48oVmBnncEPV1nAYFNRmyB6nTAFe5GAMhselhQkZ1pQ3ik5i74ZMeMlHIhcodd1reHpW2xLcrrocvlTBpi+0S6O9hhyFde39aVWqY1Olr8ZY/i5mnI2wVhT6/0BmXCbO1egkCLnM0NZFN26phcESWBqhFg42Ja3miWUFl3xCPq+YtZGVQi5QzDKtRuiJNyqvnK/ZcpEr7R5B0obolQoh8eVNiU2kDSPPasiQrq+9w9nEzuHvhIMvojbC2EqJsAh0DVjFKpkrrHeGPpgqz1mprIuboNLdhhGHW82lQU3ZwRLOoEaY9wWD8ZkC7wzgCb8S8srV6NliZzVd/QgjIyx0M3gXefNZd8x3wn5fjbACmDLCKj1rRk+EzaoRifn2JPUPN9N3oTZfS4g3c6QqMSvMB5WYbUw23n4LFinEbB+dHJOa8Iz98tf/Zq+Aa8kyNXXUmlQa8lm3DKA7eYe2+panaAOvsASeJSKVkxAACxj8MeOWPDqvYYq+MsdS7uXRQrlG0+sdsm9WlmcMGYcuDwRDQNzXOmS5kFd9duSrGTYOKvxO4z6imuFpa3UoDOTXYFpuOUiF7dQwhA4wfnPdlBjc21GasnIhLQZdsg04zstEES3u3E1YFHBFJk0nZaVbzApkSmXrzCFLNR/bZv54uZjiik8hzSagI/bT1EfiOLHsqvjGvQRbUEC68pZ8erig6VaZLIUnp7NAlqybGv/hZO3MTWl5QupvuEB5KVYGLbBon3kzfgv6WiTBQlrD0dvUeTuKo1wk4G1ff38dfXfyil3v9gdR3FLrHsDc26+Ov3n5+u1LBAYFqUPYsD/oD8iwU8YWXLZWWuCdxbut9cpuUxl1Uxl1Uxl1Uxl1Uxl1Uxl1Uxl1Uxn1SWF3Uxl1Uxl1Uxl1Uxl1Uxl1Uxl1Uxl1Uxl1Uxl1Uxl1Uxl1Uxl1Uxl1Uxl1Uxl1Uxl1Uxn1qciKTWXUp1JwclMZ9begwE1l1E1l1E1l1E1l1E1l1E1l1E1l1E1l1A92Xm0qo24qo24qo24qo24qo24qo24qo/4/rYzayozaLnMuKPHR5+e6nMWzxXqpF3GUYVLj4Vl0e4uU907n8zl+/qmiHK2zizi65lrgiy3Kh4xD+h7mYl0BpnF94x6gbZ3i+rE7aHr/vpAGivmHbsQR7f3Ovu28y5M3b0+jOBr5mq6FSil9m08xd4tPXWpbK8GLvt1GOZeTipLDIjfn3JW/ybrpileUruj/aGWYYVpfA2E3j9FtA//FTa0ccHvrUiHn87q/a1o7wiM29Mbzu5jP5/8LLNbeuw==","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 s=t(74848),l=t(28453),r=t(33617),o=t.n(r),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const x={id:"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:"eJztPNtyHLdyv4JMpcrWZrjc5UWieSqV0LaOzRxFYllUXAnJw4Od6d2BOAOMAQyXa9ZWnYfzB3nK6/k0f0mqG8Bc9kJSEm1TyfpB5g5ujUZ3oy/ovo0sn5jo8Cw6haLMuQUTXcRRCibRorRCyegwOs2AnVSjXCQs9GJHJ8eM57maGlYZ0IZZxRIN2GTDTMxm3DID+hoYN2yUV1BqIa1hY6XZBCRoboWcsFQlVQHYMBU2Y6WGFMZCQsqM1VViKw2mz37MQDJeT8+EYaZKEjBmXOX5zC+fxsxmDj4NttLSMM4qKX6qgPV6YfClSHs9xmXKOOv1StrcZaXzXq/PcLvdb7iU+53PGKclxSgHGl/wGRsBMxnXkDr4uZwRUmIGko9y3KHNoEAU+U27oUZMZGvvI24gZUoS/AHQPvteTeEaJ2t/ZsIayMcs4VIqiwAUKhVjASmzmVbVJGM2E4a9++HVH5iw2I8pmROoFS6DJxCWdpgTStZQCTnpn8tzeSrKQ/auzBVP2UxVmp18+8dmmFUMv531et/CqJqwd8e93sWXmbWlOdze5mXZVyVInC/nI9NPVLGdYscyHT+L2TQDDTgrAQfcCERuijhMJ2ANbViyRJUzliilUyGRqGJW8gkwWRUj0CZ2Z6A0MIHEoYGnsy2rtioD7N/evnmNGy247bOTvDJxvVwqNCQWiQanR8yGXX3hDuL5HtKekJOYFfwKj1BY9lMlkivctgGZ4v89pRGuer23VVkqbSFlP7otHPZ62PI15GrKuAbqn6iiUJKVXPMCLLEOsgk2a/ipEg0Z5XnAxeG53ELqnZVw2OuxY5mKxHMYMPzK1Nj37buuiCTs+raEBOnCdW2hDgltmokkI5xMuTvPMueJA1ODKSGx4hq6E9/EbIYTfwtSBQgypcXPSlqe03Fcg7Yi4Xn72BBA7Gos18TzpRLShq9+Bfaf/njw9OhQPF0haCkiqxCSWgywa55XYDxU05hlCNUPUGowxE5+XuLHlGUgJtna9Xj6vjK2MzGrjGfcGgq/VjglQi8Q2sY8N8DEuIPLgl9BazWmSJ7yvM++nrEUxrzKbcwEUpzVFfTZa2UZL8tcJBylC7IoMg9H+bdFp+zJwQMieUFnfKLVtUgBBV0qxmPQyJzYSFP4MQE6pLOSBuD2iHNsRtJh4aATlSu9TEL0uYtHlihpQdo+O7rmIifg3WYNEzLJqxTYKOfJVUx3QMw0Smk8lRngFRI7eqcueFE4nBN+mIEcqVBJhF8qvzyKfg9VigIb5XPgJ2wMqKZFhGlj1XPtWOHKiILAYgwKLvKYEBez92rErLA5xMiwJZezmKXcQsws3NiRuolZkkFyRX9pngrFRpW1SrqNpVqVqZpKj8uxktaIn1dwZGj5cIzuxGwvZs9jdhCz4SBmw52YDfdiNnwes+FBzHYGMdvZidnOXsx2njuwdg48rnmN4DYAwx2HZfv5YBfl7ithiLNRYJpaBk87MnjYZ71ezU347S9/+cu5vD2XjJ1HyFzn0SE7j+ou51Hs2lBmYtvQ/77BH7s7L/zPGf58vnPgf06p63DP/8zw587wXM79gudyhyCxvCjvgAKbHxUC/8sTEX6jRfFbkGf4EQVRHBrwrDrwYMO8vZdd3IuQwgqem/XbCT2e0I4akJY2tYebInJdvyNqfkLbacODLSQmXROJ1VZTYHiCYmdp9/t9f7Os37xb9snsvQXOp239OW4dRdMpiqb1+6+l1xNCwiJMn4aJF31SAEgyr8eD7/CEsNCF6NNwcIA4wEtpPQKw9QntvgUONvgb3rUN9raG+1s7g529DgbQNnIdimIrTbdms9ljYA91Hr88qjxBQ3WaHZqvY62KFeYHWQdNL68T0d9BZf93VNRHQYeFFO0+MiyCxlJbfG0t26qUz74wbqowtFbOsH+jms1aYFITwkHWb5IpkXjgsU9QyUZo4PURB1uEye003W5hEj+m6VZRbC18xJ9bhPjWx6Lop2l/oefS6biPBUvTmC1/Xvk9TVlRFGs+u++dz9tFsbyLflF42Ej5+qpPThXS2dbzie/wW7FKwxHdhe9kI/QcoIcEG8icW81HC5dNJqRv8ETFFjpomFQ513CDdqkRSrrej89jgcUazZ7sWDIBneeIUMG+fOO192ee/HEL3Qnwy/3jlnaGkxyxpDJWFUzDBG5Yya0FLWmya56L1LmZtugD3PCiRBNg+8/n5+k//eM2OSDQxrfOV5WKiUA/0Pafz462/utiRY+qLEEn3ADLAVcyMQOb9NlZBnnZuKKm02l/umuSTKnc+aHeGw1j9++lGr2/JHDLPjfls1U7daTRMviRdBbtfQO2gzFuWBi5wuQnGiMeGg7otvX2zh3Xre/xhG6cBZCw0XlPsPnsPCo4KSRIytD8rWwG+jy6qMc4Ix/Se8ZePIBZM5FCzkeQLzc9mNHqzzmfqcrzd3BqdbfqKbqFN2wohKz9FrSdQdxq5DcLja5tvoK/HULa3BmunMCe4QRYLkzw3HTR2R7tXVvkcJQA5MNE57UfwEY1lX4yF9SAPYwNnCTyZ3fPEtiPUcfarRhWu2eFzsG0EYNzFEKKoipq/+i4njWgrPC6RxtfOBKd/WGF9ukurcBv7lkBnZHrFziXQ/JjBP/HHZqp7/GEZMUCSHez8cdIkc49/UgX7P0MGLbVZsAV1zJ2dRdyzXxmPff12Ru83tAn6wahly1JoLTokftU1qxBfvANRT6rth9uPeW1ez0h6lsB1q9Mgb7fY98+H0Wk7d1/RoTaAfvBxOqckgWf3GG5U/MTIk8Pz5ITotc70TAWed4KKbLwKUR2MKQDORQ+7OWDiXjVkSNcSKvQLAhh2xGMKV5qKYzSjlu7e8YdaTsm6gLESrOMG6d/k8KPR4UBWwxuL7jiA2iNO17IADeeyvDx7Madrwbtcxo+3++c0/6gc06Dded0h9mIJ2hKJU3ta4OmqcXXdMTh+/LVssi2YVI80pcSYyvBenDMoKo8Zbm4oqhKKkyZ8xmeauBSD+ViuO6bTCnT9PARsy/9hg+7kTilMRj3rF8HJh7i8Fo4jNZZDF/sto5i/+CgyzEdhnmI/d6st3wKg73t4f6282itdmg1bpj1QvgOTYCxh5wX+YkedF7UszmwjdvpY91Oj0Puu49pdQ9f7HQui93Bx14Wj25ct7nmHrP6MYznR7Ni2+z2QPv1N7MjP5369n4NjXr4YrdNhS+Gj+BCXaM4fyolLunHj0Z77LGU41UE+ADt+E6V+JMJtA3sr06k+4+jSQ8HHQ3tq46C9tVOmyj39x9ElO1FFyjrPBL/8fWbH6aDP303UUdHR0ev377LXr6bHB0dFfi73++vNKJWnTYtg5qrfxHo72W649es0u/3EYUpt/yQhm+XcvIHNz5eP6bvo8+/kmdn/zGCKSscOJ8uBequv5+35tfj80/lwCiOVEmPpJU8TqPDyD1CDo+Ao5hMSzD2a5XOosPbyD8bwz/9oywcuv3e4Dvu28gkGRQc/womKb78Hoscp8KXT6BNFEf0jgCfgSPVRYeRGr2HxEYxxrhKdESAwTlo3OFt6OWey0axV8Kjw8hRfRRHPtJTf2IgE4Wx2zIdR/Ow4F1T1V+aqQz9Ub+IxnnwRepHTkND5wsv3z9qpvYM8watzWRcaz6LFh/Zh6eoIY7oxtVv7fJZuByERVdI/T6SukVxJCwU7VXWHJpWH47pBBTuhN4YfehYOhZefPCaOK7MlPyogf4ZyMcMfa9Glx9FjjjYez1WnPUDT8e1Li/cJZUjfFwJadCGt5pXwjGjl3r9+yg19Ccs80l7TRebWFrzdN3r8dajVZORCczLErju0yPuj84PoHwSnicVZTvU4rizsxrUemfDeRzd3L+ZG5aorfA0nX2Zw9i6UDJLlJagn7XfpzyZze3s7c3jaHb/9maf5fZe4OFN79/dj/Smv8l3+D1g3T2Yx1F2P6zf11kHvyOwe8/nzR0buSypOg9qpNLZZZBb8/s6hssM+2EOzLF8o1PQLUSMlMqByyVMHI+dV1+xL9DS+SJ2DzjosbjQJlxkbIqObQ0JYOIJvesKsop5Xce9JGf+AS8GA17iB1LPTDUy2EuG+YybcATMajGZAPq6fQ8a7J/DA08yTOrxz0r4OHj3Sg3XQlUmgIcOcLxdcrCUagVC1wlTHWushR1ys7f33m+fDn7ByxUzxeDN6ckDcEmm4pZL8HL6gdulm4O9OT3BFBwx9upfn70zNSYCanmnC0N1jF0LHp7p17J95oLe4PydyuWstWMDfZ/8ssWWAUqFWQlR7FIHMT+gTh5cmrjJ0cIjUpXFWIPwmQfGQmk6eCQoakSequohVHkPJjmbVPTG0CLLhnwcembUpNAI6ZIUyc5IKx2yhjxZYE9MGGzwFLCCnVrzY7agccM5G3NjMeevkgIxryu0Kuop4aYELUAmsBIFGhzqMHnxfm2im4/y7odXPjMv7CEw5Qg50E0MKatKohrihDpPKpzc4taXFCXkDtCX6xTDZdWDspm8C6QEbZREM0npCZfiZ0fCpJGglTWCjOeuqxcV6CpHeJDDu8AEWfvL3/7egmutprsMmFuBpyk+grsHQjIlHcGjpq+hRAmouhDhfKD/dfESQOiIaS5doqdjJPNwGj+hZ3Omlos+dlfHDU2VZGhY1PLWxEHGGq9WGrJNyYCl4F+J+4UbYWwr0ye8x12WDz8A4jFpwUBqCHI10ryctRm8iWeqhekoH0l0s8Tqa3CJF3hl1aWGQsiH3VNtb5xVtSCorCq4FQkLU5l+N/fPhXwCXxfsywAaUuO1UPrZGlbF6S6VTOBSyEtM9H2Agve6fj+U8hkSt50CyDZsAUnuOmvys6aUQ93GSet2oizEDjHux0h3BegJXCZophDhwcOpjuDwItVU2rtTfBosyQ4UI83MCI1PcKtfdo8FEkQ787iVFF3mgM8/0Xx3cyMqGUHsM8Hbszfp0gYwpQ0lWR1WK7ho0rHJ/xko99hZ3onz4uAMmN6Ja8R37SWIzfqpOscUzbAy7Qh9KIznivjHZo3QTbuQHFNaXkb3DZ0X+nvdAiFXVk0l6F/++j8GlRZKAk0wa/54vL6V3gnw3CiX89eeNZBvIPA+RkPJXHRB/FW27N0OjSAfnGpBOd/FCB+TuOcIKHrpIlGNT6NrHH8u1rWPy29s68/I+BwOBv+XbevdwedjW+8NPiPb+gCB9W78+wXQOn13pewIYYm7B7xX4DyeudJ390Rv/zyugyirENyww87c/de4A4Lcv8dF4HwITXjBm7dhM4SGncEA/7cgBENlE1/GpVPb5R+i+OGxjXsugaYCzN34Oro+OClKWSQZSfK6HMzdo9rE5r8SnbnxSHr/EiAQ6T931yjAmO6FsWIBX4jH3o2u9ikJmQsJl+EILheCSO6Y91adyVtVgFM6pmjWTbXCeihe5bJ6xvgEdSacRj/iEYHW9xHzh0F2Fzb2BoPLYY2E/WUkHEvK86CKQqfqCuRvu9P28tYtj6DeFHkjUSLhOlF71Nls+7vbpIGk0sLOosOz2+hmi5diy7Ufnl3ML5AKbaYo2KgMQcxtFh1G20uxRyrshJGts9uI+KImfsNlio9olqQtL8X29bA/jObx4piV0vmO/lBtfegQY/lEyMl94y4aHL3Fc3RH1cFUo4GW4k+AKqg/iHavOBJIPxlwND0R9UgePzQR25fhkEMsdVV4tDnMxYBniHd2QpiLt+SKoGQrJnkWAoIU46tDfFGzoagOw0VRK7CGP1qhMvxZq+dnDTnXcaagCg9Jh9zZ2yNl68WQtJLdA7rw957PLxzyW45lei/d9o66p0EdN5//1HV7RdGCm6nj61l09ax1u6zxuvglF7wLNSCrjHo0plfa0m6LLbtqBSaDXtDFIz6sQTzuDgiPewPC48Ggo5L43TczNIoFaQ+18kAaQltBQC3gAulWyLEioven/aYE+Rb9tSiUiGmWFEnIE1XU9WB6vTDkl7/9vR7V69VGrnNUo6X7ptKsVFPQ48oVmBnncEPV1nAYFNRmyB6nTAFe5GAMhselhQkZ1pQ3ik5i74ZMeMlHIhcodd1reHpW2xLcrrocvlTBpi+0S6O9hhyFde39aVWqY1Olr8ZY/i5mnI2wVhT6/0BmXCbO1egkCLnM0NZFN26phcESWBqhFg42Ja3miWUFl3xCPq+YtZGVQi5QzDKtRuiJNyqvnK/ZcpEr7R5B0obolQoh8eVNiU2kDSPPasiQrq+9w9nEzuHvhIMvojbC2EqJsAh0DVjFKpkrrHeGPpgqz1mprIuboNLdhhGHW82lQU3ZwRLOoEaY9wWD8ZkC7wzgCb8S8srV6NliZzVd/QgjIyx0M3gXefNZd8x3wn5fjbACmDLCKj1rRk+EzaoRifn2JPUPN9N3oTZfS4g3c6QqMSvMB5WYbUw23n4LFinEbB+dHJOa8Iz98tf/Zq+Aa8kyNXXUmlQa8lm3DKA7eYe2+panaAOvsASeJSKVkxAACxj8MeOWPDqvYYq+MsdS7uXRQrlG0+sdsm9WlmcMGYcuDwRDQNzXOmS5kFd9duSrGTYOKvxO4z6imuFpa3UoDOTXYFpuOUiF7dQwhA4wfnPdlBjc21GasnIhLQZdsg04zstEES3u3E1YFHBFJk0nZaVbzApkSmXrzCFLNR/bZv54uZjiik8hzSagI/bT1EfiOLHsqvjGvQRbUEC68pZ8erig6VaZLIUnp7NAlqybGv/hZO3MTWl5QupvuEB5KVYGLbBon3kzfgv6WiTBQlrD0dvUeTuKo1wk4G1ff38dfXfyil3v9gdR3FLrHsDc26+Ov3n5+u1LBAYFqUPYsD/oD8iwU8YWXLZWWuCdxbut9cpuUxl1Uxl1Uxl1Uxl1Uxl1Uxl1Uxl1Uxn1SWF3Uxl1Uxl1Uxl1Uxl1Uxl1Uxl1Uxl1Uxl1Uxl1Uxl1Uxl1Uxl1Uxl1Uxl1Uxl1Uxl1Uxn1qciKTWXUp1JwclMZ9begwE1l1E1l1E1l1E1l1E1l1E1l1E1l1E1l1A92Xm0qo24qo24qo24qo24qo24qo24qo/4/rYzayozaLnMuKPHR5+e6nMWzxXqpF3GUYVLj4Vl0e4uU907n8zl+/qmiHK2zizi65lrgiy3Kh4xD+h7mYl0BpnF94x6gbZ3i+rE7aHr/vpAGivmHbsQR7f3Ovu28y5M3b0+jOBr5mq6FSil9m08xd4tPXWpbK8GLvt1GOZeTipLDIjfn3JW/ybrpileUruj/aGWYYVpfA2E3j9FtA//FTa0ccHvrUiHn87q/a1o7wiM29Mbzu5jP5/8LLNbeuw==",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,y={},j=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,l.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Public Template"}),"\n",(0,s.jsx)(o(),{method:"post",path:"/publictemplate",context:"endpoint"}),"\n",(0,s.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,s.jsx)(n.strong,{children:"template_id"})," and a ",(0,s.jsx)(n.strong,{children:"public_url"}),". The ",(0,s.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,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"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.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.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)(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 final PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\nfalse - If you choose not to merge, the completion certificate will be provided as a separate 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"},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",description:"Allowed values - signature, stamp.",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:{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,l.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/03e06346.fd769b08.js b/assets/js/03e06346.fd769b08.js deleted file mode 100644 index fdcf9e9fe..000000000 --- a/assets/js/03e06346.fd769b08.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:()=>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":"eJztPF1zGzeSfwU3tVWJeUOKpCRb0dbVnZJ4E996bZUtX+pO0irgTJMDawaYABhRjIpV+7D/4J7udX9afslVN4DhDD8k2VYS+Y55cMTBV6M/gO5Gd99Elk9MdHganUBR5tyCic7jKAWTaFFaoWR0GJ1kwI6rUS4SFnqxo+MXjOe5mhpWGdCGWcUSDdhkw0zMZtwyA/oKGDdslFdQaiGtYWOl2QQkaG6FnLBUJVUB2DAVNmOlhhTGQkLKjNVVYisNpsd+yEAyXk/PhGGmShIwZlzl+cwvn8bMZg4+DbbS0jDOKil+qoB1OmHwhUg7HcZlyjjrdEra3EWl806nx3C77W+4lPudzxinJcUoBxpf8BkbATMZ15A6+LmcEVJiBpKPctyhzaBAFPlNu6FGTGRj7yNuIGVKEvwB0B77Xk3hCidrfmbCGsjHLOFSKosAFCoVYwEps5lW1SRjNhOGvXvz8o9MWOzHlMwJ1AqXQQqEpR3mhJI1VEJOemfyTJ6I8pC9K3PFUzZTlWbH3/5pMcwqht9OO51vYVRN2LsXnc75l5m1pTnc2eFl2VMlSJwv5yPTS1Sxk2LHMh0/idk0Aw04KwEH3AhEboo4TCdgDW1YskSVM5YopVMhkaliVvIJMFkVI9AmdjRQGphA5tDA01nXqm5lgP3729evcKMFtz12nFcmrpdLhYbEItPg9IjZsKsvHCGe7iHvCTmJWcEvkYTCsp8qkVzitg3IFP/vOY1w1em8rcpSaQsp+8Ft4bDTwZavIVdTxjVQ/0QVhZKs5JoXYEl0UEywWcNPlViwUZ4HXByeyS5y76yEw06HvZCpSLyEAcOvTI19357rikjCrm9LSJAvXNcG6pDRpplIMsLJlDt6ljlPHJgaTAmJFVfQnvg6ZjOc+FuQKkCQKS1+VtLynMhxBdqKhOdNsiGA2NVYrknmSyWkDV/9Cuw/PXmQekQUz1cIWorIKoSkFgPsiucVGA/VNGYZQvUGSg2GxMnPS/KYsgzEJNu4Hk/fV8a2JmaV8YJbQ+HXClQi9AKhbcxzA0yMW7gs+CU0VmOKzlOe99jXM5bCmFe5jZlAjrO6gh57pSzjZZmLhOPpgiKKwsPx/OsSlT07eEAkL4jGx1pdiRTwoEvFeAwahRMbaQo/JkCHfFbSANweSY7N6HRYInSicqVXWYg+t/HIEiUtSNtjR1dc5AS826xhQiZ5lQIb5Ty5jOkOiJnGUxqpMgO8QmLH79QFLwqHc8IPM5AjFyqJ8Evll8ej30OV4oGN53OQJ2wMqKZFhGli1UvtWOHKiIIgYgwKLvKYEBez92rErLA5xCiwJZezmKXcQswsXNuRuo5ZkkFySX9pngrFRpW1SrqNpVqVqZpKj8uxktaIn9dIZGj5cIwOY7YXs6cxO4jZoB+zwTBmg72YDZ7GbHAQs2E/ZsNhzIZ7MRs+dWANDzyueY3gJgCDocOy/Xywi+fuS2FIsvHANPUZPG2dwYMe63RqacJvP/7445m8OZOMnUUoXGfRITuL6i5nUeza8MzEtoH/fY0/dofP/M8Z/nw6PPA/p9R1sOd/ZvhzODiTc7/gmRwSJJYX5S1QYPODQuB/eSbCb7QofgvnGX7EgygODUirFjzYMG/uZRf3IqSwgudm83ZCj0e0owVIK5vaw00Ru27eETU/ou004cEWOiZdEx2rjaYg8ATFcGX3+z1/s2zevFv20ey9Ac6nbf0pbh2PphM8mjbvvz69HhESlmH6NEw865ECQCfzZjz4Do8IC22IPg0HB4gDvJQ2IwBbH9HuG+Bgg7/hXVt/rzvY7w77w70WBtA2ch2Kopum3dls9hDYQ53HL48qT9BQnWaH5utYq2KN+UHWwaKX14no76Cy/wUV9VHQYSFFu48Mi6Cx1BZfU8u2KuWzL4ybKgytlTPsv1DNZg0wqQnhIOs3yZRIPPDYJ6hkIzTweoiDLmFyJ013GpjEj2naLYru0kf82SXENz4WRS9Ne0s9V6jjPhYsTWO2+nnt9zRlRVFs+Oy+tz7vFMXqLnpF4WEj5eurHjlVSGfbLCe+w28lKguJaC98qxih5wA9JNhA5tx6OVq6bDIhfYNnKrbUQcOkyrmGa7RLjVDS9X54GQsittDsyY4lE9B5jggV7MvXXnt/4tkft9CeAL/cPW5lZzjJEUsqY1XBNEzgmpXcWtCSJrviuUidm6lLH+CaFyWaADt/PTtL//kPO+SAQBvfOl9VKiYC/UA7fz096v7X+ZoeVVmCTrgBlgOuZGIGNumx0wzycuGKmk6nvemuSTKlcueHem80jN2/F2r0/oLALXvclE/W7dSxRsPgR9ZZtvcN2BbGuGFh5BqTn3iMZGjQp9vW2zu3XLe+xyO6cZZAwkbnPcHm07Oo4KSQICvD4m9lM9Bn0Xk9xhn5kN4x9vwewpqJFHI+gny16d6CVn/O+UxVXr6DU6u9Vc/RDbxhQyFk7beg7fTjRiO/Xmp0bfM18u0Q0pTOcOUE8QwUYLkwwXPTRmdztHdtkcNRApAPE53XfgAb1Vz6yVJQA3Y/MXAnkafdHUtgP0Yda7diWO2OFVqEaSIG5yiEFEVV1P7RcT1rQFnhdY8mvnAkOvvDCk3qrqzAr+9YAZ2Rmxc4kwPyYwT/xy2aqe/xiM6KJZBuF+OPOUVa9/QDXbB3C2DYVlMA11zL2NVdyLXwmc3S12Ov8XpDn6wbhF62JIHSokfuU0WzBvneNxT5rJp+uM2c1+z1iLhvDVi/Mgf6fg99+3wUkzZ3/xkxagvsezOrc0oWfHKL5U7Nj4g9PTwrTohO51jDWOR540mRhU/hZQefdCCHwj97+cdEvOrIES6kVWgWhGfbEYzpvdTSM0rz3drdM46kzTdR90CsNMu4cfo3KfxIKnywxcftJVd8AG3hjhcywI1UGTyc3Tj8qt+k0+DpfotO+/0Wnfqb6HSL2YgUNKWSpva1waKpIddE4vB99WpZFtswKZL0ucS3lWA9OGFQVZ6yXFzSq0oqTJnzGVI1SKmHcvm57ptMKbPo4V/MvvQbPmy/xCmNj3FPevXDxH0cXkvEaNBi8Gy3QYr9g4O2xLQE5j72+2K9VSr093YG+zvOo7XeobVww2w+hG/RBBi7D73IT3QvelHPBcG2bqePdTs9DLvvPqTVPXg2bF0Wu/2PvSwe3LhuSs0dZvVDGM8PZsU2xe2e9utvZkd+Ovft/Roa9eDZbpMLnw0ewIW6QXH+VE5c0Y8fjPfYQynH6xjwHtrxrSrxJzNoE9hfnUn3H0aTHvRbGtpXLQXtq2GTKff378WUzUWXOOssEv/x9es30/6fv5uoo6Ojo1dv32XP302Ojo4K/N3r9dYaUeuoTcug5uojAv29THf8hlV6vR6iMOWWH9LwnVJO/ujGx5vH9Pzr86/k2dl/iMeUNQ6cTz8F6q6/n7fm15PzT5XAKI5USUHSSr5Io8PIBSGHIOAoJtMSjP1apbPo8CbyYWP4pw/KwqE77w3Gcd9EJsmg4PhXMEkx8nsscpwKI59AmyiOKI4Aw8CR66LDSI3eQ2KjGN+4SnREgME5aNzhTejlwmWj2Cvh0WHkuD6KI//SU39iIBOFb7dlOo7mYcHbpqq/LKYy9EcdEY3zYETqR05DQ+dLke8fNVNzhvkCrYvJuNZ8Fi0H2YdQ1PCO6MbVsXb5LFwOwqIrpI6PpG5RHAkLRXOVDUTT6sMxnYDCnVCM0YeOJbLw4oPXxHFlpuRHDfRhIB8z9L0aXXwUO+Jg7/VYQ+t7Use1ri7cZpUjDK6ENGjD3UWUcMwoUq93F6eG/oRlPmmu6d4mVtY82RQ93ghaNRmZwLwsgeseBXF/dH4A5ZPwPKko26E+jls7q0GtdzaYx9H13Zu5ZonqhtB09mUOY+ueklmitAT9pBmf8mg2N9zbm8fR7O7tzT7L7T1D4k3v3t0PFNO/yHf4PWDdPZjHUXY3rN/XWQe/I7B7T+eLOzZyWVJ1HtRIpbOLcG7N7+oYLjPshzkwL+RrnYJuIGKkVA5crmDixdh59RX7Ai2dL2IXwEHB4kKbcJGxKTq2NSSAiScU1xXOKuZ1HRdJznwALz4GPMcPpJ6ZamSwlwzzGTfhCJjVYjIB9HX7HjTYh8MDTzJM6vFhJXwcvHulhiuhKhPAQwc43i45WEq1AqHrhKmWNdbADrnZm3vvNamDX/ByxUwxeH1yfA9ckqnYdQleTj9wu3RzsNcnx5iCI8Ze/euxd6bGREAtb3VhqI6xK8FDmH59ts/cozc4f6dyOWvNt4GeT37pslWAUmHWQhS71EHMD6iTB1cmXuRoIYlUZfGtQfjMA2OhNC08EhQ1Ik9UdR+uvAOTnE0qijG0KLIhH4fCjBYpNEK6JEWyM9JKh6whzxbYExMGF3gKWMFOjfkxW9C44ZyNubGY81dJgZjXFVoV9ZRwXYIWIBNYiwINDnWYvHi3NtHOR3n35qXPzAt7CEI5Qgl0E0PKqpK4hiShzpMKlFve+oqihNIB+mKTYriqelA2k3eBlKCNkmgmKT3hUvzsWJg0ErSyRpDx3HX1RwW6yhEelPA2MOGs/eXv/2jAtVHTXQXMrcDTFIPg7oCQTEnH8KjpayjxBFRtiHA+0P+2fAkgdCQ0Fy7R0wmSuT+PH1PYnKnPRf92V78bmirJ0LCoz1sThzPWeLXSkG1KBiw9/pW4X7gWxjYyfUI87ur58AYQj0kDBlJDUKqR5+WsKeCL90y1NB3lI4l2llh9Da7IAq+sutBQCHm/e6rpjbOqPggqqwpuRcLCVKbXzv1zTz5Brgv2ZQANufFKKP1kg6jidBdKJnAh5AUm+t5DwXtVxw+lfIbMbacAsglbQJK7zhb5WVPKoW7ipHE7URZiE8p9NA/co+062+V2Azbwg7tKKMe3GGHwgHt+RlGjg0MtbNi2MfS5WFP+HXZrS31Gxsag3/+/bEvt9j8fW2qv/xnZUgcIrHfb3n0AbdJv1p4dwQ19+4D3CpyHK1f69p7o3Z3HtdN8HYIX4jCcu/8W5l849+8wCZ3NuHAne3MmbIbQMOz38X9Lh2CoZOHLdrRqefxTFN/fl33HJbCo+HE7vo6uDo6LUhZJRid5Xf7j9lFNZvNfic/ceGS9fw0QiPRf2msUYEz7wlizgC+8Ym9HV5NKQuZCwkUgwcXSo4Ej8946mrxVBdiMlDlU46daYf2LMgfMsLB6xviEC8lwGv2AJAKt72LmD4PsNmzs9fsXgxoJ+6tIeCEprp8qyJyoS5C/7U6by1u3PIJ6XeSLEyUSrhO1R63NNr+7TRpIKi3sLDo8vYmuu7wUXdd+eHo+P0cutJmixyVlCGJus+gw2ll5a6JCPviScXoTkVzUzG+4TDFoYuW05aXYuRr0BtE8Xh6z9nS+pT9U3Q8dYiyfCDm5a9z5AkdvkY6OVC1MLTTQUvwZUAX1hGj2iiOB/JMBR1MDUY/s8WbxQvc8EDm8na17DlsQc/mBK7xvtZ6slm/JNY9QjTeo0/AARG869ZNOtNhQVD+7RFHjIQV/NJ5G8Getnp8u2Ll+Vwiq8IB0yOHeHilbzwaklewe0IW/93R+7pDfcCRSfGzTG+ZCQVpuHf+p7eaIoiW3Qsu2XzbtN5rZG6xsv+SSNVkDss6I22/ZTmuwFe7+Nq4wWAJxtdsnXO31CVcH/Zba4Xe4mGGhPJCGUCsIpAU0lQC86c+RN4UcK2JsT9HXJci36IPDg4cEY0VZhDxRRV3jo9MJQ375+z/qUZ1Obao75yPGkbyuNCvVFPS4ckVDxjlcUwUtHAYFtRl63aTob17kYAw+eUoLE6qXRbmA6PjzrqWEl3wkcoEnq4twplDJxuHsKoZh9AE2faFdauQV5Hgg1xZ9o/oYmyp9OcaSZjHjbIT1f9CnAzLjMnHuI3dKkBsE7Vl0zZVaGCxrpBFq4WBT0mqeWFZwySfkx4hZE1kp5AKPUqbVCL2rRuWV8x9aLnKlXWAbbYgiDwiJz69LbCKNF+VSQ4a8e+WdiCZ2Tlx3APjCWCP0l5cIi0iAfCmVzBXWsEK/e5XnrFTW+cJRsW7CiMOt5tKgNuxgCTSoEeb9e2B89Pc7A0jhl0JeurorXXZa89UPMDLCQjsrc1n+nrTHfCfs99UIqzopI6zSs8XoibBZNaKjvDlJ/cPN9F2ot9Y4qBdzpCoxa0wElZgdTCDdeQsWOcTsHB2/IFXgCfvlb//NXgLXkmVq6rg1qTTks3ZpN0d5h7b6JicPMq+wrJklJpWT8KgRMPhDxu0vf/sfw17BFD1pTqRcNMlSCT7T6Ryyb9aW3AtZZC62H9363NevY7mQlz125CvUudcPZAb8TuM+okLdSWN1KAzkV2AalekgFbZVlw5awPjNtdMccG9HacrKpVQHdLMtwHGeJHql4M6lhIXe1mRHtNIQ2gWKQKZUiswcslTzsV3MH68WyFvzKaROBHTEfpqaJE4Sy7Yab1x0z5KS0T5vNYyBivSZduXAUnh2Og1sydrpzh/O1s6klJYnpOKGS5KXYq0jGguxmdfjt6CvRBKsoA0SvUOdd6I4ykUC3r7199fRd8cv2dVurx/FDdXtHsK98/LFN89fvX2OwOBB6hA26PV7fTLelLEFl42VlmRn+W5rRE5tq11uq11uq11uq11uq11uq11uq11uq10+Kuxuq11uq11uq11uq11uq11uq11uq11uq11uq11uq11uq11uq11uq11uq11uq11uq11uq10+lrNiW+3ysRQR3Fa7/C04cFvtclvtclvtclvtclvtclvtclvtclvt8oOdV9tql9tql9tql9tql9tql9tql9tql/9Pq102MqN2ypwLSm70ObguL/F0uQbmeRxlmLh4eBrd3CDnvdP5fI6ff6ooD+v0PI6uuBYYsUU5j3FI0cNcrEvA7LZvXABa9wTXjx2hKf59KdUTcwzdiCPa+619m7mVx6/fnkRxNPJ1OguVUoo2n2LuFp+69LVGghd9u4lyLicVJYdFbs65K2mStVMSLykl0f/RyDDD1L0FhO1cRbcN/Bc3tXbAzY1Ld5zP6/6uaeMIj9jQG+l3Pp/P/xfm6hYZ","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),l=t(28453),r=t(33617),o=t.n(r),d=t(17543),a=t.n(d),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),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:"eJztPF1zGzeSfwU3tVWJeUOKpCRb0dbVnZJ4E996bZUtX+pO0irgTJMDawaYABhRjIpV+7D/4J7udX9afslVN4DhDD8k2VYS+Y55cMTBV6M/gO5Gd99Elk9MdHganUBR5tyCic7jKAWTaFFaoWR0GJ1kwI6rUS4SFnqxo+MXjOe5mhpWGdCGWcUSDdhkw0zMZtwyA/oKGDdslFdQaiGtYWOl2QQkaG6FnLBUJVUB2DAVNmOlhhTGQkLKjNVVYisNpsd+yEAyXk/PhGGmShIwZlzl+cwvn8bMZg4+DbbS0jDOKil+qoB1OmHwhUg7HcZlyjjrdEra3EWl806nx3C77W+4lPudzxinJcUoBxpf8BkbATMZ15A6+LmcEVJiBpKPctyhzaBAFPlNu6FGTGRj7yNuIGVKEvwB0B77Xk3hCidrfmbCGsjHLOFSKosAFCoVYwEps5lW1SRjNhOGvXvz8o9MWOzHlMwJ1AqXQQqEpR3mhJI1VEJOemfyTJ6I8pC9K3PFUzZTlWbH3/5pMcwqht9OO51vYVRN2LsXnc75l5m1pTnc2eFl2VMlSJwv5yPTS1Sxk2LHMh0/idk0Aw04KwEH3AhEboo4TCdgDW1YskSVM5YopVMhkaliVvIJMFkVI9AmdjRQGphA5tDA01nXqm5lgP3729evcKMFtz12nFcmrpdLhYbEItPg9IjZsKsvHCGe7iHvCTmJWcEvkYTCsp8qkVzitg3IFP/vOY1w1em8rcpSaQsp+8Ft4bDTwZavIVdTxjVQ/0QVhZKs5JoXYEl0UEywWcNPlViwUZ4HXByeyS5y76yEw06HvZCpSLyEAcOvTI19357rikjCrm9LSJAvXNcG6pDRpplIMsLJlDt6ljlPHJgaTAmJFVfQnvg6ZjOc+FuQKkCQKS1+VtLynMhxBdqKhOdNsiGA2NVYrknmSyWkDV/9Cuw/PXmQekQUz1cIWorIKoSkFgPsiucVGA/VNGYZQvUGSg2GxMnPS/KYsgzEJNu4Hk/fV8a2JmaV8YJbQ+HXClQi9AKhbcxzA0yMW7gs+CU0VmOKzlOe99jXM5bCmFe5jZlAjrO6gh57pSzjZZmLhOPpgiKKwsPx/OsSlT07eEAkL4jGx1pdiRTwoEvFeAwahRMbaQo/JkCHfFbSANweSY7N6HRYInSicqVXWYg+t/HIEiUtSNtjR1dc5AS826xhQiZ5lQIb5Ty5jOkOiJnGUxqpMgO8QmLH79QFLwqHc8IPM5AjFyqJ8Evll8ej30OV4oGN53OQJ2wMqKZFhGli1UvtWOHKiIIgYgwKLvKYEBez92rErLA5xCiwJZezmKXcQswsXNuRuo5ZkkFySX9pngrFRpW1SrqNpVqVqZpKj8uxktaIn9dIZGj5cIwOY7YXs6cxO4jZoB+zwTBmg72YDZ7GbHAQs2E/ZsNhzIZ7MRs+dWANDzyueY3gJgCDocOy/Xywi+fuS2FIsvHANPUZPG2dwYMe63RqacJvP/7445m8OZOMnUUoXGfRITuL6i5nUeza8MzEtoH/fY0/dofP/M8Z/nw6PPA/p9R1sOd/ZvhzODiTc7/gmRwSJJYX5S1QYPODQuB/eSbCb7QofgvnGX7EgygODUirFjzYMG/uZRf3IqSwgudm83ZCj0e0owVIK5vaw00Ru27eETU/ou004cEWOiZdEx2rjaYg8ATFcGX3+z1/s2zevFv20ey9Ac6nbf0pbh2PphM8mjbvvz69HhESlmH6NEw865ECQCfzZjz4Do8IC22IPg0HB4gDvJQ2IwBbH9HuG+Bgg7/hXVt/rzvY7w77w70WBtA2ch2Kopum3dls9hDYQ53HL48qT9BQnWaH5utYq2KN+UHWwaKX14no76Cy/wUV9VHQYSFFu48Mi6Cx1BZfU8u2KuWzL4ybKgytlTPsv1DNZg0wqQnhIOs3yZRIPPDYJ6hkIzTweoiDLmFyJ013GpjEj2naLYru0kf82SXENz4WRS9Ne0s9V6jjPhYsTWO2+nnt9zRlRVFs+Oy+tz7vFMXqLnpF4WEj5eurHjlVSGfbLCe+w28lKguJaC98qxih5wA9JNhA5tx6OVq6bDIhfYNnKrbUQcOkyrmGa7RLjVDS9X54GQsittDsyY4lE9B5jggV7MvXXnt/4tkft9CeAL/cPW5lZzjJEUsqY1XBNEzgmpXcWtCSJrviuUidm6lLH+CaFyWaADt/PTtL//kPO+SAQBvfOl9VKiYC/UA7fz096v7X+ZoeVVmCTrgBlgOuZGIGNumx0wzycuGKmk6nvemuSTKlcueHem80jN2/F2r0/oLALXvclE/W7dSxRsPgR9ZZtvcN2BbGuGFh5BqTn3iMZGjQp9vW2zu3XLe+xyO6cZZAwkbnPcHm07Oo4KSQICvD4m9lM9Bn0Xk9xhn5kN4x9vwewpqJFHI+gny16d6CVn/O+UxVXr6DU6u9Vc/RDbxhQyFk7beg7fTjRiO/Xmp0bfM18u0Q0pTOcOUE8QwUYLkwwXPTRmdztHdtkcNRApAPE53XfgAb1Vz6yVJQA3Y/MXAnkafdHUtgP0Yda7diWO2OFVqEaSIG5yiEFEVV1P7RcT1rQFnhdY8mvnAkOvvDCk3qrqzAr+9YAZ2Rmxc4kwPyYwT/xy2aqe/xiM6KJZBuF+OPOUVa9/QDXbB3C2DYVlMA11zL2NVdyLXwmc3S12Ov8XpDn6wbhF62JIHSokfuU0WzBvneNxT5rJp+uM2c1+z1iLhvDVi/Mgf6fg99+3wUkzZ3/xkxagvsezOrc0oWfHKL5U7Nj4g9PTwrTohO51jDWOR540mRhU/hZQefdCCHwj97+cdEvOrIES6kVWgWhGfbEYzpvdTSM0rz3drdM46kzTdR90CsNMu4cfo3KfxIKnywxcftJVd8AG3hjhcywI1UGTyc3Tj8qt+k0+DpfotO+/0Wnfqb6HSL2YgUNKWSpva1waKpIddE4vB99WpZFtswKZL0ucS3lWA9OGFQVZ6yXFzSq0oqTJnzGVI1SKmHcvm57ptMKbPo4V/MvvQbPmy/xCmNj3FPevXDxH0cXkvEaNBi8Gy3QYr9g4O2xLQE5j72+2K9VSr093YG+zvOo7XeobVww2w+hG/RBBi7D73IT3QvelHPBcG2bqePdTs9DLvvPqTVPXg2bF0Wu/2PvSwe3LhuSs0dZvVDGM8PZsU2xe2e9utvZkd+Ovft/Roa9eDZbpMLnw0ewIW6QXH+VE5c0Y8fjPfYQynH6xjwHtrxrSrxJzNoE9hfnUn3H0aTHvRbGtpXLQXtq2GTKff378WUzUWXOOssEv/x9es30/6fv5uoo6Ojo1dv32XP302Ojo4K/N3r9dYaUeuoTcug5uojAv29THf8hlV6vR6iMOWWH9LwnVJO/ujGx5vH9Pzr86/k2dl/iMeUNQ6cTz8F6q6/n7fm15PzT5XAKI5USUHSSr5Io8PIBSGHIOAoJtMSjP1apbPo8CbyYWP4pw/KwqE77w3Gcd9EJsmg4PhXMEkx8nsscpwKI59AmyiOKI4Aw8CR66LDSI3eQ2KjGN+4SnREgME5aNzhTejlwmWj2Cvh0WHkuD6KI//SU39iIBOFb7dlOo7mYcHbpqq/LKYy9EcdEY3zYETqR05DQ+dLke8fNVNzhvkCrYvJuNZ8Fi0H2YdQ1PCO6MbVsXb5LFwOwqIrpI6PpG5RHAkLRXOVDUTT6sMxnYDCnVCM0YeOJbLw4oPXxHFlpuRHDfRhIB8z9L0aXXwUO+Jg7/VYQ+t7Use1ri7cZpUjDK6ENGjD3UWUcMwoUq93F6eG/oRlPmmu6d4mVtY82RQ93ghaNRmZwLwsgeseBXF/dH4A5ZPwPKko26E+jls7q0GtdzaYx9H13Zu5ZonqhtB09mUOY+ueklmitAT9pBmf8mg2N9zbm8fR7O7tzT7L7T1D4k3v3t0PFNO/yHf4PWDdPZjHUXY3rN/XWQe/I7B7T+eLOzZyWVJ1HtRIpbOLcG7N7+oYLjPshzkwL+RrnYJuIGKkVA5crmDixdh59RX7Ai2dL2IXwEHB4kKbcJGxKTq2NSSAiScU1xXOKuZ1HRdJznwALz4GPMcPpJ6ZamSwlwzzGTfhCJjVYjIB9HX7HjTYh8MDTzJM6vFhJXwcvHulhiuhKhPAQwc43i45WEq1AqHrhKmWNdbADrnZm3vvNamDX/ByxUwxeH1yfA9ckqnYdQleTj9wu3RzsNcnx5iCI8Ze/euxd6bGREAtb3VhqI6xK8FDmH59ts/cozc4f6dyOWvNt4GeT37pslWAUmHWQhS71EHMD6iTB1cmXuRoIYlUZfGtQfjMA2OhNC08EhQ1Ik9UdR+uvAOTnE0qijG0KLIhH4fCjBYpNEK6JEWyM9JKh6whzxbYExMGF3gKWMFOjfkxW9C44ZyNubGY81dJgZjXFVoV9ZRwXYIWIBNYiwINDnWYvHi3NtHOR3n35qXPzAt7CEI5Qgl0E0PKqpK4hiShzpMKlFve+oqihNIB+mKTYriqelA2k3eBlKCNkmgmKT3hUvzsWJg0ErSyRpDx3HX1RwW6yhEelPA2MOGs/eXv/2jAtVHTXQXMrcDTFIPg7oCQTEnH8KjpayjxBFRtiHA+0P+2fAkgdCQ0Fy7R0wmSuT+PH1PYnKnPRf92V78bmirJ0LCoz1sThzPWeLXSkG1KBiw9/pW4X7gWxjYyfUI87ur58AYQj0kDBlJDUKqR5+WsKeCL90y1NB3lI4l2llh9Da7IAq+sutBQCHm/e6rpjbOqPggqqwpuRcLCVKbXzv1zTz5Brgv2ZQANufFKKP1kg6jidBdKJnAh5AUm+t5DwXtVxw+lfIbMbacAsglbQJK7zhb5WVPKoW7ipHE7URZiE8p9NA/co+062+V2Azbwg7tKKMe3GGHwgHt+RlGjg0MtbNi2MfS5WFP+HXZrS31Gxsag3/+/bEvt9j8fW2qv/xnZUgcIrHfb3n0AbdJv1p4dwQ19+4D3CpyHK1f69p7o3Z3HtdN8HYIX4jCcu/8W5l849+8wCZ3NuHAne3MmbIbQMOz38X9Lh2CoZOHLdrRqefxTFN/fl33HJbCo+HE7vo6uDo6LUhZJRid5Xf7j9lFNZvNfic/ceGS9fw0QiPRf2msUYEz7wlizgC+8Ym9HV5NKQuZCwkUgwcXSo4Ej8946mrxVBdiMlDlU46daYf2LMgfMsLB6xviEC8lwGv2AJAKt72LmD4PsNmzs9fsXgxoJ+6tIeCEprp8qyJyoS5C/7U6by1u3PIJ6XeSLEyUSrhO1R63NNr+7TRpIKi3sLDo8vYmuu7wUXdd+eHo+P0cutJmixyVlCGJus+gw2ll5a6JCPviScXoTkVzUzG+4TDFoYuW05aXYuRr0BtE8Xh6z9nS+pT9U3Q8dYiyfCDm5a9z5AkdvkY6OVC1MLTTQUvwZUAX1hGj2iiOB/JMBR1MDUY/s8WbxQvc8EDm8na17DlsQc/mBK7xvtZ6slm/JNY9QjTeo0/AARG869ZNOtNhQVD+7RFHjIQV/NJ5G8Getnp8u2Ll+Vwiq8IB0yOHeHilbzwaklewe0IW/93R+7pDfcCRSfGzTG+ZCQVpuHf+p7eaIoiW3Qsu2XzbtN5rZG6xsv+SSNVkDss6I22/ZTmuwFe7+Nq4wWAJxtdsnXO31CVcH/Zba4Xe4mGGhPJCGUCsIpAU0lQC86c+RN4UcK2JsT9HXJci36IPDg4cEY0VZhDxRRV3jo9MJQ375+z/qUZ1Obao75yPGkbyuNCvVFPS4ckVDxjlcUwUtHAYFtRl63aTob17kYAw+eUoLE6qXRbmA6PjzrqWEl3wkcoEnq4twplDJxuHsKoZh9AE2faFdauQV5Hgg1xZ9o/oYmyp9OcaSZjHjbIT1f9CnAzLjMnHuI3dKkBsE7Vl0zZVaGCxrpBFq4WBT0mqeWFZwySfkx4hZE1kp5AKPUqbVCL2rRuWV8x9aLnKlXWAbbYgiDwiJz69LbCKNF+VSQ4a8e+WdiCZ2Tlx3APjCWCP0l5cIi0iAfCmVzBXWsEK/e5XnrFTW+cJRsW7CiMOt5tKgNuxgCTSoEeb9e2B89Pc7A0jhl0JeurorXXZa89UPMDLCQjsrc1n+nrTHfCfs99UIqzopI6zSs8XoibBZNaKjvDlJ/cPN9F2ot9Y4qBdzpCoxa0wElZgdTCDdeQsWOcTsHB2/IFXgCfvlb//NXgLXkmVq6rg1qTTks3ZpN0d5h7b6JicPMq+wrJklJpWT8KgRMPhDxu0vf/sfw17BFD1pTqRcNMlSCT7T6Ryyb9aW3AtZZC62H9363NevY7mQlz125CvUudcPZAb8TuM+okLdSWN1KAzkV2AalekgFbZVlw5awPjNtdMccG9HacrKpVQHdLMtwHGeJHql4M6lhIXe1mRHtNIQ2gWKQKZUiswcslTzsV3MH68WyFvzKaROBHTEfpqaJE4Sy7Yab1x0z5KS0T5vNYyBivSZduXAUnh2Og1sydrpzh/O1s6klJYnpOKGS5KXYq0jGguxmdfjt6CvRBKsoA0SvUOdd6I4ykUC3r7199fRd8cv2dVurx/FDdXtHsK98/LFN89fvX2OwOBB6hA26PV7fTLelLEFl42VlmRn+W5rRE5tq11uq11uq11uq11uq11uq11uq11uq10+Kuxuq11uq11uq11uq11uq11uq11uq11uq11uq11uq11uq11uq11uq11uq11uq11uq11uq10+lrNiW+3ysRQR3Fa7/C04cFvtclvtclvtclvtclvtclvtclvtclvt8oOdV9tql9tql9tql9tql9tql9tql9tql/9Pq102MqN2ypwLSm70ObguL/F0uQbmeRxlmLh4eBrd3CDnvdP5fI6ff6ooD+v0PI6uuBYYsUU5j3FI0cNcrEvA7LZvXABa9wTXjx2hKf59KdUTcwzdiCPa+619m7mVx6/fnkRxNPJ1OguVUoo2n2LuFp+69LVGghd9u4lyLicVJYdFbs65K2mStVMSLykl0f/RyDDD1L0FhO1cRbcN/Bc3tXbAzY1Ld5zP6/6uaeMIj9jQG+l3Pp/P/xfm6hYZ",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,l.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:"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.p,{children:[(0,i.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,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)(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},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",description:"Allowed values - signature, stamp.",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,l.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.c409fe4f.js b/assets/js/23f866da.c409fe4f.js new file mode 100644 index 000000000..2cd2c574e --- /dev/null +++ b/assets/js/23f866da.c409fe4f.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:()=>f,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,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":"eJztO11vHEdyf6UyCCCLmd3lrmhZIRThaMmxmSgWYdIQLiSP7p2p3Wlxpnvc3bMfJhbww/2Dezogebmfpl8SVHXP7MxySUq2cVaS1QO1059V1VXVVdVVN5ETUxsdnkevdFIVqJyNLuMoRZsYWTqpVXQYnWUIFvOJlVMFRyfHMEWFRji0IOD7716Dy4QDVGKco4WJQbRumSPQeKmmoCcgIA3r9+GPuoJEKBC51SBVklcpgubNRA6lwV6KE6kwhblMp+hsDPNMJhm4zK+JhudjKh1oA7gohUqhKrUCYUEhppj24SyTFkqjZzJlQGtocFGikagSWqyQuTDgNK/9/uf/OiUU/6grQ/i+//m/YZLrOUjF/W9KVDxAlGX/Ql2oM1kewvdlrkUKS10ZOHn1rw2itCq1ne/tvcJxNYXvj/f2Lj/LnCvt4WBAa+gSFYGVi7HtJ7oYpDSwTCePCWU0SKt6XIWV+RJE2iKKy1BBosslJFqbVCo6kRhKMUVQVTFGY2MgyhTaIOEgwKBIlz2ne5VF+LfTN9/CRJtCuD6c5JWNm+1SaTBx+dIvT7jXWD2yMBYWnx6AdUaqaQyFuCaySgc/VjK5JrQtqrQm6tHJMdNqb++0KkttHKbw1qNwuLdHPV8i0VgY5PGJLgqtoBRGFOjQWM9d1G3wx0oa5guXgcjzmhaHF6oHe3tuWeLh3h4cq1QmzJ60ILUSC/qxfT+UiERDT0tM5ESGoS3SgVaB64gmc+HPs8xF4sE0aEtMnJxhd+FFDEta+BUqXUOQaSN/0sqJnI9jhsbJROTtYyMAmb2dMI7IWWqpXN0admgkh06PDyXwFYGWErEKqbjHIsxEXqENUM1jyAiq77A0aEnK63WJkCqFDOU0u3M/kb6rrOssDJUlMNtQhL3qU2LyIpNtInKLICcdWhbiGlu7NRqgD18uIcWJqHIXgySOc6bCPnyrHUleLhNSNMS5LNPCVQZ7fMqBHQIgShR8xidrHZDKyQQNCSd18hJhTg0d8ZlXGoQeS47LhAKtNg460bk2t1mIm7t0hEQrx5rvaCZkzsB7ZG2j/sa5SK5jGOcVxmAw9YK7xDzX89jzOw8hBedpzvQhtUxcqBXBr3TYXlqwAapGEdbyRJ2NsqVNpG1TNUjtRNPORIJaxAALIfOYCRfDOz0GJ12OMQlsKdQyhlQ4jMHhwo31IoYkw+R6rBeBXhOtnJU/bZG6uufjqTaK4SCGpzE8i2G4H8NwFMPwIIbh0xiGz2IY7ccwGsUwOohh9NTTdPQs0FM0RGwDMBx5SrpPi4KkP19LyxJKis82unTe0aXDPuztNVJBbT/88MOFurlQABcRCclFdAgXUTPkIop9H+k+6huG7wV9PBl9ET6X9Pl09Cx8znno8CB8ZvQ5Gl6oVdjwQo0YEieK8h4oqPs3hSB8BUahNt6U2mq9RI2kUOK6g86jAw91rNq4PCFcpJJOitzejU494hPCaA3SLaQOCClmybsx4u5PCJ02PNTD6s53sXpsddVCzVCMbmH/eT/cEHcj77f9ZHBvgfPrUH9KqJP6OSP1czf+jYb6hIiwCdOvo8QXfb7IWfveTYcw4BOiQheiX0eDZ0QDunjuJgD1fkLYt8ChjnCL+779g97w895of3TQoQD5OH5AUfTStLdcLn8L6pFdE7Yns6a2NL2FJhzCxOhiixvBVv56VLB7+Hdtev8HGdzj2hbFtPZBG6uk8dza1rLTqVg+sn6pempjgNH4tfm1bIHJXQQHe7FJpmUSgKcxtdk1JketTzToMSUHaTpoUZIa07RXFL2NRvrsMeFbjUXRT9P+xshbp+MbC0jTGG43b21PUyiK4o5m395pHhTFbSz6RRFgY3wv1D+TmATL7G5JCQP+XsKylonuxvcKEsUAtMp5b3bMtkvSxnWTSRU6AlvBxgCD0yoXBhfkYVqplR/920tZLWRr+509Unbm2N/3pIDP3gQb/XEQAEKhuwC1PDzvFma0yBEklXW6AINTXEApnEOjeLGZyGUq2CnrcQMuRFGSoT/408VF+k//OOBQAnnrDugkIJVTSRGdwZ/Oj3r/ebllRFWWaBJhEXKknWwM6JI+nGeYl+ug0nw+78+f2CTTOvcRpXfW4MT/vdLjd1cMbtkXtny8DVPPGi3XnVhn03O36DoUExbqmVucd+YxdmGG+3zfBq/mngs3jPiE7pwNkKjTx0Go+/wiKgSbJMTKuP6tXYbmIrps5nh3HdMH5l5+gLBmMsVcjDG/3fXBgtY052KpqyDfdXiqi2rg6BbdqKOQqolAMDr7catTLDY6fd9qi3x7grSls750avGsTwByaesYTJec7dkhSMWhQwoIE9uOEeoJMG649FdLQQPYh4mB10Th7B7YgsYBD2wChE1M4P4dOgfTJgytUUgli6poIp2TZtWaZEWwPtr0opmVRVPv0D7dWzuIxQM7UFjx7g0u1JAjGbIQ03sMU+7+hLREgGeDv6M40iW9l0itjtPoMKrfUqKYF0XrvtTpMjq8iULMi36GiBJNGryz9A5zE9kkw0LQrxoYermZyByjOPIvIzaKI3aQ6BmHKBUdRnr8DhMXxXR1lyTdaGkNnnd4U4/y8fwoDuZydBj5QH8UR+ECa5oAVaLJKC3TSbSqN7xvqaZlvZTlH83DAq1DIfNfuMy3NHW18XL1i1Z61VqBcSvwTL/U1OfwlVja1rqev6PNBzOaQ/KbhFmQiqWlMGFlvSpKRJ5UOZneuCilWTZ+ANvfDUla8DY7NfAOP1/Vh96C6I6zNvrjDyhBTQTgmMvHzn2ncYz4h9BAlgifryg+Gop3GmGMfLZlptVHzx+OngxHwyfDEa0QHOePXaN+p6Ml3unx1S/i9xRnND/Ea1uzhTFiGcWRdFjYh4/S997eu8uCRxR9xrS+CHvrp5IYOMzZf0ga6vFMeTHFh9n+7K4ntFZU32a6ylOKl6MwfX7J+sWPpF1Jok0Y2/4DcrOKo8XDyCwg0b36fQ4+y3HivBUOiTYKzeO2c//JIDc6OFjF0fJh9Jb/K9H7gg5v/jB2b/lhc/3o+3vA+uTZKo6yh2H9pnl6/R2BPXi6Wt/jUWJQOHRYlLTI1Viny6tab63aA2tLpr6x/NBwKa1oxzxFQ0bPbX21VjU0klIGrjavmrHWOQq1RdF03uME6TrLljPZ5SG6Nc+Q3K+1Qc2r28YTCFa8t5rojQ83AgrSkrFpKryI+nA8WdPS2+KbT4L1WH4SVBoe8X5XtmI1/mgQvolCj9rpDfTivI7q1SDwYKiPwMJc5jnBTRZEH5p/bF02lCQA6hu73vjhq+KlD2TwhmFS93EdgpXah5dCNY+v3UdOuLlpmIC5Y7WCmxs6VTRXdO+vVvG6gfbqNPDV7lsMJihnnVlNE64nNm2tqd6YuiJjyjeE+74NgM8CuqpMWIdsztWq32HIDcAhY9eOaYBpw2eUCXQb68Zk4pP+YOrfInbgAFrk/w3dn5cvvpFbQHk+KF88L1+8pVSaEr3sefJMpEq95M8xz/vw3Dqj1fTFBgmeD0L79qM0OJM4Z8HlU12vsknbZqF+gIlyxVqHJy0kpkqkyDmCZ3SCdb4SnZvChQPrsLQULZDOJ6VxJgRb/mJqEDl5jGARlePUIXYC6w2fC8gMTv7l0QZNH73g1DTKGns+EC/C6GMfUMjEDEGoJTDiHFfRxgdGJpVhNZnkwshJ8DhjKHOkaCM5pCLxgQ5P0RqOs0yoaxs/H5sXZyiKJjnu/Z//RiNYDDgj8ExX5gN0Osc/ev5svfvtdZ5fBARMK34HcUSnWj1xIHSdriOVdabyIQlIK1NnKNWpf3we1vZDQlIPUml9zkaG7fVjQGX9dAETYR2aGCollUNjqpI453Y2YYeVeYMV+fc+lY7O6GFd0M2LocxKnwXYSnys74F6YQyJj8HVbHKy6iTETdS3XrxBTh4GkC5JzpwK0agSjdWKeEmbqVCBVb3hry05bpnI/VAvr5JekQgeun/7W52s93/+WwuuO73P24D5HUSaUpj+AQg5BkXBJsuRKINlvgSnuxDRemj+sGlrEXQFmileJeSVsczgh3M4Gy+BtW3l88tcnfrIZ0jHuV6ZaBZ0f/MKOJGUe9TONu3DN3qOM2LUILqkYP3amnJdGeI09hu1Vk+EomwnNonIKiGOal7+CiHVeguKy9WSExQLvTT4vTilj/aI78OlZt/mWVNwam7YmTGisBSIXHPmlGtl/aZdSI45TStjubcUjaUwqN+gzo/Uc4Xm/c9/pTxg5MS/BG1jy23tZXOMM5M5B6y9am2a1QmNfTa/HjSHvcW8DtgFI40SSLWy3qcf7e/Tf11+qTOywZvjKdgqIRmeVHm+/Ico/vBo4f0BBd+83Ui/L0KQvZOjnxbJbHRCEnGHgrt3geDQVCannGSiXK85Yha0Fm2lyqXCq5psV6P9/ash0XYVRwfbyHeqC/TsMScizunaboTDmSWIKXE3mdfmN6QmGqPN/f7Ox0F2HxEOOkT4/DYRjhW/3XDW/pm+RvX3xbS9vfPbE6iLgnnF3zmR9IO4P+og2273SFpMKiPdMjo8v4kWPVHKnu8/PL9cXZJedpmmGHupLUMsXBYdRoNWyN2imVGcnFZgpm340AqV0tPKLedalHIwG/aH0SrenLPVGb9nPFa9j51inZhKNX1o3uWaOqd0gv6QOjRahxxL+e9IMcdwBO1RcSSJczIUKTnxFPK0Wn23fqj4qj7e+glh26tASyluxPnrMH8ncr95V26JxW8PxQ8/bwfBfZibI9dN4HpbLLpBvI4uN8HlVry4FS5eR4A7AWCO6bZCuudrWWiip3XwdMhRx9HBAYfnvhhyHOvJMw4RHTxdXXaiJVHUjYjwe9OmX//r3NSul7pzvf4PuV5dz8vnBmx4IjWDNZZ/x/zetL7vtIS3GsLBwJFqolnlBFlpqqfoMmCVdStqi3miiyaDfm+vhVgza2+vUSX+cMgWfFMZKPUczaTyKfmTHBeSPDuahgX3rSOEKIocrc2XQC7dlE1PzsEReeMwJaIUY5lLuu1omA5ssr4wbR/ermOMj4xPSZphTpckcZAuBDtkjTM21+aaCsqoLgvGVEFDngqqTKjEO0Vef8fEIlT1RQ5naaSlwiBDUEsPm1bOEG8UQokpc23c5gJIMSchtmD0mJ7yrc4rz3tOyFwb/wrJCBEnWibiV4uSujj0TJrPYEbHPQuusaVChRTBq+ZQWjamSFVJsEgynp2GSuWaqsDIS6nyHEpNtgZJpZ50YKTpzghlyUQMD5/hDBqCBa8VbSiB+N4infBrqa59xUMPzhu+eotjKx12s6E2WfZxd87X0n1TjakuSlvptFmuZ0+ly6oxX7LtRZoPv9LXoRQSWlfoeo1UJ3ZLrF4ndkCJW4NTdMQhdnB0cszm2WN4//Nf4DUKoyDTc8+tSWUwXzZVl76mj0/ek62xrjguQqqLKJ545gsat6bg20w49nm+Ra5r9CLlUzpOqnEuEzirg857e4fwkn2PViC6k72RCWKlmRQgoPSzc6mu+3Ckluxer/UvtfO8Dhqs8+vj9qWFKWgV0sv8nv01RNReWMxnaFuOKxWCEkdnRldTv1sbmICcwQl5caH2kHA7SlN2/eS6kpAr6dbg4MQXgOHSh+nZ0T7ZmMI9TT1O7aE3EVpUKRfz2UNIjZi49frxmtHZxWPtf6uprlaqyRGHZZoj8ZIYMG5a+/w0sGH+dfUte720IaO9PpdSBnY6r9kSummGH8/W/vGdLzR2HcK9Ikq5NbxCpYz2zeQUzUwmtat4h0QPePAgiqNcJqgstlyLo69PXsPsSX8/iltG9QcI9+D18cuvvj39ioAhReoJNuzv9/f5PVxbVwjV2ukU8wmcegtxIwelcbd2hdS7QupdIfWukHpXSL0rpN4VUu8KqXeF1LtC6l0h9a6QeldI/buVde0KqXeF1LtC6l0h9a6QeldIvSuk3hVS7wqpd4XUu0Lq311L3FlIHdJrSGEOylxI1Uo99Lle5+vy6ss4yigN7PA8urmhYPv3lK1BzT9WaCiH7DKOZsJICjdxBllcpz1RKs81UmLMSx89653RzrFXVvxytZE4R3lbfsZRkmDp7h3bzlQ7eXN6FsVRXS1S6JTmGDGn8nAx97kagY6c4yS4AC4XalpxZlHk16RMLXr77aZ5XXOaV/jRSlCitKY1hN38L48G/SWktk64ufEpZJxI5Mf7rjtnBMLWo+nkLler1f8AqynNMQ==","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),l=t(33617),o=t.n(l),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),m=t.n(h),g=(t(18766),t(79329),t(9303));const u={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:"eJztO11vHEdyf6UyCCCLmd3lrmhZIRThaMmxmSgWYdIQLiSP7p2p3Wlxpnvc3bMfJhbww/2Dezogebmfpl8SVHXP7MxySUq2cVaS1QO1059V1VXVVdVVN5ETUxsdnkevdFIVqJyNLuMoRZsYWTqpVXQYnWUIFvOJlVMFRyfHMEWFRji0IOD7716Dy4QDVGKco4WJQbRumSPQeKmmoCcgIA3r9+GPuoJEKBC51SBVklcpgubNRA6lwV6KE6kwhblMp+hsDPNMJhm4zK+JhudjKh1oA7gohUqhKrUCYUEhppj24SyTFkqjZzJlQGtocFGikagSWqyQuTDgNK/9/uf/OiUU/6grQ/i+//m/YZLrOUjF/W9KVDxAlGX/Ql2oM1kewvdlrkUKS10ZOHn1rw2itCq1ne/tvcJxNYXvj/f2Lj/LnCvt4WBAa+gSFYGVi7HtJ7oYpDSwTCePCWU0SKt6XIWV+RJE2iKKy1BBosslJFqbVCo6kRhKMUVQVTFGY2MgyhTaIOEgwKBIlz2ne5VF+LfTN9/CRJtCuD6c5JWNm+1SaTBx+dIvT7jXWD2yMBYWnx6AdUaqaQyFuCaySgc/VjK5JrQtqrQm6tHJMdNqb++0KkttHKbw1qNwuLdHPV8i0VgY5PGJLgqtoBRGFOjQWM9d1G3wx0oa5guXgcjzmhaHF6oHe3tuWeLh3h4cq1QmzJ60ILUSC/qxfT+UiERDT0tM5ESGoS3SgVaB64gmc+HPs8xF4sE0aEtMnJxhd+FFDEta+BUqXUOQaSN/0sqJnI9jhsbJROTtYyMAmb2dMI7IWWqpXN0admgkh06PDyXwFYGWErEKqbjHIsxEXqENUM1jyAiq77A0aEnK63WJkCqFDOU0u3M/kb6rrOssDJUlMNtQhL3qU2LyIpNtInKLICcdWhbiGlu7NRqgD18uIcWJqHIXgySOc6bCPnyrHUleLhNSNMS5LNPCVQZ7fMqBHQIgShR8xidrHZDKyQQNCSd18hJhTg0d8ZlXGoQeS47LhAKtNg460bk2t1mIm7t0hEQrx5rvaCZkzsB7ZG2j/sa5SK5jGOcVxmAw9YK7xDzX89jzOw8hBedpzvQhtUxcqBXBr3TYXlqwAapGEdbyRJ2NsqVNpG1TNUjtRNPORIJaxAALIfOYCRfDOz0GJ12OMQlsKdQyhlQ4jMHhwo31IoYkw+R6rBeBXhOtnJU/bZG6uufjqTaK4SCGpzE8i2G4H8NwFMPwIIbh0xiGz2IY7ccwGsUwOohh9NTTdPQs0FM0RGwDMBx5SrpPi4KkP19LyxJKis82unTe0aXDPuztNVJBbT/88MOFurlQABcRCclFdAgXUTPkIop9H+k+6huG7wV9PBl9ET6X9Pl09Cx8znno8CB8ZvQ5Gl6oVdjwQo0YEieK8h4oqPs3hSB8BUahNt6U2mq9RI2kUOK6g86jAw91rNq4PCFcpJJOitzejU494hPCaA3SLaQOCClmybsx4u5PCJ02PNTD6s53sXpsddVCzVCMbmH/eT/cEHcj77f9ZHBvgfPrUH9KqJP6OSP1czf+jYb6hIiwCdOvo8QXfb7IWfveTYcw4BOiQheiX0eDZ0QDunjuJgD1fkLYt8ChjnCL+779g97w895of3TQoQD5OH5AUfTStLdcLn8L6pFdE7Yns6a2NL2FJhzCxOhiixvBVv56VLB7+Hdtev8HGdzj2hbFtPZBG6uk8dza1rLTqVg+sn6pempjgNH4tfm1bIHJXQQHe7FJpmUSgKcxtdk1JketTzToMSUHaTpoUZIa07RXFL2NRvrsMeFbjUXRT9P+xshbp+MbC0jTGG43b21PUyiK4o5m395pHhTFbSz6RRFgY3wv1D+TmATL7G5JCQP+XsKylonuxvcKEsUAtMp5b3bMtkvSxnWTSRU6AlvBxgCD0yoXBhfkYVqplR/920tZLWRr+509Unbm2N/3pIDP3gQb/XEQAEKhuwC1PDzvFma0yBEklXW6AINTXEApnEOjeLGZyGUq2CnrcQMuRFGSoT/408VF+k//OOBQAnnrDugkIJVTSRGdwZ/Oj3r/ebllRFWWaBJhEXKknWwM6JI+nGeYl+ug0nw+78+f2CTTOvcRpXfW4MT/vdLjd1cMbtkXtny8DVPPGi3XnVhn03O36DoUExbqmVucd+YxdmGG+3zfBq/mngs3jPiE7pwNkKjTx0Go+/wiKgSbJMTKuP6tXYbmIrps5nh3HdMH5l5+gLBmMsVcjDG/3fXBgtY052KpqyDfdXiqi2rg6BbdqKOQqolAMDr7catTLDY6fd9qi3x7grSls750avGsTwByaesYTJec7dkhSMWhQwoIE9uOEeoJMG649FdLQQPYh4mB10Th7B7YgsYBD2wChE1M4P4dOgfTJgytUUgli6poIp2TZtWaZEWwPtr0opmVRVPv0D7dWzuIxQM7UFjx7g0u1JAjGbIQ03sMU+7+hLREgGeDv6M40iW9l0itjtPoMKrfUqKYF0XrvtTpMjq8iULMi36GiBJNGryz9A5zE9kkw0LQrxoYermZyByjOPIvIzaKI3aQ6BmHKBUdRnr8DhMXxXR1lyTdaGkNnnd4U4/y8fwoDuZydBj5QH8UR+ECa5oAVaLJKC3TSbSqN7xvqaZlvZTlH83DAq1DIfNfuMy3NHW18XL1i1Z61VqBcSvwTL/U1OfwlVja1rqev6PNBzOaQ/KbhFmQiqWlMGFlvSpKRJ5UOZneuCilWTZ+ANvfDUla8DY7NfAOP1/Vh96C6I6zNvrjDyhBTQTgmMvHzn2ncYz4h9BAlgifryg+Gop3GmGMfLZlptVHzx+OngxHwyfDEa0QHOePXaN+p6Ml3unx1S/i9xRnND/Ea1uzhTFiGcWRdFjYh4/S997eu8uCRxR9xrS+CHvrp5IYOMzZf0ga6vFMeTHFh9n+7K4ntFZU32a6ylOKl6MwfX7J+sWPpF1Jok0Y2/4DcrOKo8XDyCwg0b36fQ4+y3HivBUOiTYKzeO2c//JIDc6OFjF0fJh9Jb/K9H7gg5v/jB2b/lhc/3o+3vA+uTZKo6yh2H9pnl6/R2BPXi6Wt/jUWJQOHRYlLTI1Viny6tab63aA2tLpr6x/NBwKa1oxzxFQ0bPbX21VjU0klIGrjavmrHWOQq1RdF03uME6TrLljPZ5SG6Nc+Q3K+1Qc2r28YTCFa8t5rojQ83AgrSkrFpKryI+nA8WdPS2+KbT4L1WH4SVBoe8X5XtmI1/mgQvolCj9rpDfTivI7q1SDwYKiPwMJc5jnBTRZEH5p/bF02lCQA6hu73vjhq+KlD2TwhmFS93EdgpXah5dCNY+v3UdOuLlpmIC5Y7WCmxs6VTRXdO+vVvG6gfbqNPDV7lsMJihnnVlNE64nNm2tqd6YuiJjyjeE+74NgM8CuqpMWIdsztWq32HIDcAhY9eOaYBpw2eUCXQb68Zk4pP+YOrfInbgAFrk/w3dn5cvvpFbQHk+KF88L1+8pVSaEr3sefJMpEq95M8xz/vw3Dqj1fTFBgmeD0L79qM0OJM4Z8HlU12vsknbZqF+gIlyxVqHJy0kpkqkyDmCZ3SCdb4SnZvChQPrsLQULZDOJ6VxJgRb/mJqEDl5jGARlePUIXYC6w2fC8gMTv7l0QZNH73g1DTKGns+EC/C6GMfUMjEDEGoJTDiHFfRxgdGJpVhNZnkwshJ8DhjKHOkaCM5pCLxgQ5P0RqOs0yoaxs/H5sXZyiKJjnu/Z//RiNYDDgj8ExX5gN0Osc/ev5svfvtdZ5fBARMK34HcUSnWj1xIHSdriOVdabyIQlIK1NnKNWpf3we1vZDQlIPUml9zkaG7fVjQGX9dAETYR2aGCollUNjqpI453Y2YYeVeYMV+fc+lY7O6GFd0M2LocxKnwXYSnys74F6YQyJj8HVbHKy6iTETdS3XrxBTh4GkC5JzpwK0agSjdWKeEmbqVCBVb3hry05bpnI/VAvr5JekQgeun/7W52s93/+WwuuO73P24D5HUSaUpj+AQg5BkXBJsuRKINlvgSnuxDRemj+sGlrEXQFmileJeSVsczgh3M4Gy+BtW3l88tcnfrIZ0jHuV6ZaBZ0f/MKOJGUe9TONu3DN3qOM2LUILqkYP3amnJdGeI09hu1Vk+EomwnNonIKiGOal7+CiHVeguKy9WSExQLvTT4vTilj/aI78OlZt/mWVNwam7YmTGisBSIXHPmlGtl/aZdSI45TStjubcUjaUwqN+gzo/Uc4Xm/c9/pTxg5MS/BG1jy23tZXOMM5M5B6y9am2a1QmNfTa/HjSHvcW8DtgFI40SSLWy3qcf7e/Tf11+qTOywZvjKdgqIRmeVHm+/Ico/vBo4f0BBd+83Ui/L0KQvZOjnxbJbHRCEnGHgrt3geDQVCannGSiXK85Yha0Fm2lyqXCq5psV6P9/ash0XYVRwfbyHeqC/TsMScizunaboTDmSWIKXE3mdfmN6QmGqPN/f7Ox0F2HxEOOkT4/DYRjhW/3XDW/pm+RvX3xbS9vfPbE6iLgnnF3zmR9IO4P+og2273SFpMKiPdMjo8v4kWPVHKnu8/PL9cXZJedpmmGHupLUMsXBYdRoNWyN2imVGcnFZgpm340AqV0tPKLedalHIwG/aH0SrenLPVGb9nPFa9j51inZhKNX1o3uWaOqd0gv6QOjRahxxL+e9IMcdwBO1RcSSJczIUKTnxFPK0Wn23fqj4qj7e+glh26tASyluxPnrMH8ncr95V26JxW8PxQ8/bwfBfZibI9dN4HpbLLpBvI4uN8HlVry4FS5eR4A7AWCO6bZCuudrWWiip3XwdMhRx9HBAYfnvhhyHOvJMw4RHTxdXXaiJVHUjYjwe9OmX//r3NSul7pzvf4PuV5dz8vnBmx4IjWDNZZ/x/zetL7vtIS3GsLBwJFqolnlBFlpqqfoMmCVdStqi3miiyaDfm+vhVgza2+vUSX+cMgWfFMZKPUczaTyKfmTHBeSPDuahgX3rSOEKIocrc2XQC7dlE1PzsEReeMwJaIUY5lLuu1omA5ssr4wbR/ermOMj4xPSZphTpckcZAuBDtkjTM21+aaCsqoLgvGVEFDngqqTKjEO0Vef8fEIlT1RQ5naaSlwiBDUEsPm1bOEG8UQokpc23c5gJIMSchtmD0mJ7yrc4rz3tOyFwb/wrJCBEnWibiV4uSujj0TJrPYEbHPQuusaVChRTBq+ZQWjamSFVJsEgynp2GSuWaqsDIS6nyHEpNtgZJpZ50YKTpzghlyUQMD5/hDBqCBa8VbSiB+N4infBrqa59xUMPzhu+eotjKx12s6E2WfZxd87X0n1TjakuSlvptFmuZ0+ly6oxX7LtRZoPv9LXoRQSWlfoeo1UJ3ZLrF4ndkCJW4NTdMQhdnB0cszm2WN4//Nf4DUKoyDTc8+tSWUwXzZVl76mj0/ek62xrjguQqqLKJ545gsat6bg20w49nm+Ra5r9CLlUzpOqnEuEzirg857e4fwkn2PViC6k72RCWKlmRQgoPSzc6mu+3Ckluxer/UvtfO8Dhqs8+vj9qWFKWgV0sv8nv01RNReWMxnaFuOKxWCEkdnRldTv1sbmICcwQl5caH2kHA7SlN2/eS6kpAr6dbg4MQXgOHSh+nZ0T7ZmMI9TT1O7aE3EVpUKRfz2UNIjZi49frxmtHZxWPtf6uprlaqyRGHZZoj8ZIYMG5a+/w0sGH+dfUte720IaO9PpdSBnY6r9kSummGH8/W/vGdLzR2HcK9Ikq5NbxCpYz2zeQUzUwmtat4h0QPePAgiqNcJqgstlyLo69PXsPsSX8/iltG9QcI9+D18cuvvj39ioAhReoJNuzv9/f5PVxbVwjV2ukU8wmcegtxIwelcbd2hdS7QupdIfWukHpXSL0rpN4VUu8KqXeF1LtC6l0h9a6QeldI/buVde0KqXeF1LtC6l0h9a6QeldIvSuk3hVS7wqpd4XUu0Lq311L3FlIHdJrSGEOylxI1Uo99Lle5+vy6ss4yigN7PA8urmhYPv3lK1BzT9WaCiH7DKOZsJICjdxBllcpz1RKs81UmLMSx89653RzrFXVvxytZE4R3lbfsZRkmDp7h3bzlQ7eXN6FsVRXS1S6JTmGDGn8nAx97kagY6c4yS4AC4XalpxZlHk16RMLXr77aZ5XXOaV/jRSlCitKY1hN38L48G/SWktk64ufEpZJxI5Mf7rjtnBMLWo+nkLler1f8AqynNMQ==",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,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)(g.default,{as:"h1",className:"openapi__heading",children:"Self Sign"}),"\n",(0,s.jsx)(o(),{method:"post",path:"/selfsign",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"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.jsx)(g.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 final PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\nfalse - If you choose not to merge, the completion certificate will be provided as a separate 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"}},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/23f866da.e170b9c6.js b/assets/js/23f866da.e170b9c6.js deleted file mode 100644 index 361ce1a88..000000000 --- a/assets/js/23f866da.e170b9c6.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:()=>y,contentTitle:()=>x,default:()=>b,frontMatter:()=>m,metadata:()=>i,toc:()=>f});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":"eJztO11vG0lyf6UyCOC1MiRFWvY6gmOc1t7sOnFsYSXDuEg6bXOmyGlppnu2u0ckVyCwD/cP7umA5OV+mn9JUNU9wxmKkuz14tZJ6AeZ059V1VXVVdVV15ETUxvtn0QvdVIVqJyNzuIoRZsYWTqpVbQfHWcIFvOJlVMFB4evYIoKjXBoQcC7H16Dy4QDVGKco4WJQbRukSPQeKmmoCcgIA3r9+GPuoJEKBC51SBVklcpgubNRA6lwV6KE6kwhZlMp+hsDLNMJhm4zK+JhudjKh1oAzgvhUqhKrUCYUEhppj24TiTFkqjr2TKgNbQ4LxEI1EltFghc2HAaV77wy//dUQo/lFXhvD98Mt/wyTXM5CK+9+WqHiAKMv+qTpVx7Lch3dlrkUKC10ZOHz5rw2itCq1nezsvMRxNYV3r3Z2zr7KnCvt/mBAa+gSFYGVi7HtJ7oYpDSwTCcPCWU0SKt6XIWV+QJE2iKKy1BBossFJFqbVCo6kRhKMUVQVTFGY2MgyhTaIOEgwKBIFz2ne5VF+Lejt29gok0hXB8O88rGzXapNJi4fOGXJ9xrrB5YGAuLT/bAOiPVNIZCXBJZpYOfKplcEtoWVVoT9eDwFdNqZ+eoKkttHKbw3qOwv7NDPd8g0VgY5PGJLgqtoBRGFOjQWM9d1G3wp0oa5guXgcjzmhb7p6oHOztuUeL+zg68UqlMmD1pQWolFvRj+34oEYmGHpWYyIkMQ1ukA60C1xFNZsKfZ5mLxINp0JaYOHmF3YXnMSxo4ZeodA1Bpo38WSsncj6OKzROJiJvHxsByOzthHFEzlJL5erWsEMjOXR6fCiBrwi0lIhVSMU9FuFK5BXaANUshoyg+gFLg5akvF6XCKlSyFBOs1v3E+lFZV1nYagsgdmGIuxVnxKTF5lsE5FbBDnp0LIQl9jardEAffhmASlORJW7GCRxnDMV9uGNdiR5uUxI0RDnskwLVxns8SkHdgiAKFHwGR+udEAqJxM0JJzUyUuEOTV0xGdeaRB6LDkuEwq0WjvoROfa3GQhbu7SERKtHGu+gyshcwbeI2sb9TfORXIZwzivMAaDqRfcBea5nsWe33kIKThPc6YPqWXiQq0IfqXD9tKCDVA1irCWJ+pslC1tIm2bqkFqJ5p2JhLUIgZYCJnHTLgYLvQYnHQ5xiSwpVCLGFLhMAaHczfW8xiSDJPLsZ4Hek20clb+vEHq6p5Pp9oohr0YnsTwNIbhbgzDUQzDvRiGT2IYPo1htBvDaBTDaC+G0RNP09HTQE/RELENwHDkKem+LAqS/nwtLUsoKT7b6NJZR5cO+7Cz00gFtf3444+n6vpUAZxGJCSn0T6cRs2Q0yj2faT7qG8Yvuf08Wj0dfhc0OeT0dPwOeOhw73wmdHnaHiqlmHDUzViSJwoyjugoO7fFILwFRiF2nhTaqv1EjWSQonrDjqPDjzUsWzj8ohwkUo6KXJ7Ozr1iC8IoxVIN5DaI6SYJW/HiLu/IHTa8FAPqzvfxeqx1VULNUMxuoH94364IW5H3m/7xeDeAufzUH9CqJP6OSb1czv+jYb6goiwDtPnUeLrPl/krH1vp0MY8AVRoQvR59HgKdGALp7bCUC9XxD2LXCoI9zivm93rzd83BvtjvY6FCAfxw8oil6a9haLxW9BPbJrwvZk1tSWprfQhEOYGF1scCPYyl+NCnYP/65N7/8gg3tc26KY1j5oY5U0nlvbWnY6FYsH1i9VT20MMBq/Mr8WLTC5i+BgLzbJtEwC8DSmNrvG5Kj1iQY9puQgTQctSlJjmvaKorfWSJ89JnyrsSj6adpfG3njdHxjAWkaw83mje1pCkVR3NLs2zvNg6K4iUW/KAJsjO+p+mcSk2CZ3S4pYcDfS1hWMtHd+E5BohiAVjnvzY7ZZklau24yqUJHYCtYG2BwWuXC4Jw8TCu18qN/eymrhWxlv7NHys4c+/ueFPDV22CjPwwCQCh0F6CW++fdwIwWOYCksk4XYHCKcyiFc2gUL3YlcpkKdsp63IBzUZRk6A/+dHqa/tM/DjiUQN66AzoJSOVUUkRn8KeTg95/nm0YUZUlmkRYhBxpJxsDuqQPJxnm5SqoNJvN+rNHNsm0zn1E6cIanPi/53p8cc7gln1hy4ebMPWs0XLdiXXWPXeLrkMxYaGeucF5Zx5jF2a4y/dt8GruuHDDiC/ozlkDiTp9HIS6T06jQrBJQqyMq9/aZWhOo7NmjnfXMb1n7tlHCGsmU8zFGPObXR8taE1zLha6CvJdh6e6qAaObtGNOgqpmggEo7MbtzrFfK3T9y03yLcnSFs660unFs/6BCCXto7BdMnZnh2CVBw6pIAwse0YoZ4A44ZLP1sKGsA+Tgy8Jgpnd88WNA54YBMgbGICd+/QOZg2YWiNQipZVEUT6Zw0q9YkK4L10aYXzawsmnqH9une2EHM79mBwoq3b3CqhhzJkIWY3mGYcvcXpCUCPGv8HcWRLum9RGr1Ko32o/otJYp5UbTuG50uov3rKMS86GeIKNGkwYWld5jryCYZFoJ+1cDQy81E5hjFkX8ZsVEcsYNEzzhEqWg/0uMLTFwU09VdknSjpTV43v51PcrH86M4mMvRfuQD/VEchQusaQJUiSajtEwn0bLe8K6lmpbVUpZ/NA8LtA6FzH/lMm9o6nLt5epXrfSytQLjVuCxfqGpz+FLsbCtdT1/R+sPZjSH5DcJsyAVC0thwsp6VZSIPKlyMr1xXkqzaPwAtr8bkrTgbXZq4B0+XtaH3oLolrM2+tMPKEFNBOCYy6fOvdA4RvxDaCBLhM9XFJ8MxYVGGCOfbZlp9cnzh6NHw9Hw0XBEKwTH+VPXqN/paIkLPT7/Vfye4hXND/Ha1mxhjFhEcSQdFvb+o/S9N/fusuABRZ8xrS/C3uqpJAYOc/bvk4Z6PFNeTPF+tj++7QmtFdW3ma7ylOLlKEyfX7J+9SNpV5JoE8a2f4/cLONofj8yc0h0r36fg69ynDhvhUOijULzsO3cfzHIjfb2lnG0uB+9xf9K9L6mw5vdj917fthcPfr+HrA+erqMo+x+WL9vnl5/R2D3nixX93iUGBQOHRYlLXI+1univNZby/bA2pKpbyw/NFxKS9oxT9GQ0XNTX61UDY2klIHz9atmrHWOQm1QNJ33OEG6zrLlTHZ5iG7NMiT3a2VQ8+q28QSCFe+tJnrjw7WAgrRkbJoKT6M+vJqsaOlt8fUnwXosPwkqDQ94v3NbsRp/MAjfRKEH7fQGenFeRfVqEHgw1EdgYSbznOAmC6IPzT+2LhtKEgD1jV1vfP9V8cIHMnjDMKn7uA7BSu3DC6Gax9fuIydcXzdMwNyxXML1NZ0qmnO695fLeNVAe3Ua+Gr3LQYTlFedWU0TriY2ba2p3pg6J2PKN4T7vg2AzwI6r0xYh2zO5bLfYcg1wCFj145pgGnDZ5QJdBPrxmTik/5o6t8gduAAWuT/Dd2flc+/lxtAeTYonz8rn7+nVJoSvex58kykSr3kzzDP+/DMOqPV9PkaCZ4NQvvmozR4JXHGgsunulplnbbNQv0AE+WKtQ5PWkhMlUiRcwTP6ATrfCU6N4VzB9ZhaSlaIJ1PSuNMCLb8xdQgcvIYwSIqx6lD7ATWGz4TkBmc/MuDNZo+eM6paZQ19mwgnofRr3xAIRNXCEItgBHnuIo2PjAyqQyrySQXRk6CxxlDmSNFG8khFYkPdHiK1nAcZ0Jd2vjZ2Dw/RlE0yXEf/vw3GsFiwBmBx7oyH6HTOf7R82fr3W+v8/wiIGBa8TuIIzrV6okDoat0HamsM5UPSUBamTpDqU794/Owth8SknqQSutzNjJsrx8DKuunC5gI69DEUCmpHBpTlcQ5N7MJO6zMGyzJv/epdHRG9+uCbl4MZVb6LMBW4mN9D9QLY0h8DK5mk5NVJyGuo77x4g1ycj+AdEly5lSIRpVorFbES9pMhQqs6g1/bclxy0Tuh3p5lfSKRPDQ/dvf6GR9+PPfWnDd6n3eBMzvINKUwvT3QMgxKAo2WY5EGSzzBTjdhYjWQ/OHdVsrutcC8kbSKkYT7mXKGdTKejdutLtL/3XRqJNwwVtgKdgqoWObVHm++Ico/vgA0d0+pG/ebJfd5RRmF3L08zy5Gh3SEd3C03cuEGzYyuSUhkqU6zWZweu0lSqXCs9rsp2PdnfPh0TbZRztbSLfkS7QZZxzRUSckaZuVJkzCxBTIRWQRWV+Q2qiMdrcbeJ+GmR3EWGvQ4THN4nwSnG4nhO1j/Ulqr8vpu3tnd+eQJ0XzCtezUTSD+L+qINsu90jaTGpjHSLaP/kOpr3RCl7vn//5Gx5FkdEWE1h1VJbhli4LNqPBq0oq0VzRaFRWoGZtuFDK1RK0fQb/pQo5eBq2B9Gy3h9zkb/647xWPU+dYp1YirV9L55ZyvqHNEJ+kPq0GgVZSrlvyOFmcIRtEfFkSTOyVCk5LdRlMtq9cMqNv1tfbx11HhTILilFNdCu3VktxOsXVfhG8Kvm6Ovw8ftuKePbHKwsolVbgo/NojXAcUmntgKEbYihKugXyfmx2G8VhTvZCULTcCsjpcNOdA02tvjiMzXQw5dPHrKUYG9J8uzjoMcRV0nmJ8Y1l25z/NMuo7J1tr+P2Rtd41t/xy8ZnzWDNYYex2La93gut34IWUx0axZgkg0dTGk81kz3YjHYZ7oosmN3tlpwd/M2tlpNIY/A3oHfFsZKPUMzaTyydaTHOeSbHaahgX3rWI/KIocrc0XQMb6lIqUfHaFyBtTOBGlGMtc0qVGw3TghtW9aPvwfhU9emB8sskV5nQXEqPoQrCp3ZjZM20uqVSIKm5gTLURZIOiyoRKvLnr1XRMnED1PORKlEZaKvkwBLX0sGnlDLFAIZSYMnPG7cOGFHOSVQtGj+mR1uq88izmhMy18e9LjBAxnGUifjsvqYuDiqTgDGZ0qlfB6bGUgp4ieA0ciobGFIMoCRaZIEfNKpVrqu+h+EOV51BqMilI+PSkAyNNd0YoS5ZgeNIKZ9AQLPgjaENy+zuLdMKvpbr0uew9OGn46j2OrXTYzXNZ58yH3TnfSfd9NaaKF22l02axmj2VLqvGfJe2F2k+/ErfhSI3aN2UqzVSndgNUVid2AGl5AyO0BGH2MHB4Su2wh7Ch1/+Aq9RGAWZnnluTSqD+aKpp/PVWnzynmyNEcUeL2koonjimS8o1pqC7zPhPvzyVwtvkCvWvEj5x/rDapzLBI7rcOLOzj68YBejFWLsvMtngljpSgoQUPrZuVSXfThQC3acVmqW2nleBw1W7fVx+6KxFLQKiUN+z/4KImovLOZXyB4ZFWCMkUv8iKMzo6up360NTEDO4IS84lBVRrgdpCkVEnJzXeBDNVIrcHDiS3tw4QOwXGlyuDaFe5pKi5CBuYq9oUq5TMvuQ2rExK3Wj1eMzp4cK/kbTXUdSk2OOCzTHImXxIBx09rnoO+aldfVtwYnyO/IjPbqXEoZ2OmkZkvoJpB9Olv7Z1W+t9hDCNeHKOXGu4OK1OzbyRGaK5nUHuEtEj3gwYMojnKZoLLY8iAOvjt8DVeP+rtR3LKdP0K4B69fvfj2zdG3BAwpUk+wYX+3v8svndq6QqjWTkeYT+DIG4Jr2QWNV7Utkd2WyG5LZLclstsS2W2J7LZEdlsiuy2R3ZbIbktktyWy2xLZ361gZ1siuy2R3ZbIbktktyWy2xLZbYnstkR2WyK7LZHdlsj+7lri1hLZkEVDCnNQ5kKqVoahT+k6WRXOnsVRRtle+yfR9TUF299RUgY1/1ShoVSxszi6EkZSuIkTxeI6u4kydi6R8l9e+OhZ75h2jr2y4pertfw4Ss/yMw6SBEt359h2Qtrh26PjKI7qOoBCpzTHiBkV/oqZT8kIdORUJsGlTblQ04oTiCK/JiVk0dtvN5vrkrO5wo9WHhJlL60g7KZ5eTToLyG1ccL1tc8U43whP9533TojELYeTSd3tlwu/we3oQVv","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),u=t.n(h),g=(t(18766),t(79329),t(9303));const m={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:"eJztO11vG0lyf6UyCOC1MiRFWvY6gmOc1t7sOnFsYSXDuEg6bXOmyGlppnu2u0ckVyCwD/cP7umA5OV+mn9JUNU9wxmKkuz14tZJ6AeZ059V1VXVVdVV15ETUxvtn0QvdVIVqJyNzuIoRZsYWTqpVbQfHWcIFvOJlVMFB4evYIoKjXBoQcC7H16Dy4QDVGKco4WJQbRukSPQeKmmoCcgIA3r9+GPuoJEKBC51SBVklcpgubNRA6lwV6KE6kwhZlMp+hsDLNMJhm4zK+JhudjKh1oAzgvhUqhKrUCYUEhppj24TiTFkqjr2TKgNbQ4LxEI1EltFghc2HAaV77wy//dUQo/lFXhvD98Mt/wyTXM5CK+9+WqHiAKMv+qTpVx7Lch3dlrkUKC10ZOHz5rw2itCq1nezsvMRxNYV3r3Z2zr7KnCvt/mBAa+gSFYGVi7HtJ7oYpDSwTCcPCWU0SKt6XIWV+QJE2iKKy1BBossFJFqbVCo6kRhKMUVQVTFGY2MgyhTaIOEgwKBIFz2ne5VF+Lejt29gok0hXB8O88rGzXapNJi4fOGXJ9xrrB5YGAuLT/bAOiPVNIZCXBJZpYOfKplcEtoWVVoT9eDwFdNqZ+eoKkttHKbw3qOwv7NDPd8g0VgY5PGJLgqtoBRGFOjQWM9d1G3wp0oa5guXgcjzmhb7p6oHOztuUeL+zg68UqlMmD1pQWolFvRj+34oEYmGHpWYyIkMQ1ukA60C1xFNZsKfZ5mLxINp0JaYOHmF3YXnMSxo4ZeodA1Bpo38WSsncj6OKzROJiJvHxsByOzthHFEzlJL5erWsEMjOXR6fCiBrwi0lIhVSMU9FuFK5BXaANUshoyg+gFLg5akvF6XCKlSyFBOs1v3E+lFZV1nYagsgdmGIuxVnxKTF5lsE5FbBDnp0LIQl9jardEAffhmASlORJW7GCRxnDMV9uGNdiR5uUxI0RDnskwLVxns8SkHdgiAKFHwGR+udEAqJxM0JJzUyUuEOTV0xGdeaRB6LDkuEwq0WjvoROfa3GQhbu7SERKtHGu+gyshcwbeI2sb9TfORXIZwzivMAaDqRfcBea5nsWe33kIKThPc6YPqWXiQq0IfqXD9tKCDVA1irCWJ+pslC1tIm2bqkFqJ5p2JhLUIgZYCJnHTLgYLvQYnHQ5xiSwpVCLGFLhMAaHczfW8xiSDJPLsZ4Hek20clb+vEHq6p5Pp9oohr0YnsTwNIbhbgzDUQzDvRiGT2IYPo1htBvDaBTDaC+G0RNP09HTQE/RELENwHDkKem+LAqS/nwtLUsoKT7b6NJZR5cO+7Cz00gFtf3444+n6vpUAZxGJCSn0T6cRs2Q0yj2faT7qG8Yvuf08Wj0dfhc0OeT0dPwOeOhw73wmdHnaHiqlmHDUzViSJwoyjugoO7fFILwFRiF2nhTaqv1EjWSQonrDjqPDjzUsWzj8ohwkUo6KXJ7Ozr1iC8IoxVIN5DaI6SYJW/HiLu/IHTa8FAPqzvfxeqx1VULNUMxuoH94364IW5H3m/7xeDeAufzUH9CqJP6OSb1czv+jYb6goiwDtPnUeLrPl/krH1vp0MY8AVRoQvR59HgKdGALp7bCUC9XxD2LXCoI9zivm93rzd83BvtjvY6FCAfxw8oil6a9haLxW9BPbJrwvZk1tSWprfQhEOYGF1scCPYyl+NCnYP/65N7/8gg3tc26KY1j5oY5U0nlvbWnY6FYsH1i9VT20MMBq/Mr8WLTC5i+BgLzbJtEwC8DSmNrvG5Kj1iQY9puQgTQctSlJjmvaKorfWSJ89JnyrsSj6adpfG3njdHxjAWkaw83mje1pCkVR3NLs2zvNg6K4iUW/KAJsjO+p+mcSk2CZ3S4pYcDfS1hWMtHd+E5BohiAVjnvzY7ZZklau24yqUJHYCtYG2BwWuXC4Jw8TCu18qN/eymrhWxlv7NHys4c+/ueFPDV22CjPwwCQCh0F6CW++fdwIwWOYCksk4XYHCKcyiFc2gUL3YlcpkKdsp63IBzUZRk6A/+dHqa/tM/DjiUQN66AzoJSOVUUkRn8KeTg95/nm0YUZUlmkRYhBxpJxsDuqQPJxnm5SqoNJvN+rNHNsm0zn1E6cIanPi/53p8cc7gln1hy4ebMPWs0XLdiXXWPXeLrkMxYaGeucF5Zx5jF2a4y/dt8GruuHDDiC/ozlkDiTp9HIS6T06jQrBJQqyMq9/aZWhOo7NmjnfXMb1n7tlHCGsmU8zFGPObXR8taE1zLha6CvJdh6e6qAaObtGNOgqpmggEo7MbtzrFfK3T9y03yLcnSFs660unFs/6BCCXto7BdMnZnh2CVBw6pIAwse0YoZ4A44ZLP1sKGsA+Tgy8Jgpnd88WNA54YBMgbGICd+/QOZg2YWiNQipZVEUT6Zw0q9YkK4L10aYXzawsmnqH9une2EHM79mBwoq3b3CqhhzJkIWY3mGYcvcXpCUCPGv8HcWRLum9RGr1Ko32o/otJYp5UbTuG50uov3rKMS86GeIKNGkwYWld5jryCYZFoJ+1cDQy81E5hjFkX8ZsVEcsYNEzzhEqWg/0uMLTFwU09VdknSjpTV43v51PcrH86M4mMvRfuQD/VEchQusaQJUiSajtEwn0bLe8K6lmpbVUpZ/NA8LtA6FzH/lMm9o6nLt5epXrfSytQLjVuCxfqGpz+FLsbCtdT1/R+sPZjSH5DcJsyAVC0thwsp6VZSIPKlyMr1xXkqzaPwAtr8bkrTgbXZq4B0+XtaH3oLolrM2+tMPKEFNBOCYy6fOvdA4RvxDaCBLhM9XFJ8MxYVGGCOfbZlp9cnzh6NHw9Hw0XBEKwTH+VPXqN/paIkLPT7/Vfye4hXND/Ha1mxhjFhEcSQdFvb+o/S9N/fusuABRZ8xrS/C3uqpJAYOc/bvk4Z6PFNeTPF+tj++7QmtFdW3ma7ylOLlKEyfX7J+9SNpV5JoE8a2f4/cLONofj8yc0h0r36fg69ynDhvhUOijULzsO3cfzHIjfb2lnG0uB+9xf9K9L6mw5vdj917fthcPfr+HrA+erqMo+x+WL9vnl5/R2D3nixX93iUGBQOHRYlLXI+1univNZby/bA2pKpbyw/NFxKS9oxT9GQ0XNTX61UDY2klIHz9atmrHWOQm1QNJ33OEG6zrLlTHZ5iG7NMiT3a2VQ8+q28QSCFe+tJnrjw7WAgrRkbJoKT6M+vJqsaOlt8fUnwXosPwkqDQ94v3NbsRp/MAjfRKEH7fQGenFeRfVqEHgw1EdgYSbznOAmC6IPzT+2LhtKEgD1jV1vfP9V8cIHMnjDMKn7uA7BSu3DC6Gax9fuIydcXzdMwNyxXML1NZ0qmnO695fLeNVAe3Ua+Gr3LQYTlFedWU0TriY2ba2p3pg6J2PKN4T7vg2AzwI6r0xYh2zO5bLfYcg1wCFj145pgGnDZ5QJdBPrxmTik/5o6t8gduAAWuT/Dd2flc+/lxtAeTYonz8rn7+nVJoSvex58kykSr3kzzDP+/DMOqPV9PkaCZ4NQvvmozR4JXHGgsunulplnbbNQv0AE+WKtQ5PWkhMlUiRcwTP6ATrfCU6N4VzB9ZhaSlaIJ1PSuNMCLb8xdQgcvIYwSIqx6lD7ATWGz4TkBmc/MuDNZo+eM6paZQ19mwgnofRr3xAIRNXCEItgBHnuIo2PjAyqQyrySQXRk6CxxlDmSNFG8khFYkPdHiK1nAcZ0Jd2vjZ2Dw/RlE0yXEf/vw3GsFiwBmBx7oyH6HTOf7R82fr3W+v8/wiIGBa8TuIIzrV6okDoat0HamsM5UPSUBamTpDqU794/Owth8SknqQSutzNjJsrx8DKuunC5gI69DEUCmpHBpTlcQ5N7MJO6zMGyzJv/epdHRG9+uCbl4MZVb6LMBW4mN9D9QLY0h8DK5mk5NVJyGuo77x4g1ycj+AdEly5lSIRpVorFbES9pMhQqs6g1/bclxy0Tuh3p5lfSKRPDQ/dvf6GR9+PPfWnDd6n3eBMzvINKUwvT3QMgxKAo2WY5EGSzzBTjdhYjWQ/OHdVsrutcC8kbSKkYT7mXKGdTKejdutLtL/3XRqJNwwVtgKdgqoWObVHm++Ico/vgA0d0+pG/ebJfd5RRmF3L08zy5Gh3SEd3C03cuEGzYyuSUhkqU6zWZweu0lSqXCs9rsp2PdnfPh0TbZRztbSLfkS7QZZxzRUSckaZuVJkzCxBTIRWQRWV+Q2qiMdrcbeJ+GmR3EWGvQ4THN4nwSnG4nhO1j/Ulqr8vpu3tnd+eQJ0XzCtezUTSD+L+qINsu90jaTGpjHSLaP/kOpr3RCl7vn//5Gx5FkdEWE1h1VJbhli4LNqPBq0oq0VzRaFRWoGZtuFDK1RK0fQb/pQo5eBq2B9Gy3h9zkb/647xWPU+dYp1YirV9L55ZyvqHNEJ+kPq0GgVZSrlvyOFmcIRtEfFkSTOyVCk5LdRlMtq9cMqNv1tfbx11HhTILilFNdCu3VktxOsXVfhG8Kvm6Ovw8ftuKePbHKwsolVbgo/NojXAcUmntgKEbYihKugXyfmx2G8VhTvZCULTcCsjpcNOdA02tvjiMzXQw5dPHrKUYG9J8uzjoMcRV0nmJ8Y1l25z/NMuo7J1tr+P2Rtd41t/xy8ZnzWDNYYex2La93gut34IWUx0axZgkg0dTGk81kz3YjHYZ7oosmN3tlpwd/M2tlpNIY/A3oHfFsZKPUMzaTyydaTHOeSbHaahgX3rWI/KIocrc0XQMb6lIqUfHaFyBtTOBGlGMtc0qVGw3TghtW9aPvwfhU9emB8sskV5nQXEqPoQrCp3ZjZM20uqVSIKm5gTLURZIOiyoRKvLnr1XRMnED1PORKlEZaKvkwBLX0sGnlDLFAIZSYMnPG7cOGFHOSVQtGj+mR1uq88izmhMy18e9LjBAxnGUifjsvqYuDiqTgDGZ0qlfB6bGUgp4ieA0ciobGFIMoCRaZIEfNKpVrqu+h+EOV51BqMilI+PSkAyNNd0YoS5ZgeNIKZ9AQLPgjaENy+zuLdMKvpbr0uew9OGn46j2OrXTYzXNZ58yH3TnfSfd9NaaKF22l02axmj2VLqvGfJe2F2k+/ErfhSI3aN2UqzVSndgNUVid2AGl5AyO0BGH2MHB4Su2wh7Ch1/+Aq9RGAWZnnluTSqD+aKpp/PVWnzynmyNEcUeL2koonjimS8o1pqC7zPhPvzyVwtvkCvWvEj5x/rDapzLBI7rcOLOzj68YBejFWLsvMtngljpSgoQUPrZuVSXfThQC3acVmqW2nleBw1W7fVx+6KxFLQKiUN+z/4KImovLOZXyB4ZFWCMkUv8iKMzo6up360NTEDO4IS84lBVRrgdpCkVEnJzXeBDNVIrcHDiS3tw4QOwXGlyuDaFe5pKi5CBuYq9oUq5TMvuQ2rExK3Wj1eMzp4cK/kbTXUdSk2OOCzTHImXxIBx09rnoO+aldfVtwYnyO/IjPbqXEoZ2OmkZkvoJpB9Olv7Z1W+t9hDCNeHKOXGu4OK1OzbyRGaK5nUHuEtEj3gwYMojnKZoLLY8iAOvjt8DVeP+rtR3LKdP0K4B69fvfj2zdG3BAwpUk+wYX+3v8svndq6QqjWTkeYT+DIG4Jr2QWNV7Utkd2WyG5LZLclstsS2W2J7LZEdlsiuy2R3ZbIbktktyWy2xLZ361gZ1siuy2R3ZbIbktktyWy2xLZbYnstkR2WyK7LZHdlsj+7lri1hLZkEVDCnNQ5kKqVoahT+k6WRXOnsVRRtle+yfR9TUF299RUgY1/1ShoVSxszi6EkZSuIkTxeI6u4kydi6R8l9e+OhZ75h2jr2y4pertfw4Ss/yMw6SBEt359h2Qtrh26PjKI7qOoBCpzTHiBkV/oqZT8kIdORUJsGlTblQ04oTiCK/JiVk0dtvN5vrkrO5wo9WHhJlL60g7KZ5eTToLyG1ccL1tc8U43whP9533TojELYeTSd3tlwu/we3oQVv",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={},f=[];function j(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Self Sign"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/selfsign",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"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.jsx)(g.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"}},title:"selfsigndocument_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"},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,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/34593b53.6a79c571.js b/assets/js/34593b53.6a79c571.js new file mode 100644 index 000000000..c8ea3f19d --- /dev/null +++ b/assets/js/34593b53.6a79c571.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:()=>x,contentTitle:()=>y,default:()=>j,frontMatter:()=>g,metadata:()=>s,toc:()=>f});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":"eJztPGtzHDdyfwWZSpUsZjj7ICnJjKI6WlJs5hSJZVFRXUgdjZ3p3YE4A4yBGS7XrK26D/cP8ilf76f5l6S6AcxjHyQl0T7qsv4gczF4NBrdjX7iKij5xAT7J8ELFVc5yNIEH8IgARNrUZRCyWA/OE6BPdfAS2C+Fzs4OmQ8y9TUsMqANqxUbAISNPaSMGWJn4+NZqzQ6kIkQk5YwkvOpqJM2YgbeLTLQMYqgYSNRQbRqTyVx6LYZ++KTPGEzVSl2dGLf69nw2Ww7WRr6wWMqgl7d7i19eGbtCwLs9/r8aKIVAHSiInM+MhEscp7CXYskvHDkE1T0ICzsphLBtyIbMZ4krCpSCZQmpCVKUgWq2LGYqV0IiQvwYSs4BNgsspHoE3IuExYrjQwIRlnGngy2y7VdmWA/cfbN6/ZWOmclxE7yioT1sslQkNcZjM7fZlCvasHxmPDlFrISchyfo7YEiX7uRLxOW7bgEzw/zjw4OiQcLW19bYqCqVLSNh7u4X9rS388h1kasq4BuofqzxXkhVc8xxKOq6Ul/RZw8+V0JDYQ+FZ5nGxfyq32dZWOStgf2uLHcpExIgMmhBbmRq7vpHtikjCrm8LiMVYuK4t1DEl2TQVcUo4mXJ7nkXGYwumBlNAXIoL6E58GbIZTvwCpPIQpEqLX5QseUbHcQG6FDHP2seGAGJXU3JdIjoLJWTpW90K7E/uePD06FAcXSFoCSIrF5K+GGAXPKvAOKimIUsRqh+h0GCI1N28iEiZsBTEJF27Hk8+VqbsTMwqg2C2oXBr+VMi9AKhbcwzA0yMO7jM+Tm0VmOKeJhnEftuxhIY8yorQyaQ4kpdQcReq5LxoshEzEcZIOUyZB5eVhq26ZQdOThAJM/pjI+Io8EwzhIxHoNG5sSPNIUb46FDOmtEAHFOmXLJlFw46FhlSi+TEDV38chiJUuQZcQOLrjICHi7WcOEjLMqATbKeHweslFWQcg0JJZxZ4BiK3RCCLswbhzOCT/MQIZUqCTCL5VbXhhmHFRJxI5TYRp+wo8e1bSIMG2sOq4dK1wZUeBZjEHORRYS4kL2UY1YKcoMQmTYgstZiPISQlbCZTlSlyGLU4jP6S/NE6HYqCpLJe3GEq2KRE2lw+VYydKIX1ZwpP/y6Rgdhmw3ZI9C9iRkg37IBsOQDXZDNngUssGTkA37IRsOQzbcDdnwkQVr+MThmtcIbgMwGFosl18PdlHuvhKGOBsFpqll8LQjgwcR29qquQnbfvrpp1N5dSoZOw2QuU6DfXYa1F1Og9B+Q5mJ3wbu9yX+2Bk+dj9n+PPR8In7OaWug133M8Wfw8GpnLsFT+WQICl5XlwDBX6+UwjcL0dE2EaLYpuXZ9iIgij0H/CsOvDgh3l7Lzu4FyFFKXhm1m/H97hHO2pAWtrULm6KyHX9jujzPdpOGx78QmLSfiKx2vrkGZ6gGC7tfi9yN8v6zdtl783eW+B82dYf4dZRNB2jaFq//1p63SMkLML0ZZh4HJECQJJ5PR5ch3uEhS5EX4aDJ4gDvJTWIwC/3qPdt8DBD+6Gt9/6u9uDve1hf7jbwQDaRrZDnm8nyfZsNrsL7KHO45ZHlcdrqFazQ6t0rFW+wvwg66Dp5XQi+tur7P+JivrI67CQoN1HhoXXWGqLr61llyrhswfGTuWH1soZ9m9Us1kLTPqEcJD1G6dKxA547ONVshEaeBHiYJsw2UuSXguT2Jgk23m+vdCIP7cJ8a3GPI+SJFrouXQ6tjFnSRKy5eaV7UnC8jxf02zbO829PF/eRZTnDjZSvr5FJnE623o+cR1+L1ZpOKK78LVshJ4DJTNam8y51Xy0cNmkQroPjqjYQgcNkyrjGi7RLjVCSdv77nnMs1ij2ZMdSyYgeQksKtg3b5z2/tCRP26hOwG23DxuaWc4yQGLK1OqnGmYwCUreFmCljTZBc9EwsmU26YGuOR5gSZA78+np8m//HOPHBBo45cMT4IlYiLQD9T788nB9n9/WNGjKgrQMTfAMsCVTMigjCN2kkJWNK6o6XQaTXdMnCqVWT/UR6NhbP89U6OPZwRuEXFTPFy1U0saLYMfSWfR3jdQdjDGDfMjV5j8RGPEQ4M+3bbO3rnmunU97tGNswASfrTeE/x8chrknBQSJGVo/lZlCvo0+FCPsUY+JDeM/XALZk1FAhkfQbb86daMVjdnfKYqx9/eqdXdqqPoFt7wQy5k7beg7fTD1kd+ufDRfpuv4G+LkDZ3+ivHs6c/AZYJ4z03XXS2RzvXFjkcJQD5MEfA/AB0D3vp8aVcUAN2Ozawksid3Q1LYD9GHWu3ol/thhU6B9NGDM6RCynyKq/9o+N6Vo+y3OkebXzhSPS6+xXap7u0Ar+8YQV0Rq5f4FQOyI/h/R/XaKauxz2SFQsgXc/GnyNFOvf0HV2wNzOg31abAVdcy9jVXsg185n13BexN3i9oU/WDkIvWxxDUaJH7ktZswb51jcU+azafrj1lNfudY+obwVYvzEFun53fft8FpG2d/8VEWoH7FsTq3VK5nxyjeVOn+8ReTp4lpwQW1tHGsYiy1ohReabfGQHQzqQQe7CXi6YiFcdOcKFLBWaBT5sO4IxxUtLCqOkvAk42nvGHmk7JspijDgrzVJurP5NCj8eFQZsyxTyBVe8B61xxwvp4cZTGdyd3Tj8tt8+p8Gjvc457fU759Rfd07XmI14gqZQ0tS+Nmg+tfiajti3L18ti2zrJ8UjfSkxtuKtB8sMqsoSlolziqokwhQZn+Gpei51UC6G656nSpmmh4uYfeM2vN+NxCmNwbiHUR2YuI3Da+EwWmcxeLzTOoq9J0+6HNNhmNvY7816y6fQ3+0N9nrWo7XaodW4YdYL4Ws0AcZuc17kJ7rVeVHP5sA2bqfPdTvdDbnv3KXVPXg87FwWO/3PvSzu3Lhuc80NZvVdGM93ZsW22e2W9uvvZkd+OfXt/hYa9eDxTpsKHw/uwIW6RnH+Ukpc0o/vjPbYXSnHqwjwFtrxtSrxFxNoG9jfnEj37kaTHvQ7Gtq3HQXt22GbKPf2bkWU7UUXKOs0EP/13Zsfp/0/fj9RBwcHB6/fvktfvpscHBzk+DuKopVG1KrTpmVQc3UZge5epjt+zSpRFCEKMbVyn4b3Cjn5Vzs+XD8mOpVBGKgCczaFkodJsB+Q0g1eBw9CsiPAlN+pZBbsXwUuRwj/dBk4OLT30WCi6FVg4hRyjn95+wNTSzG1MwgpzQW0CcKAgsaYZ4pHGuwHavQRYlyt0AhOKcDgHDRu/8r3srmRQeg0rmA/sFsMwsC59eumOqu0SMbB3C943VR1SzOVoT9qgwTnwfTDz5zmNQ6dL6TWftZML1oz0N5yOFbPFX4r4QWfmda81usXLGb04hhk9tiNYgmfGRQalbEXXMyzuMpQL4TLQuhZHRsl5bBFHzW89Uo1vIO9eXPoDUhcaz4LwkCUkLfb1xCBVp9+cjEoxAwlqHzq2I8KRgB/cA0YuKGD5/knQ/FRARsBHXqRKvnJ4wfDncFwsDMY4gwuy+BT5/DJ0DjFRzU6+yxGSOACxzv7+vOP0n5dXrtLmweYxgeJ17u2m3zUkFFOWHQTm/j+hHk+gZv54XhdnnIrPdKkZGzxogCuI0oX/uxM9C6L1Rd8dANDzcPg8ubNXLJYbfskaPZNBuPSBi1ZrLQE/bCdCXFvNjfc3Z2Hwezm7c2+yu09xsOb3ry795Q93mTW/z1g3XkyD4P0Zlh/qPPb/47A7j6aNxf8gv5yNlLJ7MzLrflNHf1dhf3GKktAo060LK8aUYMSBusyzhavmpFSGXC5QtB0EptdBQ3q3+iCdj6ZaQpoxjRqOc3e6PzOYW2hxWRpWMi/EAbVZV3BaRCxw3HLgiCNfjG32velPGep2ANa78xUJMYf9NxvxNGDdg0JenybFCgPAnVmJeRFRkUYU3QbjyiemESs/o+UzxqTCIC/sf3CN18Vz23eBy3oBnUrGJhTXyP2nMs6i72bLc6urmoyIOqYz9nVFZ4q6DO89+fzsGnAtToNdLXbFg0xiIvOqLoJmoF1W2uo1bLOUMuyDe6+bwMgJlLIyVml3TyojM7nUYcgFwAn57nDASQ1nYmJXLHrWmWik7419peQ7SgAJ/l/g/enxbMfxApQnvaKZ0+LZ++xXqkAy3sWPWMhE8v5U8iyiD01pVZy8mwBBU97rn31UWq4EDAlxqVTbWZZxG09UeRg+hMK6ubwhGGxrmLBM0p40ioGH6PBc5NoxJsSCoNBMVHSSFtSQiYBn2igaBDBwquS6rPIOvQLPuUs1TD+twcLOH3w7C2CjqV5T3v8met9aN0SKb8AxuWM0cbJh6K09cONK01iMs64FmNnioasyACTs9BS5bGN6VmMejiOUy7PTfh0pJ8dA8/ZmwIkQvDrX/+GPbxMP5RvdAL6FkL9cGyjh4o9QDn2ILSJYkTuQpvSiWorCR2FWLjWsI4rFMCg48ta9JtqZLCX9PM1orXUYjIBjKm5HjTYld0Aj1N7aRBUfOyjCAUSj6qMBw8JzBuEFGATlj6EnHS9Pi3sUDivvfdolVSXWKfz5vjoFrgkl9S2ZRTrj7G7tHOwN8dHWOpXH3fE3pkaEx61vNOFoSeAXQjuy4FqzX5mk2vAxlWcXGzHICNXZLfNlgFKhFkJUWgvdZRwdWHs0sRNLSgekapKjGkKV+FEXNbBI0FRI/JYVbehyhswydmkolzmEtnX35qUztiU6glpSl3ZxCKWVNpXJzqysGLCmAZPHivYqTV/yEAaO5yzMTcl6JBVUiDmdYVeynpKuCxAC5AxrESBBos6FB03X1Hdurd3P75yFcB+D54pR8iBdmJIWFUQ1RAn1PWY/uQWt75SH3Ti+2YAUXejqknnai1AGyVRxCk94dJJUGuPoj91BCnPbFcnKjAkh/Agh0crbf9f//q3FlxrnSLLgNkVeJJgsu0NEJJr2hI85pNpKFACqi5EOB/oPyyaAAgdMc1ZrpKakcztafyI0nNNLRddjkCdn2CqOMVrq5a3JvQy1jingiEvNLmqKcmgwP3CpTBlq6LQ5/0vy4cfAfEYt2AgIxS5GmleztoM3uRNqIXpyDwQ3WrU2gha4gVelepMQy7k7e6ptte/VLUgqEqV81LEzE9lom6NsQ0te77O2TceNKTGC6H0wzWsitOdKRnDmZBncAH6Fub96zpPkXySIyinALINm0eSvc6aOtAplu53cNK6najauQ0lOidz0BM4i9FDRVQHtyc5AsLJU1NpF5txtfYkOFCGNDMjKE4PrstHxgKpof28QcR+UFNEVK3GoLJp50Y8MoI4Ce1CrdljLrGElsxDtNBQjNWx+5wL2SyBQRZPtk7Jim2wBmfAGnJcI7xuL15m1vUwHOvA/cq0I/TdM54pYh6nQxJrJF1IDqn2N6XLhg4Lg0p2AV+Qr6YS9K9/+V+DGgtVmsdgart25VcyTXlmlC0sbs/qaddTd0SmKHoKbabQKjdmlwJ8Ab+vvvDCweoV9LBEPsKMNZvzhHKXbhFvsi/5Rb8Wx6pL/tm4Vb8iv+Og3/9Hdqvu9L8et+pu/ytyqz5BYF1A/GYBtE7ZXSk7fNT7+gEfFdi4V6b09T0xykweW5uWsQrBDTsM5/a/xhPs5f4N3mHrPm7C2s629ZshNAz7ffxf9zhfdBJa0dKpYrQcxlWWzf4pCG8fU7/+DGzzao/1dVI9/SiGv1zGF8OjwMVru6bVJ95FnxV0xTGLIdc1Bt61W3EMUekM32PCvWzX2gZN2zpjITMh4cwf4Fmi4jO/+zkph8Z0b7lbwVAfN7lcumd9w/KBJczdVVT0VuVg1aQpzjtFV16tJJZ6xvgEtTzkcX2HRAVa38R+nwbZdSjY7ffPBjUS9paRcCip/I0eHztW5yB/3522ly/t8gjqZZ41MjAQthN9DzqbbbfbTRqIKy3KWbB/chVcbvNCbNvv+ycf5h+QBMtUYVpOoQxBzMs02A96S1k6BvQFZVmcXFm+qVnBcJlgbuHS/cAL0bsYRINgHi6OWXmfXNMfqu1PHWJKPhFyctO4Dw2O3uI52qPqYKqRU4X4I6CgcgfR7hUGAuknBY6WMqIeyePHJrfppT9kn3W0KpGoOczF1CCfGdRJ9lm811ek76zO3hnstfJmTnwKDGW11Ektq/JU6q37zJM68aSVS9JKJWmyQzrJIZTv0Ur3OGl4os6s8BbAgFTn4e4u6ZiPB6SM7TwhPWf30ZyouAmlBkE3XEqFKYtBvy+LYXVDWJu4zD9QXGYhLOOIp4kt2ATejpPcNXWdxp4Kaydtx1O66Chd67Rc47N0Sy745mpAVrnE9lZ6ouz+Wl6JFQzpteouO2LuK7LjTp/YcbdP7Pik31Ho3dabGRq1nHTvWvUm/bqtXqMO/QFlqJBjRQLYyQ1/YHRBkgBfMsMgi1VeP9m2tdU643rU1lYtWC2dop/oTaVZoaagx5V9A26cwaVAtx8Og5y+NZkUwPMMjMmwGKaECbml6GkHjK84D37MCz4SmUANwBasWY5plAgTsfdNLsYDbV+6uIAMFYfacYqvmnqlb6r0+RhzOkLG2Qifc0TXOciUy9h66e1tRt5m9BRhBKTQwuArlRqhFhY2JUuNbJJzySfEwGGbIVgCGcozw7QaYRDLqKyybFhykSlt0zhpQ5QwTkh8eVngJ7Il8RbQkCJRX7hYjQltrMxeVO6d0xGGJQuERaBjrVSskpnCJ0nRg1llGStUaUOOaLK2YcThpebSoL7sMkfdGdQIc2EUMK6Y750BPOFXQp7bZ/S22UlNV+9hZEQJ3Uc2FhnzYXfM96L8oRrhI53KiFLpWTN6Isq0GpHK0Z6k/mFn+t6/attSKJo5EhWbFca3ik0P3wPpvYUSKcT0Do4OSWV9yH79y/+wV8C1ZKmaWmqNKw3ZrHlAlx6YpZO3aKs1TgrUoRRHjMeW+Nzl4zH4PuUl+UNfwxQ9zZalbML5UTXKRMyOfXLO1ta+f9m3SdjpPApgSzUxespZYUdnQp5H7EDOKN7TXEXYTuM626Drr/UYMMcMYyVdZYBdM2ogogiDgewCTMupDYmwMWmtqoldrQ2M21y3ahX3dpAkrFioXMVoRgOO9dFSMJhbZy2+27ui2LVTVdrNZAGZ0MuyZp8lmo/LZv5woZyVLsKlJl8J69ERumnqI7Gc6HZct9r8/QVluCtvySOOC3bfZ+aFcOR04smSdV+v+XSyts4auttbbgDUylfG+/BdXfNm/Bb0hYi97b6Go3vUuReEQSZicJ4jd38dfH/0il3sRP0gbJkYt2Du3qvD5y9fv32JwKAgtQgbRP2oTw5uZcqcy9ZKCy9gL95trdqIzYPZmwezNw9mbx7M3jyY/dU86bx5MHvzYPbmwezNg9mbB7M3D2b/dkjYPJi9eTB782D25sHszYPZmwezNw9mbx7M3jyYvXkwe/Ng9ubB7PsjKzYPZt+Xd4g3D2b/HhS4eTB782D25sHszYPZmwezNw9mbx7M3jyYvXkwe/Ng9ubB7M2D2ZsHszcPZq95MLtVetErMi5kq1jVFuidLD6j/SEMUqzg2z8Jrq5wmXdYX4PNP1dUAXLyIQwuuBaYnkPFf6GvVcNij3PAUqbnNtto+xjXDy1vU4LtQs0jFtvZEQdE0Nf2bRcZHr15exyEgX/8L1cJVVfzKRaH8KktnGlVkFDbVZBxOamo+iSwc87t0zRptzbvnGrz3B+tEhasRGsg7Bbt2W3gv7iplQOurmzdH5V+2f7209oRDrG+N57fh/l8/n9omfya","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),d=t(17543),a=t.n(d),c=t(86013),p=t.n(c),h=t(63723),m=t.n(h),u=(t(18766),t(79329),t(9303));const g={id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztPGtzHDdyfwWZSpUsZjj7ICnJjKI6WlJs5hSJZVFRXUgdjZ3p3YE4A4yBGS7XrK26D/cP8ilf76f5l6S6AcxjHyQl0T7qsv4gczF4NBrdjX7iKij5xAT7J8ELFVc5yNIEH8IgARNrUZRCyWA/OE6BPdfAS2C+Fzs4OmQ8y9TUsMqANqxUbAISNPaSMGWJn4+NZqzQ6kIkQk5YwkvOpqJM2YgbeLTLQMYqgYSNRQbRqTyVx6LYZ++KTPGEzVSl2dGLf69nw2Ww7WRr6wWMqgl7d7i19eGbtCwLs9/r8aKIVAHSiInM+MhEscp7CXYskvHDkE1T0ICzsphLBtyIbMZ4krCpSCZQmpCVKUgWq2LGYqV0IiQvwYSs4BNgsspHoE3IuExYrjQwIRlnGngy2y7VdmWA/cfbN6/ZWOmclxE7yioT1sslQkNcZjM7fZlCvasHxmPDlFrISchyfo7YEiX7uRLxOW7bgEzw/zjw4OiQcLW19bYqCqVLSNh7u4X9rS388h1kasq4BuofqzxXkhVc8xxKOq6Ul/RZw8+V0JDYQ+FZ5nGxfyq32dZWOStgf2uLHcpExIgMmhBbmRq7vpHtikjCrm8LiMVYuK4t1DEl2TQVcUo4mXJ7nkXGYwumBlNAXIoL6E58GbIZTvwCpPIQpEqLX5QseUbHcQG6FDHP2seGAGJXU3JdIjoLJWTpW90K7E/uePD06FAcXSFoCSIrF5K+GGAXPKvAOKimIUsRqh+h0GCI1N28iEiZsBTEJF27Hk8+VqbsTMwqg2C2oXBr+VMi9AKhbcwzA0yMO7jM+Tm0VmOKeJhnEftuxhIY8yorQyaQ4kpdQcReq5LxoshEzEcZIOUyZB5eVhq26ZQdOThAJM/pjI+Io8EwzhIxHoNG5sSPNIUb46FDOmtEAHFOmXLJlFw46FhlSi+TEDV38chiJUuQZcQOLrjICHi7WcOEjLMqATbKeHweslFWQcg0JJZxZ4BiK3RCCLswbhzOCT/MQIZUqCTCL5VbXhhmHFRJxI5TYRp+wo8e1bSIMG2sOq4dK1wZUeBZjEHORRYS4kL2UY1YKcoMQmTYgstZiPISQlbCZTlSlyGLU4jP6S/NE6HYqCpLJe3GEq2KRE2lw+VYydKIX1ZwpP/y6Rgdhmw3ZI9C9iRkg37IBsOQDXZDNngUssGTkA37IRsOQzbcDdnwkQVr+MThmtcIbgMwGFosl18PdlHuvhKGOBsFpqll8LQjgwcR29qquQnbfvrpp1N5dSoZOw2QuU6DfXYa1F1Og9B+Q5mJ3wbu9yX+2Bk+dj9n+PPR8In7OaWug133M8Wfw8GpnLsFT+WQICl5XlwDBX6+UwjcL0dE2EaLYpuXZ9iIgij0H/CsOvDgh3l7Lzu4FyFFKXhm1m/H97hHO2pAWtrULm6KyHX9jujzPdpOGx78QmLSfiKx2vrkGZ6gGC7tfi9yN8v6zdtl783eW+B82dYf4dZRNB2jaFq//1p63SMkLML0ZZh4HJECQJJ5PR5ch3uEhS5EX4aDJ4gDvJTWIwC/3qPdt8DBD+6Gt9/6u9uDve1hf7jbwQDaRrZDnm8nyfZsNrsL7KHO45ZHlcdrqFazQ6t0rFW+wvwg66Dp5XQi+tur7P+JivrI67CQoN1HhoXXWGqLr61llyrhswfGTuWH1soZ9m9Us1kLTPqEcJD1G6dKxA547ONVshEaeBHiYJsw2UuSXguT2Jgk23m+vdCIP7cJ8a3GPI+SJFrouXQ6tjFnSRKy5eaV7UnC8jxf02zbO829PF/eRZTnDjZSvr5FJnE623o+cR1+L1ZpOKK78LVshJ4DJTNam8y51Xy0cNmkQroPjqjYQgcNkyrjGi7RLjVCSdv77nnMs1ij2ZMdSyYgeQksKtg3b5z2/tCRP26hOwG23DxuaWc4yQGLK1OqnGmYwCUreFmCljTZBc9EwsmU26YGuOR5gSZA78+np8m//HOPHBBo45cMT4IlYiLQD9T788nB9n9/WNGjKgrQMTfAMsCVTMigjCN2kkJWNK6o6XQaTXdMnCqVWT/UR6NhbP89U6OPZwRuEXFTPFy1U0saLYMfSWfR3jdQdjDGDfMjV5j8RGPEQ4M+3bbO3rnmunU97tGNswASfrTeE/x8chrknBQSJGVo/lZlCvo0+FCPsUY+JDeM/XALZk1FAhkfQbb86daMVjdnfKYqx9/eqdXdqqPoFt7wQy5k7beg7fTD1kd+ufDRfpuv4G+LkDZ3+ivHs6c/AZYJ4z03XXS2RzvXFjkcJQD5MEfA/AB0D3vp8aVcUAN2Ozawksid3Q1LYD9GHWu3ol/thhU6B9NGDM6RCynyKq/9o+N6Vo+y3OkebXzhSPS6+xXap7u0Ar+8YQV0Rq5f4FQOyI/h/R/XaKauxz2SFQsgXc/GnyNFOvf0HV2wNzOg31abAVdcy9jVXsg185n13BexN3i9oU/WDkIvWxxDUaJH7ktZswb51jcU+azafrj1lNfudY+obwVYvzEFun53fft8FpG2d/8VEWoH7FsTq3VK5nxyjeVOn+8ReTp4lpwQW1tHGsYiy1ohReabfGQHQzqQQe7CXi6YiFcdOcKFLBWaBT5sO4IxxUtLCqOkvAk42nvGHmk7JspijDgrzVJurP5NCj8eFQZsyxTyBVe8B61xxwvp4cZTGdyd3Tj8tt8+p8Gjvc457fU759Rfd07XmI14gqZQ0tS+Nmg+tfiajti3L18ti2zrJ8UjfSkxtuKtB8sMqsoSlolziqokwhQZn+Gpei51UC6G656nSpmmh4uYfeM2vN+NxCmNwbiHUR2YuI3Da+EwWmcxeLzTOoq9J0+6HNNhmNvY7816y6fQ3+0N9nrWo7XaodW4YdYL4Ws0AcZuc17kJ7rVeVHP5sA2bqfPdTvdDbnv3KXVPXg87FwWO/3PvSzu3Lhuc80NZvVdGM93ZsW22e2W9uvvZkd+OfXt/hYa9eDxTpsKHw/uwIW6RnH+Ukpc0o/vjPbYXSnHqwjwFtrxtSrxFxNoG9jfnEj37kaTHvQ7Gtq3HQXt22GbKPf2bkWU7UUXKOs0EP/13Zsfp/0/fj9RBwcHB6/fvktfvpscHBzk+DuKopVG1KrTpmVQc3UZge5epjt+zSpRFCEKMbVyn4b3Cjn5Vzs+XD8mOpVBGKgCczaFkodJsB+Q0g1eBw9CsiPAlN+pZBbsXwUuRwj/dBk4OLT30WCi6FVg4hRyjn95+wNTSzG1MwgpzQW0CcKAgsaYZ4pHGuwHavQRYlyt0AhOKcDgHDRu/8r3srmRQeg0rmA/sFsMwsC59eumOqu0SMbB3C943VR1SzOVoT9qgwTnwfTDz5zmNQ6dL6TWftZML1oz0N5yOFbPFX4r4QWfmda81usXLGb04hhk9tiNYgmfGRQalbEXXMyzuMpQL4TLQuhZHRsl5bBFHzW89Uo1vIO9eXPoDUhcaz4LwkCUkLfb1xCBVp9+cjEoxAwlqHzq2I8KRgB/cA0YuKGD5/knQ/FRARsBHXqRKvnJ4wfDncFwsDMY4gwuy+BT5/DJ0DjFRzU6+yxGSOACxzv7+vOP0n5dXrtLmweYxgeJ17u2m3zUkFFOWHQTm/j+hHk+gZv54XhdnnIrPdKkZGzxogCuI0oX/uxM9C6L1Rd8dANDzcPg8ubNXLJYbfskaPZNBuPSBi1ZrLQE/bCdCXFvNjfc3Z2Hwezm7c2+yu09xsOb3ry795Q93mTW/z1g3XkyD4P0Zlh/qPPb/47A7j6aNxf8gv5yNlLJ7MzLrflNHf1dhf3GKktAo060LK8aUYMSBusyzhavmpFSGXC5QtB0EptdBQ3q3+iCdj6ZaQpoxjRqOc3e6PzOYW2hxWRpWMi/EAbVZV3BaRCxw3HLgiCNfjG32velPGep2ANa78xUJMYf9NxvxNGDdg0JenybFCgPAnVmJeRFRkUYU3QbjyiemESs/o+UzxqTCIC/sf3CN18Vz23eBy3oBnUrGJhTXyP2nMs6i72bLc6urmoyIOqYz9nVFZ4q6DO89+fzsGnAtToNdLXbFg0xiIvOqLoJmoF1W2uo1bLOUMuyDe6+bwMgJlLIyVml3TyojM7nUYcgFwAn57nDASQ1nYmJXLHrWmWik7419peQ7SgAJ/l/g/enxbMfxApQnvaKZ0+LZ++xXqkAy3sWPWMhE8v5U8iyiD01pVZy8mwBBU97rn31UWq4EDAlxqVTbWZZxG09UeRg+hMK6ubwhGGxrmLBM0p40ioGH6PBc5NoxJsSCoNBMVHSSFtSQiYBn2igaBDBwquS6rPIOvQLPuUs1TD+twcLOH3w7C2CjqV5T3v8met9aN0SKb8AxuWM0cbJh6K09cONK01iMs64FmNnioasyACTs9BS5bGN6VmMejiOUy7PTfh0pJ8dA8/ZmwIkQvDrX/+GPbxMP5RvdAL6FkL9cGyjh4o9QDn2ILSJYkTuQpvSiWorCR2FWLjWsI4rFMCg48ta9JtqZLCX9PM1orXUYjIBjKm5HjTYld0Aj1N7aRBUfOyjCAUSj6qMBw8JzBuEFGATlj6EnHS9Pi3sUDivvfdolVSXWKfz5vjoFrgkl9S2ZRTrj7G7tHOwN8dHWOpXH3fE3pkaEx61vNOFoSeAXQjuy4FqzX5mk2vAxlWcXGzHICNXZLfNlgFKhFkJUWgvdZRwdWHs0sRNLSgekapKjGkKV+FEXNbBI0FRI/JYVbehyhswydmkolzmEtnX35qUztiU6glpSl3ZxCKWVNpXJzqysGLCmAZPHivYqTV/yEAaO5yzMTcl6JBVUiDmdYVeynpKuCxAC5AxrESBBos6FB03X1Hdurd3P75yFcB+D54pR8iBdmJIWFUQ1RAn1PWY/uQWt75SH3Ti+2YAUXejqknnai1AGyVRxCk94dJJUGuPoj91BCnPbFcnKjAkh/Agh0crbf9f//q3FlxrnSLLgNkVeJJgsu0NEJJr2hI85pNpKFACqi5EOB/oPyyaAAgdMc1ZrpKakcztafyI0nNNLRddjkCdn2CqOMVrq5a3JvQy1jingiEvNLmqKcmgwP3CpTBlq6LQ5/0vy4cfAfEYt2AgIxS5GmleztoM3uRNqIXpyDwQ3WrU2gha4gVelepMQy7k7e6ptte/VLUgqEqV81LEzE9lom6NsQ0te77O2TceNKTGC6H0wzWsitOdKRnDmZBncAH6Fub96zpPkXySIyinALINm0eSvc6aOtAplu53cNK6najauQ0lOidz0BM4i9FDRVQHtyc5AsLJU1NpF5txtfYkOFCGNDMjKE4PrstHxgKpof28QcR+UFNEVK3GoLJp50Y8MoI4Ce1CrdljLrGElsxDtNBQjNWx+5wL2SyBQRZPtk7Jim2wBmfAGnJcI7xuL15m1vUwHOvA/cq0I/TdM54pYh6nQxJrJF1IDqn2N6XLhg4Lg0p2AV+Qr6YS9K9/+V+DGgtVmsdgart25VcyTXlmlC0sbs/qaddTd0SmKHoKbabQKjdmlwJ8Ab+vvvDCweoV9LBEPsKMNZvzhHKXbhFvsi/5Rb8Wx6pL/tm4Vb8iv+Og3/9Hdqvu9L8et+pu/ytyqz5BYF1A/GYBtE7ZXSk7fNT7+gEfFdi4V6b09T0xykweW5uWsQrBDTsM5/a/xhPs5f4N3mHrPm7C2s629ZshNAz7ffxf9zhfdBJa0dKpYrQcxlWWzf4pCG8fU7/+DGzzao/1dVI9/SiGv1zGF8OjwMVru6bVJ95FnxV0xTGLIdc1Bt61W3EMUekM32PCvWzX2gZN2zpjITMh4cwf4Fmi4jO/+zkph8Z0b7lbwVAfN7lcumd9w/KBJczdVVT0VuVg1aQpzjtFV16tJJZ6xvgEtTzkcX2HRAVa38R+nwbZdSjY7ffPBjUS9paRcCip/I0eHztW5yB/3522ly/t8gjqZZ41MjAQthN9DzqbbbfbTRqIKy3KWbB/chVcbvNCbNvv+ycf5h+QBMtUYVpOoQxBzMs02A96S1k6BvQFZVmcXFm+qVnBcJlgbuHS/cAL0bsYRINgHi6OWXmfXNMfqu1PHWJKPhFyctO4Dw2O3uI52qPqYKqRU4X4I6CgcgfR7hUGAuknBY6WMqIeyePHJrfppT9kn3W0KpGoOczF1CCfGdRJ9lm811ek76zO3hnstfJmTnwKDGW11Ektq/JU6q37zJM68aSVS9JKJWmyQzrJIZTv0Ur3OGl4os6s8BbAgFTn4e4u6ZiPB6SM7TwhPWf30ZyouAmlBkE3XEqFKYtBvy+LYXVDWJu4zD9QXGYhLOOIp4kt2ATejpPcNXWdxp4Kaydtx1O66Chd67Rc47N0Sy745mpAVrnE9lZ6ouz+Wl6JFQzpteouO2LuK7LjTp/YcbdP7Pik31Ho3dabGRq1nHTvWvUm/bqtXqMO/QFlqJBjRQLYyQ1/YHRBkgBfMsMgi1VeP9m2tdU643rU1lYtWC2dop/oTaVZoaagx5V9A26cwaVAtx8Og5y+NZkUwPMMjMmwGKaECbml6GkHjK84D37MCz4SmUANwBasWY5plAgTsfdNLsYDbV+6uIAMFYfacYqvmnqlb6r0+RhzOkLG2Qifc0TXOciUy9h66e1tRt5m9BRhBKTQwuArlRqhFhY2JUuNbJJzySfEwGGbIVgCGcozw7QaYRDLqKyybFhykSlt0zhpQ5QwTkh8eVngJ7Il8RbQkCJRX7hYjQltrMxeVO6d0xGGJQuERaBjrVSskpnCJ0nRg1llGStUaUOOaLK2YcThpebSoL7sMkfdGdQIc2EUMK6Y750BPOFXQp7bZ/S22UlNV+9hZEQJ3Uc2FhnzYXfM96L8oRrhI53KiFLpWTN6Isq0GpHK0Z6k/mFn+t6/attSKJo5EhWbFca3ik0P3wPpvYUSKcT0Do4OSWV9yH79y/+wV8C1ZKmaWmqNKw3ZrHlAlx6YpZO3aKs1TgrUoRRHjMeW+Nzl4zH4PuUl+UNfwxQ9zZalbML5UTXKRMyOfXLO1ta+f9m3SdjpPApgSzUxespZYUdnQp5H7EDOKN7TXEXYTuM626Drr/UYMMcMYyVdZYBdM2ogogiDgewCTMupDYmwMWmtqoldrQ2M21y3ahX3dpAkrFioXMVoRgOO9dFSMJhbZy2+27ui2LVTVdrNZAGZ0MuyZp8lmo/LZv5woZyVLsKlJl8J69ERumnqI7Gc6HZct9r8/QVluCtvySOOC3bfZ+aFcOR04smSdV+v+XSyts4auttbbgDUylfG+/BdXfNm/Bb0hYi97b6Go3vUuReEQSZicJ4jd38dfH/0il3sRP0gbJkYt2Du3qvD5y9fv32JwKAgtQgbRP2oTw5uZcqcy9ZKCy9gL95trdqIzYPZmwezNw9mbx7M3jyY/dU86bx5MHvzYPbmwezNg9mbB7M3D2b/dkjYPJi9eTB782D25sHszYPZmwezNw9mbx7M3jyYvXkwe/Ng9ubB7PsjKzYPZt+Xd4g3D2b/HhS4eTB782D25sHszYPZmwezNw9mbx7M3jyYvXkwe/Ng9ubB7M2D2ZsHszcPZq95MLtVetErMi5kq1jVFuidLD6j/SEMUqzg2z8Jrq5wmXdYX4PNP1dUAXLyIQwuuBaYnkPFf6GvVcNij3PAUqbnNtto+xjXDy1vU4LtQs0jFtvZEQdE0Nf2bRcZHr15exyEgX/8L1cJVVfzKRaH8KktnGlVkFDbVZBxOamo+iSwc87t0zRptzbvnGrz3B+tEhasRGsg7Bbt2W3gv7iplQOurmzdH5V+2f7209oRDrG+N57fh/l8/n9omfya",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,x={},f=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(u.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:"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.p,{children:[(0,i.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,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)(u.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 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 final PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\nfalse - If you choose not to merge, the completion certificate will be provided as a separate 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"},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",description:"Allowed values - signature, stamp.",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)(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"},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.e3542020.js b/assets/js/34593b53.e3542020.js deleted file mode 100644 index edfe789a2..000000000 --- a/assets/js/34593b53.e3542020.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:()=>y,contentTitle:()=>g,default:()=>j,frontMatter:()=>x,metadata:()=>s,toc:()=>f});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":"eJztPGtzHDdyfwWZSpUsZrgvkpLMKKqjJcVWzpFYFhXXhdTR2JneHYgzwBjAcLlmseo+3D/Ip3y9n+ZfkuoGMI99kJRE+6jL+oPMxeDR6Bca3Y2+jCyfmmj/OHqhkqoAaU30Po5SMIkWpRVKRvvRUQbsuQZugYVe7ODwFeN5rmaGVQa0YVaxKUjQ2EvCjKVhPjaes1Krc5EKOWUpt5zNhM3YmBt4tMtAJiqFlE1EDr0TeSKPRLnP3pW54imbq0qzwxf/Xs+Gy2Db8dbWCxhXU/bu1dbW+68ya0uz3+/zsuypEqQRU5nzseklquin2LFMJw9jNstAA87KEi4ZcCPyOeNpymYinYI1MbMZSJaocs4SpXQqJLdgYlbyKTBZFWPQJmZcpqxQGpiQjDMNPJ1vW7VdGWD/8fbNazZRuuC2xw7zysT1cqnQkNh87qa3GdS7emACNozVQk5jVvAzxJaw7OdKJGe4bQMyxf/jwIPDV4Srra23VVkqbSFlP7ot7G9t4ZdvIFczxjVQ/0QVhZKs5JoXYIlcGbf0WcPPldCQOqLwPA+42D+R22xry85L2N/aYq9kKhJEBk2IrUxNfN+e64pIwq5vS0jERPiuLdQxJdksE0lGOJlxR88y54kDU4MpIbHiHLoTX8RsjhO/AKkCBJnS4hclLc+JHOegrUh43iYbAohdjeXaIjpLJaQNrX4F9idPHqQeEcXzFYKWIrIKIemLAXbO8wqMh2oWswyh+gFKDYZY3c+LiJQpy0BMs7Xr8fRDZWxnYlYZBLMNhV8rUInQC4S2Cc8NMDHp4LLgZ9BajSmSYZ732DdzlsKEV7mNmUCOs7qCHnutLONlmYuEj3NAzmUoPNxWGraJyp4dPCCSF0TjQ5JoMIyzVEwmoFE48SNN4ccE6JDPGhVAkmMzLpmSC4ROVK70MgtRcxePLFHSgrQ9dnDORU7Au80aJmSSVymwcc6Ts5iN8wpipiF1gjsHVFuxV0LYhXHjcU74YQZy5EIlEX6p/PLCMOOhSnvsKBOmkSf8GFBNiwjTxqqX2onClREFQcQYFFzkMSEuZh/UmFlhc4hRYEsu5zHqS4iZhQs7VhcxSzJIzugvzVOh2LiyVkm3sVSrMlUz6XE5UdIa8csKiQxfPh6jo5jtxuxRzJ7EbDiI2XAUs+FuzIaPYjZ8ErPRIGajUcxGuzEbPXJgjZ54XPMawW0AhiOHZfvlYBf17vfCkGSjwjS1Dp51dPCwx7a2amnCtp9++ulEXp5Ixk4iFK6TaJ+dRHWXkyh231Bn4reh/32BP3ZGj/3POf58NHrif86o63DX/8zw52h4Iq/8gidyRJBYXpTXQIGf7xQC/8szEbbRotgW9Bk2oiKKwwekVQce/HDV3ssO7kVIYQXPzfrthB73aEcNSEub2sVNEbuu3xF9vkfbacODX0hNuk+kVlufgsATFKOl3e/1/MmyfvNu2Xuz9xY4n7f1R7h1VE1HqJrW77/WXvcICYswfR4mHvfIACDNvB4PvsM9wkIXos/DwRPEAR5K6xGAX+/R7lvg4Ad/wrtvg93t4d72aDDa7WAA70auQ1Fsp+n2fD6/C+yhzeOXR5MnWKjOssNb6USrYsX1g24HTS9vE9HfwWT/TzTUx8GGhRTvfXSxCBZLfeNrW9lWpXz+wLipwtDaOMP+jWk2b4FJnxAOuv0mmRKJBx77BJNsjBe8HuJgmzDZT9N+C5PYmKbbRbG90Ig/twnxrcai6KVpb6HnEnVcY8HSNGbLzSvb05QVRbGm2bV3mvtFsbyLXlF42Mj4+hqFxNts6+XEd/i9RKWRiO7C14oReg6UzGltus6tlqOFwyYT0n/wTMUWOmiYVjnXcIH3UiOUdL3vXsaCiDWWPd1j6QpIXgKHCvbVG2+9P/Tsj1voToAtN49b2hlOcsCSylhVMA1TuGAltxa0pMnOeS5STle5bWqAC16UeAXo//nkJP2Xf+6TAwLv+JYhJVgqpgL9QP0/Hx9s//f7FT2qsgSdcAMsB1zJxAxs0mPHGeRl44qazWa92Y5JMqVy54f6YDRM3L+navzhlMAte9yUD1ft1LFG68KPrLN43zdgOxjjhoWRK678xGMkQ8MBnbb+vnPNcet73KMTZwEk/Oi8J/j5+CQqOBkkyMrQ/K1sBvokel+PcZd8SG8Y+/4WwpqJFHI+hnz5060FrW7O+VxVXr6DU6u7Vc/RLbzhh0LI2m9B2xnErY/8YuGj+3a1Qr4dQtrSGY6cIJ6BAiwXJnhuuuhsj/auLXI4SgDyYY6BhQHoHg7a43OloAbsdmLgNJGn3Q1LYD9GHWu3YljthhU6hGkjBucohBRFVdT+0Uk9a0BZ4W2PNr5wJHrdwwpt6i6twC9uWAGdkesXOJFD8mME/8c1lqnvcY90xQJI14vxp2iRzjl9RwfszQIYttUWwBXHMnZ1B3ItfGa99PXYGzze0CfrBqGXLUmgtOiR+1zRrEG+9QlFPqu2H24957V73SPuWwHWb8yBvt9dnz6fxKTt3X9BjNoB+9bM6pySBZ9ec3Onz/eIPT08S06Ira1DDROR562QIgtNIbKDIR3IofBhLx9MxKOOHOFCWoXXghC2HcOE4qWWwigZbwKO7pxxJG3HRFmCEWelWcaNs7/J4EdSYcDWZlAsuOIDaI07XsgAN1JleHf3xtHXgzadho/2OnTaG3ToNFhHp2uujUhBUyppal8bNJ9ack0kDu3LR8ui2IZJkaQvJcZWwu3BCYOq8pTl4oyiKqkwZc7nSNUgpR7KxXDd80wp0/TwEbOv/Ib3u5E4pTEY97BXByZu4/BaIEaLFsPHOy1S7D150pWYjsDc5v7erLdMhcFuf7jXdx6t1Q6txg2zXglfYwkwdht6kZ/oVvSing3BNm6nT3U73Q2779zlrXv4eNQ5LHYGn3pY3Pnlui01N1yr7+LyfGe32La43fL++rvdIz+f+3Z/C4t6+HinzYWPh3fgQl1jOH8uJy7Zx3fGe+yujONVDHgL6/hak/izGbQN7G/OpHt3Y0kPBx0L7euOgfb1qM2Ue3u3Ysr2ogucdRKJ//rmzQ+zwR+/naqDg4OD12/fZS/fTQ8ODgr83ev1Vl6iVlGblkHL1WcE+nOZzvg1q/R6PUQhplbu0/B+Kaf/6sbH68f0TmQUR6rEnE2h5Ks02o/I6IZgg0cx3SPA2G9UOo/2LyOfI4R/+gwcHNr/YDBR9DIySQYFx7/C/QNTSzG1M4opzQW0ieKIgsaYZ4okjfYjNf4ACa5WagTHCjA4B43bvwy9XG5kFHuLK9qP3BajOPJu/bqpziot00l0FRa8bqq6pZnK0B/1hQTnwfTDT5zmNQ69Wkit/aSZXrRmoL0VcKSeK/xm4QWfm9a8zusXLWb04hgU9sSPYimfG1QalXEHXMLzpMrRLoSLUuh5HRsl47DFHzW89Uo1vMO9q4boDUhcaz6P4khYKNrta5hAq4+nXAIKMUMJKh879oOCMcAffAMGbojwvPhoKD4oYGMgopeZkh89fjjaGY6GO8MRzuCzDD52jpAMjVN8UOPTTxKEFM5xvL9ffzop3dfltbu8eYBpfJAGu2u7yUeNGeWE9W4Sk9CfMM+ncLM8HK3LU26lR5qMLlu8LIHrHqULf3ImelfE6gO+d4NAXcXRxc2buWCJ2g5J0OyrHCbWBS1ZorQE/bCdCXFvNjfa3b2Ko/nN25t/kdt7jMSb3by7Hyl7vMms/3vAuvPkKo6ym2H9rs5v/zsCu/voqjngF+yX07FK56dBb13d1DGcVdhvovIUNNpEy/qqUTWoYfBdxuniUTNWKgcuVyiaTmKzf0GD9je6oL1PZpYBXmMas5xmb2x+77B20GKyNCzkXwiD5rKu4CTqsVeT1g2CLPrF3OrQl/KcpWIPaL1TU5Eaf9D3vxFHD9pvSNDj26RABRCoM7NQlDk9wpih23hM8cS0x+r/yPisMYkAhBM7LHzzUfHc5X3Qgn5Q9wUD8+Zrjz3nss5i72aLs8vLmg2IO66u2OUlUhX0KZ77V1dx04BrdRroaHctGhIQ551RdRM0A+u21lBnZZ2ileUa/HnfBkBMpZDT00r7edAYvbrqdRhyAXBynnscQFrzmZjKFbuuTSai9K2xv4RszwE4yf8bvD8tn30nVoDytF8+e1o++xHfK5XgZM+hZyJk6iR/BnneY0+N1UpOny2g4Gnft68mpYZzATMSXKJqM8sibuuJeh6mP6GibognDEt0lQieU8KTVgmEGA3STeIl3lgoDQbFhKWR7kkJXQn4VANFgwgWXll6n0W3w7DgU84yDZN/e7CA0wfP3iLo+DTvaZ8/871fObdExs+BcTlntHHyoSjt/HCTSpOaTHKuxcRfRWNW5oDJWXhT5YmL6TmMBjiOMi7PTPx0rJ8dAS/YmxIkQvDrX/+GPYJOfyXf6BT0LZT6q4mLHir2APXYg9glihG7C22sV9VOE3oOcXCtER3/UACDji9r1W+qscFeMszXqFarxXQKGFPzPWiwf3YDPMncoUFQ8UmIIpTIPKoyATxksHAhpACbcPwh5LTr9Wlhh8J57b33Vml1ie903hwd3gKX5JLadoLi/DFul24O9uboEJ/61eTusXemxkRALe90YegJYOeCh+dAtWU/d8k14OIqXi+2Y5A9/8humy0DlAqzEqLYHeqo4eqHsUsTN29BkUSqshjTFP6FE0lZB48ERY3II1XdhitvwCRn04pymS2Kbzg1KZ2xeaonpLG6colFLK10eJ3o2cKpCWMaPAWsYKfW/DEDadxwzibcWNAxq6RAzOsKvZT1lHBRghYgE1iJAg0Odag6bj6iuu/e3v3wvX8BHPYQhHKMEugmhpRVJXENSUL9HjNQbnHrK+1Br75vBhBtN3o16V2tJWijJKo4padceg3q7qPoTx1DxnPX1asKDMkhPCjhvZV3/1//+rcWXGudIsuAuRV4mmKy7Q0QkmvaMTzmk2koUQOqLkQ4H+g/LF4BEDoSmtNCpbUgmdvz+CGl55paL/ocgTo/wVRJhsdWrW9NHHSs8U4FQ15oclVTkkGJ+4ULYWzrRWHI+1/WDz8A4jFpwUCXUJRq5Hk5bwt4kzehFqaj64HovkatL0FLssArq041FELe7pxqe/2tqhVBZVXBrUhYmMr0um+MXWg5yHXBvgqgITeeC6UfrhFVnO5UyQROhTyFc9C3uN6/rvMUySc5BjsDkG3YApLccda8A53h0/0OTlqnE712bkOJzsnSJYes8lx1gQpvtkPCfeAHd5RQLYFijElKLs0FRY0UR7ilLbnCvhRfms/32HjSviBX03Aw+Ef2pO0MvhxP2u7gC/KkPUFgfQz0ZgW0zr5ZqTtCoPP6AR8UuFBHrvT1PTGwSE46F4lfheBGHEZX7r/G+Rf0/g0OQecxbCKZ/joTNkNoGA0G+L8uOV90chjRuK0SNBYnVZ7P/ymKbx9GvZ4Grnm1k/I6rZ59EKNfLpLz0WHkQ3Rda/ojz6JPirPhmMUo2xqb/tqteIGodI4leHAv27U9RdO2aCxkLiScBgKepio5DbvHfgUY0z3lbgVDTW66ZXdpfcPykWPM3VVc9FYVYDMyP3HeGXpvaveG1XPGp1xIhjKu75CpQOubxO/jILsOBbuDwemwRsLeMhJeSXrxRPWmjtQZyN93p+3lrVseQb0o8kYHRsJ1ou9RZ7PtdrdJA0mlhZ1H+8eX0cU2L8W2+75//P7qPbKgzRRmYpTKEMTcZtF+1F9KzDCgzymwfnzp5KYWBcNliulkS+cDL0X/fNgbRlfx4piV58k1/aHa/tghxvKpkNObxr1vcPQW6ehI1cFUo6dK8UdAReUJ0e4VRwL5JwOOlyNEPbLHD006y8tA5JBosip3pCHmYjZISAbp5HcsnusrMjZWJ2wM91qpEsch64ESGeo8hlWpCfXWQ7JBnWvQSh9oZQ80CQGdfAAK8bci/MeNTNTB9HADGJLpPNrdJRvz8ZCMsZ0nZOfsProiLm6iZ1HUjZDRW4TFOM/nhS26UYuNK/4fyBW/4In3zNO4k13OZscv6pu6fsLAhbVfruMcW/SNrfVTrXFT+SUX3DE1IKu8IHsd58MKuQvGc1fqMKsRpW5nQFK3OyCpezLo2O1+h80MjfVNJnZtYZMZ3bai0VR+j6pSyIkiPevVQ6ALnYOkp5duW5AnqqiLcW1ttUhZj9raqvWnY0dM+HxTaVaqGehJ5ap7TXK4EOjQwWFQ0LcmRg68yMGYHJ85WJhSvUl6tI+ec++bTXjJxyIXeNC7p0hOMBpbwfTYj02U/YF2NQzOIUf7oHaJYb3KYNvNlD6bYLQ+ZpyNsVAfOkVBZlwmzv/qDi3yI6JDCH3bpRYG6w9qhFo42JS0GqWh4JJPSU7jNt+zFHJUW4ZpNcbwhFF55aTNcpEr7RL0aEOUCkxIfHlR4ie6MqKy15Ah7557L7yJXRTEnUe+guUYA04lwiISIGdkJXOFxSYxcFXlOSuVdcEkvJm2YcThVnNp0Cz2OYGeBjXCvIMcjH+m9c4AUvh7Ic9cgbRtdlzz1Y8wNsJCt3zCovw97I75VtjvqjGWX1RGWKXnzeipsFk1JsuiPUn9w830bahX2rIbmjlSlZgVd2yVmD5Weui/BYscYvoHh6/IMn3Ifv3L/7DvgWvJMjVz3JpUGvJ5UxqVSocS5R3aasOSQjCorBHjiWM+f8YEDP6YcfvrX/7XsNcwQ1e0EymXSnxYjXORsKOQdrG1tR9qtjapGJ3n3u4RHsbFOCvd6FzIsx47kHPy5DcnDrbTuM426JRrlXnlmDuqpM/5dmv2GojId2wgPwcKEWDFvzEwSIWLNmpVTd1qbWD85rrvEXFvB2nKyoU3ieinbsBxrlgK83Hnk8WKrCueMXbeC3ZzFECmVDPU7LNU84lt5o8XHirSebfUFN44BnTEfpqaJE4S/Y7rVpeZvWDzdvWthglQIm638i4vhWen48CWrFuX5OPZ2vlk6Ahv3fbR+F4ZycGKqebN5C3oc5GEK/oaie5T534UR7lIwDuI/Pl18O3h9+x8pzeI4tZN4hbC3f/+1fOXr9++RGBQkTqEDXuD3oD82MrYgsvWSgu1jRfPtlbW+6YU8qYU8qYU8qYU8qYU8hdTrHdTCnlTCnlTCnlTCnlTCnlTCvm3Q8KmFPKmFPKmFPKmFPKmFPKmFPKmFPKmFPKmFPKmFPKmFPKmFPL90RWbUsj3pcLsphTy78GBm1LIm1LIm1LIm1LIm1LIm1LIm1LIm1LIm1LIm1LIm1LIm1LIm1LIm1LIa0oht55e9MucC9l6k+re4R0vFkh+H0cZPtTbP44uL3GZd/iMBpt/ruihx/H7ODrnWmB6Dr3xi8OTNHzscQb4Yum5yzbaPsL1YyfblGC78LQR39S5EQfE0Nf2bb8lPHzz9iiKo1DWrVApPaLmM3wcwmfufUzrBQm1XUY5l9OKXp9Ebs4rV3Qk6z7BO6MneP6P1hMWfHDWQNh9m+e2gf/iplYOuLx0z/vohZfr7z6tHeERG3oj/d5fXV39HwLdNNg=","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),m=t.n(p),u=(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:"eJztPGtzHDdyfwWZSpUsZrgvkpLMKKqjJcVWzpFYFhXXhdTR2JneHYgzwBjAcLlmseo+3D/Ip3y9n+ZfkuoGMI99kJRE+6jL+oPMxeDR6Bca3Y2+jCyfmmj/OHqhkqoAaU30Po5SMIkWpRVKRvvRUQbsuQZugYVe7ODwFeN5rmaGVQa0YVaxKUjQ2EvCjKVhPjaes1Krc5EKOWUpt5zNhM3YmBt4tMtAJiqFlE1EDr0TeSKPRLnP3pW54imbq0qzwxf/Xs+Gy2Db8dbWCxhXU/bu1dbW+68ya0uz3+/zsuypEqQRU5nzseklquin2LFMJw9jNstAA87KEi4ZcCPyOeNpymYinYI1MbMZSJaocs4SpXQqJLdgYlbyKTBZFWPQJmZcpqxQGpiQjDMNPJ1vW7VdGWD/8fbNazZRuuC2xw7zysT1cqnQkNh87qa3GdS7emACNozVQk5jVvAzxJaw7OdKJGe4bQMyxf/jwIPDV4Srra23VVkqbSFlP7ot7G9t4ZdvIFczxjVQ/0QVhZKs5JoXYIlcGbf0WcPPldCQOqLwPA+42D+R22xry85L2N/aYq9kKhJEBk2IrUxNfN+e64pIwq5vS0jERPiuLdQxJdksE0lGOJlxR88y54kDU4MpIbHiHLoTX8RsjhO/AKkCBJnS4hclLc+JHOegrUh43iYbAohdjeXaIjpLJaQNrX4F9idPHqQeEcXzFYKWIrIKIemLAXbO8wqMh2oWswyh+gFKDYZY3c+LiJQpy0BMs7Xr8fRDZWxnYlYZBLMNhV8rUInQC4S2Cc8NMDHp4LLgZ9BajSmSYZ732DdzlsKEV7mNmUCOs7qCHnutLONlmYuEj3NAzmUoPNxWGraJyp4dPCCSF0TjQ5JoMIyzVEwmoFE48SNN4ccE6JDPGhVAkmMzLpmSC4ROVK70MgtRcxePLFHSgrQ9dnDORU7Au80aJmSSVymwcc6Ts5iN8wpipiF1gjsHVFuxV0LYhXHjcU74YQZy5EIlEX6p/PLCMOOhSnvsKBOmkSf8GFBNiwjTxqqX2onClREFQcQYFFzkMSEuZh/UmFlhc4hRYEsu5zHqS4iZhQs7VhcxSzJIzugvzVOh2LiyVkm3sVSrMlUz6XE5UdIa8csKiQxfPh6jo5jtxuxRzJ7EbDiI2XAUs+FuzIaPYjZ8ErPRIGajUcxGuzEbPXJgjZ54XPMawW0AhiOHZfvlYBf17vfCkGSjwjS1Dp51dPCwx7a2amnCtp9++ulEXp5Ixk4iFK6TaJ+dRHWXkyh231Bn4reh/32BP3ZGj/3POf58NHrif86o63DX/8zw52h4Iq/8gidyRJBYXpTXQIGf7xQC/8szEbbRotgW9Bk2oiKKwwekVQce/HDV3ssO7kVIYQXPzfrthB73aEcNSEub2sVNEbuu3xF9vkfbacODX0hNuk+kVlufgsATFKOl3e/1/MmyfvNu2Xuz9xY4n7f1R7h1VE1HqJrW77/WXvcICYswfR4mHvfIACDNvB4PvsM9wkIXos/DwRPEAR5K6xGAX+/R7lvg4Ad/wrtvg93t4d72aDDa7WAA70auQ1Fsp+n2fD6/C+yhzeOXR5MnWKjOssNb6USrYsX1g24HTS9vE9HfwWT/TzTUx8GGhRTvfXSxCBZLfeNrW9lWpXz+wLipwtDaOMP+jWk2b4FJnxAOuv0mmRKJBx77BJNsjBe8HuJgmzDZT9N+C5PYmKbbRbG90Ig/twnxrcai6KVpb6HnEnVcY8HSNGbLzSvb05QVRbGm2bV3mvtFsbyLXlF42Mj4+hqFxNts6+XEd/i9RKWRiO7C14oReg6UzGltus6tlqOFwyYT0n/wTMUWOmiYVjnXcIH3UiOUdL3vXsaCiDWWPd1j6QpIXgKHCvbVG2+9P/Tsj1voToAtN49b2hlOcsCSylhVMA1TuGAltxa0pMnOeS5STle5bWqAC16UeAXo//nkJP2Xf+6TAwLv+JYhJVgqpgL9QP0/Hx9s//f7FT2qsgSdcAMsB1zJxAxs0mPHGeRl44qazWa92Y5JMqVy54f6YDRM3L+navzhlMAte9yUD1ft1LFG68KPrLN43zdgOxjjhoWRK678xGMkQ8MBnbb+vnPNcet73KMTZwEk/Oi8J/j5+CQqOBkkyMrQ/K1sBvokel+PcZd8SG8Y+/4WwpqJFHI+hnz5060FrW7O+VxVXr6DU6u7Vc/RLbzhh0LI2m9B2xnErY/8YuGj+3a1Qr4dQtrSGY6cIJ6BAiwXJnhuuuhsj/auLXI4SgDyYY6BhQHoHg7a43OloAbsdmLgNJGn3Q1LYD9GHWu3YljthhU6hGkjBucohBRFVdT+0Uk9a0BZ4W2PNr5wJHrdwwpt6i6twC9uWAGdkesXOJFD8mME/8c1lqnvcY90xQJI14vxp2iRzjl9RwfszQIYttUWwBXHMnZ1B3ItfGa99PXYGzze0CfrBqGXLUmgtOiR+1zRrEG+9QlFPqu2H24957V73SPuWwHWb8yBvt9dnz6fxKTt3X9BjNoB+9bM6pySBZ9ec3Onz/eIPT08S06Ira1DDROR562QIgtNIbKDIR3IofBhLx9MxKOOHOFCWoXXghC2HcOE4qWWwigZbwKO7pxxJG3HRFmCEWelWcaNs7/J4EdSYcDWZlAsuOIDaI07XsgAN1JleHf3xtHXgzadho/2OnTaG3ToNFhHp2uujUhBUyppal8bNJ9ack0kDu3LR8ui2IZJkaQvJcZWwu3BCYOq8pTl4oyiKqkwZc7nSNUgpR7KxXDd80wp0/TwEbOv/Ib3u5E4pTEY97BXByZu4/BaIEaLFsPHOy1S7D150pWYjsDc5v7erLdMhcFuf7jXdx6t1Q6txg2zXglfYwkwdht6kZ/oVvSing3BNm6nT3U73Q2779zlrXv4eNQ5LHYGn3pY3Pnlui01N1yr7+LyfGe32La43fL++rvdIz+f+3Z/C4t6+HinzYWPh3fgQl1jOH8uJy7Zx3fGe+yujONVDHgL6/hak/izGbQN7G/OpHt3Y0kPBx0L7euOgfb1qM2Ue3u3Ysr2ogucdRKJ//rmzQ+zwR+/naqDg4OD12/fZS/fTQ8ODgr83ev1Vl6iVlGblkHL1WcE+nOZzvg1q/R6PUQhplbu0/B+Kaf/6sbH68f0TmQUR6rEnE2h5Ks02o/I6IZgg0cx3SPA2G9UOo/2LyOfI4R/+gwcHNr/YDBR9DIySQYFx7/C/QNTSzG1M4opzQW0ieKIgsaYZ4okjfYjNf4ACa5WagTHCjA4B43bvwy9XG5kFHuLK9qP3BajOPJu/bqpziot00l0FRa8bqq6pZnK0B/1hQTnwfTDT5zmNQ69Wkit/aSZXrRmoL0VcKSeK/xm4QWfm9a8zusXLWb04hgU9sSPYimfG1QalXEHXMLzpMrRLoSLUuh5HRsl47DFHzW89Uo1vMO9q4boDUhcaz6P4khYKNrta5hAq4+nXAIKMUMJKh879oOCMcAffAMGbojwvPhoKD4oYGMgopeZkh89fjjaGY6GO8MRzuCzDD52jpAMjVN8UOPTTxKEFM5xvL9ffzop3dfltbu8eYBpfJAGu2u7yUeNGeWE9W4Sk9CfMM+ncLM8HK3LU26lR5qMLlu8LIHrHqULf3ImelfE6gO+d4NAXcXRxc2buWCJ2g5J0OyrHCbWBS1ZorQE/bCdCXFvNjfa3b2Ko/nN25t/kdt7jMSb3by7Hyl7vMms/3vAuvPkKo6ym2H9rs5v/zsCu/voqjngF+yX07FK56dBb13d1DGcVdhvovIUNNpEy/qqUTWoYfBdxuniUTNWKgcuVyiaTmKzf0GD9je6oL1PZpYBXmMas5xmb2x+77B20GKyNCzkXwiD5rKu4CTqsVeT1g2CLPrF3OrQl/KcpWIPaL1TU5Eaf9D3vxFHD9pvSNDj26RABRCoM7NQlDk9wpih23hM8cS0x+r/yPisMYkAhBM7LHzzUfHc5X3Qgn5Q9wUD8+Zrjz3nss5i72aLs8vLmg2IO66u2OUlUhX0KZ77V1dx04BrdRroaHctGhIQ551RdRM0A+u21lBnZZ2ileUa/HnfBkBMpZDT00r7edAYvbrqdRhyAXBynnscQFrzmZjKFbuuTSai9K2xv4RszwE4yf8bvD8tn30nVoDytF8+e1o++xHfK5XgZM+hZyJk6iR/BnneY0+N1UpOny2g4Gnft68mpYZzATMSXKJqM8sibuuJeh6mP6GibognDEt0lQieU8KTVgmEGA3STeIl3lgoDQbFhKWR7kkJXQn4VANFgwgWXll6n0W3w7DgU84yDZN/e7CA0wfP3iLo+DTvaZ8/871fObdExs+BcTlntHHyoSjt/HCTSpOaTHKuxcRfRWNW5oDJWXhT5YmL6TmMBjiOMi7PTPx0rJ8dAS/YmxIkQvDrX/+GPYJOfyXf6BT0LZT6q4mLHir2APXYg9glihG7C22sV9VOE3oOcXCtER3/UACDji9r1W+qscFeMszXqFarxXQKGFPzPWiwf3YDPMncoUFQ8UmIIpTIPKoyATxksHAhpACbcPwh5LTr9Wlhh8J57b33Vml1ie903hwd3gKX5JLadoLi/DFul24O9uboEJ/61eTusXemxkRALe90YegJYOeCh+dAtWU/d8k14OIqXi+2Y5A9/8humy0DlAqzEqLYHeqo4eqHsUsTN29BkUSqshjTFP6FE0lZB48ERY3II1XdhitvwCRn04pymS2Kbzg1KZ2xeaonpLG6colFLK10eJ3o2cKpCWMaPAWsYKfW/DEDadxwzibcWNAxq6RAzOsKvZT1lHBRghYgE1iJAg0Odag6bj6iuu/e3v3wvX8BHPYQhHKMEugmhpRVJXENSUL9HjNQbnHrK+1Br75vBhBtN3o16V2tJWijJKo4padceg3q7qPoTx1DxnPX1asKDMkhPCjhvZV3/1//+rcWXGudIsuAuRV4mmKy7Q0QkmvaMTzmk2koUQOqLkQ4H+g/LF4BEDoSmtNCpbUgmdvz+CGl55paL/ocgTo/wVRJhsdWrW9NHHSs8U4FQ15oclVTkkGJ+4ULYWzrRWHI+1/WDz8A4jFpwUCXUJRq5Hk5bwt4kzehFqaj64HovkatL0FLssArq041FELe7pxqe/2tqhVBZVXBrUhYmMr0um+MXWg5yHXBvgqgITeeC6UfrhFVnO5UyQROhTyFc9C3uN6/rvMUySc5BjsDkG3YApLccda8A53h0/0OTlqnE712bkOJzsnSJYes8lx1gQpvtkPCfeAHd5RQLYFijElKLs0FRY0UR7ilLbnCvhRfms/32HjSviBX03Aw+Ef2pO0MvhxP2u7gC/KkPUFgfQz0ZgW0zr5ZqTtCoPP6AR8UuFBHrvT1PTGwSE46F4lfheBGHEZX7r/G+Rf0/g0OQecxbCKZ/joTNkNoGA0G+L8uOV90chjRuK0SNBYnVZ7P/ymKbx9GvZ4Grnm1k/I6rZ59EKNfLpLz0WHkQ3Rda/ojz6JPirPhmMUo2xqb/tqteIGodI4leHAv27U9RdO2aCxkLiScBgKepio5DbvHfgUY0z3lbgVDTW66ZXdpfcPykWPM3VVc9FYVYDMyP3HeGXpvaveG1XPGp1xIhjKu75CpQOubxO/jILsOBbuDwemwRsLeMhJeSXrxRPWmjtQZyN93p+3lrVseQb0o8kYHRsJ1ou9RZ7PtdrdJA0mlhZ1H+8eX0cU2L8W2+75//P7qPbKgzRRmYpTKEMTcZtF+1F9KzDCgzymwfnzp5KYWBcNliulkS+cDL0X/fNgbRlfx4piV58k1/aHa/tghxvKpkNObxr1vcPQW6ehI1cFUo6dK8UdAReUJ0e4VRwL5JwOOlyNEPbLHD006y8tA5JBosip3pCHmYjZISAbp5HcsnusrMjZWJ2wM91qpEsch64ESGeo8hlWpCfXWQ7JBnWvQSh9oZQ80CQGdfAAK8bci/MeNTNTB9HADGJLpPNrdJRvz8ZCMsZ0nZOfsProiLm6iZ1HUjZDRW4TFOM/nhS26UYuNK/4fyBW/4In3zNO4k13OZscv6pu6fsLAhbVfruMcW/SNrfVTrXFT+SUX3DE1IKu8IHsd58MKuQvGc1fqMKsRpW5nQFK3OyCpezLo2O1+h80MjfVNJnZtYZMZ3bai0VR+j6pSyIkiPevVQ6ALnYOkp5duW5AnqqiLcW1ttUhZj9raqvWnY0dM+HxTaVaqGehJ5ap7TXK4EOjQwWFQ0LcmRg68yMGYHJ85WJhSvUl6tI+ec++bTXjJxyIXeNC7p0hOMBpbwfTYj02U/YF2NQzOIUf7oHaJYb3KYNvNlD6bYLQ+ZpyNsVAfOkVBZlwmzv/qDi3yI6JDCH3bpRYG6w9qhFo42JS0GqWh4JJPSU7jNt+zFHJUW4ZpNcbwhFF55aTNcpEr7RL0aEOUCkxIfHlR4ie6MqKy15Ah7557L7yJXRTEnUe+guUYA04lwiISIGdkJXOFxSYxcFXlOSuVdcEkvJm2YcThVnNp0Cz2OYGeBjXCvIMcjH+m9c4AUvh7Ic9cgbRtdlzz1Y8wNsJCt3zCovw97I75VtjvqjGWX1RGWKXnzeipsFk1JsuiPUn9w830bahX2rIbmjlSlZgVd2yVmD5Weui/BYscYvoHh6/IMn3Ifv3L/7DvgWvJMjVz3JpUGvJ5UxqVSocS5R3aasOSQjCorBHjiWM+f8YEDP6YcfvrX/7XsNcwQ1e0EymXSnxYjXORsKOQdrG1tR9qtjapGJ3n3u4RHsbFOCvd6FzIsx47kHPy5DcnDrbTuM426JRrlXnlmDuqpM/5dmv2GojId2wgPwcKEWDFvzEwSIWLNmpVTd1qbWD85rrvEXFvB2nKyoU3ieinbsBxrlgK83Hnk8WKrCueMXbeC3ZzFECmVDPU7LNU84lt5o8XHirSebfUFN44BnTEfpqaJE4S/Y7rVpeZvWDzdvWthglQIm638i4vhWen48CWrFuX5OPZ2vlk6Ahv3fbR+F4ZycGKqebN5C3oc5GEK/oaie5T534UR7lIwDuI/Pl18O3h9+x8pzeI4tZN4hbC3f/+1fOXr9++RGBQkTqEDXuD3oD82MrYgsvWSgu1jRfPtlbW+6YU8qYU8qYU8qYU8qYU8hdTrHdTCnlTCnlTCnlTCnlTCnlTCvm3Q8KmFPKmFPKmFPKmFPKmFPKmFPKmFPKmFPKmFPKmFPKmFPKmFPL90RWbUsj3pcLsphTy78GBm1LIm1LIm1LIm1LIm1LIm1LIm1LIm1LIm1LIm1LIm1LIm1LIm1LIm1LIa0oht55e9MucC9l6k+re4R0vFkh+H0cZPtTbP44uL3GZd/iMBpt/ruihx/H7ODrnWmB6Dr3xi8OTNHzscQb4Yum5yzbaPsL1YyfblGC78LQR39S5EQfE0Nf2bb8lPHzz9iiKo1DWrVApPaLmM3wcwmfufUzrBQm1XUY5l9OKXp9Ebs4rV3Qk6z7BO6MneP6P1hMWfHDWQNh9m+e2gf/iplYOuLx0z/vohZfr7z6tHeERG3oj/d5fXV39HwLdNNg=",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,y={},f=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(u.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:"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.p,{children:[(0,i.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,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)(u.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},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",description:"Allowed values - signature, stamp.",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)(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"},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/4d139b56.6f4eebad.js b/assets/js/4d139b56.6f4eebad.js deleted file mode 100644 index d6fec29f8..000000000 --- a/assets/js/4d139b56.6f4eebad.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7075],{7988:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>m,contentTitle:()=>b,default:()=>Q,frontMatter:()=>P,metadata:()=>i,toc:()=>v});const i=JSON.parse('{"id":"API-docs/v1.1/getcredits","title":"Get your API credits","description":"The Get Credits API returns details about the credits available to your account:","source":"@site/docs/API-docs/v1.1/getcredits.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getcredits","permalink":"/docs/API-docs/v1.1/getcredits","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getcredits","title":"Get your API credits","description":"The Get Credits API returns details about the credits available to your account:","sidebar_label":"Get your API credits","hide_title":true,"hide_table_of_contents":true,"api":"eJztV0tvJLcR/isVXmIPWjPaxL7MyYohKEIWXsHSQgdJWLDZNdO02EWaj3lgMIAPQX5Acso1P21/iVFkT0+PdhcbI4aBAL7sjsh6fPVifb0TUS6DmD+ItwG9eKpEg0F57aK2JObirkW4wgjfemx0DHBxcw0eY/IUoMEotQkga5sixBZB9VJyJbWRtUGIFrY2eZBK2URx/kiPNJk4I+ldLzyfTAbrmpRJDTaw1rEtiiHVAx5gvSnctRgQPAaMIIvjEKWPYBeAUrVAuIZaG6NpCWqrDE4fCeByIztncA7Xi2KarYHzdqUbDPDq/HzA79BDZym2IKlhYUBq2EYOki0WhF+fg8dOatK0rIrRWhpJqocXOH42XGCyhQEpmyLcxBFCTo1sGvvR3LjkVSsDNhDQSS8jmi0svO3gFmPUtAzw/h//zAW6s89I+a+/pC3ceOx06g6GpnDRNGeWhmAbC2Qj4MZpjzlg6REsmS0kdmc5HGlMyddQYo+gLIXUYTMtVY02SjOGzs0TUsfRntZ8Msl+XkQ7mXBtdQCPjtNHnL+WeyhKMzhWyXukaLajLltYz1injyQqYR16ye1y3Yi5WGLsNUUlPAZnKWAQ85340/k5/3fa77dJKQxhkQwMdkQllKWIFFleOme0yhezHwIr7URQLXaSf8WtQzEXtv4BVRSVcJ7NRF1cjnMwkqbU1ehFJbC0qJif7ytxkpvPSp8k/zPSLK4j/xa9wjuPQez3fPPVx9MymkLuloVN1Px6iUHvrR+Jheg1LceoPwHhDxl1wf3Vh7j5URsL/5aAX/oep12T0YTvDv34jsEfwvj6wzCuaSWNbo7D/dtGMnYfi3uGuukM65HsSkhZKN+Lk1DH5yXIgCp5Hbdi/rATmzPp9Fm5nz887Z8q0WFsbT+9DFjGVszF7GSWA/oV+pBNJG/EXLQxujCfzYKkprabqXVIQS/JyDpMle1m0unZ6tX0ldhXL3Wkc79IHtPZL1UJUS41LT+n93RMzy2XsFTpJElDraTTf8OtqA41GEtVQnPrtCgb9LlemhY2K/eVeeOQbvWScl2z85fb/x6Nsl3e4vwQTyYHlfd//8+gNZlAY1XqkGLuwLwN3vB+tWv0/JLyW78wuNH8VrMadvku5NUaLQSUncEQzBY0RVzydoNGLzU//JynvMmlk7U2mhuXxQ7M4tj7YQr3LcYWPV/9kbcZNLhCw/0OMkXbSd6UA15YW/+8MHYdKpBQp6AJQwCkVpJiwUMlKrAeJAFSRO+8Dkw5PKPWBZul6KWK0EmSS2TbFYyT1aDR3K7gbZ1ChGBNypCBOZT12AxUiRCbkJN4uXF8BXyqbOc8ttw2K4RlYs5SgbINQshzyiFQAzWGCI6xaIWZfyQyVj3nAi4Sr3HLz4aWhvfyGCOrRy8pLKzvCpZDDYaEOW95P2Lod/7bgFzh15qeeeU/0hk8DH11j3XQEZ++OIzAer3+oPW/PNW50vGvqYbv0dmgo/Xbo/ZSxzbVeVzGRoY/iqUrJMz9MxqGo43GqvDh9PHprEXjZgcuNbu4uc4v7Zfw/qd/wWuUnqC169KtKnlmX8uDK85cqXxJ2/BQZmYiU2w546o0n8cfE4Z4yOB9K+P7n/4d4Dtcg6Z+pDiUyeQm1UYruMPOGRkxTCZzpnHsMh7OILYygpIENUJoJbfSSkuQ4Iq20fQ8hQvKdM4X4srNwOdZ7yQMzstQ7gC1LBSwELHe5/SIiM+7gGaFgW3xuqsR+I3mjm69TcvibQymD87jQhsD97pZYsyxXTQNuP54XY454SM4uOCBiC1uMwNlkjiFmxcq+SY5Zz2j0AX8whpj11wApMZZTTHMofFyEY/2q2OjK06ztvSRo5JCOaSj6s0MJSmT2Ec8nBZ2+uIhP31vPS7Qs8Mc9rEuTvft9HBoS+Bu/V/amlc0v1pSZQbBXzGmbJRvXtrJ2xx9F94sbtGvtMJ+q31iomdZeCYqYbRCCjhiCRdXN69h9efpuahG6/G/GO7Z6+tvL7+7vWQw/JCWhL2ank/P+cjZEDtJI0/81ToM45E2nCR8dyRRv3/p/v6l+//2pduzwIibOHNG6sy781Ttes78MP7+fapEa0Pk092OH/a33uz3fPxjQs9k/KkSK+k1e8pUvDrQRybZz7jlAVYKHZPylTSpcNAX3x4nBP7q8k5UgjfgKW19zrS1/8HWD1e0Hdk+5bMFAP/L5PqjCrtdocT7/SBfrj6p0Qd4kOYcPu33+58B0iLGHQ==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get your account details","permalink":"/docs/API-docs/v1.1/get-user"},"next":{"title":"Create Contact","permalink":"/docs/API-docs/v1.1/createcontact"}}');var r=s(74848),n=s(28453),o=s(33617),a=s.n(o),d=s(17543),c=s.n(d),l=s(86013),p=s.n(l),u=s(63723),h=s.n(u),y=(s(18766),s(79329),s(9303));const P={id:"getcredits",title:"Get your API credits",description:"The Get Credits API returns details about the credits available to your account:",sidebar_label:"Get your API credits",hide_title:!0,hide_table_of_contents:!0,api:"eJztV0tvJLcR/isVXmIPWjPaxL7MyYohKEIWXsHSQgdJWLDZNdO02EWaj3lgMIAPQX5Acso1P21/iVFkT0+PdhcbI4aBAL7sjsh6fPVifb0TUS6DmD+ItwG9eKpEg0F57aK2JObirkW4wgjfemx0DHBxcw0eY/IUoMEotQkga5sixBZB9VJyJbWRtUGIFrY2eZBK2URx/kiPNJk4I+ldLzyfTAbrmpRJDTaw1rEtiiHVAx5gvSnctRgQPAaMIIvjEKWPYBeAUrVAuIZaG6NpCWqrDE4fCeByIztncA7Xi2KarYHzdqUbDPDq/HzA79BDZym2IKlhYUBq2EYOki0WhF+fg8dOatK0rIrRWhpJqocXOH42XGCyhQEpmyLcxBFCTo1sGvvR3LjkVSsDNhDQSS8jmi0svO3gFmPUtAzw/h//zAW6s89I+a+/pC3ceOx06g6GpnDRNGeWhmAbC2Qj4MZpjzlg6REsmS0kdmc5HGlMyddQYo+gLIXUYTMtVY02SjOGzs0TUsfRntZ8Msl+XkQ7mXBtdQCPjtNHnL+WeyhKMzhWyXukaLajLltYz1injyQqYR16ye1y3Yi5WGLsNUUlPAZnKWAQ85340/k5/3fa77dJKQxhkQwMdkQllKWIFFleOme0yhezHwIr7URQLXaSf8WtQzEXtv4BVRSVcJ7NRF1cjnMwkqbU1ehFJbC0qJif7ytxkpvPSp8k/zPSLK4j/xa9wjuPQez3fPPVx9MymkLuloVN1Px6iUHvrR+Jheg1LceoPwHhDxl1wf3Vh7j5URsL/5aAX/oep12T0YTvDv34jsEfwvj6wzCuaSWNbo7D/dtGMnYfi3uGuukM65HsSkhZKN+Lk1DH5yXIgCp5Hbdi/rATmzPp9Fm5nz887Z8q0WFsbT+9DFjGVszF7GSWA/oV+pBNJG/EXLQxujCfzYKkprabqXVIQS/JyDpMle1m0unZ6tX0ldhXL3Wkc79IHtPZL1UJUS41LT+n93RMzy2XsFTpJElDraTTf8OtqA41GEtVQnPrtCgb9LlemhY2K/eVeeOQbvWScl2z85fb/x6Nsl3e4vwQTyYHlfd//8+gNZlAY1XqkGLuwLwN3vB+tWv0/JLyW78wuNH8VrMadvku5NUaLQSUncEQzBY0RVzydoNGLzU//JynvMmlk7U2mhuXxQ7M4tj7YQr3LcYWPV/9kbcZNLhCw/0OMkXbSd6UA15YW/+8MHYdKpBQp6AJQwCkVpJiwUMlKrAeJAFSRO+8Dkw5PKPWBZul6KWK0EmSS2TbFYyT1aDR3K7gbZ1ChGBNypCBOZT12AxUiRCbkJN4uXF8BXyqbOc8ttw2K4RlYs5SgbINQshzyiFQAzWGCI6xaIWZfyQyVj3nAi4Sr3HLz4aWhvfyGCOrRy8pLKzvCpZDDYaEOW95P2Lod/7bgFzh15qeeeU/0hk8DH11j3XQEZ++OIzAer3+oPW/PNW50vGvqYbv0dmgo/Xbo/ZSxzbVeVzGRoY/iqUrJMz9MxqGo43GqvDh9PHprEXjZgcuNbu4uc4v7Zfw/qd/wWuUnqC169KtKnlmX8uDK85cqXxJ2/BQZmYiU2w546o0n8cfE4Z4yOB9K+P7n/4d4Dtcg6Z+pDiUyeQm1UYruMPOGRkxTCZzpnHsMh7OILYygpIENUJoJbfSSkuQ4Iq20fQ8hQvKdM4X4srNwOdZ7yQMzstQ7gC1LBSwELHe5/SIiM+7gGaFgW3xuqsR+I3mjm69TcvibQymD87jQhsD97pZYsyxXTQNuP54XY454SM4uOCBiC1uMwNlkjiFmxcq+SY5Zz2j0AX8whpj11wApMZZTTHMofFyEY/2q2OjK06ztvSRo5JCOaSj6s0MJSmT2Ec8nBZ2+uIhP31vPS7Qs8Mc9rEuTvft9HBoS+Bu/V/amlc0v1pSZQbBXzGmbJRvXtrJ2xx9F94sbtGvtMJ+q31iomdZeCYqYbRCCjhiCRdXN69h9efpuahG6/G/GO7Z6+tvL7+7vWQw/JCWhL2ank/P+cjZEDtJI0/81ToM45E2nCR8dyRRv3/p/v6l+//2pduzwIibOHNG6sy781Ttes78MP7+fapEa0Pk092OH/a33uz3fPxjQs9k/KkSK+k1e8pUvDrQRybZz7jlAVYKHZPylTSpcNAX3x4nBP7q8k5UgjfgKW19zrS1/8HWD1e0Hdk+5bMFAP/L5PqjCrtdocT7/SBfrj6p0Qd4kOYcPu33+58B0iLGHQ==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},b=void 0,m={},v=[];function j(e){const t={p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(y.default,{as:"h1",className:"openapi__heading",children:"Get your API credits"}),"\n",(0,r.jsx)(a(),{method:"get",path:"/getcredits",context:"endpoint"}),"\n",(0,r.jsx)(t.p,{children:"The Get Credits API returns details about the credits available to your account:"}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"plan_credits:"})," Credits included with your subscription plan. These reset at the start of each new billing cycle.\nExample: If your plan provides 100 credits per month and you end\nthe cycle with 50 remaining, your balance resets to 100 at the\nstart of the next cycle."]}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"addon_credits:"})," Credits purchased separately from Settings \u2192 API Token \u2192 Buy Premium Credits. Add-on credits do not expire and are only used once all plan credits are consumed."]}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"total_credits:"})," The sum of ",(0,r.jsx)(t.strong,{children:"plan_credits"})," and ",(0,r.jsx)(t.strong,{children:"addon_credits"}),". This represents the total credits currently available for use."]}),"\n",(0,r.jsx)(c(),{parameters:void 0}),"\n",(0,r.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,r.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{plan_credits:{type:"number",example:0},addon_credits:{type:"number",example:0},total_credits:{type:"number",example:0}},title:"credits_res"}}}},400:{description:"Subscription not found",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Subscription not found!"}}}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},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 Q(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/4d139b56.8d0aa3f2.js b/assets/js/4d139b56.8d0aa3f2.js new file mode 100644 index 000000000..58b3a31aa --- /dev/null +++ b/assets/js/4d139b56.8d0aa3f2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7075],{7988:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>C,contentTitle:()=>g,default:()=>f,frontMatter:()=>S,metadata:()=>n,toc:()=>b});const n=JSON.parse('{"id":"API-docs/v1.1/getcredits","title":"Get your API credits","description":"The Get Credits API returns details about the credits available to your account:","source":"@site/docs/API-docs/v1.1/getcredits.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getcredits","permalink":"/docs/API-docs/v1.1/getcredits","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getcredits","title":"Get your API credits","description":"The Get Credits API returns details about the credits available to your account:","sidebar_label":"Get your API credits","hide_title":true,"hide_table_of_contents":true,"api":"eJztV91uI7cVfpUT3rQRxpK8SVp0ruoGhmtkkTVqLwzUNgwO52iGMYdk+CNZEATkougDtFe97aPtkxSHnBmNvA62QYrcNIAhS+T5+c4PeT7uWOCNZ+Ude+/RsYeC1eiFkzZIo1nJblqECwzwtcNaBg9nV5fgMESnPdQYuFQeeGVigNAiiF6Kr7lUvFIIwcDWRAdcCBN1KO/1vZ7NrOL6sRcuZ7PRutRCxRpr2MjQZkUfqxEPkN4cblr0CA49BuDZsQ/cBTArQC5a0LiBSioldQNiKxTO7zXA+TPvrMISLlfZNFkD68xa1ujhdLkc8Vt00BkdWuC6JmFAXZONFCRZzAi/WoLDjkstdVNkoxVXXIsenqf4yXCGSRZGpGRK43OYIKTU8Lo2r+bGRida7rEGj5Y7HlBtYeVMB9cYgtSNhw9//0cq0I15Qp1+/Slu4cphJ2M3GJrDWV2fGD0GWxvQJgA+W+kwBcwdgtFqC5HcGQqHK5XzNZbYIQijfeywnueqBhO4mkKn5vGxo2iPaz6bJT8vop3NqLbSg0NL6dOUv5Z6KHA1OhbROdRBbSddtjKOsPY4HGrccPVY84ADjOtpG/UCQAL3mhXMWHScti5rVrIGQ++MFcyht0Z79KzcsTfLJf07PiLXUQj0fhUVjHZYwYTRAXUgeW6tkiJtLL7zpLRjXrTYcfoWthZZyUz1HYrACmYdmQkyu5ymbSKtY1ehYwXD3NWsXO4LdpTOT0of1euT0tOsToR9cFI3rGAr4zoeWMmSwESZvVm++d3J8g8np7+/WS7L9DdfLpd/ZXsCIUMS6mE8OvRsv6edL19P9qSO1LYrE3X9v0s3Omfca+EdwnkdwmcJdcb95ce46XadCv+SgF/6nqZdaiU1Pg5d/kjghzC++jiMS73mStaHW+aXjWTqPmT3BPW5U6SneZdDSkJpnx2FOl3PQXoU0cmwZeXdjj2fcCtP8n5597B/KFiHoTX9nUCAeWhZyRZHN4RHt0bnk4noFCtZG4L15WLhua4r8zw3FrWXjVa88nNhugW3crE+nZ+yffFSh1v7k+QxnvxUFR94I3XzKb2HQ3quqYS5SkdJGmvFrfwGt6wYajCVKpik1mmR1+hSvaRemaTcV+adRX0tG53qmpy/pCG3qITpEp2giTCbDSof/vbvUWs2g9qI2KEOqQPTOHhHg95s0NH9TENnpfBZ0tAgNezSnk8zPhjwyDuF3qstSB2woTELtWwkTSDKU6IU3PJKKkmNS2IDxTn0vp/DbYuhRUdbv6GxCjWuUVG/A4/BdJxG9ogXNsY9rZTZ+AI4VNFLjd4D6pZrQYJDJQowDrgG1AGdddIT93GEWmZsRgfHRYCOa94g2S5gmqwalaR2BWeq6AN4o2KCDETmjMN65GwasfYpiefPlraAVoXprMOW2maN0EQiTwUIUyP4dE4pBF1DhT6AJSxSYCJCUSsjnlIBV5H4hKFrQ3JFBGGKkdSD49rTTMlYhhqMCbPO0NRF3w/99x6pwm+lfiLuca9P4G7sq1usvAz48NvhCGw2m49a//NjnQsZ/hwr+Ata42UwbnvQbmRoY5WOy9TI+CNbukCNqX8mh+FgozbCf3z6aHXRorKLgdQtzq4u0037OXz44Z/wFrnT0JpN7lYRHdHAZnBFmcuVz2kbL8pEkXgMLWVc5OZz+H1EH4YM3rY8fPjhXx6+xQ1I3R8pCmU2u4qVkgJusLOKB/SzWUl8klyGYQ1CywMIrqFC8C2nVlpLDhxs1lZSP83hTCde6TKDpmag9aR3FAblZSy3h4pnLpoZYe9zfkBE651HtUZPtmjcVQh0R1NHt87EJnubgumDc7iSSsGtrBsMKbazugbbL2/yMiV8AgdXdCBCi9tEhYmtzuHqhUraidYaRyhkBr8ySpkNFQB1bY3UwZdQO74KB/vFodEFpVka/cpSTiEf01H0ZsaS5JPYRzyuzhPnfXGRH9+3DlfoyGEK+1AXK/t2uhvaEqhbf05b04imW4uLxCDoOaXyRPnjSztpmqPr/LvVNbq1FNhPtR850YskvGAFU1Kg9jhhCWcXV29h/cV8yYrJePwvDvfi7eXX599enxMYukhzwk7ny/mSlqzxoeN64omez+NhPNCGo4TvDiTq1yf3r0/u/4Mnd08cAz6HhVVcJqqeDuKup9l304f4Q8Fa4wOt7nY0C947td/T8vcRHfH3h4KtuZMELrH3YmCcxMufcEtnXgi0xOPXXMVMW188V444/8X5DSsYDc1jpvuUmG7/hawPW3o7sX1MgTMA+iQ+/qrCbpdZ9H4/yuetH9XoAxykKYcP+/3+P2OzBN4=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get your account details","permalink":"/docs/API-docs/v1.1/get-user"},"next":{"title":"Create Contact","permalink":"/docs/API-docs/v1.1/createcontact"}}');var s=r(74848),i=r(28453),d=r(33617),o=r.n(d),c=r(17543),a=r.n(c),p=r(86013),u=r.n(p),l=r(63723),h=r.n(l),m=(r(18766),r(79329),r(9303));const S={id:"getcredits",title:"Get your API credits",description:"The Get Credits API returns details about the credits available to your account:",sidebar_label:"Get your API credits",hide_title:!0,hide_table_of_contents:!0,api:"eJztV91uI7cVfpUT3rQRxpK8SVp0ruoGhmtkkTVqLwzUNgwO52iGMYdk+CNZEATkougDtFe97aPtkxSHnBmNvA62QYrcNIAhS+T5+c4PeT7uWOCNZ+Ude+/RsYeC1eiFkzZIo1nJblqECwzwtcNaBg9nV5fgMESnPdQYuFQeeGVigNAiiF6Kr7lUvFIIwcDWRAdcCBN1KO/1vZ7NrOL6sRcuZ7PRutRCxRpr2MjQZkUfqxEPkN4cblr0CA49BuDZsQ/cBTArQC5a0LiBSioldQNiKxTO7zXA+TPvrMISLlfZNFkD68xa1ujhdLkc8Vt00BkdWuC6JmFAXZONFCRZzAi/WoLDjkstdVNkoxVXXIsenqf4yXCGSRZGpGRK43OYIKTU8Lo2r+bGRida7rEGj5Y7HlBtYeVMB9cYgtSNhw9//0cq0I15Qp1+/Slu4cphJ2M3GJrDWV2fGD0GWxvQJgA+W+kwBcwdgtFqC5HcGQqHK5XzNZbYIQijfeywnueqBhO4mkKn5vGxo2iPaz6bJT8vop3NqLbSg0NL6dOUv5Z6KHA1OhbROdRBbSddtjKOsPY4HGrccPVY84ADjOtpG/UCQAL3mhXMWHScti5rVrIGQ++MFcyht0Z79KzcsTfLJf07PiLXUQj0fhUVjHZYwYTRAXUgeW6tkiJtLL7zpLRjXrTYcfoWthZZyUz1HYrACmYdmQkyu5ymbSKtY1ehYwXD3NWsXO4LdpTOT0of1euT0tOsToR9cFI3rGAr4zoeWMmSwESZvVm++d3J8g8np7+/WS7L9DdfLpd/ZXsCIUMS6mE8OvRsv6edL19P9qSO1LYrE3X9v0s3Omfca+EdwnkdwmcJdcb95ce46XadCv+SgF/6nqZdaiU1Pg5d/kjghzC++jiMS73mStaHW+aXjWTqPmT3BPW5U6SneZdDSkJpnx2FOl3PQXoU0cmwZeXdjj2fcCtP8n5597B/KFiHoTX9nUCAeWhZyRZHN4RHt0bnk4noFCtZG4L15WLhua4r8zw3FrWXjVa88nNhugW3crE+nZ+yffFSh1v7k+QxnvxUFR94I3XzKb2HQ3quqYS5SkdJGmvFrfwGt6wYajCVKpik1mmR1+hSvaRemaTcV+adRX0tG53qmpy/pCG3qITpEp2giTCbDSof/vbvUWs2g9qI2KEOqQPTOHhHg95s0NH9TENnpfBZ0tAgNezSnk8zPhjwyDuF3qstSB2woTELtWwkTSDKU6IU3PJKKkmNS2IDxTn0vp/DbYuhRUdbv6GxCjWuUVG/A4/BdJxG9ogXNsY9rZTZ+AI4VNFLjd4D6pZrQYJDJQowDrgG1AGdddIT93GEWmZsRgfHRYCOa94g2S5gmqwalaR2BWeq6AN4o2KCDETmjMN65GwasfYpiefPlraAVoXprMOW2maN0EQiTwUIUyP4dE4pBF1DhT6AJSxSYCJCUSsjnlIBV5H4hKFrQ3JFBGGKkdSD49rTTMlYhhqMCbPO0NRF3w/99x6pwm+lfiLuca9P4G7sq1usvAz48NvhCGw2m49a//NjnQsZ/hwr+Ata42UwbnvQbmRoY5WOy9TI+CNbukCNqX8mh+FgozbCf3z6aHXRorKLgdQtzq4u0037OXz44Z/wFrnT0JpN7lYRHdHAZnBFmcuVz2kbL8pEkXgMLWVc5OZz+H1EH4YM3rY8fPjhXx6+xQ1I3R8pCmU2u4qVkgJusLOKB/SzWUl8klyGYQ1CywMIrqFC8C2nVlpLDhxs1lZSP83hTCde6TKDpmag9aR3FAblZSy3h4pnLpoZYe9zfkBE651HtUZPtmjcVQh0R1NHt87EJnubgumDc7iSSsGtrBsMKbazugbbL2/yMiV8AgdXdCBCi9tEhYmtzuHqhUraidYaRyhkBr8ySpkNFQB1bY3UwZdQO74KB/vFodEFpVka/cpSTiEf01H0ZsaS5JPYRzyuzhPnfXGRH9+3DlfoyGEK+1AXK/t2uhvaEqhbf05b04imW4uLxCDoOaXyRPnjSztpmqPr/LvVNbq1FNhPtR850YskvGAFU1Kg9jhhCWcXV29h/cV8yYrJePwvDvfi7eXX599enxMYukhzwk7ny/mSlqzxoeN64omez+NhPNCGo4TvDiTq1yf3r0/u/4Mnd08cAz6HhVVcJqqeDuKup9l304f4Q8Fa4wOt7nY0C947td/T8vcRHfH3h4KtuZMELrH3YmCcxMufcEtnXgi0xOPXXMVMW188V444/8X5DSsYDc1jpvuUmG7/hawPW3o7sX1MgTMA+iQ+/qrCbpdZ9H4/yuetH9XoAxykKYcP+/3+P2OzBN4=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,C={},b=[];function T(e){const t={p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Get your API credits"}),"\n",(0,s.jsx)(o(),{method:"get",path:"/getcredits",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Get Credits API returns details about the credits available to your account:"}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"plan_credits:"})," Credits included with your subscription plan. These reset at the start of each new billing cycle.\nExample: If your plan provides 100 credits per month and you end\nthe cycle with 50 remaining, your balance resets to 100 at the\nstart of the next cycle."]}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"addon_credits:"})," Credits purchased separately from Settings \u2192 API Token \u2192 Buy Premium Credits. Add-on credits do not expire and are only used once all plan credits are consumed."]}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"total_credits:"})," The sum of ",(0,s.jsx)(t.strong,{children:"plan_credits"})," and ",(0,s.jsx)(t.strong,{children:"addon_credits"}),". This represents the total credits currently available for use."]}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"renewal_date:"})," The Subscription renewal date"]}),"\n",(0,s.jsx)(a(),{parameters:void 0}),"\n",(0,s.jsx)(u(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{plan_credits:{type:"number",example:0},addon_credits:{type:"number",example:0},total_credits:{type:"number",example:0},renewal_date:{type:"string",format:"date",example:"2026-09-17T00:00:00.000Z"}},title:"credits_res"}}}},400:{description:"Subscription not found",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Subscription not found!"}}}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},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:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(T,{...e})}):T(e)}}}]); \ No newline at end of file diff --git a/assets/js/851f8f65.b07419f4.js b/assets/js/851f8f65.b07419f4.js deleted file mode 100644 index 8e1ed57de..000000000 --- a/assets/js/851f8f65.b07419f4.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:()=>x,default:()=>b,frontMatter:()=>y,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":"eJztPGtzHDdyfwWZSpUsZrgvkpLMKKqjJcVWzpFYFhXXhdTR2JneHYgzwBjAcLlmseo+3D/Ip3y9n+ZfkuoGMI99kJRE+6jL+oPMxeDRaHQ3Gv26jCyfmmj/OHqhkqoAaU30Po5SMIkWpRVKRvvRUQbsheYTy0IndnD4ivE8VzPDKgPaMKvYFCRoboFJmLE0TMfGc1ZqdS5SIacs5ZazmbAZ42zMDTzaZSATlULKJiKH3ok8kUei3GfvylzxlM1Vpdnhi3+v58OFsO14a+sFjKspe/dqa+v9V5m1pdnv93lZ9lQJ0oipzPnY9BJV9FPsWKaThzGbZaABZ2UJlwy4Efmc8TRlM5FOwZqY2QwkS1Q5Z4lSOhWSWzAxK/kUmKyKMWgTMy5TVigNTEjGmQaezret2q4MsP94++Y1myhdcNtjh3ll4nq5VGhIbD5309sM6l09MAEbxmohpzEr+BniS1j2cyWSM9y2AZni/3HgweErwtXW1tuqLJW2kLIf3Rb2t7bwyzeQqxnjGqh/oopCSVZyzQuwdGAZt/RZw8+V0JD6Y8nzgIv9E7nNtrbsvIT9rS32SqYiQWTQhNjK1MT37bmuiCTs+raEREyE79pCHVOSzTKRZISTGXfnWeY8cWBqMCUkVpxDd+KLmM1x4hcgVYAgU1r8oqTlOR3HOWgrEp63jw0BxK7Gcm0RnaUS0oZWvwL7kz8ePD06FE9XCFqKyCqEpC8G2DnPKzAeqlnMMoTqByg1GCJ2Py8iUqYsAzHN1q7H0w+VsZ2JWWUQzDYUfq1wSoReILRNeG6AiUkHlwU/g9ZqTBET87zHvpmzFCa8ym3MBFKc1RX02GtlGS/LXCR8nANSLkPm4bbSsE2n7MnBAyJ5QWd8SDwNhnGWiskENDInfqQp/JgAHdJZIwSIc2zGJVNy4aATlSu9TELU3MUjS5S0IG2PHZxzkRPwbrOGCZnkVQpsnPPkLGbjvIKYaUgd484BBVfs6J26MG48zgk/zECOVKgkwi+VX14YZjxUaY8dZcI0/IQfA6ppEWHaWPVcO1G4MqIgsBiDgos8JsTF7IMaMytsDjEybMnlPEaJCTGzcGHH6iJmSQbJGf2leSoUG1fWKuk2lmpVpmomPS4nSlojflnBkeHLx2N0FLPdmD2K2ZOYDQcxG45iNtyN2fBRzIZPYjYaxGw0itloN2ajRw6s0ZM4iPyA4DYAw5HDsv1ysIty93thiLNRYJpaBs86MnjYY1tbNTdh208//XQiL08kYycRMtdJtM9OorrLSRS7bygz8dvQ/77AHzujx/7nHH8+Gj3xP2fUdbjrf2b4czQ8kVd+wRM5IkgsL8proMDPdwqB/+WJCNtoUWwL8gwbURDF4QOeVQce/HDV3ssO7kVIYQXPzfrthB73aEcNSEub2sVNEbmu3xF9vkfbacODX0hMuk8kVlufAsMTFKOl3e/1/M2yfvNu2Xuz9xY4n7f1R7h1FE1HKJrW77+WXvcICYswfR4mHvdIASDJvB4PvsM9wkIXos/DwRPEAV5K6xGAX+/R7lvg4Ad/w7tvg93t4d72aDDa7WAA30auQ1Fsp+n2fD6/C+yhzuOXR5UnaKhOs8N36USrYsXzg14HTS+vE9HfQWX/T1TUx0GHhRTfffSwCBpL/eJra9lWpXz+wLipwtBaOcP+jWo2b4FJnxAOev0mmRKJBx77BJVsjA+8HuJgmzDZT9N+C5PYmKbbRbG90Ig/twnxrcai6KVpb6Hn0um4xoKlacyWm1e2pykrimJNs2vvNPeLYnkXvaLwsJHy9TUyidfZ1vOJ7/B7sUrDEd2Fr2UjtBwomdPa9JxbzUcLl00mpP/giYotdNAwrXKu4QLfpUYo6XrfPY8FFms0e3rH0hOQrAQOFeyrN157f+jJH7fQnQBbbh63tDOc5IAllbGqYBqmcMFKbi1oSZOd81yknJ5y29QAF7wo8QnQ//PJSfov/9wnAwS+8S3Dk2CpmAq0A/X/fHyw/d/vV/SoyhJ0wg2wHHAlEzOwSY8dZ5CXjSlqNpv1ZjsmyZTKnR3qg9Ewcf+eqvGHUwK37HFTPly1U0carQc/ks7ie9+A7WCMGxZGrnjyE40RDw0HdNv69841163vcY9unAWQ8KOznuDn45Oo4KSQIClD87eyGeiT6H09xj3yIb1h7PtbMGsmUsj5GPLlT7dmtLo553NVef4ORq3uVj1Ft/CGHwoha7sFbWcQtz7yi4WP7tvVCv52CGlzZ7hyAnuGE2C5MMFy00Vne7Q3bZHBUQKQDXMMLAxAA3GQHp/LBTVgt2MDJ4n82d2wBPZj1LE2K4bVblihczBtxOAchZCiqIraPjqpZw0oK7zu0cYXjkS7e1ihfbpLK/CLG1ZAY+T6BU7kkOwYwf5xjWbqe9wjWbEA0vVs/ClSpHNP39EFezMDhm21GXDFtYxd3YVcM59Zz3099gavN7TJukFoZUsSKC1a5D6XNWuQb31Dkc3K2eG+ITvcesprW+vuEfWtAOs3pkDf765vn08i0vbuvyBC7YB9a2J1RsmCT695udPne0SeHp4lI8TW1qGGicjzlkuRhabg2UGXDuRQeLeXdybiVUeGcCGtwmdBcNuOYUL+UktulIw3Dkd3z7gjbftEWaKBW6VZxo3Tv0nhx6NCh63NoFgwxQfQGnO8kAFuPJXh3b0bR18P2uc0fLTXOae9QeecBuvO6ZpnI56gKZU0ta0Nmk8tvqYjDu3LV8si24ZJ8UhfSvSthNeDYwZV5SnLxRl5VVJhypzP8VQDl3ooF911zzOlTNPDe8y+8hve73rilEZn3MNe7Zi4jcFr4TBaZzF8vNM6ir0nT7oc02GY27zfm/WWT2Gw2x/u9Z1Fa7VBqzHDrBfC12gCjN3mvMhOdKvzop7NgW3MTp9qdrobct+5y1f38PGoc1nsDD71srjzx3Wba254Vt/F4/nOXrFtdrvl+/V3e0d+PvXtNhr1+M406uHjnTYVPh7egQl1jeL8uZS4pB/fGe2xu1KOVxHgLbTja1XizybQNrC/OZHu3Y0mPRx0NLSvOwra16M2Ue7t3Yoo24suUNZJJP7rmzc/zAZ//HaqDg4ODl6/fZe9fDc9ODgo8Hev11v5iFp12rQMaq4+ItDfy3THr1ml1+shCjG4cp+G90s5/Vc3Pl4/pnciozhSJUZtCiVfpdF+lGKcZ1DBo5ieEWDsNyqdR/uXkQ8Rwj99AA6O7H8wGCh6GZkkg4LjX+H5gaGlGNkZxRF5ijG6FM8x2o/U+AMkuEapEQYrwOBI6r1/GXq5gMgo9mpWtB+5fUVx5G35dVMdSlqmk+gqLHjdVHVLM5WhP+pXCM6DMYefOM1rHHq1EFD7STO9aM1AeyvgSD1X+M3CCz43rXmdqS9ajOPFMcjhiR/FUj43KCkq4261hOdJlaMyCBel0PPaIUoaYYsqanjrlWp4h3tXMQU0gW6DxLXm8yiOhIWi3b6GCLT6+JNLQCFmKCrlY8d+UDAG+INvQG8NHTwvPhqKDwrYGOjQy0zJjx4/HO0MR8Od4Qhn8KEFHztHiIDGKT6o8eknMUIK5zjeP6o//Sjd1+W1u7R5gLF7kAZla7sJQo0ZBYL1bmKT0J8wz6dwMz8crQtObsVEmoxeWLwsgesexQh/cvh5l8XqW713A0NdxdHFzZu5YInaDpHP7KscJtZ5KlmitAT9sB3+cG82N9rdvYqj+c3bm3+R23uMhze7eXc/Ush4E07/94B158lVHGU3w/pdHdT+dwR299FVc8FHZCmEcD+djlU6Pw1y6+qmjuGuwn4TlaegURFalleNqEEJg8kYp4tXzVipHLhcIWg60cw+cQaVbrQ7e0PMLAN8uzS6OM3eKPreSu2gxQhpWAi6EAZ1ZF3BSdRjryatZwOp8YsB1aEvBTdLxR7QeqemIjH+oO9/I44etBNH0MzbxD0FEKgzs1CUOWVezNBWPCYnYtpj9X+kcdaYRADCjR0WvvmqeO6CPWhBP6ibtsC80tpjz7msQ9e7IeLs8rImA6KOqyt2eYmnCvoU7/2rq7hpwLU6DXS1uxYNCYjzzqi6CZqBdVtrqNOyTlHLcg3+vm8DIKZSyOlppf08qIxeXfU6BLkAOFnMPQ4grelMTOWKXdcqE530rbG/hGxPATjJ/xu8Py2ffSdWgPK0Xz57Wj77EZOUSnC859AzETJ1nD+DPO+xp8ZqJafPFlDwtO/bVx+lhnMBM2JcOtVmlkXc1hP1PEx/QkHdHJ4wLNFVInhOUU5aJRAcM3huEl/uxkJp0BMmLI10eST0JOBTDeQCIlh4ZSkpi96EYcGnnGUaJv/2YAGnD569RdAxH+9pnz/zvV85W0TGz4FxOWe0cTKcKO2Mb5NKk5hMcq7FxD9AY1bmgBFZ+D7liXPkOYwGOI4yLs9M/HSsnx0BL9ibEiRC8Otf/4Y9gkx/Jd/oFPQthPqriXMZKvYA5diD2EWHEbkLbawX1U4SegpxcK1hHZ8dgJ7Gl7XoN9XYYC8Z5mtEq9ViOgV0pPkeNNjn2gBPMndpEFR8ElwHJRKPqkwADwksPAjJqyYcfQg57Zp6WtghH157771VUl1ics6bo8Nb4JLsUNuOUZwRxu3SzcHeHB1ifl993D32ztSYCKjlnS4MLQHsXPCQA1Rr9nMXUQPOmeLlYtvx2POZddtsGaBUmJUQxe5SRwlX58MuTdwkgOIRqcqiI1P4tCbisg4eCYoakUequg1V3oBJzqYVBTBbZN9wa1IMY5OfJ6SxunLRRCytdEhJ9GThxIQxDZ4CVrBTa/6YgTRuOGcTbizomFVSIOZ1habJekq4KEELkAmsRIEGhzoUHTdfUd1kt3c/fO/TfsMeAlOOkQPdxJCyqiSqIU6okzDDyS1ufaU+6MX3zQCi7kapkt6+WoI2SqKIU3rKpZeg7j2KRtQxZDx3Xb2oQD8cwoMc3lv59v/1r39rwbXWKLIMmFuBpylG2N4AIdmjHcFjEJmGEiWg6kKE84H+w+ITAKEjpjktVFozkrk9jR9STK6p5aIPDKiDEkyVZHht1fLWxEHGGm9UMGR6Jvs0RRaUuF+4EMa20ghDsP+yfPgBEI9JCwZ6hCJXI83LeZvBm2AJtTAdPQ9ENwW1fgQt8QKvrDrVUAh5u3uqbeq3qhYElVUFtyJhYSrT6yYWO39y4OuCfRVAQ2o8F0o/XMOqON2pkgmcCnkK56Bv8bx/XQcnkk1yDHYGINuwBSS566xJ/pxhvn4HJ63biVKc21CicbJ0ESGrLFddoEKidoiyD/TgrhIqIFCMMTLJxbYgq5HgCK+0JVPYl2JL80EeG0vaF2RqGg4G/8iWtJ3Bl2NJ2x18QZa0Jwisd3zeLIDW6TcrZUfwbl4/4IMC5+rIlb6+J7oTyUjn3O+rENyww+jK/dcY/4Lcb7d13J3OAkJjGvelf82EvRAWRoMB/q97mi86cYuo21YJ6oqTKs/n/xTFt/edXn8ENbRipZnyOrmefRCjXy6S89Eh4nGNLn3tBJ4QK51jvRu88bZrPYZ0uhZuhcyFhFNC8WmqklMN5nQ0GJwOI3cwu6vQ+FYVYDNSvxCZM7Re1M97q+eMT7mQDGlc3yFWQeubyO/jIFuBiUBDp7sdJOwtI+GVpDQfKrN0pM5A/r47bS9v3fII6kWRNzIgEq4TfY86m223u00aSCot7DzaP76MLrZ5Kbbd9/3j91fv4wgRqzD8oFSGIOY2i/aj/mI0ggF9Tn7l40tHvjVFGi5TDKFaEo+8FP3zYW8YXcWLY1aK02v6Q7X9sUOM5VMhpzeNe9+g6C0eozupDqIalbEUfwTUGf05tHvFkUDyyYDj2wAxj9TxQxPD8TKccYizWBU60ZzlYjBEiIXohDcsXmsrAhZWxysM91qRAsfB6U9+/NqNv8ozX289+NprV3vLe95ynjf+8I47nDzcLQf3ccMStS85KMBD0hxHu7ukYj0eki6y84Su+d1HV0TEjfMoiroOIoq/X3RzfJ7Vvmu031ii/4Es0QuGaE88jTXVxSl2zIK+qWsmC1RYm6U6tqFF09BaM80aK41fcsEaUQOyygiw13l7r+C7oDt2uQ4j+ZDrdgbEdbsD4rong47a6nfYzNAon6Rh1gomaZFtJRI1xfcoKoWcKJKzXjyEc6FrkOT00mMD8kQVdQGqra3WUdajtrZq+enIEYMc31SalWoGelK5ilaTHC4E2jNwGBT0rXERAy9yMCbH0H4LU6qySInqaDj2psmEl3wscoH3vEu/cYzRqAqmx35snMwPtMvbP4cc1YPaIoRVGoMqO1P6bILO6hjrNWJxOrQJgsy4TJz50V1aZEZDewiadkstDNbc0wi1cLApaTVyQ8ElnxKfxm26ZynkKLYM02qM1nmj8spxm+UiV9rFp9GGKPyVkPjyosRP9GJCYa8hQ9o990ZoEzsngLuPfNXGMfpbSoRFJEC2uErmCgssot+mynNWKut8Kfgwa8OIw63m0qCG7EPi/BnUCPP2YTA+NemdATzh74U8c0XBttlxTVc/wtgIC92SAYv897A75lthv6vGWHJQGWGVnjejp8Jm1Zg0i/Yk9Q8307ehSmdLb2jmSFViVjwxVWL6WN2g/xYsUojpHxy+IsX0Ifv1L//DvgeuJcvUzFFrUmnI501BUCqXSSfv0FbrleSBQGGNGE8c8fk7JmDwx4zbX//yv4a9hhlaYh1LufDZw2qci4QdhaiDra199pxeX61IhE6Ks0s8Q7cQZ6UbnQt51mMHck6G7ObGwXYa19kG3XKt4qYcQyeV9HHObs1eAxGZTg3k50AWcqxyNwYGqXDONq2qqVutDYzfXDcHD/d2kKasXMjDQzNtA46zRJKXizuTJFYhXZG618mR67roQaZUJ9PsM9K/m/njheQ8uu+WmkJeX0BH7Kepj8Rxot9x3eqikRd03q681TABikPt1pvlpfDkdBzIknVrcXw8WTuTBF3h9GjylyQvxUpHBlYJNW8mb0GfiyS8lNdwdJ8696M4ykUC3j7i76+Dbw+/Z+c7vUEUt14St2Du/vevnr98/fYlAoOC1CFs2Bv0BmTGVcYWXLZW6hb0XbzaWpHem/K/m/K/m/K/m/K/m/K/X06B2k3530353035303530353035398OCZvyv5vyv5vyv5vyv5vyv5vyv5vyv5vyv5vyv5vyv5vyv5vyv/dHVmzK/96Xqqqb8r+/BwVuyv9uyv9uyv9uyv9uyv9uyv9uyv9uyv9uyv9uyv9uyv9uyv9uyv9uyv+uKf/bSr3olzkXspUa6tLwjheKAr+PowzT9PaPo8tLXOUdZtFg888V5Xkcv4+jc64FRudQhl8cMtIw1+MMMGHpuQs22j7C5WPH2hRfu5DYiCl1bsQB0fO1fduZhIdv3h5FcRSKmhUqpRRiPsPcED5z6TGtBBJqu4xyLqcVJZ9Ebs4rV3Ij62bgnVEGnv+jlcGC+WYNhN3UPLcN/Bc3tXLA5aXL7qMEL9fffVo7wiM29Mbje391dfV/94fVhQ==","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),o=t(28453),r=t(33617),l=t.n(r),a=t(17543),d=t.n(a),c=t(86013),h=t.n(c),p=t(63723),m=t.n(p),u=(t(18766),t(79329),t(9303));const y={id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztPGtzHDdyfwWZSpUsZrgvkpLMKKqjJcVWzpFYFhXXhdTR2JneHYgzwBjAcLlmseo+3D/Ip3y9n+ZfkuoGMI99kJRE+6jL+oPMxeDRaHQ3Gv26jCyfmmj/OHqhkqoAaU30Po5SMIkWpRVKRvvRUQbsheYTy0IndnD4ivE8VzPDKgPaMKvYFCRoboFJmLE0TMfGc1ZqdS5SIacs5ZazmbAZ42zMDTzaZSATlULKJiKH3ok8kUei3GfvylzxlM1Vpdnhi3+v58OFsO14a+sFjKspe/dqa+v9V5m1pdnv93lZ9lQJ0oipzPnY9BJV9FPsWKaThzGbZaABZ2UJlwy4Efmc8TRlM5FOwZqY2QwkS1Q5Z4lSOhWSWzAxK/kUmKyKMWgTMy5TVigNTEjGmQaezret2q4MsP94++Y1myhdcNtjh3ll4nq5VGhIbD5309sM6l09MAEbxmohpzEr+BniS1j2cyWSM9y2AZni/3HgweErwtXW1tuqLJW2kLIf3Rb2t7bwyzeQqxnjGqh/oopCSVZyzQuwdGAZt/RZw8+V0JD6Y8nzgIv9E7nNtrbsvIT9rS32SqYiQWTQhNjK1MT37bmuiCTs+raEREyE79pCHVOSzTKRZISTGXfnWeY8cWBqMCUkVpxDd+KLmM1x4hcgVYAgU1r8oqTlOR3HOWgrEp63jw0BxK7Gcm0RnaUS0oZWvwL7kz8ePD06FE9XCFqKyCqEpC8G2DnPKzAeqlnMMoTqByg1GCJ2Py8iUqYsAzHN1q7H0w+VsZ2JWWUQzDYUfq1wSoReILRNeG6AiUkHlwU/g9ZqTBET87zHvpmzFCa8ym3MBFKc1RX02GtlGS/LXCR8nANSLkPm4bbSsE2n7MnBAyJ5QWd8SDwNhnGWiskENDInfqQp/JgAHdJZIwSIc2zGJVNy4aATlSu9TELU3MUjS5S0IG2PHZxzkRPwbrOGCZnkVQpsnPPkLGbjvIKYaUgd484BBVfs6J26MG48zgk/zECOVKgkwi+VX14YZjxUaY8dZcI0/IQfA6ppEWHaWPVcO1G4MqIgsBiDgos8JsTF7IMaMytsDjEybMnlPEaJCTGzcGHH6iJmSQbJGf2leSoUG1fWKuk2lmpVpmomPS4nSlojflnBkeHLx2N0FLPdmD2K2ZOYDQcxG45iNtyN2fBRzIZPYjYaxGw0itloN2ajRw6s0ZM4iPyA4DYAw5HDsv1ysIty93thiLNRYJpaBs86MnjYY1tbNTdh208//XQiL08kYycRMtdJtM9OorrLSRS7bygz8dvQ/77AHzujx/7nHH8+Gj3xP2fUdbjrf2b4czQ8kVd+wRM5IkgsL8proMDPdwqB/+WJCNtoUWwL8gwbURDF4QOeVQce/HDV3ssO7kVIYQXPzfrthB73aEcNSEub2sVNEbmu3xF9vkfbacODX0hMuk8kVlufAsMTFKOl3e/1/M2yfvNu2Xuz9xY4n7f1R7h1FE1HKJrW77+WXvcICYswfR4mHvdIASDJvB4PvsM9wkIXos/DwRPEAV5K6xGAX+/R7lvg4Ad/w7tvg93t4d72aDDa7WAA30auQ1Fsp+n2fD6/C+yhzuOXR5UnaKhOs8N36USrYsXzg14HTS+vE9HfQWX/T1TUx0GHhRTfffSwCBpL/eJra9lWpXz+wLipwtBaOcP+jWo2b4FJnxAOev0mmRKJBx77BJVsjA+8HuJgmzDZT9N+C5PYmKbbRbG90Ig/twnxrcai6KVpb6Hn0um4xoKlacyWm1e2pykrimJNs2vvNPeLYnkXvaLwsJHy9TUyidfZ1vOJ7/B7sUrDEd2Fr2UjtBwomdPa9JxbzUcLl00mpP/giYotdNAwrXKu4QLfpUYo6XrfPY8FFms0e3rH0hOQrAQOFeyrN157f+jJH7fQnQBbbh63tDOc5IAllbGqYBqmcMFKbi1oSZOd81yknJ5y29QAF7wo8QnQ//PJSfov/9wnAwS+8S3Dk2CpmAq0A/X/fHyw/d/vV/SoyhJ0wg2wHHAlEzOwSY8dZ5CXjSlqNpv1ZjsmyZTKnR3qg9Ewcf+eqvGHUwK37HFTPly1U0carQc/ks7ie9+A7WCMGxZGrnjyE40RDw0HdNv69841163vcY9unAWQ8KOznuDn45Oo4KSQIClD87eyGeiT6H09xj3yIb1h7PtbMGsmUsj5GPLlT7dmtLo553NVef4ORq3uVj1Ft/CGHwoha7sFbWcQtz7yi4WP7tvVCv52CGlzZ7hyAnuGE2C5MMFy00Vne7Q3bZHBUQKQDXMMLAxAA3GQHp/LBTVgt2MDJ4n82d2wBPZj1LE2K4bVblihczBtxOAchZCiqIraPjqpZw0oK7zu0cYXjkS7e1ihfbpLK/CLG1ZAY+T6BU7kkOwYwf5xjWbqe9wjWbEA0vVs/ClSpHNP39EFezMDhm21GXDFtYxd3YVcM59Zz3099gavN7TJukFoZUsSKC1a5D6XNWuQb31Dkc3K2eG+ITvcesprW+vuEfWtAOs3pkDf765vn08i0vbuvyBC7YB9a2J1RsmCT695udPne0SeHp4lI8TW1qGGicjzlkuRhabg2UGXDuRQeLeXdybiVUeGcCGtwmdBcNuOYUL+UktulIw3Dkd3z7gjbftEWaKBW6VZxo3Tv0nhx6NCh63NoFgwxQfQGnO8kAFuPJXh3b0bR18P2uc0fLTXOae9QeecBuvO6ZpnI56gKZU0ta0Nmk8tvqYjDu3LV8si24ZJ8UhfSvSthNeDYwZV5SnLxRl5VVJhypzP8VQDl3ooF911zzOlTNPDe8y+8hve73rilEZn3MNe7Zi4jcFr4TBaZzF8vNM6ir0nT7oc02GY27zfm/WWT2Gw2x/u9Z1Fa7VBqzHDrBfC12gCjN3mvMhOdKvzop7NgW3MTp9qdrobct+5y1f38PGoc1nsDD71srjzx3Wba254Vt/F4/nOXrFtdrvl+/V3e0d+PvXtNhr1+M406uHjnTYVPh7egQl1jeL8uZS4pB/fGe2xu1KOVxHgLbTja1XizybQNrC/OZHu3Y0mPRx0NLSvOwra16M2Ue7t3Yoo24suUNZJJP7rmzc/zAZ//HaqDg4ODl6/fZe9fDc9ODgo8Hev11v5iFp12rQMaq4+ItDfy3THr1ml1+shCjG4cp+G90s5/Vc3Pl4/pnciozhSJUZtCiVfpdF+lGKcZ1DBo5ieEWDsNyqdR/uXkQ8Rwj99AA6O7H8wGCh6GZkkg4LjX+H5gaGlGNkZxRF5ijG6FM8x2o/U+AMkuEapEQYrwOBI6r1/GXq5gMgo9mpWtB+5fUVx5G35dVMdSlqmk+gqLHjdVHVLM5WhP+pXCM6DMYefOM1rHHq1EFD7STO9aM1AeyvgSD1X+M3CCz43rXmdqS9ajOPFMcjhiR/FUj43KCkq4261hOdJlaMyCBel0PPaIUoaYYsqanjrlWp4h3tXMQU0gW6DxLXm8yiOhIWi3b6GCLT6+JNLQCFmKCrlY8d+UDAG+INvQG8NHTwvPhqKDwrYGOjQy0zJjx4/HO0MR8Od4Qhn8KEFHztHiIDGKT6o8eknMUIK5zjeP6o//Sjd1+W1u7R5gLF7kAZla7sJQo0ZBYL1bmKT0J8wz6dwMz8crQtObsVEmoxeWLwsgesexQh/cvh5l8XqW713A0NdxdHFzZu5YInaDpHP7KscJtZ5KlmitAT9sB3+cG82N9rdvYqj+c3bm3+R23uMhze7eXc/Ush4E07/94B158lVHGU3w/pdHdT+dwR299FVc8FHZCmEcD+djlU6Pw1y6+qmjuGuwn4TlaegURFalleNqEEJg8kYp4tXzVipHLhcIWg60cw+cQaVbrQ7e0PMLAN8uzS6OM3eKPreSu2gxQhpWAi6EAZ1ZF3BSdRjryatZwOp8YsB1aEvBTdLxR7QeqemIjH+oO9/I44etBNH0MzbxD0FEKgzs1CUOWVezNBWPCYnYtpj9X+kcdaYRADCjR0WvvmqeO6CPWhBP6ibtsC80tpjz7msQ9e7IeLs8rImA6KOqyt2eYmnCvoU7/2rq7hpwLU6DXS1uxYNCYjzzqi6CZqBdVtrqNOyTlHLcg3+vm8DIKZSyOlppf08qIxeXfU6BLkAOFnMPQ4grelMTOWKXdcqE530rbG/hGxPATjJ/xu8Py2ffSdWgPK0Xz57Wj77EZOUSnC859AzETJ1nD+DPO+xp8ZqJafPFlDwtO/bVx+lhnMBM2JcOtVmlkXc1hP1PEx/QkHdHJ4wLNFVInhOUU5aJRAcM3huEl/uxkJp0BMmLI10eST0JOBTDeQCIlh4ZSkpi96EYcGnnGUaJv/2YAGnD569RdAxH+9pnz/zvV85W0TGz4FxOWe0cTKcKO2Mb5NKk5hMcq7FxD9AY1bmgBFZ+D7liXPkOYwGOI4yLs9M/HSsnx0BL9ibEiRC8Otf/4Y9gkx/Jd/oFPQthPqriXMZKvYA5diD2EWHEbkLbawX1U4SegpxcK1hHZ8dgJ7Gl7XoN9XYYC8Z5mtEq9ViOgV0pPkeNNjn2gBPMndpEFR8ElwHJRKPqkwADwksPAjJqyYcfQg57Zp6WtghH157771VUl1ics6bo8Nb4JLsUNuOUZwRxu3SzcHeHB1ifl993D32ztSYCKjlnS4MLQHsXPCQA1Rr9nMXUQPOmeLlYtvx2POZddtsGaBUmJUQxe5SRwlX58MuTdwkgOIRqcqiI1P4tCbisg4eCYoakUequg1V3oBJzqYVBTBbZN9wa1IMY5OfJ6SxunLRRCytdEhJ9GThxIQxDZ4CVrBTa/6YgTRuOGcTbizomFVSIOZ1habJekq4KEELkAmsRIEGhzoUHTdfUd1kt3c/fO/TfsMeAlOOkQPdxJCyqiSqIU6okzDDyS1ufaU+6MX3zQCi7kapkt6+WoI2SqKIU3rKpZeg7j2KRtQxZDx3Xb2oQD8cwoMc3lv59v/1r39rwbXWKLIMmFuBpylG2N4AIdmjHcFjEJmGEiWg6kKE84H+w+ITAKEjpjktVFozkrk9jR9STK6p5aIPDKiDEkyVZHht1fLWxEHGGm9UMGR6Jvs0RRaUuF+4EMa20ghDsP+yfPgBEI9JCwZ6hCJXI83LeZvBm2AJtTAdPQ9ENwW1fgQt8QKvrDrVUAh5u3uqbeq3qhYElVUFtyJhYSrT6yYWO39y4OuCfRVAQ2o8F0o/XMOqON2pkgmcCnkK56Bv8bx/XQcnkk1yDHYGINuwBSS566xJ/pxhvn4HJ63biVKc21CicbJ0ESGrLFddoEKidoiyD/TgrhIqIFCMMTLJxbYgq5HgCK+0JVPYl2JL80EeG0vaF2RqGg4G/8iWtJ3Bl2NJ2x18QZa0Jwisd3zeLIDW6TcrZUfwbl4/4IMC5+rIlb6+J7oTyUjn3O+rENyww+jK/dcY/4Lcb7d13J3OAkJjGvelf82EvRAWRoMB/q97mi86cYuo21YJ6oqTKs/n/xTFt/edXn8ENbRipZnyOrmefRCjXy6S89Eh4nGNLn3tBJ4QK51jvRu88bZrPYZ0uhZuhcyFhFNC8WmqklMN5nQ0GJwOI3cwu6vQ+FYVYDNSvxCZM7Re1M97q+eMT7mQDGlc3yFWQeubyO/jIFuBiUBDp7sdJOwtI+GVpDQfKrN0pM5A/r47bS9v3fII6kWRNzIgEq4TfY86m223u00aSCot7DzaP76MLrZ5Kbbd9/3j91fv4wgRqzD8oFSGIOY2i/aj/mI0ggF9Tn7l40tHvjVFGi5TDKFaEo+8FP3zYW8YXcWLY1aK02v6Q7X9sUOM5VMhpzeNe9+g6C0eozupDqIalbEUfwTUGf05tHvFkUDyyYDj2wAxj9TxQxPD8TKccYizWBU60ZzlYjBEiIXohDcsXmsrAhZWxysM91qRAsfB6U9+/NqNv8ozX289+NprV3vLe95ynjf+8I47nDzcLQf3ccMStS85KMBD0hxHu7ukYj0eki6y84Su+d1HV0TEjfMoiroOIoq/X3RzfJ7Vvmu031ii/4Es0QuGaE88jTXVxSl2zIK+qWsmC1RYm6U6tqFF09BaM80aK41fcsEaUQOyygiw13l7r+C7oDt2uQ4j+ZDrdgbEdbsD4rong47a6nfYzNAon6Rh1gomaZFtJRI1xfcoKoWcKJKzXjyEc6FrkOT00mMD8kQVdQGqra3WUdajtrZq+enIEYMc31SalWoGelK5ilaTHC4E2jNwGBT0rXERAy9yMCbH0H4LU6qySInqaDj2psmEl3wscoH3vEu/cYzRqAqmx35snMwPtMvbP4cc1YPaIoRVGoMqO1P6bILO6hjrNWJxOrQJgsy4TJz50V1aZEZDewiadkstDNbc0wi1cLApaTVyQ8ElnxKfxm26ZynkKLYM02qM1nmj8spxm+UiV9rFp9GGKPyVkPjyosRP9GJCYa8hQ9o990ZoEzsngLuPfNXGMfpbSoRFJEC2uErmCgssot+mynNWKut8Kfgwa8OIw63m0qCG7EPi/BnUCPP2YTA+NemdATzh74U8c0XBttlxTVc/wtgIC92SAYv897A75lthv6vGWHJQGWGVnjejp8Jm1Zg0i/Yk9Q8307ehSmdLb2jmSFViVjwxVWL6WN2g/xYsUojpHxy+IsX0Ifv1L//DvgeuJcvUzFFrUmnI501BUCqXSSfv0FbrleSBQGGNGE8c8fk7JmDwx4zbX//yv4a9hhlaYh1LufDZw2qci4QdhaiDra199pxeX61IhE6Ks0s8Q7cQZ6UbnQt51mMHck6G7ObGwXYa19kG3XKt4qYcQyeV9HHObs1eAxGZTg3k50AWcqxyNwYGqXDONq2qqVutDYzfXDcHD/d2kKasXMjDQzNtA46zRJKXizuTJFYhXZG618mR67roQaZUJ9PsM9K/m/njheQ8uu+WmkJeX0BH7Kepj8Rxot9x3eqikRd03q681TABikPt1pvlpfDkdBzIknVrcXw8WTuTBF3h9GjylyQvxUpHBlYJNW8mb0GfiyS8lNdwdJ8696M4ykUC3j7i76+Dbw+/Z+c7vUEUt14St2Du/vevnr98/fYlAoOC1CFs2Bv0BmTGVcYWXLZW6hb0XbzaWpHem/K/m/K/m/K/m/K/m/K/X06B2k3530353035303530353035398OCZvyv5vyv5vyv5vyv5vyv5vyv5vyv5vyv5vyv5vyv5vyv5vyv/dHVmzK/96Xqqqb8r+/BwVuyv9uyv9uyv9uyv9uyv9uyv9uyv9uyv9uyv9uyv9uyv9uyv9uyv9uyv+uKf/bSr3olzkXspUa6tLwjheKAr+PowzT9PaPo8tLXOUdZtFg888V5Xkcv4+jc64FRudQhl8cMtIw1+MMMGHpuQs22j7C5WPH2hRfu5DYiCl1bsQB0fO1fduZhIdv3h5FcRSKmhUqpRRiPsPcED5z6TGtBBJqu4xyLqcVJZ9Ebs4rV3Ij62bgnVEGnv+jlcGC+WYNhN3UPLcN/Bc3tXLA5aXL7qMEL9fffVo7wiM29Mbje391dfV/94fVhQ==",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,g={},j=[];function f(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:"Draft Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/draftdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"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.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.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)(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},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",description:"Allowed values - signature, stamp.",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,o.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/851f8f65.dce016b3.js b/assets/js/851f8f65.dce016b3.js new file mode 100644 index 000000000..8c95d2521 --- /dev/null +++ b/assets/js/851f8f65.dce016b3.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:()=>y,default:()=>b,frontMatter:()=>x,metadata:()=>s,toc:()=>g});const s=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":"eJztPGtzHDluf4XpSpXXSmtekmyv4rhOazu7ym1s1VrO1kXy6TjdmGla3WQfydZoTqWq+3D/IJ/y9X7a/pIUQLIf85BkW7cnX2Y/eDVsPkAQAAEQwFVk+dRE+yfRK5VUBUhrog9xlIJJtCitUDLaj44zYK80n1gWOrGDo0PG81zNDKsMaMOsYlOQoLkFJmHG0jAdG89ZqdWFSIWcspRbzmbCZoyzMTfwZJeBTFQKKZuIHHqn8lQei3KfvS9zxVM2V5VmR6/+vZ4PF8K2k62tVzCupuz94dbWh28ya0uz3+/zsuypEqQRU5nzseklquin2LFMJ49jNstAA87KEi4ZcCPyOeNpymYinYI1MbMZSJaocs4SpXQqJLdgYlbyKTBZFWPQJmZcpqxQGpiQjDMNPJ1vW7VdGWD/8e7tGzZRuuC2x47yysT1cqnQkNh87qa3GdS7emQCNozVQk5jVvBzxJew7I+VSM5x2wZkiv/HgQdHh4Srra13VVkqbSFlP7st7G9t4ZfvIFczxjVQ/0QVhZKs5JoXYOnAMm7ps4Y/VkJD6o8lzwMu9k/lNtvasvMS9re22KFMRYLIoAmxlamJ79tzXRFJ2PVdCYmYCN+1hTqmJJtlIskIJzPuzrPMeeLA1GBKSKy4gO7ElzGb48SvQKoAQaa0+JOSlud0HBegrUh43j42BBC7Gsu1RXSWSkgbWv0K7Hf+ePD06FA8XSFoKSKrEJK+GGAXPK/AeKhmMcsQqp+g1GCI2P28iEiZsgzENFu7Hk8/VsZ2JmaVQTDbUPi1wikReoHQNuG5ASYmHVwW/BxaqzFFTMzzHvtuzlKY8Cq3MRNIcVZX0GNvlGW8LHOR8HEOSLkMmYfbSsM2nbInBw+I5AWd8RHxNBjGWSomE9DInPiRpvBjAnRIZ40QIM6xGZdMyYWDTlSu9DIJUXMXjyxR0oK0PXZwwUVOwLvNGiZkklcpsHHOk/OYjfMKYqYhdYw7BxRcsaN36sK48Tgn/DADOVKhkgi/VH55YZjxUKU9dpwJ0/ATfgyopkWEaWPVc+1E4cqIgsBiDAou8pgQF7OPasyssDnEyLAll/MYJSbEzMKlHavLmCUZJOf0l+apUGxcWauk21iqVZmqmfS4nChpjfjTCo4MXz4do6OY7cbsScyexWw4iNlwFLPhbsyGT2I2fBaz0SBmo1HMRrsxGz1xYI2exUHkBwS3ARiOHJbt14NdlLs/CkOcjQLT1DJ41pHBwx7b2qq5Cdv+8Ic/nMqrU8nYaYTMdRrts9Oo7nIaxe4bykz8NvS/L/HHzuip/znHn09Gz/zPGXUd7vqfGf4cDU/ltV/wVI4IEsuL8gYo8PO9QuB/eSLCNloU24I8w0YURHH4gGfVgQc/XLf3soN7EVJYwXOzfjuhxwPaUQPS0qZ2cVNErut3RJ8f0Hba8OAXEpPuE4nV1qfA8ATFaGn3ez1/s6zfvFv2wey9Bc6Xbf0Jbh1F0zGKpvX7r6XXA0LCIkxfhomnPVIASDKvx4Pv8ICw0IXoy3DwDHGAl9J6BODXB7T7Fjj4wd/w7ttgd3u4tz0ajHY7GEDbyHUoiu003Z7P5/eBPdR5/PKo8gQN1Wl2aJdOtCpWmB9kHTS9vE5EfweV/T9RUR8HHRZStPvIsAgaS23xtbVsq1I+f2TcVGForZxh/0Y1m7fApE8IB1m/SaZE4oHHPkElG6OB10McbBMm+2nab2ESG9N0uyi2Fxrx5zYhvtVYFL007S30XDod11iwNI3ZcvPK9jRlRVGsaXbtneZ+USzvolcUHjZSvr5FJvE623o+8R1+LVZpOKK78I1shJ4DJXNam8y51Xy0cNlkQvoPnqjYQgcN0yrnGi7RLjVCSdf7/nkssFij2ZMdSyYgeQkcKtg3b732/tiTP26hOwG23D5uaWc4yQFLKmNVwTRM4ZKV3FrQkia74LlIOZly29QAl7wo0QTo//70NP2Xf+6TAwJtfMvwJFgqpgL9QP3fnxxs//eHFT2qsgSdcAMsB1zJxAxs0mMnGeRl44qazWa92Y5JMqVy54f6aDRM3L9navzxjMAte9yUj1ft1JFGy+BH0lm09w3YDsa4YWHkCpOfaIx4aDig29bbOzdct77HA7pxFkDCj857gp9PTqOCk0KCpAzN38pmoE+jD/UYZ+RDesvYD3dg1kykkPMx5Muf7sxodXPO56ry/B2cWt2teopu4Q0/FELWfgvaziBufeSXCx/dt+sV/O0Q0ubOcOUE9gwnwHJhguemi872aO/aIoejBCAf5hhYGIAO4iA9vpQLasDuxgZOEvmzu2UJ7MeoY+1WDKvdskLnYNqIwTkKIUVRFbV/dFLPGlBWeN2jjS8ciX73sEL7dJdW4Je3rIDOyPULnMoh+TGC/+MGzdT3eECyYgGkm9n4c6RI556+pwv2dgYM22oz4IprGbu6C7lmPrOe+3rsLV5v6JN1g9DLliRQWvTIfSlr1iDf+YYin5Xzw31Hfrj1lNf21j0g6lsB1t+YAn2/+759PotI27v/igi1A/adidU5JQs+vcFyp88PiDw9PEtOiK2tIw0TkeetJ0UWmsLLDj7pQA6Ff/byj4l41ZEjXEir0CwIz7ZjmNB7qaVnlIw3D47unnFH2n4TZYkGbpVmGTdO/yaFH48KH2xtBsWCKz6A1rjjhQxw46kM789uHH07aJ/T8Mle55z2Bp1zGqw7pxvMRjxBUyppal8bNJ9afE1HHNqXr5ZFtg2T4pG+lvi2EqwHxwyqylOWi3N6VUmFKXM+x1MNXOqhXHyue5kpZZoe/sXsG7/h/e5LnNL4GPe4Vz9M3MXhtXAYrbMYPt1pHcXes2ddjukwzF3s92a95VMY7PaHe33n0Vrt0GrcMOuF8A2aAGN3OS/yE93pvKhnc2Abt9Pnup3uh9x37tPqHj4ddS6LncHnXhb3bly3ueYWs/o+jOd7s2Lb7HZH+/VXsyO/nPp2G416fG8a9fDpTpsKnw7vwYW6RnH+Ukpc0o/vjfbYfSnHqwjwDtrxjSrxFxNoG9i/OZHu3Y8mPRx0NLRvOwrat6M2Ue7t3Yko24suUNZpJP7ru7c/zQa//X6qDg4ODt68e5+9fj89ODgo8Hev11tpRK06bVoGNVcfEejvZbrj16zS6/UQhRhcuU/D+6Wc/qsbH68f0zuVURypEqM2hZKHabQfpRjnGVTwKCYzAoz9TqXzaP8q8iFC+KcPwMGR/Y8GA0WvIpNkUHD8K5gfGFqKkZ1RHNFLMUaX4jlG+5Eaf4QE1yg1wmAFGBxJvfevQi8XEBnFXs2K9iO3ryiOvC+/bqpDSct0El2HBW+aqm5ppjL0R22F4DwYc/iZ07zBodcLAbWfNdOr1gy0twKO1UuF3yy84nPTmte5+qLFOF4cgxye+FEs5XODkqIy7lZLeJ5UOSqDcFkKPa8fREkjbFFFDW+9Ug3vcO86poAm0G2QuNZ8HsWRsFC029cQgVaffnIJKMQMRaV86tiPCsYAv/EN+FpDB8+LT4biowI2Bjr0MlPyk8cPRzvD0XBnOMIZfGjBp84RIqBxio9qfPZZjJDCBY73RvXnH6X7urx2lzYPMHYP0qBsbTdBqDGjQLDebWwS+hPm+RRu54fjdcHJrZhIk5GFxcsSuO5RjPBnh593Way+1Xu3MNR1HF3evplLlqjtEPnMvslhYt1LJUuUlqAft8MfHszmRru713E0v317869ye0/x8Ga37+5nChlvwun/HrDuPLuOo+x2WH+og9r/jsDuPrluLviIPIUQ7qezsUrnZ0FuXd/WMdxV2G+i8hQ0KkLL8qoRNShhMBnjbPGqGSuVA5crBE0nmtknzqDSjX5n74iZZYC2S6OL0+yNou+91A5ajJCGhaALYVBH1hWcRj12OGmZDaTGLwZUh74U3CwVe0TrnZmKxPijvv+NOHrUThxBN28T9xRAoM7MQlHmlHkxQ1/xmB4R0x6r/yONs8YkAhBu7LDw7VfFSxfsQQv6Qd20BeaV1h57yWUdut4NEWdXVzUZEHVcX7OrKzxV0Gd4719fx00DrtVpoKvdtWhIQFx0RtVN0Ays21pDnZZ1hlqWa/D3fRsAMZVCTs8q7edBZfT6utchyAXAyWPucQBpTWdiKlfsulaZ6KTvjP0lZHsKwEn+3+D9efniB7EClOf98sXz8sXPmKRUguM9h56JkKnj/BnkeY89N1YrOX2xgILnfd+++ig1XAiYEePSqTazLOK2nqjnYfodCurm8IRhia4SwXOKctIqgfAwg+cm0XI3FkqDL2HC0kiXR0ImAZ9qoCcggoVXlpKyyCYMCz7nLNMw+bdHCzh99OIdgo75eM/7/IXvfeh8ERm/AMblnNHGyXGitHO+TSpNYjLJuRYTb4DGrMwBI7LQPuWJe8hzGA1wHGdcnpv4+Vi/OAZesLclSITgl7/8FXsEmX4o3+oU9B2E+uHEPRkq9gjl2KPYRYcRuQttrBfVThJ6CnFwrWEdnx2AL42va9FvqrHBXjLM14hWq8V0CviQ5nvQYJ9rAzzJ3KVBUPFJeDookXhUZQJ4SGDBIKRXNeHoQ8hp19XTwg694bX33lsl1SUm57w9ProDLskPte0YxTlh3C7dHOzt8RHm99XH3WPvTY2JgFre6cLQE8AuBA85QLVmP3cRNeAeU7xcbD889nxm3TZbBigVZiVEsbvUUcLV+bBLEzcJoHhEqrL4kCl8WhNxWQePBEWNyGNV3YUqb8EkZ9OKApgtsm+4NSmGscnPE9JYXbloIpZWOqQkerJwYsKYBk8BK9ipNX/MQBo3nLMJNxZ0zCopEPO6QtdkPSVclqAFyARWokCDQx2KjtuvqG6y2/uffvRpv2EPgSnHyIFuYkhZVRLVECfUSZjh5Ba3vlIf9OL7dgBRd6NUSe9fLUEbJVHEKT3l0ktQZ4+iE3UMGc9dVy8q8B0O4UEO7620/X/5y19bcK11iiwD5lbgaYoRtrdASP5oR/AYRKahRAmouhDhfKB/s2gCIHTENGeFSmtGMnen8SOKyTW1XPSBAXVQgqmSDK+tWt6aOMhY450KhlzP5J+myIIS9wuXwthWGmEI9l+WDz8B4jFpwUBGKHI10ryctxm8CZZQC9OReSC6Kai1EbTEC7yy6kxDIeTd7qm2q9+qWhBUVhXcioSFqUyvm1js3pMDXxfsmwAaUuOFUPrxGlbF6c6UTOBMyDO4AH0H8/5NHZxIPskx2BmAbMMWkOSusyb5c4b5+h2ctG4nSnHuEONejHRXgJ7CWYJOKiI8uDvVERxepJpK+zcZn2NPsgPFSDMzQuNV4TptZCKQINplDXrsBzVDXNWaDOqbbm5EJSOI09gt1Jo94RJTZ8lCRCMNJVn9Zl9wIZsl8HElUK7XsxL3SIMzYO44rhHftJcgNus8GI7532Fl2hG67xnPFfGPVyOJO9IuJIeU85vRfUPnhY9JboGQiK9mEvQvf/5fg0oLZZgnYGrTduVXsk55bpRLKG7PGsg3EHiva4sG+i1dvNAqv2aXHkIaf8jBCNLCKRpUXqIYY9yai3xCQUzXSrDhlxylX4un1YcAbfysX5EjcjgY/CP7WXcGX4+fdXfwFflZnyGw/ln8dgG0TvtdKTvC2/fNAz4qcA9hudI398THZnLhuuCMVQhu2GF07f5rXMNB7rfbOo/hzj9GY5rHbW/rhr0QFkaDAf6ve5qvOlGtaPlUCVoSkyrP5/8UxXd/Wb/5CGpoxUon9k1yPfsoRn+6TC5GR4jHNZbWjRN4Qqx0jtWQ8Mbbru980vhbuBUyFxLOCMVnqUrONJiz0WBwNozcweyuQuM7VYBTGmaIzBn6tmqVyeo541PUeZDG9T1iFbS+jfw+DbIVmAg0dLbbQcLeMhIOJSWBURGuY3UO8tfdaXt565ZHUC+LvJEBkXCd6HvU2Wy73W3SQFJpYefR/slVdLnNS7Htvu+ffLj+gNq6zRQGp5TKEMTcZtF+1F+MVTGgLyjq4OTKkW9NkYbLFAPslsQjL0X/YtgbRtfx4piV4vSG/lBtf+oQY/lUyOlt4z40KHqHx+hOqoOoRmUsxW8BdUZ/Du1ecSSQfDLgaDki5pE6fmoifF6HMw5ROKsCa5qzXAyVCZEyneCXxWttRTjL6miW4V4rjuQkhIRQlEcd5LEqbqPeeojEqAMxWrEVrdCKJlqiEyxB8Q+t8IeThiXqSIOgAA9Jcxzt7pKK9XRIusjOM7rmd59cExE3T4tR1H0+pOyMxUewL3vT6T7pbN4p/oHeKRaeKTzxNL52F8XacRr7pq4TNVBh7bTseA4XHYdrnXhrfHh+yQVfVQ3IKhcRumZWemb8qJZhvoIpg2LZZUkMAkWW3BkQS+4OiCWfDTo6rd9+M0OjmZL6WWufpGK2NUxUIz+gHBVyokgIe9kRDo3uSBLiS5YI5Ikq6tplW1utc65HbW3VwtXRKjpO3laalWoGelK5YmiTHC4FusJwGBT0rYkuAF7kYEyOWSEWpuSnoRoH+ObgvdoJL/lY5AKVAJe55bim0SNMj/3cxCc80q7kwwXkqDvUzkQs8Bn03JnS5xOMc4ix1CfWNUR3MsiMy8R5rt2NRh5YdJbgq0CphcFyjRqhFg42Ja1GVim45FNi4rjNFCyFHGWaYVqN8WHHqLxyrGi5yJV2oY20IYqcJiS+vizxE5lTeBNoyJCwL/z7hYnd+5G7rHzBzzE+1ZUIi0BPk1WskrnC2pzo0qvynJXKumc4tNraMOJwq7k0qD77aEp/BjXC/NMCGJ/V9t4AnvCPQp67enLb7KSmq59hbISFbrWJReZ83B3zvbA/VGOsVqmMsErPm9FTYbNqTGpHe5L6h5vp+1DgtaVUNHOkKjEr7E+VmD4Wxui/A4sUYvoHR4ektT5mv/z5f9iPwLVkmZo5ak0qDfm8qSVLlVbp5B3aaqWTHq9QkiPGE0d8/gIKGPw545YchG9ghq5Xx1Iu8vqoGuciYcchYGVra5+9JNOsFcTSyY53OYv4oshZ6UbnQp732IGc0xtIcx1hO43rbIOuwFZdXI5Rt0r6EHm3Zq+BiLzuBvILMC0vL6TCvdNqVU3dam1g/Oa66Zu4t4M0ZeVCCid6+BtwnJuSHki581diAdsVWZ+d9MpudAfIlEqsmn1Gynkzf7yQ10mX4VJTSAkN6Ij9NPWROE70O65bnSt3QSHuyltyEeOC3VLFvBSenE4CWbJuGZdPJ2vnr6D7nSwqf4PyUqx8A8MCs+bt5B3oC5EEM3oNR/epcz+Ko1wk4J0n/v46+P7oR3ax0xtEccvMuANz9388fPn6zbvXCAwKUoewYW/QG5CPVxlbcNlaqVsLevFqayUJbCpHbypHbypHbypHbypHfz21jTeVozeVozeVozeVozeVozeVo/92SNhUjt5Ujt5Ujt5Ujt5Ujt5Ujt5Ujt5Ujt5Ujt5Ujt5Ujt5Ujn44smJTOfqhFOTdVI7+NShwUzl6Uzl6Uzl6Uzl6Uzl6Uzl6Uzl6Uzl6Uzl6Uzl6Uzl6Uzl6Uzl6Uzl6TeXoVupFv8y5kK28UZejd7JQT/pDHGWYw7d/El1d4SrvMcUGm/9YURLIyYc4uuBaYHQOpf/FIV0Ncz3OAfNEXrpgo+1jXD52rE3xtQtZj5hv50YcED3f2LedZnj09t1xFEehHl6hUsov5jPMDeEzlzvTSiChtqso53JaUfJJ5Oa8dtVasm563jml5/k/WhksmIzWQNjN23PbwH9xUysHXF251D/K/nL93ae1IzxiQ288vg/X19f/B3Eoo+I=","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 i=t(74848),o=t(28453),r=t(33617),l=t.n(r),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const x={id:"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:"eJztPGtzHDluf4XpSpXXSmtekmyv4rhOazu7ym1s1VrO1kXy6TjdmGla3WQfydZoTqWq+3D/IJ/y9X7a/pIUQLIf85BkW7cnX2Y/eDVsPkAQAAEQwFVk+dRE+yfRK5VUBUhrog9xlIJJtCitUDLaj44zYK80n1gWOrGDo0PG81zNDKsMaMOsYlOQoLkFJmHG0jAdG89ZqdWFSIWcspRbzmbCZoyzMTfwZJeBTFQKKZuIHHqn8lQei3KfvS9zxVM2V5VmR6/+vZ4PF8K2k62tVzCupuz94dbWh28ya0uz3+/zsuypEqQRU5nzseklquin2LFMJ49jNstAA87KEi4ZcCPyOeNpymYinYI1MbMZSJaocs4SpXQqJLdgYlbyKTBZFWPQJmZcpqxQGpiQjDMNPJ1vW7VdGWD/8e7tGzZRuuC2x47yysT1cqnQkNh87qa3GdS7emQCNozVQk5jVvBzxJew7I+VSM5x2wZkiv/HgQdHh4Srra13VVkqbSFlP7st7G9t4ZfvIFczxjVQ/0QVhZKs5JoXYOnAMm7ps4Y/VkJD6o8lzwMu9k/lNtvasvMS9re22KFMRYLIoAmxlamJ79tzXRFJ2PVdCYmYCN+1hTqmJJtlIskIJzPuzrPMeeLA1GBKSKy4gO7ElzGb48SvQKoAQaa0+JOSlud0HBegrUh43j42BBC7Gsu1RXSWSkgbWv0K7Hf+ePD06FA8XSFoKSKrEJK+GGAXPK/AeKhmMcsQqp+g1GCI2P28iEiZsgzENFu7Hk8/VsZ2JmaVQTDbUPi1wikReoHQNuG5ASYmHVwW/BxaqzFFTMzzHvtuzlKY8Cq3MRNIcVZX0GNvlGW8LHOR8HEOSLkMmYfbSsM2nbInBw+I5AWd8RHxNBjGWSomE9DInPiRpvBjAnRIZ40QIM6xGZdMyYWDTlSu9DIJUXMXjyxR0oK0PXZwwUVOwLvNGiZkklcpsHHOk/OYjfMKYqYhdYw7BxRcsaN36sK48Tgn/DADOVKhkgi/VH55YZjxUKU9dpwJ0/ATfgyopkWEaWPVc+1E4cqIgsBiDAou8pgQF7OPasyssDnEyLAll/MYJSbEzMKlHavLmCUZJOf0l+apUGxcWauk21iqVZmqmfS4nChpjfjTCo4MXz4do6OY7cbsScyexWw4iNlwFLPhbsyGT2I2fBaz0SBmo1HMRrsxGz1xYI2exUHkBwS3ARiOHJbt14NdlLs/CkOcjQLT1DJ41pHBwx7b2qq5Cdv+8Ic/nMqrU8nYaYTMdRrts9Oo7nIaxe4bykz8NvS/L/HHzuip/znHn09Gz/zPGXUd7vqfGf4cDU/ltV/wVI4IEsuL8gYo8PO9QuB/eSLCNloU24I8w0YURHH4gGfVgQc/XLf3soN7EVJYwXOzfjuhxwPaUQPS0qZ2cVNErut3RJ8f0Hba8OAXEpPuE4nV1qfA8ATFaGn3ez1/s6zfvFv2wey9Bc6Xbf0Jbh1F0zGKpvX7r6XXA0LCIkxfhomnPVIASDKvx4Pv8ICw0IXoy3DwDHGAl9J6BODXB7T7Fjj4wd/w7ttgd3u4tz0ajHY7GEDbyHUoiu003Z7P5/eBPdR5/PKo8gQN1Wl2aJdOtCpWmB9kHTS9vE5EfweV/T9RUR8HHRZStPvIsAgaS23xtbVsq1I+f2TcVGForZxh/0Y1m7fApE8IB1m/SaZE4oHHPkElG6OB10McbBMm+2nab2ESG9N0uyi2Fxrx5zYhvtVYFL007S30XDod11iwNI3ZcvPK9jRlRVGsaXbtneZ+USzvolcUHjZSvr5FJvE623o+8R1+LVZpOKK78I1shJ4DJXNam8y51Xy0cNlkQvoPnqjYQgcN0yrnGi7RLjVCSdf7/nkssFij2ZMdSyYgeQkcKtg3b732/tiTP26hOwG23D5uaWc4yQFLKmNVwTRM4ZKV3FrQkia74LlIOZly29QAl7wo0QTo//70NP2Xf+6TAwJtfMvwJFgqpgL9QP3fnxxs//eHFT2qsgSdcAMsB1zJxAxs0mMnGeRl44qazWa92Y5JMqVy54f6aDRM3L9navzxjMAte9yUj1ft1JFGy+BH0lm09w3YDsa4YWHkCpOfaIx4aDig29bbOzdct77HA7pxFkDCj857gp9PTqOCk0KCpAzN38pmoE+jD/UYZ+RDesvYD3dg1kykkPMx5Muf7sxodXPO56ry/B2cWt2teopu4Q0/FELWfgvaziBufeSXCx/dt+sV/O0Q0ubOcOUE9gwnwHJhguemi872aO/aIoejBCAf5hhYGIAO4iA9vpQLasDuxgZOEvmzu2UJ7MeoY+1WDKvdskLnYNqIwTkKIUVRFbV/dFLPGlBWeN2jjS8ciX73sEL7dJdW4Je3rIDOyPULnMoh+TGC/+MGzdT3eECyYgGkm9n4c6RI556+pwv2dgYM22oz4IprGbu6C7lmPrOe+3rsLV5v6JN1g9DLliRQWvTIfSlr1iDf+YYin5Xzw31Hfrj1lNf21j0g6lsB1t+YAn2/+759PotI27v/igi1A/adidU5JQs+vcFyp88PiDw9PEtOiK2tIw0TkeetJ0UWmsLLDj7pQA6Ff/byj4l41ZEjXEir0CwIz7ZjmNB7qaVnlIw3D47unnFH2n4TZYkGbpVmGTdO/yaFH48KH2xtBsWCKz6A1rjjhQxw46kM789uHH07aJ/T8Mle55z2Bp1zGqw7pxvMRjxBUyppal8bNJ9afE1HHNqXr5ZFtg2T4pG+lvi2EqwHxwyqylOWi3N6VUmFKXM+x1MNXOqhXHyue5kpZZoe/sXsG7/h/e5LnNL4GPe4Vz9M3MXhtXAYrbMYPt1pHcXes2ddjukwzF3s92a95VMY7PaHe33n0Vrt0GrcMOuF8A2aAGN3OS/yE93pvKhnc2Abt9Pnup3uh9x37tPqHj4ddS6LncHnXhb3bly3ueYWs/o+jOd7s2Lb7HZH+/VXsyO/nPp2G416fG8a9fDpTpsKnw7vwYW6RnH+Ukpc0o/vjfbYfSnHqwjwDtrxjSrxFxNoG9i/OZHu3Y8mPRx0NLRvOwrat6M2Ue7t3Yko24suUNZpJP7ru7c/zQa//X6qDg4ODt68e5+9fj89ODgo8Hev11tpRK06bVoGNVcfEejvZbrj16zS6/UQhRhcuU/D+6Wc/qsbH68f0zuVURypEqM2hZKHabQfpRjnGVTwKCYzAoz9TqXzaP8q8iFC+KcPwMGR/Y8GA0WvIpNkUHD8K5gfGFqKkZ1RHNFLMUaX4jlG+5Eaf4QE1yg1wmAFGBxJvfevQi8XEBnFXs2K9iO3ryiOvC+/bqpDSct0El2HBW+aqm5ppjL0R22F4DwYc/iZ07zBodcLAbWfNdOr1gy0twKO1UuF3yy84nPTmte5+qLFOF4cgxye+FEs5XODkqIy7lZLeJ5UOSqDcFkKPa8fREkjbFFFDW+9Ug3vcO86poAm0G2QuNZ8HsWRsFC029cQgVaffnIJKMQMRaV86tiPCsYAv/EN+FpDB8+LT4biowI2Bjr0MlPyk8cPRzvD0XBnOMIZfGjBp84RIqBxio9qfPZZjJDCBY73RvXnH6X7urx2lzYPMHYP0qBsbTdBqDGjQLDebWwS+hPm+RRu54fjdcHJrZhIk5GFxcsSuO5RjPBnh593Way+1Xu3MNR1HF3evplLlqjtEPnMvslhYt1LJUuUlqAft8MfHszmRru713E0v317869ye0/x8Ga37+5nChlvwun/HrDuPLuOo+x2WH+og9r/jsDuPrluLviIPIUQ7qezsUrnZ0FuXd/WMdxV2G+i8hQ0KkLL8qoRNShhMBnjbPGqGSuVA5crBE0nmtknzqDSjX5n74iZZYC2S6OL0+yNou+91A5ajJCGhaALYVBH1hWcRj12OGmZDaTGLwZUh74U3CwVe0TrnZmKxPijvv+NOHrUThxBN28T9xRAoM7MQlHmlHkxQ1/xmB4R0x6r/yONs8YkAhBu7LDw7VfFSxfsQQv6Qd20BeaV1h57yWUdut4NEWdXVzUZEHVcX7OrKzxV0Gd4719fx00DrtVpoKvdtWhIQFx0RtVN0Ays21pDnZZ1hlqWa/D3fRsAMZVCTs8q7edBZfT6utchyAXAyWPucQBpTWdiKlfsulaZ6KTvjP0lZHsKwEn+3+D9efniB7EClOf98sXz8sXPmKRUguM9h56JkKnj/BnkeY89N1YrOX2xgILnfd+++ig1XAiYEePSqTazLOK2nqjnYfodCurm8IRhia4SwXOKctIqgfAwg+cm0XI3FkqDL2HC0kiXR0ImAZ9qoCcggoVXlpKyyCYMCz7nLNMw+bdHCzh99OIdgo75eM/7/IXvfeh8ERm/AMblnNHGyXGitHO+TSpNYjLJuRYTb4DGrMwBI7LQPuWJe8hzGA1wHGdcnpv4+Vi/OAZesLclSITgl7/8FXsEmX4o3+oU9B2E+uHEPRkq9gjl2KPYRYcRuQttrBfVThJ6CnFwrWEdnx2AL42va9FvqrHBXjLM14hWq8V0CviQ5nvQYJ9rAzzJ3KVBUPFJeDookXhUZQJ4SGDBIKRXNeHoQ8hp19XTwg694bX33lsl1SUm57w9ProDLskPte0YxTlh3C7dHOzt8RHm99XH3WPvTY2JgFre6cLQE8AuBA85QLVmP3cRNeAeU7xcbD889nxm3TZbBigVZiVEsbvUUcLV+bBLEzcJoHhEqrL4kCl8WhNxWQePBEWNyGNV3YUqb8EkZ9OKApgtsm+4NSmGscnPE9JYXbloIpZWOqQkerJwYsKYBk8BK9ipNX/MQBo3nLMJNxZ0zCopEPO6QtdkPSVclqAFyARWokCDQx2KjtuvqG6y2/uffvRpv2EPgSnHyIFuYkhZVRLVECfUSZjh5Ba3vlIf9OL7dgBRd6NUSe9fLUEbJVHEKT3l0ktQZ4+iE3UMGc9dVy8q8B0O4UEO7620/X/5y19bcK11iiwD5lbgaYoRtrdASP5oR/AYRKahRAmouhDhfKB/s2gCIHTENGeFSmtGMnen8SOKyTW1XPSBAXVQgqmSDK+tWt6aOMhY450KhlzP5J+myIIS9wuXwthWGmEI9l+WDz8B4jFpwUBGKHI10ryctxm8CZZQC9OReSC6Kai1EbTEC7yy6kxDIeTd7qm2q9+qWhBUVhXcioSFqUyvm1js3pMDXxfsmwAaUuOFUPrxGlbF6c6UTOBMyDO4AH0H8/5NHZxIPskx2BmAbMMWkOSusyb5c4b5+h2ctG4nSnHuEONejHRXgJ7CWYJOKiI8uDvVERxepJpK+zcZn2NPsgPFSDMzQuNV4TptZCKQINplDXrsBzVDXNWaDOqbbm5EJSOI09gt1Jo94RJTZ8lCRCMNJVn9Zl9wIZsl8HElUK7XsxL3SIMzYO44rhHftJcgNus8GI7532Fl2hG67xnPFfGPVyOJO9IuJIeU85vRfUPnhY9JboGQiK9mEvQvf/5fg0oLZZgnYGrTduVXsk55bpRLKG7PGsg3EHiva4sG+i1dvNAqv2aXHkIaf8jBCNLCKRpUXqIYY9yai3xCQUzXSrDhlxylX4un1YcAbfysX5EjcjgY/CP7WXcGX4+fdXfwFflZnyGw/ln8dgG0TvtdKTvC2/fNAz4qcA9hudI398THZnLhuuCMVQhu2GF07f5rXMNB7rfbOo/hzj9GY5rHbW/rhr0QFkaDAf6ve5qvOlGtaPlUCVoSkyrP5/8UxXd/Wb/5CGpoxUon9k1yPfsoRn+6TC5GR4jHNZbWjRN4Qqx0jtWQ8Mbbru980vhbuBUyFxLOCMVnqUrONJiz0WBwNozcweyuQuM7VYBTGmaIzBn6tmqVyeo541PUeZDG9T1iFbS+jfw+DbIVmAg0dLbbQcLeMhIOJSWBURGuY3UO8tfdaXt565ZHUC+LvJEBkXCd6HvU2Wy73W3SQFJpYefR/slVdLnNS7Htvu+ffLj+gNq6zRQGp5TKEMTcZtF+1F+MVTGgLyjq4OTKkW9NkYbLFAPslsQjL0X/YtgbRtfx4piV4vSG/lBtf+oQY/lUyOlt4z40KHqHx+hOqoOoRmUsxW8BdUZ/Du1ecSSQfDLgaDki5pE6fmoifF6HMw5ROKsCa5qzXAyVCZEyneCXxWttRTjL6miW4V4rjuQkhIRQlEcd5LEqbqPeeojEqAMxWrEVrdCKJlqiEyxB8Q+t8IeThiXqSIOgAA9Jcxzt7pKK9XRIusjOM7rmd59cExE3T4tR1H0+pOyMxUewL3vT6T7pbN4p/oHeKRaeKTzxNL52F8XacRr7pq4TNVBh7bTseA4XHYdrnXhrfHh+yQVfVQ3IKhcRumZWemb8qJZhvoIpg2LZZUkMAkWW3BkQS+4OiCWfDTo6rd9+M0OjmZL6WWufpGK2NUxUIz+gHBVyokgIe9kRDo3uSBLiS5YI5Ikq6tplW1utc65HbW3VwtXRKjpO3laalWoGelK5YmiTHC4FusJwGBT0rYkuAF7kYEyOWSEWpuSnoRoH+ObgvdoJL/lY5AKVAJe55bim0SNMj/3cxCc80q7kwwXkqDvUzkQs8Bn03JnS5xOMc4ix1CfWNUR3MsiMy8R5rt2NRh5YdJbgq0CphcFyjRqhFg42Ja1GVim45FNi4rjNFCyFHGWaYVqN8WHHqLxyrGi5yJV2oY20IYqcJiS+vizxE5lTeBNoyJCwL/z7hYnd+5G7rHzBzzE+1ZUIi0BPk1WskrnC2pzo0qvynJXKumc4tNraMOJwq7k0qD77aEp/BjXC/NMCGJ/V9t4AnvCPQp67enLb7KSmq59hbISFbrWJReZ83B3zvbA/VGOsVqmMsErPm9FTYbNqTGpHe5L6h5vp+1DgtaVUNHOkKjEr7E+VmD4Wxui/A4sUYvoHR4ektT5mv/z5f9iPwLVkmZo5ak0qDfm8qSVLlVbp5B3aaqWTHq9QkiPGE0d8/gIKGPw545YchG9ghq5Xx1Iu8vqoGuciYcchYGVra5+9JNOsFcTSyY53OYv4oshZ6UbnQp732IGc0xtIcx1hO43rbIOuwFZdXI5Rt0r6EHm3Zq+BiLzuBvILMC0vL6TCvdNqVU3dam1g/Oa66Zu4t4M0ZeVCCid6+BtwnJuSHki581diAdsVWZ+d9MpudAfIlEqsmn1Gynkzf7yQ10mX4VJTSAkN6Ij9NPWROE70O65bnSt3QSHuyltyEeOC3VLFvBSenE4CWbJuGZdPJ2vnr6D7nSwqf4PyUqx8A8MCs+bt5B3oC5EEM3oNR/epcz+Ko1wk4J0n/v46+P7oR3ax0xtEccvMuANz9388fPn6zbvXCAwKUoewYW/QG5CPVxlbcNlaqVsLevFqayUJbCpHbypHbypHbypHbypHfz21jTeVozeVozeVozeVozeVozeVo/92SNhUjt5Ujt5Ujt5Ujt5Ujt5Ujt5Ujt5Ujt5Ujt5Ujt5Ujt5Ujn44smJTOfqhFOTdVI7+NShwUzl6Uzl6Uzl6Uzl6Uzl6Uzl6Uzl6Uzl6Uzl6Uzl6Uzl6Uzl6Uzl6Uzl6TeXoVupFv8y5kK28UZejd7JQT/pDHGWYw7d/El1d4SrvMcUGm/9YURLIyYc4uuBaYHQOpf/FIV0Ncz3OAfNEXrpgo+1jXD52rE3xtQtZj5hv50YcED3f2LedZnj09t1xFEehHl6hUsov5jPMDeEzlzvTSiChtqso53JaUfJJ5Oa8dtVasm563jml5/k/WhksmIzWQNjN23PbwH9xUysHXF251D/K/nL93ae1IzxiQ288vg/X19f/B3Eoo+I=",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,f={},g=[];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,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Draft Document"}),"\n",(0,i.jsx)(l(),{method:"post",path:"/draftdocument",context:"endpoint"}),"\n",(0,i.jsx)(n.p,{children:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file."}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"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.p,{children:[(0,i.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,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)(p(),{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 final PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\nfalse - If you choose not to merge, the completion certificate will be provided as a separate 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",description:"Allowed values - signature, stamp.",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,i.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 b(e={}){const{wrapper:n}={...(0,o.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/9c9cb35e.370bccf1.js b/assets/js/9c9cb35e.370bccf1.js new file mode 100644 index 000000000..f79cffea7 --- /dev/null +++ b/assets/js/9c9cb35e.370bccf1.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:()=>f,contentTitle:()=>b,default:()=>j,frontMatter:()=>x,metadata:()=>s,toc:()=>g});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":"eJztPNtyGzeWv4LtmqrEnBZFUpLtaF9WSTyJdry2KpY3tStpFLD7kA2rG+gAaFGMilXzMH+wT/s6n5Yv2ToHQF94kWRbSewt5sERG7eDg3OAc7+NLJ+a6PAsOoWizLkFE13EUQom0aK0QsnoMDrNgIVm9o0Gjt/Z0ckx43muZoZVBrRhVrEEG4EllbGqEL/wcQ7MholjNstEkjED+hoYN2ycV1BqIa1hE6XZFCRoboWcslQlVQHYMBM2Y6WGFCZCQsqM1VViKw2mz96WSjJTJQkYM6nyeiUHhlAyZjYDAlSDrbQ0jLNKip8rYL1e6H0p0l6P2YxblnDJxoDbSXE3HiBogTPm2KYkTWxKSMREYGc/V/9cnstTUR6yt2WueMrmqtLs5Nu/1FPgvPjtrNf7FsbVlL097vUuvsysLc3h7i4vy74qQRoxlTkfm36iit0UO5bp5AliEDTgrAQrcCPyOeNpymYinYI1tGPJElXOWaKUToV0qC/5FJisijFoEzMuU1YoDUxIxpkGns53rNqpDLB/f/P6FR5HwW2fneSVievlUqEhsfncTY8YCLv6wmHm6T6ej5DTmBX8Cg9SWPZzJZIr3LYBSWj1Z0K46vXeVGWptIWU/ei2cNjrYcvXkKsZ4xqof6KKQklWcs0LsERteGDYrOHnSmhIHanwPA+4ODyXO3jO8xIOez12LFORIDJoQvzK1MT37buuiCTs+sYfrOvaQh2evCNixMmMu/Msc544MDUgTVhxDd2Jb2I2x4m/BakCBJnS4hclLc/pOK5BW5HwvH1sCCARmuWa+KJUQtrw1a/A/ssfD54eHYqnKwQtRWQVQlKLAXbN8wqMh2oWswyh+gFKDYbo28+LiJQpy0BMs43r8fRdZWxnYlYZBLMNhV8rnBKhFwhtE54bYGLSwWXBr6C1GlN0CfG8z76esxQmvMptzARSnNUV9NkrZRkvy1wkdNvgRYLMw/GO2KFT9uTgAZG8oDM+0epapIBXQiomE9DInNhIU/gxATqks5IG4PaIc2zGJVNy6aATlSu9SkL0uYtHlihpQdo+O7rmIifg3WYNEzLJqxTYOOfJVUz3ZMw0pI5x54C3buzonbrgZepwTvhhBnKkQiURfqn88sI0N1afnWbCNPyEjQHVtIgwbax6rp0oXBlREFiMQcFFHhPiYvZOjZkVNocYGbbkch6zlFuImYUbO1Y3MUsySK7oL81Todi4shYvalwz1apM1Ux6XE6UtEb8soYjQ8v7Y3QUs/2YPY3Z85gNBzEbjmI23I/Z8GnMhs9jNhrEbDSK2Wg/ZqOnDqzRc49rXiO4DcBw5LBsPx/s4r37UhjibLwwTX0Hzzp38LDPer2am/DbTz/9dC5vzyVj5xEy13l0yM6just5FLs2vDOxbeh/3+CPvdEz/3OOP5+OnvufM+o63Pc/M/w5Gp7LhV/wXI4IEsuL8g4osPlRIfC/PBHhN1oUv4X7DD/iRRSHBjyrDjzYsGjvZQ/3IqSwgudm83ZCj09oRw1IK5vax00RuW7eETV/Qttpw4MtdE26JrpWW02B4QmK0cruD/r+Zdm8ebfsJ7P3Fjgft/WnuHW8mk7xatq8//r2+oSQsAzTx2HiWZ8EALqZN+PBd/iEsNCF6ONw8BxxgI/SZgRg6ye0+xY42OBfeNc22N8ZHuyMBqP9DgZQN3IdimInTXfm8/ljYA9lHr88ijxBQnWSHaqhE62KNeoHaQdNLy8T0d9BZP8PFNTHQYaFFPW+rgYbNL62lG1VyudfGDdVGFoLZ9i/Ec3mLTCpCeEg7TfJlEg88NgniGRjVPD6iIMdwuRumu62MIkf03SnKHaWPuLPHUJ862NR9NO0v9Rz5XTcx4KlacxWP6/9nqasKIoNn933zufdoljdRb8oPGwkfH3VJ/MDyWyb+cR3+L1YpeGI7sJ3shFaDpTMaW1S59bz0dJjkwnpGzxRsaUOGqZVzjXcoF5qhJKu9+PzWGCxRrInPZZUQLISOFSwL1976f2JJ3/cQncC/HL/uJWd4SRH3mDGNEzhhpXcWtCSJrvmuUidvW2HPsANL0pUAXb/dn6e/vlPu2SAQB3fMjwJloqpQDvQ7t/Ojnb++2JNj6osQSfcAMsBVzIxA5v02VkGedmYomazWX+2Z5JMqdzZod4ZDRP376Uav7skcMs+N+WTdTt1pNFS+JF0lvV9A7aDMW5YGLlG5ScaIx4aDui19frOHc+t7/EJvThLIGGjs55g89l5VHASSJCUoflb2Qz0eXRRj3FKPqT3jL14ALNmIoWcjyFfbXowo9Wfcz5XlefvYNTqbtVTdAtv2FAIWdstaDuDuNXIb5YaXdtiDX87hLS5Mzw5gT3DCbBcmGC56aKzPdqbtsjgKMGZhsfAwgA2rqn0o7mgBuxhbOBuIn929yyB/Rh1rM2KYbV7VugcTBsxOEchpCiqoraPTupZA8oKL3u08YUj0WkQVmif7soK/OaeFbzZfsMC53JIdoxg/7hDMvU9PqG7Ygmku9n4Q26Rzjv9SA/s/QwYttVmwDXPMnZ1D3LNfGYz9/XZa3ze0CbrBqGVLUmgtGiR+1jWrEF+8AtFNqu2HW4z5bV7fULUtwas35gCfb/Hfn0+iEjbu/+MCLUD9oOJ1RklCz69Q3On5k+IPD08K0aIXu9Ew0TkeculyMKn4NlBlw7kUHi3l3cm4lNHhnAhrUK1ILhtxzAhf6klN0rGG4eje2fckbZ9os4LrTTLuHHyNwn8eFTosLUZFEum+ABaY44XMsCNpzJ8PL1x9NWgfU7DpwedczoYdM5psOmc7lAb8QRNqaSpbW3QNLX4mo44fF99WpbZNkyKR/pCom8laA+OGVSVpywXV+RVSYUpcz7HUw1c6qFcdtd9kyllmh7eY/al3/Bh1xOnNDrjnvRrx8RDDF5Lh9E6i+GzvdZRHDx/3uWYDsM8RH9v1ls9hcH+7vBg11m01hu0GjPM5kv4DkmAsYecF9mJHnRe1LM5sK3Z6UPNTo9D7nuPqXUPn406j8Xe4EMfi0dXrttcc49a/RjK86NpsW12e6D++rvpkR9Pffu/hUQ9fLbXpsJnw0cwoW4QnD+WElfk40ejPfZYwvE6AnyAdHynSPzRBNoG9jcn0oPHkaSHg46E9lVHQPtq1CbKg4MHEWV70SXKOo/Ef379+ofZ4K/fTdXR0dHRqzdvsxdvp0dHRwX+7vf7a5WodadNy6Dk6iMC/btMb/yGVfr9PqIw5ZYf0vDdUk7/1Y2PN4/pe+/zb2TZOXgMZ8oaA87H3wJ11z/OWvPb8fnHcSDz/53LKI5USQHFSh6n0WHkgpNDqG4Uk4oJxn6t0nl0eBv58DH80wdn4dDddwaDoG8jk2RQcPwrqKYYNj0ROU6FEVCgTRRHFE+AMdRIfdFhpMbvILFRjL6uEg0SYHAOGnd4G3q5sNko9sJ4dBg56o/iyHt86k8MZKLQh1umk2gRFrxrqvpLM5WhP+q4ZZwHI1M/cBoaulgKG/+gmdozLBq0NpNxrfk8Wo5QDyGpwZ/oxtUxd/k8PBLCokmkjpOkblEcCQtFe5UNh6bV+2M6AYU7oVij9x1Lx8KL914Tx5WZkh800IeDfMjQd2p8+UHkiIO99WPNWT/wdFzr6sJdUjnCIEtIg1S800QLx4wi9vr3UWroT1jm0/aazkexsubppijyVvCqyUgV5mUJXPcpmPuD8wQoFYPnSUXZEPW13NlZDWq9s+Eijm7u38wNS9ROCFFnX+Ywsc6lzBKlJegn7TiVT2Zzo/39RRzN79/e/LPc3jM8vNn9u/uRYvubvIc/Ata954s4yu6H9fs6++APBHb/6aJ5Y5dEiMuxSueX4d5a3NcxPGbYD3NhjuVrnYJuIWKsVA5crmDieOKs+4p9gRrPF7EL5KCgcaFNeMjYDA3cGhLABBSK7wp3FfOyjosoZz6QF50CL/ADiWmmGhvsJcN8xk04Bma1mE4Bbd6+Bw32YfHAKalL+vASPglWvlLDtVCVCeChIRxflxzQtm0zEC5XQ8hpVytrYYfM7e2999ung1/wcZUYR//69OQBuCSVcYfZrI7Jd7t0c7DXpyeYiiMmXvzrs7emxkRALe90YSiOsWvBQ7h+fbfPnfMbnN1T0WY7PoK+T4LZYasApcKshSh2WXeYJ1Dn3a1M3ORq4RGpyqLPQfgMBGOhNB08EhQ1Ik9V9RCqvAeTnE0rijW0yLIhL4fCjZpUGiFdQh/pG2mlQ/aQJwvsidl9DZ4CVrBTa/6YgTRuOGcTbizoGFP9EPO6Qu2inhJuStACZAJrUaDBoe6y0mvltS4Ounkpb3946TP0wh4CU46RA93EkLKqJKohTqjzpcLJLW99RVBC7gB9uUkwXBU9KKvJm0JK0EZJVJeUnnIpfnEkTBIJaltjyHjuuvqrAk3mCA9yeBeYcNf++o9/tuDaKOmuAuZW4GmKwXD3QEgqpSN4lPQ1lHgDqi5EOB/of1t+BBA6YprLQqU1I5mH0/gJhc+Z+l70Przaf2iqJEPFor5vTRzuWOPFSkM6Kimy5AQscb9wI4xtZfyEuNzV++EHQDwmLRhIDEGuRpqX8zaDN35NtTQd5SWJbrZY/Qyu8AKvrLrUUAj5sHeqbZWzqr4IKqsKbkXCwlSm380BdK6fwNcF+zKAhtR4LZR+soFVcbpLJRO4FPISrkE/QMB7VccRpXyOxG1nALINW0CSe86aPK0ZptZ2cNJ6nSgbsUOMBzHSXQF6CpcJqilEePBwqiM4/JVqKu3NKj4dlu4OvEaamREan+hWR3hPBBJEOwO5z75XM8RVzMocMAwU1Xc3N6KSEcSpy51uz55wiVluZM3B1Da8yWr3WsGFbJZAO2ig3GOneSfOmoMzYJonrhHftZdwbdYh6xxTNcPKtCO0oTCeK+IfmzWXbtqF5JjS8zJ6b+i80O7rFgg5s2omQf/69/81KLRQMmiCGebHk82tFC/Ac6Nc7l971kC+gcD7ZI9CddE589fpsncbNML94EQLyv0uxhhU4sIS8Oqlh0Q1No2ucvy5aNfeP7/VrT8j5XM4GPx/1q33Bp+Pbr0/+Ix06+cIrDfn338BbZJ3194dwT1x94B3CpzFM1f67p5o7V/EtTNlHYIbdhgt3H+NOSDc+/eYCJwNoXEvePU2bIbQMBoM8H9Ll2Cn8gkqO3VVlHz+L1H8cN/G3WfgPqM35S5kfZ2NvjelLJLMCUDGdG/yNUPu2UAbb0LmQsJlQMrlaDC4PIgcvvfXIeeNKsC9/jPUr2ZaYYESL/tYPWd8isILLq8fEVeg9X1U9X6Q3YWE/cHgclgj4WAVCceSEi+oGM6pugL5++60vbx1yyOoN0XesHYkXCdqjzqbbX93mzSQVFrYeXR4dhvd7PBS7Lj2w7OLxQVSnc0Uev1KZQhibrPoMNpdcQJSNSJ0MZ3dRqTyR+HKM1ymGNWycu3xUuxeD/vDaBEvj1l7Td7RH6qd9x1iLJ8KOb1v3EWDozd4ju6oOphqRMFS/BVQFvQH0e4VRwLpJwOOOiCiHsnjh8Z1+iIccnBqrvNTNoe57HkMjseOL3H5uVrjHWw5B8+CZ46cbbWvLWo2FNX+sChqebjwR8tnhT9rOfmsIefa4RNk0iEJc6P9fZJ6ng1JPNh7Ti/v/tPFhUN+y8JLAcxtM6WL1enY2/ynrv0pipbsPR2jy7LNZaP9Y4P5wy+5pObXgKzTrlGrXavUui22FJw1mAwPdBePGOmCeNwbEB73B4TH54OObOB338zQvPD0jNevOD3V7Zcan+MLpFshJ4qI3p/26xLkGzSc4qVETLMi0UGeqKIu0NLrhSG//uOf9aher9Y2ncUYVc7XlWalmoHGumRYfWWSw41AIwIOg4LaDCnGFLrPixyMQT+1tDB1RccwkROttd4emPCSj0Uu8NZ14ekU59q6uE2f/ZgBho5g0xfa5bVeQ46XdW2GaZVXYzOlryZYwi1mnI2xeBMa4kBmXCbO5uduELJdodKJ9tRSC4M1qTRCLRxsSlrNE8sKLvmUjE8xayMrhVzgNcu0GqNJ3Ki8ckZfy0WutItKpA1R2Agh8cVNiU0kliLPasiQrq+95dfEzvLuLgdf1WyMTo4SYRGoo1vFKpkrLECGxpAqz1mprHNgoPTbhhGHW82lQZHVwRLOoEaYN8qC8aH7bw3gCb8U8soVzdlhZzVd/QhjIyx0U2qXefNJd8x3wn5fjbEklzLCKj1vRk+FzaoxXfPtSeofbqbvQtG61iXezJGqxKyR41VidjH7d/cNWKQQs3t0ckxiwhP269//h70EriXL1MxRa1JpyOdNfTwqJ0cn79BWv/Jk9ucV1qSzRKRyGjxRAYM/ZtySaeUVzNBo5VjKhQKdVONcJHXtQdPrHbr6g62qgt0UQJeYgb4Yzko3Ohfyqs+O5Jysx42lCL/TuM42yJOyod5fXeWvgYjslQbyazAt+xikwnm4tKqmbrU2MH5z3RwV3NtRmrJyKU8FbaMNOM7cQ64l7uw+WKVvTWpLJ4ekW10KZEp15MwhSzWf2Gb+eCl5hbxNK59C3ktAR+ynaRV6REz6Hddf+xSStSSAdO9bMq7hgqZTfpGXwpPTWSBL1s1Vf3+ydnqftDwh8Tc8oLwUa70HWEXPvJ68AX0tEvDS2AaO3qXOu1Ec5SIBr4T69+vou5OX7HqvP4jillj3AObefXn8zYtXb14gMHiROoQN+4P+gGxlytiCy9ZKnk9OGzlrKTqrFv639T239T239T239T239T239T239T239T239T239T1XNrWt77mt77mt77mt77mt77mt77kttLCt77mt77mt77mt77mt77mt77mt77mt77mt77mt77mt77mt77mt7/mo5shtfc9tfc9tfc9tfc+t2Wlb33Nb33Nb33Nb33Nb33Nb33Nb33Nb33Nb3xODyVtpRbtlzgVlDfq6PS7h72y56udFHGWYEXh4Ft3eIgW+1fligZ9/rijB6ewijq65Fhi5RcmEcch9w0SmK8AcqG9cINrOKa4fuwOn4PGlHEpM3nMjjggHd/ZtJy2evH5zGsXR2FcmLVRKSch8holPfObywlrZUfTtNsq5nFaUWRW5OReuiEvWzfW7olw//0crPQtz4hoIu0mAbhv4L25q7YDbW5dHuFjU/V3TxhEesaE3nt/FYrH4P4yrJY0=","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),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),h=t.n(c),p=t(63723),m=t.n(p),u=(t(18766),t(79329),t(9303));const 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:"eJztPNtyGzeWv4LtmqrEnBZFUpLtaF9WSTyJdry2KpY3tStpFLD7kA2rG+gAaFGMilXzMH+wT/s6n5Yv2ToHQF94kWRbSewt5sERG7eDg3OAc7+NLJ+a6PAsOoWizLkFE13EUQom0aK0QsnoMDrNgIVm9o0Gjt/Z0ckx43muZoZVBrRhVrEEG4EllbGqEL/wcQ7MholjNstEkjED+hoYN2ycV1BqIa1hE6XZFCRoboWcslQlVQHYMBM2Y6WGFCZCQsqM1VViKw2mz96WSjJTJQkYM6nyeiUHhlAyZjYDAlSDrbQ0jLNKip8rYL1e6H0p0l6P2YxblnDJxoDbSXE3HiBogTPm2KYkTWxKSMREYGc/V/9cnstTUR6yt2WueMrmqtLs5Nu/1FPgvPjtrNf7FsbVlL097vUuvsysLc3h7i4vy74qQRoxlTkfm36iit0UO5bp5AliEDTgrAQrcCPyOeNpymYinYI1tGPJElXOWaKUToV0qC/5FJisijFoEzMuU1YoDUxIxpkGns53rNqpDLB/f/P6FR5HwW2fneSVievlUqEhsfncTY8YCLv6wmHm6T6ej5DTmBX8Cg9SWPZzJZIr3LYBSWj1Z0K46vXeVGWptIWU/ei2cNjrYcvXkKsZ4xqof6KKQklWcs0LsERteGDYrOHnSmhIHanwPA+4ODyXO3jO8xIOez12LFORIDJoQvzK1MT37buuiCTs+sYfrOvaQh2evCNixMmMu/Msc544MDUgTVhxDd2Jb2I2x4m/BakCBJnS4hclLc/pOK5BW5HwvH1sCCARmuWa+KJUQtrw1a/A/ssfD54eHYqnKwQtRWQVQlKLAXbN8wqMh2oWswyh+gFKDYbo28+LiJQpy0BMs43r8fRdZWxnYlYZBLMNhV8rnBKhFwhtE54bYGLSwWXBr6C1GlN0CfG8z76esxQmvMptzARSnNUV9NkrZRkvy1wkdNvgRYLMw/GO2KFT9uTgAZG8oDM+0epapIBXQiomE9DInNhIU/gxATqks5IG4PaIc2zGJVNy6aATlSu9SkL0uYtHlihpQdo+O7rmIifg3WYNEzLJqxTYOOfJVUz3ZMw0pI5x54C3buzonbrgZepwTvhhBnKkQiURfqn88sI0N1afnWbCNPyEjQHVtIgwbax6rp0oXBlREFiMQcFFHhPiYvZOjZkVNocYGbbkch6zlFuImYUbO1Y3MUsySK7oL81Todi4shYvalwz1apM1Ux6XE6UtEb8soYjQ8v7Y3QUs/2YPY3Z85gNBzEbjmI23I/Z8GnMhs9jNhrEbDSK2Wg/ZqOnDqzRc49rXiO4DcBw5LBsPx/s4r37UhjibLwwTX0Hzzp38LDPer2am/DbTz/9dC5vzyVj5xEy13l0yM6just5FLs2vDOxbeh/3+CPvdEz/3OOP5+OnvufM+o63Pc/M/w5Gp7LhV/wXI4IEsuL8g4osPlRIfC/PBHhN1oUv4X7DD/iRRSHBjyrDjzYsGjvZQ/3IqSwgudm83ZCj09oRw1IK5vax00RuW7eETV/Qttpw4MtdE26JrpWW02B4QmK0cruD/r+Zdm8ebfsJ7P3Fjgft/WnuHW8mk7xatq8//r2+oSQsAzTx2HiWZ8EALqZN+PBd/iEsNCF6ONw8BxxgI/SZgRg6ye0+xY42OBfeNc22N8ZHuyMBqP9DgZQN3IdimInTXfm8/ljYA9lHr88ijxBQnWSHaqhE62KNeoHaQdNLy8T0d9BZP8PFNTHQYaFFPW+rgYbNL62lG1VyudfGDdVGFoLZ9i/Ec3mLTCpCeEg7TfJlEg88NgniGRjVPD6iIMdwuRumu62MIkf03SnKHaWPuLPHUJ862NR9NO0v9Rz5XTcx4KlacxWP6/9nqasKIoNn933zufdoljdRb8oPGwkfH3VJ/MDyWyb+cR3+L1YpeGI7sJ3shFaDpTMaW1S59bz0dJjkwnpGzxRsaUOGqZVzjXcoF5qhJKu9+PzWGCxRrInPZZUQLISOFSwL1976f2JJ3/cQncC/HL/uJWd4SRH3mDGNEzhhpXcWtCSJrvmuUidvW2HPsANL0pUAXb/dn6e/vlPu2SAQB3fMjwJloqpQDvQ7t/Ojnb++2JNj6osQSfcAMsBVzIxA5v02VkGedmYomazWX+2Z5JMqdzZod4ZDRP376Uav7skcMs+N+WTdTt1pNFS+JF0lvV9A7aDMW5YGLlG5ScaIx4aDui19frOHc+t7/EJvThLIGGjs55g89l5VHASSJCUoflb2Qz0eXRRj3FKPqT3jL14ALNmIoWcjyFfbXowo9Wfcz5XlefvYNTqbtVTdAtv2FAIWdstaDuDuNXIb5YaXdtiDX87hLS5Mzw5gT3DCbBcmGC56aKzPdqbtsjgKMGZhsfAwgA2rqn0o7mgBuxhbOBuIn929yyB/Rh1rM2KYbV7VugcTBsxOEchpCiqoraPTupZA8oKL3u08YUj0WkQVmif7soK/OaeFbzZfsMC53JIdoxg/7hDMvU9PqG7Ygmku9n4Q26Rzjv9SA/s/QwYttVmwDXPMnZ1D3LNfGYz9/XZa3ze0CbrBqGVLUmgtGiR+1jWrEF+8AtFNqu2HW4z5bV7fULUtwas35gCfb/Hfn0+iEjbu/+MCLUD9oOJ1RklCz69Q3On5k+IPD08K0aIXu9Ew0TkeculyMKn4NlBlw7kUHi3l3cm4lNHhnAhrUK1ILhtxzAhf6klN0rGG4eje2fckbZ9os4LrTTLuHHyNwn8eFTosLUZFEum+ABaY44XMsCNpzJ8PL1x9NWgfU7DpwedczoYdM5psOmc7lAb8QRNqaSpbW3QNLX4mo44fF99WpbZNkyKR/pCom8laA+OGVSVpywXV+RVSYUpcz7HUw1c6qFcdtd9kyllmh7eY/al3/Bh1xOnNDrjnvRrx8RDDF5Lh9E6i+GzvdZRHDx/3uWYDsM8RH9v1ls9hcH+7vBg11m01hu0GjPM5kv4DkmAsYecF9mJHnRe1LM5sK3Z6UPNTo9D7nuPqXUPn406j8Xe4EMfi0dXrttcc49a/RjK86NpsW12e6D++rvpkR9Pffu/hUQ9fLbXpsJnw0cwoW4QnD+WElfk40ejPfZYwvE6AnyAdHynSPzRBNoG9jcn0oPHkaSHg46E9lVHQPtq1CbKg4MHEWV70SXKOo/Ef379+ofZ4K/fTdXR0dHRqzdvsxdvp0dHRwX+7vf7a5WodadNy6Dk6iMC/btMb/yGVfr9PqIw5ZYf0vDdUk7/1Y2PN4/pe+/zb2TZOXgMZ8oaA87H3wJ11z/OWvPb8fnHcSDz/53LKI5USQHFSh6n0WHkgpNDqG4Uk4oJxn6t0nl0eBv58DH80wdn4dDddwaDoG8jk2RQcPwrqKYYNj0ROU6FEVCgTRRHFE+AMdRIfdFhpMbvILFRjL6uEg0SYHAOGnd4G3q5sNko9sJ4dBg56o/iyHt86k8MZKLQh1umk2gRFrxrqvpLM5WhP+q4ZZwHI1M/cBoaulgKG/+gmdozLBq0NpNxrfk8Wo5QDyGpwZ/oxtUxd/k8PBLCokmkjpOkblEcCQtFe5UNh6bV+2M6AYU7oVij9x1Lx8KL914Tx5WZkh800IeDfMjQd2p8+UHkiIO99WPNWT/wdFzr6sJdUjnCIEtIg1S800QLx4wi9vr3UWroT1jm0/aazkexsubppijyVvCqyUgV5mUJXPcpmPuD8wQoFYPnSUXZEPW13NlZDWq9s+Eijm7u38wNS9ROCFFnX+Ywsc6lzBKlJegn7TiVT2Zzo/39RRzN79/e/LPc3jM8vNn9u/uRYvubvIc/Ata954s4yu6H9fs6++APBHb/6aJ5Y5dEiMuxSueX4d5a3NcxPGbYD3NhjuVrnYJuIWKsVA5crmDieOKs+4p9gRrPF7EL5KCgcaFNeMjYDA3cGhLABBSK7wp3FfOyjosoZz6QF50CL/ADiWmmGhvsJcN8xk04Bma1mE4Bbd6+Bw32YfHAKalL+vASPglWvlLDtVCVCeChIRxflxzQtm0zEC5XQ8hpVytrYYfM7e2999ung1/wcZUYR//69OQBuCSVcYfZrI7Jd7t0c7DXpyeYiiMmXvzrs7emxkRALe90YSiOsWvBQ7h+fbfPnfMbnN1T0WY7PoK+T4LZYasApcKshSh2WXeYJ1Dn3a1M3ORq4RGpyqLPQfgMBGOhNB08EhQ1Ik9V9RCqvAeTnE0rijW0yLIhL4fCjZpUGiFdQh/pG2mlQ/aQJwvsidl9DZ4CVrBTa/6YgTRuOGcTbizoGFP9EPO6Qu2inhJuStACZAJrUaDBoe6y0mvltS4Ounkpb3946TP0wh4CU46RA93EkLKqJKohTqjzpcLJLW99RVBC7gB9uUkwXBU9KKvJm0JK0EZJVJeUnnIpfnEkTBIJaltjyHjuuvqrAk3mCA9yeBeYcNf++o9/tuDaKOmuAuZW4GmKwXD3QEgqpSN4lPQ1lHgDqi5EOB/of1t+BBA6YprLQqU1I5mH0/gJhc+Z+l70Przaf2iqJEPFor5vTRzuWOPFSkM6Kimy5AQscb9wI4xtZfyEuNzV++EHQDwmLRhIDEGuRpqX8zaDN35NtTQd5SWJbrZY/Qyu8AKvrLrUUAj5sHeqbZWzqr4IKqsKbkXCwlSm380BdK6fwNcF+zKAhtR4LZR+soFVcbpLJRO4FPISrkE/QMB7VccRpXyOxG1nALINW0CSe86aPK0ZptZ2cNJ6nSgbsUOMBzHSXQF6CpcJqilEePBwqiM4/JVqKu3NKj4dlu4OvEaamREan+hWR3hPBBJEOwO5z75XM8RVzMocMAwU1Xc3N6KSEcSpy51uz55wiVluZM3B1Da8yWr3WsGFbJZAO2ig3GOneSfOmoMzYJonrhHftZdwbdYh6xxTNcPKtCO0oTCeK+IfmzWXbtqF5JjS8zJ6b+i80O7rFgg5s2omQf/69/81KLRQMmiCGebHk82tFC/Ac6Nc7l971kC+gcD7ZI9CddE589fpsncbNML94EQLyv0uxhhU4sIS8Oqlh0Q1No2ucvy5aNfeP7/VrT8j5XM4GPx/1q33Bp+Pbr0/+Ix06+cIrDfn338BbZJ3194dwT1x94B3CpzFM1f67p5o7V/EtTNlHYIbdhgt3H+NOSDc+/eYCJwNoXEvePU2bIbQMBoM8H9Ll2Cn8gkqO3VVlHz+L1H8cN/G3WfgPqM35S5kfZ2NvjelLJLMCUDGdG/yNUPu2UAbb0LmQsJlQMrlaDC4PIgcvvfXIeeNKsC9/jPUr2ZaYYESL/tYPWd8isILLq8fEVeg9X1U9X6Q3YWE/cHgclgj4WAVCceSEi+oGM6pugL5++60vbx1yyOoN0XesHYkXCdqjzqbbX93mzSQVFrYeXR4dhvd7PBS7Lj2w7OLxQVSnc0Uev1KZQhibrPoMNpdcQJSNSJ0MZ3dRqTyR+HKM1ymGNWycu3xUuxeD/vDaBEvj1l7Td7RH6qd9x1iLJ8KOb1v3EWDozd4ju6oOphqRMFS/BVQFvQH0e4VRwLpJwOOOiCiHsnjh8Z1+iIccnBqrvNTNoe57HkMjseOL3H5uVrjHWw5B8+CZ46cbbWvLWo2FNX+sChqebjwR8tnhT9rOfmsIefa4RNk0iEJc6P9fZJ6ng1JPNh7Ti/v/tPFhUN+y8JLAcxtM6WL1enY2/ynrv0pipbsPR2jy7LNZaP9Y4P5wy+5pObXgKzTrlGrXavUui22FJw1mAwPdBePGOmCeNwbEB73B4TH54OObOB338zQvPD0jNevOD3V7Zcan+MLpFshJ4qI3p/26xLkGzSc4qVETLMi0UGeqKIu0NLrhSG//uOf9aher9Y2ncUYVc7XlWalmoHGumRYfWWSw41AIwIOg4LaDCnGFLrPixyMQT+1tDB1RccwkROttd4emPCSj0Uu8NZ14ekU59q6uE2f/ZgBho5g0xfa5bVeQ46XdW2GaZVXYzOlryZYwi1mnI2xeBMa4kBmXCbO5uduELJdodKJ9tRSC4M1qTRCLRxsSlrNE8sKLvmUjE8xayMrhVzgNcu0GqNJ3Ki8ckZfy0WutItKpA1R2Agh8cVNiU0kliLPasiQrq+95dfEzvLuLgdf1WyMTo4SYRGoo1vFKpkrLECGxpAqz1mprHNgoPTbhhGHW82lQZHVwRLOoEaYN8qC8aH7bw3gCb8U8soVzdlhZzVd/QhjIyx0U2qXefNJd8x3wn5fjbEklzLCKj1vRk+FzaoxXfPtSeofbqbvQtG61iXezJGqxKyR41VidjH7d/cNWKQQs3t0ckxiwhP269//h70EriXL1MxRa1JpyOdNfTwqJ0cn79BWv/Jk9ucV1qSzRKRyGjxRAYM/ZtySaeUVzNBo5VjKhQKdVONcJHXtQdPrHbr6g62qgt0UQJeYgb4Yzko3Ohfyqs+O5Jysx42lCL/TuM42yJOyod5fXeWvgYjslQbyazAt+xikwnm4tKqmbrU2MH5z3RwV3NtRmrJyKU8FbaMNOM7cQ64l7uw+WKVvTWpLJ4ekW10KZEp15MwhSzWf2Gb+eCl5hbxNK59C3ktAR+ynaRV6REz6Hddf+xSStSSAdO9bMq7hgqZTfpGXwpPTWSBL1s1Vf3+ydnqftDwh8Tc8oLwUa70HWEXPvJ68AX0tEvDS2AaO3qXOu1Ec5SIBr4T69+vou5OX7HqvP4jillj3AObefXn8zYtXb14gMHiROoQN+4P+gGxlytiCy9ZKnk9OGzlrKTqrFv639T239T239T239T239T239T239T239T239T239T1XNrWt77mt77mt77mt77mt77mt77kttLCt77mt77mt77mt77mt77mt77mt77mt77mt77mt77mt77mt77mt7/mo5shtfc9tfc9tfc9tfc+t2Wlb33Nb33Nb33Nb33Nb33Nb33Nb33Nb33Nb3xODyVtpRbtlzgVlDfq6PS7h72y56udFHGWYEXh4Ft3eIgW+1fligZ9/rijB6ewijq65Fhi5RcmEcch9w0SmK8AcqG9cINrOKa4fuwOn4PGlHEpM3nMjjggHd/ZtJy2evH5zGsXR2FcmLVRKSch8holPfObywlrZUfTtNsq5nFaUWRW5OReuiEvWzfW7olw//0crPQtz4hoIu0mAbhv4L25q7YDbW5dHuFjU/V3TxhEesaE3nt/FYrH4P4yrJY0=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},b=void 0,f={},g=[];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,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Create Template"}),"\n",(0,i.jsx)(l(),{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:"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.p,{children:[(0,i.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,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)(u.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 final PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\nfalse - If you choose not to merge, the completion certificate will be provided as a separate 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"},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",description:"Allowed values - signature, stamp.",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)(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"},message:{type:"string",example:"Template created successfully!"}},title:"inline_response_200_5"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/9c9cb35e.b86e5973.js b/assets/js/9c9cb35e.b86e5973.js deleted file mode 100644 index 0d5aeba27..000000000 --- a/assets/js/9c9cb35e.b86e5973.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:()=>g,contentTitle:()=>j,default:()=>f,frontMatter:()=>x,metadata:()=>s,toc:()=>b});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":"eJztPNtyG7eSv4Kd2qrE3CFFUpLtaF9WyfFJvMcbq2J5U7uSjgLONDmwZoAJgBHFqFh1Hs4f7NO+nk/Ll2x1A5gLL5JsK4m9xTw44uDWaHQDfb+NLJ+Z6OgsOoWizLkFE13EUQom0aK0QsnoKDrNgIVm9o0Gjt/Z8clLxvNczQ2rDGjDrGIJNgJLKmNVIX7hkxyYDRPHbJ6JJGMG9DUwbtgkr6DUQlrDpkqzGUjQ3Ao5Y6lKqgKwYS5sxkoNKUyFhJQZq6vEVhrMgL0tlWSmShIwZlrl9UoODKFkzGwGBKgGW2lpGGeVFD9XwHq90PtSpL0esxm3LOGSTQC3k+JuPEDQAmfCsU1JmtiUkIipwM5+rsG5PJenojxib8tc8ZQtVKXZyZ/+XE+B8+K3s17vTzCpZuzty17v4svM2tIc7e3xshyoEqQRM5nziRkkqthLsWOZTp8gBkEDzkqwAjciXzCepmwu0hlYQzuWLFHlgiVK6VRIh/qSz4DJqpiANjHjMmWF0sCEZJxp4Omib1W/MsD+/c3r7/E4Cm4H7CSvTFwvlwoNic0XbnrEQNjVFw4zTw/wfIScxazgV3iQwrKfK5Fc4bYNSEKrPxPCVa/3pipLpS2k7Ee3haNeD1u+hlzNGddA/RNVFEqykmtegCVqwwPDZg0/V0JD6kiF53nAxdG57OM5L0o46vXYS5mKBJFBE+JXpqa+78B1RSRh1zf+YF3XFurw5B0RI07m3J1nmfPEgakBacKKa+hOfBOzBU78J5AqQJApLX5R0vKcjuMatBUJz9vHhgASoVmuiS9KJaQNX/0K7L/88eDp0aF4ukLQUkRWISS1GGDXPK/AeKjmMcsQqh+g1GCIvv28iEiZsgzELNu6Hk/fVcZ2JmaVQTDbUPi1wikReoHQNuW5ASamHVwW/ApaqzFFlxDPB+zrBUthyqvcxkwgxVldwYB9ryzjZZmLhG4bvEiQeTjeEX06ZU8OHhDJCzrjE62uRQp4JaRiOgWNzImNNIUfE6BDOitpAG6POMdmXDIlVw46UbnS6yREn7t4ZImSFqQdsONrLnIC3m3WMCGTvEqBTXKeXMV0T8ZMQ+oYdwF468aO3qkLXqYO54QfZiBHKlQS4ZfKLy9Mc2MN2GkmTMNP2BhQTYsI08aq59qpwpURBYHFGBRc5DEhLmbv1IRZYXOIkWFLLhcxS7mFmFm4sRN1E7Mkg+SK/tI8FYpNKmvxosY1U63KVM2lx+VUSWvELxs4MrS8P0bHMTuI2dOYPY/ZaBiz0Thmo4OYjZ7GbPQ8ZuNhzMbjmI0PYjZ+6sAaP/e45jWC2wCMxg7L9vPBLt67r4QhzsYL09R38LxzB48GrNeruQm//fTTT+fy9lwydh4hc51HR+w8qrucR7FrwzsT20b+9w3+2B8/8z8X+PPp+Ln/OaeuowP/M8Of49G5XPoFz+WYILG8KO+AApsfFQL/yxMRfqNF8Vu4z/AjXkRxaMCz6sCDDcv2XvZxL0IKK3hutm8n9PiEdtSAtLapA9wUkev2HVHzJ7SdNjzYQteka6JrtdUUGJ6gGK/t/nDgX5btm3fLfjJ7b4HzcVt/ilvHq+kUr6bt+69vr08ICaswfRwmng1IAKCbeTsefIdPCAtdiD4OB88RB/gobUcAtn5Cu2+Bgw3+hXdtw4P+6LA/Ho4POhhA3ch1KIp+mvYXi8VjYA9lHr88ijxBQnWSHaqhU62KDeoHaQdNLy8T0d9BZP8PFNQnQYaFFPW+rgYbNL62lG1VyhdfGDdVGFoLZ9i/Ec0WLTCpCeEg7TfJlEg88NgniGQTVPAGiIM+YXIvTfdamMSPadoviv7KR/zZJ8S3PhbFIE0HKz3XTsd9LFiaxmz988bvacqKotjy2X3vfN4rivVdDIrCw0bC11cDMj+QzLadT3yH34tVGo7oLnwnG6HlQMmc1iZ1bjMfrTw2mZC+wRMVW+mgYVblXMMN6qVGKOl6Pz6PBRZrJHvSY0kFJCuBQwX78rWX3p948sctdCfAL/ePW9sZTnLsDWZMwwxuWMmtBS1psmuei9TZ2/r0AW54UaIKsPfX8/P0X/55jwwQqONbhifBUjETaAfa++vZcf+/Lzb0qMoSdMINsBxwJRMzsMmAnWWQl40paj6fD+b7JsmUyp0d6p3RMHX/XqrJu0sCtxxwUz7ZtFNHGi2FH0lnVd83YDsY44aFkRtUfqIx4qHRkF5br+/c8dz6Hp/Qi7MCEjY66wk2n51HBSeBBEkZmr+VzUCfRxf1GKfkQ3rP2IsHMGsmUsj5BPL1pgczWv055wtVef4ORq3uVj1Ft/CGDYWQtd2CtjOMW438ZqXRtS038LdDSJs7w5MT2DOcAMuFCZabLjrbo71piwyOEpxpeAIsDGCTmko/mgtqwB7GBu4m8md3zxLYj1HH2qwYVrtnhc7BtBGDcxRCiqIqavvotJ41oKzwskcbXzgSnQZhhfbprq3Ab+5ZwZvttyxwLkdkxwj2jzskU9/jE7orVkC6m40/5BbpvNOP9MDez4BhW20G3PAsY1f3INfMZ7Zz34C9xucNbbJuEFrZkgRKixa5j2XNGuQHv1Bks2rb4bZTXrvXJ0R9G8D6jSnQ93vs1+eDiLS9+8+IUDtgP5hYnVGy4LM7NHdq/oTI08OzZoTo9U40TEWet1yKLHwKnh106UAOhXd7eWciPnVkCBfSKlQLgtt2AlPyl1pyo2S8cTi6d8Ydadsn6rzQSrOMGyd/k8CPR4UOW5tBsWKKD6A15nghA9x4KqPH0xvHXw3b5zR6etg5p8Nh55yG287pDrURT9CUSpra1gZNU4uv6YjD9/WnZZVtw6R4pC8k+laC9uCYQVV5ynJxRV6VVJgy5ws81cClHspVd903mVKm6eE9Zl/6DR91PXFKozPuyaB2TDzE4LVyGK2zGD3bbx3F4fPnXY7pMMxD9PdmvfVTGB7sjQ73nEVrs0GrMcNsv4TvkAQYe8h5kZ3oQedFPZsD25mdPtTs9Djkvv+YWvfo2bjzWOwPP/SxeHTlus0196jVj6E8P5oW22a3B+qvv5se+fHUd/BbSNSjZ/ttKnw2egQT6hbB+WMpcU0+fjTaY48lHG8iwAdIx3eKxB9NoG1gf3MiPXwcSXo07EhoX3UEtK/GbaI8PHwQUbYXXaGs80j859evf5gP//LtTB0fHx9//+Zt9uLt7Pj4uMDfg8FgoxK16bRpGZRcfUSgf5fpjd+yymAwQBSm3PIjGr5Xytm/uvHx9jED733+jSw7h4/hTNlgwPn4W6Du+sdZa347Pv84DmT+v3MZxZEqKaBYyZdpdBS54OQQqhvFpGKCsV+rdBEd3UY+fAz/9MFZOHTvncEg6NvIJBkUHP8KqimGTU9FjlNhBBRoE8URxRNgDDVSX3QUqck7SGwUo6+rRIMEGJyDxh3dhl4ubDaKvTAeHUWO+qM48h6f+hMDmSj04ZbpNFqGBe+aqv7STGXojzpuGefByNQPnIaGLlfCxj9opvYMywatzWRca76IViPUQ0hq8Ce6cXXMXb4Ij4SwaBKp4ySpWxRHwkLRXmXLoWn1/phOQOFOKNbofcfSsfDivdfEcWWm5AcN9OEgHzL0nZpcfhA54mBv/dhw1g88Hde6vnCXVI4xyBLSIBX3m2jhmFHE3uA+Sg39Cct81l7T+SjW1jzdFkXeCl41GanCvCyB6wEFc39wngClYvA8qSgbor6WOzurQa13NlrG0c39m7lhieqHEHX2ZQ5T61zKLFFagn7SjlP5ZDY3PjhYxtHi/u0tPsvtPcPDm9+/ux8ptr/Je/gjYN1/voyj7H5Yv6uzD/5AYA+eLps3dkWEuJyodHEZ7q3lfR3DY4b9MBfmpXytU9AtREyUyoHLNUy8nDrrvmJfoMbzRewCOShoXGgTHjI2RwO3hgQwAYXiu8Jdxbys4yLKmQ/kRafAC/xAYpqpJgZ7yTCfcRNOgFktZjNAm7fvQYN9WDxwSuqSPryET4OVr9RwLVRlAnhoCMfXJQe0bdsMhMvVEHLW1cpa2CFze3vvg/bp4Bd8XCXG0b8+PXkALkll7DOb1TH5bpduDvb69ARTccTUi38D9tbUmAio5Z0uDMUxdi14CNev7/aFc36Ds3sq2mzHRzDwSTB9tg5QKsxGiGKXdYd5AnXe3drETa4WHpGqLPochM9AMBZK08EjQVEj8lRVD6HKezDJ2ayiWEOLLBvycijcqEmlEdIl9JG+kVY6ZA95ssCemN3X4ClgBTu15o8ZSOOGczblxoKOMdUPMa8r1C7qKeGmBC1AJrARBRoc6i4rvVFe6+Kgm5fy9odXPkMv7CEw5QQ50E0MKatKohrihDpfKpzc6tbXBCXkDtCX2wTDddGDspq8KaQEbZREdUnpGZfiF0fCJJGgtjWBjOeuq78q0GSO8CCHd4EJd+2vf/9HC66tku46YG4FnqYYDHcPhKRSOoJHSV9DiTeg6kKE84H+t9VHAKEjprksVFozknk4jZ9Q+Jyp70Xvw6v9h6ZKMlQs6vvWxOGONV6sNKSjkiJLTsAS9ws3wthWxk+Iy12/H34AxGPSgoHEEORqpHm5aDN449dUK9NRXpLoZovVz+AaL/DKqksNhZAPe6faVjmr6ougsqrgViQsTGUG3RxA5/oJfF2wLwNoSI3XQuknW1gVp7tUMoFLIS/hGvQDBLzv6ziilC+QuO0cQLZhC0hyz1mTpzXH1NoOTlqvE2UjtqE8RPXAOW836S53K7CBHtxTQrm+xQSDCJwbGlmNLg7V6LBdZehz0aa8P3anS31GysZoOPz/rEvtDz8fXepg+BnpUs8RWG++vf8C2ibfbLw7gjn67gHvFDgLV6703T3RuruMa+P5JgQ37DBeuv8a9S/c+/eohE5nbMzJXp0JmyE0jIdD/N/KJdipdIHCbV0FI1/8UxQ/3JZ99xm4z2g9vwtZX2fj70wpiyRDnBVgTPcm3zDkng208SZkLiRcBqRcjofDy8PI4ftgE3LeqAJsRlIVytNzrbAgRZkDpjxYvWB8xoVkuLx+RFyB1vdR1ftBdhcSDobDy1GNhMN1JLyUFGhPxU9O1RXI33en7eWtWx5BvSnyhrUj4TpRe9TZbPu726SBpNLCLqKjs9vops9L0XftR2cXywukOpsp9PKUyhDE3GbRUbS35vSh6jPoUji7jUjFi8KVZ7hMMYph7drjpdi7Hg1G0TJeHbPxmryjP1T99x1iLJ8JObtv3EWDozd4ju6oOphqRMFS/AVQFvQH0e4VRwLpJwOOMj+iHsnjh8ZV9iIccnBibfJLNYe56mkKjqaO72j1udrgDWo5g86CJ4acK7VvJWo2FNX+jyhqeTTwR8tHgT9rOfmsIefawB9k0hEJc+ODA5J6no1IPNh/Ti/vwdPlhUN+y6JHAatts5SLzejYV/ynrr0hilb0+46Svapjb9V3t6i7fskVta4GZJM2ddhRYjZgKzzCXVxh9ALian9IuDoYEq6eDzvvv99hM0PzitNTXb/U9By3X2N8ci+QNoWcKiJsf6KvS5Bv0BiGFw8xxprUBnmiirroRq8Xhvz693/Uo3q9Wmd2VkAM7HhdaVaqOWisNYUVNaY53AhUDHEYFNRmyM1I4di8yMEY9D1KCzNXSAqT89AC5208CS/5ROQCb1YXckyxi63L2QzYjxlgOAA2faFdruI15Hgh16p1q2QWmyt9NcWyXDHjbIIFedC4AjLjMnF2HHdLkD0CFUu0kZVaGKwzpBFq4WBT0mqeWFZwyWdkUIhZG1kp5AKvUqbVBM2cRuWVM+RZLnKlXaQZbYhCAQiJL25KbCLRE/lSQ4a0e+2teSZ21lR3AfhKVRM0XJcIi0iAjBqVzBUWlUIDeJXnrFTWGaVRwm3DiMOt5tKgWOpgCWdQI8wb2sD4cOy3BvCEXwl55Qqh9NlZTVc/wsQIC900yVX+e9Id862w31UTLLOkjLBKL5rRM2GzakJXeXuS+oeb6dtQiKx1UTdzpCoxG2R1lZg9zOjcewMWKcTsHZ+8JFHgCfv1b//DXgHXkmVq7qg1qTTki6bmGZUIo5N3aKtfcjLl8grrjFkiUjkL3oWAwR8zbn/92/8a9j3M0aTlWMqFd5xUk1wkdT050+sduZpyrUpx3bQuF2yP9nXOSjc6F/JqwI7lgiyCzg2BxIDfaVxnG2Qd31LDra7c1kBENigD+TWQqREr+0yAQSqc10KrauZWawPjN9fNO8C9HacpK1dyD9De1YDjTDrkLuDOtoOV1zakK3TyAroVg0CmVBvMHLFU86lt5o9XEhLIg7D2KeQyBHTEfppW8T7EpN9x/XVAYTYrQkb3vtUwBY0Lmk5JPV4KT05ngSxZN//4/cna6XbS8oRE3PBI8lJstAhjZTTzevoG9LVIwEtcWzh6jzrvRXGUiwS8ounfr+NvT16x6/3BMIpbotsDmHvv1ctvXnz/5gUCgxepQ9hoMBwMyR6mjC24bK3k+eS0kaVWIm5qAX9Xs3FXs3FXs3FXs3FXs3FXs3FXs3FXs3FXs3FXs3FtU7uajbuajbuajbuajbuajbuajbvk+V3Nxl3Nxl3Nxl3Nxl3Nxl3Nxl3Nxl3Nxl3Nxl3Nxl3Nxl3Nxl3Nxkc1R+5qNu5qNu5qNu5qNu7MTruajbuajbuajbuajbuajbuajbuajbuajbuajRhM3kor2itzLigz0NdicUl9Z6uVHC/iKMOsv6Oz6PYWKfCtzpdL/PxzRUlMZxdxdM21wMgtShiMQ34bJjJdAaaGfeMC0fqnuH7sDpyCx1fyJDFBz404Jhzc2bedmHjy+s1pFEcTX22yUCklGvM5Jj7xucv9amVH0bfbKOdyVlFmVeTmXLrCHFk3n++K8vn8H630LMx7ayDsJvq5beC/uKmNA25vXa7gcln3d01bR3jEht54fhfL5fL/AAfnXNw=","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),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 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:"eJztPNtyG7eSv4Kd2qrE3CFFUpLtaF9WyfFJvMcbq2J5U7uSjgLONDmwZoAJgBHFqFh1Hs4f7NO+nk/Ll2x1A5gLL5JsK4m9xTw44uDWaHQDfb+NLJ+Z6OgsOoWizLkFE13EUQom0aK0QsnoKDrNgIVm9o0Gjt/Z8clLxvNczQ2rDGjDrGIJNgJLKmNVIX7hkxyYDRPHbJ6JJGMG9DUwbtgkr6DUQlrDpkqzGUjQ3Ao5Y6lKqgKwYS5sxkoNKUyFhJQZq6vEVhrMgL0tlWSmShIwZlrl9UoODKFkzGwGBKgGW2lpGGeVFD9XwHq90PtSpL0esxm3LOGSTQC3k+JuPEDQAmfCsU1JmtiUkIipwM5+rsG5PJenojxib8tc8ZQtVKXZyZ/+XE+B8+K3s17vTzCpZuzty17v4svM2tIc7e3xshyoEqQRM5nziRkkqthLsWOZTp8gBkEDzkqwAjciXzCepmwu0hlYQzuWLFHlgiVK6VRIh/qSz4DJqpiANjHjMmWF0sCEZJxp4Omib1W/MsD+/c3r7/E4Cm4H7CSvTFwvlwoNic0XbnrEQNjVFw4zTw/wfIScxazgV3iQwrKfK5Fc4bYNSEKrPxPCVa/3pipLpS2k7Ee3haNeD1u+hlzNGddA/RNVFEqykmtegCVqwwPDZg0/V0JD6kiF53nAxdG57OM5L0o46vXYS5mKBJFBE+JXpqa+78B1RSRh1zf+YF3XFurw5B0RI07m3J1nmfPEgakBacKKa+hOfBOzBU78J5AqQJApLX5R0vKcjuMatBUJz9vHhgASoVmuiS9KJaQNX/0K7L/88eDp0aF4ukLQUkRWISS1GGDXPK/AeKjmMcsQqh+g1GCIvv28iEiZsgzELNu6Hk/fVcZ2JmaVQTDbUPi1wikReoHQNuW5ASamHVwW/ApaqzFFlxDPB+zrBUthyqvcxkwgxVldwYB9ryzjZZmLhG4bvEiQeTjeEX06ZU8OHhDJCzrjE62uRQp4JaRiOgWNzImNNIUfE6BDOitpAG6POMdmXDIlVw46UbnS6yREn7t4ZImSFqQdsONrLnIC3m3WMCGTvEqBTXKeXMV0T8ZMQ+oYdwF468aO3qkLXqYO54QfZiBHKlQS4ZfKLy9Mc2MN2GkmTMNP2BhQTYsI08aq59qpwpURBYHFGBRc5DEhLmbv1IRZYXOIkWFLLhcxS7mFmFm4sRN1E7Mkg+SK/tI8FYpNKmvxosY1U63KVM2lx+VUSWvELxs4MrS8P0bHMTuI2dOYPY/ZaBiz0Thmo4OYjZ7GbPQ8ZuNhzMbjmI0PYjZ+6sAaP/e45jWC2wCMxg7L9vPBLt67r4QhzsYL09R38LxzB48GrNeruQm//fTTT+fy9lwydh4hc51HR+w8qrucR7FrwzsT20b+9w3+2B8/8z8X+PPp+Ln/OaeuowP/M8Of49G5XPoFz+WYILG8KO+AApsfFQL/yxMRfqNF8Vu4z/AjXkRxaMCz6sCDDcv2XvZxL0IKK3hutm8n9PiEdtSAtLapA9wUkev2HVHzJ7SdNjzYQteka6JrtdUUGJ6gGK/t/nDgX5btm3fLfjJ7b4HzcVt/ilvHq+kUr6bt+69vr08ICaswfRwmng1IAKCbeTsefIdPCAtdiD4OB88RB/gobUcAtn5Cu2+Bgw3+hXdtw4P+6LA/Ho4POhhA3ch1KIp+mvYXi8VjYA9lHr88ijxBQnWSHaqhU62KDeoHaQdNLy8T0d9BZP8PFNQnQYaFFPW+rgYbNL62lG1VyhdfGDdVGFoLZ9i/Ec0WLTCpCeEg7TfJlEg88NgniGQTVPAGiIM+YXIvTfdamMSPadoviv7KR/zZJ8S3PhbFIE0HKz3XTsd9LFiaxmz988bvacqKotjy2X3vfN4rivVdDIrCw0bC11cDMj+QzLadT3yH34tVGo7oLnwnG6HlQMmc1iZ1bjMfrTw2mZC+wRMVW+mgYVblXMMN6qVGKOl6Pz6PBRZrJHvSY0kFJCuBQwX78rWX3p948sctdCfAL/ePW9sZTnLsDWZMwwxuWMmtBS1psmuei9TZ2/r0AW54UaIKsPfX8/P0X/55jwwQqONbhifBUjETaAfa++vZcf+/Lzb0qMoSdMINsBxwJRMzsMmAnWWQl40paj6fD+b7JsmUyp0d6p3RMHX/XqrJu0sCtxxwUz7ZtFNHGi2FH0lnVd83YDsY44aFkRtUfqIx4qHRkF5br+/c8dz6Hp/Qi7MCEjY66wk2n51HBSeBBEkZmr+VzUCfRxf1GKfkQ3rP2IsHMGsmUsj5BPL1pgczWv055wtVef4ORq3uVj1Ft/CGDYWQtd2CtjOMW438ZqXRtS038LdDSJs7w5MT2DOcAMuFCZabLjrbo71piwyOEpxpeAIsDGCTmko/mgtqwB7GBu4m8md3zxLYj1HH2qwYVrtnhc7BtBGDcxRCiqIqavvotJ41oKzwskcbXzgSnQZhhfbprq3Ab+5ZwZvttyxwLkdkxwj2jzskU9/jE7orVkC6m40/5BbpvNOP9MDez4BhW20G3PAsY1f3INfMZ7Zz34C9xucNbbJuEFrZkgRKixa5j2XNGuQHv1Bks2rb4bZTXrvXJ0R9G8D6jSnQ93vs1+eDiLS9+8+IUDtgP5hYnVGy4LM7NHdq/oTI08OzZoTo9U40TEWet1yKLHwKnh106UAOhXd7eWciPnVkCBfSKlQLgtt2AlPyl1pyo2S8cTi6d8Ydadsn6rzQSrOMGyd/k8CPR4UOW5tBsWKKD6A15nghA9x4KqPH0xvHXw3b5zR6etg5p8Nh55yG287pDrURT9CUSpra1gZNU4uv6YjD9/WnZZVtw6R4pC8k+laC9uCYQVV5ynJxRV6VVJgy5ws81cClHspVd903mVKm6eE9Zl/6DR91PXFKozPuyaB2TDzE4LVyGK2zGD3bbx3F4fPnXY7pMMxD9PdmvfVTGB7sjQ73nEVrs0GrMcNsv4TvkAQYe8h5kZ3oQedFPZsD25mdPtTs9Djkvv+YWvfo2bjzWOwPP/SxeHTlus0196jVj6E8P5oW22a3B+qvv5se+fHUd/BbSNSjZ/ttKnw2egQT6hbB+WMpcU0+fjTaY48lHG8iwAdIx3eKxB9NoG1gf3MiPXwcSXo07EhoX3UEtK/GbaI8PHwQUbYXXaGs80j859evf5gP//LtTB0fHx9//+Zt9uLt7Pj4uMDfg8FgoxK16bRpGZRcfUSgf5fpjd+yymAwQBSm3PIjGr5Xytm/uvHx9jED733+jSw7h4/hTNlgwPn4W6Du+sdZa347Pv84DmT+v3MZxZEqKaBYyZdpdBS54OQQqhvFpGKCsV+rdBEd3UY+fAz/9MFZOHTvncEg6NvIJBkUHP8KqimGTU9FjlNhBBRoE8URxRNgDDVSX3QUqck7SGwUo6+rRIMEGJyDxh3dhl4ubDaKvTAeHUWO+qM48h6f+hMDmSj04ZbpNFqGBe+aqv7STGXojzpuGefByNQPnIaGLlfCxj9opvYMywatzWRca76IViPUQ0hq8Ce6cXXMXb4Ij4SwaBKp4ySpWxRHwkLRXmXLoWn1/phOQOFOKNbofcfSsfDivdfEcWWm5AcN9OEgHzL0nZpcfhA54mBv/dhw1g88Hde6vnCXVI4xyBLSIBX3m2jhmFHE3uA+Sg39Cct81l7T+SjW1jzdFkXeCl41GanCvCyB6wEFc39wngClYvA8qSgbor6WOzurQa13NlrG0c39m7lhieqHEHX2ZQ5T61zKLFFagn7SjlP5ZDY3PjhYxtHi/u0tPsvtPcPDm9+/ux8ptr/Je/gjYN1/voyj7H5Yv6uzD/5AYA+eLps3dkWEuJyodHEZ7q3lfR3DY4b9MBfmpXytU9AtREyUyoHLNUy8nDrrvmJfoMbzRewCOShoXGgTHjI2RwO3hgQwAYXiu8Jdxbys4yLKmQ/kRafAC/xAYpqpJgZ7yTCfcRNOgFktZjNAm7fvQYN9WDxwSuqSPryET4OVr9RwLVRlAnhoCMfXJQe0bdsMhMvVEHLW1cpa2CFze3vvg/bp4Bd8XCXG0b8+PXkALkll7DOb1TH5bpduDvb69ARTccTUi38D9tbUmAio5Z0uDMUxdi14CNev7/aFc36Ds3sq2mzHRzDwSTB9tg5QKsxGiGKXdYd5AnXe3drETa4WHpGqLPochM9AMBZK08EjQVEj8lRVD6HKezDJ2ayiWEOLLBvycijcqEmlEdIl9JG+kVY6ZA95ssCemN3X4ClgBTu15o8ZSOOGczblxoKOMdUPMa8r1C7qKeGmBC1AJrARBRoc6i4rvVFe6+Kgm5fy9odXPkMv7CEw5QQ50E0MKatKohrihDpfKpzc6tbXBCXkDtCX2wTDddGDspq8KaQEbZREdUnpGZfiF0fCJJGgtjWBjOeuq78q0GSO8CCHd4EJd+2vf/9HC66tku46YG4FnqYYDHcPhKRSOoJHSV9DiTeg6kKE84H+t9VHAKEjprksVFozknk4jZ9Q+Jyp70Xvw6v9h6ZKMlQs6vvWxOGONV6sNKSjkiJLTsAS9ws3wthWxk+Iy12/H34AxGPSgoHEEORqpHm5aDN449dUK9NRXpLoZovVz+AaL/DKqksNhZAPe6faVjmr6ougsqrgViQsTGUG3RxA5/oJfF2wLwNoSI3XQuknW1gVp7tUMoFLIS/hGvQDBLzv6ziilC+QuO0cQLZhC0hyz1mTpzXH1NoOTlqvE2UjtqE8RPXAOW836S53K7CBHtxTQrm+xQSDCJwbGlmNLg7V6LBdZehz0aa8P3anS31GysZoOPz/rEvtDz8fXepg+BnpUs8RWG++vf8C2ibfbLw7gjn67gHvFDgLV6703T3RuruMa+P5JgQ37DBeuv8a9S/c+/eohE5nbMzJXp0JmyE0jIdD/N/KJdipdIHCbV0FI1/8UxQ/3JZ99xm4z2g9vwtZX2fj70wpiyRDnBVgTPcm3zDkng208SZkLiRcBqRcjofDy8PI4ftgE3LeqAJsRlIVytNzrbAgRZkDpjxYvWB8xoVkuLx+RFyB1vdR1ftBdhcSDobDy1GNhMN1JLyUFGhPxU9O1RXI33en7eWtWx5BvSnyhrUj4TpRe9TZbPu726SBpNLCLqKjs9vops9L0XftR2cXywukOpsp9PKUyhDE3GbRUbS35vSh6jPoUji7jUjFi8KVZ7hMMYph7drjpdi7Hg1G0TJeHbPxmryjP1T99x1iLJ8JObtv3EWDozd4ju6oOphqRMFS/AVQFvQH0e4VRwLpJwOOMj+iHsnjh8ZV9iIccnBibfJLNYe56mkKjqaO72j1udrgDWo5g86CJ4acK7VvJWo2FNX+jyhqeTTwR8tHgT9rOfmsIefawB9k0hEJc+ODA5J6no1IPNh/Ti/vwdPlhUN+y6JHAatts5SLzejYV/ynrr0hilb0+46Svapjb9V3t6i7fskVta4GZJM2ddhRYjZgKzzCXVxh9ALian9IuDoYEq6eDzvvv99hM0PzitNTXb/U9By3X2N8ci+QNoWcKiJsf6KvS5Bv0BiGFw8xxprUBnmiirroRq8Xhvz693/Uo3q9Wmd2VkAM7HhdaVaqOWisNYUVNaY53AhUDHEYFNRmyM1I4di8yMEY9D1KCzNXSAqT89AC5208CS/5ROQCb1YXckyxi63L2QzYjxlgOAA2faFdruI15Hgh16p1q2QWmyt9NcWyXDHjbIIFedC4AjLjMnF2HHdLkD0CFUu0kZVaGKwzpBFq4WBT0mqeWFZwyWdkUIhZG1kp5AKvUqbVBM2cRuWVM+RZLnKlXaQZbYhCAQiJL25KbCLRE/lSQ4a0e+2teSZ21lR3AfhKVRM0XJcIi0iAjBqVzBUWlUIDeJXnrFTWGaVRwm3DiMOt5tKgWOpgCWdQI8wb2sD4cOy3BvCEXwl55Qqh9NlZTVc/wsQIC900yVX+e9Id862w31UTLLOkjLBKL5rRM2GzakJXeXuS+oeb6dtQiKx1UTdzpCoxG2R1lZg9zOjcewMWKcTsHZ+8JFHgCfv1b//DXgHXkmVq7qg1qTTki6bmGZUIo5N3aKtfcjLl8grrjFkiUjkL3oWAwR8zbn/92/8a9j3M0aTlWMqFd5xUk1wkdT050+sduZpyrUpx3bQuF2yP9nXOSjc6F/JqwI7lgiyCzg2BxIDfaVxnG2Qd31LDra7c1kBENigD+TWQqREr+0yAQSqc10KrauZWawPjN9fNO8C9HacpK1dyD9De1YDjTDrkLuDOtoOV1zakK3TyAroVg0CmVBvMHLFU86lt5o9XEhLIg7D2KeQyBHTEfppW8T7EpN9x/XVAYTYrQkb3vtUwBY0Lmk5JPV4KT05ngSxZN//4/cna6XbS8oRE3PBI8lJstAhjZTTzevoG9LVIwEtcWzh6jzrvRXGUiwS8ounfr+NvT16x6/3BMIpbotsDmHvv1ctvXnz/5gUCgxepQ9hoMBwMyR6mjC24bK3k+eS0kaVWIm5qAX9Xs3FXs3FXs3FXs3FXs3FXs3FXs3FXs3FXs3FXs3FtU7uajbuajbuajbuajbuajbuajbvk+V3Nxl3Nxl3Nxl3Nxl3Nxl3Nxl3Nxl3Nxl3Nxl3Nxl3Nxl3Nxl3Nxkc1R+5qNu5qNu5qNu5qNu7MTruajbuajbuajbuajbuajbuajbuajbuajbuajRhM3kor2itzLigz0NdicUl9Z6uVHC/iKMOsv6Oz6PYWKfCtzpdL/PxzRUlMZxdxdM21wMgtShiMQ34bJjJdAaaGfeMC0fqnuH7sDpyCx1fyJDFBz404Jhzc2bedmHjy+s1pFEcTX22yUCklGvM5Jj7xucv9amVH0bfbKOdyVlFmVeTmXLrCHFk3n++K8vn8H630LMx7ayDsJvq5beC/uKmNA25vXa7gcln3d01bR3jEht54fhfL5fL/AAfnXNw=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},j=void 0,g={},b=[];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,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Create Template"}),"\n",(0,i.jsx)(l(),{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:"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.p,{children:[(0,i.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,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)(u.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},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",description:"Allowed values - signature, stamp.",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)(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"},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 f(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/c195e1f1.0541c66c.js b/assets/js/c195e1f1.0541c66c.js deleted file mode 100644 index effca4e26..000000000 --- a/assets/js/c195e1f1.0541c66c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6192],{19115:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>b,contentTitle:()=>x,default:()=>j,frontMatter:()=>g,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":"eJztW19vG7m1/yq88+LEGEuy4+zdGrlBvUnurtFgbSTODQrL0HJmjjR0ZsgpyZGsNQT0od+gT33tR9tPUpxDzgxHli07u0B7Wy8WuxaH5Dk8/3j4O+RNZPnMREcX0VuV1iVIa6LLOMrApFpUVigZHUXnObA3GrgF1vRiU61KZqGsCmw+PjthvCjUwrClqplVbAYSNH6SsGBZMzdLluyqNpZVWs1FJuSsnWMiMiakscAzpqasrgrFqQOnKaaigGdCMpsDmypdYp+EG/jmkCnNEiG5Xj5nMAe9ZFaUQHxIgAyZSR3zvGVkwM49WYOzMQ0V9siKJasNZETNsJRLloAfnbkl1wY0E9KCnvIUGLfsYnf3LST1jH062d29fJZbW5mj4ZBX1UBVII2YyYInZpCqcphhxyqbPkema0Pr74R7HohzMJZj+UdVExNOWsAymPK6sGzOi5rEgEJnC5HNAGXLkXVFMhKaSV5C77upq0ppy+A6hcoyZIzbWkPMjOVlFTMhhRW8MDETJZ/BYCz3B2x3F0ouit3dsfzpp5/G8mYsGRtHOPs4OmLjiD6Po9i1a+CZksUSv015YcC3e9aDIb+Ha15WBaBgxtFYrjyBsTxAqkjgbqLur8fQvFLQp/ICqVyphJ0LW9xDCrtY7PI4eimoPr1DpJeqsuJyeTc13+GR8nSSZNXcssJmfbovkW7G7T1LxK+Po7i/vzd6uXcwOnjZJ/YNErNwbRN1fTc93+FxJMslw3F9ev9NQs0h/XIvwabHYyhejCNFEXDvYBxddkT3UJyu29HuLmt8NOdzYEoCenapNDCbc0kNzlttzi0FJIMRKQFmoIAU40qybBybnP5b0pdWVaYW8h6d+R6PE6Jb0X5fiL9DippnQrGktlbdQ5V6/QYkd3fPNExFUbDPLjqhKJumJmBxDQwKcDsHyQ9bhDSgUW5CWhXEdJbAFOUuLBOGmZxryNhC2JxxitoDdiqLJcXbdgiFdqVZzg2rQJfCGIEBVDGeZdi1JJWgyjWYSkkDjlEXj3GuQLsmV3WR4WZS4N6AX+FaGIthvhk+cKt/L4zFLWwtNtOqGjmgFva3+9Mmd3K06COXmYYFS6AX/g4eGhRuzcjG0ehwuP9yeDA6OAynfPHVrtjNfTGOSk6Rlo2jKbi/A987fKSl+l4baTWkutkpUtLWd/e09HmzpMX/fXf6YTH6w/czdXx8fPzjx0/5u0+z4+PjEn8PBgNPy0/9zVf7ebiGRkjdKqI4UhXmXkLJkyw6inz+4m0ePaLJuUQWxVHFNS/BgsY08IYoR0dRkJZFcSQwDay4zaP13FAlV5DaE8rZmvwliiMNf6qFhiw6srqGODJ2WeC0RuBGFcURXFeFyiA6cnEjMmkOJY+ObiK7rKin1ULOojjCbI/bsMVvd8jSD/tJnh7kVRKtVpeOLBj7ncqWOFWqpAVp8U9eVYVISSjDK4Os3wQ0O3YvIsyLUBiXccOKWyOKSqNkrQBDjGJS8FiOfwzSYZdW3BLpsWQuZvKCtcphpoJUTJdNykhDKQXEXxIWxbJNVLss92TKVCmshSx2o7yGfvnz34yfYoERNwGX9/a2omgVt8LoVsm15ks0CQtl2H6HkLTaLKNOIsdpqmorubRIkFLDe4VKHcIJrhSEuSTO4oz4PqpXCjAmYucqV3JL7/2DF/jvi33s71O0x2q+OQzgFFcqmXyV+WQwx/F+2/h6tWwXkN9UJrTkZqMPhiRKFcBlOIZceRU32//98/t0LlHX0WoVN860FqyCKDT56Exx0qx99ahhRGSqigw0BsX7OCO7B5lN1m2xW/L6+ViYwFP7B2Hvt2yRg81BU/OCS8to9i4ZxHCgmPe3AcMzd/+4JwxmzrqGcUSO3SUfCn/0WAj6Mi4zJhXbIXoTU5NB7Az970Rly51upEu6HM8CQ4lngTq34cP0osZg3LMCJNs4ckNuk8D7MnxTG6tKRmT8IIpu7SmV+dg+YG+4ZEKmRe0zsKlCgWNgZDc3jQk491qt2M0N6hL0BE1+tYq7BqTVa6BA4Fo0pCDmvVFtE3QD27ZgKFxXQi8nmD65Bh8vQgbETAo5m9TazyMVdh70zHCNccpRvQwga61LzOSGVbeRlPT7YOnfErbXO07yHyP3V9XrH8QGVl4Nq9evqtefgeWqAudxTjxTITPn7wsoigF7ZaxWcvZ6TQSvhr59syo1zAUsyF1Jq90s67JtJxp4nv6o6tBThGGprlPBC5y30iqF5ijkkoVry4yFyjBu8LhEYpkKoDVoxmca6NBFvPDa5kqLnyl1agi+4izXMP2fnTWZ7rzGcMty0PBqyF/73idTWiOdkLlcMlq4UNLgWZkwummtKTimBddi6vO0mFUFcAMM0zieWmLeSbTh4zzn8ouJXyX69Tnwkp1WIJGDX/7yd+zRRPITeaoz0A8I5SdTZoAi8Q7GsZ2YqebQOBXaWB+gXfzzFuL4usN1PKZWLAfsXRvwTZ0Y7CWb+bqAarWYzQCPrr4HDY6d9oCnudsqiCs+xViP1Cs0HlWbhj00MDT/AtDAHB7oFTVg37VJXswC6dCpOVz7YENUR2j1XL3xU7/lyzDXkHWZgL4lU4JjEYX1o1jGlwapUcqJH3iR1gR8Oh9m6MO4q5E5NtYfZkYtpZa//ZcY8iRPCjg9P3uApnFBbM+5sUu3nQ7cHOz0/IzNoTPGAftkWj01iue9LixVGbC54E71MVvkIiWXW7ISQW+QpC8ftUMgYuDgE7bHbjOUCbORo9glGhh/a2Jt08QsExpSWyzJgFRtEdgQ/nBBMWCwKYNzQjhX9UN8ZoskOZvVIiNN17rd00GbOKgCIPKv69RFhazWzTHHG60LYsZ0cmqkgp2C+WMG0rjhnE25saBjVksC7HVdoTc0U8J1BVqATGGjCILQvX3/xGyN8Hbl8rIKtFESw5vSMy599ERsfpErgyePnBeuqw8ThiWAXKF3DzaeG375y9+jjq87z0m3GXMUeJZpMGYLh4RjOXNCUBOhrCWzqs8Rzgf69+vVDeSOTHJSqqw1U/NwCzpDBM6aNiZ6GK6FAE2d5rhltbHWhDULKmKYGJeEBwsqhKgK19uCcA3aJu7yvg+AckwDHqjogz6DFiWXoft00KRam44OBMK41jCJ32hpWGzarknEmUu+bGtBOLcvgIHEyJOxs7f/S5Url01sACHxnBtEUTf81tmH11ZNNJRCPmzP/Og2DVKiVa3b11aV3IqUNVOZAfNdnbitCr24ZM8aUaF3zIXSzzeKy003UTKFiZATKvlt34R+pGa0Btp9ErALABny1ijNba0OLkLeFjlI1pNJsFPiontc4jZUOfx20yn8tk7D+l5jn27jwC9QJgjLOGQbXZ8CY3NOvHWs/9W4gPu6zRaP0cshczZt2N6tWuJgC4zRnvwRfpzBdvVhHMOeTHo9ym539WJr4HdeVcD1AKMYwx3n6+qzvbSkPWoPtiQhqzi63r6Ya5aqPaUzIXHyZwVMLaurCvNfpSXo5y7quAX+6yxuNFrF0QNcbfn/cnkvcHWL7av7LDKbd6Wbfwqvh8hrvp3XH0DMcvtPZvZbZNblhb8lMOlgSVcK2Qr1Oti2UPr+nlgBIJhQWiN+3hiWOnc4WLl/OhCyift3A5OTEJkkaIYm6FdLgoWRSA5GI/xfX7VveyVMTGvrFDPkaV0Uy/+K4ofXPu7XR1PfeSxQnV+Jg5+v0/nBWVNGqHXx9fvS9rLAJoh57ZYJctLn4mFL8c5R62LPqj1cy16b69G0gb6FLISESaPASabSSbN67FeCMf0d70E8tOqm039f11vIR85IDzdZUYDMyB06G3bFd49DYRKM+XJzNwkhG2XblKXpwgtFCbbDmIRmWPihkWTmv5k9gtabvfg+6Z05HMmAratuJW7ibRI8HI0maSfElxuEKOe8EBldgjtXX0D+hu5353K7xYXkrSOPrF6XRRdPI+E60feot9qw3S3SQFprYZdUDr7e45XYc9+PLi6xyFqCzRUWlitliGOsCx9Fw36oG94EsW4V4bR63hSZyQtbxzJcZom6vr3z8EoM5/sDLEGtj9m4U93TH+q9xw4xls+EnG0bd9lJ7CNq1SmuJ7cu6lXiD4De4NUS9vJV9hw4HrtQEWgsH7qK9rtG5W3peXM1ua3ZXjTl17DG2pZYb9VNW66a2mhbGg3qn0H5s6to9gqaVKMMSpThnYKmpBhWFP0FgLZo2KsMksF1Zbso6pfm3OWCtVLTr6uc9AsnT9WAf6NqwFoxwBnPJkR7/2UPS/YWGoKiza2VECTsIXXrQN2doNkdmJkn4LAhNPs1VMZ/3wyGvOxhEKEn+jjU+Fdz/N6nc+v+aEQHvBcjOgkdjuiQ8e2ol773fTkKk3DKtNtEm7LpMJnGjPkS45qQUxVGsUZPtIVRUL116IIiVa6KgGrf3Q1U247a3W1joTNPvGp1WmtWqQXoaV2QBU8LuBaI6+AwKOlbV6wHXhZgTLGkO94zusGeiZmwCJd74DjlFU9EIXCPdpcQnaN027wZsM9duX9H09VzmEOBW3uLjMlZF7sXSn+Z4rWBmHGW4M1wxGpB5lymDhZ2OwzBm4gLIaBdaYFZjdXItXC8KWk1ekfJJZ+R38ahH7AMCgxjhmmVYE3CqKJ23me5KJR2FRlaEF1WJSG+w8ta2p0cMfxryNGK5x56N7ErfRjaS3AJEjEruubPUytSIIy0loVKv7haWl0UrFLW1bfwgBryiMOt5tLQRX9XBPI6aAXmCwJg/IXKTwZQw++F/IJ3SfHO5kVrV58hMcJCd85dLBa3tvTn/THfC/tDnbAPUCkjrNLLbvRM2LxOKA0IJ2l/uJm+b15ABJt8N0emUrPhqK1SM8yhqIYfwaKFmOHx2Qkllc/ZL3/+K3sPXEuWq4Wz1rTWUCy7xxYoOad5J7Y2J3SPBWqbo8RT7q+kUuhtJPg555buhWFSIaR3KXf59axOCpF2jyZ2d4+aRwvdnRCqHfg3E/76LRbDOKvc6ELILwN2LJfuEUW7A2E7jestg3a94OFI8LihpRk+40AI2UAxd+828IiSAINMuAKoVvXMUQuZ8Yvr30TGtR1nGavWbiMjXN2x4xBZqu1xB83awcYLzL2bvf1rEyCzSglpzRHLNJ/abv547Yoy7X+3mprbzY04Yj9NqxLniX7Fbau7r7OWoPbjrYYpUOXV9N7y8Ep4c7pozJKhtf4as3bQDG3pwUEfM+WNBSYLujSn04+g5yJtTud3ePSQOg+jOCpECh4n8vvX8fdn79n8xWAUxUHa/wDnHr4/efPux4/vkBkMpE5g+4PRYERwtjK25DKgtPHlVHBVtif54M7q07Orp2dXT8+unp5dPT27enp29fTs6unZ1dOzq3/1Z1cBuDKsCi5kUHByIPnFWj0wiqOj8KXVZRzlCKofXUQ3N5hYfEIcDZv/VBOyc3EZR3OuBSJRBOj4GzRZgKPekU4+++CrjM/ZHY+2NvLfINcSYWvyOodHfYHl2jOx1SVWpR18jay5Hm8cA3vnOE83w62iCOLvbsRxionSvX3DKsTZ6cfzKI6ai+4lvSqLNF8gNsUXjtsAwKK2m6jgclYT+BW5OVfu6lPeh+u/EFzv/wgQtL48+ji+Wwb+Fxe1ccDNjSsFEODs+rtPd47wgm16o3IuV6vVPwDClwzW","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),a=n(33617),o=n.n(a),l=n(17543),d=n.n(l),p=n(86013),c=n.n(p),m=n(63723),u=n.n(m),h=(n(18766),n(79329),n(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:"eJztW19vG7m1/yq88+LEGEuy4+zdGrlBvUnurtFgbSTODQrL0HJmjjR0ZsgpyZGsNQT0od+gT33tR9tPUpxDzgxHli07u0B7Wy8WuxaH5Dk8/3j4O+RNZPnMREcX0VuV1iVIa6LLOMrApFpUVigZHUXnObA3GrgF1vRiU61KZqGsCmw+PjthvCjUwrClqplVbAYSNH6SsGBZMzdLluyqNpZVWs1FJuSsnWMiMiakscAzpqasrgrFqQOnKaaigGdCMpsDmypdYp+EG/jmkCnNEiG5Xj5nMAe9ZFaUQHxIgAyZSR3zvGVkwM49WYOzMQ0V9siKJasNZETNsJRLloAfnbkl1wY0E9KCnvIUGLfsYnf3LST1jH062d29fJZbW5mj4ZBX1UBVII2YyYInZpCqcphhxyqbPkema0Pr74R7HohzMJZj+UdVExNOWsAymPK6sGzOi5rEgEJnC5HNAGXLkXVFMhKaSV5C77upq0ppy+A6hcoyZIzbWkPMjOVlFTMhhRW8MDETJZ/BYCz3B2x3F0ouit3dsfzpp5/G8mYsGRtHOPs4OmLjiD6Po9i1a+CZksUSv015YcC3e9aDIb+Ha15WBaBgxtFYrjyBsTxAqkjgbqLur8fQvFLQp/ICqVyphJ0LW9xDCrtY7PI4eimoPr1DpJeqsuJyeTc13+GR8nSSZNXcssJmfbovkW7G7T1LxK+Po7i/vzd6uXcwOnjZJ/YNErNwbRN1fTc93+FxJMslw3F9ev9NQs0h/XIvwabHYyhejCNFEXDvYBxddkT3UJyu29HuLmt8NOdzYEoCenapNDCbc0kNzlttzi0FJIMRKQFmoIAU40qybBybnP5b0pdWVaYW8h6d+R6PE6Jb0X5fiL9DippnQrGktlbdQ5V6/QYkd3fPNExFUbDPLjqhKJumJmBxDQwKcDsHyQ9bhDSgUW5CWhXEdJbAFOUuLBOGmZxryNhC2JxxitoDdiqLJcXbdgiFdqVZzg2rQJfCGIEBVDGeZdi1JJWgyjWYSkkDjlEXj3GuQLsmV3WR4WZS4N6AX+FaGIthvhk+cKt/L4zFLWwtNtOqGjmgFva3+9Mmd3K06COXmYYFS6AX/g4eGhRuzcjG0ehwuP9yeDA6OAynfPHVrtjNfTGOSk6Rlo2jKbi/A987fKSl+l4baTWkutkpUtLWd/e09HmzpMX/fXf6YTH6w/czdXx8fPzjx0/5u0+z4+PjEn8PBgNPy0/9zVf7ebiGRkjdKqI4UhXmXkLJkyw6inz+4m0ePaLJuUQWxVHFNS/BgsY08IYoR0dRkJZFcSQwDay4zaP13FAlV5DaE8rZmvwliiMNf6qFhiw6srqGODJ2WeC0RuBGFcURXFeFyiA6cnEjMmkOJY+ObiK7rKin1ULOojjCbI/bsMVvd8jSD/tJnh7kVRKtVpeOLBj7ncqWOFWqpAVp8U9eVYVISSjDK4Os3wQ0O3YvIsyLUBiXccOKWyOKSqNkrQBDjGJS8FiOfwzSYZdW3BLpsWQuZvKCtcphpoJUTJdNykhDKQXEXxIWxbJNVLss92TKVCmshSx2o7yGfvnz34yfYoERNwGX9/a2omgVt8LoVsm15ks0CQtl2H6HkLTaLKNOIsdpqmorubRIkFLDe4VKHcIJrhSEuSTO4oz4PqpXCjAmYucqV3JL7/2DF/jvi33s71O0x2q+OQzgFFcqmXyV+WQwx/F+2/h6tWwXkN9UJrTkZqMPhiRKFcBlOIZceRU32//98/t0LlHX0WoVN860FqyCKDT56Exx0qx99ahhRGSqigw0BsX7OCO7B5lN1m2xW/L6+ViYwFP7B2Hvt2yRg81BU/OCS8to9i4ZxHCgmPe3AcMzd/+4JwxmzrqGcUSO3SUfCn/0WAj6Mi4zJhXbIXoTU5NB7Az970Rly51upEu6HM8CQ4lngTq34cP0osZg3LMCJNs4ckNuk8D7MnxTG6tKRmT8IIpu7SmV+dg+YG+4ZEKmRe0zsKlCgWNgZDc3jQk491qt2M0N6hL0BE1+tYq7BqTVa6BA4Fo0pCDmvVFtE3QD27ZgKFxXQi8nmD65Bh8vQgbETAo5m9TazyMVdh70zHCNccpRvQwga61LzOSGVbeRlPT7YOnfErbXO07yHyP3V9XrH8QGVl4Nq9evqtefgeWqAudxTjxTITPn7wsoigF7ZaxWcvZ6TQSvhr59syo1zAUsyF1Jq90s67JtJxp4nv6o6tBThGGprlPBC5y30iqF5ijkkoVry4yFyjBu8LhEYpkKoDVoxmca6NBFvPDa5kqLnyl1agi+4izXMP2fnTWZ7rzGcMty0PBqyF/73idTWiOdkLlcMlq4UNLgWZkwummtKTimBddi6vO0mFUFcAMM0zieWmLeSbTh4zzn8ouJXyX69Tnwkp1WIJGDX/7yd+zRRPITeaoz0A8I5SdTZoAi8Q7GsZ2YqebQOBXaWB+gXfzzFuL4usN1PKZWLAfsXRvwTZ0Y7CWb+bqAarWYzQCPrr4HDY6d9oCnudsqiCs+xViP1Cs0HlWbhj00MDT/AtDAHB7oFTVg37VJXswC6dCpOVz7YENUR2j1XL3xU7/lyzDXkHWZgL4lU4JjEYX1o1jGlwapUcqJH3iR1gR8Oh9m6MO4q5E5NtYfZkYtpZa//ZcY8iRPCjg9P3uApnFBbM+5sUu3nQ7cHOz0/IzNoTPGAftkWj01iue9LixVGbC54E71MVvkIiWXW7ISQW+QpC8ftUMgYuDgE7bHbjOUCbORo9glGhh/a2Jt08QsExpSWyzJgFRtEdgQ/nBBMWCwKYNzQjhX9UN8ZoskOZvVIiNN17rd00GbOKgCIPKv69RFhazWzTHHG60LYsZ0cmqkgp2C+WMG0rjhnE25saBjVksC7HVdoTc0U8J1BVqATGGjCILQvX3/xGyN8Hbl8rIKtFESw5vSMy599ERsfpErgyePnBeuqw8ThiWAXKF3DzaeG375y9+jjq87z0m3GXMUeJZpMGYLh4RjOXNCUBOhrCWzqs8Rzgf69+vVDeSOTHJSqqw1U/NwCzpDBM6aNiZ6GK6FAE2d5rhltbHWhDULKmKYGJeEBwsqhKgK19uCcA3aJu7yvg+AckwDHqjogz6DFiWXoft00KRam44OBMK41jCJ32hpWGzarknEmUu+bGtBOLcvgIHEyJOxs7f/S5Url01sACHxnBtEUTf81tmH11ZNNJRCPmzP/Og2DVKiVa3b11aV3IqUNVOZAfNdnbitCr24ZM8aUaF3zIXSzzeKy003UTKFiZATKvlt34R+pGa0Btp9ErALABny1ijNba0OLkLeFjlI1pNJsFPiontc4jZUOfx20yn8tk7D+l5jn27jwC9QJgjLOGQbXZ8CY3NOvHWs/9W4gPu6zRaP0cshczZt2N6tWuJgC4zRnvwRfpzBdvVhHMOeTHo9ym539WJr4HdeVcD1AKMYwx3n6+qzvbSkPWoPtiQhqzi63r6Ya5aqPaUzIXHyZwVMLaurCvNfpSXo5y7quAX+6yxuNFrF0QNcbfn/cnkvcHWL7av7LDKbd6Wbfwqvh8hrvp3XH0DMcvtPZvZbZNblhb8lMOlgSVcK2Qr1Oti2UPr+nlgBIJhQWiN+3hiWOnc4WLl/OhCyift3A5OTEJkkaIYm6FdLgoWRSA5GI/xfX7VveyVMTGvrFDPkaV0Uy/+K4ofXPu7XR1PfeSxQnV+Jg5+v0/nBWVNGqHXx9fvS9rLAJoh57ZYJctLn4mFL8c5R62LPqj1cy16b69G0gb6FLISESaPASabSSbN67FeCMf0d70E8tOqm039f11vIR85IDzdZUYDMyB06G3bFd49DYRKM+XJzNwkhG2XblKXpwgtFCbbDmIRmWPihkWTmv5k9gtabvfg+6Z05HMmAratuJW7ibRI8HI0maSfElxuEKOe8EBldgjtXX0D+hu5353K7xYXkrSOPrF6XRRdPI+E60feot9qw3S3SQFprYZdUDr7e45XYc9+PLi6xyFqCzRUWlitliGOsCx9Fw36oG94EsW4V4bR63hSZyQtbxzJcZom6vr3z8EoM5/sDLEGtj9m4U93TH+q9xw4xls+EnG0bd9lJ7CNq1SmuJ7cu6lXiD4De4NUS9vJV9hw4HrtQEWgsH7qK9rtG5W3peXM1ua3ZXjTl17DG2pZYb9VNW66a2mhbGg3qn0H5s6to9gqaVKMMSpThnYKmpBhWFP0FgLZo2KsMksF1Zbso6pfm3OWCtVLTr6uc9AsnT9WAf6NqwFoxwBnPJkR7/2UPS/YWGoKiza2VECTsIXXrQN2doNkdmJkn4LAhNPs1VMZ/3wyGvOxhEKEn+jjU+Fdz/N6nc+v+aEQHvBcjOgkdjuiQ8e2ol773fTkKk3DKtNtEm7LpMJnGjPkS45qQUxVGsUZPtIVRUL116IIiVa6KgGrf3Q1U247a3W1joTNPvGp1WmtWqQXoaV2QBU8LuBaI6+AwKOlbV6wHXhZgTLGkO94zusGeiZmwCJd74DjlFU9EIXCPdpcQnaN027wZsM9duX9H09VzmEOBW3uLjMlZF7sXSn+Z4rWBmHGW4M1wxGpB5lymDhZ2OwzBm4gLIaBdaYFZjdXItXC8KWk1ekfJJZ+R38ahH7AMCgxjhmmVYE3CqKJ23me5KJR2FRlaEF1WJSG+w8ta2p0cMfxryNGK5x56N7ErfRjaS3AJEjEruubPUytSIIy0loVKv7haWl0UrFLW1bfwgBryiMOt5tLQRX9XBPI6aAXmCwJg/IXKTwZQw++F/IJ3SfHO5kVrV58hMcJCd85dLBa3tvTn/THfC/tDnbAPUCkjrNLLbvRM2LxOKA0IJ2l/uJm+b15ABJt8N0emUrPhqK1SM8yhqIYfwaKFmOHx2Qkllc/ZL3/+K3sPXEuWq4Wz1rTWUCy7xxYoOad5J7Y2J3SPBWqbo8RT7q+kUuhtJPg555buhWFSIaR3KXf59axOCpF2jyZ2d4+aRwvdnRCqHfg3E/76LRbDOKvc6ELILwN2LJfuEUW7A2E7jestg3a94OFI8LihpRk+40AI2UAxd+828IiSAINMuAKoVvXMUQuZ8Yvr30TGtR1nGavWbiMjXN2x4xBZqu1xB83awcYLzL2bvf1rEyCzSglpzRHLNJ/abv547Yoy7X+3mprbzY04Yj9NqxLniX7Fbau7r7OWoPbjrYYpUOXV9N7y8Ep4c7pozJKhtf4as3bQDG3pwUEfM+WNBSYLujSn04+g5yJtTud3ePSQOg+jOCpECh4n8vvX8fdn79n8xWAUxUHa/wDnHr4/efPux4/vkBkMpE5g+4PRYERwtjK25DKgtPHlVHBVtif54M7q07Orp2dXT8+unp5dPT27enp29fTs6unZ1dOzq3/1Z1cBuDKsCi5kUHByIPnFWj0wiqOj8KXVZRzlCKofXUQ3N5hYfEIcDZv/VBOyc3EZR3OuBSJRBOj4GzRZgKPekU4+++CrjM/ZHY+2NvLfINcSYWvyOodHfYHl2jOx1SVWpR18jay5Hm8cA3vnOE83w62iCOLvbsRxionSvX3DKsTZ6cfzKI6ai+4lvSqLNF8gNsUXjtsAwKK2m6jgclYT+BW5OVfu6lPeh+u/EFzv/wgQtL48+ji+Wwb+Fxe1ccDNjSsFEODs+rtPd47wgm16o3IuV6vVPwDClwzW",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,b={},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)(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)(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.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}\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}\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}\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}\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}\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.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.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"response:"})," Provide the value that should replace the existing response."]}),"\n"]}),"\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.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.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.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)(c(),{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},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",description:"Allowed values - signature, stamp.",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_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 j(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.84e557cf.js b/assets/js/c195e1f1.84e557cf.js new file mode 100644 index 000000000..6f1c28b7b --- /dev/null +++ b/assets/js/c195e1f1.84e557cf.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:()=>b,contentTitle:()=>x,default:()=>j,frontMatter:()=>f,metadata:()=>i,toc:()=>g});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":"eJztW1FvGzmS/iu8fklitCXZSebmjFywniQ3MTaYGIlzwcIyNFR3Sc2ETfaSbMkaQ8A+7D/Yp33dnza/5FBFdjdbli07M8Du3XkwmLHYZFWxWFUsfkVeJY7PbXJ0nrzWWV2Ccja5SJMcbGZE5YRWyVFyVgB7ZYA7YE0vNjO6ZA7KSmLz8ekJ41LqpWUrXTOn2RwUGPykYMnyhjabrtiX2jpWGb0QuVDzlsZE5Ewo64DnTM9YXUnNqQMnEjMh4bFQzBXAZtqU2GfKLXz3jGnDpkJxs3rCYAFmxZwogeRQADkKk3nheSvIgJ0FthapMQMV9sjlitUWcuJmWcYVm0IYnfsp1xYME8qBmfEMGHfsfG/vNUzrOft0srd38bhwrrJHwyGvqoGuQFkxV5JP7SDT5TDHjlU+e4JC15bm3yn3LFLnYKzG6k+6JiG8toDlMOO1dGzBZU1qQKWzpcjngLrlKLomHQnDFC+h993WVaWNY3CZQeUYCsZdbSBl1vGySplQwgkubcpEyecwGKuDAdvbg5ILubc3Vj///PNYXY0VY+MEqY+TIzZO6PM4SX27AZ5rJVf4bcalhdAeRI+G/AEueVlJQMWMk7FaBwZjdYhckcHNTP1f9+H5RUOfy1Pk8kVP2Zlw8hZW2MVhl/vxy0D3+T1DfpkuK65WN3MLHe6pT69JVi0cky7v832OfHPubpkifr0fx4OD/dHz/cPR4fM+s++QmYNLN9WXN/MLHe7HslwxHNfn9++k1AKyr7cybHrch+P5ONEUAfcPx8lFx3Qf1em7He3tscZHC74AphWgZ5faAHMFV9TgvdUV3FFAshiRpsAsSMgwrkxXjWOT039P62V0leulumXNQo/7KdHP6KCvxP9AjobnQrNp7Zy+hSv1+h1Y7u2dGpgJKdlnH51QlU1TE7C4AQYS/M5B+sMWoSwY1JtQTkcxnU1hhnoXjgnLbMEN5GwpXME4Re0Be6/kiuJtO4RCuzas4JZVYEphrcAAqhnPc+xa0pLgkhuwlVYWvKA+HiOtaHVtoWuZ42YicW/Ar3AprMMw3wwf+Nm/E9bhFrYRm2lWjR5wFQ52+9M2d/K86CNXuYElm0Iv/B3eNShco8jGyejZ8OD58HB0+Cwm+fSbXbGjfT5OSk6Rlo2TGfi/I997dk9LDb228mpYddQpUtLWdzNZ+rxd0+K/f3j/YTn6449zfXx8fPzTx0/Fm0/z4+PjEn8PBoPAK5D+7pv9PJ5Do6RuFkma6ApzL6HVSZ4cJSF/CTaPHtHkXCJP0qTihpfgwGAaeEWck6MkSsuSNBGYBlbcFclmbqinXyBzJ5SzNflLkiYG/lwLA3ly5EwNaWLdSiJZK3CjStIELiupc0iOfNxIbFZAyZOjq8StKurpjFDzJE0w2+MubgnbHYr09mBaZIdFNU3W6wvPFqz7QecrJJVp5UA5/JNXlRQZKWX4xaLoVxHPTtzzBPMiVMZF2oji54iqMqhZJ8CSoJgU3Ffin6J02KcV11R6rJiPmVyydnGYrSATs1WTMtJQSgHxl4KlXLWJapflnsyYLoVzkKd+VFihX//ydxtILDHiTsHnvb2tKFmnrTK6WXJj+ApNwkEZt9+gJKO366jTyHGW6doprhwypNTwVqVSh5jAFw1xLolUvBHfxvWLBoyJ2LkqtNrR++DwKf779AD7hxTtvivfHAaQxBc9nXyT+eSwwPFh2/j2ZdmtoLCpTGjKzUYfDZlqLYGreAy58jpttv/b6Yd0bqovk/U6bZxpI1hFUWjy0ZvipJn7+l7DiMlMyxwMBsXbJCO7B5VPNm2xm/Lm+VjYyFP7B+Hgt2xZgCvAUPOSK8eIepcMYjjQLPjbgOGZu3/cExYzZ1PDOCHH7pIPjT96IkR9GVc5U5o9In4TW5NBPBqG31Odrx51I33S5WUWGEqCCNS5DR+2FzUG454VINvGkRt22xTe1+Gr2jpdMmITBlF0a0+pLMT2AXvFFRMqk3XIwGYaFY6BkV1dNSbg3Wu9ZldXuJZgJmjy63XaNSCvXgMFAt9iIAOx6I1qm6Ab2LZFQ+GyEmY1wfTJN4R4EQsg5kqo+aQ2gY7S2HnQM8MNwSlHDTqAvLUuMVdbZt1GUlrfO2v/mrLDuiOR/zd6f1G9fCu2iPJiWL18Ub38DKzQFXiP8+qZCZV7f1+ClAP2wjqj1fzlhgpeDEP79qU0sBCwJHelVe2obOq2JTQIMv1J17GnCMsyU2eCS6RbGZ1BcxTyycKlY9ZBZRm3eFwitcwE0BwM43MDdOgiWXjtCm3EL5Q6NQxfcFYYmP3now2dPnqJ4ZYVYODFkL8MvU9mNEc6IXO1YjRxoZXFszJhdLPaUHDMJDdiFvK0lFUSuAWGaRzPHAnvNdrIcVZw9dWmL6bm5Rnwkr2vQKEEv/71H9ijieQn6r3JwdwhlJ/MmAWKxI8wjj1KmW4OjTNhrAsB2se/YCFerhtcJ2BqcjVgb9qAb+upxV6qodcFVGfEfA54dA09aHDqVw94VvitgqTiM4z1yL1C49G1bcRDA0Pzl4AG5vHAsFAD9kOb5KUs0g6dmuO5D7ZEdYRWz/SrQPo1X8W5hqrLKZhrOiU4FlHYMIrlfGWRG6Wc+IHLrCbg0/swQx/GXY3MsbH+ODNqObXyHTzHkKf4VML7s9M7rDROiO17N/bptl8DT4O9PztlC+iMccA+2XadmoXnvS4s0zmwheB+6VO2LERGLrdiJYLeoGi9QtSOgYiBh0/YPrsuUC7sVolSn2hg/K1JtG2EWS4MZE6uyIB07RDYEOFwQTFgsC2D80o40/VdfGaHJjmb1yKnla5Nu6eDsWlUBUDk39SZjwp5bZpjTjBaH8Ss7fTUaAU7RfRTBsr64ZzNuHVgUlYrAuxNXaE3NCThsgIjQGWwVQVR6N69f2K2Rni79nlZBcZqheFNmzlXIXoiNr8stMWTR8Gl7xrChGVTQKnQuwdbzw2//vUfSSfXjeek64J5DjzPDVi7Q0LCsbw5IaiJUNaKOd2XCOmB+cNmdQOlI5OclDpvzdTe3YJOEYFzto2JAYZrIUBbZwVuWW2stXHNgooYNsUp4cGCCiG6wvm2IFyDtombvO8DoB6zSAYq+qDPoEWpVew+HTSpN8jRgUBY3xon8VstDYtNu1cSceaSr9paENIOBTBQGHlydvr6v6hy5bOJLSAknnOjKOqHXzv78NrpiYFSqLvtmR/9pkGL6HTr9rXTJXciYw0pO2Chq1e307EXl+xxoyr0joXQ5slWdXlyE60ymAg1oZLf7k3oJ2pGa6DdZwpuCaBi2ZpF81urh4tQtmUBivV0Eu2UOOm+czxPUYclmDlMMjxwkyPA3b2A5AgB1NYmYMu4jmEDpa2mo4zShLQ8byx7JtBA0R46o3yrl6irNqvC3NfTRlUykjjARDH1jCulnT+j4jGxrYRix5IL1bFAaLPxpJDzZYXWnhdqi3ikt82lSYOClefo7rzl3Fk4l5r8OaS05K15X5KTGbItaHeh9Uox1yUGtfWOoZcKDGFhlYEZGNwMbHu43vqVzsdcWk1z6lFtzLcx8AFjHkSrPJ6/DZW57uNxvbeJVz6RwC9QThGm85UO3Apoo2xwg2swz2/GifzXXbHpGKM+5D7GWbZ/rbY82AFrtUgQwtFz2O3OuK9hT6aCX6su2wpqa8oxvKqAmwEtOmYg31av76WpLfQy2JGUrtPkcvdkLlmm97XJhULijyXMHKurCs9D2igwT7zD+Qn+60xuNFqnyR1C7+p/5fSe4uyWu2f3WeSu6Ep5/xRZn6GsxW5Z34KYF+6fLOz3KKw/J/yeQLWHqX1pbCf072F8qc3tPbEiRLCxclb8sjUsde5wuPb/dKB0E/dvBqonMVJNUB0R6FfPoomRSg5HI/xff2lf90raeMypMzwxzWopV/+WpHevhd2+Hk29776Fi+KLOPzlMlscnjZlpdrIb9+XdpeJtpUcNm4doSR9Ke42leActZH7Tu/jXPbbzIPIRustlBQKJs0CTnKdTZrZrylRtLa/491Jhna5CQ3qr/UO9ok30mfbrChC6tQjwgq6yxgBl8RDEWaZzV01hPC0a1OWpks/QROGYSGQRpKZ/272CMZs9+LbtHfqM2ALrq66mXjCuzT4bDSaZJ0Sn29RolpwKXK6FHmmv4L6Hd3vxul2k4vZO88eRb0sZRdPE+E70fekN9u43U/SQlYb4VZ0PeByn1di338/Or/AonsJrtB40aDSliTGewJHybAf6oZXUaxbJ0jWLJpLB+SFrWNZrvKpvry+8/BKDBcHAyxJbo7ZulPd0h/q/fsOsY7PhZrvGnfRaewjrqpfuJ7euqhXiT8CekNYlrhXuHVRAMdjOC4EGsuH7obDm2bJ26sI228XtDX886YcH9fc25L7tTp6K1VTK29L5VE9PCqHdxXuXoGbatZRyTq+Y9KUmOMKc7gQ0haRe5ViMriujJsk/VKtv2yyUXr8bZW0fiHtoTr0f6g6tFEc8sazrcJx8LxXWwgWGoPkzS2mGDTuIbebwO2NIOoNGGpg4LFCNPsNlC583w6OISi1FZPyU47widhLQ4xqfK85mh/QmfZgNKLD39MRnZKejegA8v2ol9r3/TyJE3TKwtsknDLtONHGbPoCY55QMx1HuGYNaXujgHvtQAYy077ihCaxtxcteztqb6+Nk950ETF6XxtW6SWYWS3JumcSLgVigDgMSvrWXewAXkqwVq7oPcCcAKpczIXD0kooMmS84lMhBe7f/sKqd6IuBbAD9rm7GvLI0DMFWIDEbb9FUdW8i+tLbb7O8IpJyjib4isCxPVBFVxlvoTgdx+CwhEzwuJHZQRmPM6g1MLLppUz6DklV3xOPp3GPsJykBjiLDN6ivUrq2XtPdNxIbXx1TuaEF1sJiW+wYt9xp8qcWswUKCFL0KZxqa+TGZpn8EpKMSz6EkIz5xAiM1pViups68ey6ylZJV2vhaKh9dYRhzuDFeWHoX4gmFYg1ZhoXgENly+/WQBV/idUF/x3jHe7z1v7eozTK1w0J2Bl8vlte3+SX/Mj8K9rafsA1TaCqfNqhs9F66op5QixETaH57Sj81rmSgB6GjkOrNbjuE6s8MCZDX8CA4txA6PT08o4XzCfv3L39g74EaxQi+9tWa1AbnqHuag5vzKe7W1+aJ/WFK7AjWe8XB9mcJyo8HPBXeEjGLCIVRwKX9R+rSeSpF1D2z29o6aBy7d/SHCncP7mnBVGwunnFV+tBTq64Adq5V/cNPuTthO43rToB0xemQUPYRpecZPfrDcYEEu/BufAG9DLnyx3Oh67rnFwoTJ9W+t49yO85xVGzfXsbTRiePRWqoDcw/busHWy+69W+D9Kzag8koL5ewRyw2fuY5+unGdnfbGa03NTfhGHWkg0y6J98Qw47bV3+3aSF778ZawcWRoe+++eCWCOZ03ZsnQWn+LWXvYhrb7CATALHprMdKBKe372UcwC5E1J/cbPHpInYdJmkiRQcCQwv51/OPpO7Z4OhglaXQkuINzD9+dvHrz08c3KAwGUq+wg8FoMCKoW1tXchVx2vrKLrpW3dN8dL/54YnewxO9hyd6D0/0Hp7oPTzRe3ii9/BE7+GJ3r/6E70IXBlWkgsVFaM8gH6+UStM0uQofpV3kSYFAu5H58nVFSYWnxBjw+Y/14T6nF+kyYIbgSgVATrhtlUeYaw3pJOPP4QK5BN2wwO/rfI3qLZCSJu8zmNVX2G18aRwfYEVaw9to2i+xysvwP4Z0ukoXCuYIDbvRxxnmCjd2jeuUJy+/3iWpEnzKKKkF4iJ4UvEpvjSSxsBWNR2lUiu5jWBX4mnufbX5Io+lP+VoPzwR4Sg9fXRx/j9NPC/OKmtA66ufJmAwGjf33+6cURQbNMbF+divV7/D1M/1Xg=","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 r=n(74848),o=n(28453),s=n(33617),a=n.n(s),l=n(17543),d=n.n(l),p=n(86013),c=n.n(p),m=n(63723),u=n.n(m),h=(n(18766),n(79329),n(9303));const f={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:"eJztW1FvGzmS/iu8fklitCXZSebmjFywniQ3MTaYGIlzwcIyNFR3Sc2ETfaSbMkaQ8A+7D/Yp33dnza/5FBFdjdbli07M8Du3XkwmLHYZFWxWFUsfkVeJY7PbXJ0nrzWWV2Ccja5SJMcbGZE5YRWyVFyVgB7ZYA7YE0vNjO6ZA7KSmLz8ekJ41LqpWUrXTOn2RwUGPykYMnyhjabrtiX2jpWGb0QuVDzlsZE5Ewo64DnTM9YXUnNqQMnEjMh4bFQzBXAZtqU2GfKLXz3jGnDpkJxs3rCYAFmxZwogeRQADkKk3nheSvIgJ0FthapMQMV9sjlitUWcuJmWcYVm0IYnfsp1xYME8qBmfEMGHfsfG/vNUzrOft0srd38bhwrrJHwyGvqoGuQFkxV5JP7SDT5TDHjlU+e4JC15bm3yn3LFLnYKzG6k+6JiG8toDlMOO1dGzBZU1qQKWzpcjngLrlKLomHQnDFC+h993WVaWNY3CZQeUYCsZdbSBl1vGySplQwgkubcpEyecwGKuDAdvbg5ILubc3Vj///PNYXY0VY+MEqY+TIzZO6PM4SX27AZ5rJVf4bcalhdAeRI+G/AEueVlJQMWMk7FaBwZjdYhckcHNTP1f9+H5RUOfy1Pk8kVP2Zlw8hZW2MVhl/vxy0D3+T1DfpkuK65WN3MLHe6pT69JVi0cky7v832OfHPubpkifr0fx4OD/dHz/cPR4fM+s++QmYNLN9WXN/MLHe7HslwxHNfn9++k1AKyr7cybHrch+P5ONEUAfcPx8lFx3Qf1em7He3tscZHC74AphWgZ5faAHMFV9TgvdUV3FFAshiRpsAsSMgwrkxXjWOT039P62V0leulumXNQo/7KdHP6KCvxP9AjobnQrNp7Zy+hSv1+h1Y7u2dGpgJKdlnH51QlU1TE7C4AQYS/M5B+sMWoSwY1JtQTkcxnU1hhnoXjgnLbMEN5GwpXME4Re0Be6/kiuJtO4RCuzas4JZVYEphrcAAqhnPc+xa0pLgkhuwlVYWvKA+HiOtaHVtoWuZ42YicW/Ar3AprMMw3wwf+Nm/E9bhFrYRm2lWjR5wFQ52+9M2d/K86CNXuYElm0Iv/B3eNShco8jGyejZ8OD58HB0+Cwm+fSbXbGjfT5OSk6Rlo2TGfi/I997dk9LDb228mpYddQpUtLWdzNZ+rxd0+K/f3j/YTn6449zfXx8fPzTx0/Fm0/z4+PjEn8PBoPAK5D+7pv9PJ5Do6RuFkma6ApzL6HVSZ4cJSF/CTaPHtHkXCJP0qTihpfgwGAaeEWck6MkSsuSNBGYBlbcFclmbqinXyBzJ5SzNflLkiYG/lwLA3ly5EwNaWLdSiJZK3CjStIELiupc0iOfNxIbFZAyZOjq8StKurpjFDzJE0w2+MubgnbHYr09mBaZIdFNU3W6wvPFqz7QecrJJVp5UA5/JNXlRQZKWX4xaLoVxHPTtzzBPMiVMZF2oji54iqMqhZJ8CSoJgU3Ffin6J02KcV11R6rJiPmVyydnGYrSATs1WTMtJQSgHxl4KlXLWJapflnsyYLoVzkKd+VFihX//ydxtILDHiTsHnvb2tKFmnrTK6WXJj+ApNwkEZt9+gJKO366jTyHGW6doprhwypNTwVqVSh5jAFw1xLolUvBHfxvWLBoyJ2LkqtNrR++DwKf779AD7hxTtvivfHAaQxBc9nXyT+eSwwPFh2/j2ZdmtoLCpTGjKzUYfDZlqLYGreAy58jpttv/b6Yd0bqovk/U6bZxpI1hFUWjy0ZvipJn7+l7DiMlMyxwMBsXbJCO7B5VPNm2xm/Lm+VjYyFP7B+Hgt2xZgCvAUPOSK8eIepcMYjjQLPjbgOGZu3/cExYzZ1PDOCHH7pIPjT96IkR9GVc5U5o9In4TW5NBPBqG31Odrx51I33S5WUWGEqCCNS5DR+2FzUG454VINvGkRt22xTe1+Gr2jpdMmITBlF0a0+pLMT2AXvFFRMqk3XIwGYaFY6BkV1dNSbg3Wu9ZldXuJZgJmjy63XaNSCvXgMFAt9iIAOx6I1qm6Ab2LZFQ+GyEmY1wfTJN4R4EQsg5kqo+aQ2gY7S2HnQM8MNwSlHDTqAvLUuMVdbZt1GUlrfO2v/mrLDuiOR/zd6f1G9fCu2iPJiWL18Ub38DKzQFXiP8+qZCZV7f1+ClAP2wjqj1fzlhgpeDEP79qU0sBCwJHelVe2obOq2JTQIMv1J17GnCMsyU2eCS6RbGZ1BcxTyycKlY9ZBZRm3eFwitcwE0BwM43MDdOgiWXjtCm3EL5Q6NQxfcFYYmP3now2dPnqJ4ZYVYODFkL8MvU9mNEc6IXO1YjRxoZXFszJhdLPaUHDMJDdiFvK0lFUSuAWGaRzPHAnvNdrIcVZw9dWmL6bm5Rnwkr2vQKEEv/71H9ijieQn6r3JwdwhlJ/MmAWKxI8wjj1KmW4OjTNhrAsB2se/YCFerhtcJ2BqcjVgb9qAb+upxV6qodcFVGfEfA54dA09aHDqVw94VvitgqTiM4z1yL1C49G1bcRDA0Pzl4AG5vHAsFAD9kOb5KUs0g6dmuO5D7ZEdYRWz/SrQPo1X8W5hqrLKZhrOiU4FlHYMIrlfGWRG6Wc+IHLrCbg0/swQx/GXY3MsbH+ODNqObXyHTzHkKf4VML7s9M7rDROiO17N/bptl8DT4O9PztlC+iMccA+2XadmoXnvS4s0zmwheB+6VO2LERGLrdiJYLeoGi9QtSOgYiBh0/YPrsuUC7sVolSn2hg/K1JtG2EWS4MZE6uyIB07RDYEOFwQTFgsC2D80o40/VdfGaHJjmb1yKnla5Nu6eDsWlUBUDk39SZjwp5bZpjTjBaH8Ss7fTUaAU7RfRTBsr64ZzNuHVgUlYrAuxNXaE3NCThsgIjQGWwVQVR6N69f2K2Rni79nlZBcZqheFNmzlXIXoiNr8stMWTR8Gl7xrChGVTQKnQuwdbzw2//vUfSSfXjeek64J5DjzPDVi7Q0LCsbw5IaiJUNaKOd2XCOmB+cNmdQOlI5OclDpvzdTe3YJOEYFzto2JAYZrIUBbZwVuWW2stXHNgooYNsUp4cGCCiG6wvm2IFyDtombvO8DoB6zSAYq+qDPoEWpVew+HTSpN8jRgUBY3xon8VstDYtNu1cSceaSr9paENIOBTBQGHlydvr6v6hy5bOJLSAknnOjKOqHXzv78NrpiYFSqLvtmR/9pkGL6HTr9rXTJXciYw0pO2Chq1e307EXl+xxoyr0joXQ5slWdXlyE60ymAg1oZLf7k3oJ2pGa6DdZwpuCaBi2ZpF81urh4tQtmUBivV0Eu2UOOm+czxPUYclmDlMMjxwkyPA3b2A5AgB1NYmYMu4jmEDpa2mo4zShLQ8byx7JtBA0R46o3yrl6irNqvC3NfTRlUykjjARDH1jCulnT+j4jGxrYRix5IL1bFAaLPxpJDzZYXWnhdqi3ikt82lSYOClefo7rzl3Fk4l5r8OaS05K15X5KTGbItaHeh9Uox1yUGtfWOoZcKDGFhlYEZGNwMbHu43vqVzsdcWk1z6lFtzLcx8AFjHkSrPJ6/DZW57uNxvbeJVz6RwC9QThGm85UO3Apoo2xwg2swz2/GifzXXbHpGKM+5D7GWbZ/rbY82AFrtUgQwtFz2O3OuK9hT6aCX6su2wpqa8oxvKqAmwEtOmYg31av76WpLfQy2JGUrtPkcvdkLlmm97XJhULijyXMHKurCs9D2igwT7zD+Qn+60xuNFqnyR1C7+p/5fSe4uyWu2f3WeSu6Ep5/xRZn6GsxW5Z34KYF+6fLOz3KKw/J/yeQLWHqX1pbCf072F8qc3tPbEiRLCxclb8sjUsde5wuPb/dKB0E/dvBqonMVJNUB0R6FfPoomRSg5HI/xff2lf90raeMypMzwxzWopV/+WpHevhd2+Hk29776Fi+KLOPzlMlscnjZlpdrIb9+XdpeJtpUcNm4doSR9Ke42leActZH7Tu/jXPbbzIPIRustlBQKJs0CTnKdTZrZrylRtLa/491Jhna5CQ3qr/UO9ok30mfbrChC6tQjwgq6yxgBl8RDEWaZzV01hPC0a1OWpks/QROGYSGQRpKZ/272CMZs9+LbtHfqM2ALrq66mXjCuzT4bDSaZJ0Sn29RolpwKXK6FHmmv4L6Hd3vxul2k4vZO88eRb0sZRdPE+E70fekN9u43U/SQlYb4VZ0PeByn1di338/Or/AonsJrtB40aDSliTGewJHybAf6oZXUaxbJ0jWLJpLB+SFrWNZrvKpvry+8/BKDBcHAyxJbo7ZulPd0h/q/fsOsY7PhZrvGnfRaewjrqpfuJ7euqhXiT8CekNYlrhXuHVRAMdjOC4EGsuH7obDm2bJ26sI228XtDX886YcH9fc25L7tTp6K1VTK29L5VE9PCqHdxXuXoGbatZRyTq+Y9KUmOMKc7gQ0haRe5ViMriujJsk/VKtv2yyUXr8bZW0fiHtoTr0f6g6tFEc8sazrcJx8LxXWwgWGoPkzS2mGDTuIbebwO2NIOoNGGpg4LFCNPsNlC583w6OISi1FZPyU47widhLQ4xqfK85mh/QmfZgNKLD39MRnZKejegA8v2ol9r3/TyJE3TKwtsknDLtONHGbPoCY55QMx1HuGYNaXujgHvtQAYy077ihCaxtxcteztqb6+Nk950ETF6XxtW6SWYWS3JumcSLgVigDgMSvrWXewAXkqwVq7oPcCcAKpczIXD0kooMmS84lMhBe7f/sKqd6IuBbAD9rm7GvLI0DMFWIDEbb9FUdW8i+tLbb7O8IpJyjib4isCxPVBFVxlvoTgdx+CwhEzwuJHZQRmPM6g1MLLppUz6DklV3xOPp3GPsJykBjiLDN6ivUrq2XtPdNxIbXx1TuaEF1sJiW+wYt9xp8qcWswUKCFL0KZxqa+TGZpn8EpKMSz6EkIz5xAiM1pViups68ey6ylZJV2vhaKh9dYRhzuDFeWHoX4gmFYg1ZhoXgENly+/WQBV/idUF/x3jHe7z1v7eozTK1w0J2Bl8vlte3+SX/Mj8K9rafsA1TaCqfNqhs9F66op5QixETaH57Sj81rmSgB6GjkOrNbjuE6s8MCZDX8CA4txA6PT08o4XzCfv3L39g74EaxQi+9tWa1AbnqHuag5vzKe7W1+aJ/WFK7AjWe8XB9mcJyo8HPBXeEjGLCIVRwKX9R+rSeSpF1D2z29o6aBy7d/SHCncP7mnBVGwunnFV+tBTq64Adq5V/cNPuTthO43rToB0xemQUPYRpecZPfrDcYEEu/BufAG9DLnyx3Oh67rnFwoTJ9W+t49yO85xVGzfXsbTRiePRWqoDcw/busHWy+69W+D9Kzag8koL5ewRyw2fuY5+unGdnfbGa03NTfhGHWkg0y6J98Qw47bV3+3aSF778ZawcWRoe+++eCWCOZ03ZsnQWn+LWXvYhrb7CATALHprMdKBKe372UcwC5E1J/cbPHpInYdJmkiRQcCQwv51/OPpO7Z4OhglaXQkuINzD9+dvHrz08c3KAwGUq+wg8FoMCKoW1tXchVx2vrKLrpW3dN8dL/54YnewxO9hyd6D0/0Hp7oPTzRe3ii9/BE7+GJ3r/6E70IXBlWkgsVFaM8gH6+UStM0uQofpV3kSYFAu5H58nVFSYWnxBjw+Y/14T6nF+kyYIbgSgVATrhtlUeYaw3pJOPP4QK5BN2wwO/rfI3qLZCSJu8zmNVX2G18aRwfYEVaw9to2i+xysvwP4Z0ukoXCuYIDbvRxxnmCjd2jeuUJy+/3iWpEnzKKKkF4iJ4UvEpvjSSxsBWNR2lUiu5jWBX4mnufbX5Io+lP+VoPzwR4Sg9fXRx/j9NPC/OKmtA66ufJmAwGjf33+6cURQbNMbF+divV7/D1M/1Xg=",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,b={},g=[];function y(e){const t={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Create Document from Template"}),"\n",(0,r.jsx)(a(),{method:"post",path:"/createdocument/{template_id}",context:"endpoint"}),"\n",(0,r.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,r.jsx)(t.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,r.jsx)(t.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,r.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,r.jsxs)(t.ol,{children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"email"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "email",\n "readonly": false,\n "default": "email@example.com"\n}\n'})}),"\n",(0,r.jsxs)(t.ol,{start:"2",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"name"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "name",\n "readonly": false,\n "default": "joe"\n}\n'})}),"\n",(0,r.jsxs)(t.ol,{start:"3",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"job Title"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "job title",\n "readonly": false,\n "default": "ceo"\n}\n'})}),"\n",(0,r.jsxs)(t.ol,{start:"4",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"company"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "company",\n "readonly": false,\n "default": "example pvt ltd"\n}\n'})}),"\n",(0,r.jsxs)(t.ol,{start:"5",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"date"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "date",\n "readonly": false,\n "default": "11-05-2025"\n}\n'})}),"\n",(0,r.jsxs)(t.ol,{start:"6",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"textbox"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "textbox",\n "readonly": false,\n "default": "my text"\n}\n'})}),"\n",(0,r.jsxs)(t.ol,{start:"7",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "checkbox",\n "readonly": false,\n "default": ["option-2"]\n}\n'})}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"default:"})," You can have one or more than one value that needs to be selected by default."]}),"\n"]}),"\n",(0,r.jsxs)(t.ol,{start:"8",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "dropdown",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,r.jsxs)(t.ol,{start:"9",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"radio button"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "radio",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.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,r.jsxs)(t.ul,{children:["\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.strong,{children:"response:"})," Provide the value that should replace the existing response."]}),"\n"]}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,r.jsxs)(t.ol,{children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"textbox"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name":"textbox",\n "response":"andrew bee"\n}\n'})}),"\n",(0,r.jsxs)(t.ol,{start:"2",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"date"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "date"\n "response": "04/15/2024"\n}\n'})}),"\n",(0,r.jsxs)(t.ol,{start:"3",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "checkbox",\n "response": ["male", "female"]\n}\n'})}),"\n",(0,r.jsxs)(t.ol,{start:"4",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"radio button"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "radio button",\n "response": "male"\n}\n'})}),"\n",(0,r.jsxs)(t.ol,{start:"5",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"image"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n}\n\n'})}),"\n",(0,r.jsxs)(t.ol,{start:"6",children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'{\n "name": "dropdown",\n "response": "female"\n}\n'})}),"\n",(0,r.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.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,r.jsx)(c(),{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 final PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\nfalse - If you choose not to merge, the completion certificate will be provided as a separate 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"},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",description:"Allowed values - signature, stamp.",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_template_id_body"}}},required:!0}}),"\n",(0,r.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 j(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/c4fbe420.3faae548.js b/assets/js/c4fbe420.3faae548.js new file mode 100644 index 000000000..bad158162 --- /dev/null +++ b/assets/js/c4fbe420.3faae548.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:()=>g,contentTitle:()=>f,default:()=>j,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":"eJztPNtyG7eSv4Kd2qrEPEOKpCRftC+rOIpDx5a0lnyVdBRwBuRAmgEmAEYUrVLVeTh/sE/7ej4tX7LVDWAuvEiyrST2LvMQi4Nbo9Hd6Au6rwJDxzrYOgoOWZan1DAdnIRBzHSkeG64FMFWcJgw4pvJj4qODBdjsr0/IEzQYco0KTRTmhhJIsWgU1RoIzP+EVqJ8TOHRDN1AWOpJsO0YLniwmgykoqMmWCK4sSxjIqMQcOEm4TkisVsxAWLiTaqiEyhmO6Q17kURBdRxLQeFaldmUtB5IjQcs2QmIQhqIqZQglNKCkE/61gpNWSwzMWmUHcapHvY6b5WFDDYgDODz/l8YOQTBIeJSSiggwZbDWGnTqAWQ3cIYU2KXBNnbOIjzh0dpN1yHYcc4CRpuk0JJS0WoVKWy3CNcmVvOAxi/1qcjQClFJELeHCMDWiEUNcMZhFjHEZPzmhIiYjGvGUmyYaScy1UXxYwMqdY3EsDnm+RV7nqaQxmcpCkf0ff6q6G0ng21Gr9SMbFmPyetBqnXyfGJPrrbU1mucdmTMB2ErpUHcima3F0DGPR4grphjMivhiVPN0SmgckwmPx8xoPBBBIplPSSSlirmwpJHTMSOiyIZM6RB3k0nFCBeEEsVoPG0b2S40I88P9nYBDRk1HbKfFjosl4u5YpFJp3Z6QI/f1Xf2dB5uAA1xMQ5JRs8BS9yQ3woencO2NRN4tI5kEFet1luAt8QO147GY0JMwjWZsGEi5TlhF9A84WlKjOLjMVOt1rH49ddfj8XVsSDkOMAex8EWOQ7cFMdBaJvMNGe25ce9p69f7uwenh6+398p2z2lzvQZ/Fj2GPF0dobXr16UzYJms8272y+rBYQ0rn0/ZVQzotgFZxM8Bzhqu1ePhXJYTU7Y0WULDGJKw9cj+ELIlf2nCc3B4Nnuzqs6LLYHyyhPG112Xm4PXjT65IkUzWn2f97bbc5TqNosg91nFim2/Rr+OXHwuhPZdgd0OHi5c3C4/XIfOl+7cwRqOCjyXCo4/reWoLfgmI/FDyyVE0IVQ+qJZJZJQXKqaMYMysaEGmxW7LeCKxZb4UbT1HPG1rFok1YLSGGr1SIDEfMIWMOy+TRnINls347tCiwDXQ+cqLFda4wEssiKE+CQCbXcnacgSKCrYiClDL9gzYkvQzKFiX9kQBd22kQq/lEKQ1MkigumDI9oWmdiABBFn6EKRVAuuTD+q1uBvHfMCryMLOqkDIAWA7IyLrBFM3JB04JpB9UkJAlA9YrlimmUuG5eQKSIScL4OFm6Ho3PCm0aE5NCeznqoXBr+VNC9DJE24immhE+auAyo+esthqRuZXvHfLDlMRsRIvUhISD/DGqYB2yKw2heZ7yCO9GEOf24ikUa+MpO3JwgACrABD79n6AGyHmcDeAtIFGnMKN8dABndkLBbaHctQkVBApZg46kqlU8ySEn5t4JJEUhgnTIdsXlKcIvN2sJlxEaREzMkxpdB7izR4SBXcZnMqUpamchJbesQvesIhzxA/RLAUqlALgF9Itz3V1h3bIIcifkp+g0aMaF+G6jlUnw0cSVgYUeBYjKFdCRFxIzuSQGG5SFgLD5lRMQxJbpYFdmqG8DEmUsOgc/1I05pIMC2OksBuLlcxjOREOlyMpjOYfF3Ckb/l0jPZDshGShyF5HJJeNyS9fkh6GyHpPQxJ73FI+t2Q9Psh6W+EpP/QgtV/7HBNSwTXAej1LZbNt4NdkLsvuEbOBoGpSxk8acjgXoe0WiU3zV6/1R1bdilvK5CZ0NZzvy/hx3r/kfs5hZ8P+4/dzwl27W24nwn87Pfq90QfITE0y2+AAprvFQKvLFgigm/uzj0OvDyDjyCIQt9QXcUOHmi4ru9lHfbCBTecpnr5dnyPr2hHFUhzm9qATSG5Lt+R00G+mu3U4UGVBcSkbUKxWmvyDI9Q9Od2v9lxN8vyzdtlv5q918D5sq0/hK2DaDoE0bR8/6X0+oqQMAvTl2HiUQcVAJTMy/HgOnxFWGhC9GU4eAw4gEtpOQKg9SvafQ0ca4DhDW/buhvt3ma73+1vNDAAlrLtkGXtOG5Pp9P7wB7oPG55UHm8hmo1O/BIjJTMFpgfaB1UvZxOhH97lf0lKOpDVjpFwAvQ9Kl4+7+uZRsZ0+l32k7lh5bKGfSvVLNpDUxsAjjQFxIlkkcOeOjjVbIhGHgdwEEbMbkWx2s1TMLHOG5nWXvmI/xsI+JrH7OsE8edmZ5zp2M/ZiSOQzL/eeH3OCZZli35bL83Pq9l2fwuOlnmYEPl6wkwidPZlvOJ6/BnsUrFEc2Fb2Qj8CNJkeLaaM4t5qOZyybh3m3jiIrMdFBsXKRUsUuwS/WsL+QeecyzWKXZox2LJqB1BiIqyPd7Tnt/4MgfttCcAL7cPm5uZzDJtnPvEsXG7JLk1BimBE52QVMeWzds27oqL2mWgwmw9vfj4/hv/76GDgiw8Q2BkyAxH3PwCq79/Wi7/eFkQY8iz5mKwCeVMlhJh4SZqEOOEpbmlWNyMpl0Jus6SqRMrVfyTCs2sv8/lcOzUwQ371CdP1i0U0saNYMfSGfW3tfMNDBGNfEjF5j8SGPIQ70u3rbO3rnhunU9vqIbZwYkaLTeE+vbCzKKCgmQMqv+liZh6jg4KcdYI5/Ft4w9uQOzJjxmKR2ydL7pzoxWfk7pVBaOv71Tq7lVR9E1vEFDxkXpt8DtdGtux4xezjQeVy7HGf62CKlzp79yPHv6EyAp195z00RnfbRzbaHDUTAbrBgy4geQYUmlX8wFJWB3YwMridzZ3bIE9CPYsXQr+tVuWaFxMHXEwBwZFzwrstI/Oipn9SjLnO5RxxeMhDiMX6F+unMr0MtbVnCBpCULHIse+jG8/+MGzdT1+IpkxQxIN7Px50iRxj19Txfs7Qzot1VnwAXXMnS1F3LJfHo593XIHlxv4JO1g8DLFkUsN+CR+1LWLEG+8w2FPqu6H2455dV7fUXUtwCsP5gCXb/7vn0+i0jru/+GCLUB9p2J1TolMzq+wXLH5q+IPB08c06IVmtfsREEjquQIvGffGQHQjosZZkLe7lgIlx16AjnwkgwC3yYeshGGD3HgLVOaBVwtPeMPdJ6hNyGtaUiCdVW/0aFH44KwvcmYdmMK96DVrnjufBww6n07s9u7D/p1s+p93CzcU6b3cY5dZed0w1mI5ygzqXQpa+NVU01vlZl1H7h1TLLtn5SONIdeMRRWg+WGWSRxiTl5xhVibnOUzqFU/Vc6qCcDdc9TaTUVQ8XMfvebXirGYmTCoJxDzplYOIuDq+Zw6idRe/Reu0oNh8/bnJMg2HuYr9X682fQndjrbe5Zj1aix1alRtmuRC+QRMg5C7nhX6iO50X9qwObOV2+ly30/2Q+/p9Wt29R/3GZbHe/dzL4t6N6zrX3GJW34fxfG9WbJ3d7mi//ml25JdT38YfoVH3Hq3XqfBR7x5cqEsU5y+lxDn9+N5oj9yXcryIAO+gHd+oEn8xgdaB/cOJdPN+NOlet6GhPWkoaE/6daLc3LwTUdYXnaGs44C/+WHv1aT7y7Ox3N7e3t49eJ3svB5vb29n8LvT6Sw0ohadNi4Dmqt7H+ruZbzjl6zS6XQAhTE1dAuHr+Vi/B92fLh8TMdFn/8gz87mfQRTFjhwvlwKlF3/Om/NH8fnX8qBQRjIHJ++SzGIg60ghgf2/ll3EKJlybT5QcbTYOsqcK/G4E/3JgtGrp1peKp/FegoYRmFv7xFCo/74XVwEPpHuUEY4DMCeOkPRBdsuQfGQQghrhz8EEzDHDhu68r3sm+ng9Dp4MFWYIk+CAMX6Ck/ESYiCaHbPB4F137Bm6Yqv1RTafyjfOMO88CD1M+cBodezyQ3fNZM9RmuK7RWk1Gl6DSYzaPwL1F9GNGOK5/apVN/N3ADnpDyeSR2C8KAG5bVV1lyaEp+OqYjJmEn+MToU8fisdDsk9eEcfiG+3MGulcgnzP0TA5PP4scYbBzeiw46zuejm2dX7hJKtvwtpLFXhluV4+EQ4IP9Tq3Uarvj1im4/qaNjQxt+bhssfjtTerOkELmOY5o6qDb7g/O1kE84VoGhWYv1JK48bOSlDLnfWuw+Dy9s1ckki2/ct08n3KRsZGkkkklWDqQf15ylezuf7GxnUYTG/f3vSb3N4jOLzJ7bt7i0/6q3SHvwLW9cfXYZDcDuvPZdLBXwjsxsPr6o51uSxlDttQxtNTL7eub+voLzPoBwlRA7GnYqZqiBhKmTIq5jAxGFmnviTfgaHzXWjfb+Bbca60v8hsjpRiEYO8E3zW5WUVcbqOfUhO3PtdiAXswAfUznQx1NBL+Pm0nXDIfN4VJAraHtwm2qHjm9EogQwv96qEjrxzL4dUJ1loDx74v+F2SRm4tE3CuE3R4GLcNMZq2EEve33vnfrpwBe4XDFZcu9w/w64REuxbbOurH5gd2nnIHuH+5CBw0dO/euQ17rEhEctbXQhoI6RC079K/1Stk9tzJtZd6f0+V5VaKDjcl/aZB6gmOuFEIXwUt+mB5TJoXMTVwl7cESyMBBqcBmSRBuW6wYeEYoSkYeyuAtV3oJJSsYFPjE0wLI+HQdfGVUZNFzYzFM0M+JC+aQhRxbQE9JQKzx5rECn2vwhYULb4ZSMqDZMhZCOCphXBRgV5ZTsMmeKMxGxhShQzKLutFAL9bUmDprpKK9fvXBpmn4PnimHwIF2YhaTIkeqQU4o06T8yc1ufU5RAu5g6nSZYjivemAyk/OA5ExpSOVVRKoxFfyjS+0FjQSMrCFLaGq7OlEBnnKABzi8CYyXtb//8181uJZquvOA2RVoHMMbuFsgREvSEjxo+orlIAFlEyKYj6n/nL0EADpkmtNMxiUj6bvT+D6+mtOlXHShuzJsqIsoAcOilLc69DJWO7VSo2mK9ivG/nLYL7vk2tQSffxz3Hn58IoBHqMaDKiGAFcDzYtpncGrcKacmQ7TkXgzSay8Bud4gRZGniqWcXG3e6rujDOyFASFkRk1PCJ+Kt1ppv7ZiI/n6wxyxi1oQI0XXKoHS1gVpjuVImKnXJyyC6buoODtls+HYjoF4jYTxkQdNo8ke51V6VkTyFdu4KR2O2ESYoMYN0Ogu4ypMTuNwExBwmN3pzqEw4lUXSjnTXFZsCg7QIxUMwM0Lr+tfNg94kAQ9TT0DvlZTgBXIcltRjKY73ZuQCVBiGOb31+fPaICktvQiQMZbSDJyqhaRnmVy43uT0+5A2t5R9aJAzNAdiesEd60Fy82y5fqFDI0/cq4I/ChEJpK5B+TVEI3bkIywKy8BO8bPC9w99oFfKqsnAimfv/H/0C5AIY5oBGUQhiMlrfiMwGaamlT/uqzevL1BN6BYCiaizaGv8iWvdmh4eVDVTCBZUN4S2JfI4DoxYtEVj6NpnH8rVjXLiy/sq2/IeOz1+3+X7at17vfjm290f2GbOvHAKzz4t8ugJbpuwtlh49K3DzgTDLr8UylurknePuvwzKGsgjBFTv0r+1/lTvAy/1bXATWh1CFF5x56zeDaOh3u/DPjBD0tWp8BZWqfE86/bcgvHts4+Yz8NVSbkbWD0n/Z52LLEoAZ0vsqKr7zSRWj9mssenzZPgs4nv8+eD1x0Fvlw/0QLzajJ4OHg7O83dvnj5/0mHT572o/2b6rv/GvH+b6sGZ5NHPz5MP4o0ePt0s3r/7oN6/G6j3b18Z+nZzeygSMXz2E4+mm2fDfpe/ePq8++FtbzJ89lP3w5sn+Qec/Kfuh/PzbpTtPh2KbeiTv3/3X3zvbGf95cedjy8Pdy5ffkyfdOjub2dPL6MnL893HrY/DFT75d7wl7PfTP5qM17ffccfPmYv2Vtx2H0RNaiBi5QLduqP+hT3fQqHbSlpY9GxH8iMWb1mgiVylIT6O06rM2pK6BjUMkCdukcqYErdxi+fBtlNiNjodk97JRI255EwEJhJgqWoDuU5E3/uTuvLG7s8gHqZpZXQCrjthO1BY7P173aTmkWF4mYabB1dBZdtmvO2bd86Ork+AYPCJBLCmbnUCDE1SbAVrM1GN6EiGMbOjq4sD5aMpqmI4ZXOHLPRnK9d9Dq94DqcHbOQOW/oz4r2pw7Rho65GN827qRC0QEcoz2pBqIqHTfnvzBQct051HuFAQfySRgF4xYwD9TxqooJ7/gz9tHaRQHY6ixnQ6o+otoIks7ewwvCnrWo55EPOWIUsQwiBtWGgjLQFwS10B38qAXj4GdpABxV1FxGsryy3UMttb+xgercox7qPeuPUaXYeHh9YpFfc13jg+y6/9W+PWo4Et2npmMtCGYcWQ1v0qwzaaljZ4lfxy05478oAVnkNgBzfaG1brdYs9wWYNJrHk08wssdwON6F/G40UU8Pu42lB63+2qGSnVB/aRUT1AHqasgoGecAN1yMZJI9O6093ImDsAjDDIJmWZOVWVpJLOy4Eyr5Yf8/s9/laNardKMpmWFu71CkVxOmILKgFgZL2WXHLwjWLUwwzaNFj+mItAsZVpDAF4YNrZl/SAxFdzQztEZ0ZwOoboeuFHxuT2+263Jbd0hbxMGT2Gg6Ttl83QvWAqyuvQv1SvzTaQ6H6VyAgXvyBCKUYGHkYmEisg6M60EQaccWNPgKM4V11BjSwHU3MImhVE0MiSjgo7RqxaSOrJilnIQs0TJIfj6tUwL6802lKdS2VeWuCF8BoNI3LnMoQn1beBZxRKg6wvn0tahDSlY4eBq9g0hepMDLBycD0aSQqQSyuuBl6dIU5JLYyMzoNbXYYThRlGhQRe3sPgzKBHmvM1Mu1SE15rBCb/g4twWAWqTo5Ku3rKh5oY1U4RnefNBc8wzbn4uhlBiTGpupJpWo8fcJMUQxXx9kvKHnemZLwtZE+LVHLGM9ALtUUZ6DbKZ1w6YAQrRa9v7A9QSHpDf//Hf5AWjSpBETiy1RoVi6bSqQInFEvHkLdrKSx7jGbSAiosGiVSMfYhNl9UNqUGf0S6bgDfOspR92rRfDFMelaU/dau1RZ7aAp9lTc9mSqNNNIEgEyW5HZ1ycd4h22JqK1mWLjD4juMa28AQ0ZKKmlUdzcPa6izTLL1guub4g/qYGLpTshjb1erAuM01c25gb9txTPKZvBtw+lbgWD8WxsyodWhBDcoFqTqNnJhmtSwmYqyLp7cIKkPV/OFMMg6G0eY++TyeqsSpnaZWZhUw6XZcfrVPzWYUkKa8Ra8hLKgbBU5pzh05HXmyJM3c+08na2vQCkMj1H79BUpzvjAsAlUB9d7oAMrHRt4aW8LRa9h5LQiDlEfMWdfu/tp+tv+CXKx3ukFYU+vuwNxrLwZPd3YPdgAYEKQWYb1Ot9NFJ6DUJqOithKWyS0JdfZqqz3jW1XXXVXXXVXXXVXXXVXXXVXXXVXXXVXXXVXXXVXXXVXXXVXXJavquqvqun/S3lfVdVfVdVfVdVfVdVfVdVfVdVfVdVfVdVfVdf+8+3ZVXXdVXXdVXXdVXXdVXfcbKlq6qq77Z1DgqrruqrruqrruqrruqrruqrruqrruqrruJzuvVtV1V9V1V9V1V9V1V9V1V9V1V9V1/59W160lv63lKeWilu5ts1KPZmrunoRBAlmrW0fB1RUQ3muVXl/D598KzMI7OgmDC6o4PNjChNfQJ2hCtt05g0S9p/b9WfsQlg/tOWOGw0yeL2SY2hHbuPUb+9YTa/f3Dg6DMBi6usCZjLEEAJ1Adh6d2OTFWgoffrsKUirGBab/BXbOa1tCKWkmpJ5jQqr7o5ZDCImbFYTNTFW7Dfg/bGrhgKsrm+x6fV32t01LRzjE+t5wfCfX19f/C0lCHvk=","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":"Resend request mail","permalink":"/docs/API-docs/v1.1/resendrequestmail"},"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),p=t.n(c),h=t(63723),u=t.n(h),m=(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:"eJztPNtyG7eSv4Kd2qrEPEOKpCRftC+rOIpDx5a0lnyVdBRwBuRAmgEmAEYUrVLVeTh/sE/7ej4tX7LVDWAuvEiyrST2LvMQi4Nbo9Hd6Au6rwJDxzrYOgoOWZan1DAdnIRBzHSkeG64FMFWcJgw4pvJj4qODBdjsr0/IEzQYco0KTRTmhhJIsWgU1RoIzP+EVqJ8TOHRDN1AWOpJsO0YLniwmgykoqMmWCK4sSxjIqMQcOEm4TkisVsxAWLiTaqiEyhmO6Q17kURBdRxLQeFaldmUtB5IjQcs2QmIQhqIqZQglNKCkE/61gpNWSwzMWmUHcapHvY6b5WFDDYgDODz/l8YOQTBIeJSSiggwZbDWGnTqAWQ3cIYU2KXBNnbOIjzh0dpN1yHYcc4CRpuk0JJS0WoVKWy3CNcmVvOAxi/1qcjQClFJELeHCMDWiEUNcMZhFjHEZPzmhIiYjGvGUmyYaScy1UXxYwMqdY3EsDnm+RV7nqaQxmcpCkf0ff6q6G0ng21Gr9SMbFmPyetBqnXyfGJPrrbU1mucdmTMB2ErpUHcima3F0DGPR4grphjMivhiVPN0SmgckwmPx8xoPBBBIplPSSSlirmwpJHTMSOiyIZM6RB3k0nFCBeEEsVoPG0b2S40I88P9nYBDRk1HbKfFjosl4u5YpFJp3Z6QI/f1Xf2dB5uAA1xMQ5JRs8BS9yQ3woencO2NRN4tI5kEFet1luAt8QO147GY0JMwjWZsGEi5TlhF9A84WlKjOLjMVOt1rH49ddfj8XVsSDkOMAex8EWOQ7cFMdBaJvMNGe25ce9p69f7uwenh6+398p2z2lzvQZ/Fj2GPF0dobXr16UzYJms8272y+rBYQ0rn0/ZVQzotgFZxM8Bzhqu1ePhXJYTU7Y0WULDGJKw9cj+ELIlf2nCc3B4Nnuzqs6LLYHyyhPG112Xm4PXjT65IkUzWn2f97bbc5TqNosg91nFim2/Rr+OXHwuhPZdgd0OHi5c3C4/XIfOl+7cwRqOCjyXCo4/reWoLfgmI/FDyyVE0IVQ+qJZJZJQXKqaMYMysaEGmxW7LeCKxZb4UbT1HPG1rFok1YLSGGr1SIDEfMIWMOy+TRnINls347tCiwDXQ+cqLFda4wEssiKE+CQCbXcnacgSKCrYiClDL9gzYkvQzKFiX9kQBd22kQq/lEKQ1MkigumDI9oWmdiABBFn6EKRVAuuTD+q1uBvHfMCryMLOqkDIAWA7IyLrBFM3JB04JpB9UkJAlA9YrlimmUuG5eQKSIScL4OFm6Ho3PCm0aE5NCeznqoXBr+VNC9DJE24immhE+auAyo+esthqRuZXvHfLDlMRsRIvUhISD/DGqYB2yKw2heZ7yCO9GEOf24ikUa+MpO3JwgACrABD79n6AGyHmcDeAtIFGnMKN8dABndkLBbaHctQkVBApZg46kqlU8ySEn5t4JJEUhgnTIdsXlKcIvN2sJlxEaREzMkxpdB7izR4SBXcZnMqUpamchJbesQvesIhzxA/RLAUqlALgF9Itz3V1h3bIIcifkp+g0aMaF+G6jlUnw0cSVgYUeBYjKFdCRFxIzuSQGG5SFgLD5lRMQxJbpYFdmqG8DEmUsOgc/1I05pIMC2OksBuLlcxjOREOlyMpjOYfF3Ckb/l0jPZDshGShyF5HJJeNyS9fkh6GyHpPQxJ73FI+t2Q9Psh6W+EpP/QgtV/7HBNSwTXAej1LZbNt4NdkLsvuEbOBoGpSxk8acjgXoe0WiU3zV6/1R1bdilvK5CZ0NZzvy/hx3r/kfs5hZ8P+4/dzwl27W24nwn87Pfq90QfITE0y2+AAprvFQKvLFgigm/uzj0OvDyDjyCIQt9QXcUOHmi4ru9lHfbCBTecpnr5dnyPr2hHFUhzm9qATSG5Lt+R00G+mu3U4UGVBcSkbUKxWmvyDI9Q9Od2v9lxN8vyzdtlv5q918D5sq0/hK2DaDoE0bR8/6X0+oqQMAvTl2HiUQcVAJTMy/HgOnxFWGhC9GU4eAw4gEtpOQKg9SvafQ0ca4DhDW/buhvt3ma73+1vNDAAlrLtkGXtOG5Pp9P7wB7oPG55UHm8hmo1O/BIjJTMFpgfaB1UvZxOhH97lf0lKOpDVjpFwAvQ9Kl4+7+uZRsZ0+l32k7lh5bKGfSvVLNpDUxsAjjQFxIlkkcOeOjjVbIhGHgdwEEbMbkWx2s1TMLHOG5nWXvmI/xsI+JrH7OsE8edmZ5zp2M/ZiSOQzL/eeH3OCZZli35bL83Pq9l2fwuOlnmYEPl6wkwidPZlvOJ6/BnsUrFEc2Fb2Qj8CNJkeLaaM4t5qOZyybh3m3jiIrMdFBsXKRUsUuwS/WsL+QeecyzWKXZox2LJqB1BiIqyPd7Tnt/4MgfttCcAL7cPm5uZzDJtnPvEsXG7JLk1BimBE52QVMeWzds27oqL2mWgwmw9vfj4/hv/76GDgiw8Q2BkyAxH3PwCq79/Wi7/eFkQY8iz5mKwCeVMlhJh4SZqEOOEpbmlWNyMpl0Jus6SqRMrVfyTCs2sv8/lcOzUwQ371CdP1i0U0saNYMfSGfW3tfMNDBGNfEjF5j8SGPIQ70u3rbO3rnhunU9vqIbZwYkaLTeE+vbCzKKCgmQMqv+liZh6jg4KcdYI5/Ft4w9uQOzJjxmKR2ydL7pzoxWfk7pVBaOv71Tq7lVR9E1vEFDxkXpt8DtdGtux4xezjQeVy7HGf62CKlzp79yPHv6EyAp195z00RnfbRzbaHDUTAbrBgy4geQYUmlX8wFJWB3YwMridzZ3bIE9CPYsXQr+tVuWaFxMHXEwBwZFzwrstI/Oipn9SjLnO5RxxeMhDiMX6F+unMr0MtbVnCBpCULHIse+jG8/+MGzdT1+IpkxQxIN7Px50iRxj19Txfs7Qzot1VnwAXXMnS1F3LJfHo593XIHlxv4JO1g8DLFkUsN+CR+1LWLEG+8w2FPqu6H2455dV7fUXUtwCsP5gCXb/7vn0+i0jru/+GCLUB9p2J1TolMzq+wXLH5q+IPB08c06IVmtfsREEjquQIvGffGQHQjosZZkLe7lgIlx16AjnwkgwC3yYeshGGD3HgLVOaBVwtPeMPdJ6hNyGtaUiCdVW/0aFH44KwvcmYdmMK96DVrnjufBww6n07s9u7D/p1s+p93CzcU6b3cY5dZed0w1mI5ygzqXQpa+NVU01vlZl1H7h1TLLtn5SONIdeMRRWg+WGWSRxiTl5xhVibnOUzqFU/Vc6qCcDdc9TaTUVQ8XMfvebXirGYmTCoJxDzplYOIuDq+Zw6idRe/Reu0oNh8/bnJMg2HuYr9X682fQndjrbe5Zj1aix1alRtmuRC+QRMg5C7nhX6iO50X9qwObOV2+ly30/2Q+/p9Wt29R/3GZbHe/dzL4t6N6zrX3GJW34fxfG9WbJ3d7mi//ml25JdT38YfoVH3Hq3XqfBR7x5cqEsU5y+lxDn9+N5oj9yXcryIAO+gHd+oEn8xgdaB/cOJdPN+NOlet6GhPWkoaE/6daLc3LwTUdYXnaGs44C/+WHv1aT7y7Ox3N7e3t49eJ3svB5vb29n8LvT6Sw0ohadNi4Dmqt7H+ruZbzjl6zS6XQAhTE1dAuHr+Vi/B92fLh8TMdFn/8gz87mfQRTFjhwvlwKlF3/Om/NH8fnX8qBQRjIHJ++SzGIg60ghgf2/ll3EKJlybT5QcbTYOsqcK/G4E/3JgtGrp1peKp/FegoYRmFv7xFCo/74XVwEPpHuUEY4DMCeOkPRBdsuQfGQQghrhz8EEzDHDhu68r3sm+ng9Dp4MFWYIk+CAMX6Ck/ESYiCaHbPB4F137Bm6Yqv1RTafyjfOMO88CD1M+cBodezyQ3fNZM9RmuK7RWk1Gl6DSYzaPwL1F9GNGOK5/apVN/N3ADnpDyeSR2C8KAG5bVV1lyaEp+OqYjJmEn+MToU8fisdDsk9eEcfiG+3MGulcgnzP0TA5PP4scYbBzeiw46zuejm2dX7hJKtvwtpLFXhluV4+EQ4IP9Tq3Uarvj1im4/qaNjQxt+bhssfjtTerOkELmOY5o6qDb7g/O1kE84VoGhWYv1JK48bOSlDLnfWuw+Dy9s1ckki2/ct08n3KRsZGkkkklWDqQf15ylezuf7GxnUYTG/f3vSb3N4jOLzJ7bt7i0/6q3SHvwLW9cfXYZDcDuvPZdLBXwjsxsPr6o51uSxlDttQxtNTL7eub+voLzPoBwlRA7GnYqZqiBhKmTIq5jAxGFmnviTfgaHzXWjfb+Bbca60v8hsjpRiEYO8E3zW5WUVcbqOfUhO3PtdiAXswAfUznQx1NBL+Pm0nXDIfN4VJAraHtwm2qHjm9EogQwv96qEjrxzL4dUJ1loDx74v+F2SRm4tE3CuE3R4GLcNMZq2EEve33vnfrpwBe4XDFZcu9w/w64REuxbbOurH5gd2nnIHuH+5CBw0dO/euQ17rEhEctbXQhoI6RC079K/1Stk9tzJtZd6f0+V5VaKDjcl/aZB6gmOuFEIXwUt+mB5TJoXMTVwl7cESyMBBqcBmSRBuW6wYeEYoSkYeyuAtV3oJJSsYFPjE0wLI+HQdfGVUZNFzYzFM0M+JC+aQhRxbQE9JQKzx5rECn2vwhYULb4ZSMqDZMhZCOCphXBRgV5ZTsMmeKMxGxhShQzKLutFAL9bUmDprpKK9fvXBpmn4PnimHwIF2YhaTIkeqQU4o06T8yc1ufU5RAu5g6nSZYjivemAyk/OA5ExpSOVVRKoxFfyjS+0FjQSMrCFLaGq7OlEBnnKABzi8CYyXtb//8181uJZquvOA2RVoHMMbuFsgREvSEjxo+orlIAFlEyKYj6n/nL0EADpkmtNMxiUj6bvT+D6+mtOlXHShuzJsqIsoAcOilLc69DJWO7VSo2mK9ivG/nLYL7vk2tQSffxz3Hn58IoBHqMaDKiGAFcDzYtpncGrcKacmQ7TkXgzSay8Bud4gRZGniqWcXG3e6rujDOyFASFkRk1PCJ+Kt1ppv7ZiI/n6wxyxi1oQI0XXKoHS1gVpjuVImKnXJyyC6buoODtls+HYjoF4jYTxkQdNo8ke51V6VkTyFdu4KR2O2ESYoMYN0Ogu4ypMTuNwExBwmN3pzqEw4lUXSjnTXFZsCg7QIxUMwM0Lr+tfNg94kAQ9TT0DvlZTgBXIcltRjKY73ZuQCVBiGOb31+fPaICktvQiQMZbSDJyqhaRnmVy43uT0+5A2t5R9aJAzNAdiesEd60Fy82y5fqFDI0/cq4I/ChEJpK5B+TVEI3bkIywKy8BO8bPC9w99oFfKqsnAimfv/H/0C5AIY5oBGUQhiMlrfiMwGaamlT/uqzevL1BN6BYCiaizaGv8iWvdmh4eVDVTCBZUN4S2JfI4DoxYtEVj6NpnH8rVjXLiy/sq2/IeOz1+3+X7at17vfjm290f2GbOvHAKzz4t8ugJbpuwtlh49K3DzgTDLr8UylurknePuvwzKGsgjBFTv0r+1/lTvAy/1bXATWh1CFF5x56zeDaOh3u/DPjBD0tWp8BZWqfE86/bcgvHts4+Yz8NVSbkbWD0n/Z52LLEoAZ0vsqKr7zSRWj9mssenzZPgs4nv8+eD1x0Fvlw/0QLzajJ4OHg7O83dvnj5/0mHT572o/2b6rv/GvH+b6sGZ5NHPz5MP4o0ePt0s3r/7oN6/G6j3b18Z+nZzeygSMXz2E4+mm2fDfpe/ePq8++FtbzJ89lP3w5sn+Qec/Kfuh/PzbpTtPh2KbeiTv3/3X3zvbGf95cedjy8Pdy5ffkyfdOjub2dPL6MnL893HrY/DFT75d7wl7PfTP5qM17ffccfPmYv2Vtx2H0RNaiBi5QLduqP+hT3fQqHbSlpY9GxH8iMWb1mgiVylIT6O06rM2pK6BjUMkCdukcqYErdxi+fBtlNiNjodk97JRI255EwEJhJgqWoDuU5E3/uTuvLG7s8gHqZpZXQCrjthO1BY7P173aTmkWF4mYabB1dBZdtmvO2bd86Ork+AYPCJBLCmbnUCDE1SbAVrM1GN6EiGMbOjq4sD5aMpqmI4ZXOHLPRnK9d9Dq94DqcHbOQOW/oz4r2pw7Rho65GN827qRC0QEcoz2pBqIqHTfnvzBQct051HuFAQfySRgF4xYwD9TxqooJ7/gz9tHaRQHY6ixnQ6o+otoIks7ewwvCnrWo55EPOWIUsQwiBtWGgjLQFwS10B38qAXj4GdpABxV1FxGsryy3UMttb+xgercox7qPeuPUaXYeHh9YpFfc13jg+y6/9W+PWo4Et2npmMtCGYcWQ1v0qwzaaljZ4lfxy05478oAVnkNgBzfaG1brdYs9wWYNJrHk08wssdwON6F/G40UU8Pu42lB63+2qGSnVB/aRUT1AHqasgoGecAN1yMZJI9O6093ImDsAjDDIJmWZOVWVpJLOy4Eyr5Yf8/s9/laNardKMpmWFu71CkVxOmILKgFgZL2WXHLwjWLUwwzaNFj+mItAsZVpDAF4YNrZl/SAxFdzQztEZ0ZwOoboeuFHxuT2+263Jbd0hbxMGT2Gg6Ttl83QvWAqyuvQv1SvzTaQ6H6VyAgXvyBCKUYGHkYmEisg6M60EQaccWNPgKM4V11BjSwHU3MImhVE0MiSjgo7RqxaSOrJilnIQs0TJIfj6tUwL6802lKdS2VeWuCF8BoNI3LnMoQn1beBZxRKg6wvn0tahDSlY4eBq9g0hepMDLBycD0aSQqQSyuuBl6dIU5JLYyMzoNbXYYThRlGhQRe3sPgzKBHmvM1Mu1SE15rBCb/g4twWAWqTo5Ku3rKh5oY1U4RnefNBc8wzbn4uhlBiTGpupJpWo8fcJMUQxXx9kvKHnemZLwtZE+LVHLGM9ALtUUZ6DbKZ1w6YAQrRa9v7A9QSHpDf//Hf5AWjSpBETiy1RoVi6bSqQInFEvHkLdrKSx7jGbSAiosGiVSMfYhNl9UNqUGf0S6bgDfOspR92rRfDFMelaU/dau1RZ7aAp9lTc9mSqNNNIEgEyW5HZ1ycd4h22JqK1mWLjD4juMa28AQ0ZKKmlUdzcPa6izTLL1guub4g/qYGLpTshjb1erAuM01c25gb9txTPKZvBtw+lbgWD8WxsyodWhBDcoFqTqNnJhmtSwmYqyLp7cIKkPV/OFMMg6G0eY++TyeqsSpnaZWZhUw6XZcfrVPzWYUkKa8Ra8hLKgbBU5pzh05HXmyJM3c+08na2vQCkMj1H79BUpzvjAsAlUB9d7oAMrHRt4aW8LRa9h5LQiDlEfMWdfu/tp+tv+CXKx3ukFYU+vuwNxrLwZPd3YPdgAYEKQWYb1Ot9NFJ6DUJqOithKWyS0JdfZqqz3jW1XXXVXXXVXXXVXXXVXXXVXXXVXXXVXXXVXXXVXXXVXXXVXXJavquqvqun/S3lfVdVfVdVfVdVfVdVfVdVfVdVfVdVfVdVfVdf+8+3ZVXXdVXXdVXXdVXXdVXfcbKlq6qq77Z1DgqrruqrruqrruqrruqrruqrruqrruqrruJzuvVtV1V9V1V9V1V9V1V9V1V9V1V9V1/59W160lv63lKeWilu5ts1KPZmrunoRBAlmrW0fB1RUQ3muVXl/D598KzMI7OgmDC6o4PNjChNfQJ2hCtt05g0S9p/b9WfsQlg/tOWOGw0yeL2SY2hHbuPUb+9YTa/f3Dg6DMBi6usCZjLEEAJ1Adh6d2OTFWgoffrsKUirGBab/BXbOa1tCKWkmpJ5jQqr7o5ZDCImbFYTNTFW7Dfg/bGrhgKsrm+x6fV32t01LRzjE+t5wfCfX19f/C0lCHvk=",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,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)(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:"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.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.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)(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 final PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\n\nfalse - If you choose not to merge, the completion certificate will be provided as a separate 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"},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",description:"Allowed values - signature, stamp.",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 j(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/c4fbe420.8c4aab4f.js b/assets/js/c4fbe420.8c4aab4f.js deleted file mode 100644 index fbcb3be78..000000000 --- a/assets/js/c4fbe420.8c4aab4f.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:()=>y,contentTitle:()=>g,default:()=>j,frontMatter:()=>x,metadata:()=>i,toc:()=>f});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":"eJztPNl2G7eSv4LpM+ck5m1SJCV50byM4iiOHGsZS14lXQXsLrIhdQNtAC2K1tE59+H+wTzN6/20fMmcwtILF0m2FceeYR5isbEVClWFWlB1FWg6UsHGUXAIWZ5SDSo4CYMYVCRZrpngwUZwmADxzeRnSYea8RHZ3N8mwOkgBUUKBVIRLUgkATtFhdIiYx+xlWg/c0gUyAscSxUZpAXkknGtyFBIMgIOkpqJYxEVGWDDmOmE5BJiGDIOMVFaFpEuJKgOeZULTlQRRaDUsEjtykxwIoaElmuGRCdgQJWgC8kVoaTg7EMBpNUSgzOI9HbcapEfY1BsxKmGGIHzw09Z/CAk44RFCYkoJwPArca4Uwcw1MAdUGwT3KypcojYkGFnN1mHbMYxQxhpmk5CQkmrVci01SJMkVyKCxZD7FcTwyGilBrUEsY1yCGNwOAKcBY+Msv4yQnlMRnSiKVMN9FIYqa0ZIMCV+4c82N+yPIN8ipPBY3JRBSS7P/8S9VdC4Lfjlqtn2FQjMir7Vbr5MdE61xtrKzQPO+IHDhiK6UD1YlEthJjxzweGlyBBJzV4AuoYumE0DgmYxaPQCtzIJxEIp+QSAgZM25JI6cjILzIBiBVaHaTCQmEcUKJBBpP2lq0CwXk+cHeLqIho7pD9tNCheVyMZMQ6XRip0f0+F39YE/n4RrSEOOjkGT0HLHENPlQsOgct62Am6N1JGNw1Wq9QXhL7DDlaDwmRCdMkTEMEiHOCVxg85ilKdGSjUYgW61j/vvvvx/zq2NOyHFgehwHG+Q4cFMcB6Ft0pMcbMvPe09f7WztHp4evtvfKts9pU712f657DFk6fQMr16+KJs5zaabdzd3qgW40K59PwWqgEi4YDA254BHbffqsVAOq8kJO7pswUEgFX49wi+EXNl/mtAcbD/b3XpZh8X2gIyytNFla2dz+0WjT54I3pxm/9e93eY8hazNsr37zCLFtl/jPycOXncim+6ADrd3tg4ON3f2sfO1O0ekhoMiz4XE439jCXoDj/mY/wSpGBMqwVBPJLJMcJJTSTPQRjYmVJtmCR8KJiG2wo2mqeeMjWPeJq0WksJGq0W2ecwiZA3L5pMcULLZvh3bFVkGux44UWO71hgJZZEVJ8ghY2q5O09RkGBXCSilNLuA5sSXIZngxD8D0oWdNhGSfRRc09QQxQVIzSKa1pkYATSiT1NpRFAuGNf+q1uBvHPMirxsWNRJGQQtRmRljJsWBeSCpgUoB9U4JAlC9RJyCcpIXDcvIpLHJAE2ShauR+OzQunGxKRQXo56KNxa/pQMesGgbUhTBYQNG7jM6DnUViMit/K9Q36akBiGtEh1SBjKHy0L6JBdoQnN85RF5m5EcW4vnkJC25yyIwcHCLIKArFv7we8EWKGdwNKG2w0U7gxHjqkM3uh4PaMHNUJ5UTwqYOORCrkLAmZz008kkhwDVx3yOYFZakB3m5WEcajtIiBDFIanYfmZg+JxLsMT2UCaSrGoaV308XcsAbnBj9EQYpUKDjCz4VbnqnqDu2QQ5Q/JT9ho0e1WYSpOladDB8KXBlR4FmMGLkSGsSF5EwMiGY6hRAZNqd8EpLYKg1wqQfiMiRRAtG5+UvSmAkyKLQW3G4sliKPxZg7XA4F14p9nMORvuXTMdoPyVpIHobkcUh63ZD0+iHprYWk9zAkvcch6XdD0u+HpL8Wkv5DC1b/scM1LRFcB6DXt1jW3w92Ue6+YMpwNgpMVcrgcUMG9zqk1Sq5afr6re7Yskt5W6HMxLae+32JP1b7j9zPCf582H/sfo5N196a+5ngz36vfk/0DSSaZvkNUGDzvULglQVLRPjN3bnHgZdn+BEFUegbqqvYwYMN1/W9rOJeGGea0VQt3o7v8Q3tqAJpZlNruClDrot35HSQb2Y7dXiMyoJi0jYZsVpr8gxvoOjP7H69426WxZu3y34ze6+B82Vbf4hbR9F0iKJp8f5L6fUNIWEapi/DxKOOUQCMZF6MB9fhG8JCE6Ivw8FjxAFeSosRgK3f0O5r4FgDzNzwtq271u6tt/vd/loDA2gp2w5Z1o7j9mQyuQ/soc7jlkeVx2uoVrNDj8RQimyO+WGsg6qX04nM315l30FFfQClUwS9AE2firf/61q2FjGd/KDsVH5oqZxh/0o1m9TANE0Ih/GFRIlgkQMe+3iVbIAGXgdx0DaYXInjlRom8WMct7OsPfURf7YN4msfs6wTx52pnjOnYz9mJI5DMvt57vc4JlmWLfhsvzc+r2TZ7C46WeZgM8rXE2QSp7Mt5hPX4WuxSsURzYVvZCP0IwmemrWNOTefj6Yum4R5t40jKjLVQcKoSKmES7RL1bQv5B55zLNYpdkbO9aYgNYZaFBBftxz2vsDR/64heYE+OX2cTM7w0k2nXuXSBjBJcmp1iC5meyCpiy2bti2dVVe0ixHE2Dl78fH8d/+fcU4INDG1wRPgsRsxNAruPL3o832+5M5PYo8BxmhTyoFXEmFBHTUIUcJpHnlmByPx53xqooSIVLrlTxTEob2/6dicHZqwM07VOUP5u3UkkbN4EfSmbb3FegGxqgifuQck9/QmOGhXtfcts7eueG6dT2+oRtnCiRstN4T69sLMmoUEiRlqP4WOgF5HJyUY6yRD/EtY0/uwKwJiyGlA0hnm+7MaOXnlE5E4fjbO7WaW3UUXcMbNmSMl34Ls51uze2Y0cupxuPK5TjF3xYhde70V45nT38CJGXKe26a6KyPdq4t43DkYIMVAyB+ABmUVPrFXFACdjc2sJLInd0tS2A/YjqWbkW/2i0rNA6mjhicI2OcZUVW+keH5aweZZnTPer4wpEYh/Er1E93ZgV6ecsKLpC0YIFj3jN+DO//uEEzdT2+IVkxBdLNbPw5UqRxT9/TBXs7A/pt1RlwzrWMXe2FXDKfWsx9HbKH1xv6ZO0g9LJFEeQaPXJfypolyHe+oYzPqu6HW0x59V7fEPXNAetPpkDX775vn88i0vruvyNCbYB9Z2K1TsmMjm6w3E3zN0SeDp4ZJ0SrtS9hiIHjKqRI/Ccf2cGQDqSQubCXCybiVWcc4YxrgWaBD1MPYGii5yZgrRJaBRztPWOPtB4ht2FtIUlCldW/jcKPR4Xhe51ANuWK96BV7njGPdx4Kr37sxv7T7r1c+o9XG+c03q3cU7dRed0g9mIJ6hywVXpa4OqqcbXsozaz71aptnWT4pHuoWPOErrwTKDKNKYpOzcRFVipvKUTvBUPZc6KKfDdU8TIVTVw0XMfnQb3mhG4oTEYNyDThmYuIvDa+owamfRe7RaO4r1x4+bHNNgmLvY79V6s6fQXVvpra9Yj9Z8h1blhlkshG/QBAi5y3kZP9Gdzsv0rA5s6Xb6XLfT/ZD76n1a3b1H/cZlsdr93Mvi3o3rOtfcYlbfh/F8b1Zsnd3uaL9+NTvyy6lv7c/QqHuPVutU+Kh3Dy7UBYrzl1LijH58b7RH7ks5nkeAd9COb1SJv5hA68D+6US6fj+adK/b0NCeNBS0J/06Ua6v34ko64tOUdZxwF7/tPdy3P3t2Uhsbm5u7h68SrZejTY3NzP83el05hpR807bLIOaq3sf6u5lc8cvWKXT6SAKY6rphhm+kvPRf9jx4eIxHRd9/pM8O+v3EUyZ48D5cilQdv3rvDV/Hp9/KQcGYSBy8/Rd8O042AhifGDvn3UHobEsQemfRDwJNq4C92oM/3RvsnDkypnCp/pXgYoSyCj+5S1SfNyPr4OD0D/KDcLAPCPAl/5IdMGGe2AchBjiytEPAQrnMOM2rnwv+3Y6CJ0OHmwEluiDMHCBnvITAR4JDN3m8TC49gveNFX5pZpKmT/KN+44Dz5I/cxpzNDrqeSGz5qpPsN1hdZqMiolnQTTeRT+JaoPI9px5VO7dOLvBqbRE1I+jzTdgjBgGrL6KgsOTYpPx3QEAndinhh96lhzLDT75DVxnHnD/TkD3SuQzxl6Jgann0WOONg5Peac9R1Px7bOLtwklU18WwmxV4bb1SPhkJiHep3bKNX3N1imo/qaNjQxs+bhosfjtTerKjEWMM1zoLJj3nB/drKIyReiaVSY/JVSGjd2VoJa7qx3HQaXt2/mkkSi7V+mkx9TGGobSSaRkBzkg/rzlG9mc/21teswmNy+vcl3ub1HeHjj23f3xjzpr9Id/gpYVx9fh0FyO6y/lkkHfyGwaw+vqzvW5bKUOWwDEU9Ovdy6vq2jv8ywHyZEbfM9GYOsIWIgRAqUz2Bie2id+oL8gIbOD6F9v2HeijOp/EVmc6QkRIB5J+ZZl5dVxOk69iE5ce93MRawhR+MdqaKgcJe3M+n7IQD8HlXmChoezCbaGcc30CjBDO83KsSOvTOvRxTnUShPHjo/8bbJQV0aesEmE3RYHzUNMZq2DFe9vreO/XTwS94uZpkyb3D/Tvg0liKbZt1ZfUDu0s7B9k73McMHDZ06l+HvFIlJjxqaaMLQXWMXDDqX+mXsn1iY95g3Z3C53tVoYGOy31pk1mAYqbmQhTiS32bHlAmh85MXCXs4RGJQmOowWVIEqUhVw08GihKRB6K4i5UeQsmKRkV5omhRpb16TjmlVGVQcO4zTw1ZkZcSJ805MgCe2IaaoUnjxXsVJs/JMCVHU7JkCoNMsR0VMS8LNCoKKeEyxwkAx7BXBRIsKg7LeRcfa2Jg2Y6yquXL1yapt+DZ8oBcqCdGGJS5IZqDCeUaVL+5Ka3PqMoIXeAPF2kGM6qHiaZyXlAcpAKU3klEXJEOfvoUntRI0EjawAJTW1XJyrQU47wIIc3gfGy9o9//qsG10JNdxYwuwKNY3wDdwuExpK0BI+avoQcJaBoQoTzgfzP6UsAoTNMc5qJuGQkdXca3zev5lQpF13orgwbqiJK0LAo5a0KvYxVTq1UxjQ19quJ/eW4X7hkStcSffxz3Fn58BIQj1ENBqOGIFcjzfNJncGrcKaYms6kI7Fmklh5Dc7wAi20OJWQMX63e6rujNOiFASFFhnVLCJ+KtVppv7ZiI/n6wxzxi1oSI0XTMgHC1gVpzsVPIJTxk/hAuQdFLzd8vlQTCdI3HoMwOuweSTZ66xKzxpjvnIDJ7XbySQh1qFcR/PAxmzn2S43G7CeHqoEecgG+HbARp+R1YzgEJUN2zSGvhdryoVhl7bUd2Rs9Lrd/8u21Gr3+7Gl1rrfkS31GIF1XtvbBdAi/Wau7PBe6JsHnAmwHq5UyJt7onf3Oix95vMQXLFD/9r+V5l/Xu7fYhJam7FyJztzxm/GoKHf7eI/U0LQ1ybxFTOqci3p5N+C8O6+7JvPwFfHuBlZPyX9X1XOsyhBnC3Qm6vuN5NY3Ue/ApPnyeBZxPbY8+1XH7d7u2xbbfOX69HT7Yfb5/nb10+fP+nA5Hkv6r+evO2/1u/epGr7TLDo1+fJe/5aDZ6uF+/evpfv3m7Ld29eavpmfXPAEz549guLJutng36XvXj6vPv+TW88ePZL9/3rJ/l7M/kv3ffn590o23064JvYJ3/39r/Y3tnW6s7HrY87h1uXOx/TJx26++Hs6WX0ZOd862H7/bZs7+wNfjv7oPOX6/Hq7lv28DHswBt+2H0RNaiB8ZRxOPVHfWr2fYqHbSlpbd6xH4gMdGL0RVMSRQqst5LbuiJaTggdUcYJok7eIxWAlLfxy6dBdhMi1rrd016JhPVZJGxzkzlgSg8dinPgX3en9eW1XR5BvczSSmgFzHYy7UFjs/XvdpMKokIyPQk2jq6CyzbNWdu2bxydXJ+EASJWYPgqF8pATHUSbAQr09EsrABlYiVHV5YHS0ZTlMf4KmOG2WjOVi56nV5wHU6PmcucN/SHov2pQ5SmI8ZHt407qVB0gMdoT6qBqErHzdlvgEquO4d6rzBgSD4JUDRmEPNIHS+rGOCWP2MfnZsXcKvOcjqE5iNojaDY9D08J8xVi3Id+RCTiRqVQaOg2lBQBnaCoBaqwR+14Av+LA2Ao4qay8iFV7Z7Rkvtr60Zde5Rz+g9q4+NSrH28PrEIr/mqjQPcOv+NvvWpOE4cp+ajpQgmHJcNLwH086DhYb8AjveLTllr5aAzDMT1xvW2Rxsee2iiSt8jYG4Wu0aXK11Da4edxuKjdthNUOlnhgdpFRBjJ5RVzNQlzhB2mR8KAxhuxPdy4EfoJcP5Y5hjBl1FNJIZGURkVbLD/njn/8qR7VapTOAllXL9gpJcjEGidXeTLWzFC4ZWrymEl1m2pSJn5rn5TRLQSkMqnINI1uqDZMN0bXonFcRzekAK6aha8w8oTZvMWuyWXXImwTweQM2/SBt7uUFpCiPS59BvdraWMjzYSrGWMSMDLDAEHqNgCeUR9ZBZaWEcbSgxYzOv1wyhXWTJELNLGyCa0kjTTLK6ch4SkJSR1YMKUNRSqQYoP9WibSwHkpNWSqkfTlnNmSeNhgkbl3m2GR0auRLCQnS7oVzU6rQuomtAHB12Abokc8RFhaB8dYUPBVYMg09+0Waklxo621H1b0OIw7XknKF+raFxZ9BiTDnQQTlnpe/UoAn/ILxc1vYpU2OSrp6AwPFNDTTPqf570FzzDOmfy0GWDZKKKaFnFSjR0wnxcCI8vok5Q870zNf6q8mqKs5YhGpORqiiNQKZqiuHIBGClErm/vbRhN4QP74x3+TF0AlJ4kYW2qNCgnppKoqaArgmZO3aCsvcuOjpgVW0dOGSPnIh01UWbGO6j/+8T+K7MIYfXWWpexzlf1ikLKoLOeoWq0N8tQWbSzrNDbT1GzyAAYOKMnt6JTx8w7Z5BNbndDEV5AY8LsZ19iGcfsvqJJY1UY8rK0OmYL0AowPFSsVDcDUPDThGCmKkV2tDozbXDOPAve2Gcckn8qlQEdeBY71VZk4CLVOK6wrOCf9opHn0KyABDw2tc7UBjEKTzV/OJVgYUIjM598bkZVttJOUyudiZh0Oy6/2udDU0pGU95KGILEBVWjaCXNmSOnI0+WpJlP/elkbY1WrmlkNFx/SdKczXV1Y6U3tTc8wJKgkbe4FnD0ium8EoRByiJwFrS7vzaf7b8gF6udbhDWVLc7MPfKi+2nW7sHWwgMClKLsF6n2+kaR59QOqO8tpIpfVoS6vTVVnuatayYuqyYuqyYuqyYuqyYuqyYuqyYuqyYuqyYuqyYuqyYuqyYSpYVU5cVU7/S3pcVU5cVU5cVU5cVU5cVU5cVU5cVU5cVU5cVU7/efbusmLqsmLqsmLqsmLqsmPodFaJcVkz9GhS4rJi6rJi6rJi6rJi6rJi6rJi6rJi6rJj6yc6rZcXUZcXUZcXUZcXUZcXUZcXUZcXU/6cVU2vJbyt5ShmvpXTbzNOjqTqqJ2GQYGbqxlFwdYWE90qm19f4+UNhMu2OTsLggkqGD7ZMUmvokzAx2+4cMH/xqX1/1j7E5UN7zibDYSqXF7NI7YhNs/Ub+9aTZ/f3Dg6DMBi4Wq+ZiE2aPx1jdh4d2wTFWgqf+XYVpJSPCpP+F9g5r21ZnKSZdHpukk7dH7UcQkzOrCBsZqPabeD/cVNzB1xd2YTW6+uyv21aOMIh1vfG4zu5vr7+X8+xVkg=","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":"Resend request mail","permalink":"/docs/API-docs/v1.1/resendrequestmail"},"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),p=t.n(c),h=t(63723),m=t.n(h),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:"eJztPNl2G7eSv4LpM+ck5m1SJCV50byM4iiOHGsZS14lXQXsLrIhdQNtAC2K1tE59+H+wTzN6/20fMmcwtILF0m2FceeYR5isbEVClWFWlB1FWg6UsHGUXAIWZ5SDSo4CYMYVCRZrpngwUZwmADxzeRnSYea8RHZ3N8mwOkgBUUKBVIRLUgkATtFhdIiYx+xlWg/c0gUyAscSxUZpAXkknGtyFBIMgIOkpqJYxEVGWDDmOmE5BJiGDIOMVFaFpEuJKgOeZULTlQRRaDUsEjtykxwIoaElmuGRCdgQJWgC8kVoaTg7EMBpNUSgzOI9HbcapEfY1BsxKmGGIHzw09Z/CAk44RFCYkoJwPArca4Uwcw1MAdUGwT3KypcojYkGFnN1mHbMYxQxhpmk5CQkmrVci01SJMkVyKCxZD7FcTwyGilBrUEsY1yCGNwOAKcBY+Msv4yQnlMRnSiKVMN9FIYqa0ZIMCV+4c82N+yPIN8ipPBY3JRBSS7P/8S9VdC4Lfjlqtn2FQjMir7Vbr5MdE61xtrKzQPO+IHDhiK6UD1YlEthJjxzweGlyBBJzV4AuoYumE0DgmYxaPQCtzIJxEIp+QSAgZM25JI6cjILzIBiBVaHaTCQmEcUKJBBpP2lq0CwXk+cHeLqIho7pD9tNCheVyMZMQ6XRip0f0+F39YE/n4RrSEOOjkGT0HLHENPlQsOgct62Am6N1JGNw1Wq9QXhL7DDlaDwmRCdMkTEMEiHOCVxg85ilKdGSjUYgW61j/vvvvx/zq2NOyHFgehwHG+Q4cFMcB6Ft0pMcbMvPe09f7WztHp4evtvfKts9pU712f657DFk6fQMr16+KJs5zaabdzd3qgW40K59PwWqgEi4YDA254BHbffqsVAOq8kJO7pswUEgFX49wi+EXNl/mtAcbD/b3XpZh8X2gIyytNFla2dz+0WjT54I3pxm/9e93eY8hazNsr37zCLFtl/jPycOXncim+6ADrd3tg4ON3f2sfO1O0ekhoMiz4XE439jCXoDj/mY/wSpGBMqwVBPJLJMcJJTSTPQRjYmVJtmCR8KJiG2wo2mqeeMjWPeJq0WksJGq0W2ecwiZA3L5pMcULLZvh3bFVkGux44UWO71hgJZZEVJ8ghY2q5O09RkGBXCSilNLuA5sSXIZngxD8D0oWdNhGSfRRc09QQxQVIzSKa1pkYATSiT1NpRFAuGNf+q1uBvHPMirxsWNRJGQQtRmRljJsWBeSCpgUoB9U4JAlC9RJyCcpIXDcvIpLHJAE2ShauR+OzQunGxKRQXo56KNxa/pQMesGgbUhTBYQNG7jM6DnUViMit/K9Q36akBiGtEh1SBjKHy0L6JBdoQnN85RF5m5EcW4vnkJC25yyIwcHCLIKArFv7we8EWKGdwNKG2w0U7gxHjqkM3uh4PaMHNUJ5UTwqYOORCrkLAmZz008kkhwDVx3yOYFZakB3m5WEcajtIiBDFIanYfmZg+JxLsMT2UCaSrGoaV308XcsAbnBj9EQYpUKDjCz4VbnqnqDu2QQ5Q/JT9ho0e1WYSpOladDB8KXBlR4FmMGLkSGsSF5EwMiGY6hRAZNqd8EpLYKg1wqQfiMiRRAtG5+UvSmAkyKLQW3G4sliKPxZg7XA4F14p9nMORvuXTMdoPyVpIHobkcUh63ZD0+iHprYWk9zAkvcch6XdD0u+HpL8Wkv5DC1b/scM1LRFcB6DXt1jW3w92Ue6+YMpwNgpMVcrgcUMG9zqk1Sq5afr6re7Yskt5W6HMxLae+32JP1b7j9zPCf582H/sfo5N196a+5ngz36vfk/0DSSaZvkNUGDzvULglQVLRPjN3bnHgZdn+BEFUegbqqvYwYMN1/W9rOJeGGea0VQt3o7v8Q3tqAJpZlNruClDrot35HSQb2Y7dXiMyoJi0jYZsVpr8gxvoOjP7H69426WxZu3y34ze6+B82Vbf4hbR9F0iKJp8f5L6fUNIWEapi/DxKOOUQCMZF6MB9fhG8JCE6Ivw8FjxAFeSosRgK3f0O5r4FgDzNzwtq271u6tt/vd/loDA2gp2w5Z1o7j9mQyuQ/soc7jlkeVx2uoVrNDj8RQimyO+WGsg6qX04nM315l30FFfQClUwS9AE2firf/61q2FjGd/KDsVH5oqZxh/0o1m9TANE0Ih/GFRIlgkQMe+3iVbIAGXgdx0DaYXInjlRom8WMct7OsPfURf7YN4msfs6wTx52pnjOnYz9mJI5DMvt57vc4JlmWLfhsvzc+r2TZ7C46WeZgM8rXE2QSp7Mt5hPX4WuxSsURzYVvZCP0IwmemrWNOTefj6Yum4R5t40jKjLVQcKoSKmES7RL1bQv5B55zLNYpdkbO9aYgNYZaFBBftxz2vsDR/64heYE+OX2cTM7w0k2nXuXSBjBJcmp1iC5meyCpiy2bti2dVVe0ixHE2Dl78fH8d/+fcU4INDG1wRPgsRsxNAruPL3o832+5M5PYo8BxmhTyoFXEmFBHTUIUcJpHnlmByPx53xqooSIVLrlTxTEob2/6dicHZqwM07VOUP5u3UkkbN4EfSmbb3FegGxqgifuQck9/QmOGhXtfcts7eueG6dT2+oRtnCiRstN4T69sLMmoUEiRlqP4WOgF5HJyUY6yRD/EtY0/uwKwJiyGlA0hnm+7MaOXnlE5E4fjbO7WaW3UUXcMbNmSMl34Ls51uze2Y0cupxuPK5TjF3xYhde70V45nT38CJGXKe26a6KyPdq4t43DkYIMVAyB+ABmUVPrFXFACdjc2sJLInd0tS2A/YjqWbkW/2i0rNA6mjhicI2OcZUVW+keH5aweZZnTPer4wpEYh/Er1E93ZgV6ecsKLpC0YIFj3jN+DO//uEEzdT2+IVkxBdLNbPw5UqRxT9/TBXs7A/pt1RlwzrWMXe2FXDKfWsx9HbKH1xv6ZO0g9LJFEeQaPXJfypolyHe+oYzPqu6HW0x59V7fEPXNAetPpkDX775vn88i0vruvyNCbYB9Z2K1TsmMjm6w3E3zN0SeDp4ZJ0SrtS9hiIHjKqRI/Ccf2cGQDqSQubCXCybiVWcc4YxrgWaBD1MPYGii5yZgrRJaBRztPWOPtB4ht2FtIUlCldW/jcKPR4Xhe51ANuWK96BV7njGPdx4Kr37sxv7T7r1c+o9XG+c03q3cU7dRed0g9mIJ6hywVXpa4OqqcbXsozaz71aptnWT4pHuoWPOErrwTKDKNKYpOzcRFVipvKUTvBUPZc6KKfDdU8TIVTVw0XMfnQb3mhG4oTEYNyDThmYuIvDa+owamfRe7RaO4r1x4+bHNNgmLvY79V6s6fQXVvpra9Yj9Z8h1blhlkshG/QBAi5y3kZP9Gdzsv0rA5s6Xb6XLfT/ZD76n1a3b1H/cZlsdr93Mvi3o3rOtfcYlbfh/F8b1Zsnd3uaL9+NTvyy6lv7c/QqHuPVutU+Kh3Dy7UBYrzl1LijH58b7RH7ks5nkeAd9COb1SJv5hA68D+6US6fj+adK/b0NCeNBS0J/06Ua6v34ko64tOUdZxwF7/tPdy3P3t2Uhsbm5u7h68SrZejTY3NzP83el05hpR807bLIOaq3sf6u5lc8cvWKXT6SAKY6rphhm+kvPRf9jx4eIxHRd9/pM8O+v3EUyZ48D5cilQdv3rvDV/Hp9/KQcGYSBy8/Rd8O042AhifGDvn3UHobEsQemfRDwJNq4C92oM/3RvsnDkypnCp/pXgYoSyCj+5S1SfNyPr4OD0D/KDcLAPCPAl/5IdMGGe2AchBjiytEPAQrnMOM2rnwv+3Y6CJ0OHmwEluiDMHCBnvITAR4JDN3m8TC49gveNFX5pZpKmT/KN+44Dz5I/cxpzNDrqeSGz5qpPsN1hdZqMiolnQTTeRT+JaoPI9px5VO7dOLvBqbRE1I+jzTdgjBgGrL6KgsOTYpPx3QEAndinhh96lhzLDT75DVxnHnD/TkD3SuQzxl6Jgann0WOONg5Peac9R1Px7bOLtwklU18WwmxV4bb1SPhkJiHep3bKNX3N1imo/qaNjQxs+bhosfjtTerKjEWMM1zoLJj3nB/drKIyReiaVSY/JVSGjd2VoJa7qx3HQaXt2/mkkSi7V+mkx9TGGobSSaRkBzkg/rzlG9mc/21teswmNy+vcl3ub1HeHjj23f3xjzpr9Id/gpYVx9fh0FyO6y/lkkHfyGwaw+vqzvW5bKUOWwDEU9Ovdy6vq2jv8ywHyZEbfM9GYOsIWIgRAqUz2Bie2id+oL8gIbOD6F9v2HeijOp/EVmc6QkRIB5J+ZZl5dVxOk69iE5ce93MRawhR+MdqaKgcJe3M+n7IQD8HlXmChoezCbaGcc30CjBDO83KsSOvTOvRxTnUShPHjo/8bbJQV0aesEmE3RYHzUNMZq2DFe9vreO/XTwS94uZpkyb3D/Tvg0liKbZt1ZfUDu0s7B9k73McMHDZ06l+HvFIlJjxqaaMLQXWMXDDqX+mXsn1iY95g3Z3C53tVoYGOy31pk1mAYqbmQhTiS32bHlAmh85MXCXs4RGJQmOowWVIEqUhVw08GihKRB6K4i5UeQsmKRkV5omhRpb16TjmlVGVQcO4zTw1ZkZcSJ805MgCe2IaaoUnjxXsVJs/JMCVHU7JkCoNMsR0VMS8LNCoKKeEyxwkAx7BXBRIsKg7LeRcfa2Jg2Y6yquXL1yapt+DZ8oBcqCdGGJS5IZqDCeUaVL+5Ka3PqMoIXeAPF2kGM6qHiaZyXlAcpAKU3klEXJEOfvoUntRI0EjawAJTW1XJyrQU47wIIc3gfGy9o9//qsG10JNdxYwuwKNY3wDdwuExpK0BI+avoQcJaBoQoTzgfzP6UsAoTNMc5qJuGQkdXca3zev5lQpF13orgwbqiJK0LAo5a0KvYxVTq1UxjQ19quJ/eW4X7hkStcSffxz3Fn58BIQj1ENBqOGIFcjzfNJncGrcKaYms6kI7Fmklh5Dc7wAi20OJWQMX63e6rujNOiFASFFhnVLCJ+KtVppv7ZiI/n6wxzxi1oSI0XTMgHC1gVpzsVPIJTxk/hAuQdFLzd8vlQTCdI3HoMwOuweSTZ66xKzxpjvnIDJ7XbySQh1qFcR/PAxmzn2S43G7CeHqoEecgG+HbARp+R1YzgEJUN2zSGvhdryoVhl7bUd2Rs9Lrd/8u21Gr3+7Gl1rrfkS31GIF1XtvbBdAi/Wau7PBe6JsHnAmwHq5UyJt7onf3Oix95vMQXLFD/9r+V5l/Xu7fYhJam7FyJztzxm/GoKHf7eI/U0LQ1ybxFTOqci3p5N+C8O6+7JvPwFfHuBlZPyX9X1XOsyhBnC3Qm6vuN5NY3Ue/ApPnyeBZxPbY8+1XH7d7u2xbbfOX69HT7Yfb5/nb10+fP+nA5Hkv6r+evO2/1u/epGr7TLDo1+fJe/5aDZ6uF+/evpfv3m7Ld29eavpmfXPAEz549guLJutng36XvXj6vPv+TW88ePZL9/3rJ/l7M/kv3ffn590o23064JvYJ3/39r/Y3tnW6s7HrY87h1uXOx/TJx26++Hs6WX0ZOd862H7/bZs7+wNfjv7oPOX6/Hq7lv28DHswBt+2H0RNaiB8ZRxOPVHfWr2fYqHbSlpbd6xH4gMdGL0RVMSRQqst5LbuiJaTggdUcYJok7eIxWAlLfxy6dBdhMi1rrd016JhPVZJGxzkzlgSg8dinPgX3en9eW1XR5BvczSSmgFzHYy7UFjs/XvdpMKokIyPQk2jq6CyzbNWdu2bxydXJ+EASJWYPgqF8pATHUSbAQr09EsrABlYiVHV5YHS0ZTlMf4KmOG2WjOVi56nV5wHU6PmcucN/SHov2pQ5SmI8ZHt407qVB0gMdoT6qBqErHzdlvgEquO4d6rzBgSD4JUDRmEPNIHS+rGOCWP2MfnZsXcKvOcjqE5iNojaDY9D08J8xVi3Id+RCTiRqVQaOg2lBQBnaCoBaqwR+14Av+LA2Ao4qay8iFV7Z7Rkvtr60Zde5Rz+g9q4+NSrH28PrEIr/mqjQPcOv+NvvWpOE4cp+ajpQgmHJcNLwH086DhYb8AjveLTllr5aAzDMT1xvW2Rxsee2iiSt8jYG4Wu0aXK11Da4edxuKjdthNUOlnhgdpFRBjJ5RVzNQlzhB2mR8KAxhuxPdy4EfoJcP5Y5hjBl1FNJIZGURkVbLD/njn/8qR7VapTOAllXL9gpJcjEGidXeTLWzFC4ZWrymEl1m2pSJn5rn5TRLQSkMqnINI1uqDZMN0bXonFcRzekAK6aha8w8oTZvMWuyWXXImwTweQM2/SBt7uUFpCiPS59BvdraWMjzYSrGWMSMDLDAEHqNgCeUR9ZBZaWEcbSgxYzOv1wyhXWTJELNLGyCa0kjTTLK6ch4SkJSR1YMKUNRSqQYoP9WibSwHkpNWSqkfTlnNmSeNhgkbl3m2GR0auRLCQnS7oVzU6rQuomtAHB12Abokc8RFhaB8dYUPBVYMg09+0Waklxo621H1b0OIw7XknKF+raFxZ9BiTDnQQTlnpe/UoAn/ILxc1vYpU2OSrp6AwPFNDTTPqf570FzzDOmfy0GWDZKKKaFnFSjR0wnxcCI8vok5Q870zNf6q8mqKs5YhGpORqiiNQKZqiuHIBGClErm/vbRhN4QP74x3+TF0AlJ4kYW2qNCgnppKoqaArgmZO3aCsvcuOjpgVW0dOGSPnIh01UWbGO6j/+8T+K7MIYfXWWpexzlf1ikLKoLOeoWq0N8tQWbSzrNDbT1GzyAAYOKMnt6JTx8w7Z5BNbndDEV5AY8LsZ19iGcfsvqJJY1UY8rK0OmYL0AowPFSsVDcDUPDThGCmKkV2tDozbXDOPAve2Gcckn8qlQEdeBY71VZk4CLVOK6wrOCf9opHn0KyABDw2tc7UBjEKTzV/OJVgYUIjM598bkZVttJOUyudiZh0Oy6/2udDU0pGU95KGILEBVWjaCXNmSOnI0+WpJlP/elkbY1WrmlkNFx/SdKczXV1Y6U3tTc8wJKgkbe4FnD0ium8EoRByiJwFrS7vzaf7b8gF6udbhDWVLc7MPfKi+2nW7sHWwgMClKLsF6n2+kaR59QOqO8tpIpfVoS6vTVVnuatayYuqyYuqyYuqyYuqyYuqyYuqyYuqyYuqyYuqyYuqyYuqyYSpYVU5cVU7/S3pcVU5cVU5cVU5cVU5cVU5cVU5cVU5cVU5cVU7/efbusmLqsmLqsmLqsmLqsmPodFaJcVkz9GhS4rJi6rJi6rJi6rJi6rJi6rJi6rJi6rJj6yc6rZcXUZcXUZcXUZcXUZcXUZcXUZcXU/6cVU2vJbyt5ShmvpXTbzNOjqTqqJ2GQYGbqxlFwdYWE90qm19f4+UNhMu2OTsLggkqGD7ZMUmvokzAx2+4cMH/xqX1/1j7E5UN7zibDYSqXF7NI7YhNs/Ub+9aTZ/f3Dg6DMBi4Wq+ZiE2aPx1jdh4d2wTFWgqf+XYVpJSPCpP+F9g5r21ZnKSZdHpukk7dH7UcQkzOrCBsZqPabeD/cVNzB1xd2YTW6+uyv21aOMIh1vfG4zu5vr7+X8+xVkg=",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,y={},f=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Draft Template"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/drafttemplate",context:"endpoint"}),"\n",(0,s.jsxs)(n.p,{children:["The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique ",(0,s.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,s.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"When document is created this webhook event will trigger"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"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.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.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)(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},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",description:"Allowed values - signature, stamp.",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 j(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.c3197cfd.js b/assets/js/runtime~main.a3826b82.js similarity index 95% rename from assets/js/runtime~main.c3197cfd.js rename to assets/js/runtime~main.a3826b82.js index 2460079e1..6780d7f80 100644 --- a/assets/js/runtime~main.c3197cfd.js +++ b/assets/js/runtime~main.a3826b82.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",285:"23f866da",291:"4f7a2d40",300:"833eda7d",419:"e5d81aec",448:"d77fb6a8",490:"ce589067",539:"cfb1e6eb",560:"500027af",636:"eaa24e23",746:"cf03142d",841:"d1393a72",849:"0058b4c6",850:"c6b74119",930:"05729a5b",956:"19e4dfff",962:"046910c8",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",2089:"c7b98810",2131:"299c7a47",2264:"17e5210b",2634:"c4f5d8e4",2661:"8bd80e56",2703:"da66eb9c",2711:"9e4087bc",2723:"reactPlayerMux",2908:"2c416566",2959:"50ea61d6",3021:"4cff09f6",3073:"e9e778b7",3128:"c674cfb4",3148:"1e1b513c",3230:"d480dde9",3249:"ccc49370",3276:"e5aefb32",3333:"e48228d1",3381:"42f80fc5",3392:"reactPlayerVidyard",3404:"03e06346",3460:"5ce6d213",3633:"b97a0b7b",3637:"f4f34a3a",3694:"8717b14a",3795:"c4fbe420",3841:"56b5f4f8",3891:"8e4d0438",3976:"0e384e19",4001:"d281bdbe",4106:"882238ec",4134:"393be207",4212:"621db11d",4232:"5a144266",4240:"9c9cb35e",4372:"9cd612ce",4466:"56b0ffe9",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",6318:"bb4fa758",6328:"reactPlayerDailyMotion",6353:"5e1bb91e",6463:"reactPlayerKaltura",6473:"4c5e977b",6505:"cd2b86eb",6648:"0c0943c7",6653:"f214d5ff",6743:"e226bb09",6841:"f22c5875",6887:"reactPlayerFacebook",6940:"a000203c",6969:"14eb3368",7024:"98334e25",7068:"e92d0461",7075:"4d139b56",7098:"a7bd4aaa",7318:"e76c28ee",7458:"reactPlayerFilePlayer",7472:"814f3328",7477:"36994c47",7570:"reactPlayerMixcloud",7574:"70276854",7627:"reactPlayerStreamable",7643:"a6aa9e1f",7696:"1ee58ee1",7757:"eb56c656",7904:"5144c8d4",7910:"e4f5c862",7960:"b2e6bd40",7968:"489197af",8e3:"54a7b8f4",8025:"5e90a9b3",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",9190:"6cb65baf",9239:"0c806540",9241:"11b7b3d8",9325:"59362658",9328:"e273c56f",9340:"reactPlayerWistia",9350:"62b755e6",9426:"38ec836e",9490:"02fcf422",9570:"a3008c1e",9611:"06b6ef6a",9647:"5e95c892",9858:"1f7895dc",9979:"reactPlayerSoundCloud"}[e]||e)+"."+{33:"04d03f97",89:"67599f09",108:"b9723cd9",157:"be2f595e",285:"e170b9c6",291:"4d88e708",300:"d5462c6f",419:"26112334",448:"3492c614",490:"a197b5a8",539:"ddb32cf1",560:"183f80db",636:"23fdfdd6",746:"49f86803",841:"2e9f4f9b",849:"392ec67f",850:"3ac080ec",930:"9f35584c",956:"e6fef687",962:"0758599a",1179:"955bead1",1235:"e0fce024",1440:"5dc69857",1463:"6c989e27",1477:"c7a939ea",1640:"d2ce80bf",1651:"e44b2367",1665:"6005cc6b",1679:"27742ef4",1688:"2582d322",1706:"33c9f705",1903:"9c2000d9",1924:"fdb8fe31",1936:"3329227e",1972:"6aa170c8",2042:"ccdbba13",2043:"4a1b8c9b",2089:"4267cecd",2131:"920ad619",2264:"03a17636",2489:"a212f802",2634:"b5502b21",2661:"881ab85e",2703:"717af639",2711:"999c03aa",2723:"ad84c6fe",2908:"9a88f7fa",2959:"16d5d1b8",3021:"8265c79a",3042:"040aac0d",3073:"cff2425c",3128:"e29762a5",3148:"9a6039c4",3230:"a2cfa06b",3249:"d6c50b29",3276:"00ab24d9",3333:"099c2226",3381:"dfcbba2f",3392:"a7951473",3404:"fd769b08",3460:"827e01c6",3633:"d2a8f664",3637:"ffa80471",3694:"4d710693",3795:"8c4aab4f",3841:"cf1c6a97",3891:"c8de3ba8",3976:"2d4c4f66",4001:"183be27c",4106:"d9d3f988",4132:"a5c6ef5a",4134:"7b436152",4212:"5dccb1c7",4232:"804e9e11",4240:"b86e5973",4372:"b75be620",4466:"8b9f41be",4584:"a7d307eb",4622:"420bc0ab",4813:"1198d246",4833:"cf9a081c",4865:"4a732e7a",4952:"9881366e",5013:"b10f6f78",5277:"b2de11fb",5305:"760fdd56",5314:"2ddf281e",5342:"3f44a353",5373:"60be571e",5506:"9d141ac4",5510:"92a4db7d",5524:"47dbdaaf",5550:"76bbef59",5557:"dffbf1c4",5597:"3dcd4c42",5742:"ac359952",5752:"9f2d8c5b",5794:"c75a31d7",5855:"84d22ac9",5881:"3782c030",5939:"07a6668d",5970:"91dc704f",6007:"bc61a38c",6011:"1a38abf2",6061:"bb03b217",6157:"fccfe0be",6173:"40e527dc",6192:"0541c66c",6235:"5aa106b8",6288:"cb1b5f05",6295:"958608f5",6318:"213b74ab",6328:"a2ec01b1",6353:"c48fddc9",6463:"665cb544",6473:"0243df4f",6505:"c6903d64",6648:"2847553a",6653:"fdbc0c47",6743:"a3fe848c",6841:"50291cb3",6887:"f478ac9c",6940:"fd8689e0",6969:"408561bf",7024:"163938f2",7054:"cab4fa5c",7068:"b64a0c73",7075:"6f4eebad",7085:"2efbf216",7098:"c920e4e4",7318:"2bd572be",7458:"e1cdf442",7472:"909d2cac",7477:"4aaebd1d",7570:"086b8299",7574:"d5e60f67",7627:"df6df631",7643:"4bb958af",7696:"d7f04e0f",7757:"13e692a4",7904:"8aab2983",7910:"5b11649a",7960:"102fca2b",7968:"14065b3d",8e3:"58f8ce85",8025:"18e81984",8046:"eb383529",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:"b07419f4",9099:"e3542020",9190:"dd359a70",9239:"cb86fd3c",9241:"c62c9d6a",9325:"cc9232ad",9328:"18a92a49",9340:"91290ba6",9350:"4db3ade4",9426:"4597631d",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","23f866da":"285","4f7a2d40":"291","833eda7d":"300",e5d81aec:"419",d77fb6a8:"448",ce589067:"490",cfb1e6eb:"539","500027af":"560",eaa24e23:"636",cf03142d:"746",d1393a72:"841","0058b4c6":"849",c6b74119:"850","05729a5b":"930","19e4dfff":"956","046910c8":"962","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",c7b98810:"2089","299c7a47":"2131","17e5210b":"2264",c4f5d8e4:"2634","8bd80e56":"2661",da66eb9c:"2703","9e4087bc":"2711",reactPlayerMux:"2723","2c416566":"2908","50ea61d6":"2959","4cff09f6":"3021",e9e778b7:"3073",c674cfb4:"3128","1e1b513c":"3148",d480dde9:"3230",ccc49370:"3249",e5aefb32:"3276",e48228d1:"3333","42f80fc5":"3381",reactPlayerVidyard:"3392","03e06346":"3404","5ce6d213":"3460",b97a0b7b:"3633",f4f34a3a:"3637","8717b14a":"3694",c4fbe420:"3795","56b5f4f8":"3841","8e4d0438":"3891","0e384e19":"3976",d281bdbe:"4001","882238ec":"4106","393be207":"4134","621db11d":"4212","5a144266":"4232","9c9cb35e":"4240","9cd612ce":"4372","56b0ffe9":"4466",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",bb4fa758:"6318",reactPlayerDailyMotion:"6328","5e1bb91e":"6353",reactPlayerKaltura:"6463","4c5e977b":"6473",cd2b86eb:"6505","0c0943c7":"6648",f214d5ff:"6653",e226bb09:"6743",f22c5875:"6841",reactPlayerFacebook:"6887",a000203c:"6940","14eb3368":"6969","98334e25":"7024",e92d0461:"7068","4d139b56":"7075",a7bd4aaa:"7098",e76c28ee:"7318",reactPlayerFilePlayer:"7458","814f3328":"7472","36994c47":"7477",reactPlayerMixcloud:"7570",reactPlayerStreamable:"7627",a6aa9e1f:"7643","1ee58ee1":"7696",eb56c656:"7757","5144c8d4":"7904",e4f5c862:"7910",b2e6bd40:"7960","489197af":"7968","54a7b8f4":"8000","5e90a9b3":"8025","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","6cb65baf":"9190","0c806540":"9239","11b7b3d8":"9241",e273c56f:"9328",reactPlayerWistia:"9340","62b755e6":"9350","38ec836e":"9426","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",285:"23f866da",291:"4f7a2d40",300:"833eda7d",419:"e5d81aec",448:"d77fb6a8",490:"ce589067",539:"cfb1e6eb",560:"500027af",636:"eaa24e23",746:"cf03142d",841:"d1393a72",849:"0058b4c6",850:"c6b74119",930:"05729a5b",956:"19e4dfff",962:"046910c8",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",2089:"c7b98810",2131:"299c7a47",2264:"17e5210b",2634:"c4f5d8e4",2661:"8bd80e56",2703:"da66eb9c",2711:"9e4087bc",2723:"reactPlayerMux",2908:"2c416566",2959:"50ea61d6",3021:"4cff09f6",3073:"e9e778b7",3128:"c674cfb4",3148:"1e1b513c",3230:"d480dde9",3249:"ccc49370",3276:"e5aefb32",3333:"e48228d1",3381:"42f80fc5",3392:"reactPlayerVidyard",3404:"03e06346",3460:"5ce6d213",3633:"b97a0b7b",3637:"f4f34a3a",3694:"8717b14a",3795:"c4fbe420",3841:"56b5f4f8",3891:"8e4d0438",3976:"0e384e19",4001:"d281bdbe",4106:"882238ec",4134:"393be207",4212:"621db11d",4232:"5a144266",4240:"9c9cb35e",4372:"9cd612ce",4466:"56b0ffe9",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",6318:"bb4fa758",6328:"reactPlayerDailyMotion",6353:"5e1bb91e",6463:"reactPlayerKaltura",6473:"4c5e977b",6505:"cd2b86eb",6648:"0c0943c7",6653:"f214d5ff",6743:"e226bb09",6841:"f22c5875",6887:"reactPlayerFacebook",6940:"a000203c",6969:"14eb3368",7024:"98334e25",7068:"e92d0461",7075:"4d139b56",7098:"a7bd4aaa",7318:"e76c28ee",7458:"reactPlayerFilePlayer",7472:"814f3328",7477:"36994c47",7570:"reactPlayerMixcloud",7574:"70276854",7627:"reactPlayerStreamable",7643:"a6aa9e1f",7696:"1ee58ee1",7757:"eb56c656",7904:"5144c8d4",7910:"e4f5c862",7960:"b2e6bd40",7968:"489197af",8e3:"54a7b8f4",8025:"5e90a9b3",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",9190:"6cb65baf",9239:"0c806540",9241:"11b7b3d8",9325:"59362658",9328:"e273c56f",9340:"reactPlayerWistia",9350:"62b755e6",9426:"38ec836e",9490:"02fcf422",9570:"a3008c1e",9611:"06b6ef6a",9647:"5e95c892",9858:"1f7895dc",9979:"reactPlayerSoundCloud"}[e]||e)+"."+{33:"04d03f97",89:"67599f09",108:"b9723cd9",157:"be2f595e",285:"c409fe4f",291:"4d88e708",300:"d5462c6f",419:"26112334",448:"3492c614",490:"a197b5a8",539:"ddb32cf1",560:"183f80db",636:"23fdfdd6",746:"49f86803",841:"2e9f4f9b",849:"392ec67f",850:"3ac080ec",930:"9f35584c",956:"e6fef687",962:"0758599a",1179:"955bead1",1235:"e0fce024",1440:"5dc69857",1463:"6c989e27",1477:"c7a939ea",1640:"d2ce80bf",1651:"e44b2367",1665:"6005cc6b",1679:"27742ef4",1688:"2582d322",1706:"33c9f705",1903:"9c2000d9",1924:"fdb8fe31",1936:"3329227e",1972:"6aa170c8",2042:"ccdbba13",2043:"4a1b8c9b",2089:"4267cecd",2131:"920ad619",2264:"03a17636",2489:"a212f802",2634:"b5502b21",2661:"881ab85e",2703:"717af639",2711:"999c03aa",2723:"ad84c6fe",2908:"9a88f7fa",2959:"16d5d1b8",3021:"8265c79a",3042:"040aac0d",3073:"cff2425c",3128:"e29762a5",3148:"9a6039c4",3230:"a2cfa06b",3249:"d6c50b29",3276:"00ab24d9",3333:"099c2226",3381:"dfcbba2f",3392:"a7951473",3404:"b31c41dc",3460:"827e01c6",3633:"d2a8f664",3637:"ffa80471",3694:"4d710693",3795:"3faae548",3841:"cf1c6a97",3891:"c8de3ba8",3976:"2d4c4f66",4001:"183be27c",4106:"d9d3f988",4132:"a5c6ef5a",4134:"7b436152",4212:"5dccb1c7",4232:"804e9e11",4240:"370bccf1",4372:"b75be620",4466:"8b9f41be",4584:"a7d307eb",4622:"420bc0ab",4813:"1198d246",4833:"cf9a081c",4865:"4a732e7a",4952:"9881366e",5013:"b10f6f78",5277:"b2de11fb",5305:"760fdd56",5314:"2ddf281e",5342:"3f44a353",5373:"60be571e",5506:"9d141ac4",5510:"92a4db7d",5524:"47dbdaaf",5550:"76bbef59",5557:"dffbf1c4",5597:"3dcd4c42",5742:"ac359952",5752:"9f2d8c5b",5794:"c75a31d7",5855:"84d22ac9",5881:"3782c030",5939:"07a6668d",5970:"91dc704f",6007:"bc61a38c",6011:"1a38abf2",6061:"bb03b217",6157:"fccfe0be",6173:"40e527dc",6192:"84e557cf",6235:"5aa106b8",6288:"cb1b5f05",6295:"958608f5",6318:"213b74ab",6328:"a2ec01b1",6353:"c48fddc9",6463:"665cb544",6473:"0243df4f",6505:"c6903d64",6648:"2847553a",6653:"fdbc0c47",6743:"a3fe848c",6841:"50291cb3",6887:"f478ac9c",6940:"fd8689e0",6969:"408561bf",7024:"163938f2",7054:"cab4fa5c",7068:"b64a0c73",7075:"8d0aa3f2",7085:"2efbf216",7098:"c920e4e4",7318:"2bd572be",7458:"e1cdf442",7472:"909d2cac",7477:"4aaebd1d",7570:"086b8299",7574:"d5e60f67",7627:"df6df631",7643:"4bb958af",7696:"d7f04e0f",7757:"13e692a4",7904:"8aab2983",7910:"5b11649a",7960:"102fca2b",7968:"14065b3d",8e3:"58f8ce85",8025:"18e81984",8046:"eb383529",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:"dce016b3",9099:"6a79c571",9190:"dd359a70",9239:"cb86fd3c",9241:"c62c9d6a",9325:"cc9232ad",9328:"18a92a49",9340:"91290ba6",9350:"4db3ade4",9426:"4597631d",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","23f866da":"285","4f7a2d40":"291","833eda7d":"300",e5d81aec:"419",d77fb6a8:"448",ce589067:"490",cfb1e6eb:"539","500027af":"560",eaa24e23:"636",cf03142d:"746",d1393a72:"841","0058b4c6":"849",c6b74119:"850","05729a5b":"930","19e4dfff":"956","046910c8":"962","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",c7b98810:"2089","299c7a47":"2131","17e5210b":"2264",c4f5d8e4:"2634","8bd80e56":"2661",da66eb9c:"2703","9e4087bc":"2711",reactPlayerMux:"2723","2c416566":"2908","50ea61d6":"2959","4cff09f6":"3021",e9e778b7:"3073",c674cfb4:"3128","1e1b513c":"3148",d480dde9:"3230",ccc49370:"3249",e5aefb32:"3276",e48228d1:"3333","42f80fc5":"3381",reactPlayerVidyard:"3392","03e06346":"3404","5ce6d213":"3460",b97a0b7b:"3633",f4f34a3a:"3637","8717b14a":"3694",c4fbe420:"3795","56b5f4f8":"3841","8e4d0438":"3891","0e384e19":"3976",d281bdbe:"4001","882238ec":"4106","393be207":"4134","621db11d":"4212","5a144266":"4232","9c9cb35e":"4240","9cd612ce":"4372","56b0ffe9":"4466",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",bb4fa758:"6318",reactPlayerDailyMotion:"6328","5e1bb91e":"6353",reactPlayerKaltura:"6463","4c5e977b":"6473",cd2b86eb:"6505","0c0943c7":"6648",f214d5ff:"6653",e226bb09:"6743",f22c5875:"6841",reactPlayerFacebook:"6887",a000203c:"6940","14eb3368":"6969","98334e25":"7024",e92d0461:"7068","4d139b56":"7075",a7bd4aaa:"7098",e76c28ee:"7318",reactPlayerFilePlayer:"7458","814f3328":"7472","36994c47":"7477",reactPlayerMixcloud:"7570",reactPlayerStreamable:"7627",a6aa9e1f:"7643","1ee58ee1":"7696",eb56c656:"7757","5144c8d4":"7904",e4f5c862:"7910",b2e6bd40:"7960","489197af":"7968","54a7b8f4":"8000","5e90a9b3":"8025","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","6cb65baf":"9190","0c806540":"9239","11b7b3d8":"9241",e273c56f:"9328",reactPlayerWistia:"9340","62b755e6":"9350","38ec836e":"9426","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 895d8fb85..1030b8d8e 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 4e2b8f070..833c22106 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 66cdcd44f..5faf8433b 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 e49c8246b..e6326f6c1 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 c2e4965f3..994e7487a 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 21fd020ac..7e43c8017 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 016f619b1..073ccddef 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 f7baa0756..4bc3a14fe 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 401552ec9..f907ae698 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 1d4c15624..85aac6eb4 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 6189037e2..8b0d3de21 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 ffeec1e09..5f48cbdee 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 0b3fde84e..db67cce0e 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 23d3408e4..5198c4c78 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 5624acecf..3d82d2e25 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™ - + diff --git a/docs/API-docs/v1.1/createdocumentwithtemplateid/index.html b/docs/API-docs/v1.1/createdocumentwithtemplateid/index.html index 52a11b8f9..f47c1033c 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™ - + diff --git a/docs/API-docs/v1.1/createfolder/index.html b/docs/API-docs/v1.1/createfolder/index.html index 53b4e99ee..ad62629b8 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 a6b64a9cd..d3a2f9dbf 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™ - + diff --git a/docs/API-docs/v1.1/delete-template/index.html b/docs/API-docs/v1.1/delete-template/index.html index 4eea60073..a993f5287 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 e72e8c870..61123bbde 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 6b39185cb..a1fec0613 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 2ba9762c7..7e22487e6 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 9d7cd3a16..fae130d11 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 7b7f98f78..d110d38be 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™ - + diff --git a/docs/API-docs/v1.1/drafttemplate/index.html b/docs/API-docs/v1.1/drafttemplate/index.html index 2caca9009..550c13089 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™ - + diff --git a/docs/API-docs/v1.1/folderlist/index.html b/docs/API-docs/v1.1/folderlist/index.html index 66991c193..0ba550d0c 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 18226a6e8..f21ebea5b 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 d0db690ef..d36f030ff 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 3086a1785..ce1d1fdee 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 4ecdb3848..4e659a6b4 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 36e8f7706..375d493fb 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™ - + @@ -18,6 +18,7 @@ the cycle with 50 remaining, your balance resets to 100 at the start of the next cycle.

addon_credits: Credits purchased separately from Settings → API Token → Buy Premium Credits. Add-on credits do not expire and are only used once all plan credits are consumed.

total_credits: The sum of plan_credits and addon_credits. This represents the total credits currently available for use.

+

renewal_date: The Subscription renewal date

Responses​

Successful operation

diff --git a/docs/API-docs/v1.1/getdocument/index.html b/docs/API-docs/v1.1/getdocument/index.html index 965e640b3..9fe9ceb4e 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 686d307c4..56a5b7d96 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 4351f02ee..f1f300ffe 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/gettemplatelist/index.html b/docs/API-docs/v1.1/gettemplatelist/index.html index 27605af02..7d5d682ff 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 a9f4f8eab..7846a7659 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 5b14dbe5c..2c0a163ed 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 26080c74b..b6866cf6c 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 6d74b82f5..a741ae24c 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™ - + diff --git a/docs/API-docs/v1.1/resendrequestmail/index.html b/docs/API-docs/v1.1/resendrequestmail/index.html index 6a378254b..d6be0338e 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 16ced154e..52ec64346 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 6465b6c15..5aff99158 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 95ca67241..367f20d04 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™ - + diff --git a/docs/API-docs/v1.1/update-document/index.html b/docs/API-docs/v1.1/update-document/index.html index e1c69f81a..de6fc42de 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 132130355..5b638b201 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 14452b44d..0b7b904a2 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 071dba43b..643a0b8ef 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 61a8cba31..c139c2073 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 bcec6aa5f..1f7dc5da9 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 d80985895..bfda8b0ec 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 8f1a75de9..a3e387618 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 5f16ba8af..156ed4d8a 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 9e3d9dab5..a4a3d3752 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 c35f50ffc..0803a0224 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 798cfdb4e..e9c30dfd2 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 fde5a5263..67dcf6252 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 70b34028e..2ad40eaac 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 de77d0da6..fdb289a7c 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 237937005..bdb3aa150 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 79f5b4f97..6c1ba7769 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 d4a360e63..998a5549a 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 8d3bd32ad..6892afb99 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 0167e1e04..f2df54f6a 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 9761fcb74..94143aebd 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 468a89756..271d0a130 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 2805972a6..6aa225281 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 bdf26406b..51ac96d3d 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 48cbbb478..577a71dcf 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 1e5cd9dfb..3b84974b9 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 55e9b7122..b66909e3d 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 dbe956127..ac8a270be 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 0b31a001d..aece6a209 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 ed30c2ee4..c7ac2d663 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 7357861d3..29d0d2abf 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 90eb12efc..fd59f748f 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 061480be2..6e309c06c 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 1fa1e5189..ee3b9a7ad 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 6bde1c3b4..0b223f1db 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 7f2c44d7f..69e37d2f8 100644 --- a/docs/category/cloud-storage/index.html +++ b/docs/category/cloud-storage/index.html @@ -5,7 +5,7 @@ Cloud Storage | OpenSign™ - + diff --git a/docs/category/create-new-opensign-document/index.html b/docs/category/create-new-opensign-document/index.html index 821066367..0a87db7f3 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 95d1a7b47..6bf8a590e 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 cc1eb8c6a..3ef60d4b6 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 673e5aa40..94aebd44a 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 e8fe1f919..18f335828 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 169aea36b..88ce0fb5a 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 395829305..3207ebc11 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 bbdc82316..500372d9c 100644 --- a/docs/category/templates/index.html +++ b/docs/category/templates/index.html @@ -5,7 +5,7 @@ Templates | OpenSign™ - + diff --git a/docs/contribute/CODE_OF_CONDUCT/index.html b/docs/contribute/CODE_OF_CONDUCT/index.html index ebd8de17e..1ffd9b36e 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 0e8498da6..c4faab4b7 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 3e89501ad..ccd0c6b15 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 0cf3e5eb9..0e154ace7 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 11ee4009f..9c9cc162b 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 fdd7cb666..50a60be44 100644 --- a/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html +++ b/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html @@ -5,7 +5,7 @@ Why am I getting 'Ensure this field is accurately filled and meets all requirements'? | OpenSign™ - + diff --git a/docs/help/FAQs/index.html b/docs/help/FAQs/index.html index ae2674f45..19403eed5 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 02d99ef7e..04c56cec6 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 195f501fd..7428f59ff 100644 --- a/docs/help/New-Document/enforce-email-verification/index.html +++ b/docs/help/New-Document/enforce-email-verification/index.html @@ -5,7 +5,7 @@ Enforce email OTP verification | OpenSign™ - + diff --git a/docs/help/New-Document/navigate-between-pages/index.html b/docs/help/New-Document/navigate-between-pages/index.html index d90c1d677..8d4cc3106 100644 --- a/docs/help/New-Document/navigate-between-pages/index.html +++ b/docs/help/New-Document/navigate-between-pages/index.html @@ -5,7 +5,7 @@ Navigate between pages of a document | OpenSign™ - + diff --git a/docs/help/New-Document/request-signatures/index.html b/docs/help/New-Document/request-signatures/index.html index 1f9a117bb..c8074f187 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 a7511e617..7ce4a06e5 100644 --- a/docs/help/New-Document/sign-yourself/index.html +++ b/docs/help/New-Document/sign-yourself/index.html @@ -5,7 +5,7 @@ Sign your-self | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/create-document/index.html b/docs/help/OpenSign™ Drive/create-document/index.html index 8d0730a0e..a97e16055 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 86421bf4e..6f8e900dd 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 aa2a711c3..9d11528a0 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 2a6d1d580..e6928cd47 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 0e9ebd148..90c229f6f 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 29905cf62..6767f75dc 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 0258d6f39..48d4ddbca 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 69aa9ce92..1e63f67b8 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 5634d9c51..983138ae4 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 c6c11fdb3..4d0b6ea93 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 c07e4260a..935f94f30 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 0f8481965..4400a5575 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 5cf0e52f0..734eaa712 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 6796cfdf9..05b2fb1a2 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 3f2f9f60f..2b4aec643 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 6ec8e2192..e88e3b7c5 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 40fe50425..abf4bfdc5 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 8c27353e7..a27a4e583 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 517ba55d8..518b928c8 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 db06f4c39..47d544eb6 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 3b34fe3fe..bf829165c 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 dd83ef038..f99b470d3 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 b95334dc7..94d46373f 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 b2a648b94..ae8fdd402 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 81555ddca..494722a1e 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 09fef7cbc..96276289d 100644 --- a/docs/help/Templates/use-template/index.html +++ b/docs/help/Templates/use-template/index.html @@ -5,7 +5,7 @@ Use template to create documents | OpenSign™ - + diff --git a/docs/help/intro/index.html b/docs/help/intro/index.html index 43fa22036..d50acc694 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 27d954d81..bd0f0b78b 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 1c1902b17..09ae6d09d 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 d5c739a08..b6b9ec442 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 065122039..66f79b8dd 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 85ac71873..7b3087a52 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 ccbcfa68e..73fbe66d2 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 10bd740a7..e8899e63f 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 4270a9b05..f267454a0 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 cc2eaaba3..275796f71 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 239d4ae01..121e1d373 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 d000e5932..db07f0e34 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 0953d0a42..bd66197de 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +