mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-08-31 12:19:52 +02:00
1 line
37 KiB
JavaScript
1 line
37 KiB
JavaScript
"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[285],{97831(e,n,t){t.r(n),t.d(n,{assets:()=>j,contentTitle:()=>f,default:()=>w,frontMatter:()=>x,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"id":"API-docs/v1.1/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","source":"@site/docs/API-docs/v1.1/selfsign.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/selfsign","permalink":"/docs/API-docs/v1.1/selfsign","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar_label":"Self Sign","hide_title":true,"hide_table_of_contents":true,"api":"eJztPF1zG8eRf6Vv66pkIQuQgChZx1JUUSwn1p0jqyyqXD6SYQa7DWDE3Zn1zCxBhIUqP+Qf3NNV3b3kp/mXXHXPzGIXH6QoO4nuDn6QiZ2vnu6e/p65SZyY2uT4NHmps7pE5WxyniY52szIykmtkuPkZIZgsZhYOVXw4s0rmKJCIxxaEPDu26/BzYQDVGJcoIWJQbRuUSBQf6mmoCcgIA/zD+B7XUMmFIjCapAqK+ocQfNiooDKYD/HiVSYw1zmU3Q2hflMZjNwMz8nGh6PuXSgDeB1JVQOdaUVCAsKMcd8ACczaaEy+krmDGiEBq8rNBJVRpOVshAGnOa5f/rxv97SFr/XtaH9/vTjf8Ok0HOQitu/qVBxB1FVgzN1pk5kdQzvqkKLHBa6NvDm5e+ajdKs9O2013uJ43oK7171euefzZyr7PHBAc2hK1QEViHGdpDp8iCnjlU+eUhbRoM0q9+rsLJYgMhbSHEzVJDpagGZ1iaXiiiSQiWmCKoux2hsCoSZUhukPQgwKPJF3+l+bRH+9e03r2GiTSncAN4UtU2b5XJpMHPFwk9Pe4+7emBhLCw+OQLrjFTTFEpxSWiVDn6oZXZJ27ao8ojUF29eMa56vbd1VWnjMIfv/BaOez1q+S0SjoVB7p/pstQKKmFEiQ6N9dxFzQZ/qKVhvnAzEEURcXF8pvrQ6ylR4nGvB++U/KFGkDkqJycSDe0SHPGDHzDw/d2i4v6vVC4zZmcCgL4Sy3a6ElKp69sKM5rSd22hGrQKXEo4nAtP/6oQmd+WQVth5uQVdie+TmFBE79EpSMEM23kn7VyomDyXaFxMhNFm8wEIB8HJ4wj9FdaKhe/hhWak0bUZiIGPiTQckJuKRW3WIQrUdRoA1TzFGYE1bdYGbQkFeK8hHiVwwzldLZzPZG/r63rTAy1JTDbUIS1IlUZvchom4jCIshJB5eluMTWao3EGMBvF5DjRNSFS0EShzpT4wBea0cntZAZCSbmATpswtUG+0zlwD6DLvu8WcmMXE4maOgwUyNPEcZE6IgvvZCh7fFJczOhQKs1Qme60GaThfhzF4+QaeVYUr64ErJg4P1mbSMux4XILlMYFzWmYDD3B32BRaHnqT8f3IUEosc544fEOHGhVgS/0mF5acEGqBrBGc8fNTbCmRaRto3VcMonmlYmFMQjCVgKWaSMuBTe6zE46QpM6YBXQi1SyIXDFBxeu7G+TiGbYXY51tcBXxOtnJV/3nLqYsv9sTZK4SiFJyk8TWF4mMJwlMLwKIXhkxSGT1MYHaYwGqUwOkph9MTjdPQ04FM0SGwDMBx5TLpPD4MzmeMFNV4Q/BfCOjTSXpLYhe9Id3iNnade7OG1IyHWKNl8pcmkhZnMc1QwMboEg5msJEsFf6qbqVMY1w4MAa4sTOqiWMCVtLK1z2ZSPSdF7lWrNC3lmmW6JjoyFj3iGGUrsqpiQaCeoCgtY/RL5dBURlokkatsgwHlVvzjFRl9ax/kD6GW6kqS3RSLFEjBiFxqwobTKoXc6CrXcxU04dfSsuwkFWYbrTjvaMXhAHq9Rl7Rtz/96U9n6uZMAZwlJL7OkmM4S5ouZ0nq20grUdsw/L6mH49Gn4efC/r5ZPQ0/Jxz1+FR+Dmjn6M4NBygs+SY1+UOUjm/cpCT0IKAOi3P1DIAe6ZGvAsnyuqWHVDz3xZ6aMCP2oY+kppIYwOdsk14duzY99jY7SParVTSSVHY3RuOPT6hPa+BtH3bq04bOz+inbO82r1tbv6E9tyGh1pYF/om1p2tpijxGYrRLShan3OXDKZRbOVsYPLxIJgiuxHpt/DJ4LEFzi+FxrUp74/FJ4RFUpknpDJ3o7LRqp8QPtdh+qWQum3e+2P28wEbs2yB7MZr6PAJYbUL0S+F081Z74/Rp4RRMuV2o5NaPyFctsChhmAX+7bDo/7wcX90ODrq4JOiDL5DWfbzvL9YLH4eLUqpLjwcNKjVvxTX2xtCAKhpZGrcQlvfb41cZFaG/ZJlGZ1Fb9oKh95C3owEsKO+6hVcF/47es9/IJ95HN1JzGPYqXEsmmBN2+F1OheLB9ZPFYc2PhT1X7eAPZjcRHBw4CqbaZkF4KlP9JzGFJsZEA76TLqDPD9okY4+5nm/LPtrH+lnnynd+liWgzwfrPXcYAf/sYQ8T2Hz89bveQ5lWe747L93Ph+U5eYuBmUZYAvYixy2QedSKlnW5AdRDMy709SRXImA3jLQUiro9b7//vvv+3/4Q//ly14v0jAsEXi1FXbwK4jrX2iFNtP3esfwagLtT+z6+6ALn/XG/SO3pukw03MVvZ4QgM1riv7Frj70U4oFT4bSzdB019FmxbLkI5JLNdZuNoB37ELS39HValwidpf+hcRj8HF3S8jQ4e8lJFeysLvwrQKUoq/ku24Kn44E3TB+omCqtltHBqd1IQxeU6zOSq02JN/HaLr7abE1sRh5eRUz4ShgiMNiDFnAZ98ET/thEwxc2wvN9gKy2joOPEzxGirhHBrFk12JQuaCz0efP+C1KCsKkhz88ews/9U/H3AYliKdzscNcjmVFD0/+OPpi/6/n2/pUVcVmkxYhAJpJZsCumwApzMsqlUAfz6fD+aPbDbTuvDR+/fW4MT/e6HH7y8Y3GogbPVw2049M7TCnsQs61FPPpwtjAkLceSWwCeThk/N8JDttBCPuMVQCz0+IetiDSRq9DFkaj4lBc8mLDEvrv7WJHPOkvOVuudQJ+Z3jD3/gONJp6EQYyw2m+5/tAqx0HU40TG0391q4OgW3oLB00RveTuHaatRXK81+rbllnPqEdI+plHbx+MZKQCFtI0i6aCzPToE+DlNQ8k3YtsxQhwA44ZLf/YpaAD7sGMQo6BMuzuWoH7AHZvkShNPvX2FDmE2NHmwFWKWaNLMGlEWFXkbXzSytmhWZsItKwRbYfcKlJLZvcCZGnKsUZZieosLws2fkJRow7MjXOV7bPhbQw5KenTdEmTh9ts3PDzsbPhxd8NPDj/CnOgseysqWjbDYUvmmLIuxIYFkGMmS1FwPpKXHv0MCbYlXrMO9cfYDwF24u8vdFnVzvN3sBzIM2EZHxk9JuJ8CuJXKfRT6KVwkMJnKTwcwLfIqbusSfMFvpfGJ/OkglzXFM/PalMsYGwINyngYDqAm5sfaqGcdIvlEnpwc0PlDsvlgCTFpdJzn+k7pdyGA8rUr+yCXGd2S2ZfZ/aADIiD1zjvx2KLgwDaQ/hMr0nGW62pgIINcdohMw193QgFb/dw5lfaqhALEBNKd/jsIA/zSeQBYeAYRvDr5zAcDQ4PUzj0f8Nncf3RQz5IHO/OsLgt2M3Ndx2jw/YxWv3cJjceH37QOWov+5FGOU1xwbkoXne7sb5VAn2CxvlqM+vhgJbeIJx5lWFnui5y0hoGXW0UNvUcQWskaaIrKgKSWr3Kk+MkFgglKeMarfutzhfJ8U0SErP0Z0ii0aCD95aKi24Sm82wFPRXpBGVI01kgUmaeG/TJmnCkUuqTSLWSo4TPX6PmUtS8ooqMqPQ0hw87vgm9vJFKkkaIlDJceKrV5I0CZ5C8wlQZZrCLlU+SZZxwdumar6sprL8R5PkpHmoruMjp3lNQ5dr5VgfNdPL1gy8txJPNEnZAh2+FAvbmtczRLJeBUZjiAmyMApysbDkstfWc0cmiqwuyNnH60qaRRPp4ghTg5IWvM1KDbzDx8tI9BZEO2ht9P0JlKEmBHCe5r5j32scI/4mfCCxzvQV5b2heK8Rxsi0rWZa3Xv8cPRoOBo+Go5ohhCDvu8cUUXRFO/1+OKj+D3HKxof1FhrtDBGLJI0kQ5Lezcpfevm2l0WfEEJd8yjx9FfpZ5Tn5Md3HUaYn/GvJji3Wx/sqvOq1V6EqSlqCoUZsDlVh9d+dc9SY0BNLjj3CzT5PruzVxDpvuxiAw+K3DifLgDMm0Umoft8PUns7nR0dEyTRZ3b2/xv3J7nxPx5nfv7juuvltVJv4jYH30dJkms7th/aqpD/wHAnv0ZLnS40lmUDh0WFY0ycVY54uLKLeW7Y7Rkokay3cNSmlJKxY5GjJ6NuXVStRQT6qDvVhXNWOtCxRqi6DplCEJknWWQxQUAAkG23yG7AM1kQue3TYhlxAu8VZTyBZ0IrDSknVuajxLBpQMWHlYHPRYr4SKfbkSSml4wOtd2JrF+IOD8Jsw9KBds0tlkau8VQSBO0MkAVXjFgXBTRbEAJr/2LpsMEkARI0dF75bVXzhI8a8YBjUrQCFYKUO4AuhmgrBbl0X3Nw0TMDcsVzCzQ1RFc0F6f3lMl19oLU6H1i1+y8GM5RXnVHNJ1wNbL61hnpjirMo/kPQ920AQqalNmEesjmXy0GHIdcAhxnH0BgHmDd8RhV4m7tuTCam9AdjfwPZgQNokv83eH9WPf9KbgHl2UH1/Fn1/Duq967Qnz2PnolUuT/5cyyKATyzzmg1fb6GgmcH4ft2Uhq8kjjng8tUXc2yjttmokGAiS5AtIgnLWSmzqQoOFVidIaxCJ8dSKoctQ4rS2FZ6Xzij8t12fIXU4PIJZ8Ei6gd17ezExgXfCZgZnDy6wdrOH3wnEtCKcDy7EA8D71f+cjtTFwhCLUA3jgHsLXxEehJbVhMZoUwchI8zhSqAimtQw6pyHxE2WM0wnEyE+rSps/G5jkVlzZFqT/95a/Ug48BF82e6Np8gEznQHPf0zZUsrLM85OAgGnNmX5HeIriiTNOq5pyqawztY/9xrRrO0vL9LB2EKrm+xTf8WWqM2zPnwIq64cLmHDQIIVaSSqdNXVFnLN5RabDyrzAkvx7fz+EaHS3LOgWb9N1IX+1pZVMjnogTozhNk9wNZuLA7F0eH3rWxVvOCd3A0hKkiOCIexfobFaES9pMxUqsKo3/LUlx20mCt/Vn1dJdRKcDaf6861O1k9/+WsLrp3e5yZgfgWR5xQ+ugNCjtxQfMZyyN9gVSzA6S5ENB+a36zbWgRdiWaKFxl5ZXxm8AM4vNcjHu/1oO/rqAN729pfhHDxTg/TkUi6mp3wFuR/U+sSgwt55yrVAL7Sc7wihg1HmAStn19ThJchD4Xs7RUyobjQgM45WSc0cVPjQkXqqyV8ZTazOO8mCBlK7/r1+A4KrZPetqfIyk0Rj+C7Z2H1WFlPm6NIFYhCc/24a91uy7tAveLrBTMWBVysQSkov06818Ol9D/9+J903y1GvW1j3m1tZQuNb+BxxUV71mitxYs4g649FqWA0k5OFhdaXTSawm5lmO7IWxmodcbZXNdBNgTdCXQTjg8ELx7kOskTRdwRLvmF0hPbkRkb9N29GCHkF1qQAnjH8C1OhcmL5gB7Mjq+PSfajOSX2sUNrD53sJ1wTmQz5NsKOVZ0/04reLByQFrWOdGTwh+oLjj2/CFhmyChli1qniZ0+4jDvXmS+th1cn6nI+V9rVWoN5j3dD9OK+tZaHR4SP/rMsrLDrFIW9UZSX++ZfJPSfrhcebbQ1H+83b37rbY0uy9HP35OrsavSE07VCNt04QXOHaFHRFkzDXb7iJRXQLt1IVUuFFRNvF6PDwYki4XabJ0Tb0vdUleikyJyTOyeBrxKkzCxBTkofkmJlfEJtojDa3e8r3g+w2JBx1kPB4EwmvFJdX8CXmE32J6u+70/byzi9PoF6XzCveWkmk78TtSWez7e9+kxaz2ki3SI5Pb5Lrvqhk37cfn54vz0mju5mm7EylLUMs3Cw5Tg5ayRqL5ooyLDQDM23Dh1aonKofNsIyopIHV8PBMFmm62O2hnFu6Y91/75DrBNTqaZ3jTtfYectUdATqYOjldSr5L8hib1AgnavNJHEOTMUOYV/KFhutfp2leL6MpI3Jp+25ZNaQnEtQxQTRJ2cz7qS3JLF2Z7EGT5up098goRzHk3KY1sWo9l4zEs0aYlWpqGVaFjlDjqpA84GtJIBp6uz0MTdY9h9yPHq0dERB3Y/H3IE9NFTDi4ePVmed+JsSdKNpXECdz0i9PMCHN34xt5p/z/ktHd99mCEdn3YyGCNz9hx3Nb9tp0+1FYXKiy43VwOjW1bbIddRXJoollohdPW3JgldcJCbyNjgEWmy+bCaq/XQk0zqtdrhJEnLxmu39QGKj1HM6n9LdhJgdd8jZeGYcltq+g0ipLM22IBFE6YsqvDBSeiaJz1TFRiLAtJ+pK66cBoK5VrB3QvOca3Hxhf8XKFBalZ4kFdCg4GNBbxXJtLeqGDHrqAMVUCkZGNaiZU5h1yrwFSYjKy5Vf3hK0zBLX0sGnlDHFXKZSYMt+nbT6CHAsSAxaMHlO9ntVF7bnXCVlo4zPgvCHiZctI/PK6oiZOe5DsNDgjhrkKYRlLN7npNikL4vBWx5iipBXBIslLcxpqVWh6VoMipHVBRTpkrdC51pMOjDTcGaEsGZkh6R5o0CAsREzQBn/onUWi8NdSXfqLx304bfjqOxxb6bBb8rzO9A+7Y34v3Vf1mB6O0FY6bRar0VPpZvWY1XR7kuaHn+n34W0ZaCnhDy+ueuv9Knvw4s0rNvAewk8//gd8jcIomOm559asNlgsmmds/CMpTHmPtsY+45gcCT/CeOaZL8jsiMHvZsKxc/0a+aEYf6R80c2belzIDE5iwoMuYHzB3ksrCdIp0ZwJYqUrKUBA5UcXUl0O4IVacGhnJcHpO4/rbIO1RiS3f6slj9f645qDFUT0vbRYXKFtBUvoZR3i6JnR9dSv1gYmbM7ghNzl8JgL7e1FnnOMQa6eZuGCsxU4OPEvZODCp4g4uPNmbQi3NNfiQ2RolR1AlXOhmj2G3IiJW82frnn0rD82PsXnHCI60jBNQxJ/EsOOm68+DLJmQHblLYdXaEHe9ooulQzsdBrZErp3Ce7P1r7wg1UiOx9BM4lKbg3t0Vsv9pvJWzRXMovO5o4TfcCdD5I0KWSGymLLOXnx+zdfw9WjwWGStszyDzjcB1+/+uLL12+/JGBIkHqEDQeHg0MORmjrSqFaK73FYgJvvY25Vv/UOGz7l6n2L1PtX6bav0y1f5lq/zLV/mWq/ctU+5ep9i9T7V+m2r9MtX+Zav8y1f5lqv3LVPuXqfYvU+1fptq/TLV/mWr/MtX+Zar9y1T7l6n2L1PtX6bav0y1f5lq/zLV305K7F+m2r9MtX+Zav8y1Y5ztH+Z6m/+MlWoOidADqpCSNW6keOvQJyu3qs6T5MZ3Y44Pk1ubqiC5B0VMdPnH2o0dLXiPE2uhJGUYeOLFWm8DUAV7pdI9eJf+BRv/4RWTr1VyOVYa/dJ6DqDH/Eiy7Byt/ZtX+B4883bE6oGDtfvS53TGCPmVCgs5r6EOTAel/4LflGkEGpac8F94uekCwxU0Ni9/XDJtx/CH626far2X0HYvRbht0H/0qa2Dri58TcruL7e9/dNO0cExMbeRLnz5XL5P7FB1NM=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact list","permalink":"/docs/API-docs/v1.1/contactlist"},"next":{"title":"Draft Document","permalink":"/docs/API-docs/v1.1/draftdocument"}}');var s=t(74848),r=t(28453),o=t(57742),a=t.n(o),l=t(78178),d=t.n(l),c=t(19624),h=t.n(c),p=t(96226),m=t.n(p),u=(t(77675),t(19365),t(51107)),g=t(21312);const x={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:"eJztPF1zG8eRf6Vv66pkIQuQgChZx1JUUSwn1p0jqyyqXD6SYQa7DWDE3Zn1zCxBhIUqP+Qf3NNV3b3kp/mXXHXPzGIXH6QoO4nuDn6QiZ2vnu6e/p65SZyY2uT4NHmps7pE5WxyniY52szIykmtkuPkZIZgsZhYOVXw4s0rmKJCIxxaEPDu26/BzYQDVGJcoIWJQbRuUSBQf6mmoCcgIA/zD+B7XUMmFIjCapAqK+ocQfNiooDKYD/HiVSYw1zmU3Q2hflMZjNwMz8nGh6PuXSgDeB1JVQOdaUVCAsKMcd8ACczaaEy+krmDGiEBq8rNBJVRpOVshAGnOa5f/rxv97SFr/XtaH9/vTjf8Ok0HOQitu/qVBxB1FVgzN1pk5kdQzvqkKLHBa6NvDm5e+ajdKs9O2013uJ43oK7171euefzZyr7PHBAc2hK1QEViHGdpDp8iCnjlU+eUhbRoM0q9+rsLJYgMhbSHEzVJDpagGZ1iaXiiiSQiWmCKoux2hsCoSZUhukPQgwKPJF3+l+bRH+9e03r2GiTSncAN4UtU2b5XJpMHPFwk9Pe4+7emBhLCw+OQLrjFTTFEpxSWiVDn6oZXZJ27ao8ojUF29eMa56vbd1VWnjMIfv/BaOez1q+S0SjoVB7p/pstQKKmFEiQ6N9dxFzQZ/qKVhvnAzEEURcXF8pvrQ6ylR4nGvB++U/KFGkDkqJycSDe0SHPGDHzDw/d2i4v6vVC4zZmcCgL4Sy3a6ElKp69sKM5rSd22hGrQKXEo4nAtP/6oQmd+WQVth5uQVdie+TmFBE79EpSMEM23kn7VyomDyXaFxMhNFm8wEIB8HJ4wj9FdaKhe/hhWak0bUZiIGPiTQckJuKRW3WIQrUdRoA1TzFGYE1bdYGbQkFeK8hHiVwwzldLZzPZG/r63rTAy1JTDbUIS1IlUZvchom4jCIshJB5eluMTWao3EGMBvF5DjRNSFS0EShzpT4wBea0cntZAZCSbmATpswtUG+0zlwD6DLvu8WcmMXE4maOgwUyNPEcZE6IgvvZCh7fFJczOhQKs1Qme60GaThfhzF4+QaeVYUr64ErJg4P1mbSMux4XILlMYFzWmYDD3B32BRaHnqT8f3IUEosc544fEOHGhVgS/0mF5acEGqBrBGc8fNTbCmRaRto3VcMonmlYmFMQjCVgKWaSMuBTe6zE46QpM6YBXQi1SyIXDFBxeu7G+TiGbYXY51tcBXxOtnJV/3nLqYsv9sTZK4SiFJyk8TWF4mMJwlMLwKIXhkxSGT1MYHaYwGqUwOkph9MTjdPQ04FM0SGwDMBx5TLpPD4MzmeMFNV4Q/BfCOjTSXpLYhe9Id3iNnade7OG1IyHWKNl8pcmkhZnMc1QwMboEg5msJEsFf6qbqVMY1w4MAa4sTOqiWMCVtLK1z2ZSPSdF7lWrNC3lmmW6JjoyFj3iGGUrsqpiQaCeoCgtY/RL5dBURlokkatsgwHlVvzjFRl9ax/kD6GW6kqS3RSLFEjBiFxqwobTKoXc6CrXcxU04dfSsuwkFWYbrTjvaMXhAHq9Rl7Rtz/96U9n6uZMAZwlJL7OkmM4S5ouZ0nq20grUdsw/L6mH49Gn4efC/r5ZPQ0/Jxz1+FR+Dmjn6M4NBygs+SY1+UOUjm/cpCT0IKAOi3P1DIAe6ZGvAsnyuqWHVDz3xZ6aMCP2oY+kppIYwOdsk14duzY99jY7SParVTSSVHY3RuOPT6hPa+BtH3bq04bOz+inbO82r1tbv6E9tyGh1pYF/om1p2tpijxGYrRLShan3OXDKZRbOVsYPLxIJgiuxHpt/DJ4LEFzi+FxrUp74/FJ4RFUpknpDJ3o7LRqp8QPtdh+qWQum3e+2P28wEbs2yB7MZr6PAJYbUL0S+F081Z74/Rp4RRMuV2o5NaPyFctsChhmAX+7bDo/7wcX90ODrq4JOiDL5DWfbzvL9YLH4eLUqpLjwcNKjVvxTX2xtCAKhpZGrcQlvfb41cZFaG/ZJlGZ1Fb9oKh95C3owEsKO+6hVcF/47es9/IJ95HN1JzGPYqXEsmmBN2+F1OheLB9ZPFYc2PhT1X7eAPZjcRHBw4CqbaZkF4KlP9JzGFJsZEA76TLqDPD9okY4+5nm/LPtrH+lnnynd+liWgzwfrPXcYAf/sYQ8T2Hz89bveQ5lWe747L93Ph+U5eYuBmUZYAvYixy2QedSKlnW5AdRDMy709SRXImA3jLQUiro9b7//vvv+3/4Q//ly14v0jAsEXi1FXbwK4jrX2iFNtP3esfwagLtT+z6+6ALn/XG/SO3pukw03MVvZ4QgM1riv7Frj70U4oFT4bSzdB019FmxbLkI5JLNdZuNoB37ELS39HValwidpf+hcRj8HF3S8jQ4e8lJFeysLvwrQKUoq/ku24Kn44E3TB+omCqtltHBqd1IQxeU6zOSq02JN/HaLr7abE1sRh5eRUz4ShgiMNiDFnAZ98ET/thEwxc2wvN9gKy2joOPEzxGirhHBrFk12JQuaCz0efP+C1KCsKkhz88ews/9U/H3AYliKdzscNcjmVFD0/+OPpi/6/n2/pUVcVmkxYhAJpJZsCumwApzMsqlUAfz6fD+aPbDbTuvDR+/fW4MT/e6HH7y8Y3GogbPVw2049M7TCnsQs61FPPpwtjAkLceSWwCeThk/N8JDttBCPuMVQCz0+IetiDSRq9DFkaj4lBc8mLDEvrv7WJHPOkvOVuudQJ+Z3jD3/gONJp6EQYyw2m+5/tAqx0HU40TG0391q4OgW3oLB00RveTuHaatRXK81+rbllnPqEdI+plHbx+MZKQCFtI0i6aCzPToE+DlNQ8k3YtsxQhwA44ZLf/YpaAD7sGMQo6BMuzuWoH7AHZvkShNPvX2FDmE2NHmwFWKWaNLMGlEWFXkbXzSytmhWZsItKwRbYfcKlJLZvcCZGnKsUZZieosLws2fkJRow7MjXOV7bPhbQw5KenTdEmTh9ts3PDzsbPhxd8NPDj/CnOgseysqWjbDYUvmmLIuxIYFkGMmS1FwPpKXHv0MCbYlXrMO9cfYDwF24u8vdFnVzvN3sBzIM2EZHxk9JuJ8CuJXKfRT6KVwkMJnKTwcwLfIqbusSfMFvpfGJ/OkglzXFM/PalMsYGwINyngYDqAm5sfaqGcdIvlEnpwc0PlDsvlgCTFpdJzn+k7pdyGA8rUr+yCXGd2S2ZfZ/aADIiD1zjvx2KLgwDaQ/hMr0nGW62pgIINcdohMw193QgFb/dw5lfaqhALEBNKd/jsIA/zSeQBYeAYRvDr5zAcDQ4PUzj0f8Nncf3RQz5IHO/OsLgt2M3Ndx2jw/YxWv3cJjceH37QOWov+5FGOU1xwbkoXne7sb5VAn2CxvlqM+vhgJbeIJx5lWFnui5y0hoGXW0UNvUcQWskaaIrKgKSWr3Kk+MkFgglKeMarfutzhfJ8U0SErP0Z0ii0aCD95aKi24Sm82wFPRXpBGVI01kgUmaeG/TJmnCkUuqTSLWSo4TPX6PmUtS8ooqMqPQ0hw87vgm9vJFKkkaIlDJceKrV5I0CZ5C8wlQZZrCLlU+SZZxwdumar6sprL8R5PkpHmoruMjp3lNQ5dr5VgfNdPL1gy8txJPNEnZAh2+FAvbmtczRLJeBUZjiAmyMApysbDkstfWc0cmiqwuyNnH60qaRRPp4ghTg5IWvM1KDbzDx8tI9BZEO2ht9P0JlKEmBHCe5r5j32scI/4mfCCxzvQV5b2heK8Rxsi0rWZa3Xv8cPRoOBo+Go5ohhCDvu8cUUXRFO/1+OKj+D3HKxof1FhrtDBGLJI0kQ5Lezcpfevm2l0WfEEJd8yjx9FfpZ5Tn5Md3HUaYn/GvJji3Wx/sqvOq1V6EqSlqCoUZsDlVh9d+dc9SY0BNLjj3CzT5PruzVxDpvuxiAw+K3DifLgDMm0Umoft8PUns7nR0dEyTRZ3b2/xv3J7nxPx5nfv7juuvltVJv4jYH30dJkms7th/aqpD/wHAnv0ZLnS40lmUDh0WFY0ycVY54uLKLeW7Y7Rkokay3cNSmlJKxY5GjJ6NuXVStRQT6qDvVhXNWOtCxRqi6DplCEJknWWQxQUAAkG23yG7AM1kQue3TYhlxAu8VZTyBZ0IrDSknVuajxLBpQMWHlYHPRYr4SKfbkSSml4wOtd2JrF+IOD8Jsw9KBds0tlkau8VQSBO0MkAVXjFgXBTRbEAJr/2LpsMEkARI0dF75bVXzhI8a8YBjUrQCFYKUO4AuhmgrBbl0X3Nw0TMDcsVzCzQ1RFc0F6f3lMl19oLU6H1i1+y8GM5RXnVHNJ1wNbL61hnpjirMo/kPQ920AQqalNmEesjmXy0GHIdcAhxnH0BgHmDd8RhV4m7tuTCam9AdjfwPZgQNokv83eH9WPf9KbgHl2UH1/Fn1/Duq967Qnz2PnolUuT/5cyyKATyzzmg1fb6GgmcH4ft2Uhq8kjjng8tUXc2yjttmokGAiS5AtIgnLWSmzqQoOFVidIaxCJ8dSKoctQ4rS2FZ6Xzij8t12fIXU4PIJZ8Ei6gd17ezExgXfCZgZnDy6wdrOH3wnEtCKcDy7EA8D71f+cjtTFwhCLUA3jgHsLXxEehJbVhMZoUwchI8zhSqAimtQw6pyHxE2WM0wnEyE+rSps/G5jkVlzZFqT/95a/Ug48BF82e6Np8gEznQHPf0zZUsrLM85OAgGnNmX5HeIriiTNOq5pyqawztY/9xrRrO0vL9LB2EKrm+xTf8WWqM2zPnwIq64cLmHDQIIVaSSqdNXVFnLN5RabDyrzAkvx7fz+EaHS3LOgWb9N1IX+1pZVMjnogTozhNk9wNZuLA7F0eH3rWxVvOCd3A0hKkiOCIexfobFaES9pMxUqsKo3/LUlx20mCt/Vn1dJdRKcDaf6861O1k9/+WsLrp3e5yZgfgWR5xQ+ugNCjtxQfMZyyN9gVSzA6S5ENB+a36zbWgRdiWaKFxl5ZXxm8AM4vNcjHu/1oO/rqAN729pfhHDxTg/TkUi6mp3wFuR/U+sSgwt55yrVAL7Sc7wihg1HmAStn19ThJchD4Xs7RUyobjQgM45WSc0cVPjQkXqqyV8ZTazOO8mCBlK7/r1+A4KrZPetqfIyk0Rj+C7Z2H1WFlPm6NIFYhCc/24a91uy7tAveLrBTMWBVysQSkov06818Ol9D/9+J903y1GvW1j3m1tZQuNb+BxxUV71mitxYs4g649FqWA0k5OFhdaXTSawm5lmO7IWxmodcbZXNdBNgTdCXQTjg8ELx7kOskTRdwRLvmF0hPbkRkb9N29GCHkF1qQAnjH8C1OhcmL5gB7Mjq+PSfajOSX2sUNrD53sJ1wTmQz5NsKOVZ0/04reLByQFrWOdGTwh+oLjj2/CFhmyChli1qniZ0+4jDvXmS+th1cn6nI+V9rVWoN5j3dD9OK+tZaHR4SP/rMsrLDrFIW9UZSX++ZfJPSfrhcebbQ1H+83b37rbY0uy9HP35OrsavSE07VCNt04QXOHaFHRFkzDXb7iJRXQLt1IVUuFFRNvF6PDwYki4XabJ0Tb0vdUleikyJyTOyeBrxKkzCxBTkofkmJlfEJtojDa3e8r3g+w2JBx1kPB4EwmvFJdX8CXmE32J6u+70/byzi9PoF6XzCveWkmk78TtSWez7e9+kxaz2ki3SI5Pb5Lrvqhk37cfn54vz0mju5mm7EylLUMs3Cw5Tg5ayRqL5ooyLDQDM23Dh1aonKofNsIyopIHV8PBMFmm62O2hnFu6Y91/75DrBNTqaZ3jTtfYectUdATqYOjldSr5L8hib1AgnavNJHEOTMUOYV/KFhutfp2leL6MpI3Jp+25ZNaQnEtQxQTRJ2cz7qS3JLF2Z7EGT5up098goRzHk3KY1sWo9l4zEs0aYlWpqGVaFjlDjqpA84GtJIBp6uz0MTdY9h9yPHq0dERB3Y/H3IE9NFTDi4ePVmed+JsSdKNpXECdz0i9PMCHN34xt5p/z/ktHd99mCEdn3YyGCNz9hx3Nb9tp0+1FYXKiy43VwOjW1bbIddRXJoollohdPW3JgldcJCbyNjgEWmy+bCaq/XQk0zqtdrhJEnLxmu39QGKj1HM6n9LdhJgdd8jZeGYcltq+g0ipLM22IBFE6YsqvDBSeiaJz1TFRiLAtJ+pK66cBoK5VrB3QvOca3Hxhf8XKFBalZ4kFdCg4GNBbxXJtLeqGDHrqAMVUCkZGNaiZU5h1yrwFSYjKy5Vf3hK0zBLX0sGnlDHFXKZSYMt+nbT6CHAsSAxaMHlO9ntVF7bnXCVlo4zPgvCHiZctI/PK6oiZOe5DsNDgjhrkKYRlLN7npNikL4vBWx5iipBXBIslLcxpqVWh6VoMipHVBRTpkrdC51pMOjDTcGaEsGZkh6R5o0CAsREzQBn/onUWi8NdSXfqLx304bfjqOxxb6bBb8rzO9A+7Y34v3Vf1mB6O0FY6bRar0VPpZvWY1XR7kuaHn+n34W0ZaCnhDy+ueuv9Knvw4s0rNvAewk8//gd8jcIomOm559asNlgsmmds/CMpTHmPtsY+45gcCT/CeOaZL8jsiMHvZsKxc/0a+aEYf6R80c2belzIDE5iwoMuYHzB3ksrCdIp0ZwJYqUrKUBA5UcXUl0O4IVacGhnJcHpO4/rbIO1RiS3f6slj9f645qDFUT0vbRYXKFtBUvoZR3i6JnR9dSv1gYmbM7ghNzl8JgL7e1FnnOMQa6eZuGCsxU4OPEvZODCp4g4uPNmbQi3NNfiQ2RolR1AlXOhmj2G3IiJW82frnn0rD82PsXnHCI60jBNQxJ/EsOOm68+DLJmQHblLYdXaEHe9ooulQzsdBrZErp3Ce7P1r7wg1UiOx9BM4lKbg3t0Vsv9pvJWzRXMovO5o4TfcCdD5I0KWSGymLLOXnx+zdfw9WjwWGStszyDzjcB1+/+uLL12+/JGBIkHqEDQeHg0MORmjrSqFaK73FYgJvvY25Vv/UOGz7l6n2L1PtX6bav0y1f5lq/zLV/mWq/ctU+5ep9i9T7V+m2r9MtX+Zav8y1f5lqv3LVPuXqfYvU+1fptq/TLV/mWr/MtX+Zar9y1T7l6n2L1PtX6bav0y1f5lq/zLV305K7F+m2r9MtX+Zav8y1Y5ztH+Z6m/+MlWoOidADqpCSNW6keOvQJyu3qs6T5MZ3Y44Pk1ubqiC5B0VMdPnH2o0dLXiPE2uhJGUYeOLFWm8DUAV7pdI9eJf+BRv/4RWTr1VyOVYa/dJ6DqDH/Eiy7Byt/ZtX+B4883bE6oGDtfvS53TGCPmVCgs5r6EOTAel/4LflGkEGpac8F94uekCwxU0Ni9/XDJtx/CH626far2X0HYvRbht0H/0qa2Dri58TcruL7e9/dNO0cExMbeRLnz5XL5P7FB1NM=",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,j={},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)(u.default,{as:"h1",className:"openapi__heading",children:"Self Sign"}),"\n",(0,s.jsx)(a(),{method:"post",path:"/selfsign",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, 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 "options":{\n "hint": "Provide signature"\n }\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 "hint": "Provide 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 "hint": "Provide 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 "hint": "Provide email",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide name",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide job title",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide company",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12,\n "min_date": "",\n "max_date": "",\n "signing_date": false,\n "hint": "Provide date"\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",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"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 "hint": "Provide image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "default": 0,\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hint": "Provide number",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{...t(27471)}),"\n",(0,s.jsx)(m(),{...t(16737)})]})}function w(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}},27471(e){e.exports=JSON.parse('{"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":true},"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":"<p>Hi {{receiver_name}},</p><p>We hope this email finds you well. <strong>{{sender_name}}</strong> has requested you to review and sign <strong>{{document_title}}</strong>.</p><p>Your signature is crucial to proceed with the next steps as it signifies your agreement and authorization.</p><p><a href=\'{{signing_url}}\'>Sign here</a></p><p>If you have any questions or need further clarification, please contact the sender.</p><p>Thanks,<br>Team OpenSign\u2122</p>"},"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":false},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent.","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to.","example":"mailer@opensignlabs.com"},"merge_certificate":{"type":"boolean","description":"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\\n\\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\\n","example":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]}},"title":"selfsigndocument_body"}}},"required":true}}')},16737(e){e.exports=JSON.parse('{"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"}}}}}}')}}]); |